allure-report-publisher 1.6.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a1b01fffd526add66fad90f0b9361fbb267cbe0245f466b2593a0dd763491f9
-  data.tar.gz: c906896082cb17fc3bc79b2cfcf5725d01694a927dcd5b882403777c9d14d809
+  metadata.gz: 4115ac96bf1ba67b88667f692f4d679badba58b771446fc6b31d814aee152367
+  data.tar.gz: 4d3b7cf9834063ee9ccac56bcb1c81fe0b690a369929230255b7715106b43bc2
 SHA512:
-  metadata.gz: de9f9cb4037366f792d9a82c4390f4f749c212a740a515c2352ea10fecc1c566af47af6968d0717e9a1fd07281c9a6263bbd45be37b034367c3d5fa3b84b6172
-  data.tar.gz: 3731415da0b98f0de6667dbea3ae80898b3b68e9b49d521132605b8dece4126c15ce754495d117fe26e3d72a04f3f95a886824d0af9314859db4f29b74f16751
+  metadata.gz: f904533b0677eeb3222689567663e26c828d6f14410a91cb87b031dc5b66b83db3c71becc56049c7ff43f3ea6c09f14800544e8530134aad0283a8a34b66179d
+  data.tar.gz: 4cab5ad6c6965715e8a1a33a47cbe040bab2724f57225a3d7cd7fc99e7c1e8499f9eef7d8a4f671dc19468d988077f43b64fbaee77e1956ac9da95f8629f1519

data/README.md

