allure-cucumber 2.13.8.1 → 2.13.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ed90b6ad0073262969fa5e433bc9377b8819bc717e187646b2cdc513cbf5e23
-  data.tar.gz: 66675726bd054f79afc4b870b5b16b4b09b33c49bd90791b0c5c030c5fdea952
+  metadata.gz: df0a75ebcd25e7169150696e4745ecef51e069a71e7491ec8317ee32b09c8bd8
+  data.tar.gz: 659024e9b7ca69d939a2908e629a92efa62d8b68d0ff32946fdc844f1f58bf01
 SHA512:
-  metadata.gz: 0d75d177740bd48c8d28011883c435046e9c7e8f6d950f986fff413e5f83896f6ad1716f15ddc526b9237e161693f9920d8bbb27ff84862d1bf87e1a5a157427
-  data.tar.gz: 60b79aace137482bf1407d45aefd7f79775b3b21d9ced240d6ce559a138ea2bd57742d6e7f08ade9690c8cd81f3a33742a552f0ce19828d97fc74eaf5269c630
+  metadata.gz: badd202150dedfb6ce97d4f84acafa015ca19cf96cb4e4074c100cfcf057d1bd2a3f18dfe91b87ac2b03083a5ba59883d342807fda3600fbbaf84285215139db
+  data.tar.gz: 8f80df33fafc4a7f60c27524f586182d55d3e290d48630ccf871766c2e09c2c50fc74ce4d0a225fb3d3831f6cdcefd3101226dc425d9e2b08a6318b60d54128c

data/README.md

@@ -52,18 +52,24 @@ AllureCucumber.configure do |config|
 end
 ```
 
-By default, allure-cucumber will analyze your cucumber tags looking for Test Management, Issue Management, and Severity tag. Links to TMS and ISSUE and test severity will be displayed in the report. By default these prefixes are used:
+By default, allure-cucumber will analyze your cucumber tags looking for Test Management, Issue Management, and Severity tag as well
+as custom tags for grouping tests in to epics, features and stories in Behavior tab of report. Links to TMS and ISSUE and test severity will be displayed in the report.
+
+By default these prefixes are used:
 
 ```ruby
     DEFAULT_TMS_PREFIX      = 'TMS:'
     DEFAULT_ISSUE_PREFIX    = 'ISSUE:'
     DEFAULT_SEVERITY_PREFIX = 'SEVERITY:'
+    DEFAULT_EPIC_PREFIX     = 'EPIC:'
+    DEFAULT_FEATURE_PREFIX  = 'FEATURE:'
+    DEFAULT_STORY_PREFIX    = 'STORY:'
 ```
 
 Example:
 
 ```gherkin
-  @SEVERITY:trivial @ISSUE:YZZ-100 @TMS:9901
+  @SEVERITY:trivial @ISSUE:YZZ-100 @TMS:9901 @EPIC:custom-epic
   Scenario: Leave First Name Blank
     When I register an account without a first name
     Then exactly (1) [validation_error] should be visible
@@ -76,13 +82,16 @@ AllureCucumber.configure do |config|
   config.tms_prefix      = 'HIPTEST--'
   config.issue_prefix    = 'JIRA++'
   config.severity_prefix = 'URGENCY:'
+  config.epic_prefix = 'epic:'
+  config.feature_prefix = 'feature:'
+  config.story_prefix = 'story:'
 end
 ```
 
 Example:
 
 ```gherkin
-  @URGENCY:critical @JIRA++YZZ-100 @HIPTEST--9901
+  @URGENCY:critical @JIRA++YZZ-100 @HIPTEST--9901 @epic:custom-epic
   Scenario: Leave First Name Blank
     When I register an account without a first name
     Then exactly (1) [validation_error] should be visible
