@reportportal/agent-js-cucumber

@reportportal/agent-js-cucumber

Agent to integrate CucumberJS with ReportPortal.

• More about CucumberJS
• More about ReportPortal

This agent works with Cucumber versions from 7.x to 12.x. See release notes for the detailed versions description.

Install the agent to your project dir

npm install --save-dev @reportportal/agent-js-cucumber

• Make sure that you required glue code correctly. It is important to make Cucumber see support code. For example: Let's say you have project structure like this below

   my-project
    L features
        L step_definitions
            L steps.js
            L support
                L hooks.js
                L world.js
    L package.json
  

  Note

  Protractor and Cucumber have their own timeouts . When protractor start main process that launches cucumber it would have different timeouts if they are not the same they would wait for scripts different time. If cucumber's timeout less than protractor's it would through wrong exception. For example if page that has been loaded and hasn't got angular, the next error would be thrown : Error: function timed out after 10000 milliseconds . . . . Instead of protractor's : Error: Error while running testForAngular: asynchronous script timeout: result was not received in 4 seconds . . . . So it must be handled manually by setting cucumber's timeout greater than protractor's is at the hooks.js. For example if you set up protractor's timeout 9000 miliseconds , so cucumber must be at least 1 second greater = 10000 miliseconds. Example :

  var { setDefaultTimeout } = require('@cucumber/cucumber');
  
  setDefaultTimeout(10000);
  

• Create Report Portal configuration file For example ./rpConfig.json

  {
    "apiKey": "reportportalApiKey",
    "endpoint": "https://your.reportportal.server/api/v2",
    "launch": "Your launch name",
    "project": "Your reportportal project name",
    "description": "Awesome launch description.",
    "attributes": [
      {
        "key": "launchAttributeKey",
        "value": "launchAttributeValue"
      }
    ],
    "takeScreenshot": "onFailure"
  }
  

The full list of available options presented below.

Authentication Options

The agent supports two authentication methods:

• API Key Authentication (default)
• OAuth 2.0 Password Grant (recommended for enhanced security)

Note:
If both authentication methods are provided, OAuth 2.0 will be used.
Either API key or complete OAuth 2.0 configuration is required to connect to ReportPortal.

Option	Necessity	Default	Description
apiKey	Conditional		User's ReportPortal API key from which you want to send requests. It can be found on the profile page of this user. *Required only if OAuth is not configured.
oauth	Conditional		OAuth 2.0 configuration object. When provided, OAuth authentication will be used instead of API key. See OAuth Configuration below.

OAuth Configuration

The oauth object supports the following properties:

Property	Necessity	Default	Description
tokenEndpoint	Required		OAuth 2.0 token endpoint URL for password grant flow.
username	Required		Username for OAuth 2.0 password grant.
password	Required		Password for OAuth 2.0 password grant.
clientId	Required		OAuth 2.0 client ID.
clientSecret	Optional		OAuth 2.0 client secret (optional, depending on your OAuth server configuration).
scope	Optional		OAuth 2.0 scope (optional, space-separated list of scopes).

Note: The OAuth interceptor automatically handles token refresh when the token is about to expire (1 minute before expiration).

OAuth 2.0 configuration example

const rpConfig = {
  endpoint: 'https://your.reportportal.server/api/v2',
  project: 'Your reportportal project name',
  launch: 'Your launch name',
  oauth: {
    tokenEndpoint: 'https://your-oauth-server.com/oauth/token',
    username: 'your-username',
    password: 'your-password',
    clientId: 'your-client-id',
    clientSecret: 'your-client-secret', // optional
    scope: 'reportportal', // optional
  }
};

General options

