allure-rspec 2.28.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976bbb8464540667897631469bd8ae7b9e995a4174b4120d361ffd36f013e9ae
-  data.tar.gz: 97081c64e4e985873af72034cf704c3fb3c2a3094025fa0830c3c858bc1b1dd2
+  metadata.gz: 7b1ea18ddb872284ccba7545c9e8b0918b75d765000498381a53a7de2f0a5472
+  data.tar.gz: 4d47410b77295618c92416d154744c4f4c0e75449bdb386fb6e05111bce38c60
 SHA512:
-  metadata.gz: b377acac69363d54043ace0f5a3daff9acde21d751063933ace20d41b9f158180e4009bddcb0473c94cdd3ae200e57a079f65d4c507884c877fcee9dd88cb0c3
-  data.tar.gz: 722df27fcaf1094fb6d87a68ab1d5cee2351b299f133536adc3f88494e7cd7099c1e8d87757e64f0e7c336b32c9b3b1f2c5d0c56752ba15b7011e5322c6e1706
+  metadata.gz: 999a696e41ef85ae1566aca0879e7ea7704aaf4fdf81c0166387ed5d546286afebad769fac5a2f968dae592d6088a48497d0010c3b09667638138abe6f84dd17
+  data.tar.gz: 6546a3ff10044dfb8841f132d677071eb538ea14f0b7306be12d5c11d6dca6a85a972ae6179ac20d6a3803198f75204d011421e09453aef12f5c354575b54c21

data/README.md

@@ -30,6 +30,12 @@ AllureRspec.configure do |config|
   config.logger = Logger.new($stdout, Logger::DEBUG)
   config.environment = "staging"
 
+  # labels added to every test result
+  config.global_labels = [
+    { name: "owner", value: "qa" },
+    { name: "tag", value: "global" }
+  ]
+
   # these are used for creating links to bugs or test cases where {} is replaced with keys of relevant items
   config.link_tms_pattern = "http://www.jira.com/browse/{}"
   config.link_issue_pattern = "http://www.jira.com/browse/{}"
@@ -44,6 +50,9 @@ AllureRspec.configure do |config|
 end
 ```
 
+`global_labels` defaults to `[]`. Each entry is a hash with symbol keys `:name` and `:value`.
+Labels are prepended to every completed test's labels without replacing test-specific labels, including those with the same name.
+
 ## Usage
 
 Via commandline arguments, simply add:

data/lib/allure_rspec/formatter.rb

@@ -15,6 +15,8 @@ module AllureRspec
       pending: Allure::Status::SKIPPED,
       passed: Allure::Status::PASSED
     }.freeze
+    ANSI_ESCAPE_PATTERN = /\e\[(\d+)(?:;\d+)*m/
+    SUITE_HOOK_FAILURE_PATTERN = /\AAn error occurred in an? `(?:before|after)\(:suite\)` hook\.\z/
 
     RSpec::Core::Formatters.register(
       self,
@@ -23,7 +25,8 @@ module AllureRspec
       :example_group_started,
       :example_group_finished,
       :example_started,
-      :example_finished
+      :example_finished,
+      :message
     )
 
     RSpec.configure do |config|
@@ -58,6 +61,7 @@ module AllureRspec
     # @return [void]
     def stop(_stop_notification)
       lifecycle.write_environment
+      lifecycle.write_globals
     end
 
     # Starts example group
@@ -92,6 +96,17 @@ module AllureRspec
       lifecycle.stop_test_container
     end
 
+    # Capture errors raised by before(:suite) and after(:suite) hooks
+    # @param [RSpec::Core::Notifications::MessageNotification] notification
+    # @return [void]
+    def message(notification)
+      formatted_error = notification.message.to_s.gsub(ANSI_ESCAPE_PATTERN, "").strip
+      first_line = formatted_error.lines.first&.chomp
+      return unless SUITE_HOOK_FAILURE_PATTERN.match?(first_line.to_s)
+
+      lifecycle.add_global_error(message: first_line, trace: formatted_error)
+    end
+
     private
 
     attr_reader :lifecycle, :allure_config
@@ -108,6 +123,7 @@ module AllureRspec
         description_html: "Location - #{strip_relative(parser.location)}",
         history_id: example.id,
         full_name: example.full_description,
+        title_path: parser.title_path,
         labels: parser.labels,
         links: parser.links,
         status_details: parser.status_details,
@@ -124,7 +140,7 @@ module AllureRspec
           test_case.stage = Allure::Stage::FINISHED
           test_case.status = status(result)
           test_case.status_details.message = status_detail.message
-          test_case.status_details.trace = status_detail.trace&.gsub(/\e\[(\d+)(?:;\d+)*m/, "")
+          test_case.status_details.trace = status_detail.trace&.gsub(ANSI_ESCAPE_PATTERN, "")
         end
       end
     end

data/lib/allure_rspec/metadata_parser.rb

@@ -67,6 +67,12 @@ module AllureRspec
       )
     end
 
+    # Title path without the final example display name.
+    # @return [Array<String>]
+    def title_path
+      [strip_relative(example.file_path), *SuiteLabels.new(example.example_group).title_path]
+    end
+
     # Example location
     #
     # @return [String]

data/lib/allure_rspec/suite_labels.rb

@@ -13,9 +13,7 @@ module AllureRspec
     # 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
+      parents = parent_groups
 
       labels = []
       labels << Allure::ResultUtils.suite_label(suite(parents))
@@ -25,10 +23,23 @@ module AllureRspec
       labels
     end
 
+    # Get title path from outermost group to innermost group.
+    # @return [Array<String>]
+    def title_path
+      parent_groups.reverse
+    end
+
     private
 
     attr_reader :example_group
 
+    # @return [Array<String>]
+    def parent_groups
+      @parent_groups ||= example_group.parent_groups.map do |group|
+        group.description.empty? ? "Anonymous" : group.description
+      end
+    end
+
     # @param [Array<String>] parents
     # @return [String]
     def suite(parents)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.32.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.28.0
+        version: 2.32.0
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-description: Cucumber adaptor to generate rich allure test reports
+description: Cucumber adapter to generate rich allure test reports
 email: andrejs.cunskis@gmail.com
 executables: []
 extensions: []
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.20
 specification_version: 4
-summary: Allure rspec ruby adaptor
+summary: Allure rspec ruby adapter
 test_files: []