allure-report-publisher 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbc236368c7b0893b5de931e7ecd37836c72bc540a5909efcf319fd74348541a
-  data.tar.gz: bf74a63cf06f76bc27d52cdf16fce99006a82076c12fce25de89375a27a932c0
+  metadata.gz: 1809950b5cb79015f9d4568c28eea62fea2ff4abb581ee762303684aa86859a2
+  data.tar.gz: e22f93a0a820aded1cd74bef9b3836867e6c25a0a454acd57343159ba19c780f
 SHA512:
-  metadata.gz: 51104eb7d7073e3495804534aaa0f415cec9f9300dd1c0fa8e1338b065acae290f91fd758c61e0af45f34165f1710923bd6a6e0f2b6d1a9c4d295d409fa89909
-  data.tar.gz: 5aec20910db4609549224a161a09502a390be539a77873b2d1de556b73d307b23d93d0d0f6c8404897569c7fc84e4a7c366bb33cfb6dc40406c530f1874cd2c6
+  metadata.gz: 7695a8fab036e58f775d1d6372ddcc054cd791212e278c840fb2642e4c4c29fb35409fe5cf9e30475217be471f564e68c231362305e89f3815bdb31c53f05ec1
+  data.tar.gz: c9a64aaf86756c14c2e735a9632a1024d178ea1b8e9e97a43d65ad2afd05ff4adaa38094a9f12e083a70d145006269defdb1252ef64991e6412913cd47e6ea5e

data/README.md

@@ -53,6 +53,7 @@ Options:
   --[no-]copy-latest                # Keep copy of latest report at base prefix path, default: false
   --[no-]color                      # Force color output
   --[no-]ignore-missing-results     # Ignore missing allure results, default: false
+  --[no-]debug                      # Print additional debug output, default: false
   --help, -h                        # Print this help
 
 Examples:

data/lib/allure_report_publisher/commands/upload.rb

@@ -55,6 +55,10 @@ module Publisher
              type: :boolean,
              default: false,
              desc: "Ignore missing allure results"