Option	Necessity	Default	Description
endpoint	Required		URL of your server. For example 'https://server:8080/api/v2'.
launch	Required		Name of launch at creation.
project	Required		The name of the project in which the launches will be created.
attributes	Optional	[]	Launch attributes.
description	Optional	''	Launch description.
rerun	Optional	false	Enable rerun
rerunOf	Optional	Not set	UUID of launch you want to rerun. If not specified, reportportal will update the latest launch with the same name
mode	Optional	'DEFAULT'	Results will be submitted to Launches page 'DEBUG' - Results will be submitted to Debug page.
debug	Optional	false	This flag allows seeing the logs of the client-javascript. Useful for debugging.
launchId	Optional	Not set	The ID of an already existing launch. The launch must be in 'IN_PROGRESS' status while the tests are running. Please note that if this ID is provided, the launch will not be finished at the end of the run and must be finished separately.
restClientConfig	Optional	Not set	axios like http client config. May contain agent property for configure http(s) client, and other client options e.g. proxy, timeout. For debugging and displaying logs the debug: true option can be used. Visit client-javascript for more details.
headers	Optional	{}	The object with custom headers for internal http client.
launchUuidPrint	Optional	false	Whether to print the current launch UUID.
launchUuidPrintOutput	Optional	'STDOUT'	Launch UUID printing output. Possible values: 'STDOUT', 'STDERR', 'FILE', 'ENVIRONMENT'. Works only if launchUuidPrint set to true. File format: rp-launch-uuid-${launch_uuid}.tmp. Env variable: RP_LAUNCH_UUID, note that the env variable is only available in the reporter process (it cannot be obtained from tests).
skippedIssue	Optional	true	reportportal provides feature to mark skipped tests as not 'To Investigate'. Option could be equal boolean values: true - skipped tests considered as issues and will be marked as 'To Investigate' on reportportal. false - skipped tests will not be marked as 'To Investigate' on application.
takeScreenshot	Optional	Not set	Possible values: onFailure. If this option is defined then framework will take screenshot with protractor or webdriver API if step has failed.
scenarioBasedStatistics	Optional	false	While true, the Gherkin Scenarios considered as entity with statistics. In this case Cucumber steps will be reported to the log level as nested steps.

• Create Report Portal formatter in a new js file, for example reportPortalFormatter.js:

  const { createRPFormatterClass } = require('@reportportal/agent-js-cucumber');
  const config = require('./rpConfig.json');
  
  module.exports = createRPFormatterClass(config);
  

• Import RPWorld (provides API for logging and data attaching) into /features/step_definitions/support/world.js

  let { setWorldConstructor } = require('@cucumber/cucumber');
  let { RPWorld } = require('@reportportal/agent-js-cucumber');
  setWorldConstructor(RPWorld);
  

  If you have other world constructors it must be used with the RPWorld as shown below

  class CustomWorld extends RPWorld {
    constructor(...args) {
      super(...args);
  
      /*
       * any driver container must be named 'browser', because reporter could be used with cucumber
       * and protractor. And protractor has global object browser which contains all web-driver methods
       */
      global.browser = new seleniumWebdriver.Builder().forBrowser('chrome').build();
    }
  }
  
  setWorldConstructor(CustomWorld);
  

  It will allow you send logs and screenshots to RP directly from step definitions. All this logs would be attached to test data and could be viewed at the Report Portal.
  Also you will be able to specify additional info for test items (e.g. description, attributes, testCaseId, status). See API section for more information.

• Run cucumber-js

  cucumber-js -f ./reportPortalFormatter.js

  More info in the examples repository.

Step reporting configuration

By default, this agent reports the following structure:

• feature - SUITE
• scenario - TEST
• step - STEP

You may change this behavior to report steps to the log level by enabling scenario-based reporting:

• feature - TEST
• scenario - STEP
• step - log item (nested step)

To report your steps as logs without creating statistics for every step, you need to pass an additional parameter to the agent config: "scenarioBasedStatistics": true

{
  "scenarioBasedStatistics": true
}

Asynchronous API

The client supports an asynchronous reporting (via the ReportPortal asynchronous API). If you want the client to report through the asynchronous API, change v1 to v2 in the endpoint address.

Note: It is highly recommended to use the v2 endpoint for reporting, especially for extensive test suites.

Reporting API

Attachments

Attachments are being reported as logs. You can either just attach a file using cucumber's this.attach or specify log level and message:

this.attach(
  JSON.stringify({
    message: `Attachment with ${type}`,
    level: 'INFO',
    data: data.toString('base64'),
  }),
  type,
);

