Hudson支持什么JUnit XML格式规范?


183

我将Hudson作为持续集成服务器,并且我想使用选项“发布JUnit测试结果报告”。但是我不使用xUnit工具进行测试,相反,我有运行测试并以简单格式返回结果的shell脚本。我正在考虑制作一个脚本,将这些结果转换为JUnit格式。所以我很有趣JUnit文件的外观如何?


有什么理由不使用JUnit吗?这些测试可以通过各种工具cmd,UI等以各种方式实现自动化...
Aaron McIver

6
@AaronMcIver:Shell脚本非常擅长在(不是Java的语言)上运行测试。您将如何使用JUnit?
Ben Voigt

1
@BenVoigt我最初以为OP涉及Java,并希望绕过JUnit作为测试工具。复习问题后,情况极有可能不是这样。再次查看后,看来code.google.com/p/shell2junit可以为OP提供一些使用。
亚伦·麦克弗

1
沿着shell2unit的方向,这是我创建的一个JAXB类,可以解析/输出JUnit XML:gist.github.com/agentgt/8583649
Adam Gent

Answers:


127

几个月前,我做过类似的事情,结果证明这种简单的格式足以让哈德森接受它作为测试协议:

<testsuite tests="3">
    <testcase classname="foo1" name="ASuccessfulTest"/>
    <testcase classname="foo2" name="AnotherSuccessfulTest"/>
    <testcase classname="foo3" name="AFailingTest">
        <failure type="NotEnoughFoo"> details about failure </failure>
    </testcase>
</testsuite>

这个问题的答案有更多详细信息:规格。用于JUnit XML输出


请对此答案进行更正,因为xunit插件拒绝“ classname”属性,而仅接受“ class”
andho

10
我有相反的问题。class被拒绝了,只能classname奏效。
ryanbrainard'2

1
当我将xUnit插件升级到1.60时,这开始对我失败。我发现验证器变得更加严格,因此我必须添加<testsuite tests="(number of tests)">ex。<testsuite tests="10">
凯文·布罗特克

2
感谢@KevinBrotcke,我将更新答案以包含该属性。
Anders Lindahl 2013年

2
还要注意,要让Hudson按包/套件组织测试,必须在classname属性中指定一个包。例如:<testcase classname="foo.bar" name="ATest" /> 这会将bar类放在Jenkins的foo包中,使您的测试集合更有条理。
jluzwick 2013年

89

我只是抓住了其他人链接到的junit-4.xsd,并使用了一个名为XMLSpear的工具,使用以下所示的选项将架构转换为空白XML文件。这是(稍作清理)的结果:

<?xml version="1.0" encoding="UTF-8"?>
<testsuites disabled="" errors="" failures="" name="" tests="" time="">
    <testsuite disabled="" errors="" failures="" hostname="" id=""
               name="" package="" skipped="" tests="" time="" timestamp="">
        <properties>
            <property name="" value=""/>
        </properties>
        <testcase assertions="" classname="" name="" status="" time="">
            <skipped/>
            <error message="" type=""/>
            <failure message="" type=""/>
            <system-out/>
            <system-err/>
        </testcase>
        <system-out/>
        <system-err/>
    </testsuite>
</testsuites>

其中一些项目可能会多次出现:

  • testsuites因为XML是这样工作的,所以只能有一个元素,但是testsuite元素内可以有多个元素testsuites
  • 每个properties元素可以有多个property子代。
  • 每个testsuite元素可以有多个testcase子代。
  • 每一个testcase元素可以有多个errorfailuresystem-out,或system-err孩子。

XMLSpear选项


1
是否有文档描述某些属性的有效值,例如测试用例的状态或错误的类型?
埃里克·科普

1
@EricCope我可以建议您查看源代码svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/…。基本上,它只是一个字符串。
苏珊(Sulthan)2012年

4
为什么标签重复?
Nakilon 2014年

设置镜像:imgur.com/quneFJf ALT: :RootelementtestsuitesMax recursive de...2Max Repeat factor2:(include optional elements是=打勾)include optional attributes:(是=打勾)
n611x007

1
@Nakilon已经晚了2.5年,但我已将其修复
-bdesham

45

顶端回答问题的安德斯·林达尔XSD文件

我个人觉得这个xsd文件也非常有用(我不记得自己是怎么找到的)。看起来没那么吓人,就我所使用的而言,Jenkins(v1.451)似乎可以识别所有元素和属性。

但是,有一件事:在添加多个<failure ...元素时,詹金斯只保留了一个元素。现在,在创建xml文件时,我将所有失败串联在一起。


更新2016-11链接现在已断开。更好的替代方法是cubic.org的以下页面:JUnit XML报告文件格式,在此页面上我们竭尽全力提供了一个合理的文档示例。示例和xsd复制到下面,但是它们的页面看起来更好。


