allure-report-publisher 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc21e0f3488c76bf88a227a59a470d1959f5aadb813fc86986f7a7a175793efc
-  data.tar.gz: 641b2e9a9e6587a3246bdcdbf4e34cc3b952f56c46773e495473db9749e68e80
+  metadata.gz: 60bffdf8cfaef83d728fa0f0ddb3d5f87227f5fd3f3af1df048ac5859a7e21c7
+  data.tar.gz: d3a83dd85d3c3586db99d0c26bf6c5323e4bdc23beff83d80beae12ae0dfcdca
 SHA512:
-  metadata.gz: 2ef72a1f8869b175110a7377418bc3a4b369bbb44329965b2b76184c905dc38293b845cf0d661dbe1ff6eb66c2b87804d6fdc74b06eefa58d30826b863c6f0f9
-  data.tar.gz: d15121ee77d77a467a7e9f6a28b447218711aacc3aa63586f2a0cac424e1abdd129ac2aa7aaba654ddce25f8cf4aec0049d39d4b6cf8be8348515cac6f1854de
+  metadata.gz: 1811d5892f98e633ab10585425c359839da9bdef5828389b18c7e10591031b2dae88b920f7d291d72ddcf7b2894ad457ff975769e74e03f84e4baa0bd94a88ab
+  data.tar.gz: e27359fd763ce52f1ce55522681e06d446c44d815980b0e2777c9181073a5270d78148f1820afff893406483bd24732e778c0ccbff512d0537511efe00234e6e

data/lib/allure_report_publisher/commands/upload.rb

@@ -70,7 +70,7 @@ module Publisher
         @args = args
 
         validate_args
-        validate_result_files
+        scan_results_paths
 
         generate_report
         upload_report
@@ -91,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,
@@ -122,16 +122,18 @@ 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
 

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

@@ -29,15 +29,6 @@ module Publisher
         )
       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]

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,8 +10,8 @@ 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
@@ -42,25 +42,14 @@ module Publisher
 
     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
-      log_debug("Generating allure report from following paths: #{result_paths}")
+      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}")

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

@@ -5,6 +5,8 @@ module Publisher
   module Uploaders
     class HistoryNotFoundError < StandardError; end
 
+    PARALLEL_THREADS = 8
+
     # Uploader implementation
     #
     class Uploader
@@ -23,7 +25,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
@@ -32,7 +34,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]
@@ -65,7 +67,9 @@ module Publisher
       #
       # @return [void]
       def upload
-        run_uploads
+        upload_history unless !run_id || copy_latest
+        upload_report
+        upload_latest_copy if copy_latest
       end
 
       # Add allure report url to pull request description
@@ -97,7 +101,7 @@ module Publisher
 
       private
 
-      attr_reader :results_glob,
+      attr_reader :result_paths,
                   :bucket_name,
                   :prefix,
                   :update_pr,
@@ -164,7 +168,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
@@ -234,15 +238,6 @@ module Publisher
         log_debug("Saved '#{EXECUTOR_JSON}' as '#{json_path}'\n#{JSON.pretty_generate(ci_provider.executor_info)}")
       end
 
-      # Run upload commands
-      #
-      # @return [void]
-      def run_uploads
-        upload_history unless !run_id || copy_latest
-        upload_report
-        upload_latest_copy if copy_latest
-      end
-
       # Fetch allure report history
       #
       # @return [void]

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

@@ -14,13 +14,6 @@ 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]
@@ -70,8 +63,6 @@ module Publisher
       # @return [void]
       def upload_report
         log_debug("Uploading report files")
-        return batch_upload_to_gcs(report_path, full_prefix) if gsutil.valid?
-
         upload_to_gcs(report_files, full_prefix)
       end
 
@@ -79,10 +70,21 @@ module Publisher
       #
       # @return [void]
       def upload_latest_copy
-        log_debug("Uploading report copy as latest report")
-        return batch_upload_to_gcs(report_path, prefix, cache_control: 60) if gsutil.valid?
+        log_debug("Copying report as latest")
+
+        args = report_files.map do |file|
+          {
+            source_file: bucket.file(key(full_prefix, file.relative_path_from(report_path))),
+            destination: key(prefix, file.relative_path_from(report_path))
+          }
+        end
 
