junit-processor

A JUnit XML post processing utility, for cleaning up, modifying some data on these reports, or even do some other operations on these reports. Please consider this highly experimental :)

Features

• remove testcase elements that are marked as skipped, or that have failures or errors
• updates test counters on parent testsuite element, and on root testsuites element if present
• applies patches, to fix/change the JUnit produced by some tools
• validate JUnit XML report against known schemas (e.g., jenkins, ant)

Nice-2-have

• update testcase elements that match a certain criteria

Installation

npm install -g junit-processor

Or just download the repository and include it in your node_modules directly.

Usage

Usage: junit-processor [options] <inputJunitXMLfile>

Options:
  -V, --version              output the version number
  -s, --removeSkipped        remove skipped testcases
  -e, --removeErrors         remove testcases with errors
  -f, --removeFailures       remove testcases with failures
  -x, --schema               validate against known schemas
  -p, --patches <listOfIds>  patches to apply, by their id, delimited by comma; see https://github.com/bitcoder/junit-processor#readme
  -o, --out <outputfile>     file to output to (default: "./junit-new.xml")
  -d, --debug                print debug information
  -h, --help                 display help for command

Patches

Ahead please find a list of patches that you can apply. Each patch is identified by an id, which is a number.

Example for applying patch 1 on a JUnit XML file:

junit-processor -p 1 some_junit_report.xml

Example for applying patch 1 and 3, in that order, on a JUnit XML file:

junit-processor -p 1,3 some_junit_report.xml

Patch 1

This patch fixes the name attribute of testcase elements of JUnit XML reports produced by Karate DSL, in order to remove the line numbers which may change with time. The purpose of this patch is to make testcase elements uniquely identifiable, based on their name and classname attributes.

For example,

<testcase name="[1:9] create and retrieve a cat" classname="[demo/cats/cats] cats end-point" time="0.248"/>

becomes...

<testcase name="create and retrieve a cat" classname="[demo/cats/cats] cats end-point" time="0.248"/>

Patch 2

This patch enforces the classname attribute of testcase elements of JUnit XML reports to be junit-processor, even if doesn't exist.

For example,

<testcase name="xx" time="0.248"/>

becomes...

<testcase name="xx" classname="junit-processor" time="0.248"/>

Patch 3

This patch creates one single failure element, in case testcase elements of JUnit XML contain more than one (such as the ones produced by TestComplete). The failure element will have one default message and the inner contents correspond to the concatenation of the original failure elements.

For example,

    <testcase name="Invoice" time="18" classname="FleetApp">
      <failure message="The property checkpoint failed, because Text does not equal (case-sensitive) &quot;150.0&quot;. See Details for additional information.">x1</failure>
      <failure message="The test run has stopped because the test item is configured to stop on errors."></failure>
    </testcase>

becomes...

    <testcase name="Invoice" time="18" classname="FleetApp">
      <failure message="multiple failures">
      The property checkpoint failed, because Text does not equal (case-sensitive) &quot;150.0&quot;. See Details for additional information.
      x1
      The test run has stopped because the test item is configured to stop on errors
      </failure>
    </testcase>

Patch 4

This patch removes all testcase elements, except the ones that have a property with name "requirements" or "test_key". These properties are usually provided by the xray-junit-extensions project to provide more info on the tests that Xray Test Management will consume.

For example, the first testcase will be included while the second one won't.

    <testcase name="Test login page @CALC-1" classname="specs/tags.spec.mjs:3:1 › Test login page @CALC-1" time="3.767">
        <properties>
            <property name="test_key" value="CALC-2">
            </property>
            <property name="requirements" value="CALC-5">
            </property>
        </properties>
        <system-out>
            <![CDATA[
        [[ATTACHMENT|test-results/specs-tags-Test-login-page-CALC-1/tmp_screenshot.png]]
        ]]>
        </system-out>
    </testcase>

    <testcase name="Invoice" time="18" classname="FleetApp">
    </testcase>

After the patch, it becomes...

    <testcase name="Test login page @CALC-1" classname="specs/tags.spec.mjs:3:1 › Test login page @CALC-1" time="3.767">
        <properties>
            <property name="test_key" value="CALC-2">
            </property>
            <property name="requirements" value="CALC-5">
            </property>
        </properties>
        <system-out>
            <![CDATA[
        [[ATTACHMENT|test-results/specs-tags-Test-login-page-CALC-1/tmp_screenshot.png]]
        ]]>
        </system-out>
    </testcase>

Contributing

Feel free to submit issues and/or PRs! In lieu of a formal style guide, please follow existing styles. Please check the following commands that may be useful while developing and testing.

Linting/checking for JS syntax:

npm run lint

Running tests:

npm test

Checking code coverage:

npm run coverage

Contact

You can find me on Twitter.

Acknowledgments

This work was highly based on previous work from junit-merge

LICENSE

Apache 2.0.