样本JUnit XML文件

<?xml version="1.0" encoding="UTF-8"?>
<!-- a description of the JUnit XML format and how Jenkins parses it. See also junit.xsd -->

<!-- if only a single testsuite element is present, the testsuites
     element can be omitted. All attributes are optional. -->
<testsuites disabled="" <!-- total number of disabled tests from all testsuites. -->
            errors=""   <!-- total number of tests with error result from all testsuites. -->
            failures="" <!-- total number of failed tests from all testsuites. -->
            name=""
            tests=""    <!-- total number of successful tests from all testsuites. -->
            time=""     <!-- time in seconds to execute all test suites. -->
        >

  <!-- testsuite can appear multiple times, if contained in a testsuites element.
       It can also be the root element. -->
  <testsuite name=""      <!-- Full (class) name of the test for non-aggregated testsuite documents.
                               Class name without the package for aggregated testsuites documents. Required -->
         tests=""     <!-- The total number of tests in the suite, required. -->
         disabled=""  <!-- the total number of disabled tests in the suite. optional -->
             errors=""    <!-- The total number of tests in the suite that errored. An errored test is one that had an unanticipated problem,
                               for example an unchecked throwable; or a problem with the implementation of the test. optional -->
             failures=""  <!-- The total number of tests in the suite that failed. A failure is a test which the code has explicitly failed
                               by using the mechanisms for that purpose. e.g., via an assertEquals. optional -->
             hostname=""  <!-- Host on which the tests were executed. 'localhost' should be used if the hostname cannot be determined. optional -->
         id=""        <!-- Starts at 0 for the first testsuite and is incremented by 1 for each following testsuite -->
         package=""   <!-- Derived from testsuite/@name in the non-aggregated documents. optional -->
         skipped=""   <!-- The total number of skipped tests. optional -->
         time=""      <!-- Time taken (in seconds) to execute the tests in the suite. optional -->
         timestamp="" <!-- when the test was executed in ISO 8601 format (2014-01-21T16:17:18). Timezone may not be specified. optional -->
         >

    <!-- Properties (e.g., environment settings) set during test
     execution. The properties element can appear 0 or once. -->
    <properties>
      <!-- property can appear multiple times. The name and value attributres are required. -->
      <property name="" value=""/>
    </properties>

    <!-- testcase can appear multiple times, see /testsuites/testsuite@tests -->
    <testcase name=""       <!-- Name of the test method, required. -->
          assertions="" <!-- number of assertions in the test case. optional -->
          classname=""  <!-- Full class name for the class the test method is in. required -->
          status=""
          time=""       <!-- Time taken (in seconds) to execute the test. optional -->
          >

      <!-- If the test was not executed or failed, you can specify one
           the skipped, error or failure elements. -->

      <!-- skipped can appear 0 or once. optional -->
      <skipped/>

      <!-- Indicates that the test errored. An errored test is one
           that had an unanticipated problem. For example an unchecked
           throwable or a problem with the implementation of the
           test. Contains as a text node relevant data for the error,
           for example a stack trace. optional -->
      <error message="" <!-- The error message. e.g., if a java exception is thrown, the return value of getMessage() -->
         type=""    <!-- The type of error that occured. e.g., if a java execption is thrown the full class name of the exception. -->
         ></error>

      <!-- Indicates that the test failed. A failure is a test which
       the code has explicitly failed by using the mechanisms for
       that purpose. For example via an assertEquals. Contains as
       a text node relevant data for the failure, e.g., a stack
       trace. optional -->
      <failure message="" <!-- The message specified in the assert. -->
           type=""    <!-- The type of the assert. -->
           ></failure>

      <!-- Data that was written to standard out while the test was executed. optional -->
      <system-out></system-out>

      <!-- Data that was written to standard error while the test was executed. optional -->
      <system-err></system-err>
    </testcase>

    <!-- Data that was written to standard out while the test suite was executed. optional -->
    <system-out></system-out>
    <!-- Data that was written to standard error while the test suite was executed. optional -->
    <system-err></system-err>
  </testsuite>
</testsuites>

JUnit XSD文件

