Skip to content

Zebrunner WebdriverIO reporting agent#

The official Zebrunner WebdriverIO reporting agent.

Inclusion into your project#

Including the agent into your project is easy - just install reporter package using package manager of your choice:

npm install @zebrunner/javascript-agent-webdriver

yarn add @zebrunner/javascript-agent-webdriver

Configuring reporting of test executions#

Once the agent is available in your test project, it is not automatically enabled. The valid configuration must be provided.

It is currently possible to provide the configuration via:

  1. Environment variables
  2. WebdriverIO config

The configuration lookup will be performed in the order listed above. It is also possible to override configuration parameters by passing them through a configuration provider with higher precedence.

via environment variables#

The following configuration parameters are recognized by the agent:

Parameter Description
REPORTING_ENABLED Enables or disables reporting. The default value is false. If disabled, the agent will use no op component implementations that will simply log output for tracing purposes with the trace level
REPORTING_SERVER_HOSTNAME Mandatory if reporting is enabled. It is Zebrunner server hostname. It can be obtained in Zebrunner on the 'Account & profile' page under the 'Service URL' section
REPORTING_SERVER_ACCESS_TOKEN Mandatory if reporting is enabled. Access token must be used to perform API calls. It can be obtained in Zebrunner on the 'Account & profile' page under the 'Token' section
REPORTING_PROJECT_KEY Optional value. It is the project that the test run belongs to. The default value is DEF. You can manage projects in Zebrunner in the appropriate section
REPORTING_RUN_DISPLAY_NAME Optional value. It is the display name of the test run. The default value is Default Suite
REPORTING_RUN_BUILD Optional value. It is the build number that is associated with the test run. It can depict either the test build number or the application build number
REPORTING_RUN_ENVIRONMENT Optional value. It is the environment where the tests will run
REPORTING_RUN_LOCALE Optional value. Locale, that will be displayed for the run in Zebrunner if specified
REPORTING_NOTIFICATION_NOTIFY_ON_EACH_FAILURE Optional value. Specifies whether Zebrunner should send notification to Slack/Teams on each test failure. The notifications will be sent even if the suite is still running. The default value is false
REPORTING_NOTIFICATION_SLACK_CHANNELS Optional value. The list of comma-separated Slack channels to send notifications to. Notification will be sent only if Slack integration is properly configured in Zebrunner with valid credentials for the project the tests are reported to. Zebrunner can send two type of notifications: on each test failure (if appropriate property is enabled) and on suite finish
REPORTING_NOTIFICATION_MS_TEAMS_CHANNELS Optional value. The list of comma-separated Microsoft Teams channels to send notifications to. Notification will be sent only if Teams integration is configured in Zebrunner project with valid webhooks for the channels. Zebrunner can send two type of notifications: on each test failure (if appropriate property is enabled) and on suite finish
REPORTING_NOTIFICATION_EMAILS Optional value. The list of comma-separated emails to send notifications to. This type of notification does not require further configuration on Zebrunner side. Unlike other notification mechanisms, Zebrunner can send emails only on suite finish
REPORTING_MILESTONE_ID Optional value. Id of the Zebrunner milestone to link the suite execution to. The id is not displayed on Zebrunner UI, so the field is basically used for internal purposes. If the milestone does not exist, appropriate warning message will be displayed in logs, but the test suite will continue executing
REPORTING_MILESTONE_NAME Optional value. Name of the Zebrunner milestone to link the suite execution to. If the milestone does not exist, appropriate warning message will be displayed in logs, but the test suite will continue executing

via WebdriverIO config#

It is also possible to configure agent via WebdriverIO config by providing corresponding reporter options. Below is a sample wdio.conf.js:

const { ZebrunnerReporter } = require('@zebrunner/javascript-agent-webdriver');
require("dotenv").config();

const config = {
  enabled: true,
  reportingServerHostname: "<server-hostname-goes-here>",
  reportingProjectKey: "DEF",
  reportingRunDisplayName: "Sample Web tests",
  reportingRunBuild: "alpha-1",
  reportingRunEnvironment: "STAGE",
  reportingRunLocale: "en_US",
  reportingNotificationNotifyOnEachFailure: true,
  reportingNotificationSlackChannels: "channel1,channel2",
  reportingNotificationMsTeamsChannels: "channel1,channel2",
  reportingNotificationEmails: "pjfry@test.com,brodriguez@test.com",
  reportingMilestoneId: "1",
  reportingMilestoneName: "test",
};

