allure-report-publisher 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e07e63b14a3d8101f13eb9f4f824485f0c9eab83a8cc3d2dc13beb72cb3817c4
-  data.tar.gz: 5d040670bafc783b72e803b0fc942714b4aa5a560070711389821461a9f485bf
+  metadata.gz: cd838b870583e0c460f851a46db5be91f1d3c12c7fa6eea246a62dc957332403
+  data.tar.gz: 56ad43ca79094900b54540668b6402f6aef4e1489f8ff0efcac9535cc1e2223f
 SHA512:
-  metadata.gz: bbbef8d211fa162cb3dc3cb170bcc6167247938f9157e28c75f0a12c2d6296e1cc8b546e5b962855a6e6944b9e31d2538153237773a794991c47a822cde2e9bb
-  data.tar.gz: 5734ed15c3c4296394b34a05a86c48e06da2e6e12bcb044941c5624c6775a577019fe071bd4d55a01c07f56bce92e634044591ae0edfc13b5e9e21f5436ff8e2
+  metadata.gz: 20c29d89dba50857eeefbd18ca77e0cf7640a9c23cdf8ce2387f5fe7db682b117a55ad8f75b0a211ce26490c8b8bcb562e16b1d0b211e2bdd8bc18715a8bbafd
+  data.tar.gz: f0af3cc2833eda0b1decbb9d4de665b1781c3b54396edc866224cb2f170dcda52f9c91760d83b9b3fca17ee6373c8e4d76a5853beb5ba9c7bbb81aed939e6c9d

data/lib/allure_report_publisher/commands/upload.rb

@@ -32,6 +32,10 @@ module Publisher
                Publisher::Helpers::Summary::PACKAGES,
                Publisher::Helpers::Summary::TOTAL
              ]
+      option :collapse_summary,
+             type: :boolean,
+             default: false,
+             desc: "Create summary as a collapsable section"
       option :copy_latest,
              type: :boolean,
              default: false,
@@ -83,7 +87,8 @@ module Publisher
             :bucket,
             :prefix,
             :copy_latest,
-            :update_pr
+            :update_pr,
+            :collapse_summary
           )
         )
       end

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

@@ -13,12 +13,14 @@ module Publisher
       # @param [String] build_name
       # @param [String] sha_url
       # @param [String] summary_type
-      def initialize(report_url:, report_path:, build_name:, sha_url:, summary_type:)
-        @report_url = report_url
-        @report_path = report_path
-        @build_name = build_name
-        @sha_url = sha_url
-        @summary_type = summary_type
+      # @param [String] collapse_summary
+      def initialize(**args)
+        @report_url = args[:report_url]
+        @report_path = args[:report_path]
+        @build_name = args[:build_name]
+        @sha_url = args[:sha_url]
+        @summary_type = args[:summary_type]
+        @collapse_summary = args[:collapse_summary]
       end
 
       # Matches url section pattern
@@ -59,7 +61,8 @@ module Publisher
                   :report_path,
                   :build_name,
                   :sha_url,
-                  :summary_type
+                  :summary_type,
+                  :collapse_summary
 
       private
 
@@ -84,7 +87,10 @@ module Publisher
         @job_entry ||= begin
           entry = ["<!-- #{build_name} -->"]
           entry << "**#{build_name}**: #{summary.status} [test report](#{report_url}) for #{sha_url}"
+          entry << "<details>" if collapse_summary
+          entry << "<summary>expand test summary</summary>\n" if collapse_summary
           entry << "```markdown\n#{summary.table}\n```" if summary_type
+          entry << "</details>" if collapse_summary
           entry << "<!-- #{build_name} -->"
 
           entry.join("\n")

data/lib/allure_report_publisher/lib/providers/_provider.rb

@@ -19,11 +19,12 @@ module Publisher
       #
       # @param [String] report_url
       # @param [Boolean] update_pr
-      def initialize(report_url:, report_path:, update_pr:, summary_type:)
+      def initialize(report_url:, report_path:, update_pr:, summary_type:, collapse_summary:)
         @report_url = report_url
         @report_path = report_path
         @update_pr = update_pr
         @summary_type = summary_type
+        @collapse_summary = collapse_summary
       end
 
       # :nocov:
@@ -67,7 +68,8 @@ module Publisher
       attr_reader :report_url,
                   :report_path,
                   :update_pr,
-                  :summary_type
+                  :summary_type,
+                  :collapse_summary
 
       # Current pull request description
       #
@@ -128,7 +130,8 @@ module Publisher
           report_path: report_path,
           build_name: build_name,
           sha_url: sha_url,
-          summary_type: summary_type
+          summary_type: summary_type,
+          collapse_summary: collapse_summary
         )
       end
     end

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

@@ -19,13 +19,24 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob:, bucket:, update_pr: nil, prefix: nil, copy_latest: false, summary_type: nil) # rubocop:disable Metrics/ParameterLists
-        @results_glob = results_glob
-        @bucket_name = bucket
-        @prefix = prefix
-        @update_pr = update_pr
-        @summary_type = summary_type
-        @copy_latest = !!(Providers.provider && copy_latest) # copy latest for ci only
+      # Uploader instance
+      #
+      # @param [Hash] args
+      # @option args [String] :results_glob
+      # @option args [String] :bucket
+      # @option args [String] :prefix
+      # @option args [Boolean] :update_pr
+      # @option args [String] :summary_type
+      # @option args [Boolean] :collapse_summary
+      # @option args [String] :copy_latest
+      def initialize(**args)
+        @results_glob = args[:results_glob]
+        @bucket_name = args[:bucket]
+        @prefix = args[:prefix]
+        @update_pr = args[:update_pr]
+        @summary_type = args[:summary_type]
+        @copy_latest = (Providers.provider && args[:copy_latest]) # copy latest for ci only
+        @collapse_summary = args[:collapse_summary]
       end
 
       # Execute allure report generation and upload
@@ -87,7 +98,8 @@ module Publisher
                   :prefix,
                   :update_pr,
                   :copy_latest,
-                  :summary_type
+                  :summary_type,
+                  :collapse_summary
 
       def_delegators :report_generator, :results_path, :report_path
 
@@ -154,7 +166,7 @@ module Publisher
       #
       # @return [String]
       def full_prefix
-        @full_prefix ||= [prefix, run_id].compact.yield_self do |pre|
+        @full_prefix ||= [prefix, run_id].compact.then do |pre|
           break if pre.empty?
 
           pre.join("/")
@@ -187,7 +199,8 @@ module Publisher
           report_url: report_url,
           report_path: report_path,
           update_pr: update_pr,
-          summary_type: summary_type
+          summary_type: summary_type,
+          collapse_summary: collapse_summary
         )
       end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -387,7 +387,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="