QA TOUCH + JENKINS
Start Jenkins builds from QA Touch and map the results to test runs
Connect Jenkins once, map a Jenkins project to a QA Touch test run, and kick off builds from QA Touch. The build results mark the mapped test cases passed or failed.
Setup: Jenkins API token, connection, test run mapping
Jenkins runs the build. QA Touch keeps the results.
Automated tests already run in Jenkins. This integration ties those builds to QA Touch test runs, so the pass and fail results land on the test cases your team tracks.
-
Problem: Build results sit in Jenkins while test runs sit in QA Touch.
With the integration: Results from the build mark the mapped test run cases as passed or failed.
-
Problem: Starting a build means switching to Jenkins.
With the integration: Browse Jenkins jobs and click Start Build from inside QA Touch.
-
Problem: It’s unclear which automated test belongs to which test case.
With the integration: Method names carry the QA Touch case code, so each result finds its case.
Build Listing
Illustrative sample data. Build numbers and test names are examples.
What the integration does
Five capabilities from QA Touch’s Jenkins guide and blog post, from the first connection to results on your cases.
Connect with a Jenkins token
An Administrator enters the Jenkins username, URL and API token under Administration → Integration Settings. The status shows connected.
Browse jobs and builds
The Jenkins menu lists your jobs. Open one to see its builds, console output, build stats and Start Build.
Map a project to a test run
On the build list, click Map Test Run and pick the QA Touch project, the test run and the Jenkins result plugin.
Start builds from QA Touch
Click Start Build on a job. Builds started from QA Touch update the mapped cases automatically.
Pass and fail on your cases
Results from the TestNG or JUnit plugin mark the mapped test run cases passed or failed.
From Jenkins token to results on your test run
Step through the flow. The screens are schematic, drawn from the labels in the guide and blog post, not screenshots.
One-time Jenkins profile menu → configure → API token
Generate a Jenkins API token
Click Add New Token, give it a name and click generate. Copy the token straight away, because Jenkins shows it only once.
The token is shown only once. Copy it before you leave the page.
QA Touch Administration → Integration Settings
Connect Jenkins
An Administrator enters the Jenkins username, the Jenkins URL and the token, then clicks submit. The status shows connected.
QA Touch Jenkins menu → Job List → Build Listing
Open a Jenkins job
The Job List shows your freestyle projects. Click one to open its build listing, with build counts, console output, Start Build and Build Stats.
QA Touch Build list → Map Test Run
Map the job to a test run
In the Map Test Run popup, select the QA Touch project, the test run and the Jenkins result plugin, TestNG or JUnit.
QA Touch Start Build → Jenkins → mapped test run
Build, then see the results
Start the build from QA Touch. When it finishes, the results mark the mapped test run cases as passed or failed.
Illustrative sample data. Job, run and test names are examples. The case-code prefix is explained under Setup.
What changes for your QA team
Automation keeps running in Jenkins. QA Touch gets the outcome.
No hand-updating statuses
Pass and fail come from the build, so testers don’t copy results from Jenkins into the test run.
Code tied to test cases
The case code in each test method name links an automated test to its QA Touch case.
Builds and test runs in one place
Console output and build stats are in QA Touch, next to the test run they feed.
One connection for the account
An Administrator connects Jenkins once. After that, each job only needs a test run mapping.
Who uses it, and for what
Choose a role to see a scenario the integration supports.
Your pipelines already run in Jenkins
You want QA Touch connected to the Jenkins server your team already uses.
What they do
- Generate an API token in Jenkins.
- Enter the username, URL and token under Administration → Integration Settings.
- Check that the status shows connected.
Result: QA Touch can list your Jenkins jobs and builds.
An automated suite needs a home
You maintain automated tests and want their results on QA Touch test cases.
What they do
- Prefix each test method with its QA Touch case code and a double underscore, such as TR002__.
- Use TestNG or JUnit so Jenkins produces the result files.
- Map the job to a QA Touch test run.
Result: each build updates the cases the methods point to.
Running regression on demand
You want to start a regression build and watch it without leaving QA Touch.
What they do
- Open the Jenkins menu and the job's build listing.
- Click Start Build.
- Check console output and Build Stats as the build runs.
Result: the mapped test run shows passed and failed cases once the build reports back.
You need to see why a build failed
A mapped case shows as failed and you want the build output.
What they do
- Open the job's build listing in QA Touch.
- View the console output as plain text, or download it.
- Fix the code and rebuild.
Result: the failure and its console output are one click from the test run.
Set it up in four parts
The token and connection steps follow QA Touch’s Jenkins integration guide. The mapping and naming steps come from QA Touch’s Jenkins blog post.
Before you start
- A running Jenkins server and a user that can create an API token.
- The TestNG or JUnit result plugin in Jenkins.
- A QA Touch Administrator login for the global configuration.
The help guide lists mapping as a step but doesn’t detail it. The mapping and naming steps here come from the blog post published in 2020, so your Jenkins screens may look different.
- Click the profile menu at the top.
- Click configure in the left section.
- In the API token section, click Add New Token.
- Give the token a name and click generate.
- Copy the token. It is shown only once.
- Log in to QA Touch as an Administrator.
- Go to Administration → Integration Settings.
- Enter your Jenkins username, the Jenkins URL and the token.
- Click submit.
connectedThe status shows connected when the configuration succeeds.
- Click the Jenkins menu in the sidebar to open the Job List.
- Click a project to open its build listing.
- Click Map Test Run.
- Select the QA Touch project, the test run and the Jenkins result plugin, then confirm.
- Builds you start from QA Touch now update the mapped cases.
- Produce results with TestNG or JUnit. The blog post says one of them is needed for mapping.
- Start each test method name with the QA Touch case code and a double underscore.
- For example, a method for case TR002 begins TR002__.
Run mapped? See how results reach your cases.
Questions about the Jenkins integration
Answers are based on QA Touch’s Jenkins guide and blog post.
What does the QA Touch Jenkins integration do?
It connects QA Touch to a Jenkins server. You can browse Jenkins jobs, start builds, and map a job to a QA Touch test run so build results mark the mapped cases as passed or failed.
How do I connect Jenkins to QA Touch?
Create an API token in Jenkins (profile menu, configure, Add New Token). Then, as an Administrator, go to Administration → Integration Settings, enter the Jenkins username, URL and token, and click submit. The status should show connected.
How do I map a Jenkins project to a test run?
Open the Jenkins menu, choose a project, and click Map Test Run on its build list. Select the QA Touch project, the test run and the Jenkins result plugin.
Which Jenkins plugin do I need?
The blog post names TestNG and JUnit as the result plugins, and says one of them is required for mapping.
How do automated tests find their test cases?
Start each test method name with the QA Touch case code and a double underscore. The blog post’s example is a method beginning TR002__ for case TR002.
Can I start a build from QA Touch?
Yes. Open a job’s build listing and click Start Build. Builds started from QA Touch update the mapped test run cases automatically. You can also view the console output as plain text or download it.
What isn't described?
The guide and blog post list freestyle projects and don’t describe other job types. They also don’t say what happens to unmapped test methods or failed connections, and the blog post dates from 2020, so check the current guide for any changes.
Connect Jenkins to QA Touch
Connect once, map a job to your first test run, and let the next build update your cases.