allure-report-publisher 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2b10c9286500f94660d0583cc9aeaa2a1ba2ffc0bbddf76d2f210709e36ffcd
-  data.tar.gz: 9ab116dd4d4f2d0698adcbf80b2f4c5cf0b339435b965121c8cca1aa4d081d1c
+  metadata.gz: cbc236368c7b0893b5de931e7ecd37836c72bc540a5909efcf319fd74348541a
+  data.tar.gz: bf74a63cf06f76bc27d52cdf16fce99006a82076c12fce25de89375a27a932c0
 SHA512:
-  metadata.gz: 8d0206593844b02dc18b72f8e835e71ea0b6864c647ce4a9c7dc249c58ab6d16129fe3cbd31b8dd6e3c3e596693f1947cee1643ff70d48b14fdb5434cdcb62d3
-  data.tar.gz: ea0c81164c7a93d9451e9325ec1c6a14b220d7305814bbfbfbece77cb59a9c14635343ae11d92f7b1cc3b035e470eb929ab2e982002199aafb399c189c2427c8
+  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
 

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
           )

data/lib/allure_report_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Publisher
-  VERSION = "0.11.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.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3