allure-cucumber 2.10.0.beta3 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c92e1feebf6d830c45b5d024e840254bcb4b8d58f37bbf239a01e42207fc2f6
-  data.tar.gz: dc79bd33130612626d0a7095c46d27abe2ad39ab5c69e3e2797295a86bc432aa
+  metadata.gz: a40fd70805beafb477df5371f9e8f7c0f66cee6c8243b484141eb7b32c9a1026
+  data.tar.gz: f555048bb7569ecee757c15082e384d30f89eb5d15799317084a8655a1f478bb
 SHA512:
-  metadata.gz: 3dbf3cef23cf72aac699f86d06dbb72b9f47637286db8e574118c921730d5486992c0d7f54c8f7e1ba40c8ca347bdad7bf2b208ce3f4a5b741dac03684c6de8b
-  data.tar.gz: e3b8d783064d313eb06666ca53918500e421ded0ae62695b4732a215f261c51ef271cf4da6ddf57e4f7419dc9e71761283da6bf486db171d9bf1a4c70a5e95a5
+  metadata.gz: ac13c7c3b417e00809b05c584f695539f585aaf8712c58c15998049c1dc8382a5a8aea4bad87d783a5c3a85f224a53f29939dad7b11ba8a3b428b9ee20a1bd97
+  data.tar.gz: bb7c69513879f80dd682ff78a896be2dc2d9a6994be249035ed4f9a60eecd4c5b33687ef89486add98e023faa0d0b676317055823b078d22d3b5f6c7d8745121

data/README.md

@@ -9,61 +9,69 @@ Add this line to your application's Gemfile:
 ```ruby
 gem 'allure-cucumber'
 ```
+
 And then execute:
+
 ```bash
-$ bundle
+  $ bundle
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install allure-cucumber
+  $ gem install allure-cucumber
 ```
 
 ## Configuration
 
-By default, Allure json files are stored in `reports/allure-results`. To change this add the following in `features/support/env.rb` file:
+Common allure configuration is set via `Allure.configure` method. To change id, add the following in `features/support/env.rb` file:
 
 ```ruby
 Allure.configure do |c|
-   c.results_directory = "/output/dir"
+  c.results_directory = "/whatever/you/like"
+  c.clean_results_directory = true
+  c.logging_level = Logger::INFO
+  # these are used for creating links to bugs or test cases where {} is replaced with keys of relevant items
+  c.link_tms_pattern = "http://www.jira.com/browse/{}"
+  c.link_issue_pattern = "http://www.jira.com/browse/{}"
 end
 ```
 
 By default, allure-cucumber will analyze your cucumber tags looking for Test Management, Issue Management, and Severity hooks. Links to TMS and ISSUE and test severity will be displayed in the report. By default these prefixes are used:
 
-```ruby    
+```ruby
     DEFAULT_TMS_PREFIX      = 'TMS:'
     DEFAULT_ISSUE_PREFIX    = 'ISSUE:'
     DEFAULT_SEVERITY_PREFIX = 'SEVERITY:'
 ```
 
-Example: 
+Example:
+
 ```gherkin
   @SEVERITY:trivial @ISSUE:YZZ-100 @TMS:9901
   Scenario: Leave First Name Blank
     When I register an account without a first name
     Then exactly (1) [validation_error] should be visible
-```    
+```
 
 You can configure these prefixes as well as tms and issue tracker urls like this:
 
 ```ruby
-Allure.configure do |c|
-  c.link_tms_pattern = "http://www.hiptest.com/tms/{}"
-  c.link_issue_pattern = "http://www.jira.com/browse/{}"
+AllureCucumber.configure do |c|
   c.tms_prefix      = 'HIPTEST--'
   c.issue_prefix    = 'JIRA++'
   c.severity_prefix = 'URGENCY:'
 end
 ```
 
-Example: 
+Example:
+
 ```gherkin
   @URGENCY:critical @JIRA++YZZ-100 @HIPTEST--9901
   Scenario: Leave First Name Blank
     When I register an account without a first name
     Then exactly (1) [validation_error] should be visible
-```    
+```
 
 Additional special tags exists for setting status detail of test scenarios, allure will pick up following tags: `@flaky`, `@known` and `@muted`
 
@@ -75,7 +83,7 @@ Put the following in your `features/support/env.rb` file:
 require 'allure-cucumber'
 ```
 