<?xml version="1.0" encoding="UTF-8" ?>
<!-- from https://svn.jenkins-ci.org/trunk/hudson/dtkit/dtkit-format/dtkit-junit-model/src/main/resources/com/thalesgroup/dtkit/junit/model/xsd/junit-4.xsd -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">

    <xs:element name="failure">
        <xs:complexType mixed="true">
            <xs:attribute name="type" type="xs:string" use="optional"/>
            <xs:attribute name="message" type="xs:string" use="optional"/>
        </xs:complexType>
    </xs:element>

    <xs:element name="error">
        <xs:complexType mixed="true">
            <xs:attribute name="type" type="xs:string" use="optional"/>
            <xs:attribute name="message" type="xs:string" use="optional"/>
        </xs:complexType>
    </xs:element>

    <xs:element name="properties">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="property" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="property">
        <xs:complexType>
            <xs:attribute name="name" type="xs:string" use="required"/>
            <xs:attribute name="value" type="xs:string" use="required"/>
        </xs:complexType>
    </xs:element>

    <xs:element name="skipped" type="xs:string"/>
    <xs:element name="system-err" type="xs:string"/>
    <xs:element name="system-out" type="xs:string"/>

    <xs:element name="testcase">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="skipped" minOccurs="0" maxOccurs="1"/>
                <xs:element ref="error" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element ref="failure" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element ref="system-out" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element ref="system-err" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
            <xs:attribute name="name" type="xs:string" use="required"/>
            <xs:attribute name="assertions" type="xs:string" use="optional"/>
            <xs:attribute name="time" type="xs:string" use="optional"/>
            <xs:attribute name="classname" type="xs:string" use="optional"/>
            <xs:attribute name="status" type="xs:string" use="optional"/>
        </xs:complexType>
    </xs:element>

    <xs:element name="testsuite">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="properties" minOccurs="0" maxOccurs="1"/>
                <xs:element ref="testcase" minOccurs="0" maxOccurs="unbounded"/>
                <xs:element ref="system-out" minOccurs="0" maxOccurs="1"/>
                <xs:element ref="system-err" minOccurs="0" maxOccurs="1"/>
            </xs:sequence>
            <xs:attribute name="name" type="xs:string" use="required"/>
            <xs:attribute name="tests" type="xs:string" use="required"/>
            <xs:attribute name="failures" type="xs:string" use="optional"/>
            <xs:attribute name="errors" type="xs:string" use="optional"/>
            <xs:attribute name="time" type="xs:string" use="optional"/>
            <xs:attribute name="disabled" type="xs:string" use="optional"/>
            <xs:attribute name="skipped" type="xs:string" use="optional"/>
            <xs:attribute name="timestamp" type="xs:string" use="optional"/>
            <xs:attribute name="hostname" type="xs:string" use="optional"/>
            <xs:attribute name="id" type="xs:string" use="optional"/>
            <xs:attribute name="package" type="xs:string" use="optional"/>
        </xs:complexType>
    </xs:element>

    <xs:element name="testsuites">
        <xs:complexType>
            <xs:sequence>
                <xs:element ref="testsuite" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
            <xs:attribute name="name" type="xs:string" use="optional"/>
            <xs:attribute name="time" type="xs:string" use="optional"/>
            <xs:attribute name="tests" type="xs:string" use="optional"/>
            <xs:attribute name="failures" type="xs:string" use="optional"/>
            <xs:attribute name="disabled" type="xs:string" use="optional"/>
            <xs:attribute name="errors" type="xs:string" use="optional"/>
        </xs:complexType>
    </xs:element>

</xs:schema>

那如何使失败看起来好看?我想手动添加换行符,但它们不会出现在Jenkins中。
Rationalcoder

这是我的方法的缺点。我记得在那口井里挣扎。尝试添加&lt; br /&gt;之类的内容。-我忘记了如何解决此问题(并且我们不再使用它了),但这似乎值得尝试。
parvus

1
我找到了解决方法。因为我们使用的是c ++,所以我只是在失败消息中报告失败的数量,并使用“堆栈跟踪”报告实际的失败。由于堆栈跟踪是从带有故障元素的正文的文本中报告的,因此可以正确地支持新行。
Rationalcoder

25

我在此上找不到任何好的信息,因此我做了一些反复试验。Jenkins(v1.585)可以识别以下属性和字段(这些)。

<?xml version="1.0" encoding="UTF-8"?>
<testsuite>

  <!-- if your classname does not include a dot, the package defaults to "(root)" -->
  <testcase name="my testcase" classname="my package.my classname" time="29">

    <!-- If the test didn't pass, specify ONE of the following 3 cases -->

    <!-- option 1 --> <skipped />
    <!-- option 2 --> <failure message="my failure message">my stack trace</failure>
    <!-- option 3 --> <error message="my error message">my crash report</error>

    <system-out>my STDOUT dump</system-out>

    <system-err>my STDERR dump</system-err>

  </testcase>

</testsuite>

(我从这个示例XML文档开始,然后从那里开始。)


6

基本结构这是一个JUnit输出文件的示例,显示了跳过和失败的结果以及单个传递的结果。