module.export = {
  reporters: [[ZebrunnerReporter, config]],
};

The following configuration parameters are recognized by the agent:

Parameter Description
enabled Enables or disables reporting. The default value is false. If disabled, the agent will use no op component implementations that will simply log output for tracing purposes with the trace level
reportingServerHostname Mandatory if reporting is enabled. It is Zebrunner server hostname. It can be obtained in Zebrunner on the 'Account & profile' page under the 'Service URL' section
reportingServerAccessToken Mandatory if reporting is enabled. Access token must be used to perform API calls. It can be obtained in Zebrunner on the 'Account & profile' page under the 'Token' section
reportingProjectKey Optional value. It is the project that the test run belongs to. The default value is DEF. You can manage projects in Zebrunner in the appropriate section
reportingRunDisplayName Optional value. It is the display name of the test run. The default value is Default Suite
reportingRunBuild Optional value. It is the build number that is associated with the test run. It can depict either the test build number or the application build number
reportingRunEnvironment Optional value. It is the environment where the tests will run
reportingRunLocale Optional value. Locale, that will be displayed for the run in Zebrunner if specified
reportingNotificationNotifyOnEachFailure Optional value. Specifies whether Zebrunner should send notification to Slack/Teams on each test failure. The notifications will be sent even if the suite is still running. The default value is false
reportingNotificationSlackChannels Optional value. The list of comma-separated Slack channels to send notifications to. Notification will be sent only if Slack integration is properly configured in Zebrunner with valid credentials for the project the tests are reported to. Zebrunner can send two type of notifications: on each test failure (if appropriate property is enabled) and on suite finish
reportingNotificationMsTeamsChannels Optional value. The list of comma-separated Microsoft Teams channels to send notifications to. Notification will be sent only if Teams integration is configured in Zebrunner project with valid webhooks for the channels. Zebrunner can send two type of notifications: on each test failure (if appropriate property is enabled) and on suite finish
reportingNotificationEmails Optional value. The list of comma-separated emails to send notifications to. This type of notification does not require further configuration on Zebrunner side. Unlike other notification mechanisms, Zebrunner can send emails only on suite finish
reportingMilestoneId Optional value. Id of the Zebrunner milestone to link the suite execution to. The id is not displayed on Zebrunner UI, so the field is basically used for internal purposes. If the milestone does not exist, appropriate warning message will be displayed in logs, but the test suite will continue executing
reportingMilestoneName Optional value. Name of the Zebrunner milestone to link the suite execution to. If the milestone does not exist, appropriate warning message will be displayed in logs, but the test suite will continue executing

Attach video and screenshots#

First you need additional library wdio-video-reporter

yarn add wdio-video-reporter

then add video-reporter to wdio.conf.js

const { ZebrunnerReporter } = require('@zebrunner/javascript-agent-webdriver');
require('dotenv').config();
const video = require("wdio-video-reporter");

module.exports = {
  reporters: [
    [
      video,
      {
        saveAllVideos: true,
        videoSlowdownMultiplier: 3,
        outputDir: "<output dir>",
      },
    ],
    [ZebrunnerReporter, config],
  ],
};

All screenshots and video will attach to the desired test

Additional reporting capabilities#

This section uncovers extra reporting capabilities allowing to track additional test data.

Tracking test maintainer#

You may want to add transparency to the process of automation maintenance by having an engineer responsible for evolution of specific tests or test classes. To serve that purpose Zebrunner comes with a concept of a maintainer. In order to keep track of those, the agent comes with the setMaintainer method.

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  it("test", () => {
    reporterEmitter.setMaintainer("emarf");
    // ...some test code
  });

  it("another test", () => {
    reporterEmitter.setMaintainer("simple");
    // ...some test code
  });
});

In the example above, emarf will be reported as a maintainer of test, while simple will be reported as a maintainer of test another test.

The maintainer username should be a valid Zebrunner username, otherwise it will be set to anonymous.

Attaching labels#

In some cases, it may be useful to attach some meta information related to a test.

The agent comes with a concept of labels. Label is a key-value pair associated with a test or test run.

Reporter provides the following methods for labeling:

  • setRunLabel({key: value}) - attaches labels for run
  • setTestLabel({key: value}) - attaches labels for test

