allure-ruby-commons 2.13.9 → 2.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00eb4480e678a3ec0c1f8d8e0b0885481f5be98bd0c0f4894a3665135769a7e6
-  data.tar.gz: 1763a8e08847c62bf347600cb0d2f77cd8ff324d8a90771e5ba6011b321421ff
+  metadata.gz: 167b883e345ddf9b55cf96986f203371ea865bc470212f578e906989d10d3ea0
+  data.tar.gz: a7568ffb62caa98ac0e74c836630493b5ae228d2e4ff7ed7707be0862b4b012b
 SHA512:
-  metadata.gz: fd6b37bea5da7b710428231f83efeff7d9bbaf7f17fbfd2575446f43a4db2237fad3fea012b585b4648007dcfa7120012e09e918b8d1457ad29ca63e2aac0bcb
-  data.tar.gz: a9b335d4a796fcfade19f86272a3e9538fb9e5b0531fc8651a28b316b9e6ff4b2f1d9c535360ff065da2655869343950c5128a141cb69ed047d6413a8f315b11
+  metadata.gz: 974f8f097b193e9abfa0f17c1dadbcf4592f87734512a579540389982e5c05d3ef9bc68b22f5971c479a3279044195b46cce3b20ad010275b900d5a5c7919ae9
+  data.tar.gz: 36ffc3d9a9c9dfdc4ba4f03699fdb49d74e2db4f076404c698170dd0d95384876930c3150a39fe5381b7ea6d82dc692d9d451199194d4d808ef6084a97d76f55

data/README.md

@@ -20,12 +20,23 @@ Following configuration options are supported:
 
 ```ruby
     Allure.configure do |config|
-      config.results_directory = "/whatever/you/like"
+      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
 ```
 
