allure-report-publisher 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f96ef4e9997f8e97d580f212e0617f497ed7c864a2ef974792ef44966406a519
-  data.tar.gz: 01c87b5f3652e346252a55738406ab77d1c24c333751949fa7c43f79a8a5e88c
+  metadata.gz: 9231271e7296dcc0921871769aff6442e2a6eb1bb919574b72cb8753be897b4c
+  data.tar.gz: ebf30bece57cd457150bc9002b731fce743914f5ab9a11c6457d8e50151b1d2b
 SHA512:
-  metadata.gz: cc75d1e5f85618b19b41f19dad6991c11f4e84dff8185d670f3dc69561f668bfddc056d53229995df42c2759bb5454a3de09b3685b1739418f762cc78f9fb074
-  data.tar.gz: 1ea619bdabf0e0a5a90731aa79abcf216479046ba663ac381615b82a663026ef2694c73312f8fcc7d855f5ca6bed0ecb6d75e010929555a32dc07d43a1da1742
+  metadata.gz: 1cd52b5982eb6a5023b7a000a426fefc207aaf9934c84c1364dc51f3f6079058381fd55672c98cc150622702f83300da25c7a369410488cc2b809a1938778d8d
+  data.tar.gz: d924adb83f5739a791b16d66bdbe580bb0c6712d7d502f14e115a55ebac621884e14a1a97ac46369be4c1de1eabaecc64288e5d0256bc735cef4594b7e41f35c

data/README.md

@@ -47,8 +47,10 @@ Options:
   --results-glob=VALUE              # Allure results files glob. 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)
+  --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
   --[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
@@ -107,8 +109,10 @@ Following CI providers are supported:
 
 It is possible to update pull requests with urls to published reports and execution summary.
 
-- `--update-pr=(comment|description)`: post report urls in pr description or as a comment
-- `--summary=(behaviors/suites/packages/total)`: add execution summary table
+- `--update-pr=(comment|description|actions)`: post report urls in pr description, as a comment or step summary for github actions
+- `--summary=(behaviors|suites|packages|total)`: add execution summary table
+- `--summary-table-type=(ascii|markdown)`: use markdown or ascii table formatting
+- `--[no-]collapse-summary`: add summary in collapsable section
 
 Example:
 

data/lib/allure_report_publisher/commands/upload.rb

@@ -22,7 +22,7 @@ module Publisher
       option :update_pr,
              type: :string,
              desc: "Add report url to PR via comment or description update. Required: false",
-             values: %w[comment description]
+             values: %w[comment description actions]
       option :summary,
              type: :string,
              desc: "Additionally add summary table to PR comment or description. Required: false",
@@ -32,6 +32,14 @@ module Publisher
                Publisher::Helpers::Summary::PACKAGES,
                Publisher::Helpers::Summary::TOTAL
              ]
+      option :summary_table_type,
+             type: :string,
+             desc: "Summary table type. Required: false",
+             default: Publisher::Helpers::Summary::ASCII,
+             values: [
+               Publisher::Helpers::Summary::ASCII,
+               Publisher::Helpers::Summary::MARKDOWN
+             ]
       option :collapse_summary,
              type: :boolean,
              default: false,
@@ -69,7 +77,7 @@ module Publisher
         return unless args[:update_pr] && uploader.pr?
 
         log("Adding reports urls")
-        Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
+        Spinner.spin("updating", exit_on_error: false) { uploader.add_result_summary }
       end
 
       private
@@ -88,7 +96,8 @@ module Publisher
             :prefix,
             :copy_latest,
             :update_pr,
-            :collapse_summary
+            :collapse_summary,
+            :summary_table_type
           )
         )
       end

data/lib/allure_report_publisher/lib/helpers/summary.rb

@@ -9,27 +9,37 @@ module Publisher
       PACKAGES = "packages".freeze
       SUITES = "suites".freeze
       TOTAL = "total".freeze
+      MARKDOWN = :markdown
+      ASCII = :ascii
 
       # Summary table generator
       #
       # @param [String] report_path
       # @param [String] summary_type
-      def initialize(report_path, summary_type)
+      # @param [String] markdown
+      def initialize(report_path, summary_type, table_type = ASCII)
         @report_path = report_path
         @summary_type = summary_type || TOTAL
+        @table_type = table_type
       end
 
       # Summary table
       #
-      # @return [Terminal::Table]
+      # @return [String]
       def table
