allure-report-publisher 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc21e0f3488c76bf88a227a59a470d1959f5aadb813fc86986f7a7a175793efc
-  data.tar.gz: 641b2e9a9e6587a3246bdcdbf4e34cc3b952f56c46773e495473db9749e68e80
+  metadata.gz: 1809950b5cb79015f9d4568c28eea62fea2ff4abb581ee762303684aa86859a2
+  data.tar.gz: e22f93a0a820aded1cd74bef9b3836867e6c25a0a454acd57343159ba19c780f
 SHA512:
-  metadata.gz: 2ef72a1f8869b175110a7377418bc3a4b369bbb44329965b2b76184c905dc38293b845cf0d661dbe1ff6eb66c2b87804d6fdc74b06eefa58d30826b863c6f0f9
-  data.tar.gz: d15121ee77d77a467a7e9f6a28b447218711aacc3aa63586f2a0cac424e1abdd129ac2aa7aaba654ddce25f8cf4aec0049d39d4b6cf8be8348515cac6f1854de
+  metadata.gz: 7695a8fab036e58f775d1d6372ddcc054cd791212e278c840fb2642e4c4c29fb35409fe5cf9e30475217be471f564e68c231362305e89f3815bdb31c53f05ec1
+  data.tar.gz: c9a64aaf86756c14c2e735a9632a1024d178ea1b8e9e97a43d65ad2afd05ff4adaa38094a9f12e083a70d145006269defdb1252ef64991e6412913cd47e6ea5e

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/gsutil.rb

@@ -48,22 +48,43 @@ module Publisher
         @valid
       end
 
-      # Perform batch copy operation
+      # Perform copy operation within a single bucket
       #
       # @param [String] source_dir
       # @param [String] destination_dir
       # @param [String] bucket
-      # @param [String] cache_control
+      # @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?
 
-        log_debug("Uploading '#{source_dir}' using gsutil to bucket '#{bucket}' with destination '#{destination_dir}'")
+        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 -r #{source_dir} gs://#{bucket}/#{destination_dir}"
+            "rsync",
+            "-j json,csv,txt,js,css",
+            "-r #{source_dir} #{destination}"
           ].join(" "))
         end
         log_debug("Finished upload successfully")

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

@@ -23,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
@@ -32,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]
@@ -97,7 +97,7 @@ module Publisher
 
       private
 
-      attr_reader :results_glob,
+      attr_reader :result_paths,
                   :bucket_name,
                   :prefix,
                   :update_pr,
@@ -164,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

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

@@ -62,7 +62,7 @@ module Publisher
       # @return [void]
       def upload_history
         log_debug("Uploading report history")
-        upload_to_gcs(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+        file_upload(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
       end
 
       # Upload allure report
@@ -70,9 +70,9 @@ module Publisher
       # @return [void]
       def upload_report
         log_debug("Uploading report files")
-        return batch_upload_to_gcs(report_path, full_prefix) if gsutil.valid?
+        return batch_upload(report_path, full_prefix) if gsutil.valid?
 
-        upload_to_gcs(report_files, full_prefix)
+        file_upload(report_files, full_prefix)
       end
 
       # Upload copy of latest run
@@ -80,9 +80,9 @@ 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?
+        return batch_copy(full_prefix, prefix, cache_control: 60) if gsutil.valid?
 
-        upload_to_gcs(report_files, prefix, cache_control: 60)
+        file_upload(report_files, prefix, cache_control: 60)
       end
 
       # Upload files to gcs
@@ -91,7 +91,7 @@ module Publisher
       # @param [String] key_prefix
       # @param [Hash] params
       # @return [void]
-      def upload_to_gcs(files, key_prefix, cache_control: 3600)
+      def file_upload(files, key_prefix, cache_control: 3600)
         threads = 8
         args = files.map do |file|
           {
@@ -108,12 +108,27 @@ module Publisher
         log_debug("Finished upload successfully")
       end
 
-      # Batch upload whole directory
+      # Upload directory recursively
       #
       # @param [String] source_dir
       # @param [String] destination_dir
       # @return [void]
-      def batch_upload_to_gcs(source_dir, destination_dir, cache_control: 3600)
+      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,

data/lib/allure_report_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Publisher
-  VERSION = "1.1.0"
+  VERSION = "1.2.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.2.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-17 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
@@ -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