+      option :debug,
+             type: :boolean,
+             default: false,
+             desc: "Print additional debug output"
 
       example [
         "s3 --results-glob='path/to/allure-results' --bucket=my-bucket",
@@ -66,18 +70,15 @@ module Publisher
         @args = args
 
         validate_args
-        validate_result_files
-
-        log("Generating allure report")
-        Spinner.spin("generating") { uploader.generate_report }
+        scan_results_paths
 
-        log("Uploading allure report to #{args[:type]}")
-        Spinner.spin("uploading") { uploader.upload }
-        uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
+        generate_report
+        upload_report
         return unless args[:update_pr] && uploader.pr?
 
-        log("Adding reports urls")
-        Spinner.spin("updating", exit_on_error: false) { uploader.add_result_summary }
+        add_report_urls
+      rescue StandardError => e
+        handle_error(e)
       end
 
       private
@@ -90,8 +91,8 @@ module Publisher
       def uploader
         @uploader ||= uploaders(args[:type]).new(
           summary_type: args[:summary],
+          result_paths: @result_paths,
           **args.slice(
-            :results_glob,
             :bucket,
             :prefix,
             :copy_latest,
@@ -121,18 +122,54 @@ module Publisher
         error("Missing argument --bucket!") unless args[:bucket]
       end
 
-      # Check if allure results present
+      # Scan for allure results paths
       #
       # @param [String] results_glob
       # @return [void]
-      def validate_result_files
+      def scan_results_paths
         results_glob = args[:results_glob]
         ignore = args[:ignore_missing_results]
-        return unless Dir.glob(results_glob).empty?
+        @result_paths = Dir.glob(results_glob)
+        log_debug("Glob '#{results_glob}' found #{@result_paths.size} paths")
+        return unless @result_paths.empty?
 
-        log("Glob '#{results_glob}' did not match any files!", ignore ? :yellow : :red)
+        log("Glob '#{results_glob}' did not match any paths!", ignore ? :yellow : :red)
         exit(ignore ? 0 : 1)
       end
+
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        log("Generating allure report")
+        Spinner.spin("generating", debug: args[:debug]) { uploader.generate_report }
+      end
+
+      # Upload report to cloud storage
+      #
+      # @return [void]
+      def upload_report
+        log("Uploading allure report to #{args[:type]}")
+        Spinner.spin("uploading", debug: args[:debug]) { uploader.upload }
+        uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
+      end
+
+      # Add report results to pr/mr
+      #
+      # @return [void]
+      def add_report_urls
+        log("Adding reports urls")
+        Spinner.spin("updating", exit_on_error: false, debug: args[:debug]) { uploader.add_result_summary }
+      end
+
+      # Handle error during upload command
+      #
+      # @param [StandardError] error
+      # @return [void]
+      def handle_error(error)
+        exit(1) if error.is_a?(Spinner::Failure)
+        error(error)
+      end
     end
   end
 end

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

@@ -0,0 +1,141 @@
+require "tempfile"
+
+module Publisher
+  module Helpers
+    # Helper class for gsutil cli utility
+    #
+    class Gsutil
+      class UnsupportedConfig < StandardError; end
+      class Uninitialised < StandardError; end
+
+      include Helpers
+
+      def self.init
+        new.init!
+      end
+
+      private_class_method :new
+
+      # Initialize gsutil
+      #
+      # @return [Gsutil]
+      def init!
+        log_debug("Setting up gsutil")
+        @valid = execute_shell("which gsutil") && true
+
+        log_debug("Checking google credentials")
+        check_credentials
+        log_debug("Credentials valid, gsutil initialized")
+        self
+      rescue StandardError => e
+        case e
+        when UnsupportedConfig
+          log_debug("credentials not compatible with gsutil! Falling back to google sdk client for batch uploads")
+        when ShellCommandFailure
+          log_debug("gsutil command not found, falling back to gcs client")
+        else
+          log_debug("gsutil init failed: error: #{e}\nbacktrace: #{e.backtrace&.join("\n")}")
+        end
+
+        @valid = false
+        self
+      end
+
+      # Check if gsutil is valid
+      #
+      # @return [Boolean]
+      def valid?
+        @valid
+      end
+
+      # Perform copy operation within a single bucket
+      #
+      # @param [String] source_dir
+      # @param [String] destination_dir
+      # @param [String] bucket
+      # @param [Integer] cache_control
+      # @return [void]
+      def batch_copy(source_dir:, destination_dir:, bucket:, cache_control: 3600)
+        batch_upload(
+          source_dir: "gs://#{bucket}/#{source_dir}",
+          destination_dir: destination_dir,
+          bucket: bucket,
+          cache_control: cache_control
+        )
+      end
+
+      # Perform batch upload operation
+      #
+      # @param [String] source_dir
+      # @param [String] destination_dir
+      # @param [String] bucket
+      # @param [String] cache_control
+      # @return [void]
+      def batch_upload(source_dir:, destination_dir:, bucket:, cache_control: 3600)
+        raise(Uninitialised, "gsutil has not been properly set up!") unless valid?
+
+        action = source_dir.start_with?("gs://") ? "Copying" : "Uploading"
+        destination = "gs://#{bucket}/#{destination_dir}"
+
+        log_debug("#{action} '#{source_dir}' to '#{destination}'")
+        with_credentials do |key_file|
+          execute_shell([
+            base_cmd(key_file),
+            "-h 'Cache-Control:private, max-age=#{cache_control}'",
+            "rsync",
+            "-j json,csv,txt,js,css",
+            "-r #{source_dir} #{destination}"
+          ].join(" "))
+        end
+        log_debug("Finished upload successfully")
+      end
+
+      private
+
+      # Execute block with gcs credentials
+      #
+      # @return [void]
+      def with_credentials
+        if json_key[:file]
+          yield(json_key[:key])
+        else
+          Tempfile.create("auth") do |f|
+            f.write(json_key[:key])
+            f.close
+
+            yield(f.path)
+          end
+        end
+      end
+
+      # Google auth default credentials
+      #
+      # @return [String, Hash]
+      def gcs_credentials
+        @gcs_credentials ||= Google::Cloud::Storage.default_credentials
+      end
+
+      # Google auth json key
+      #
+      # @return [Hash]
+      def json_key
+        @json_key ||= if gcs_credentials.is_a?(Hash)
+                        { file: false, key: gcs_credentials.to_json }
+                      elsif gcs_credentials.is_a?(String) && File.exist?(gcs_credentials)
+                        { file: true, key: gcs_credentials.tap { |f| JSON.parse(File.read(f)) } }
+                      else
+                        raise(UnsupportedConfig, "only google key json credentials are supported for gsutil")
+                      end
+      end
+      alias check_credentials json_key
+
+      # Base command
+      #
+      # @param [String] key_file
+      # @return [String]
+      def base_cmd(key_file)
+        "gsutil -o 'Credentials:gs_service_key_file=#{key_file}' -m"
+      end
+    end
+  end
+end

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

@@ -1,28 +1,66 @@
 require "pastel"
 require "open3"
+require "logger"
+require "stringio"
 
 module Publisher
   # Helpers
   #
   module Helpers
-    # Global instance of pastel
-    #
-    # @param [Boolean] force_color
-    # @return [Pastel]
-    def self.pastel(force_color: nil)
-      @pastel ||= Pastel.new(enabled: force_color, eachline: "\n")
-    end
+    class ShellCommandFailure < StandardError; end
 
-    # Check allure cli is installed and executable
-    #
-    # @return [void]
-    def self.validate_allure_cli_present
-      _out, status = Open3.capture2("which allure")
-      return if status.success?
+    class << self
+      # Global instance of pastel
+      #
+      # @param [Boolean] force_color
+      # @return [Pastel]
+      def pastel(force_color: nil)
+        @pastel ||= Pastel.new(enabled: force_color, eachline: "\n")
+      end
+
+      # Check allure cli is installed and executable
+      #
+      # @return [void]
+      def allure_cli?
+        execute_shell("which allure")
+      rescue StandardError
+        Helpers.error(
+          "Allure cli is missing! See https://docs.qameta.io/allure/#_installing_a_commandline on how to install it!"
+        )
+      end
+
+      # Check if gsutil is installed and executable
+      #
+      # @return [Boolean]
+      def gsutil?
+        execute_shell("which gsutil") && true
+      rescue StandardError
+        false
+      end
+
+      # Debug logging session output
+      #
+      # @return [StringIO]
+      def debug_io
+        @debug_io ||= StringIO.new
+      end
+
+      # Clear debug log output
+      #
+      # @return [void]
+      def reset_debug_io!
+        @debug_io = nil
+      end
 
-      Helpers.error(
-        "Allure cli is missing! See https://docs.qameta.io/allure/#_installing_a_commandline on how to install it!"
-      )
+      # Logger instance
+      #
+      # @return [Logger]
+      def logger
+        Logger.new(debug_io).tap do |logger|
+          logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+          logger.formatter = proc { |_severity, time, _progname, msg| "[#{time}] #{msg}\n" }
+        end
+      end
     end
 
     # Colorize string
@@ -43,6 +81,14 @@ module Publisher
       puts colorize(message, color)
     end
 
+    # Save debug message to be displayed later
+    #
+    # @param [String] message
+    # @return [void]
+    def log_debug(message)
+      Helpers.logger.info(message)
+    end
+
     # Print error message and exit
     #
     # @param [String] message
@@ -64,13 +110,25 @@ module Publisher
     #
     # @param [String] command
     # @return [String] output
-    def execute_shell(command)
+    def execute_shell(command, mask: nil)
+      loggable_command = mask ? command.gsub(mask, "***") : command
+      log_debug("Executing command '#{loggable_command}'")
       out, err, status = Open3.capture3(command)
-      raise("Out:\n#{out}\n\nErr:\n#{err}") unless status.success?
 
-      out
+      cmd_output = []
+      cmd_output << "Out: #{out}" unless out.empty?
+      cmd_output << "Err: #{err}" unless err.empty?
+      output = cmd_output.join("\n")
+
+      unless status.success?
+        err_msg = "Command '#{loggable_command}' failed!\n#{output}"
+        err_msg = mask ? err_msg.gsub(mask, "***") : err_msg
+        raise(ShellCommandFailure, err_msg)
+      end
+
+      mask ? output.gsub(mask, "***") : output
     end
 
-    module_function :colorize, :log, :error, :path, :execute_shell
+    module_function :colorize, :log, :log_debug, :error, :path, :execute_shell
   end
 end

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

@@ -9,9 +9,12 @@ module Publisher
     class Spinner
       include Helpers
 
-      def initialize(spinner_message, exit_on_error: true)
+      class Failure < StandardError; end
+
+      def initialize(spinner_message, exit_on_error: true, debug: false)
         @spinner_message = spinner_message
         @exit_on_error = exit_on_error
+        @debug = debug
       end
 
       # Run code block inside spinner
@@ -21,8 +24,8 @@ module Publisher
       # @param [Boolean] exit_on_error
       # @param [Proc] &block
       # @return [void]
-      def self.spin(spinner_message, done_message: "done", exit_on_error: true, &block)
-        new(spinner_message, exit_on_error: exit_on_error).spin(done_message, &block)
+      def self.spin(spinner_message, done_message: "done", exit_on_error: true, debug: false, &block)
+        new(spinner_message, exit_on_error: exit_on_error, debug: debug).spin(done_message, &block)
       end
 
       # Run code block inside spinner
@@ -34,14 +37,32 @@ module Publisher
         yield
         spinner_success(done_message)
       rescue StandardError => e
-        spinner_error(e.message)
-        exit(1) if exit_on_error
+        spinner_error(e)
+        raise(Failure, e.message) if exit_on_error
+      ensure
+        print_debug
+        Helpers.reset_debug_io!
       end
     end
 
     private
 
-    attr_reader :spinner_message, :exit_on_error
+    attr_reader :spinner_message,
+                :exit_on_error,
+                :debug
+
+    # Print debug contents
+    #
+    # @return [void]
+    def print_debug
+      return if !debug || Helpers.debug_io.string.empty?
+
+      puts <<~OUT.strip
+        == DEBUG LOG OUTPUT ==
+        #{Helpers.debug_io.string.strip}
+        == DEBUG LOG OUTPUT ==
+      OUT
+    end
 
     # Error message color
     #
@@ -96,10 +117,12 @@ module Publisher
 
     # Return spinner error
     #
-    # @param [String] error_message
+    # @param [StandardError] error
     # @return [void]
-    def spinner_error(error_message)
-      colored_message = colorize("failed\n#{error_message}", error_color)
+    def spinner_error(error)
+      message = ["failed", error.message]
+      message << error.backtrace if debug
+      colored_message = colorize(message.compact.join("\n"), error_color)
       return spinner.error(colored_message) if tty?
 
       spinner.stop

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

@@ -70,7 +70,7 @@ module Publisher
       # Short summary table
       #
       # @return [Array<String>]
-      def short_summary # rubocop:disable Metrics/MethodLength
+      def short_summary
         return @short_summary if defined?(@short_summary)
 
         sum = summary_data.values.each_with_object({

data/lib/allure_report_publisher/lib/providers/github.rb

@@ -5,6 +5,8 @@ module Publisher
     # Github implementation
     #
     class Github < Provider
+      include Helpers
+
       # Set octokit to autopaginate
       #
       Octokit.configure do |config|
@@ -60,6 +62,7 @@ module Publisher
       def update_pr_description
         return File.write(step_summary_file, url_section_builder.comment_body) if actions?
 
+        log_debug("Updating pr description for pr !#{pr_id}")
         client.update_pull_request(repository, pr_id, body: url_section_builder.updated_pr_description(pr_description))
       end
 
@@ -67,8 +70,12 @@ module Publisher
       #
       # @return [void]
       def add_comment
-        return client.add_comment(repository, pr_id, url_section_builder.comment_body) unless comment
+        unless comment
+          log_debug("Creating comment with summary for pr ! #{pr_id}")
+          return client.add_comment(repository, pr_id, url_section_builder.comment_body)
+        end
 
+        log_debug("Updating summary in comment with id #{comment[:id]} in pr !#{pr_id}")
         client.update_comment(repository, comment[:id], url_section_builder.comment_body(comment[:body]))
       end
 

data/lib/allure_report_publisher/lib/providers/gitlab.rb

@@ -5,6 +5,8 @@ module Publisher
     # Gitlab implementation
     #
     class Gitlab < Provider
+      include Helpers
+
       # Get ci run ID without creating instance of ci provider
       #
       # @return [String]
@@ -48,6 +50,7 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
+        log_debug("Updating mr description for mr !#{mr_iid}")
         client.update_merge_request(
           project,
           mr_iid,
@@ -59,8 +62,12 @@ module Publisher
       #
       # @return [void]
       def add_comment
-        return client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body) unless comment
+        unless comment
+          log_debug("Creating comment with summary for mr ! #{mr_iid}")
+          return client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body)
+        end
 
+        log_debug("Updating summary in comment with id #{comment.id} in mr !#{mr_iid}")
         client.edit_merge_request_note(project, mr_iid, comment.id, url_section_builder.comment_body(comment.body))
       end
 

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,14 +10,16 @@ module Publisher
   class ReportGenerator
     include Helpers
 
-    def initialize(results_glob)
-      @results_glob = results_glob
+    def initialize(result_paths)
+      @result_paths = result_paths.join(" ")
     end
 
     # Generate allure report
     #
     # @return [void]
     def generate
+      create_common_path
+
       generate_report
     end
 
@@ -25,40 +27,34 @@ module Publisher
     #
     # @return [String]
     def common_info_path
-      @common_info_path ||= Dir.mktmpdir("allure-results")
+      @common_info_path ||= Dir.mktmpdir("allure-results").tap do |path|
+        log_debug("Created tmp folder for common data: '#{path}'")
+      end
     end
+    alias create_common_path common_info_path
 
     # Allure report directory
     #
     # @return [String]
     def report_path
-      @report_path ||= Dir.mktmpdir("allure-report")
+      @report_path ||= File.join(Dir.tmpdir, "allure-report-#{Time.now.to_i}")
     end
 
     private
 
-    attr_reader :results_glob
-
-    # Return all allure results paths from glob
-    #
-    # @return [String]
-    def result_paths
-      @result_paths ||= begin
-        paths = Dir.glob(results_glob)
-        raise(NoAllureResultsError, "Missing allure results") if paths.empty?
-
-        paths.join(" ")
-      end
-    end
+    # @return [String] result paths string
+    attr_reader :result_paths
 
     # Generate allure report
     #
     # @return [void]
     def generate_report
-      out, _err, status = Open3.capture3(
-        "allure generate --clean --output #{report_path} #{common_info_path} #{result_paths}"
-      )
-      raise(AllureError, out) unless status.success?
+      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}")
+    rescue StandardError => e
+      raise(AllureError, e.message)
     end
   end
 end

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

@@ -1,4 +1,5 @@
 require "forwardable"
+require "json"
 
 module Publisher
   module Uploaders
@@ -22,7 +23,7 @@ module Publisher
       # Uploader instance
       #
       # @param [Hash] args
-      # @option args [String] :results_glob
+      # @option args [Array] :result_paths
       # @option args [String] :bucket
       # @option args [String] :prefix
       # @option args [Boolean] :update_pr
@@ -31,7 +32,7 @@ module Publisher
       # @option args [Boolean] :collapse_summary
       # @option args [String] :copy_latest
       def initialize(**args)
-        @results_glob = args[:results_glob]
+        @result_paths = args[:result_paths]
         @bucket_name = args[:bucket]
         @prefix = args[:prefix]
         @update_pr = args[:update_pr]
@@ -73,6 +74,7 @@ module Publisher
       def add_result_summary
         return unless update_pr && ci_provider
 
+        log_debug("Adding test result summary")
         ci_provider.add_result_summary
       end
 
@@ -95,7 +97,7 @@ module Publisher
 
       private
 
-      attr_reader :results_glob,
+      attr_reader :result_paths,
                   :bucket_name,
                   :prefix,
                   :update_pr,
@@ -162,7 +164,7 @@ module Publisher
       #
       # @return [Publisher::ReportGenerator]
       def report_generator
-        @report_generator ||= ReportGenerator.new(results_glob)
+        @report_generator ||= ReportGenerator.new(result_paths)
       end
 
       # Report path prefix
@@ -214,7 +216,8 @@ module Publisher
       def add_history
         create_history_dir
         download_history
-      rescue HistoryNotFoundError
+      rescue HistoryNotFoundError => e
+        log_debug(e.message)
         nil
       end
 
@@ -224,7 +227,11 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        File.write("#{common_info_path}/#{EXECUTOR_JSON}", ci_provider.executor_info.to_json)
+        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)}")
       end
 
       # Run upload commands
@@ -240,7 +247,8 @@ module Publisher
       #
       # @return [void]
       def create_history_dir
-        FileUtils.mkdir_p(path(common_info_path, "history"))
+        path = FileUtils.mkdir_p(path(common_info_path, "history"))
+        log_debug("Created tmp folder for history data: '#{path.first}'")
       end
     end
   end

data/lib/allure_report_publisher/lib/uploaders/gcs.rb

@@ -14,6 +14,13 @@ module Publisher
         @client ||= Google::Cloud::Storage.new
       end
 
+      # Gsutil class
+      #
+      # @return [Helpers::Gsutil]
+      def gsutil
+        @gsutil ||= Helpers::Gsutil.init
+      end
+
       # GCS bucket
       #
       # @return [Google::Cloud::Storage::Bucket]
@@ -39,11 +46,14 @@ module Publisher
       #
       # @return [void]
       def download_history
+        log_debug("Downloading previous run history")
         HISTORY.each do |file_name|
           file = bucket.file(key(prefix, "history", file_name))
           raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
 
-          file.download(path(common_info_path, "history", file_name))
+          file_path = path(common_info_path, "history", file_name)
+          file.download(file_path)
+          log_debug("Downloaded '#{file_name}' as '#{file_path}'")
         end
       end
 
@@ -51,21 +61,28 @@ module Publisher
       #
       # @return [void]
       def upload_history
-        upload_to_gcs(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+        log_debug("Uploading report history")
+        file_upload(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
       end
 
       # Upload allure report
       #
       # @return [void]
       def upload_report
-        upload_to_gcs(report_files, full_prefix)
+        log_debug("Uploading report files")
+        return batch_upload(report_path, full_prefix) if gsutil.valid?
+
+        file_upload(report_files, full_prefix)
       end
 
       # Upload copy of latest run
       #
       # @return [void]
       def upload_latest_copy
-        upload_to_gcs(report_files, prefix, cache_control: 60)
+        log_debug("Uploading report copy as latest report")
+        return batch_copy(full_prefix, prefix, cache_control: 60) if gsutil.valid?
+
+        file_upload(report_files, prefix, cache_control: 60)
       end
 
       # Upload files to gcs
@@ -73,8 +90,9 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @param [Hash] params
-      # @return [Array<Hash>]
-      def upload_to_gcs(files, key_prefix, cache_control: 3600)
+      # @return [void]
+      def file_upload(files, key_prefix, cache_control: 3600)
+        threads = 8
         args = files.map do |file|
           {
             file: file.to_s,
@@ -83,9 +101,40 @@ module Publisher
           }
         end
 
-        Parallel.each(args, in_threads: 8) do |obj|
+        log_debug("Uploading '#{args.size}' files in '#{threads}' threads to bucker '#{bucket_name}'")
+        Parallel.each(args, in_threads: threads) do |obj|
           bucket.create_file(*obj.slice(:file, :path).values, **obj.slice(:cache_control))
         end
+        log_debug("Finished upload successfully")
+      end
+
+      # Upload directory recursively
+      #
+      # @param [String] source_dir
+      # @param [String] destination_dir
+      # @return [void]
+      def batch_upload(source_dir, destination_dir, cache_control: 3600)
+        gsutil.batch_upload(
+          source_dir: source_dir,
+          destination_dir: destination_dir,
+          bucket: bucket_name,
+          cache_control: cache_control
+        )
+      end
+
+      # Copy directory within the bucket
+      #
+      # @param [String] source_dir
+      # @param [String] destination_dir
+      # @param [String] cache_control
+      # @return [void]
+      def batch_copy(source_dir, destination_dir, cache_control: 3600)
+        gsutil.batch_copy(
+          source_dir: source_dir,
+          destination_dir: destination_dir,
+          bucket: bucket_name,
+          cache_control: cache_control
+        )
       end
 
       # Fabricate key for s3 object

data/lib/allure_report_publisher/lib/uploaders/s3.rb

@@ -47,12 +47,15 @@ module Publisher
       #
       # @return [void]
       def download_history
-        HISTORY.each do |file|
+        log_debug("Downloading previous run history")
+        HISTORY.each do |file_name|
+          file_path = path(common_info_path, "history", file_name)
           client.get_object(
-            response_target: path(common_info_path, "history", file),
-            key: key(prefix, "history", file),
+            response_target: file_path,
+            key: key(prefix, "history", file_name),
             bucket: bucket_name
           )
+          log_debug("Downloaded '#{file_name}' as '#{file_path}'")
         end
       rescue Aws::S3::Errors::NoSuchKey
         raise(HistoryNotFoundError, "Allure history from previous runs not found!")
@@ -62,6 +65,7 @@ module Publisher
       #
       # @return [void]
       def upload_history
+        log_debug("Uploading report history")
         upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
       end
 
@@ -69,6 +73,7 @@ module Publisher
       #
       # @return [void]
       def upload_report
+        log_debug("Uploading report files")
         upload_to_s3(report_files, full_prefix)
       end
 
@@ -76,6 +81,7 @@ module Publisher
       #
       # @return [void]
       def upload_latest_copy
+        log_debug("Uploading report copy as latest report")
         upload_to_s3(report_files, prefix, cache_control: 60)
       end
 
@@ -85,6 +91,7 @@ module Publisher
       # @param [String] key_prefix
       # @return [Array<Hash>]
       def upload_to_s3(files, key_prefix, cache_control: 3600)
+        threads = 8
         args = files.map do |file|
           {
             body: File.new(file),
@@ -95,7 +102,9 @@ module Publisher
           }
         end
 
-        Parallel.each(args, in_threads: 8) { |obj| client.put_object(obj) }
+        log_debug("Uploading '#{args.size}' files in '#{threads}' threads")
+        Parallel.each(args, in_threads: threads) { |obj| client.put_object(obj) }
+        log_debug("Finished upload successfully")
       end
 
       # Fabricate key for s3 object

data/lib/allure_report_publisher/version.rb

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

data/lib/allure_report_publisher.rb

@@ -18,4 +18,4 @@ module Publisher
   end
 end
 
-Publisher::Commands.before("upload") { Publisher::Helpers.validate_allure_cli_present }
+Publisher::Commands.before("upload") { Publisher::Helpers.allure_cli? }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-25 00:00:00.000000000 Z
+date: 2022-10-22 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.115.0
+        version: 1.116.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.115.0
+        version: 1.116.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: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -131,7 +131,7 @@ dependencies:
         version: '4.21'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: allure-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -231,19 +245,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -362,14 +382,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.47.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: 0.47.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com
@@ -383,6 +403,7 @@ files:
 - lib/allure_report_publisher.rb
 - lib/allure_report_publisher/commands/upload.rb
 - lib/allure_report_publisher/commands/version.rb
+- lib/allure_report_publisher/lib/helpers/gsutil.rb
 - lib/allure_report_publisher/lib/helpers/helpers.rb
 - lib/allure_report_publisher/lib/helpers/spinner.rb
 - lib/allure_report_publisher/lib/helpers/summary.rb