-        return terminal_table { |table| table << short_summary } if summary_type == TOTAL
-
-        terminal_table do |table|
-          expanded_summary.each { |row| table << row }
-          table << :separator
-          table << short_summary
-        end
+        summary = if summary_type == TOTAL
+                    terminal_table { |table| table << short_summary }
+                  else
+                    terminal_table do |table|
+                      expanded_summary.each { |row| table << row }
+                      table << :separator
+                      table << short_summary
+                    end
+                  end
+
+        return summary.to_s if markdown?
+
+        "```markdown\n#{summary}\n```"
       end
 
       # Test run status emoji
@@ -41,28 +51,36 @@ module Publisher
 
       private
 
-      attr_reader :report_path, :summary_type
+      attr_reader :report_path, :summary_type, :table_type
 
       # Expanded summary table
       #
       # @return [Array<Array>]
       def expanded_summary
         @expanded_summary ||= summary_data.map do |name, summary|
-          [name, *summary.values, status_icon(summary[:passed], summary[:failed], summary[:flaky])]
+          [
+            name,
+            *summary.values,
+            summary[:passed] + summary[:failed] + summary[:skipped],
+            status_icon(summary[:passed], summary[:failed], summary[:flaky])
+          ]
         end
       end
 
       # Short summary table
       #
       # @return [Array<String>]
-      def short_summary
+      def short_summary # rubocop:disable Metrics/MethodLength
         return @short_summary if defined?(@short_summary)
 
-        sum = summary_data.values.each_with_object({ passed: 0, failed: 0, skipped: 0, flaky: 0 }) do |entry, hsh|
+        sum = summary_data.values.each_with_object({
+          passed: 0, failed: 0, skipped: 0, flaky: 0, total: 0
+        }) do |entry, hsh|
           hsh[:passed] += entry[:passed]
           hsh[:failed] += entry[:failed]
           hsh[:skipped] += entry[:skipped]
           hsh[:flaky] += entry[:flaky]
+          hsh[:total] += (entry[:passed] + entry[:failed] + entry[:skipped])
         end
 
         @short_summary = [
@@ -71,6 +89,7 @@ module Publisher
           sum[:failed],
           sum[:skipped],
           sum[:flaky],
+          sum[:total],
           status_icon(sum[:passed], sum[:failed], sum[:flaky])
         ]
       end
@@ -93,8 +112,9 @@ module Publisher
       # @return [Terminal::Table]
       def terminal_table
         Terminal::Table.new do |table|
-          table.title = "#{summary_type} summary"
-          table.headings = ["", "passed", "failed", "skipped", "flaky", "result"]
+          table.title = "#{summary_type} summary" unless markdown?
+          table.style = { border: table_type }
+          table.headings = ["", "passed", "failed", "skipped", "flaky", "total", "result"]
           yield(table)
         end
       end
@@ -133,6 +153,13 @@ module Publisher
 
         summary
       end
+
+      # Render markdown border tables
+      #
+      # @return [Boolean]
+      def markdown?
+        table_type == MARKDOWN
+      end
     end
   end
 end

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

@@ -20,6 +20,7 @@ module Publisher
         @build_name = args[:build_name]
         @sha_url = args[:sha_url]
         @summary_type = args[:summary_type]
+        @summary_table_type = args[:summary_table_type]
         @collapse_summary = args[:collapse_summary]
       end
 
@@ -62,6 +63,7 @@ module Publisher
                   :build_name,
                   :sha_url,
                   :summary_type,
+                  :summary_table_type,
                   :collapse_summary
 
       private
@@ -77,7 +79,7 @@ module Publisher
       #
       # @return [Helpers::Summary]
       def summary
-        @summary ||= Helpers::Summary.new(report_path, summary_type)
+        @summary ||= Helpers::Summary.new(report_path, summary_type, summary_table_type)
       end
 
       # Single job report URL entry
@@ -89,9 +91,9 @@ module Publisher
           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 << summary.table if summary_type
           entry << "</details>" if collapse_summary
-          entry << "<!-- #{build_name} -->"
+          entry << "<!-- #{build_name} -->\n"
 
           entry.join("\n")
         end
@@ -101,7 +103,7 @@ module Publisher
       #
       # @return [RegExp]
       def job_entry_pattern
-        @job_entry_pattern ||= /<!-- #{build_name} -->\n([\s\S]+)\n<!-- #{build_name} -->/
+        @job_entry_pattern ||= /<!-- #{build_name} -->\n([\s\S]+)\n<!-- #{build_name} -->\n/
       end
 
       # Allure report url section

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

@@ -17,14 +17,20 @@ module Publisher
 
       # CI provider base
       #
-      # @param [String] report_url
-      # @param [Boolean] update_pr
-      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
+      # @param [Hash] args
+      # @option args [String] :report_url
+      # @option args [String] :report_path
+      # @option args [Boolean] :update_pr
+      # @option args [String] :summary_type
+      # @option args [Boolean] :collapse_summay
+      # @option args [Symbol] :summary_table_type
+      def initialize(**args)
+        @report_url = args[:report_url]
+        @report_path = args[:report_path]
+        @update_pr = args[:update_pr]
+        @summary_type = args[:summary_type]
+        @summary_table_type = args[:summary_table_type]
+        @collapse_summary = args[:collapse_summary]
       end
 
       # :nocov:
@@ -47,7 +53,7 @@ module Publisher
       # Add report url to pull request description
       #
       # @return [void]
-      def add_report_url
+      def add_result_summary
         raise("Not a pull request, skipped!") unless pr?
         return add_comment if comment?
 
@@ -69,7 +75,8 @@ module Publisher
                   :report_path,
                   :update_pr,
                   :summary_type,
-                  :collapse_summary
+                  :collapse_summary,
+                  :summary_table_type
 
       # Current pull request description
       #
@@ -131,6 +138,7 @@ module Publisher
           build_name: build_name,
           sha_url: sha_url,
           summary_type: summary_type,
+          summary_table_type: summary_table_type,
           collapse_summary: collapse_summary
         )
       end

data/lib/allure_report_publisher/lib/providers/github.rb

@@ -58,6 +58,8 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
+        return File.write(step_summary_file, url_section_builder.comment_body) if actions?
+
         client.update_pull_request(repository, pr_id, body: url_section_builder.updated_pr_description(pr_description))
       end
 
@@ -137,6 +139,26 @@ module Publisher
 
         "[#{short_sha}](#{server_url}/#{repository}/pull/#{pr_id}/commits/#{sha})"
       end
+
+      # Use actions summary for results
+      #
+      # @return [Boolean]
+      def actions?
+        update_pr == "actions"
+      end
+
+      # Github actions summary file
+      #
+      # @return [String]
+      def step_summary_file
+        @step_summary_file ||= begin
+          summary_file = ENV["GITHUB_STEP_SUMMARY"]
+          raise("Environment variable GITHUB_STEP_SUMMARY is empty!") unless summary_file
+          raise("Step summary file '#{summary_file}' does not exist!") unless File.exist?(summary_file)
+
+          summary_file
+        end
+      end
     end
   end
 end

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

@@ -27,6 +27,7 @@ module Publisher
       # @option args [String] :prefix
       # @option args [Boolean] :update_pr
       # @option args [String] :summary_type
+      # @option args [Symbol] :summary_table_type
       # @option args [Boolean] :collapse_summary
       # @option args [String] :copy_latest
       def initialize(**args)
@@ -35,6 +36,7 @@ module Publisher
         @prefix = args[:prefix]
         @update_pr = args[:update_pr]
         @summary_type = args[:summary_type]
+        @summary_table_type = args[:summary_table_type]
         @copy_latest = (Providers.provider && args[:copy_latest]) # copy latest for ci only
         @collapse_summary = args[:collapse_summary]
       end
@@ -45,7 +47,7 @@ module Publisher
       def execute
         generate_report
         upload
-        add_url_to_pr
+        add_result_summary
       end
 
       # Generate allure report
@@ -68,10 +70,10 @@ module Publisher
       # Add allure report url to pull request description
       #
       # @return [void]
-      def add_url_to_pr
+      def add_result_summary
         return unless update_pr && ci_provider
 
-        ci_provider.add_report_url
+        ci_provider.add_result_summary
       end
 
       # Uploaded report urls
@@ -99,7 +101,8 @@ module Publisher
                   :update_pr,
                   :copy_latest,
                   :summary_type,
-                  :collapse_summary
+                  :collapse_summary,
+                  :summary_table_type
 
       def_delegators :report_generator, :results_path, :report_path
 
@@ -200,6 +203,7 @@ module Publisher
           report_path: report_path,
           update_pr: update_pr,
           summary_type: summary_type,
+          summary_table_type: summary_table_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.6.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-26 00:00:00.000000000 Z
+date: 2022-05-29 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.114.0
+        version: 1.115.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.114.0
+        version: 1.115.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -182,28 +196,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.17.0
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -336,14 +350,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.3
+        version: 0.45.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.44.3
+        version: 0.45.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com