See the example below:

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  before(() => {
    reporterEmitter.setRunLabels({
      Chrome: "97.0",
      os: "linux",
    });
  });

  it("test describe", () => {
    reporterEmitter.setTestLabels({
      Author: "Deve Loper",
    });
    // ...some test code
  });

  it("another test describe", () => {
    reporterEmitter.setTestLabels({
      Author: "simple",
    });
    // ...some test code
  });
});

The values of attached labels will be displayed in Zebrunner under the name of a corresponding test or run.

Reverting test registration#

In some cases it might be handy not to register test execution in Zebrunner. This may be caused by very special circumstances of test environment or execution conditions.

You can use revertTestRegistration method for reverting test registration at runtime.

See the example below:

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  it("test describe", () => {
    reporterEmitter.revertTestRegistration();
    // ...some test code
  });
});

It is worth mentioning that the method invocation does not affect the test execution, but simply unregisters the test in Zebrunner.

Collecting additional artifacts#

In case your tests or entire test run produce some artifacts, it may be useful to track them in Zebrunner. The agent comes with a few convenient methods for uploading artifacts in Zebrunner and linking them to the currently running test or the test run.

Reporter provides the following methods for attaching artifacts and artifact references to tests and test runs:

  • The attachToTestRun(name) and attachToTest(name) methods can be used to upload and attach an artifact file to test run and test respectively. Also need create folder artifacts and put run attachments there
  • The attachReferenceToTestRun(name, reference) and attachReferenceToTest(name, reference) methods can be used to attach an arbitrary artifact reference to test run and test respectively

See the example below:

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  before(() => {
    reporterEmitter.attachToTestRun(["runEBAY.txt", "runWDIO.txt"]);
    reporterEmitter.attachReferenceToTestRun([
      ["run ref1", "https://www.linkedin.com"],
      ["run ref2", "https://www.stackoverflow.com"],
    ]);
  });

  it("test describe", () => {
    reporterEmitter.attachToTest(["testEBAY1.txt", "testEBAY2.txt"]);
    reporterEmitter.attachReferenceToTest([
      ["test ref", "https://github.com"],
      ["test ref2", "https://youtube.com"],
    ]);
    // ...some test code
  });
});

Syncing test executions with external TCM systems#

Zebrunner provides an ability to upload test results to external test case management systems (TCMs) on test run finish. For some TCMs it is possible to upload results in real-time during the test run execution.

This functionality is currently supported for TestRail, Xray, Zephyr Squad and Zephyr Scale.

TestRail#

For successful upload of test run results in TestRail, two steps must be performed:

  1. Integration with TestRail is configured and enabled for Zebrunner project
  2. Configuration is performed on the tests side

Configuration#

Zebrunner agent has a special TestRail class with a bunch of methods to control results upload:

  • setSuiteId(string) - mandatory. The method sets TestRail suite id for current test run. This method must be invoked before all tests;
  • setCaseId(array of strings) - mandatory. Using these mechanisms you can set TestRail's case associated with specific automated test;
  • disableSync(boolean) - optional. Disables result upload. Same as setSuiteId(string), this method must be invoked before all tests;
  • includeAllTestCasesInNewRun(boolean) - optional. Includes all cases from suite into newly created run in TestRail. Same as setSuiteId(string), this method must be invoked before all tests;
  • enableRealTimeSync(boolean) - optional. Enables real-time results upload. In this mode, result of test execution will be uploaded immediately after test finish. This method also automatically invokes includeAllTestCasesInNewRun. Same as setSuiteId(string), this method must be invoked before all tests;
  • setRunId(string) - optional. Adds result into existing TestRail run. If not provided, test run is treated as new. Same as setSuiteId(string), this method must be invoked before all tests;
  • setRunName(string) - optional. Sets custom name for new TestRail run. By default, Zebrunner test run name is used. Same as setSuiteId(string), this method must be invoked before all tests;
  • setMilestone(string) - optional. Adds result in TestRail milestone with the given name. Same as setSuiteId(string), this method must be invoked before all tests;
  • setAssignee(string) - optional. Sets TestRail run assignee. Same as setSuiteId(string), this method must be invoked before all tests. By default, a new run containing only cases assigned to the tests will be created in TestRail on test run finish;

