ceph/src/boost/libs/test/doc/test_output/report_format.qbk

   1 [/
   2  / Copyright (c) 2003 Boost.Test contributors
   3  /
   4  / Distributed under the Boost Software License, Version 1.0. (See accompanying
   5  / file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6  /]
   7
   8 [section Report formats][#ref_report_formats]
   9
  10 [section:report_human_readable_format Human readable report format]
  11
  12 The human readable report format is designed to produce the most human friendly description of the
  13 results of a test module testing. This is a default format generated by test modules.
  14
  15 Depending on the framework's report level the output looks like this:
  16
  17 [table
  18   [ [Level]
  19     [Output]
  20   ]
  21
  22   [ [no report]
  23     [On this level the framework does not produce result report at all. It make sense
  24      to use this level for test modules running unattended (as part of some automated regression
  25      testing system, for example)
  26     ]
  27   ]
  28
  29   [ [Confirmation]
  30     [
  31        [variablelist
  32          [[Passing test] [\*** No errors detected]]
  33          [[Skipped test] [\*** The test suite <name> was skipped; see standard output for details]]
  34          [[Aborted test] [\*** The test suite <name> was aborted; see standard output for details]]
  35          [[Failed test without failed assertions] [\*** Errors were detected in the test suite <name>; see standard output for details]]
  36          [[Failed test] [\*** N failures are detected in test suite <name>]]
  37          [[Failed test with some failures expected] [\*** N failures are detected (M failures are expected) in test suite <name>]]
  38        ]
  39     ]
  40   ]
  41   [ [Detailed]
  42     [On this level we report result for each test units hierarchically (each test unit is reported as part of parent test unit
  43      report. Test cases are reported like this:
  44         [pre
  45         Test case/suite <name> has passed/was skipped/was aborted/has failed/ with:
  46             N assertions out of M passed
  47             N assertions out of M failed
  48             N warnings out of M failed
  49             X failures expected
  50         ]
  51      Only relevant lines will appear. If test case does not have failing assertions corresponding line in the report is not shown.
  52
  53      Test suite in addition to above lines also report these:
  54             [pre
  55             N test cases out of M passed
  56             N test cases out of M passed with warnings
  57             N test cases out of M failed
  58             N test cases out of M skipped
  59             N test cases out of M aborted
  60             ]
  61     And similarly to above lines only relevant ones will appear in output.
  62     ]
  63   ]
  64   [ [Short]
  65     [Short report format is similar to detailed, but only reports information for master test suite]
  66   ]
  67 ]
  68
  69 [endsect] [/ human readable report]
  70
  71 [/ -------------------------------------------------------------------------------------------------- ]
  72 [section:report_xml_format XML based report output format]
  73
  74 This report format is designed for automated test results processing. The result report output XML schema
  75 depends on the report level.
  76
  77 [/TODO: Fix this section]
  78
  79 [endsect]
  80
  81 [endsect] [/section:log_xml_format ]