allure-ruby-commons 2.14.4 → 2.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0de1e98a75e290b8d066efde7d33692cd5debc19f447366e04f7a92485d98a
-  data.tar.gz: f23e6231dfff4143a1708d4eaa93595753ead503935cc5e59c50bcbc4361c2b4
+  metadata.gz: 6cf416a1b141ec4f00e39b29bcaed9b698b8d9a395a91766b85219223757528b
+  data.tar.gz: c6eb8f3e99d8751540623c3d55d05415d17df998ba1066aab5d59ed0a2737227
 SHA512:
-  metadata.gz: 171e1b60a3b68fce23f6147287f66b70a981b034cd4edba79c9da87284b7c7b1243936c4cbf34227973e0b6ad4213b10372db6293e5b176e3c5c9d1a83430376
-  data.tar.gz: d3c7c64d174b8fd53ca389dadb083efc52b75ec4e8413daa17e4e4ff8d82f9978f62a714d21adb08639292abaa8b5c40f027ea1db7a2cbba1eadcdfe52ac9e87
+  metadata.gz: 8edf4da0ff21aba5875d1ec318990b1806d6dc0153b71b84b6f1523874c4a68938cea9cb89931c94d61d77d4b72853075bc5649c46e4c580a25f56da478558db
+  data.tar.gz: 6ebb50bdd7de43c2d0e46e2c4d6886be2bbc10b0d8745da55554b88598bfdfa9aa50f981b1118f9a2a70db0cc8b7682e26c884e7b43efa6651b44143203d11fd

data/README.md

@@ -53,6 +53,22 @@ It is possible to set up custom allure environment which will be used as custom
 * via `ALLURE_ENVIRONMENT` environment variable
 * via `configure` method
 
+### Environment properties
+
+To add additional environment information to the report it is possible to set configuration property `environment_properties`.
+
+Option can be set to hash or block returning a hash:
+
+```ruby
+# hash
+config.environment_properties = {
+        custom_attribute: "foo"
+      }
+
+# lambda
+config.environment_properties = -> { { custom_attributes: "foo"} }
+```
+
 ### 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

@@ -164,7 +164,7 @@ module Allure
   # 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
+  # @param [Hash<Symbol, String>, Proc] environment
   # @return [void]
   def add_environment(environment)
     lifecycle.write_environment(environment)
@@ -179,6 +179,33 @@ module Allure
     lifecycle.write_categories(categories)
   end
 
+  # Set test case status detail to flaky
+  #
+  # @return [void]
+  def set_flaky
+    lifecycle.update_test_case do |test_case|
+      test_case.status_details.flaky = true
+    end
+  end
+
+  # Set test case status detail to muted
+  #
+  # @return [void]
+  def set_muted
+    lifecycle.update_test_case do |test_case|
+      test_case.status_details.muted = true
+    end
+  end
+
+  # Set test case status detail to known
+  #
+  # @return [void]
+  def set_known
+    lifecycle.update_test_case do |test_case|
+      test_case.status_details.known = true
+    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
@@ -207,5 +234,15 @@ module Allure
   ensure
     lifecycle.stop_test_step
   end
+
+  # Add parameter to current test step
+  # @param [String] name
+  # @param [String] value
+  # @return [void]
+  def step_parameter(name, value)
+    lifecycle.update_test_step do |step|
+      step.parameters.push(Parameter.new(name, value))
+    end
+  end
 end
 # rubocop:enable Naming/FileName

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -223,12 +223,13 @@ module Allure
 
     # Add environment.properties file
     #
-    # @param [Hash] env
+    # @param [Hash, Proc] env
     # @return [void]
     def write_environment(env = config.environment_properties)
       return unless env
 
-      file_writer.write_environment(env)
+      env_properties = env.respond_to?(:call) ? env.call : env
+      file_writer.write_environment(env_properties)
     end
 
     # Add categories.json

data/lib/allure_ruby_commons/file_writer.rb

@@ -73,7 +73,7 @@ module Allure
 
     def write(name, source)
       filename = File.join(output_dir, name)
-      File.open(filename, "w") { |file| file.write(source) }
+      File.write(filename, source)
     end
 
     def copy(from, to)

data/lib/allure_ruby_commons/model/executable_item.rb

@@ -24,6 +24,7 @@ module Allure
       @stage = options[:stage] || Stage::SCHEDULED
       @steps = options[:steps] || []
       @attachments = options[:attachments] || []
+      @parameters = options[:parameters] || []
     end
 
     attr_accessor :name,
@@ -34,6 +35,7 @@ module Allure
                   :description_html,
                   :steps,
                   :attachments,
+                  :parameters,
                   :start,
                   :stop
   end

data/lib/allure_ruby_commons/model/test_result.rb

@@ -28,27 +28,13 @@ module Allure
       @full_name = options[:full_name] || "Unnamed"
       @labels = options[:labels] || []
       @links = options[:links] || []
-      @parameters = updated_parameters(options[:parameters] || [], environment)
+      @parameters << Parameter.new("environment", environment) if environment
     end
 
     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
+                  :links
   end
 end

data/lib/allure_ruby_commons/result_utils.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "socket"
+require "uri"
 
 module Allure
   # Variouse helper methods
@@ -133,16 +134,18 @@ module Allure
       # @param [String] value
       # @param [String] link_pattern
       # @return [Allure::Link]
-      def tms_link(value, link_pattern)
-        Link.new(TMS_LINK_TYPE, value, url(value, link_pattern))
+      def tms_link(name, value, link_pattern)
+        link_name = url?(value) ? name : value
+        Link.new(TMS_LINK_TYPE, link_name, url(value, link_pattern))
       end
 
       # Issue link
       # @param [String] value
       # @param [String] link_pattern
       # @return [Allure::Link]
-      def issue_link(value, link_pattern)
-        Link.new(ISSUE_LINK_TYPE, value, url(value, link_pattern))
+      def issue_link(name, value, link_pattern)
+        link_name = url?(value) ? name : value
+        Link.new(ISSUE_LINK_TYPE, link_name, url(value, link_pattern))
       end
 
       # Get status based on exception type
@@ -171,6 +174,19 @@ module Allure
 
       private
 
+      # Check if value is full url
+      #
+      # @param [String] value
+      # @return [Boolean]
+      def url?(value)
+        URI.parse(value.to_s).scheme
+      end
+
+      # Construct url from pattern
+      #
+      # @param [String] value
+      # @param [String] link_pattern
+      # @return [String]
       def url(value, link_pattern)
         link_pattern.sub("{}", value)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.14.4
+  version: 2.16.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -129,6 +129,7 @@ metadata:
   documentation_uri: https://github.com/allure-framework/allure-ruby/blob/master/allure-ruby-commons/README.md
   source_code_uri: https://github.com/allure-framework/allure-ruby/tree/master/allure-ruby-commons
   wiki_uri: https://github.com/allure-framework/allure-ruby/wiki
+  rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Common library for allure results generation