To send attachment to the launch/scenario just specify entity: 'launch' or entity: 'scenario' property accordingly.

Also this.screenshot, this.scenarioScreenshot and this.launchScreenshot methods can be used to take screenshots.

Then(/^I should see my new task in the list$/, function(callback) {
  this.screenshot('This screenshot')
    .then(() => callback())
    .catch((err) => callback(err));
  this.scenarioScreenshot('This is screenshot for scenario')
    .then(() => callback())
    .catch((err) => callback(err));
  this.launchScreenshot('This is screenshot for launch')
    .then(() => callback())
    .catch((err) => callback(err));
});

screenshot/scenarioScreenshot/launchScreenshot function return promise fulfilled after screenshot is taken and image added to attachments. Handler will parse attachments and send corresponding log to the step item.

Logs

To report logs to the items you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.info('This is Info Level log');
  this.debug('This is Debug Level log');
  this.error('This is Error Level log');
  this.warn('This is Warn Level log');
  this.trace('This is Trace Level log');
  this.fatal('This is Fatal Level log');
});

To report logs to the scenario you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.scenarioInfo('This is Info Level log');
  this.scenarioDebug('This is Debug Level log');
  this.scenarioError('This is Error Level log');
  this.scenarioWarn('This is Warn Level log');
  this.scenarioTrace('This is Trace Level log');
  this.scenarioFatal('This is Fatal Level log');
});

To report logs to the launch you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.launchInfo('This is Info Level log');
  this.launchDebug('This is Debug Level log');
  this.launchError('This is Error Level log');
  this.launchWarn('This is Warn Level log');
  this.launchTrace('This is Trace Level log');
  this.launchFatal('This is Fatal Level log');
});

Attributes

Attributes for features and scenarios are parsed from @tags as @key:value pair.

To add attributes to the step items you can use the next method:

Then(/^I should see my new task in the list$/, function() {
  this.addAttributes([{ key: 'agent', value: 'cucumber' }]);
});

To add attributes to the scenario you can use the next method:

Then(/^I should see my new task in the list$/, function() {
  this.addScenarioAttributes([{ key: 'agent', value: 'cucumber' }]);
});

The attributes will be concatenated.

Description

Description for features and scenarios are parsed from their definition.

To add description to the items you can use the following method:

Then(/^I should see my new task in the list$/, function() {
  this.addDescription('Test item description.');
});

To add description to the scenario you can use the following method:

Then(/^I should see my new task in the list$/, function() {
  this.addScenarioDescription('Scenario description.');
});

The description will be concatenated.

TestCaseId

To set test case id to the items you can use the following method:

Then(/^I should see my new task in the list$/, function() {
  this.setTestCaseId('itemTestCaseId');
});

To set test case id to the scenario you can use the following method:

Then(/^I should see my new task in the list$/, function() {
  this.setScenarioTestCaseId('scenarioTestCaseId');
});

Statuses

The user can set the status of the item/launch directly depending on some conditions or behavior. It will take precedence over the actual completed status.

To set status to the item you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.setStatusPassed();
  this.setStatusFailed();
  this.setStatusSkipped();
  this.setStatusStopped();
  this.setStatusInterrupted();
  this.setStatusCancelled();
});

To set status to the scenario you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.setScenarioStatusPassed();
  this.setScenarioStatusFailed();
  this.setScenarioStatusSkipped();
  this.setScenarioStatusStopped();
  this.setScenarioStatusInterrupted();
  this.setScenarioStatusCancelled();
  this.setScenarioStatusInfo();
  this.setScenarioStatusWarn();
});

To set status to the launch you can use the next methods:

Then(/^I should see my new task in the list$/, function() {
  this.setLaunchStatusPassed();
  this.setLaunchStatusFailed();
  this.setLaunchStatusSkipped();
  this.setLaunchStatusStopped();
  this.setLaunchStatusInterrupted();
  this.setLaunchStatusCancelled();
});

Copyright Notice

Licensed under the Apache 2.0 license (see the LICENSE.txt file).