Codebeamer xUnit Uploader Plugin

This plugin publishes xUnit Results into Codebeamer Test-Cases and Test-Runs.

Prerequisites

• Create a user in Codebeamer. Ensure it has the necessary rights to access REST API.
  
• Test the access with the user to ensure it works properly. For example access the Codebeamer version like this: http://192.168.100.101:8091/cb/rest/version
  

The the V1 GET /version endpoint has been removed since Codebeamer 22.04 (FELICITY) release.

• Add the aforementioned user to the target project, where the plugin should upload test results.
• Ensure that the user can access a Test Configuration, Test Case and Test Run tracker. Ensure that the user has write access in the Test Case and Test Run tracker.
• This plugin has been tested with Freestyle Jenkins projects.
• Write down the exact location of the Jenkins project's workspace. Note: You must build the project first to create a workspace.

Installing Plugin

Go to "Manage jenkins" page and click on "Plugin manager".

You have two options to install:

• First case:
  1. Go to the Available tab.
  2. Select XUnit Uploader plugin.
  3. Click on "Install without restart" button.
• Second case:
  1. Download the plugin source code from GitHub and build it.
  2. Go to Advanced tab.
  3. Go to Upload Plugin section and upload the hpi file.

Adding Plugin

1. Go to the settings page of your jenkins job.
   
2. Go to "Post-build Actions" tab and click on "Add post-build action" button.
   
3. Select Codebeamer XUunit Uploader plugin.
   

Configuring Plugin

Now you can see the following screen:

Configuration Options:

• Disable XUnit Uploader
  If this is set to true then the plugin does not upload test results to Codebeamer.
• Codebeamer URL
  You can set the URL of Codebeamer instance. It is mandatory. Example: http://example.com/cb
• Credentials
  You can set a Codebeamer user, user should have "Rest / Remote API - Access" permission. It is mandatory.
• Test Configuration ID
  You can set a test configuration to the generated test cases. This is Test Configuration tracker item coming from the prepared tracker. It is mandatory.
  
• Test Case Tracker ID
  You can set a test case tracker. The generated test cases are created on this tracker. It is mandatory if test case id is not set.
• Test Case ID
  You can set a parent test case item. The generated test cases are created under this item. It is optional.
  Warning: This option override test case tracker option!
• Test Run Tracker ID
  You can set a test run tracker. The generated test case runs are created on this tracker. It is mandatory.
• Release ID
  You can set a release. This is set in all generated test case run items. It is optional
• Test Results Directory
  You can set the test result directory. This contains the test result xml files. You can use relative path and the root folder is the workspace folder of your jenkins job in this case. It is mandatory.
  Note: Locate the folder within the workspace, which contains the xml files. This might be different in different projects. Plugin does not contain any hardcoded path.
• Default Package Prefix
  You can set a package prefix. It is optional.
  For example: abc.test.ng
  In this case the test results are filtered by this prefix.

Results

After successful build, the xUnit Uploader Plugin sends the test results to the Codebeamer instance. These will appear among the test cases and test runs in the specified trackers.