CucumberJS ​
Cucumber.js is a JavaScript framework for running automated tests written in Gherkin syntax. It runs on Node.js and is used for behavior-driven development (BDD).
This guide explains how to integrate Cucumber with TestBeats for centralized and AI-powered reporting.
Prerequisites ​
TestBeats API Key (optional) - Sign in for free with your Work Email at testbeats portal to have a centralized and AI powered reporting. Once you're signed in, create a new organization and generate an API Key.
In-coming Webhook URL - Create an incoming webhook url for your Slack or Microsoft Teams or Google Chat.
Integration ​
TestBeats can consume the following reports for publishing test results from Cucumber.js:
JSON Report ​
1. Configure Cucumber.js to generate JSON reports ​
Run tests by updating the default formatter to json
.
cucumber-js --format json:result.json
or update the config file
{
"default": {
"format": ["json:result.json"]
}
}
2. Configure TestBeats to consume JSON reports ​
The test results can be either published using the command line mode or the configuration mode.
2.1 Command Line Mode ​
First, specify the target name using the appropriate target flag. For example, use the
--slack
flag to specify the incoming webhook URL.Next, specify the path to the result files using the appropriate results format flag. For example, use the
--cucumber
flag for cucumber results.
npx testbeats@latest publish --api-key '<api-key>' --slack '<slack-incoming-webhook-url>' --cucumber '<path-to-cucumber-report>'
# Download the executable via `curl`.
curl https://raw.githubusercontent.com/test-results-reporter/testbeats/main/scripts/download-latest.sh | bash
# After download completes, run the executable based on you operating system.
./testbeats-linux publish --api-key '<api-key>' --slack '<slack-incoming-webhook-url>' --cucumber '<path-to-cucumber-report>'
TIP
- TestBeats API Key is optional.
- Environment variable
TEST_BEATS_API_KEY
can also be used to specify the API key.
2.2 Configuration Mode ​
Sample testbeats.config.json
file
{
"api_key": "<api-key>",
"targets": [
{
"name": "slack",
"inputs": {
"url": "<incoming-webhook-url>"
}
}
],
"results": [
{
"type": "cucumber",
"files": ["path/to/result.json"]
}
]
}
npx testbeats@latest publish -c path/to/testbeats.config.json
# Download the executable via `curl`.
curl https://raw.githubusercontent.com/test-results-reporter/testbeats/main/scripts/download-latest.sh | bash
# After download completes, run the executable based on you operating system.
./testbeats-linux publish -c path/to/testbeats.config.json
Example Integration ​
For a complete example of integrating Cucumber.js with TestBeats, refer to the GitHub repository example.