Matthieu Baerts 1d6e580ff3
xunit: support versions 3+
A new major version (3.0.0) of XUnit plugin has been released in January
2021:

  https://github.com/jenkinsci/xunit-plugin/releases/

I didn't have an issue when I upgraded the plugin from version 2.4.0 to
3.0.0. But I started to have this error at the end of a build and I
guess it appeared only after having modified the configuration of the
Jenkins jobs with JJB:

  ERROR: Build step failed with exception
  java.lang.IllegalArgumentException: The tools section is required.
	at org.jenkinsci.plugins.xunit.XUnitProcessor.<init>(XUnitProcessor.java:139)
	at org.jenkinsci.plugins.xunit.XUnitPublisher.perform(XUnitPublisher.java:204)
	at jenkins.tasks.SimpleBuildStep.perform(SimpleBuildStep.java:123)
	at hudson.tasks.BuildStepCompatibilityLayer.perform(BuildStepCompatibilityLayer.java:80)
	at hudson.tasks.BuildStepMonitor$1.perform(BuildStepMonitor.java:20)
	at hudson.model.AbstractBuild$AbstractBuildExecution.perform(AbstractBuild.java:803)
	at hudson.model.AbstractBuild$AbstractBuildExecution.performAllBuildSteps(AbstractBuild.java:752)
	at hudson.model.Build$BuildExecution.post2(Build.java:177)
	at hudson.model.AbstractBuild$AbstractBuildExecution.post(AbstractBuild.java:697)
	at hudson.model.Run.execute(Run.java:1932)
	at hudson.model.FreeStyleBuild.run(FreeStyleBuild.java:43)
	at hudson.model.ResourceController.execute(ResourceController.java:97)
	at hudson.model.Executor.run(Executor.java:429)
  Build step 'Publish xUnit test result report' marked build as failure

When looking at the configuration of the job from the Web UI, the XUnit
plugin was enabled but left "unconfigured": no file to look at.

Apparently, JJB is sending a XML config that is not understood by XUnit
plugin anymore. I guess I didn't have any issue before updating the
Jenkins jobs with JJB because when upgrading XUnit plugin from 2.4.0 to
3.0.0, Jenkins migrated the config to the new format.

From what I see when analysing the generated XML from JJB and the one
from Jenkins after having configured a job manually, a sub-element has
been renamed, from 'types' to 'tools'. I suspect this is caused by this
commit:

  https://github.com/jenkinsci/xunit-plugin/commit/aa47ac57d

(XUnitBuilder class had this line: @XStreamAlias("types"))

So here, I simply picked 'tools' or 'types' for the sub-element and
depending on the plugin's version in both the builder and the publisher
parts. I'm only using the publisher but I guess the problem is the same
with the builder.

Tests have been adapted to verify both versions <3.0.0 and >=3.0.0.

Change-Id: Ie78539d0ae25ddc139ad9982cdffd2e683dd40b2
Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
2021-03-17 16:21:33 +01:00
2021-03-17 16:21:33 +01:00
2014-05-29 09:30:49 -07:00
2021-03-17 16:21:33 +01:00
2018-11-14 23:56:26 +00:00
2019-04-19 19:49:46 +00:00
2018-04-05 12:14:13 +01:00
2012-11-16 00:22:31 +00:00
2020-01-22 18:23:25 -05:00

README

Jenkins Job Builder takes simple descriptions of Jenkins jobs in YAML or JSON format and uses them to configure Jenkins. You can keep your job descriptions in human readable text format in a version control system to make changes and auditing easier. It also has a flexible template system, so creating many similarly configured jobs is easy.

To install:

$ pip install --user jenkins-job-builder

Online documentation:

Developers

Bug report:

Repository:

Cloning:

git clone https://opendev.org/jjb/jenkins-job-builder.git

Install pre-commit from https://pre-commit.com/#intro in order to run some minimal testing on your commits.

A virtual environment is recommended for development. For example, Jenkins Job Builder may be installed from the top level directory:

$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -r test-requirements.txt -e .

Patches are submitted via Gerrit at:

Please do not submit GitHub pull requests, they will be automatically closed.

Mailing list:

IRC:

  • #openstack-jjb on Freenode

More details on how you can contribute is available on our wiki at:

Writing a patch

We ask that all code submissions be pep8 and pyflakes clean. The easiest way to do that is to run tox before submitting code for review in Gerrit. It will run pep8 and pyflakes in the same manner as the automated test suite that will run on proposed patchsets.

When creating new YAML components, please observe the following style conventions:

  • All YAML identifiers (including component names and arguments) should be lower-case and multiple word identifiers should use hyphens. E.g., "build-trigger".
  • The Python functions that implement components should have the same name as the YAML keyword, but should use underscores instead of hyphens. E.g., "build_trigger".

This consistency will help users avoid simple mistakes when writing YAML, as well as developers when matching YAML components to Python implementation.

Unit Tests

Unit tests have been included and are in the tests folder. Many unit tests samples are included as examples in our documentation to ensure that examples are kept current with existing behaviour. To run the unit tests, execute the command:

tox -e py34,py27
  • Note: View tox.ini to run tests on other versions of Python, generating the documentation and additionally for any special notes on running the test to validate documentation external URLs from behind proxies.

Installing without setup.py

For YAML support, you will need libyaml installed.

Mac OS X:

$ brew install libyaml

Then install the required python packages using pip:

$ sudo pip install PyYAML python-jenkins
Description
Tools to make Jenkins jobs from templates
Readme 36 MiB
Languages
Python 99%
Shell 0.7%
C++ 0.2%