allure-ruby-commons 2.29.1 → 2.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3c7cc28f5738388cce1d85afab6a9248c501a09a3bbe2a8a0469f0d23980d05
-  data.tar.gz: 7a883ae369f1aad7ece45aa735b911b12c4e0fd3c6a7c4beff289b1e25ad0da2
+  metadata.gz: 98dba29e4163a15ada4fb2d5097aee68764e97423f7bea00f0ed20b0810d7fd9
+  data.tar.gz: 7a6be418174a478614942fff81b7c305efa1b2f8074eb450c94ce8ec40869d07
 SHA512:
-  metadata.gz: 855f38ae5530bf583a2dc2aae3ed81c6091d83db3eb79f33c5559b75699e368521daebdeb40af7640bdb54f6b9e5ada3dc26142301c5c4953876b0c57f17413e
-  data.tar.gz: f44bbb71e3bb02a18e20729e7df33c64340df4e2bbe7c46430dd852003d51794a7ba6f37d376685e3275eb8125af5256e32b728270aa894ac9fe4aaed61df45a
+  metadata.gz: c012649c7bd0e48d24630c5f09c3cd58a39a0959ffaf31fc405bd4ba7d3bcde0f0b09eda97093eeb1f98caa24105e3cfa447b968ff2c933331f43c7d963a1b40
+  data.tar.gz: fbd9d29cc963268f5809fbb99b1c2e574fbde2760d6180b484a0a22fb47888075d809d818616cc31b33a92598a364b4ebb0fe7ff257cb58439da5aab524a3403

data/README.md

@@ -1,9 +1,9 @@
-# Allure Ruby Adaptor API
+# Allure Ruby adapter API
 
 [![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/allure-ruby-commons)
 
-This is a helper library containing the basics for any ruby-based Allure adaptor.
-Using it you can easily implement the adaptor for your favorite ruby testing library or
+This is a helper library containing the basics for any ruby-based Allure adapter.
+Using it you can easily implement the adapter for your favorite ruby testing library or
 you can just create the report of any other kind using the basic Allure terms.
 
 ## Setup
@@ -26,6 +26,12 @@ Following configuration options are supported:
       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/{}"
@@ -40,6 +46,9 @@ Following configuration options are supported:
     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.
+
 Getting the configuration object:
 
 ```ruby

data/lib/allure-ruby-commons.rb

@@ -7,7 +7,7 @@ require "securerandom"
 
 require_rel "allure_ruby_commons/**/*rb"
 
-# Namespace for classes that handle allure report generation and different framework adaptors
+# Namespace for classes that handle allure report generation and different framework adapters
 module Allure
   # Set lifecycle object
   # @param [AllureLifecycle] lifecycle

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -14,13 +14,14 @@ module Allure
     def initialize(config = Config.instance)
       @test_context = []
       @step_context = []
+      @globals = Globals.new
       @config = config
       @logger = config.logger
     end
 
     attr_reader :config
 
-    def_delegators :file_writer, :write_attachment, :write_globals
+    def_delegators :file_writer, :write_attachment
 
     # Start test result container
     # @param [Allure::TestResultContainer] test_result_container
@@ -102,6 +103,7 @@ module Allure
       logger.debug { "Stopping test case: #{@current_test_case.name}" }
       @current_test_case.stop = ResultUtils.timestamp
       @current_test_case.stage = Stage::FINISHED
+      @current_test_case.labels.unshift(*global_labels)
       file_writer.write_test_result(@current_test_case)
       clear_current_test_case
       clear_step_context
@@ -231,7 +233,7 @@ module Allure
 
       logger.debug { "Adding global attachment '#{name}'" }
       write_attachment(source, attachment)
-      write_globals(Globals.new(attachments: [attachment]))
+      @globals.add_attachment(attachment)
     end
 
     # Add run-level error
@@ -246,7 +248,7 @@ module Allure
       error = ResultUtils.prepare_global_error(timestamp: ResultUtils.timestamp, **details)
 
       logger.debug { "Adding global error '#{error.message}'" }
-      write_globals(Globals.new(errors: [error]))
+      @globals.add_error(error)
     end
 
     # Add environment.properties file
@@ -270,6 +272,12 @@ module Allure
       file_writer.write_categories(categories)
     end
 
+    # Write global errors and attachments
+    # @return [void]
+    def write_globals
+      file_writer.write_globals(@globals)
+    end
+
     # Add step to current fixture|step|test case
     # @param [Allure::StepResult] step_result
     # @return [Allure::StepResult]
@@ -289,6 +297,10 @@ module Allure
 
     attr_reader :logger
 
+    def global_labels
+      @global_labels ||= config.global_labels.map { |label| Label.new(label[:name], label[:value]) }
+    end
+
     def file_writer
       @file_writer ||= FileWriter.new(config.results_directory)
     end

data/lib/allure_ruby_commons/config.rb

@@ -20,10 +20,12 @@ module Allure
                   :link_issue_pattern,
                   :clean_results_directory,
                   :environment_properties,
-                  :categories
+                  :categories,
+                  :global_labels
 
     def initialize
       @results_directory = "reports/allure-results"
+      @global_labels = []
       @logging_level = LOGLEVELS.index(ENV.fetch("ALLURE_LOG_LEVEL", "INFO")) || Logger::INFO
     end
 

data/lib/allure_ruby_commons/file_writer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "tempfile"
+
 module Allure
   # Allure result file writer
   class FileWriter
@@ -83,12 +85,30 @@ module Allure
     end
 
     def write(name, source)
-      filename = File.join(output_dir, name)
-      File.write(filename, source)
+      atomic_write(name) { |temp_file| temp_file.write(source) }
     end
 
     def copy(from, to)
-      FileUtils.cp(from, File.join(output_dir, to))
+      atomic_write(to) { |temp_file| IO.copy_stream(from, temp_file) }
+    end
+
+    def atomic_write(name)
+      filename = File.join(output_dir, name)
+      target_mode = begin
+        File.stat(filename).mode
+      rescue Errno::ENOENT
+        0o644
+      end
+
+      Tempfile.create("#{name}.tmp", output_dir) do |temp_file|
+        temp_file.binmode
+
+        yield temp_file
+
+        temp_file.chmod(target_mode)
+        temp_file.close
+        File.rename(temp_file.path, filename)
+      end
     end
   end
 end

data/lib/allure_ruby_commons/model/globals.rb

@@ -13,5 +13,19 @@ module Allure
     end
 
     attr_accessor :attachments, :errors
+
+    # Add an error to the globals
+    # @param [Allure::GlobalError] error
+    # @return [void]
+    def add_error(error)
+      @errors.push(error)
+    end
+
+    # Add an attachment to the globals
+    # @param [Allure::GlobalAttachment] attachment
+    # @return [void]
+    def add_attachment(attachment)
+      @attachments.push(attachment)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.29.1
+  version: 2.30.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -121,7 +121,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: Common library for allure results generation
 test_files: []