QA TOUCH + WEBDRIVERIO

Send WebdriverIO results to your QA Touch test run

Add the QA Touch reporter to wdio.conf.js and start each test title with its QA Touch ID. Every WebdriverIO run then updates the matching test cases.

Setup: API key, reporter package, wdio config

WebdriverIO runs the browser. QA Touch keeps the record.

Your Mocha specs already drive the browser. The QA Touch reporter sends what happened to the test run your team reports from, so nobody retypes pass and fail.

  • Problem: Results from a WebdriverIO run are copied into QA Touch by hand.

    With the integration: The reporter syncs results to the test run and updates the test case statuses.

  • Problem: Reporter settings are easy to get wrong.

    With the integration: The wdio config button on the test run shows the API key and details to copy.

  • Problem: It’s unclear which spec feeds which test run.

    With the integration: A QA Touch ID at the start of each test title ties the test to the run.

Illustrative sample data. Test names are examples.

What the integration does

Four capabilities from QA Touch’s WebdriverIO guide, from the first config to the updated test run.

Config from the test run

Open a test run, click the wdio config button, and copy the API key and details from the popup.

Per test run

A reporter in wdio.conf.js

Add the wdio-qatouch-reporter package to the reporters section, with domain, apiToken, projectKey and testRunId.

Tests tied to the run

Start each test title with the QA Touch ID, such as TR0032 in the guide’s sample spec.

Results sync as tests run

The reporter runs during execution. Results are synced to the test run and the case statuses are updated.

From wdio config to updated test case

Step through the flow. The screens are schematic, drawn from the labels in the setup guide, not screenshots.

QA Touch My Profile Generate API key

Get an API key and install the package

Generate an API key under My Profile, then install the reporter from your automation project's command line.

QA Touch Test run wdio config

Copy the details from the test run

Open your project's test run and click the wdio config button. The popup shows the API key and the details to copy.

Your project wdio.conf.js

Add the reporter to wdio.conf.js

Require the reporter at the top of the file, then add it to the reporters section with the values from the popup.

Your project spec file

Start each test title with the ID

In your Mocha spec, put the QA Touch ID at the start of the it() title. The guide's sample uses TR0032.

Your project run WebdriverIO QA Touch test run

Run your scripts, then check the run

Run your WebdriverIO scripts as usual. The results appear in the QA Touch test run and the test case statuses are updated.

Illustrative sample data. Test names are examples.

What changes for your QA team

Specs stay in your repository. Outcomes show up in the test run.

No copying results

Statuses move from WebdriverIO to QA Touch on their own, so nobody retypes pass and fail.

Specs point at the run

The ID in each test title shows in the code which QA Touch run a test reports to.

One place to report from

Automated results sit in the same test run as the rest of your testing, ready for the team to review.

Keep your spec reporter

The sample config adds the QA Touch reporter next to the spec reporter, so console output stays as it is.

Who uses it, and for what

Choose a role to see a scenario the integration supports.

A browser suite needs a run to report to

The team writes WebdriverIO tests and wants their results in QA Touch.

What they do

  1. Generate an API key under My Profile.
  2. Open the test run and click the wdio config button.
  3. Pass the popup's details to the automation engineer.

Result: the engineer has the exact domain, token and keys for that run.

Existing specs need to report

You maintain WebdriverIO Mocha specs and want them to feed QA Touch.

What they do

  1. Install wdio-qatouch-reporter.
  2. Require it in wdio.conf.js and add it to the reporters section.
  3. Start each test title with the QA Touch ID.

Result: each run updates the cases in the QA Touch test run.

Reviewing an automated run

You need to know how many cases passed before sign-off.

What they do

  1. Open the test run in QA Touch after the WebdriverIO run.
  2. Check the updated case statuses.
  3. Follow up on the failures.

Result: the run reflects the latest WebdriverIO outcome without manual updates.

You fixed something and want to re-check

You changed code and want to confirm the affected tests pass.

What they do

  1. Re-run the affected WebdriverIO tests.
  2. Open the QA Touch test run.
  3. Confirm the case status changed.

Result: the fix is confirmed in the same run the QA team reports from.

Set it up in four parts

These steps follow QA Touch’s WebdriverIO (Mocha) integration guide.

Before you start

  • A WebdriverIO project that uses Mocha, with npm.
  • A QA Touch project with a test run.
  • A QA Touch login that can generate an API key.

The guide shows both a testRunId setting and a test run ID at the start of each test title, and doesn’t say whether both are needed. Use the values in your wdio config popup, then check the test run after your first run.

  1. Log in to QA Touch, open My Profile and choose Generate API key.
  2. From your automation project's command line, run npm i wdio-qatouch-reporter.
  1. Open your project's test run in QA Touch.
  2. Click the wdio config button.
  3. Copy the API key and details from the popup.
  1. Open wdio.conf.js and add let QaTouchReporter = require('wdio-qatouch-reporter/lib/index'); at the top.
  2. In reporters, add [QaTouchReporter, { qaTouchOptions: {…} }] next to 'spec'.
  3. Set domain, apiToken, projectKey and testRunId from the popup.
  1. Start each it() title with the QA Touch ID. The guide's sample is TR0032.
  2. Run your WebdriverIO scripts. The guide doesn't give a specific command.
  3. Check the QA Touch test run. The results should appear and the case statuses update.

Specs tagged? See how results reach the run.

Questions about the WebdriverIO integration

Answers are based on QA Touch’s WebdriverIO integration guide.

What does the QA Touch WebdriverIO integration do?

A QA Touch reporter in your WebdriverIO project syncs test results to a QA Touch test run and updates the statuses of the matching test cases.

Open the test run in QA Touch and click the wdio config button. The popup shows the API key and details to copy. You can generate an API key under My Profile.

Require wdio-qatouch-reporter at the top of the file and add it to the reporters section, with qaTouchOptions for domain, apiToken, projectKey and testRunId.

The guide’s sample puts the QA Touch ID (TR0032) at the start of the it() title. It also sets testRunId in the config, and doesn’t say whether both are required, so use the values from your popup and check the run after your first execution.

The guide is for WebdriverIO with Mocha (describe and it) and npm. It doesn’t list supported versions of WebdriverIO, Mocha, Node.js or the reporter.

Run your WebdriverIO scripts as you normally would. The guide doesn’t give a specific command. Afterwards, check the QA Touch test run for the results.

The guide describes results going from WebdriverIO into QA Touch. It doesn’t describe what data is sent beyond results and statuses, or any sync back.

Connect WebdriverIO to QA Touch

Add the reporter, tag your tests, and let the next WebdriverIO run update your test run.