allure-rspec 2.13.8.1 → 2.13.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f2f8820b6daa5d3c02e82351e4d2e96eb3ef2855e7f9996fc443fa1c365732
-  data.tar.gz: 20f57610fa0c184bb8a760a072bac74aef030dfab41f455afa539009d06c7a75
+  metadata.gz: 77fad060fb1fbcbbb4399244a58df51707defcfe9a2e7b5a5b193fb1a4940420
+  data.tar.gz: 73d4d50f964562c583158da41999dc8c8390f8b977cf3c532da7da50f8524835
 SHA512:
-  metadata.gz: 102c88482e735b89b351725c099429f3d1637a156bd5e86f8f2893ecc3d30501f41439e95544fa0aedb17f3c85e875aa455dec746df97355d9e3b70ae78969dc
-  data.tar.gz: 0b64c2312ab9c7d17f1ae1fc196403c60207224400f77e2260aa5a17a05563ccafbd90d9b05ca87713566b2c6b7c0e27f84239ae3d2b8cc2bbab7b7661cd1356
+  metadata.gz: 5344896aeb24c28fb6f424c2485f61e1f2656f5f0639bf25f981f88a50d432a3afa947e3b2f4f6967218c8896f9759de8f07f3aca880b6d22f9dbf46def8ca23
+  data.tar.gz: 3f3201b3da9e3997bdcc368a274b39830569612621d0af206457aa046a507f4185679674d419971f39697da9ecae6b79acd5e05eff1ebe02a38cdda5ddf7fed4

data/README.md

@@ -131,6 +131,24 @@ it "some test case", allure_1: "visual_test", allure_2: "core_functionality" do
 end
 ```
 
+### Behavior driven test grouping
+
+Marking tests with tags `:epic, :feature, :story`, will group tests accordingly in Behavior report tab:
+
+```ruby
+context "context", feature: "my feature"  do
+  it "some test case", story: "user story" do
+    # test
+  end
+end
+
+context "context 2", feature: "my feature" do
+it "some test case 2", story: "user story" do
+    # test
+  end
+end
+```
+
 ### Custom actions
 
 Rspec example object has access to [Allure](https://www.rubydoc.info/github/allure-framework/allure-ruby/Allure) helper methods.
@@ -145,6 +163,10 @@ it "some test case" do |e|
 end
 ```
 
