contrib/kyua/doc/kyua-report-junit.1.in

   1 .\" Copyright 2014 The Kyua Authors.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are
   6 .\" met:
   7 .\"
   8 .\" * Redistributions of source code must retain the above copyright
   9 .\"   notice, this list of conditions and the following disclaimer.
  10 .\" * Redistributions in binary form must reproduce the above copyright
  11 .\"   notice, this list of conditions and the following disclaimer in the
  12 .\"   documentation and/or other materials provided with the distribution.
  13 .\" * Neither the name of Google Inc. nor the names of its contributors
  14 .\"   may be used to endorse or promote products derived from this software
  15 .\"   without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 .\" OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 .\" OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .Dd October 13, 2014
  29 .Dt KYUA-REPORT-JUNIT 1
  30 .Os
  31 .Sh NAME
  32 .Nm "kyua report-junit"
  33 .Nd Generates a JUnit report with the results of a test suite run
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl -output Ar path
  37 .Op Fl -results-file Ar file
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 command provides a simple mechanism to generate JUnit reports of the
  42 execution of a test suite.
  43 The command processes a results file and then generates a single XML file
  44 that complies with the JUnit XSchema.
  45 .Pp
  46 The JUnit output is static and self-contained, so it can easily be plugged
  47 into any continuous integration system, like Jenkins.
  48 .Pp
  49 The following subcommand options are recognized:
  50 .Bl -tag -width XX
  51 .It Fl -output Ar directory
  52 Specifies the file into which to store the JUnit report.
  53 .It Fl -results-file Ar path , Fl s Ar path
  54 __include__ results-file-flag-read.mdoc
  55 .El
  56 .Ss Caveats
  57 Because of limitations in the JUnit XML schema, not all the data collected by
  58 Kyua can be properly represented in JUnit reports.
  59 However, because test data are extremely useful for debugging purposes, the
  60 .Nm
  61 command shovels these data into the JUnit output.
  62 In particular:
  63 .Bl -bullet
  64 .It
  65 The test case metadata values are prepended to the test case's standard error
  66 output.
  67 .It
  68 Test cases that report expected failures as their results are recorded as
  69 passed.
  70 The fact that they failed as expected is recorded in the test case's standard
  71 error output along with the corresponding reason.
  72 .El
  73 .Ss Results files
  74 __include__ results-files.mdoc
  75 .Sh EXIT STATUS
  76 The
  77 .Nm
  78 command always returns 0.
  79 .Pp
  80 Additional exit codes may be returned as described in
  81 .Xr kyua 1 .
  82 .Sh EXAMPLES
  83 __include__ results-files-report-example.mdoc REPORT_COMMAND=report-junit
  84 .Sh SEE ALSO
  85 .Xr kyua 1 ,
  86 .Xr kyua-report 1 ,
  87 .Xr kyua-report-html 1