allure-rspec 2.13.9 → 2.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77fad060fb1fbcbbb4399244a58df51707defcfe9a2e7b5a5b193fb1a4940420
-  data.tar.gz: 73d4d50f964562c583158da41999dc8c8390f8b977cf3c532da7da50f8524835
+  metadata.gz: ebcd6e6c81d696779c9303a84b80d3264469f93618c9876f2fa9fc03be6d8637
+  data.tar.gz: bbe73782f89fe4819b2ba9612960da4de067a5c0762db71df8c77667ba00d8dd
 SHA512:
-  metadata.gz: 5344896aeb24c28fb6f424c2485f61e1f2656f5f0639bf25f981f88a50d432a3afa947e3b2f4f6967218c8896f9759de8f07f3aca880b6d22f9dbf46def8ca23
-  data.tar.gz: 3f3201b3da9e3997bdcc368a274b39830569612621d0af206457aa046a507f4185679674d419971f39697da9ecae6b79acd5e05eff1ebe02a38cdda5ddf7fed4
+  metadata.gz: 989e664938fbcbb496181c09e597d355b718349ba3ee114b88f3cee57f564f3302b06c5aa8e0862966110edca662b2f86da3ace00df08624ff22d6f64a2ed5c2
+  data.tar.gz: d3d7a4a7f547485edc79124172b69aa7e2eb815345bff4263048b0f6455625469686b5f6d52f20273c06f952a11c0176c5f46ef655dcf5cb43ba743369dca190

data/README.md

@@ -23,14 +23,25 @@ require "allure-rspec"
 Following configuration options are supported:
 
 ```ruby
-    AllureRspec.configure do |config|
-      config.results_directory = "/whatever/you/like"
-      config.clean_results_directory = true
-      config.logging_level = Logger::INFO
-      # 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/{}"
-    end
+AllureRspec.configure do |config|
+  config.results_directory = "report/allure-results"
+  config.clean_results_directory = true
+  config.logging_level = Logger::INFO
+  config.logger = Logger.new($stdout, Logger::DEBUG)
+  config.environment = "staging"
+
+  # 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/{}"
+  
+  # additional metadata
+  # environment.properties
+  config.environment_properties = {
+    custom_attribute: "foo"
+  }
+  # categories.json
+  config.categories = File.new("my_custom_categories.json")
+end
 ```
 
 ## Usage
@@ -53,11 +64,12 @@ end
 
 ### Adding tms links
 
-Configure tms link pattern:
+Configure tms link pattern and rspec tag:
 
 ```ruby
 AllureRspec.configure do |config|
   config.link_tms_pattern = "http://www.jira.com/browse/{}"
+  config.tms_tag = :tms
 end
 ```
 
@@ -84,6 +96,7 @@ Configure issue link pattern:
 ```ruby
 AllureRspec.configure do |config|
   config.link_issue_pattern = "http://www.jira.com/browse/{}"
+  config.issue_tag = :issue
 end
 ```
 
@@ -105,7 +118,15 @@ end
 
 ### Adding custom severity and status details
 
-Test severity (`normal` by default) can be changed via `severity` tag:
+Configure severity tag:
+
+```ruby
+AllureRspec.configure do |config|
+  config.severity_tag = :severity
+end
+```
+
+Test severity is set to `normal` by default:
 
 ```ruby
 it "some test case", severity: :critical do
@@ -131,9 +152,20 @@ it "some test case", allure_1: "visual_test", allure_2: "core_functionality" do
 end
 ```
 
+All rspec metadata tags will also be added as labels in test report.
+
 ### Behavior driven test grouping
 
