README.md

Allure ruby

Ruby testing framework adaptors for generating allure compatible test reports.

Supported frameworks

allure-cucumber

gem "allure-cucumber"

Implementation of allure adaptor for Cucumber testing framework

Detailed usage and setup instruction can be found in allure-cucumber docs

allure-rspec

gem "allure-rspec"

Implementation of allure adaptor for RSpec testing framework

Detailed usage and setup instruction can be found in allure-rspec docs

Development

allure-ruby-commons

gem "allure-ruby-commons"

Common allure lifecycle interface to be used by other testing frameworks to generate allure reports

Interaction and usage of allure lifecycle is described in allure-ruby-commons docs

Contributing

• Install dependencies:

$ bundle install
Bundle complete! ...

• Make changes

• Run linter:

$ bundle exec rake rubocop
Executing rubocop for allure-cucumber
...
no offenses detected

Executing rubocop for allure-rspec
...
no offenses detected

Executing rubocop for allure-ruby-commons
...
no offenses detected

• Run tests:

$ bundle exec rake test
Executing test for allure-cucumber
...
0 failures

Executing test for allure-rspec
...
0 failures

Executing test for allure-ruby-commons
...
0 failures

• Submit a PR

Generating HTML report

Ruby binding hosted in this repository only generate source json files for the allure2 reporter.

See documentation on how to generate report.

Using with CI providers

allure-report-publisher provides a docker image which can be run from github-actions workflow or gitlab-ci pipeline and host reports using cloud providers like AWS or GCP.