@@ -35,6 +46,13 @@ Getting the configuration object:
 Allure.configuration
 ```
 
+### Allure execution environment
+
+It is possible to set up custom allure environment which will be used as custom parameter `environment` in every test case. This is useful if you run same tests on different environments and generate single report. This way different runs are not put as retry. Environment can be configured in following ways:
+
+* via `ALLURE_ENVIRONMENT` environment variable
+* via `configure` method
+
 ### Log level
 
 Log level can be also configured via environment variable `ALLURE_LOG_LEVEL` which accepts one of the following values: `DEBUG INFO WARN ERROR FATAL UNKNOWN`.

data/lib/allure-ruby-commons.rb

@@ -8,186 +8,204 @@ require_rel "allure_ruby_commons/**/*rb"
 
 # Namespace for classes that handle allure report generation and different framework adaptors
 module Allure
-  class << self
-    # Get thread specific allure lifecycle object
-    # @return [AllureLifecycle]
-    def lifecycle
-      Thread.current[:lifecycle] ||= AllureLifecycle.new
-    end
+  # Set lifecycle object
+  # @param [AllureLifecycle] lifecycle
+  # @return [void]
+  def self.lifecycle=(lifecycle)
+    Thread.current[:lifecycle] = lifecycle
+  end
 
-    # Set lifecycle object
-    # @param [AllureLifecycle] lifecycle
-    # @return [void]
-    def lifecycle=(lifecycle)
-      Thread.current[:lifecycle] = lifecycle
-    end
+  extend self # rubocop:disable Style/ModuleFunction
 
-    # Get allure configuration
-    # @return [Config]
-    def configuration
-      Config.instance
-    end
+  # Get thread specific allure lifecycle object
+  # @return [AllureLifecycle]
+  def lifecycle
+    Thread.current[:lifecycle] ||= AllureLifecycle.new
+  end
 
-    # Set allure configuration
-    # @yieldparam [Config]
-    # @yieldreturn [void]
-    # @return [void]
-    def configure
-      yield(configuration)
-    end
+  # Get allure configuration
+  # @return [Config]
+  def configuration
+    Config.instance
+  end
 
-    # Add epic to current test case
-    # @param [String] value
-    # @return [void]
-    def epic(value)
-      label(ResultUtils::EPIC_LABEL_NAME, value)
-    end
+  # Set allure configuration
+  # @yieldparam [Config]
+  # @yieldreturn [void]
+  # @return [void]
+  def configure
+    yield(configuration)
+  end
 
-    # Add feature to current test case
-    # @param [String] value
-    # @return [void]
-    def feature(value)
-      label(ResultUtils::FEATURE_LABEL_NAME, value)
-    end
+  # Add epic to current test case
+  # @param [String] value
+  # @return [void]
+  def epic(value)
+    replace_label(ResultUtils::EPIC_LABEL_NAME, value)
+  end
 
-    # Add story to current test case
-    # @param [String] value
-    # @return [void]
-    def story(value)
-      label(ResultUtils::STORY_LABEL_NAME, value)
-    end
+  # Add feature to current test case
+  # @param [String] value
+  # @return [void]
+  def feature(value)
+    replace_label(ResultUtils::FEATURE_LABEL_NAME, value)
+  end
 
-    # Add suite to current test case
-    # @param [String] value
-    # @return [void]
-    def suite(value)
-      label(ResultUtils::SUITE_LABEL_NAME, value)
-    end
+  # Add story to current test case
+  # @param [String] value
+  # @return [void]
+  def story(value)
+    replace_label(ResultUtils::STORY_LABEL_NAME, value)
+  end
 
-    # Add tag to current test case
-    # @param [String] value
-    # @return [void]
-    def tag(value)
-      label(ResultUtils::TAG_LABEL_NAME, value)
-    end
+  # Add suite to current test case
+  # @param [String] value
+  # @return [void]
+  def suite(value)
+    replace_label(ResultUtils::SUITE_LABEL_NAME, value)
+  end
 
-    # Add label to current test case
-    # @param [String] name
-    # @param [String] value
-    # @return [void]
-    def label(name, value)
-      lifecycle.update_test_case do |test_case|
-        test_case.labels.push(Label.new(name, value))
-      end
-    end
+  # Add tag to current test case
+  # @param [String] value
+  # @return [void]
+  def tag(value)
+    label(ResultUtils::TAG_LABEL_NAME, value)
+  end
 
-    # Add description to current test case
-    # @param [String] description
-    # @return [void]
-    def add_description(description)
-      lifecycle.update_test_case do |test_case|
-        test_case.description = description
-      end
+  # Add label to current test case
+  # @param [String] name
+  # @param [String] value
+  # @return [void]
+  def label(name, value)
+    lifecycle.update_test_case do |test_case|
+      test_case.labels.push(Label.new(name, value))
     end
+  end
 
-    # Add html description to current test case
-    # @param [String] description_html
-    # @return [void]
-    def description_html(description_html)
-      lifecycle.update_test_case do |test_case|
-        test_case.description_html = description_html
-      end
-    end
+  # Replace label in current test case
+  #
+  # @param [String] name
+  # @param [String] value
+  # @return [void]
+  def replace_label(name, value)
+    lifecycle.update_test_case do |test_case|
+      present = test_case.labels.detect { |l| l.name == name }
+      return label(name, value) unless present
 
-    # Add parameter to current test case
-    # @param [String] name
-    # @param [String] value
-    # @return [void]
-    def parameter(name, value)
-      lifecycle.update_test_case do |test_case|
-        test_case.parameters.push(Parameter.new(name, value))
-      end
+      test_case.labels.map! { |l| l.name == name ? Label.new(name, value) : l }
     end
+  end
 
-    # Add tms link to current test case
-    # @param [String] name
-    # @param [String] url
-    # @return [void]
-    def tms(name, url)
-      add_link(name: name, url: url, type: ResultUtils::TMS_LINK_TYPE)
+  # Add description to current test case
+  # @param [String] description
+  # @return [void]
+  def add_description(description)
+    lifecycle.update_test_case do |test_case|
+      test_case.description = description
     end
+  end
 
-    # Add issue linkt to current test case
-    # @param [String] name
-    # @param [String] url
-    # @return [void]
-    def issue(name, url)
-      add_link(name: name, url: url, type: ResultUtils::ISSUE_LINK_TYPE)
+  # Add html description to current test case
+  # @param [String] description_html
+  # @return [void]
+  def description_html(description_html)
+    lifecycle.update_test_case do |test_case|
+      test_case.description_html = description_html
     end
+  end
 
-    # Add link to current test case
-    # @param [String ] url
-    # @param [String] name
-    # @param [String] type type of the link used to display link icon
-    # @return [void]
-    def add_link(url:, name: nil, type: "custom")
-      lifecycle.update_test_case do |test_case|
-        test_case.links.push(Link.new(type, name || url, url))
-      end
+  # Add parameter to current test case
+  # @param [String] name
+  # @param [String] value
+  # @return [void]
+  def parameter(name, value)
+    lifecycle.update_test_case do |test_case|
+      test_case.parameters.push(Parameter.new(name, value))
     end
+  end
 
-    # Add attachment to current test case or step
-    # @param [String] name Attachment name
-    # @param [File, String] source File or string to save as attachment
-    # @param [String] type attachment type defined in {ContentType} or any other valid mime type
-    # @param [Boolean] test_case add attachment to current test case instead of test step
-    # @return [void]
-    def add_attachment(name:, source:, type:, test_case: false)
-      lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
-    end
+  # Add tms link to current test case
+  # @param [String] name
+  # @param [String] url
+  # @return [void]
+  def tms(name, url)
+    add_link(name: name, url: url, type: ResultUtils::TMS_LINK_TYPE)
+  end
 
-    # Add allure report environment info
-    # @param [Hash<Symbol, String>] environment
-    # @return [void]
-    def add_environment(environment)
-      lifecycle.write_environment(environment)
-    end
+  # Add issue linkt to current test case
+  # @param [String] name
+  # @param [String] url
+  # @return [void]
+  def issue(name, url)
+    add_link(name: name, url: url, type: ResultUtils::ISSUE_LINK_TYPE)
+  end
 
-    # Add categories info
-    # @param [File, Array<Category>] categories
-    # @return [void]
-    def add_categories(categories)
-      lifecycle.write_categories(categories)
+  # Add link to current test case
+  # @param [String ] url
+  # @param [String] name
+  # @param [String] type type of the link used to display link icon
+  # @return [void]
+  def add_link(url:, name: nil, type: "custom")
+    lifecycle.update_test_case do |test_case|
+      test_case.links.push(Link.new(type, name || url, url))
     end
+  end
 
-    # Add step with provided name and optional status to current test step, fixture or test case
-    # @param [String] name
-    # @param [Symbol] status {Status}, {Status::PASSED} by default
-    # @return [void]
-    def step(name:, status: nil)
-      lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))
-      lifecycle.stop_test_step
-    end
+  # Add attachment to current test case or step
+  # @param [String] name Attachment name
+  # @param [File, String] source File or string to save as attachment
+  # @param [String] type attachment type defined in {ContentType} or any other valid mime type
+  # @param [Boolean] test_case add attachment to current test case instead of test step
+  # @return [void]
+  def add_attachment(name:, source:, type:, test_case: false)
+    lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
+  end
 
-    # Run passed block as step with given name and return result of yield
-    # @param [String] name
-    # @yield [] step block
-    # @return [Object]
-    def run_step(name)
-      lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
-      result = yield
-      lifecycle.update_test_step { |step| step.status = Status::PASSED }
-
-      result
-    rescue StandardError => e
-      lifecycle.update_test_step do |step|
-        step.status = ResultUtils.status(e)
-        step.status_details = ResultUtils.status_details(e)
-      end
-      raise(e)
-    ensure
-      lifecycle.stop_test_step
-    end
+  # Manually create environment.properties file
+  #   if this method is called before test run started and
+  #   option clean_results_directory is enabled, the file will be deleted
+  # @param [Hash<Symbol, String>] environment
+  # @return [void]
+  def add_environment(environment)
+    lifecycle.write_environment(environment)
+  end
+
+  # Manually create categories.json file
+  #   if this method is called before test run started and
+  #   option clean_results_directory is enabled, the file will be deleted
+  # @param [File, Array<Category>] categories
+  # @return [void]
+  def add_categories(categories)
+    lifecycle.write_categories(categories)
+  end
+
+  # Add step with provided name and optional status to current test step, fixture or test case
+  # @param [String] name
+  # @param [Symbol] status {Status}, {Status::PASSED} by default
+  # @return [void]
+  def step(name:, status: nil)
+    lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))
+    lifecycle.stop_test_step
+  end
+
+  # Run passed block as step with given name and return result of yield
+  # @param [String] name
+  # @yield [] step block
+  # @return [Object]
+  def run_step(name)
+    lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
+    result = yield
+    lifecycle.update_test_step { |step| step.status = Status::PASSED }
+
+    result
+  rescue StandardError => e
+    lifecycle.update_test_step do |step|
+      step.status = ResultUtils.status(e)
+      step.status_details = ResultUtils.status_details(e)
+    end
+    raise(e)
+  ensure
+    lifecycle.stop_test_step
   end
 end
 # rubocop:enable Naming/FileName

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -8,14 +8,20 @@ module Allure
   class AllureLifecycle # rubocop:disable Metrics/ClassLength
     extend Forwardable
 
-    def initialize
+    # Allure lifecycle instance
+    #
+    # @param [Allure::Config] configuration
+    def initialize(config = Config.instance)
       @test_context = []
       @step_context = []
-      @logger = Logger.new($stdout, level: Config.instance.logging_level)
-      @file_writer = FileWriter.new
+      @config = config
+      @logger = config.logger
+      @file_writer = FileWriter.new(config.results_directory)
     end
 
-    def_delegators :file_writer, :write_attachment, :write_environment, :write_categories
+    attr_reader :config
+
+    def_delegators :file_writer, :write_attachment
 
     # Start test result container
     # @param [Allure::TestResultContainer] test_result_container
@@ -215,6 +221,26 @@ module Allure
       write_attachment(source, attachment)
     end
 
+    # Add environment.properties file
+    #
+    # @param [Hash] env
+    # @return [void]
+    def write_environment(env = config.environment_properties)
+      return unless env
+
+      file_writer.write_environment(env)
+    end
+
+    # Add categories.json
+    #
+    # @param [File, Array<Category>] categories
+    # @return [void]
+    def write_categories(categories = config.categories)
+      return unless categories
+
+      file_writer.write_categories(categories)
+    end
+
     # Add step to current fixture|step|test case
     # @param [Allure::StepResult] step_result
     # @return [Allure::StepResult]
@@ -227,14 +253,12 @@ module Allure
     # Clean results directory
     # @return [void]
     def clean_results_dir
-      Allure.configuration.tap do |c|
-        FileUtils.rm_f(Dir.glob("#{c.results_directory}/**/*")) if c.clean_results_directory
-      end
+      FileUtils.rm_f(Dir.glob("#{config.results_directory}/**/*")) if config.clean_results_directory
     end
 
     private
 
-    attr_accessor :logger, :file_writer
+    attr_reader :logger, :file_writer
 
     def current_executable
       current_test_step || @current_fixture || @current_test_case

data/lib/allure_ruby_commons/config.rb

@@ -10,39 +10,36 @@ module Allure
 
     # @return [Array<String>] valid log levels
     LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
-    # @return [String] test plan path env var name
-    TESTPLAN_PATH = "ALLURE_TESTPLAN_PATH"
 
-    attr_accessor :results_directory, :logging_level, :link_tms_pattern, :link_issue_pattern, :clean_results_directory
+    attr_writer :environment, :logger
+
+    attr_accessor :results_directory,
+                  :logging_level,
+                  :link_tms_pattern,
+                  :link_issue_pattern,
+                  :clean_results_directory,
+                  :environment_properties,
+                  :categories
 
     def initialize
       @results_directory = "reports/allure-results"
       @logging_level = LOGLEVELS.index(ENV.fetch("ALLURE_LOG_LEVEL", "INFO")) || Logger::INFO
     end
 
-    # Allure id's of executable tests
+    # Allure environment
     #
-    # @return [Array]
-    def test_ids
-      @test_ids ||= tests&.map { |test| test[:id] }
-    end
+    # @return [String]
+    def environment
+      return(@environment) if defined?(@environment)
 
-    # Test names of executable tests
-    #
-    # @return [Array]
-    def test_names
-      @test_names ||= tests&.map { |test| test[:selector] }
+      @environment ||= ENV["ALLURE_ENVIRONMENT"]
     end
 
-    private
-
-    # Tests to execute from allure testplan.json
+    # Logger instance
     #
-    # @return [Array<Hash>]
-    def tests
-      @tests ||= Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
-    rescue Oj::ParseError
-      nil
+    # @return [Logger]
+    def logger
+      @logger ||= Logger.new($stdout, level: logging_level)
     end
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -14,6 +14,13 @@ module Allure
     # @return [String] categories definition json
     CATEGORIES_FILE = "categories.json"
 
+    # File writer instance
+    #
+    # @param [String] results_directory
+    def initialize(results_directory)
+      @results_directory = results_directory
+    end
+
     # Write test result
     # @param [Allure::TestResult] test_result
     # @return [void]
@@ -58,8 +65,10 @@ module Allure
 
     private
 
+    attr_reader :results_directory
+
     def output_dir
-      @output_dir ||= FileUtils.mkpath(Config.instance.results_directory).first
+      @output_dir ||= FileUtils.mkpath(results_directory).first
     end
 
     def write(name, source)

data/lib/allure_ruby_commons/model/executable_item.rb

@@ -24,12 +24,17 @@ module Allure
       @stage = options[:stage] || Stage::SCHEDULED
       @steps = options[:steps] || []
       @attachments = options[:attachments] || []
-      @parameters = options[:parameters] || []
     end
 
-    attr_accessor(
-      :name, :status, :status_details, :stage, :description, :description_html,
-      :steps, :attachments, :parameters, :start, :stop
-    )
+    attr_accessor :name,
+                  :status,
+                  :status_details,
+                  :stage,
+                  :description,
+                  :description_html,
+                  :steps,
+                  :attachments,
+                  :start,
+                  :stop
   end
 end

data/lib/allure_ruby_commons/model/test_result.rb

@@ -5,6 +5,7 @@ module Allure
   class TestResult < ExecutableItem
     # @param [String] uuid
     # @param [String] history_id
+    # @param [String] environment
     # @param [Hash] options
     # @option options [String] :name
     # @option options [String] :full_name
@@ -18,15 +19,36 @@ module Allure
     # @option options [Array<Allure::Link>] :links ([])
     # @option options [Array<Allure::Attachment>] :attachments ([])
     # @option options [Array<Allure::Parameter>] :parameters ([])
-    def initialize(uuid: UUID.generate, history_id: UUID.generate, **options)
+    def initialize(uuid: UUID.generate, history_id: UUID.generate, environment: nil, **options)
       super
+
+      @name = options[:name]
       @uuid = uuid
-      @history_id = history_id
+      @history_id = Digest::MD5.hexdigest("#{history_id}#{environment}")
       @full_name = options[:full_name] || "Unnamed"
       @labels = options[:labels] || []
       @links = options[:links] || []
+      @parameters = updated_parameters(options[:parameters] || [], environment)
     end
 
-    attr_accessor :uuid, :history_id, :full_name, :labels, :links
+    attr_accessor :uuid,
+                  :history_id,
+                  :full_name,
+                  :labels,
+                  :links,
+                  :parameters
+
+    private
+
+    # Test name prefixed with allure environment
+    #
+    # @param [Array] parameters
+    # @param [String] environment
+    # @return [Array]
+    def updated_parameters(parameters, environment)
+      return parameters unless environment
+
+      parameters << Parameter.new("environment", environment)
+    end
   end
 end

data/lib/allure_ruby_commons/result_utils.rb

@@ -131,16 +131,18 @@ module Allure
 
       # TMS link
       # @param [String] value
+      # @param [String] link_pattern
       # @return [Allure::Link]
-      def tms_link(value)
-        Link.new(TMS_LINK_TYPE, value, tms_url(value))
+      def tms_link(value, link_pattern)
+        Link.new(TMS_LINK_TYPE, value, url(value, link_pattern))
       end
 
       # Issue link
       # @param [String] value
+      # @param [String] link_pattern
       # @return [Allure::Link]
-      def issue_link(value)
-        Link.new(ISSUE_LINK_TYPE, value, issue_url(value))
+      def issue_link(value, link_pattern)
+        Link.new(ISSUE_LINK_TYPE, value, url(value, link_pattern))
       end
 
       # Get status based on exception type
@@ -169,12 +171,8 @@ module Allure
 
       private
 
-      def tms_url(value)
-        Allure.configuration.link_tms_pattern.sub("{}", value)
-      end
-
-      def issue_url(value)
-        Allure.configuration.link_issue_pattern.sub("{}", value)
+      def url(value, link_pattern)
+        link_pattern.sub("{}", value)
       end
     end
   end

data/lib/allure_ruby_commons/testplan.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Allure
+  class TestPlan
+    # @return [String] test plan path env var name
+    TESTPLAN_PATH = "ALLURE_TESTPLAN_PATH"
+
+    class << self
+      # Allure id's of executable tests
+      #
+      # @return [Array]
+      def test_ids
+        @test_ids ||= tests&.map { |test| test[:id] }
+      end
+
+      # Test names of executable tests
+      #
+      # @return [Array]
+      def test_names
+        @test_names ||= tests&.map { |test| test[:selector] }
+      end
+
+      private
+
+      # Tests to execute from allure testplan.json
+      #
+      # @return [Array<Hash>]
+      def tests
+        @tests ||= Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
+      rescue Oj::ParseError
+        nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 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: mime-types
@@ -119,6 +119,7 @@ files:
 - lib/allure_ruby_commons/model/test_result_container.rb
 - lib/allure_ruby_commons/result_utils.rb
 - lib/allure_ruby_commons/step_annotation.rb
+- lib/allure_ruby_commons/testplan.rb
 homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
@@ -143,7 +144,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: Common library for allure results generation