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