-        upload_to_gcs(report_files, prefix, cache_control: 60)
+        Parallel.each(args, in_threads: PARALLEL_THREADS) do |obj|
+          obj[:source_file].copy(obj[:destination], force_copy_metadata: true) do |f|
+            f.cache_control = "public, max-age=60"
+          end
+        end
+        log_debug("Finished latest report copy successfully")
       end
 
       # Upload files to gcs
@@ -90,38 +92,22 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @param [Hash] params
-      # @return [void]
-      def upload_to_gcs(files, key_prefix, cache_control: 3600)
-        threads = 8
+      # @return [Array<Hash>]
+      def upload_to_gcs(files, key_prefix)
         args = files.map do |file|
           {
             file: file.to_s,
-            path: key(key_prefix, file.relative_path_from(report_path)),
-            cache_control: "public, max-age=#{cache_control}"
+            path: key(key_prefix, file.relative_path_from(report_path))
           }
         end
 
-        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))
+        log_debug("Uploading '#{args.size}' files in '#{PARALLEL_THREADS}' threads")
+        Parallel.each(args, in_threads: PARALLEL_THREADS) do |obj|
+          bucket.create_file(*obj.slice(:file, :path).values, cache_control: "public, max-age=3600")
         end
         log_debug("Finished upload successfully")
       end
 
-      # Batch upload whole directory
-      #
-      # @param [String] source_dir
-      # @param [String] destination_dir
-      # @return [void]
-      def batch_upload_to_gcs(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
       #
       # @param [String] *args

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

@@ -81,8 +81,21 @@ 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)
+        log_debug("Copying report as latest")
+
+        args = report_files.map do |file|
+          {
+            bucket: bucket_name,
+            copy_source: "/#{bucket_name}/#{key(full_prefix, file.relative_path_from(report_path))}",
+            key: key(prefix, file.relative_path_from(report_path)),
+            metadata_directive: "REPLACE",
+            content_type: MiniMime.lookup_by_filename(file).content_type,
+            cache_control: "max-age=60"
+          }
+        end
+
+        Parallel.each(args, in_threads: PARALLEL_THREADS) { |obj| client.copy_object(obj) }
+        log_debug("Finished latest report copy successfully")
       end
 
       # Upload files to s3
@@ -90,20 +103,19 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @return [Array<Hash>]
-      def upload_to_s3(files, key_prefix, cache_control: 3600)
-        threads = 8
+      def upload_to_s3(files, key_prefix)
         args = files.map do |file|
           {
             body: File.new(file),
             bucket: bucket_name,
             key: key(key_prefix, file.relative_path_from(report_path)),
             content_type: MiniMime.lookup_by_filename(file).content_type,
-            cache_control: "max-age=#{cache_control}"
+            cache_control: "max-age=3600"
           }
         end
 
-        log_debug("Uploading '#{args.size}' files in '#{threads}' threads")
-        Parallel.each(args, in_threads: threads) { |obj| client.put_object(obj) }
+        log_debug("Uploading '#{args.size}' files in '#{PARALLEL_THREADS}' threads")
+        Parallel.each(args, in_threads: PARALLEL_THREADS) { |obj| client.put_object(obj) }
         log_debug("Finished upload successfully")
       end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2022-11-07 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.118.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.118.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
@@ -248,6 +248,9 @@ dependencies:
   name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -255,6 +258,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -397,7 +403,6 @@ 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

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

@@ -1,120 +0,0 @@
-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 batch copy operation
-      #
-      # @param [String] source_dir
-      # @param [String] destination_dir
-      # @param [String] bucket
-      # @param [String] cache_control
-      # @return [void]
-      def batch_copy(source_dir:, destination_dir:, bucket:, cache_control: 3600)
-        raise(Uninitialised, "gsutil has not been properly set up!") unless valid?
-
-        log_debug("Uploading '#{source_dir}' using gsutil to bucket '#{bucket}' with destination '#{destination_dir}'")
-        with_credentials do |key_file|
-          execute_shell([
-            base_cmd(key_file),
-            "-h 'Cache-Control:private, max-age=#{cache_control}'",
-            "rsync -r #{source_dir} gs://#{bucket}/#{destination_dir}"
-          ].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