allure-ruby-commons 2.28.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533f85dbee5b72bf9be4050285a6aff7e9fc5dfecd9554276baf60cda7f818dc
-  data.tar.gz: 245337c54947f7e8a324e22246b6c7b563e168a97e293af86bd0fae8ebb6434a
+  metadata.gz: 158481dc0f3a21a190859fa2ed209bc93dc94185393c9c6767a83481c01e1dac
+  data.tar.gz: 94f52c299af1494c6e6c372f562a196ba7c9000cb489f9b7effea335c2f8e9e7
 SHA512:
-  metadata.gz: 2a3f39061b901d5c9af4e191d8dd5e6fd2ec4f7fe057d8a404acc541de548b555cc6ab0dc38e2636ced1a44de28be64fedb7e0a1a9652271d41dac053c66fc25
-  data.tar.gz: f2e7f57499e365993a9e6a052a34910e24d387d8dc31a5ac85b26e0647097a3312f55ce4fcaaa73a639f672f045c77025bf45496d846ff01ddb035ee7d8e091b
+  metadata.gz: db735212d318744aa39642149273e407104a7cb3d881590fbf12cc478431053ede8eb9ff5e56e01560ade8bf9d585a953d188aa39a7bdb2453b89f00340e50b5
+  data.tar.gz: 3d80679f0439e64299f62948621db0931ddbc34125e59c47722d2891468ca4810c00f58df0422772857d0a9a13acbe8dd2bb72cadd70aa118a591ff2495b921a

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

@@ -2,11 +2,12 @@
 # frozen_string_literal: true
 
 require "require_all"
+require "digest"
 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
@@ -161,6 +162,27 @@ module Allure
     lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
   end
 
+  # Add run-level attachment not bound to a test or fixture
+  # @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
+  # @return [void]
+  def add_global_attachment(name:, source:, type:)
+    lifecycle.add_global_attachment(name: name, source: source, type: type)
+  end
+
+  # Add run-level error not bound to a test or fixture
+  # @param [Hash] details
+  # @option details [Boolean] :known
+  # @option details [Boolean] :muted
+  # @option details [Boolean] :flaky
+  # @option details [String] :message
+  # @option details [String] :trace
+  # @return [void]
+  def add_global_error(**details)
+    lifecycle.add_global_error(**details)
+  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

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -14,6 +14,7 @@ module Allure
     def initialize(config = Config.instance)
       @test_context = []
       @step_context = []
+      @globals = Globals.new
       @config = config
       @logger = config.logger
     end
@@ -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
@@ -220,6 +222,35 @@ module Allure
       write_attachment(source, attachment)
     end
 
+    # Add run-level attachment
+    # @param [String] name Attachment name
+    # @param [File, String] source File or string to save as attachment
+    # @param [String] type attachment type defined in {Allure::ContentType} or any other valid mime type
+    # @return [void]
+    def add_global_attachment(name:, source:, type:)
+      attachment = ResultUtils.prepare_global_attachment(name, type, timestamp: ResultUtils.timestamp)
+      return logger.error { "Can't add global attachment, unrecognized mime type: #{type}" } unless attachment
+
+      logger.debug { "Adding global attachment '#{name}'" }
+      write_attachment(source, attachment)
+      @globals.add_attachment(attachment)
+    end
+
+    # Add run-level error
+    # @param [Hash] details
+    # @option details [Boolean] :known
+    # @option details [Boolean] :muted
+    # @option details [Boolean] :flaky
+    # @option details [String] :message
+    # @option details [String] :trace
+    # @return [void]
+    def add_global_error(**details)
+      error = ResultUtils.prepare_global_error(timestamp: ResultUtils.timestamp, **details)
+
+      logger.debug { "Adding global error '#{error.message}'" }
+      @globals.add_error(error)
+    end
+
     # Add environment.properties file
     #
     # @param [Hash, Proc] env
@@ -241,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]
@@ -260,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
@@ -11,6 +13,8 @@ module Allure
     TEST_RESULT_CONTAINER_SUFFIX = "-container.json"
     # @return [String] attachment file suffix
     ATTACHMENT_FILE_SUFFIX = "-attachment"
+    # @return [String] globals chunk suffix
+    GLOBALS_SUFFIX = "-globals.json"
     # @return [String] environment info file
     ENVIRONMENT_FILE = "environment.properties"
     # @return [String] categories definition json
@@ -45,6 +49,13 @@ module Allure
       source.is_a?(File) ? copy(source.path, attachment.source) : write(attachment.source, source)
     end
 
+    # Write allure globals chunk
+    # @param [Allure::Globals] globals
+    # @return [void]
+    def write_globals(globals)
+      write("#{SecureRandom.uuid}#{GLOBALS_SUFFIX}", dump_json(globals))
+    end
+
     # Write allure report environment info
     # @param [Hash<Symbol, String>] environment
     # @return [void]
