resources/tools/presentation/README.md

   1 # Presentation and Analytics Layer
   2
   3 Presentation and Analytics Layer (PAL) makes possible to present and
   4 analyse the test results generated by CSIT Jenkins jobs.
   5
   6 ## Using PAL in the Local mode
   7
   8 The local mode makes possible to use:
   9 1. a single XML file,
  10 2. a directory with XML files, or
  11 3. a directory with directories of XML files.
  12
  13 ### Using a single XML file
  14
  15 Run the script with the path to a local XML file, e.g.:
  16
  17     ./run_local_report.sh --file output.xml
  18
  19 ### Using a directory of XML files
  20
  21 Store all XML files in a directory, e.g.:
  22
  23     csit-vpp-perf-verify-2001-3n-dnv/
  24     ├── csit-vpp-perf-verify-2001-3n-dnv__5__output_info.xml
  25     ├── csit-vpp-perf-verify-2001-3n-dnv__6__output_info.xml
  26     └── csit-vpp-perf-verify-2001-3n-dnv__7__output_info.xml
  27
  28 and use:
  29
  30     ./run_local_report.sh --directory csit-vpp-perf-verify-2001-3n-dnv/
  31
  32 ### Using a directory with directories of XML files.
  33
  34 Store all XML files in a directory structure, e.g.:
  35
  36     local/
  37     ├── csit-vpp-perf-verify-2001-2n-clx
  38     │   ├── csit-vpp-perf-verify-2001-2n-clx__28__output_info.xml
  39     │   └── csit-vpp-perf-verify-2001-2n-clx__29__output_info.xml
  40     └── csit-vpp-perf-verify-2001-3n-dnv
  41         ├── csit-vpp-perf-verify-2001-3n-dnv__5__output_info.xml
  42         ├── csit-vpp-perf-verify-2001-3n-dnv__6__output_info.xml
  43         └── csit-vpp-perf-verify-2001-3n-dnv__7__output_info.xml
  44
  45 and use:
  46
  47     ./run_local_report.sh --directory local/
  48
  49 ### Example
  50
  51 For more information and for a running example see the specificaton file
  52 `specification_local.yaml`.