-Use `--format Allure::CucumberFormatter --out where/you-want-results` while running cucumber or add it to `cucumber.yml`
+Use `--format AllureCucumber::CucumberFormatter --out where/you-want-results` while running cucumber or add it to `cucumber.yml`. Note that cucumber `--out` option overrides `results_directory` set via `Allure.configure` method.
 
 You can also manually attach screenshots and links to test steps and test cases by interacting with allure lifecycle directly. For more info check out `allure-ruby-commons`
 
@@ -89,4 +97,5 @@ Allure.add_link("Custom Url", "http://www.github.com")
 ```
 
 ## How to generate report
+
 This adaptor only generates json files containing information about tests. See [wiki section](https://docs.qameta.io/allure/#_reporting) on how to generate report.

data/lib/allure-cucumber.rb

@@ -6,7 +6,8 @@ require "allure-ruby-commons"
 require "allure_cucumber/formatter"
 require "allure_cucumber/config"
 
-module Allure
+# Main allure-cucumber module providing configuration methods
+module AllureCucumber
   class << self
     # Get allure cucumber configuration
     # @return [Allure::CucumberConfig]

data/lib/allure_cucumber/ast_transformer.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-# Cucumber::Core::Ast is removed in cucumber-core 4.0 version.
-# This will have to be updated accordingly, once stable version rolls out
-
-module Allure
+module AllureCucumber
+  # Cucumber::Core::Ast is removed in cucumber-core 4.0 version.
+  # This will have to be updated accordingly, once stable version rolls out
   module AstTransformer
     # Get scenario object
     # @param [Cucumber::Core::Test::Case] test_case
@@ -15,7 +14,7 @@ module Allure
     end
 
     # Get step object
-    # @param [Cucumber::Core::Test::Step] test_case
+    # @param [Cucumber::Core::Test::Step] test_step
     # @return [Cucumber::Core::Ast::Step]
     def step(test_step)
       test_step.source.detect { |it| it.is_a?(Cucumber::Core::Ast::Step) }

data/lib/allure_cucumber/config.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-module Allure
-  class CucumberConfig < Config
+module AllureCucumber
+  # Allure cucumber configuration
+  class CucumberConfig
     class << self
+      # @return [String] default tms tag prefix
       DEFAULT_TMS_PREFIX = "TMS:"
+      # @return [String] default issue tag prefix
       DEFAULT_ISSUE_PREFIX = "ISSUE:"
+      # @return [String] default severity tag prefix
       DEFAULT_SEVERITY_PREFIX = "SEVERITY:"
 
       attr_writer :tms_prefix, :issue_prefix, :severity_prefix

data/lib/allure_cucumber/cucumber_model.rb

@@ -8,7 +8,7 @@ require "csv"
 require_relative "ast_transformer"
 require_relative "tag_parser"
 
-module Allure
+module AllureCucumber
   # Support class for transforming cucumber test entities in to allure model entities
   class AllureCucumberModel
     extend AstTransformer
@@ -19,7 +19,7 @@ module Allure
       # @param [Cucumber::Core::Test::Case] test_case
       # @return [TestResult]
       def test_result(test_case)
-        TestResult.new(
+        Allure::TestResult.new(
           name: test_case.name,
           description: description(test_case),
           description_html: description(test_case),
@@ -36,7 +36,7 @@ module Allure
       # @param [Cucumber::Core::Test::Step] test_step
       # @return [StepResult]
       def step_result(test_step)
-        StepResult.new(
+        Allure::StepResult.new(
           name: "#{step(test_step).keyword}#{test_step.text}",
           attachments: [multiline_arg_attachment(test_step)].compact,
         )
@@ -47,7 +47,7 @@ module Allure
       # @return [StepResult]
       def fixture_result(test_step)
         location = test_step.location.to_s.split("/").last
-        FixtureResult.new(name: location)
+        Allure::FixtureResult.new(name: location)
       end
 
       # Get failure details
@@ -72,12 +72,12 @@ module Allure
       # @return [Array<Allure::Label>]
       def labels(test_case)
         labels = []
-        labels << ResultUtils.framework_label("cucumber")
-        labels << ResultUtils.feature_label(test_case.feature.name)
-        labels << ResultUtils.package_label(test_case.feature.name)
-        labels << ResultUtils.suite_label(test_case.feature.name)
-        labels << ResultUtils.story_label(test_case.name)
-        labels << ResultUtils.test_class_label(test_case.name)
+        labels << Allure::ResultUtils.framework_label("cucumber")
+        labels << Allure::ResultUtils.feature_label(test_case.feature.name)
+        labels << Allure::ResultUtils.package_label(test_case.feature.name)
+        labels << Allure::ResultUtils.suite_label(test_case.feature.name)
+        labels << Allure::ResultUtils.story_label(test_case.name)
+        labels << Allure::ResultUtils.test_class_label(test_case.name)
         unless test_case.tags.empty?
           labels.push(*tag_labels(test_case.tags))
           labels << severity(test_case.tags)
@@ -97,7 +97,7 @@ module Allure
       # @param [Cucumber::Core::Test::Case] test_case
       # @return [Array<Allure::Parameter>]
       def parameters(test_case)
-        example_row(test_case)&.values&.map { |value| Parameter.new("argument", value) }
+        example_row(test_case)&.values&.map { |value| Allure::Parameter.new("argument", value) }
       end
 
       # @param [Cucumber::Core::Test::Case] test_case
@@ -119,7 +119,7 @@ module Allure
       # @param [Cucumber::Core::Ast::DataTable] multiline_arg
       # @return [Allure::Attachment]
       def data_table_attachment(multiline_arg)
-        attachment = lifecycle.prepare_attachment("data-table", ContentType::CSV)
+        attachment = lifecycle.prepare_attachment("data-table", Allure::ContentType::CSV)
         csv = multiline_arg.raw.each_with_object([]) { |row, arr| arr.push(row.to_csv) }.join("")
         lifecycle.write_attachment(csv, attachment)
         attachment
@@ -128,7 +128,7 @@ module Allure
       # @param [String] multiline_arg
       # @return [String]
       def docstring_attachment(multiline_arg)
-        attachment = lifecycle.prepare_attachment("docstring", ContentType::TXT)
+        attachment = lifecycle.prepare_attachment("docstring", Allure::ContentType::TXT)
         lifecycle.write_attachment(multiline_arg.content, attachment)
         attachment
       end

data/lib/allure_cucumber/formatter.rb

@@ -1,23 +1,29 @@
 # frozen_string_literal: true
 
+require "fileutils"
 require_relative "cucumber_model"
 
-module Allure
+module AllureCucumber
   # Main formatter class. Translates cucumber event to allure lifecycle
   class CucumberFormatter
+    # @return [Hash] hook handler methods
     HOOK_HANDLERS = {
       "Before hook" => :start_prepare_fixture,
       "After hook" => :start_tear_down_fixture,
     }.freeze
+    # @return [Hash] allure statuses mapping
     ALLURE_STATUS = {
-      failed: Status::FAILED,
-      skipped: Status::SKIPPED,
-      passed: Status::PASSED,
+      failed: Allure::Status::FAILED,
+      skipped: Allure::Status::SKIPPED,
+      passed: Allure::Status::PASSED,
     }.freeze
 
     # @param [Cucumber::Configuration] config
     def initialize(config)
-      Allure::Config.results_directory = config.out_stream if config.out_stream.is_a?(String)
+      Allure.configure do |c|
+        c.results_directory = config.out_stream if config.out_stream.is_a?(String)
+        FileUtils.rm_f(Dir.glob("#{c.results_directory}/*")) if c.clean_results_directory
+      end
       config.on_event(:test_case_started, &method(:on_test_case_started))
       config.on_event(:test_step_started, &method(:on_test_step_started))
       config.on_event(:test_step_finished, &method(:on_test_step_finished))
@@ -28,7 +34,7 @@ module Allure
     # @param [Cucumber::Core::Events::TestCaseStarted] event
     # @return [void]
     def on_test_case_started(event)
-      lifecycle.start_test_container(TestResultContainer.new(name: event.test_case.name))
+      lifecycle.start_test_container(Allure::TestResultContainer.new(name: event.test_case.name))
       lifecycle.start_test_case(AllureCucumberModel.test_result(event.test_case))
     end
 
@@ -46,8 +52,8 @@ module Allure
       return if prepare_world_hook?(event.test_step)
 
       update_block = proc do |step|
-        step.stage = Stage::FINISHED
-        step.status = ALLURE_STATUS.fetch(event.result.to_sym, Status::BROKEN)
+        step.stage = Allure::Stage::FINISHED
+        step.status = ALLURE_STATUS.fetch(event.result.to_sym, Allure::Status::BROKEN)
       end
       step_type = hook?(event.test_step) ? "fixture" : "test_step"
 
@@ -60,9 +66,9 @@ module Allure
     # @return [void]
     def on_test_case_finished(event)
       failure_details = AllureCucumberModel.failure_details(event.result)
-      status = ALLURE_STATUS.fetch(event.result.to_sym, Status::BROKEN)
+      status = ALLURE_STATUS.fetch(event.result.to_sym, Allure::Status::BROKEN)
       lifecycle.update_test_case do |test_case|
-        test_case.stage = Stage::FINISHED
+        test_case.stage = Allure::Stage::FINISHED
         test_case.status = event.result.failed? ? Allure::ResultUtils.status(event.result&.exception) : status
         test_case.status_details.flaky = event.result.flaky?
         test_case.status_details.message = failure_details[:message]

data/lib/allure_cucumber/tag_parser.rb

@@ -2,36 +2,37 @@
 
 require_relative "config"
 
-module Allure
+module AllureCucumber
+  # Cucumber tag parser helper methods
   module TagParser
     # @param [Cucumber::Core::Ast::Tag] tags
     # @return [Array<Allure::Label>]
     def tag_labels(tags)
       tags
         .reject { |tag| reserved?(tag.name) }
-        .map { |tag| ResultUtils.tag_label(tag.name.delete_prefix("@")) }
+        .map { |tag| Allure::ResultUtils.tag_label(tag.name.delete_prefix("@")) }
     end
 
     # @param [Cucumber::Core::Ast::Tag] tags
     # @return [Array<Allure::Link>]
     def tms_links(tags)
-      return [] unless CucumberConfig.link_tms_pattern
+      return [] unless Allure::Config.link_tms_pattern
 
       tms_pattern = reserved_patterns[:tms]
       tags
         .select { |tag| tag.name.match?(tms_pattern) }
-        .map { |tag| tag.name.match(tms_pattern) { |match| ResultUtils.tms_link(match[:tms]) } }
+        .map { |tag| tag.name.match(tms_pattern) { |match| Allure::ResultUtils.tms_link(match[:tms]) } }
     end
 
     # @param [Cucumber::Core::Ast::Tag] tags
     # @return [Array<Allure::Link>]
     def issue_links(tags)
-      return [] unless CucumberConfig.link_issue_pattern
+      return [] unless Allure::Config.link_issue_pattern
 
       issue_pattern = reserved_patterns[:issue]
       tags
         .select { |tag| tag.name.match?(issue_pattern) }
-        .map { |tag| tag.name.match(issue_pattern) { |match| ResultUtils.issue_link(match[:issue]) } }
+        .map { |tag| tag.name.match(issue_pattern) { |match| Allure::ResultUtils.issue_link(match[:issue]) } }
     end
 
     # @param [Cucumber::Core::Ast::Tag] tags
@@ -42,7 +43,7 @@ module Allure
         .detect { |tag| tag.name.match?(severity_pattern) }&.name
         &.match(severity_pattern)&.[](:severity) || "normal"
 
-      ResultUtils.severity_label(severity)
+      Allure::ResultUtils.severity_label(severity)
     end
 
     # @param [Cucumber::Core::Ast::Tag] tags

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.10.0.beta3
+  version: 2.13.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allure-ruby-commons
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0.beta3
+        version: 2.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0.beta3
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ files:
 - lib/allure_cucumber/cucumber_model.rb
 - lib/allure_cucumber/formatter.rb
 - lib/allure_cucumber/tag_parser.rb
-homepage: http://allure.qatools.ru
+homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
 metadata: {}
@@ -66,9 +66,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: