allure-ruby-commons 2.14.1 → 2.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4763123daad55aca4e73e90914720d86b9ec9fb5a2a91271877c97b0a245abc7
-  data.tar.gz: a76d41cd5733f89ba75760dc1b89d365b19fa0eaaa71d0d4162ee72707434f26
+  metadata.gz: 35b9aec57c1f8d285f55f1463266c70daec925400f3880ddf6cacd2b237eb120
+  data.tar.gz: 5fe9f0fcef4d39ed38cec526856712948f77c72529e13fe342e507ffcdf2ad2b
 SHA512:
-  metadata.gz: ecc05f47fc2cb41dfba2bd905dc2089468077e223972be839f8b450ff197f2e370c3378f13f0109c06238903bf4e87c7dcecf446088d1b2cec6b3a92a9136ee8
-  data.tar.gz: 771590de5ea1f9a35df2427be4f12ddc4579bdaf66ba373cd70c3deaaa54990934c47f04329b7e2a0c96c1f8ef2333e4b4fabbfe0ee70d3e2229978f16dfaad6
+  metadata.gz: b0d038d11530965ea7cc37135496fe4e0071a8fb8f975d9bad3be724e5c04b9b88ae6027a2cd6a2ed227e499742e2ec35cb63e87062bbcec0696b6def3609ed8
+  data.tar.gz: 7a9dca1b51f2d0948aec73ef6749a289a8ef6be9831dcca3ba80292defedb42c58ad47e2cfce8b810bf2845ea0e02963bb5b9135bb29b422e9b854b9385b5dab

data/README.md

@@ -29,6 +29,14 @@ Following configuration options are supported:
       # 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
 ```
 
@@ -38,9 +46,9 @@ Getting the configuration object:
 Allure.configuration
 ```
 
-### Allure environment
+### Allure execution environment
 
-It is possible to set up custom allure environment which will be used to prefix test case names. 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:
+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

data/lib/allure-ruby-commons.rb

@@ -161,14 +161,18 @@ module Allure
     lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
   end
 
-  # Add allure report environment info
+  # 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
 
-  # Add categories info
+  # 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)

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -21,7 +21,7 @@ module Allure
 
     attr_reader :config
 
-    def_delegators :file_writer, :write_attachment, :write_environment, :write_categories
+    def_delegators :file_writer, :write_attachment
 
     # Start test result container
     # @param [Allure::TestResultContainer] test_result_container
@@ -221,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]

data/lib/allure_ruby_commons/config.rb

@@ -17,7 +17,9 @@ module Allure
                   :logging_level,
                   :link_tms_pattern,
                   :link_issue_pattern,
-                  :clean_results_directory
+                  :clean_results_directory,
+                  :environment_properties,
+                  :categories
 
     def initialize
       @results_directory = "reports/allure-results"

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.1
+  version: 2.14.5
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -144,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