+### Steps
+
+[Step annotations](../allure-ruby-commons/README.md#steps)
+
 ### Example project
 
 [RSpec Example](https://github.com/allure-examples/allure-rspec-example)

data/lib/allure-rspec.rb

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require "allure-ruby-commons"
-require "allure_rspec/config"
-require "allure_rspec/formatter"
+
+require_rel "allure_rspec/**/*.rb"
 
 module AllureRspec
   class << self

data/lib/allure_rspec/01_utils.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module AllureRspec
+  module Utils
+    # Strip relative ./ form path
+    # @param [String] path
+    # @return [String]
+    def strip_relative(path)
+      path.gsub("./", "")
+    end
+  end
+end

data/lib/allure_rspec/metadata_parser.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module AllureRspec
+  # Suite label generator
+  #
+  class SuiteLabels
+    include Utils
+
+    def initialize(example_group)
+      @example_group = example_group
+    end
+
+    # Get test suite labels
+    # @return [Array<Allure::Label>]
+    def fetch
+      parents = example_group.parent_groups.map do |group|
+        group.description.empty? ? "Anonymous" : group.description
+      end
+
+      labels = []
+      labels << Allure::ResultUtils.suite_label(suite(parents))
+      labels << Allure::ResultUtils.parent_suite_label(parent_suite(parents)) if parent_suite(parents)
+      labels << Allure::ResultUtils.sub_suite_label(sub_suites(parents)) if sub_suites(parents)
+
+      labels
+    end
+
+    private
+
+    attr_reader :example_group
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def suite(parents)
+      parents.length == 1 ? parents.last : parents[-2]
+    end
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def parent_suite(parents)
+      parents.length > 1 ? parents.last : nil
+    end
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def sub_suites(parents)
+      parents.length > 2 ? parents[0..-3].join(" > ") : nil
+    end
+  end
+
+  # RSpec metadata parser
+  #
+  class RspecMetadataParser
+    include Utils
+
+    RSPEC_IGNORED_METADATA = %i[
+      absolute_file_path
+      block
+      described_class
+      description
+      description_args
+      example_group
+      execution_result
+      file_path
+      full_description
+      last_run_status
+      line_number
+      location
+      rerun_file_path
+      retry
+      retry_attempts
+      retry_exceptions
+      scoped_id
+      shared_group_inclusion_backtrace
+      type
+    ].freeze
+
+    def initialize(example)
+      @example = example
+    end
+
+    # Get allure labels
+    # @return [Array<Allure::Label>]
+    def labels
+      [
+        framework_label,
+        package_label,
+        test_class_label,
+        severity,
+        *tag_labels,
+        *behavior_labels,
+        *suite_labels
+      ].select(&:value)
+    end
+
+    # Get attachable links
+    # @return [Array<Allure::Link>]
+    def links
+      matching_links(:tms) + matching_links(:issue)
+    end
+
+    # Get status details
+    # @return [Allure::StatusDetails]
+    def status_details
+      Allure::StatusDetails.new(
+        flaky: !metadata[:flaky].nil?,
+        muted: !metadata[:muted].nil?,
+        known: !metadata[:known].nil?
+      )
+    end
+
+    private
+
+    # @param [RSpec::Core::Example] example
+    attr_reader :example
+
+    # Example metadata
+    #
+    # @return [Hash]
+    def metadata
+      @metadata ||= example.metadata
+    end
+
+    # Get package label
+    # @return [Allure::Label]
+    def package_label
+      Allure::ResultUtils.package_label(Pathname.new(strip_relative(example.file_path)).parent.to_s)
+    end
+
+    # Get test class label
+    #
+    # @return [Allure::Label]
+    def test_class_label
+      Allure::ResultUtils.test_class_label(File.basename(example.file_path, ".rb"))
+    end
+
+    # Get framework label
+    # @return [Allure::Label]
+    def framework_label
+      Allure::ResultUtils.framework_label("rspec")
+    end
+
+    # Get severity
+    # @return [String]
+    def severity
+      Allure::ResultUtils.severity_label(metadata[:severity] || "normal")
+    end
+
+    # Get test suite labels
+    # @return [Array<Allure::Label>]
+    def suite_labels
+      SuiteLabels.new(example.example_group).fetch
+    end
+
+    # Get custom labels
+    # @return [Array<Allure::Label>]
+    def tag_labels
+      metadata
+        .reject { |k| RSPEC_IGNORED_METADATA.include?(k) || special_metadata_tag?(k) }
+        .map { |k, v| allure?(k) ? Allure::ResultUtils.tag_label(v) : Allure::ResultUtils.tag_label(k.to_s) }
+    end
+
+    # Get behavior labels
+    # @return [Array<Allure::Label>]
+    def behavior_labels
+      metadata = example.metadata
+      epic = metadata[:epic] || Pathname.new(strip_relative(example.file_path)).parent.to_s
+      feature = metadata[:feature] || example.example_group.description
+      story = metadata[:story]
+
+      [
+        Allure::ResultUtils.epic_label(epic),
+        Allure::ResultUtils.feature_label(feature),
+        Allure::ResultUtils.story_label(story)
+      ]
+    end
+
+    # tms and issue links
+    # @param [Symbol] type
+    # @return [Array<Allure::Link>]
+    def matching_links(type)
+      return [] unless AllureRspec.configuration.public_send("link_#{type}_pattern")
+
+      metadata
+        .select { |k| __send__("#{type}?", k) }.values
+        .map { |v| Allure::ResultUtils.public_send("#{type}_link", v) }
+    end
+
+    # Special allure metadata tags
+    #
+    # @param [Symbol] key
+    # @return [boolean]
+    def special_metadata_tag?(key)
+      tms?(key) || issue?(key) || %i[severity epic feature story].include?(key)
+    end
+
+    # Does key match custom allure label
+    # @param [Symbol] key
+    # @return [boolean]
+    def allure?(key)
+      key.to_s.match?(/allure(_\d+)?/i)
+    end
+
+    # Does key match tms pattern
+    # @param [Symbol] key
+    # @return [boolean]
+    def tms?(key)
+      key.to_s.match?(/tms(_\d+)?/i)
+    end
+
+    # Does key match issue pattern
+    # @param [Symbol] key
+    # @return [boolean]
+    def issue?(key)
+      key.to_s.match?(/issue(_\d+)?/i)
+    end
+  end
+end

data/lib/allure_rspec/rspec_model.rb

@@ -3,12 +3,10 @@
 require "digest"
 require "pathname"
 
-require_relative "tag_parser"
-
 module AllureRspec
   # Support class for transforming rspec test entities in to allure model entities
   module AllureRspecModel
-    include TagParser
+    include AllureRspec::Utils
 
     # @return [Hash] allure statuses mapping
     ALLURE_STATUS = {
@@ -21,15 +19,17 @@ module AllureRspec
     # @param [RSpec::Core::Example] example
     # @return [Allure::TestResult]
     def test_result(example)
+      parser = RspecMetadataParser.new(example)
+
       Allure::TestResult.new(
         name: example.description,
         description: "Location - #{strip_relative(example.location)}",
         description_html: "Location - #{strip_relative(example.location)}",
         history_id: Digest::MD5.hexdigest(example.id),
         full_name: example.full_description,
-        labels: labels(example),
-        links: links(example),
-        status_details: Allure::StatusDetails.new(**status_detail_tags(example.metadata))
+        labels: parser.labels,
+        links: parser.links,
+        status_details: parser.status_details
       )
     end
 
@@ -49,12 +49,6 @@ module AllureRspec
 
     private
 
-    # @param [RSpec::Core::Example] example
-    # @return [Array<Allure::Label>]
-    def links(example)
-      tms_links(example.metadata) + issue_links(example.metadata)
-    end
-
     # Get allure status from result
     # @param [RSpec::Core::Example::ExecutionResult] result
     # @return [Symbol]
@@ -63,59 +57,5 @@ module AllureRspec
 
       ALLURE_STATUS[result.status]
     end
-
-    # @param [RSpec::Core::Example] example
-    # @return [Array<Allure::Label>]
-    def labels(example)
-      labels = []
-      labels << Allure::ResultUtils.framework_label("rspec")
-      labels << Allure::ResultUtils.feature_label(example.example_group.description)
-      labels << Allure::ResultUtils.package_label(Pathname.new(strip_relative(example.file_path)).parent.to_s)
-      labels << Allure::ResultUtils.story_label(example.description)
-      labels << Allure::ResultUtils.test_class_label(File.basename(example.file_path, ".rb"))
-      labels << severity(example.metadata)
-      labels.push(*tag_labels(example.metadata))
-      labels.push(*suite_labels(example.example_group))
-
-      labels
-    end
-
-    # Add suite labels
-    # @param [RSpec::Core::ExampleGroup] example_group
-    # @return [Array<Allure::Label>]
-    def suite_labels(example_group)
-      parents = example_group.parent_groups.map { |group| group.description.empty? ? "Anonymous" : group.description }
-      labels = []
-      labels << Allure::ResultUtils.suite_label(suite(parents))
-      labels << Allure::ResultUtils.parent_suite_label(parent_suite(parents)) if parent_suite(parents)
-      labels << Allure::ResultUtils.sub_suite_label(sub_suites(parents)) if sub_suites(parents)
-
-      labels
-    end
-
-    # @param [Array<String>] parents
-    # @return [String]
-    def suite(parents)
-      parents.length == 1 ? parents.last : parents[-2]
-    end
-
-    # @param [Array<String>] parents
-    # @return [String]
-    def parent_suite(parents)
-      parents.length > 1 ? parents.last : nil
-    end
-
-    # @param [Array<String>] parents
-    # @return [String]
-    def sub_suites(parents)
-      parents.length > 2 ? parents[0..-3].join(" > ") : nil
-    end
-
-    # Strip relative ./ form path
-    # @param [String] path
-    # @return [String]
-    def strip_relative(path)
-      path.gsub("./", "")
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 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: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +66,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/allure-rspec.rb
+- lib/allure_rspec/01_utils.rb
 - lib/allure_rspec/config.rb
 - lib/allure_rspec/formatter.rb
+- lib/allure_rspec/metadata_parser.rb
 - lib/allure_rspec/rspec_model.rb
-- lib/allure_rspec/tag_parser.rb
 homepage: https://github.com/allure-framework/allure-ruby/tree/master/allure-rspec
 licenses:
 - Apache-2.0
@@ -94,7 +95,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 rspec ruby adaptor

data/lib/allure_rspec/tag_parser.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module AllureRspec
-  # RSpec custom tag parser
-  module TagParser
-    # Get custom labels
-    # @param [Hash] metadata
-    # @return [Array<Allure::Label>]
-    def tag_labels(metadata)
-      return [] unless metadata.keys.any? { |k| allure?(k) }
-
-      metadata.select { |k| allure?(k) }.values.map { |v| Allure::ResultUtils.tag_label(v) }
-    end
-
-    # Get tms links
-    # @param [Hash] metadata
-    # @return [Array<Allure::Link>]
-    def tms_links(metadata)
-      matching_links(metadata, :tms)
-    end
-
-    # Get issue links
-    # @param [Hash] metadata
-    # @return [Array<Allure::Link>]
-    def issue_links(metadata)
-      matching_links(metadata, :issue)
-    end
-
-    # Get severity
-    # @param [Hash] metadata
-    # @return [String]
-    def severity(metadata)
-      Allure::ResultUtils.severity_label(metadata[:severity] || "normal")
-    end
-
-    # Get status details
-    # @param [Hash] metadata
-    # @return [Hash<Symbol, Boolean>]
-    def status_detail_tags(metadata)
-      {
-        flaky: !metadata[:flaky].nil?,
-        muted: !metadata[:muted].nil?,
-        known: !metadata[:known].nil?
-      }
-    end
-
-    private
-
-    # @param [Hash] metadata
-    # @param [Symbol] type
-    # @return [Array<Allure::Link>]
-    def matching_links(metadata, type)
-      unless AllureRspec.configuration.public_send("link_#{type}_pattern") &&
-             metadata.keys.any? { |k| __send__("#{type}?", k) }
-        return []
-      end
-
-      metadata
-        .select { |k| __send__("#{type}?", k) }.values
-        .map { |v| Allure::ResultUtils.public_send("#{type}_link", v) }
-    end
-
-    # Does key match custom allure label
-    # @param [Symbol] key
-    # @return [boolean]
-    def allure?(key)
-      key.to_s.match?(/allure(_\d+)?/i)
-    end
-
-    # Does key match tms pattern
-    # @param [Symbol] key
-    # @return [boolean]
-    def tms?(key)
-      key.to_s.match?(/tms(_\d+)?/i)
-    end
-
-    # Does key match issue pattern
-    # @param [Symbol] key
-    # @return [boolean]
-    def issue?(key)
-      key.to_s.match?(/issue(_\d+)?/i)
-    end
-  end
-end