@@ -63,6 +63,12 @@ Examples:
   allure-report-publisher upload gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs
 ```
 
+## Environment variables
+
+All named options can be configured via environment variables. Environment variables are prefixed with `ALLURE_REPORT_` and uppercased.
+
+Example: `--results-glob` can be configured via `ALLURE_REPORT_RESULTS_GLOB`
+
 # Storage providers
 
 Multiple cloud storage providers are supported

data/lib/allure_report_publisher/lib/helpers/helpers.rb

@@ -123,7 +123,7 @@ module Publisher
 
       unless status.success?
         err_msg = "Command '#{loggable_command}' failed!\n#{output}"
-        err_msg = mask ? err_msg.gsub(mask, "***") : err_msg
+        err_msg = err_msg.gsub(mask, "***") if mask
         raise(ShellCommandFailure, err_msg)
       end
 

data/lib/allure_report_publisher/lib/helpers/url_section_builder.rb

@@ -3,8 +3,8 @@ module Publisher
     # Urls section builder
     #
     class UrlSectionBuilder
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
-      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/.freeze
+      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/
+      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/
 
       # Url section builder
       #

data/lib/allure_report_publisher/lib/parser.rb

@@ -0,0 +1,59 @@
+module Dry
+  class CLI
+    # Parser overload to support loading all options from environment variables
+    #
+    module Parser
+      class InvalidEnvValue < StandardError; end
+
+      class << self
+        def call(command, arguments, prog_name)
+          original_arguments = arguments.dup
+          parsed_options = {}
+
+          OptionParser.new do |opts|
+            command.options.each do |option|
+              opts.on(*option.parser_options) do |value|
+                parsed_options[option.name.to_sym] = value
+              end
+            end
+
+            opts.on_tail("-h", "--help") do
+              return Result.help
+            end
+          end.parse!(arguments)
+
+          parsed_options = command
+                           .default_params
+                           .merge(load_options(command.options, parsed_options))
+
+          parse_required_params(command, arguments, prog_name, parsed_options)
+        rescue ::OptionParser::ParseError, InvalidEnvValue => e
+          return Result.failure(e.message) if e.is_a?(InvalidEnvValue)
+
+          Result.failure("ERROR: \"#{prog_name}\" was called with arguments \"#{original_arguments.join(' ')}\"")
+        end
+
+        private
+
+        def load_options(options, parsed_options)
+          options.each_with_object({}) do |option, opts|
+            parsed_opt = parsed_options[option.name.to_sym]
+            next opts[option.name.to_sym] = parsed_opt unless parsed_opt.nil?
+
+            opts[option.name.to_sym] = option_from_env(option)
+          end.compact
+        end
+
+        def option_from_env(option) # rubocop:disable Metrics/CyclomaticComplexity
+          name = "ALLURE_REPORT_#{option.name.to_s.upcase}"
+          value = ENV[name]
+          return if value.nil? || value.empty?
+          return if option.boolean? && !%w[true false].include?(value)
+          raise(InvalidEnvValue, "#{name} contains invalid value: '#{value}'") if option.values&.none?(value)
+
+          option.boolean? ? value == "true" : value
+        end
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/lib/providers/_provider.rb

@@ -7,7 +7,8 @@ module Publisher
     # @return [Publisher::Providers::Base]
     def self.provider
       return Github if ENV["GITHUB_WORKFLOW"]
-      return Gitlab if ENV["GITLAB_CI"]
+
+      Gitlab if ENV["GITLAB_CI"]
     end
 
     # Base class for CI executor info

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -52,9 +52,25 @@ module Publisher
       log_debug("Generating allure report")
       cmd = "allure generate --clean --output #{report_path} #{common_info_path} #{result_paths}"
       out = execute_shell(cmd)
-      log_debug("Generated allure report. #{out}")
+      log_debug("Generated allure report. #{out}".strip)
+
+      deduplicate_executors
     rescue StandardError => e
       raise(AllureError, e.message)
     end
+
+    # Remove duplicate entries from executors widget
+    # This is a workaround for making history work with multiple result paths
+    # allure-report requires executors.json in every results folder but it will create duplicate entries
+    # in executors widget of the final report
+    #
+    # @return [void]
+    def deduplicate_executors
+      executors_file = File.join(report_path, "widgets", "executors.json")
+      executors_json = JSON.parse(File.read(executors_file)).uniq
+
+      log_debug("Removing duplicate entries in '#{executors_file}'")
+      File.write(executors_file, JSON.generate(executors_json))
+    end
   end
 end

data/lib/allure_report_publisher/lib/uploaders/_uploader.rb

@@ -238,11 +238,16 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        json_path = "#{common_info_path}/#{EXECUTOR_JSON}"
         json = ci_provider.executor_info.to_json
-        log_debug("Saving ci executor info")
-        File.write(json_path, json)
-        log_debug("Saved '#{EXECUTOR_JSON}' as '#{json_path}'\n#{JSON.pretty_generate(ci_provider.executor_info)}")
+        log_debug("Saving ci executor info:\n#{JSON.pretty_generate(ci_provider.executor_info)}")
+        # allure-report will fail to pick up reportUrl in history tab if executor.json is not present alongside results
+        [common_info_path, *result_paths].each do |path|
+          file = File.join(path, EXECUTOR_JSON)
+          next log_debug("Skipping '#{file}', executor info already exists") if File.exist?(file)
+
+          File.write(File.join(path, EXECUTOR_JSON), json)
+          log_debug("Saved ci executor info to '#{file}'")
+        end
       end
 
       # Fetch allure report history

data/lib/allure_report_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Publisher
-  VERSION = "1.6.2"
+  VERSION = "1.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -19,7 +19,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.124.0
+        version: 1.137.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.124.0
+        version: 1.137.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ dependencies:
         version: '4.21'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -131,7 +131,7 @@ dependencies:
         version: '4.21'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -219,6 +219,7 @@ files:
 - lib/allure_report_publisher/lib/helpers/spinner.rb
 - lib/allure_report_publisher/lib/helpers/summary.rb
 - lib/allure_report_publisher/lib/helpers/url_section_builder.rb
+- lib/allure_report_publisher/lib/parser.rb
 - lib/allure_report_publisher/lib/providers/_provider.rb
 - lib/allure_report_publisher/lib/providers/github.rb
 - lib/allure_report_publisher/lib/providers/gitlab.rb
@@ -245,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="