web-dev-qa-db-ja.com

HudsonがサポートするJUnit XML形式仕様とは何ですか？

Hudsonを継続的インテグレーションサーバーとして使用しており、オプション「Publish JUnit test result report」を使用したい。しかし、テストにはxUnitツールを使用しません。代わりに、テストを実行し、結果を単純な形式で返すシェルスクリプトがあります。これらの結果をJUnit形式に変換するスクリプトを作成することを考えています。だから私はJUnitファイルがどのように見える必要があるのか​​興味深いですか？

jenkinsjunithudsonxunit
169
krvladislav

数か月前に同様のことをしましたが、Hudsonがテストプロトコルとして受け入れるには、この単純なフォーマットで十分であることがわかりました。

<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出力の仕様

122
Anders Lindahl

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要素は1つしか存在できません。これはXMLの仕組みです。ただし、testsuite要素内には複数のtestsuites要素を含めることができます。
  • 各properties要素には、複数のproperty子を含めることができます。
  • 各testsuite要素には、複数のtestcase子を含めることができます。
  • 各testcase要素には、複数のerror、failure、system-out、またはsystem-errの子を含めることができます。

XMLSpear options

83
Todd Mazierski

トップアンサー 質問の Anders Lindahl は xsdファイル を参照します。

個人的に私は このxsdファイル も非常に便利だと思いました（どうやって見つけたのか覚えていません）。少し威圧的に見えますが、私が使用した限り、すべての要素と属性はJenkins（v1.451）によって認識されるようです。

ただし、複数の<failure ...要素を追加すると、Jenkinsには1つしか保持されませんでした。 xmlファイルを作成するとき、すべての失敗を1つに連結するようになりました。

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>
36
parvus

これに関する良い情報が見つからなかったので、試行錯誤を繰り返しました。次の属性とフィールド（およびonlyこれら）は、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ドキュメント から始め、そこから逆方向に作業しました。）

24
Ian

基本構造以下に、JUnit出力ファイルの例を示します。スキップと失敗の結果、および1つの合格した結果を示しています。

<?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つ以上のテストスイートを含めることができます。各テストスイートには、一連のプロパティ（環境情報の記録）があります。各テストスイートには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>
6
Nayana Adassuriya

「JUnit」および「xUnit」の結果には複数のスキーマがあります。

Jenkins xunit-pluginで使用されているスキーマには、いくつかのバージョンがあることに注意してください（現在の最新バージョンは、Erlang/OTP Junit形式のサポートを追加するjunit-10.xsdです）。

一部のテストフレームワークおよび「xUnit」スタイルのレポートプラグインも独自の秘密ソースを使用して「xUnit」スタイルのレポートを生成します。特定のスキーマを使用しない場合があります（必ずお読みください。 1つのスキーマ）。 JenkinsのPythonユニットテスト？ は、これらのライブラリのいくつかをすばやく比較し、生成されたxmlレポートのわずかな違いを示します。

4
dnozay

既存の回答の一部が古いか不完全であるため、新しい回答を投稿することにしました。

まず、JUnitがXMLまたはHTMLレポートを作成しないため、JUnit XML Format Specificationのようなものはありません。

XMLレポート生成自体は、Ant JUnitタスク/ Maven Surefireプラグイン/ Gradle（テストの実行に使用するもの）から取得されます。 XMLレポート形式は最初にAntによって導入され、後にMaven（およびGradle）によって適合されました。

誰かが公式のXML形式を必要とする場合：

  1. Maven surefireで生成されたXMLレポート用のスキーマが存在し、次の場所にあります： surefire-test-report.xsd 。
  2. Antで生成されたXMLには、利用可能なサードパーティのスキーマがあります here （ただし、少し古いかもしれません）。

それが誰かを助けることを願っています。

2
G. Demecki

Pythonの使用に関する良い答え：（それを行う方法はたくさんあります） JenkinsでのPythonユニットテスト？

私見の最良の方法は、write python unittest testsandinstall 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ビルド構成でビルド後のアクション「JUnitテスト結果レポートの発行」アクションをresult.xmlおよび作成するテスト結果ファイルで追加します。

1
gaoithe