@@ -74,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/global_attachment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Allure
+  # Allure model global attachment object
+  class GlobalAttachment < Attachment
+    # @param [Number] timestamp
+    # @param [Hash] options
+    # @option options [String] :name attachment name
+    # @option options [String] :type attachment type, {Allure::ContentType}
+    # @option options [String] :source attachment file name
+    def initialize(timestamp:, **options)
+      super(**options)
+
+      @timestamp = timestamp
+    end
+
+    attr_accessor :timestamp
+  end
+end

data/lib/allure_ruby_commons/model/global_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "status_details"
+
+module Allure
+  # Allure model global error object
+  class GlobalError < StatusDetails
+    # @param [Number] timestamp
+    # @param [Hash] options
+    # @option options [Boolean] :known
+    # @option options [Boolean] :muted
+    # @option options [Boolean] :flaky
+    # @option options [String] :message
+    # @option options [String] :trace
+    def initialize(timestamp:, status: nil, **options)
+      super(**options)
+
+      @status = status
+      @timestamp = timestamp
+    end
+
+    attr_accessor :timestamp, :status
+  end
+end

data/lib/allure_ruby_commons/model/globals.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Allure
+  # Allure model run-level globals chunk
+  class Globals < JSONable
+    # @param [Array<Allure::GlobalAttachment>] attachments
+    # @param [Array<Allure::GlobalError>] errors
+    def initialize(attachments: [], errors: [])
+      super()
+
+      @attachments = attachments
+      @errors = errors
+    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

data/lib/allure_ruby_commons/model/test_result.rb

@@ -9,6 +9,7 @@ module Allure
     # @param [Hash] options
     # @option options [String] :name
     # @option options [String] :full_name
+    # @option options [Array<String>] :title_path
     # @option options [String] :description
     # @option options [String] :description_html
     # @option options [String] :status ('broken')
@@ -26,6 +27,7 @@ module Allure
       @uuid = uuid
       @history_id = history_id
       @full_name = options[:full_name] || "Unnamed"
+      @title_path = options[:title_path]
       @labels = options[:labels] || []
       @links = options[:links] || []
       @parameters << Parameter.new("environment", environment) if environment
@@ -33,6 +35,7 @@ module Allure
 
     attr_accessor :uuid,
                   :full_name,
+                  :title_path,
                   :labels,
                   :links
 

data/lib/allure_ruby_commons/result_utils.rb

@@ -157,9 +157,13 @@ module Allure
 
       # Get exception status detail
       # @param [Exception] exception
+      # @param [Hash] options
+      # @option options [Boolean] :known
+      # @option options [Boolean] :muted
+      # @option options [Boolean] :flaky
       # @return [Allure::StatusDetails]
-      def status_details(exception)
-        StatusDetails.new(message: exception&.message, trace: exception&.backtrace&.join("\n"))
+      def status_details(exception, **options)
+        StatusDetails.new(message: exception&.message, trace: exception&.backtrace&.join("\n"), **options)
       end
 
       # Allure attachment object
@@ -172,6 +176,38 @@ module Allure
         Attachment.new(name: name, source: file_name, type: type)
       end
 
+      # Allure global attachment object
+      # @param [String] name
+      # @param [String] type
+      # @param [Number] timestamp
+      # @return [Allure::GlobalAttachment]
+      def prepare_global_attachment(name, type, timestamp: self.timestamp)
+        attachment = prepare_attachment(name, type) || return
+
+        GlobalAttachment.new(
+          name: attachment.name,
+          source: attachment.source,
+          type: attachment.type,
+          timestamp: timestamp
+        )
+      end
+
+      # Allure global error object
+      # @param [Number] timestamp
+      # @param [StandardError] :exception
+      # @param [Hash] options
+      # @option options [Boolean] :known
+      # @option options [Boolean] :muted
+      # @option options [Boolean] :flaky
+      # @return [Allure::GlobalError]
+      def prepare_global_error(timestamp: self.timestamp, exception: nil, **options)
+        GlobalError.new(
+          timestamp: timestamp,
+          status: status(exception),
+          **status_details(exception, **options).to_hash.transform_keys(&:to_sym)
+        )
+      end
+
       private
 
       # Check if value is full url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.28.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -82,6 +82,9 @@ files:
 - lib/allure_ruby_commons/model/content_type.rb
 - lib/allure_ruby_commons/model/executable_item.rb
 - lib/allure_ruby_commons/model/fixture_result.rb
+- lib/allure_ruby_commons/model/global_attachment.rb
+- lib/allure_ruby_commons/model/global_error.rb
+- lib/allure_ruby_commons/model/globals.rb
 - lib/allure_ruby_commons/model/label.rb
 - lib/allure_ruby_commons/model/link.rb
 - lib/allure_ruby_commons/model/parameter.rb
@@ -118,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: []