allure-framework / allure-cucumberjs

Deprecated, use https://github.com/allure-framework/allure-js instead

[DEPRECATED]

Please follow https://github.com/allure-framework/allure-js

Allure CucumberJS

HOW TO USE IT?

Add reporter.js file in feature packages with:

var reporter = require('cucumberjs-allure-reporter');
reporter.config(
    {...}
);
module.exports = reporter;

Supported configuration keys:

• targetDir - directory where allure will save results xml's

• labels - custom label matchers, example:

  labels : {
          feature: [/sprint-(\d*)/, /release-(\d)/, /area-(.*)/],
          issue: [/(bug-\d*)/]
      }

Possible labels:

• feature
• story
• severity
• language
• framework
• issue
• testId
• host
• thread

If you want to cancel step or test, simply throw new Error with message 'Step cancelled' or 'Test cancelled'.

Generate HTML report from Allure results

The Reporter will generate xml files inside of a targetDir, then we need to generate HTML out of them. You can use Maven for that. Copy ready-to-use pom.xml from node_modules/cucumberjs-allure-reporter and run:

mvn site -Dallure.results_pattern=allure-results

It will put HTMLs into target/site/allure-maven-plugin folder. To serve them via localhost:1234 use:

mvn jetty:run -Djetty.port=1234

Otherwise choose one of other ways to generate HTML.

For Developers

Run test examples with:

./node_modules/.bin/cucumber.js features/<FEATURE_NAME>.feature

Available tests:

• basic -> basic test results
• description -> scenario description test
• label -> cucumber tags (currently labels are not visible in generated report ...)
• exception -> test throws exception
• attachments -> docStrings and dataTable tests
• scenarioOutline -> scenario outline tests
• subSteps -> steps add sub steps using allure object

or run everything with: ./node_modules/.bin/cucumber.js features/

To check protractor screenshot test install protractor and protractor-cucumber-framework and then run tests: ./node_modules/protractor/bin/protractor miscellaneous/protractorScreenshot/conf.js

To check basic logging run: ./node_modules/.bin/cucumber.js miscellaneous/logging

To check basic configuration run: ./node_modules/.bin/cucumber.js miscellaneous/configuration

To check custom tags run: ./node_modules/.bin/cucumber.js miscellaneous/customTagNames

Release notes

01/09/2016 version 1.0.3

• added possibility to cancel steps and tests

11/07/2016 version 1.0.2

• peer dependency for cucumber (>= 1.2.0) added

06/07/2016 version 1.0.1

• dependencies updated for allure-js-commons, protractor, cucumber and protractor-cucumber-framework
• fixed cucumber handlers - getPayload will not be available in upcoming cucumber major release
• updated data table and doc string handling

02/12/2015 version 1.0.0

• plugin updated to work with cucumber 0.9.1

01/09/2015 version 0.0.1

• first release

allure-cucumberjs's Issues

Is there any way to impleted Allure on remote server?

I have my tests in localhost but I need to install allure in an amazon server, is there way to implemented this allure remote in my tests?

Unable to group features to suites

Why in labels there is not suit? why we can'not group features files by suit? Thanks

Cucumber-js version 2.0 compatibility

cucumber-js team is iterating through release candidates of version 2.0 of cucumber. It changes the step implementation and the allure reporter needs to be updated accordingly (or a new version needs to be spun off)

Is possible remove the Wrong label from the terminal?

Hi,

Currently I've received the message a lot of time, so I would like to remove them from the terminal, I've been think if it's possible to pass a flag for who want to enable o disable this feature.

The message:

The possible solution:

Failed parsing stats for Allure reporter: attribute value for name 'value' should be a primitive.

After executing my Cucumberjs Scenarios, I've got the following

Failed parsing stats for Allure reporter: attribute value for name 'value' should be a primitive (string, number, boolean, null, or undefined). Dumped this.baseReporter.stats to /Users/nicolasgonzalez/qa/training-qa-java-script/allure-reporter-debug.log.
Error: attribute value for name 'value' should be a primitive (string, number, boolean, null, or undefined)
at parseAttribute (/Users/nicolasgonzalez/qa/training-qa-java-script/node_modules/js2xmlparser/lib/main.js:76:15)

I debugged, and saw we are sending to the js2xmlparser an array instead of a primitive value. This array contains the path of the feature being run.

Can anyone give me a hand on this ?

Thanks a lot.

xml files not generated due to outdated "graceful-fs v3.0.8" module

Please update the "fs-extra" module in which there is an outdated graceful-fs v3.0.8 module due to which the allure reports are not generated.
I checked and updated to graceful-fs v4.1.4 and the xml files were generated. I could send a PR if needed?
Please find the screenshot:

Test scenarios are groupped by "Without feature" name not a correct one

I have feature file like:
@account
Feature: Account management

Scenario: Add account
Given I am on the Accounts page1
When I add new account1
Then I should see account details1

Scenario: Edit account
Given I am on the Accounts page1
When I edit new account1
Then I should see account details1

Generated after I run protractor test and generate report I've got
allure-results.zip

Why it is named as " Without feature" and not as "Account management"

Is there a way to add a link or parameter to test steps?

It's important for some tests/steps to add additional details in the report, such as: link to visual validation report (for example Applitools), Saucelabs, or maybe some browser/viewport details.
I've done it before for Java-based frameworks, but couldn't figure out the way how to add it here.
Our current testing framework is built on WebdriverIO.

Here's the example of what I'm talking about taken from Allure documentation:
https://ci.qameta.io/job/allure2/job/master/Demo_Report/index.html#behaviors/2c326d6fd7395f8c955a78fd036582ac/872f3f1859994b98/

Is Allure CucumberJS supporting adding the screenshots on failed cases?

Currently, I'm using the Protractor-CucumberJS for my automation project, however, I don't know where we support adding the screenshots on failed cases? Like we can click on the failed step to see the screenshot right away.

Best regards,
Thanh

unable to generate result folder.

Can anyone explain how to generate allure results for protractor cucumber framework , in jasmine i was using the following code:
var AllureReporter = require('jasmine-allure-reporter'); //allure reporter
jasmine.getEnv().addReporter(new AllureReporter({
resultsDir: 'allure-results'
}));
jasmine.getEnv().afterEach(function(done){
browser.takeScreenshot().then(function (png) {
allure.createAttachment('Screenshot', function () {
return new Buffer(png, 'base64')
}, 'image/png')();
done();
});
});

Please help me what code has to be used for cucumber.