<?xml version="1.0" encoding="UTF-8"?>
<testsuites>
   <testsuite name="JUnitXmlReporter" errors="0" tests="0" failures="0" time="0" timestamp="2013-05-24T10:23:58" />
   <testsuite name="JUnitXmlReporter.constructor" errors="0" skipped="1" tests="3" failures="1" time="0.006" timestamp="2013-05-24T10:23:58">
      <properties>
         <property name="java.vendor" value="Sun Microsystems Inc." />
         <property name="compiler.debug" value="on" />
         <property name="project.jdk.classpath" value="jdk.classpath.1.6" />
      </properties>
      <testcase classname="JUnitXmlReporter.constructor" name="should default path to an empty string" time="0.006">
         <failure message="test failure">Assertion failed</failure>
      </testcase>
      <testcase classname="JUnitXmlReporter.constructor" name="should default consolidate to true" time="0">
         <skipped />
      </testcase>
      <testcase classname="JUnitXmlReporter.constructor" name="should default useDotNotation to true" time="0" />
   </testsuite>
</testsuites>

以下是典型的JUnit XML报表的文档结构。请注意,一个报告可以包含1个或多个测试套件。每个测试套件都有一组属性(记录环境信息)。每个测试套件还包含一个或多个测试用例,如果测试未通过,则每个测试用例将包含跳过,失败或错误节点。如果测试用例通过,则它将不包含任何节点。有关每个节点有效的属性的更多详细信息,请参阅以下“模式”部分。

<testsuites>        => the aggregated result of all junit testfiles
  <testsuite>       => the output from a single TestSuite
    <properties>    => the defined properties at test execution
      <property>    => name/value pair for a single property
      ...
    </properties>
    <error></error> => optional information, in place of a test case - normally if the tests in the suite could not be found etc.
    <testcase>      => the results from executing a test method
      <system-out>  => data written to System.out during the test run
      <system-err>  => data written to System.err during the test run
      <skipped/>    => test was skipped
      <failure>     => test failed
      <error>       => test encountered an error
    </testcase>
    ...
  </testsuite>
  ...
</testsuites>

4

“ JUnit”和“ xUnit”结果有多个模式。

请注意,Jenkins xunit-plugin使用的模式有多个版本(当前的最新版本junit-10.xsd添加了对Erlang / OTP Junit格式的支持)。

一些测试框架以及“ xUnit”风格的报告插件也使用它们自己的秘密工具来生成“ xUnit”风格的报告,这些报告可能未使用特定的架构(请阅读:他们试图这样做,但这些工具可能无法针对任何形式进行验证一种模式)。Jenkins中的Python单元测试?可以快速比较其中的几个库,并在生成的xml报告之间略有不同。


2

关于使用python的良好答案:(有很多方法可以使用) Jenkins中的Python单元测试?

恕我直言,最好的方法是编写python unittest测试安装pytest(类似于“ yum install pytest”)来安装py.test。然后运行这样的测试:'py.test --junitxml results.xml test.py'。您可以运行任何unittest python脚本并获取jUnit xml结果。

https://docs.python.org/2.7/library/unittest.html

在jenkins构建配置中,构建后操作添加带有result.xml以及您生成的更多测试结果文件的“发布JUnit测试结果报告”操作。


2

我决定发布新答案,因为一些现有答案已过时或不完整。

首先:没有类似的东西JUnit XML Format Specification,仅仅是因为JUnit不产生任何类型的XML或HTML报告。

XML报告生成本身来自Ant JUnit任务/ Maven Surefire插件/ Gradle(用于运行测试的任何一种)。XML报告格式最初由Ant引入,后来由Maven(和Gradle)改编。

如果有人只需要一种正式的XML格式,则:

  1. 有一个由maven surefire生成的XML报告的模式,可以在以下位置找到:surefire-test-report.xsd
  2. 对于一只蚂蚁生成的XML有可用的第三方模式在这里(但它可能会稍微过时的)。

希望它能帮助到别人。


感谢您的澄清。我正试图将JUnit测试摘要从旧的Jenkins 1.6实例发送到Slack-也许您能帮上忙吗?我将在哪里放置这样的XML文件?
JJD

@JJD对不起,我不明白你的意思。这样的XML文件到底是什么意思?但是我假设您已经使用ant / maven / gradle运行了JUnit测试,是吗?如果是,则这些工具在执行测试后会生成漂亮的摘要报告。Jenkins的版本在这里无关紧要。
G. Demecki '17

是的,我的构建通过Gradle运行。我想在使用Jenkins 1.6时将JUnit测试摘要发送到Slack频道。阅读GitHub讨论后,我认为我必须将配置XML文件放在某个地方,以使Slack插件获得测试摘要。也许我误会了。
JJD

1
在Gradle启动JUnit测试之后,请检查是否存在正确生成的测试报告。然后,Slack插件应该能够使用这些报告。
G. Demecki '17

1
最后,您的建议将我推向正确的方向:我必须配置正确的路径来查找XML文件。对于我的具有多种Gradle产品口味的Android项目,以下工作原理:。非常感谢你!!!**/build/test-results/**/TEST-*.xml
JJD
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.