allure-report-publisher 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60bffdf8cfaef83d728fa0f0ddb3d5f87227f5fd3f3af1df048ac5859a7e21c7
-  data.tar.gz: d3a83dd85d3c3586db99d0c26bf6c5323e4bdc23beff83d80beae12ae0dfcdca
+  metadata.gz: 9aa8d4aeec603193bb1d2dcc253ef1ad8f22d9bac900ba393b46ace96498cf7b
+  data.tar.gz: a567fc75fcf837f7131d3e86d84106f04da7d571c8e0c91ebff64ca40afb5cae
 SHA512:
-  metadata.gz: 1811d5892f98e633ab10585425c359839da9bdef5828389b18c7e10591031b2dae88b920f7d291d72ddcf7b2894ad457ff975769e74e03f84e4baa0bd94a88ab
-  data.tar.gz: e27359fd763ce52f1ce55522681e06d446c44d815980b0e2777c9181073a5270d78148f1820afff893406483bd24732e778c0ccbff512d0537511efe00234e6e
+  metadata.gz: 54a8b3516af69699e3e2a2cb32c44a5a54c26905a5de2e0542a40ba14da3feb2517d5bde871ddae6bce9ac89a228a0dc5bebdaea70f3b993c3432703ada3e342
+  data.tar.gz: 9cd184caae6f8a6480ccf7226324f07972430c309943797881b4d95310032438e141bb657249ff7f139aab289c19b1cd36a3f811df2cf7be3b316d2260fa3148

data/README.md

@@ -49,7 +49,8 @@ Options:
   --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description/actions)
   --summary=VALUE                   # Additionally add summary table to PR comment or description. Required: false: (behaviors/suites/packages/total)
   --summary-table-type=VALUE        # Summary table type. Required: false: (ascii/markdown), default: :ascii
-  --[no-]collapse-summary           # Create summary as a collapsable section, default: false
+  --base-url=VALUE                  # Use custom base url instead of default cloud provider one. Required: false
+  --[no-]collapse-summary           # Create summary as a collapsible section, default: false
   --[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

data/lib/allure_report_publisher/commands/upload.rb

@@ -1,3 +1,5 @@
+require "uri"
+
 module Publisher
   module Commands
     # Upload allure report
@@ -40,10 +42,13 @@ module Publisher
                Publisher::Helpers::Summary::ASCII,
                Publisher::Helpers::Summary::MARKDOWN
              ]
+      option :base_url,
+             type: :string,
+             desc: "Use custom base url instead of default cloud provider one. Required: false"
       option :collapse_summary,
              type: :boolean,
              default: false,
-             desc: "Create summary as a collapsable section"
+             desc: "Create summary as a collapsible section"
       option :copy_latest,
              type: :boolean,
              default: false,
@@ -95,6 +100,7 @@ module Publisher
           **args.slice(
             :bucket,
             :prefix,
+            :base_url,
             :copy_latest,
             :update_pr,
             :collapse_summary,
@@ -120,6 +126,9 @@ module Publisher
       def validate_args
         error("Missing argument --results-glob!") unless args[:results_glob]
         error("Missing argument --bucket!") unless args[:bucket]
+        URI.parse(args[:base_url]) if args[:base_url]
+      rescue URI::InvalidURIError
+        error("Invalid --base-url value!")
       end
 
       # Scan for allure results paths

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

@@ -28,6 +28,7 @@ module Publisher
       # @option args [Array] :result_paths
       # @option args [String] :bucket
       # @option args [String] :prefix
+      # @option args [String] :base_url
       # @option args [Boolean] :update_pr
       # @option args [String] :summary_type
       # @option args [Symbol] :summary_table_type
@@ -37,6 +38,7 @@ module Publisher
         @result_paths = args[:result_paths]
         @bucket_name = args[:bucket]
         @prefix = args[:prefix]
+        @base_url = args[:base_url]
         @update_pr = args[:update_pr]
         @summary_type = args[:summary_type]
         @summary_table_type = args[:summary_table_type]
@@ -104,6 +106,7 @@ module Publisher
       attr_reader :result_paths,
                   :bucket_name,
                   :prefix,
+                  :base_url,
                   :update_pr,
                   :copy_latest,
                   :summary_type,

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

@@ -72,13 +72,18 @@ module Publisher
       def upload_latest_copy
         log_debug("Copying report as latest")
 
+        # it's not possible to overwrite whole directory so we clean out unique data files from last run
+        log_debug("Cleaning data files")
+        data_files = bucket.files(prefix: key(prefix, "data"))
+        Parallel.each(data_files, in_threads: PARALLEL_THREADS, &:delete)
+
+        log_debug("Copying report files")
         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
-
         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"
@@ -121,7 +126,7 @@ module Publisher
       # @param [String] path_prefix
       # @return [String]
       def url(path_prefix)
-        ["https://storage.googleapis.com", bucket_name, path_prefix, "index.html"].compact.join("/")
+        [base_url || "https://storage.googleapis.com", bucket_name, path_prefix, "index.html"].compact.join("/")
       end
     end
   end

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

@@ -83,6 +83,18 @@ module Publisher
       def upload_latest_copy
         log_debug("Copying report as latest")
 
+        # it's not possible to overwrite whole directory so we clean out unique data files from last run
+        log_debug("Cleaning data files")
+        client.list_objects_v2(bucket: bucket_name, prefix: key(prefix, "data")).each do |resp|
+          client.delete_objects({
+            bucket: bucket_name,
+            delete: {
+              objects: resp.contents.map { |obj| { key: obj.key } }
+            }
+          })
+        end
+
+        log_debug("Copying report files")
         args = report_files.map do |file|
           {
             bucket: bucket_name,
@@ -93,7 +105,6 @@ module Publisher
             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
@@ -132,7 +143,7 @@ module Publisher
       # @param [String] path_prefix
       # @return [String]
       def url(path_prefix)
-        ["http://#{bucket_name}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
+        [base_url || "http://#{bucket_name}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
       end
     end
   end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -39,7 +39,7 @@ dependencies:
         version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
@@ -222,14 +222,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.0
+        version: 2.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.18.0
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -382,14 +382,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.48.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.48.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com