Example#

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  before(() => {
    const tcmRunOptions = [
      {
        testRailSuiteId: "testRailSuite",
        testRailRunId: "322",
        testRailRunName: "testRailName",
        testRailMilestone: "milestone",
        testRailAssignee: "emarf",
        testRailDisableSync: true,
        testRailIncludeAll: true,
        testRailEnableRealTimeSync: true,
      },
    ];
    reporterEmitter.setRunTcmOptions(tcmRunOptions);
  });

  it("should verify title search laptop and verify title", async () => {
    const tcmTestOptions = [
      {
        xrayTestKey: ["testKey", "testKey1"],
      },
      {
        testRailCaseId: ["caseId", "caseId1"],
      },
      {
        zephyrTestCaseKey: ["zephyr", "zephyr1"],
      },
    ];

    reporterEmitter.setTestTcmOptions(tcmTestOptions);
    // some test code...
  });
});

Xray#

For successful upload of test run results in Xray two steps must be performed:

  1. Xray integration is configured and enabled in Zebrunner project
  2. Xray configuration is performed on the tests side

Configuration#

Zebrunner agent has a special Xray class with a bunch of methods to control results upload:

  • setExecutionKey(string) - mandatory. The method sets Xray execution key. This method must be invoked before all tests.
  • setTestKey(array of string) - mandatory. Using these mechanisms you can set test keys associated with specific automated test.
  • disableSync(boolean) - optional. Disables result upload. Same as setExecutionKey(string), this method must be invoked before all tests;
  • enableRealTimeSync(boolean) - optional. Enables real-time results upload. In this mode, result of test execution will be uploaded immediately after test finish. Same as setExecutionKey(string), this method must be invoked before all tests.

Example#

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  before(() => {
    const tcmRunOptions = [
      {
        xrayExecutionKey: 'execKey',
        xrayDisableSync: true,
        xrayEnableRealTimeSync: true,
      },
    ];
    reporterEmitter.setRunTcmOptions(tcmRunOptions);
  });

  it("should verify title search laptop and verify title", async () => {
    const tcmTestOptions = [
      {
        xrayTestKey: ["testKey", "testKey1"],
      },
    ];
    reporterEmitter.setTestTcmOptions(tcmTestOptions);
    // some test code...
  });
});

Zephyr#

For successful upload of test run results in Zephyr two steps must be performed:

  1. Zephyr integration is configured and enabled in Zebrunner project
  2. Zephyr configuration is performed on the tests side

Described steps work for both Zephyr Squad and Zephyr Scale.

Configuration#

  • setTestCycleKey(string) - mandatory. The method sets Zephyr test cycle key. This method must be invoked before all tests;
  • setJiraProjectKey(string) - mandatory. Sets Zephyr Jira project key. Same as setTestCycleKey(string), this method must be invoked before all tests;
  • setTestCaseKey(array of string) - mandatory. Using these mechanisms you can set test case keys associated with specific automated test;
  • disableSync() - optional. Disables result upload. Same as setTestCycleKey(string), this method must be invoked before all tests;
  • enableRealTimeSync() - optional. Enables real-time results upload. In this mode, result of test execution will be uploaded immediately after test finish. Same as setTestCycleKey(string), this method must be invoked before all tests;

Example#

const { reporterEmitter } = require('@zebrunner/javascript-agent-webdriver');


describe("run describe", () => {
  before(() => {
    const tcmRunOptions = [
      {
        zephyrTestCycleKey: 'zephyr123',
        zephyrJiraProjectKey: 'zephyr321',
        zephyrDisableSync: true,
        zephyrEnableRealTimeSync: true,
      }
    ];
    reporterEmitter.setRunTcmOptions(tcmRunOptions);
  });

  it("should verify title search laptop and verify title", async () => {
    const tcmTestOptions = [
      {
        zephyrTestCaseKey: ['zephyr', 'zephyr1'],
      },
    ];
    reporterEmitter.setTestTcmOptions(tcmTestOptions);
    // some test code...
  });
});

Sometimes reporter doesn't have enough time to complete run and you need to add to wdio.conf.js next:

exports.config = {
  reporterSyncInterval: 10 * 1000,
  // ...another config options
};

Contribution#

To check out the project and build from the source, do the following: 

git clone git://github.com/zebrunner/javascript-agent-webdriverio.git
cd javascript-agent-webdriverio

License#

Zebrunner reporting agent for WebdriverIO is released under version 2.0 of the Apache License.