Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webdriverio-community/wdio-cucumberjs-json-reporter
A WDIO reporter that creates CucumberJS JSON files for WebdriverIO
https://github.com/webdriverio-community/wdio-cucumberjs-json-reporter
cucumber cucumberjs wdio wdio-plugin wdio-reporter webdriverio
Last synced: 1 day ago
JSON representation
A WDIO reporter that creates CucumberJS JSON files for WebdriverIO
- Host: GitHub
- URL: https://github.com/webdriverio-community/wdio-cucumberjs-json-reporter
- Owner: webdriverio-community
- License: mit
- Created: 2019-07-23T07:11:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T10:31:57.000Z (13 days ago)
- Last Synced: 2024-12-27T14:06:33.760Z (9 days ago)
- Topics: cucumber, cucumberjs, wdio, wdio-plugin, wdio-reporter, webdriverio
- Language: TypeScript
- Homepage: https://webdriver.io/docs/wdio-cucumberjs-json-reporter
- Size: 6.17 MB
- Stars: 24
- Watchers: 10
- Forks: 32
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WDIO CucumberJS JSON Reporter  [](http://opensource.org/licenses/MIT)
A WDIO reporter that creates CucumberJS JSON files for WebdriverIO v8 and up.
[](https://nodei.co/npm/wdio-cucumberjs-json-reporter/)
## What does it do
This reporter will generate a **Cucumber JSON file** for each feature that is being tested. The JSON file can be used with whatever report you want to use like for example [multiple-cucumber-html-reporter](https://github.com/wswebcreation/multiple-cucumber-html-reporter).
It will also add metadata about the running instance to the feature file and last but not least, it will give you the opportunity to add attachments to the JSON output.
## Installation
The easiest way is to keep `wdio-cucumberjs-json-reporter` as a devDependency in your `package.json`.
```json
{
"devDependencies": {
"wdio-cucumberjs-json-reporter": "^5.0.0"
}
}
```
You can simple do it by:
```bash
npm install wdio-cucumberjs-json-reporter --save-dev
```
so it will automatically be added to your `package.json`
Instructions on how to install `WebdriverIO` can be found [here](https://webdriver.io/docs/gettingstarted).
## Configuration
Configure the output directory and the language in your wdio.conf.js file:
```js
export const config = {
// ...
reporters: [
// Like this with the default options, see the options below
'cucumberjs-json',
// OR like this if you want to set the folder and the language
[ 'cucumberjs-json', {
jsonFolder: '.tmp/new/',
language: 'en',
},
],
],
// ...
}
```
> DON'T USE BOTH WAYS OF ADDING THE REPORTER, THIS IS JUST AN EXAMPLE!
## Options
### `jsonFolder`
- **Type:** `String`
- **Mandatory:** No
- **Default:** `.tmp/json/`
The directory where the JSON files, generated by this report, will be stored, relative from where the script is started.
**N.B.:** If you use a npm script from the command line, like for example `npm run test` the `jsonFolder` will be relative from the path
where the script is executed. Executing it from the root of your project will also create the `jsonFolder` in the root of you project.
### `language`
- **Type:** `String`
- **Mandatory:** No
- **Default:** `en`
The language in which the Gherkin scenarios are written (defaults to English). The list of language codes and its keywords can be found [here](https://cucumber.io/docs/gherkin/reference/#overview).
### `disableHooks`
- **Type:** `boolean`
- **Mandatory:** No
- **Default:** `false`
Hook details will not be part of generation if this property sets to `true`.
### `reportFilePerRetry`
- **Type:** `boolean`
- **Mandatory:** No
- **Default:** `true`
When a spec is retried the report will be appended to the existing report file from the previous tries if this property is set to `false`.
**Example**:
`['cucumberjs-json', { jsonFolder: '.tmp/new/', language: 'en', disableHooks:true}]`
## Metadata
> **Note:**\
> This is currently not supported if you are using WebdriverIO V6, WebdriverIO V5 still supports this and WebdriverIO V7 supports it again
As said, this report can automatically store the metadata of the current machine / device the feature has been executed on.
To customize this you can add it by adding the following object to your `capabilities`
```js
// Example wdio.conf.js
export const config = {
//..
capabilities: [
{
browserName: 'chrome',
// Add this
'cjson:metadata': {
// For a browser
browser: {
name: 'chrome',
version: '58',
},
// for an app
app: {
name: 'name.of.app.ipa',
version: '1.2.3',
},
device: 'MacBook Pro 15',
platform: {
name: 'OSX',
version: '10.12.6'
}
},
},
],
};
```
> The metadata object needs to have the `cjson` prefix, otherwise it will not work!
### Metadata values
#### `metadata.app.name`
- **Type:** `string`
**e.g.:** The name of the app.
#### `metadata.app.version`
- **Type:** `string`
**e.g.:** The version of the app.
#### `metadata.browser.name`
- **Type:** `string`
- **Possible values:** `internet explorer | edge | chrome | firefox | safari`
#### `metadata.browser.version`
- **Type:** `string`
**e.g.:** The version of the browser, this can be added manual or retrieved during the execution of the tests to get the exact version number.
#### `metadata.device`
- **Type:** `string`
**e.g.:** A name that represents the type of device. For example, if you run it on a virtual machine, you can place it here `Virtual Machine`,
or the name of the mobile, like for example `iPhone 7 Plus`.
#### `metadata.platform.name`
- **Type:** `string`
- **Possible values:** `windows | osx | linux | ubuntu | android | ios`
#### `metadata.platform.version`
- **Type:** `string`
**e.g.:** The version of the platform
> If you don't provide the `browser`-object in the metadata, this module will automatically determine it for you. **It will always override it with the most recent value it can determine.**
> If you don't provide the `device` and or the `platform`-object it will be defaulted for you to `not known`
> If you don't provide a `browser.name` or a `browser.version` the module will try to determine this automatically.
## Attachment
You have the option to attach data to the JSON file in all these hooks / steps:
- Before(All)
- After(All)
- Given
- When
- Then
- And
The only thing you need to provide is the following code in your step files.
For ES Modules (ESM)
```js
import cucumberJson from 'wdio-cucumberjs-json-reporter';
// Attach a string (if no type is provided it will automatically default to `text/plain`
cucumberJson.attach('just a string');
cucumberJson.attach('just a second string', 'text/plain');
// Attach JSON
cucumberJson.attach({"json-string": true}, 'application/json');
// Attach a screenshot in a before hook
cucumberJson.attach(await browser.takeScreenshot(), 'image/png');
```
For CommonJS (CJS)
```js
const { attach } = require("wdio-cucumberjs-json-reporter");
// Attach a string (if no type is provided it will automatically default to `text/plain`
attach('just a string');
attach('just a second string', 'text/plain');
// Attach JSON
attach({"json-string": true}, 'application/json');
// Attach a screenshot in a before hook
attach(await browser.takeScreenshot(), 'image/png');
```
## Use it with multiple-cucumber-html-reporter
The previous module for WebdriverIO V4, [wdio-multiple-cucumber-html-reporter](https://github.com/webdriverio-community/wdio-multiple-cucumber-html-reporter),
had a build in connection with the [multiple-cucumber-html-reporter](https://github.com/wswebcreation/multiple-cucumber-html-reporter)-module. **This is not the case for this
reporter** because the new setup of WebdriverIO V5 is based on a instance which doesn't allow me to use the `onPrepare` and `onComplete` hook.
If you still want to use the [multiple-cucumber-html-reporter](https://github.com/wswebcreation/multiple-cucumber-html-reporter)-module you can add the following to your config file.
- Install the module with
```bash
npm install multiple-cucumber-html-reporter --save-dev
```
- Add this to your configuration file
```js
import fs from 'node:fs/promises'
// Import the module
import { generate } from 'multiple-cucumber-html-reporter'
// Example wdio.conf.js
export const config = {
//..
// =====
// Hooks
// =====
/**
* Gets executed once before all workers get launched.
*/
onPrepare: () => {
// Remove the `.tmp/` folder that holds the json and report files
return fs.rm('.tmp/', { recursive: true });
},
/**
* Gets executed after all workers got shut down and the process is about to exit.
*/
onComplete: () => {
// Generate the report when it all tests are done
generate({
// Required
// This part needs to be the same path where you store the JSON files
// default = '.tmp/json/'
jsonDir: '.tmp/json/',
reportPath: '.tmp/report/',
// for more options see https://github.com/wswebcreation/multiple-cucumber-html-reporter#options
});
}
}
```
## Older WebdriverIO Versions
> **THIS MODULE CAN ONLY WORK WITH WebdriverIO V8+!**\
> **For V6 please check the docs [here](https://github.com/webdriverio-community/wdio-cucumberjs-json-reporter/tree/v6) and use version 2.0.4**\
> **For V5 please check the docs [here](https://github.com/webdriverio-community/wdio-cucumberjs-json-reporter/tree/v5) and use version 1.3.0**
> **THIS MODULE IS NOT A REPLACEMENT OF [wdio-multiple-cucumber-html-reporter](https://github.com/wswebcreation/wdio-multiple-cucumber-html-reporter). THAT MODULE ONLY SUPPORTS WEBDRIVERIO V4 AND ALSO CREATES A REPORT. THIS MODULE ONLY CREATES A JSON, NO REPORT!!**