-Marking tests with tags `:epic, :feature, :story`, will group tests accordingly in Behavior report tab:
+Marking tests with tags `:epic, :feature, :story`, will group tests accordingly in Behavior report tab.\
+Tag values can also be configured:
+
+```ruby
+AllureRspec.configure do |config|
+  config.epic_tag = :epic
+  config.feature_tag = :feature
+  config.story_tag = :story
+end
+```
 
 ```ruby
 context "context", feature: "my feature"  do

data/lib/allure-rspec.rb

@@ -8,13 +8,13 @@ require_rel "allure_rspec/**/*.rb"
 module AllureRspec
   class << self
     # Get allure cucumber configuration
-    # @return [RspecConfig]
+    # @return [AllureRspec::RspecConfig]
     def configuration
       RspecConfig.instance
     end
 
     # Set allure configuration
-    # @yieldparam [RspecConfig]
+    # @yieldparam [AllureRspec::RspecConfig]
     # @yieldreturn [void]
     # @return [void]
     def configure

data/lib/allure_rspec/config.rb

@@ -1,14 +1,41 @@
 # frozen_string_literal: true
 
-require "forwardable"
 require "singleton"
 
 module AllureRspec
-  # Shorthand configuration class
-  class RspecConfig < Allure::Config
+  # Allure RSpec configuration class
+  #
+  # @!attribute results_directory
+  #   @return [String]
+  # @!attribute clean_results_directory
+  #   @return [Boolean]
+  # @!attribute link_issue_pattern
+  #   @return [String]
+  # @!attribute link_tms_pattern
+  #   @return [String]
+  # @!attribute logging_level
+  #   @return [Integer]
+  # @!attribute [r] logger
+  #   @return [Logger]
+  # @!attribute environment
+  #   @return [String]
+  class RspecConfig
     include Singleton
     extend Forwardable
 
+    # @return [Symbol] default tms tag
+    DEFAULT_TMS_TAG = :tms
+    # @return [Symbol] default issue tag
+    DEFAULT_ISSUE_TAG = :issue
+    # @return [Symbol] default severity tag
+    DEFAULT_SEVERITY_TAG = :severity
+    # @return [Symbol] default epic tag
+    DEFAULT_EPIC_TAG = :epic
+    # @return [Symbol] default feature tag
+    DEFAULT_FEATURE_TAG = :feature
+    # @return [Symbol] default story tag
+    DEFAULT_STORY_TAG = :story
+
     def_delegators :@allure_config,
                    :clean_results_directory,
                    :clean_results_directory=,
@@ -18,13 +45,56 @@ module AllureRspec
                    :link_tms_pattern=,
                    :logging_level,
                    :logging_level=,
+                   :logger,
+                   :logger=,
                    :results_directory,
-                   :results_directory=
+                   :results_directory=,
+                   :environment,
+                   :environment=,
+                   :environment_properties,
+                   :environment_properties=,
+                   :categories,
+                   :categories=
 
     def initialize
-      super()
-
       @allure_config = Allure.configuration
     end
+
+    attr_writer :tms_tag,
+                :issue_tag,
+                :severity_tag,
+                :epic_tag,
+                :feature_tag,
+                :story_tag
+
+    # @return [Symbol]
+    def tms_tag
+      @tms_prefix || DEFAULT_TMS_TAG
+    end
+
+    # @return [Symbol]
+    def issue_tag
+      @issue_prefix || DEFAULT_ISSUE_TAG
+    end
+
+    # @return [Symbol]
+    def severity_tag
+      @severity_prefix || DEFAULT_SEVERITY_TAG
+    end
+
+    # @return [Symbol]
+    def epic_tag
+      @epic_prefix || DEFAULT_EPIC_TAG
+    end
+
+    # @return [Symbol]
+    def feature_tag
+      @feature_prefix || DEFAULT_FEATURE_TAG
+    end
+
+    # @return [Symbol]
+    def story_tag
+      @story_prefix || DEFAULT_STORY_TAG
+    end
   end
 end

data/lib/allure_rspec/formatter.rb

@@ -1,16 +1,20 @@
 # frozen_string_literal: true
 
-require "ruby2_keywords"
 require "rspec/core"
 require "rspec/core/formatters/base_formatter"
 
-require_relative "rspec_model"
-
 # Main allure-rspec module
 module AllureRspec
   # Main rspec formatter class translating rspec events to allure lifecycle
   class RSpecFormatter < RSpec::Core::Formatters::BaseFormatter
-    include AllureRspecModel
+    include Utils
+
+    # @return [Hash] allure statuses mapping
+    ALLURE_STATUS = {
+      failed: Allure::Status::FAILED,
+      pending: Allure::Status::SKIPPED,
+      passed: Allure::Status::PASSED
+    }.freeze
 
     RSpec::Core::Formatters.register(
       self,
@@ -21,20 +25,19 @@ module AllureRspec
       :example_finished
     )
 
-    RSpec::Core::Example.class_eval do
-      Allure.singleton_methods.each do |method|
-        ruby2_keywords define_method(method) { |*args, &block| Allure.__send__(method, *args, &block) }
-      end
+    RSpec.configure do |config|
+      ids = Allure::TestPlan.test_ids
+      names = Allure::TestPlan.test_names
+
+      config.filter_run_when_matching(*ids.map { |id| { allure_id: id } }) if ids
+      config.full_description = names if names
     end
 
-    RSpec.configure do |config|
-      Allure.configure do |allure_config|
-        ids = allure_config.test_ids
-        names = allure_config.test_names
+    def initialize(output)
+      super
 
-        config.filter_run_when_matching(*ids.map { |id| { allure_id: id } }) if ids
-        config.full_description = names if names
-      end
+      @allure_config = AllureRspec.configuration
+      Allure.lifecycle = @lifecycle = Allure::AllureLifecycle.new(@allure_config)
     end
 
     # Start test run
@@ -42,6 +45,12 @@ module AllureRspec
     # @return [void]
     def start(_start_notification)
       lifecycle.clean_results_dir
+      lifecycle.write_environment
+      lifecycle.write_categories
+
+      RSpec::Core::Example.class_eval do
+        include Allure
+      end
     end
 
     # Starts example group
@@ -78,10 +87,48 @@ module AllureRspec
 
     private
 
-    # Get thread specific lifecycle
-    # @return [Allure::AllureLifecycle]
-    def lifecycle
-      Allure.lifecycle
+    attr_reader :lifecycle, :allure_config
+
+    # Transform example to <Allure::TestResult>
+    # @param [RSpec::Core::Example] example
+    # @return [Allure::TestResult]
+    def test_result(example)
+      parser = RspecMetadataParser.new(example, allure_config)
+
+      Allure::TestResult.new(
+        name: example.description,
+        description: "Location - #{strip_relative(example.location)}",
+        description_html: "Location - #{strip_relative(example.location)}",
+        history_id: example.id,
+        full_name: example.full_description,
+        labels: parser.labels,
+        links: parser.links,
+        status_details: parser.status_details,
+        environment: allure_config.environment
+      )
+    end
+
+    # Update test status on finish
+    # @param [RSpec::Core::Example::ExecutionResult] result
+    # @return [Proc]
+    def update_test_proc(result)
+      Allure::ResultUtils.status_details(result.exception).yield_self do |status_detail|
+        proc do |test_case|
+          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
+        end
+      end
+    end
+
+    # Get allure status from result
+    # @param [RSpec::Core::Example::ExecutionResult] result
+    # @return [Symbol]
+    def status(result)
+      return Allure::ResultUtils.status(result.exception) if result.status == :failed
+
+      ALLURE_STATUS[result.status]
     end
   end
 end

data/lib/allure_rspec/metadata_parser.rb

@@ -1,53 +1,6 @@
 # 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
@@ -75,8 +28,13 @@ module AllureRspec
       type
     ].freeze
 
-    def initialize(example)
+    # Metadata parser instance
+    #
+    # @param [RSpec::Core::Example] example
+    # @param [AllureRspec::RspecConfig] config <description>
+    def initialize(example, config)
       @example = example
+      @config = config
     end
 
     # Get allure labels
@@ -111,9 +69,12 @@ module AllureRspec
 
     private
 
-    # @param [RSpec::Core::Example] example
+    # @return [RSpec::Core::Example]
     attr_reader :example
 
+    # @return [AllureRspec::RspecConfig]
+    attr_reader :config
+
     # Example metadata
     #
     # @return [Hash]
@@ -143,7 +104,7 @@ module AllureRspec
     # Get severity
     # @return [String]
     def severity
-      Allure::ResultUtils.severity_label(metadata[:severity] || "normal")
+      Allure::ResultUtils.severity_label(metadata[config.severity_tag] || "normal")
     end
 
     # Get test suite labels
@@ -164,9 +125,9 @@ module AllureRspec
     # @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]
+      epic = metadata[config.epic_tag] || Pathname.new(strip_relative(example.file_path)).parent.to_s
+      feature = metadata[config.feature_tag] || example.example_group.description
+      story = metadata[config.story_tag]
 
       [
         Allure::ResultUtils.epic_label(epic),
@@ -179,11 +140,12 @@ module AllureRspec
     # @param [Symbol] type
     # @return [Array<Allure::Link>]
     def matching_links(type)
-      return [] unless AllureRspec.configuration.public_send("link_#{type}_pattern")
+      link_pattern = config.public_send("link_#{type}_pattern")
+      return [] unless link_pattern
 
       metadata
         .select { |k| __send__("#{type}?", k) }.values
-        .map { |v| Allure::ResultUtils.public_send("#{type}_link", v) }
+        .map { |v| Allure::ResultUtils.public_send("#{type}_link", v, link_pattern) }
     end
 
     # Special allure metadata tags
@@ -191,7 +153,12 @@ module AllureRspec
     # @param [Symbol] key
     # @return [boolean]
     def special_metadata_tag?(key)
-      tms?(key) || issue?(key) || %i[severity epic feature story].include?(key)
+      tms?(key) || issue?(key) || [
+        config.severity_tag,
+        config.epic_tag,
+        config.feature_tag,
+        config.story_tag
+      ].include?(key)
     end
 
     # Does key match custom allure label
@@ -205,14 +172,14 @@ module AllureRspec
     # @param [Symbol] key
     # @return [boolean]
     def tms?(key)
-      key.to_s.match?(/tms(_\d+)?/i)
+      key.to_s.match?(/#{config.tms_tag}(_\d+)?/i)
     end
 
     # Does key match issue pattern
     # @param [Symbol] key
     # @return [boolean]
     def issue?(key)
-      key.to_s.match?(/issue(_\d+)?/i)
+      key.to_s.match?(/#{config.issue_tag}(_\d+)?/i)
     end
   end
 end

data/lib/allure_rspec/suite_labels.rb

@@ -0,0 +1,50 @@
+# 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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 version: !ruby/object:Gem::Version
-  version: 2.13.9
+  version: 2.14.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-15 00:00:00.000000000 Z
+date: 2021-07-14 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.9
+        version: 2.14.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.9
+        version: 2.14.2
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: ruby2_keywords
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.2
 description: Cucumber adaptor to generate rich allure test reports
 email: andrejs.cunskis@gmail.com
 executables: []
@@ -66,11 +52,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/allure-rspec.rb
-- lib/allure_rspec/01_utils.rb
+- lib/allure_rspec/_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/suite_labels.rb
 homepage: https://github.com/allure-framework/allure-ruby/tree/master/allure-rspec
 licenses:
 - Apache-2.0
@@ -95,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Allure rspec ruby adaptor

data/lib/allure_rspec/rspec_model.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require "digest"
-require "pathname"
-
-module AllureRspec
-  # Support class for transforming rspec test entities in to allure model entities
-  module AllureRspecModel
-    include AllureRspec::Utils
-
-    # @return [Hash] allure statuses mapping
-    ALLURE_STATUS = {
-      failed: Allure::Status::FAILED,
-      pending: Allure::Status::SKIPPED,
-      passed: Allure::Status::PASSED
-    }.freeze
-
-    # Transform example to <Allure::TestResult>
-    # @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: parser.labels,
-        links: parser.links,
-        status_details: parser.status_details
-      )
-    end
-
-    # Update test status on finish
-    # @param [RSpec::Core::Example::ExecutionResult] result
-    # @return [Proc]
-    def update_test_proc(result)
-      Allure::ResultUtils.status_details(result.exception).yield_self do |status_detail|
-        proc do |test_case|
-          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
-        end
-      end
-    end
-
-    private
-
-    # Get allure status from result
-    # @param [RSpec::Core::Example::ExecutionResult] result
-    # @return [Symbol]
-    def status(result)
-      return Allure::ResultUtils.status(result.exception) if result.status == :failed
-
-      ALLURE_STATUS[result.status]
-    end
-  end
-end