allure-report-publisher 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7722c37f99dfb77c35ecc2d813ab65430855d30fa84ebb8836b48e8819e32c56
-  data.tar.gz: 2f992f399433095c273d05b41b15a76958730aeb574b025f1ab804ea993eb290
+  metadata.gz: cbc236368c7b0893b5de931e7ecd37836c72bc540a5909efcf319fd74348541a
+  data.tar.gz: bf74a63cf06f76bc27d52cdf16fce99006a82076c12fce25de89375a27a932c0
 SHA512:
-  metadata.gz: 1c5b08dba58c1d367c6481d21481ebe62044fbec30765d0d0a0ab2f270d7b241e070b4cbb2c6d6773c08888e313b690089a4ff2faa928a4a9f68d5befed8d5c5
-  data.tar.gz: c0cab48cf344df067e70660ec347ca8c11e2b4d7d2517b4364434c576355653067ef3d8a2e8db334d4b1d028b4d1b4ecd338512aad0c72474ed51cb80ba6d83c
+  metadata.gz: 51104eb7d7073e3495804534aaa0f415cec9f9300dd1c0fa8e1338b065acae290f91fd758c61e0af45f34165f1710923bd6a6e0f2b6d1a9c4d295d409fa89909
+  data.tar.gz: 5aec20910db4609549224a161a09502a390be539a77873b2d1de556b73d307b23d93d0d0f6c8404897569c7fc84e4a7c366bb33cfb6dc40406c530f1874cd2c6

data/README.md

@@ -43,7 +43,7 @@ Arguments:
   TYPE                              # REQUIRED Cloud storage type: (s3/gcs)
 
 Options:
-  --results-glob=VALUE              # Allure results files glob. Required: true
+  --results-glob=VALUE              # Glob pattern to return allure results directories. Required: true
   --bucket=VALUE                    # Bucket name. Required: true
   --prefix=VALUE                    # Optional prefix for report path. Required: false
   --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description/actions)
@@ -56,8 +56,8 @@ Options:
   --help, -h                        # Print this help
 
 Examples:
-  allure-report-publisher upload s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket
-  allure-report-publisher upload gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs
+  allure-report-publisher upload s3 --results-glob='path/to/allure-results' --bucket=my-bucket
+  allure-report-publisher upload gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs
 ```
 
 # Storage providers

data/lib/allure_report_publisher/commands/upload.rb

@@ -14,7 +14,7 @@ module Publisher
                desc: "Cloud storage type"
 
       option :results_glob,
-             desc: "Allure results files glob. Required: true"
+             desc: "Glob pattern to return allure results directories. Required: true"
       option :bucket,
              desc: "Bucket name. Required: true"
       option :prefix,
@@ -57,8 +57,8 @@ module Publisher
              desc: "Ignore missing allure results"
 
       example [
-        "s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket",
-        "gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs"
+        "s3 --results-glob='path/to/allure-results' --bucket=my-bucket",
+        "gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs"
       ]
 
       def call(**args)

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -18,15 +18,14 @@ module Publisher
     #
     # @return [void]
     def generate
-      aggregate_results
       generate_report
     end
 
-    # Aggregated results directory
+    # Common path for history and executor info
     #
     # @return [String]
-    def results_path
-      @results_path ||= Dir.mktmpdir("allure-results")
+    def common_info_path
+      @common_info_path ||= Dir.mktmpdir("allure-results")
     end
 
     # Allure report directory
@@ -40,14 +39,16 @@ module Publisher
 
     attr_reader :results_glob
 
-    # Copy all results files to results directory
+    # Return all allure results paths from glob
     #
-    # @return [void]
-    def aggregate_results
-      results = Dir.glob(results_glob)
-      raise(NoAllureResultsError, "Missing allure results") if results.empty?
+    # @return [String]
+    def result_paths
+      @result_paths ||= begin
+        paths = Dir.glob(results_glob)
+        raise(NoAllureResultsError, "Missing allure results") if paths.empty?
 
-      FileUtils.cp(results, results_path)
+        paths.join(" ")
+      end
     end
 
     # Generate allure report
@@ -55,7 +56,7 @@ module Publisher
     # @return [void]
     def generate_report
       out, _err, status = Open3.capture3(
-        "allure generate --clean --output #{report_path} #{results_path}"
+        "allure generate --clean --output #{report_path} #{common_info_path} #{result_paths}"
       )
       raise(AllureError, out) unless status.success?
     end

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

@@ -104,7 +104,7 @@ module Publisher
                   :collapse_summary,
                   :summary_table_type
 
-      def_delegators :report_generator, :results_path, :report_path
+      def_delegators :report_generator, :common_info_path, :report_path
 
       # :nocov:
 
@@ -224,7 +224,7 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        File.write("#{results_path}/#{EXECUTOR_JSON}", ci_provider.executor_info.to_json)
+        File.write("#{common_info_path}/#{EXECUTOR_JSON}", ci_provider.executor_info.to_json)
       end
 
       # Run upload commands
@@ -240,7 +240,7 @@ module Publisher
       #
       # @return [void]
       def create_history_dir
-        FileUtils.mkdir_p(path(results_path, "history"))
+        FileUtils.mkdir_p(path(common_info_path, "history"))
       end
     end
   end

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

@@ -43,7 +43,7 @@ module Publisher
           file = bucket.file(key(prefix, "history", file_name))
           raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
 
-          file.download(path(results_path, "history", file_name))
+          file.download(path(common_info_path, "history", file_name))
         end
       end
 
@@ -65,23 +65,27 @@ module Publisher
       #
       # @return [void]
       def upload_latest_copy
-        upload_to_gcs(report_files, prefix)
+        upload_to_gcs(report_files, prefix, cache_control: 60)
       end
 
-      # Upload files to s3
+      # Upload files to gcs
       #
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
+      # @param [Hash] params
       # @return [Array<Hash>]
-      def upload_to_gcs(files, key_prefix)
+      def upload_to_gcs(files, key_prefix, cache_control: 3600)
         args = files.map do |file|
           {
             file: file.to_s,
-            path: key(key_prefix, file.relative_path_from(report_path))
+            path: key(key_prefix, file.relative_path_from(report_path)),
+            cache_control: "public, max-age=#{cache_control}"
           }
         end
 
-        Parallel.each(args, in_threads: 8) { |obj| bucket.create_file(obj[:file], obj[:path]) }
+        Parallel.each(args, in_threads: 8) do |obj|
+          bucket.create_file(*obj.slice(:file, :path).values, **obj.slice(:cache_control))
+        end
       end
 
       # Fabricate key for s3 object

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

@@ -49,7 +49,7 @@ module Publisher
       def download_history
         HISTORY.each do |file|
           client.get_object(
-            response_target: path(results_path, "history", file),
+            response_target: path(common_info_path, "history", file),
             key: key(prefix, "history", file),
             bucket: bucket_name
           )
@@ -76,7 +76,7 @@ module Publisher
       #
       # @return [void]
       def upload_latest_copy
-        upload_to_s3(report_files, prefix)
+        upload_to_s3(report_files, prefix, cache_control: 60)
       end
 
       # Upload files to s3
@@ -84,13 +84,14 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @return [Array<Hash>]
-      def upload_to_s3(files, key_prefix)
+      def upload_to_s3(files, key_prefix, cache_control: 3600)
         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
+            content_type: MiniMime.lookup_by_filename(file).content_type,
+            cache_control: "max-age=#{cache_control}"
           }
         end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -362,14 +362,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.45.0
+        version: 0.46.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com