allure-ruby-commons 2.27.0 → 2.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfc6a336acd109d4c450d5ca1130a0063a90fdbb40899eae417b971787727e4a
-  data.tar.gz: 0db6791b629a3a6a6dc2ecac0f794a213faff0ec908cb19815f12aba0a2db3ae
+  metadata.gz: c492299cc403fb00313d8cb071712676292a6ca937c4e63dd69898345878d7c3
+  data.tar.gz: 7a883ae369f1aad7ece45aa735b911b12c4e0fd3c6a7c4beff289b1e25ad0da2
 SHA512:
-  metadata.gz: 457f0e99b1d265c4e8a57fd9d29449a336a9bac407871847ecd198fc28cca49b74b6575b4c37c90a4c3dda7570ea727a3ac47dd62593532b7300c23ff7a0405d
-  data.tar.gz: 60c6d25d2e1bc3db6a820f3443791c9edd6ff5baecf4be205240c1a72b39d7fe0f3884ab9d44991481609ed0c475c85112c65957931f830cb1e8fe7b9a0d3c0d
+  metadata.gz: 61912849ff65168de97d84edb8d00a024164e5b9e9caa33c366144ba93854d19ab89203a123711d10f0524b3ff0a4004e10bbc7f7f615f74393306c9bf40c8da
+  data.tar.gz: f44bbb71e3bb02a18e20729e7df33c64340df4e2bbe7c46430dd852003d51794a7ba6f37d376685e3275eb8125af5256e32b728270aa894ac9fe4aaed61df45a

data/lib/allure-ruby-commons.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "require_all"
+require "digest"
 require "securerandom"
 
 require_rel "allure_ruby_commons/**/*rb"
@@ -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

@@ -20,7 +20,7 @@ module Allure
 
     attr_reader :config
 
-    def_delegators :file_writer, :write_attachment
+    def_delegators :file_writer, :write_attachment, :write_globals
 
     # Start test result container
     # @param [Allure::TestResultContainer] test_result_container
@@ -220,6 +220,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)
+      write_globals(Globals.new(attachments: [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}'" }
+      write_globals(Globals.new(errors: [error]))
+    end
+
     # Add environment.properties file
     #
     # @param [Hash, Proc] env

data/lib/allure_ruby_commons/config.rb

@@ -31,7 +31,7 @@ module Allure
     #
     # @return [String]
     def environment
-      return(@environment) if defined?(@environment)
+      return @environment if defined?(@environment)
 
       @environment ||= ENV["ALLURE_ENVIRONMENT"]
     end

data/lib/allure_ruby_commons/file_writer.rb

@@ -11,6 +11,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 +47,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]

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,23 @@
+# 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:, **options)
+      super(**options)
+
+      @timestamp = timestamp
+    end
+
+    attr_accessor :timestamp
+  end
+end

data/lib/allure_ruby_commons/model/globals.rb

@@ -0,0 +1,17 @@
+# 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
+  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

@@ -172,6 +172,35 @@ 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 [Hash] options
+      # @option options [Boolean] :known
+      # @option options [Boolean] :muted
+      # @option options [Boolean] :flaky
+      # @option options [String] :message
+      # @option options [String] :trace
+      # @return [Allure::GlobalError]
+      def prepare_global_error(timestamp: self.timestamp, **options)
+        GlobalError.new(timestamp: timestamp, **options)
+      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.27.0
+  version: 2.29.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -55,14 +55,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 description: Utilities allowing to implement allure result generation by other test
   frameworks
 email: andrejs.cunskis@gmail.com
@@ -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.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Common library for allure results generation
 test_files: []