@@ -105,6 +114,8 @@ Allure.add_attachment(name: "attachment", source: "Some string", type: Allure::C
 Allure.add_link("Custom Url", "http://www.github.com")
 ```
 
+It's possible to mark methods so those are included as allure steps: [Step annotations](../allure-ruby-commons/README.md#steps)
+
 ### Example project
 
 [Cucumber Example](https://github.com/allure-examples/allure-cucumber-example)

data/lib/allure-cucumber.rb

@@ -3,8 +3,7 @@
 
 require "allure-ruby-commons"
 
-require "allure_cucumber/config"
-require "allure_cucumber/formatter"
+require_rel "allure_cucumber"
 
 # Main allure-cucumber module providing configuration methods
 module AllureCucumber

data/lib/allure_cucumber/config.rb

@@ -15,6 +15,12 @@ module AllureCucumber
     DEFAULT_ISSUE_PREFIX = "ISSUE:"
     # @return [String] default severity tag prefix
     DEFAULT_SEVERITY_PREFIX = "SEVERITY:"
+    # @return [String] default epic tag prefix
+    DEFAULT_EPIC_PREFIX = "EPIC:"
+    # @return [String] default feature tag prefix
+    DEFAULT_FEATURE_PREFIX = "FEATURE:"
+    # @return [String] default story tag prefix
+    DEFAULT_STORY_PREFIX = "STORY:"
 
     def_delegators :@allure_config,
                    :clean_results_directory,
@@ -50,5 +56,20 @@ module AllureCucumber
     def severity_prefix
       @severity_prefix || DEFAULT_SEVERITY_PREFIX
     end
+
+    # @return [String]
+    def epic_prefix
+      @epic_prefix || DEFAULT_EPIC_PREFIX
+    end
+
+    # @return [String]
+    def feature_prefix
+      @feature_prefix || DEFAULT_FEATURE_PREFIX
+    end
+
+    # @return [String]
+    def story_prefix
+      @story_prefix || DEFAULT_STORY_PREFIX
+    end
   end
 end

data/lib/allure_cucumber/formatter.rb

@@ -2,8 +2,6 @@
 
 require "cucumber/core"
 
-require_relative "models/cucumber_model"
-
 module AllureCucumber
   # Main formatter class. Translates cucumber event to allure lifecycle
   class CucumberFormatter
@@ -67,10 +65,8 @@ module AllureCucumber
         step.stage = Allure::Stage::FINISHED
         step.status = ALLURE_STATUS.fetch(event.result.to_sym, Allure::Status::BROKEN)
       end
-      step_type = event.test_step.hook? ? "fixture" : "test_step"
 
-      lifecycle.public_send("update_#{step_type}", &update_block)
-      lifecycle.public_send("stop_#{step_type}")
+      event.test_step.hook? ? handle_hook_finished(event.test_step, update_block) : handle_step_finished(update_block)
     end
 
     # Handle test case finished event
@@ -100,6 +96,13 @@ module AllureCucumber
       Allure.lifecycle
     end
 
+    # Is hook fixture like Before, After or Step as AfterStep
+    # @param [String] text
+    # @return [boolean]
+    def fixture_hook?(text)
+      HOOK_HANDLERS.key?(text)
+    end
+
     # @param [Cucumber::Core::Test::Step] test_step
     # @return [void]
     def handle_step_started(test_step)
@@ -111,7 +114,27 @@ module AllureCucumber
     # @param [Cucumber::Core::Test::HookStep] hook_step
     # @return [void]
     def handle_hook_started(hook_step)
-      lifecycle.public_send(HOOK_HANDLERS[hook_step.text], cucumber_model.fixture_result(hook_step))
+      result = cucumber_model.fixture_result(hook_step)
+      return lifecycle.start_test_step(result) unless fixture_hook?(hook_step.text)
+
+      lifecycle.public_send(HOOK_HANDLERS[hook_step.text], result)
+    end
+
+    # @param [Proc] update_block
+    # @return [void]
+    def handle_step_finished(update_block)
+      lifecycle.update_test_step(&update_block)
+      lifecycle.stop_test_step
+    end
+
+    # @param [Cucumber::Core::Test::HookStep] hook_step
+    # @param [Proc] update_block
+    # @return [void]
+    def handle_hook_finished(hook_step, update_block)
+      return handle_step_finished(update_block) unless fixture_hook?(hook_step.text)
+
+      lifecycle.update_fixture(&update_block)
+      lifecycle.stop_fixture
     end
   end
 end

data/lib/allure_cucumber/models/cucumber_model.rb

@@ -4,15 +4,9 @@ require "csv"
 require "cucumber/core"
 require "cucumber/formatter/ast_lookup"
 
-require_relative "scenario"
-require_relative "step"
-require_relative "tag_parser"
-
 module AllureCucumber
   # Support class for transforming cucumber test entities in to allure model entities
   class AllureCucumberModel
-    include TagParser
-
     # @param [Cucumber::Configuration] config
     def initialize(config)
       @ast_lookup = Cucumber::Formatter::AstLookup.new(config)
@@ -23,6 +17,7 @@ module AllureCucumber
     # @return [Allure::TestResult]
     def test_result(test_case)
       scenario = Scenario.new(test_case, ast_lookup)
+      parser = MetadataParser.new(scenario)
 
       Allure::TestResult.new(
         name: scenario.name,
@@ -30,10 +25,10 @@ module AllureCucumber
         description_html: scenario.description,
         history_id: scenario.id,
         full_name: scenario.name,
-        labels: labels(scenario),
-        links: links(scenario),
-        parameters: parameters(scenario),
-        status_details: Allure::StatusDetails.new(**status_detail_tags(scenario.tags))
+        labels: parser.labels,
+        links: parser.links,
+        parameters: parser.parameters,
+        status_details: parser.status_details
       )
     end
 
@@ -55,7 +50,7 @@ module AllureCucumber
     # @param [Cucumber::Core::Test::HookStep] hook_step
     # @return [Allure::StepResult]
     def fixture_result(hook_step)
-      Allure::FixtureResult.new(name: hook_step.location.to_s.split("/").last)
+      Allure::FixtureResult.new(name: "#{hook_step.text} (#{hook_step.location.to_s.split('/').last})")
     end
 
     # Get failure details
@@ -72,36 +67,6 @@ module AllureCucumber
 
     attr_reader :ast_lookup, :lifecycle
 
-    # @param [Scenario] scenario
-    # @return [Array<Allure::Label>]
-    def labels(scenario)
-      labels = []
-      labels << Allure::ResultUtils.framework_label("cucumber")
-      labels << Allure::ResultUtils.feature_label(scenario.feature_name)
-      labels << Allure::ResultUtils.package_label(scenario.feature_folder)
-      labels << Allure::ResultUtils.suite_label(scenario.feature_name)
-      labels << Allure::ResultUtils.story_label(scenario.name)
-      labels << Allure::ResultUtils.test_class_label(scenario.feature_file_name)
-      unless scenario.tags.empty?
-        labels.push(*tag_labels(scenario.tags))
-        labels << severity(scenario.tags)
-      end
-
-      labels
-    end
-
-    # @param [Cucumber::Core::Test::Case] test_case
-    # @return [Array<Allure::Link>]
-    def links(test_case)
-      tms_links(test_case.tags) + issue_links(test_case.tags)
-    end
-
-    # @param [AllureCucumber::Scenario] scenario
-    # @return [Array<Allure::Parameter>]
-    def parameters(scenario)
-      scenario.examples.map { |k, v| Allure::Parameter.new(k, v) }
-    end
-
     # @param [Step] step
     # @return [Array<Allure::Attachment>]
     def step_attachments(step)

data/lib/allure_cucumber/models/metadata_parser.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+module AllureCucumber
+  # Cucumber tag parser helper methods
+  class MetadataParser
+    def initialize(scenario)
+      @scenario = scenario
+    end
+
+    # @return [Array<Allure::Label>]
+    def labels
+      [
+        Allure::ResultUtils.framework_label("cucumber"),
+        Allure::ResultUtils.package_label(scenario.feature_folder),
+        Allure::ResultUtils.test_class_label(scenario.feature_file_name),
+        Allure::ResultUtils.suite_label(scenario.feature_name),
+        severity,
+        *behavior_labels,
+        *tag_labels
+      ].select(&:value)
+    end
+
+    # @return [Array<Allure::Label>]
+    def tag_labels
+      tags
+        .reject { |tag| reserved?(tag) }
+        .map { |tag| Allure::ResultUtils.tag_label(tag.delete_prefix("@")) }
+    end
+
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [Array<Allure::Link>]
+    def links
+      tms_links + issue_links
+    end
+
+    # @return [Allure::Label]
+    def severity
+      Allure::ResultUtils.severity_label(tag_value(:severity) || "normal")
+    end
+
+    # @return [Array<Allure::Parameter>]
+    def parameters
+      scenario.examples.map { |k, v| Allure::Parameter.new(k, v) }
+    end
+
+    # @return [Hash<Symbol, Boolean>]
+    def status_details
+      Allure::StatusDetails.new(
+        flaky: tags.any? { |tag| tag.match?(reserved_patterns[:flaky]) },
+        muted: tags.any? { |tag| tag.match?(reserved_patterns[:muted]) },
+        known: tags.any? { |tag| tag.match?(reserved_patterns[:known]) }
+      )
+    end
+
+    # Get behavior labels
+    # @return [Array<Allure::Label>]
+    def behavior_labels
+      epic = tag_value(:epic) || scenario.feature_folder
+      feature = tag_value(:feature) || scenario.feature_name
+      story = tag_value(:story)
+
+      [
+        Allure::ResultUtils.epic_label(epic),
+        Allure::ResultUtils.feature_label(feature),
+        Allure::ResultUtils.story_label(story)
+      ]
+    end
+
+    private
+
+    # @return [AllureCucumber::Scenario]
+    attr_reader :scenario
+
+    # Get scenario tags
+    #
+    # @return [Array<String>]
+    def tags
+      @tags ||= scenario.tags
+    end
+
+    # @return [Array<Allure::Link>]
+    def tms_links
+      return [] unless AllureCucumber.configuration.link_tms_pattern
+
+      matching_links(:tms)
+    end
+
+    # @return [Array<Allure::Link>]
+    def issue_links
+      return [] unless AllureCucumber.configuration.link_issue_pattern
+
+      matching_links(:issue)
+    end
+
+    # @param [Symbol] type
+    # @return [Array<Allure::Link>]
+    def matching_links(type)
+      pattern = reserved_patterns[type]
+      tags
+        .select { |tag| tag.match?(pattern) }
+        .map { |tag| tag.match(pattern) { |match| Allure::ResultUtils.public_send("#{type}_link", match[type]) } }
+    end
+
+    # @return [Hash<Symbol, Regexp>]
+    def reserved_patterns
+      @reserved_patterns ||= {
+        tms: /@#{AllureCucumber.configuration.tms_prefix}(?<tms>\S+)/,
+        issue: /@#{AllureCucumber.configuration.issue_prefix}(?<issue>\S+)/,
+        severity: /@#{AllureCucumber.configuration.severity_prefix}(?<severity>\S+)/,
+        epic: /@#{AllureCucumber.configuration.epic_prefix}(?<epic>\S+)/,
+        feature: /@#{AllureCucumber.configuration.feature_prefix}(?<feature>\S+)/,
+        story: /@#{AllureCucumber.configuration.story_prefix}(?<story>\S+)/,
+        flaky: /@flaky/,
+        muted: /@muted/,
+        known: /@known/
+      }
+    end
+
+    # @param [String] tag
+    # @return [Boolean]
+    def reserved?(tag)
+      reserved_patterns.values.any? { |pattern| tag.match?(pattern) }
+    end
+
+    # Get specific tag value
+    #
+    # @param [Symbol] type
+    # @return [String]
+    def tag_value(type)
+      pattern = reserved_patterns[type]
+      tag = tags.detect { |t| t.match?(pattern) }
+      return unless tag
+
+      tag.match(pattern)[type]
+    end
+  end
+end

data/lib/allure_cucumber/models/scenario.rb

@@ -34,9 +34,7 @@ module AllureCucumber
     # Scenario description or it's location
     # @return [String]
     def description
-      @description ||= begin
-        scenario.description.empty? ? "Location - #{test_case.location}" : scenario.description.strip
-      end
+      @description ||= scenario.description.empty? ? "Location - #{test_case.location}" : scenario.description.strip
     end
 
     # Scenario outline row parameters
@@ -86,7 +84,9 @@ module AllureCucumber
     # @return [String]
     def example_row
       @example_row ||= begin
-        "Examples (##{scenario_source.examples.table_body.index { |row| row.id == scenario_source.row.id } + 1})"
+        scneario_examples = scenario_source.examples.table_body.index { |row| row.id == scenario_source.row.id } + 1
+
+        "Examples (##{scneario_examples})"
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.13.8.1
+  version: 2.13.9
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-04-15 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.13.8.1
+        version: 2.13.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.8.1
+        version: 2.13.9
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +33,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 4.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 description: Cucumber adaptor to generate rich allure test reports
 email: andrejs.cunskis@gmail.com
 executables: []
@@ -55,9 +55,9 @@ files:
 - lib/allure_cucumber/config.rb
 - lib/allure_cucumber/formatter.rb
 - lib/allure_cucumber/models/cucumber_model.rb
+- lib/allure_cucumber/models/metadata_parser.rb
 - lib/allure_cucumber/models/scenario.rb
 - lib/allure_cucumber/models/step.rb
-- lib/allure_cucumber/models/tag_parser.rb
 homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Allure cucumber ruby adaptor

data/lib/allure_cucumber/models/tag_parser.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module AllureCucumber
-  # Cucumber tag parser helper methods
-  module TagParser
-    # @param [Array<String>] tags
-    # @return [Array<Allure::Label>]
-    def tag_labels(tags)
-      tags
-        .reject { |tag| reserved?(tag) }
-        .map { |tag| Allure::ResultUtils.tag_label(tag.delete_prefix("@")) }
-    end
-
-    # @param [Array<String>] tags
-    # @return [Array<Allure::Link>]
-    def tms_links(tags)
-      return [] unless AllureCucumber.configuration.link_tms_pattern
-
-      matching_links(tags, :tms)
-    end
-
-    # @param [Array<String>] tags
-    # @return [Array<Allure::Link>]
-    def issue_links(tags)
-      return [] unless AllureCucumber.configuration.link_issue_pattern
-
-      matching_links(tags, :issue)
-    end
-
-    # @param [Array<String>] tags
-    # @return [Allure::Label]
-    def severity(tags)
-      severity_pattern = reserved_patterns[:severity]
-      severity_tags = tags.detect { |tag| tag.match?(severity_pattern) }
-      severity = severity_tags&.match(severity_pattern)&.[](:severity) || "normal"
-
-      Allure::ResultUtils.severity_label(severity)
-    end
-
-    # @param [Array<String>] tags
-    # @return [Hash<Symbol, Boolean>]
-    def status_detail_tags(tags)
-      {
-        flaky: tags.any? { |tag| tag.match?(reserved_patterns[:flaky]) },
-        muted: tags.any? { |tag| tag.match?(reserved_patterns[:muted]) },
-        known: tags.any? { |tag| tag.match?(reserved_patterns[:known]) }
-      }
-    end
-
-    private
-
-    # @param [Array<String>] tags
-    # @param [Symbol] type
-    # @return [Array<Allure::Link>]
-    def matching_links(tags, type)
-      pattern = reserved_patterns[type]
-      tags
-        .select { |tag| tag.match?(pattern) }
-        .map { |tag| tag.match(pattern) { |match| Allure::ResultUtils.public_send("#{type}_link", match[type]) } }
-    end
-
-    # @return [Hash<Symbol, Regexp>]
-    def reserved_patterns
-      @reserved_patterns ||= {
-        tms: /@#{AllureCucumber.configuration.tms_prefix}(?<tms>\S+)/,
-        issue: /@#{AllureCucumber.configuration.issue_prefix}(?<issue>\S+)/,
-        severity: /@#{AllureCucumber.configuration.severity_prefix}(?<severity>\S+)/,
-        flaky: /@flaky/,
-        muted: /@muted/,
-        known: /@known/
-      }
-    end
-
-    # @param [String] tag
-    # @return [Boolean]
-    def reserved?(tag)
-      reserved_patterns.values.any? { |pattern| tag.match?(pattern) }
-    end
-  end
-end