allure-report-publisher 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e668a0aee13c1d2edab3fee43da526050512d0566f6635116a8ab3ac36478040
-  data.tar.gz: 724e24dbdc7eb7a1c481c548347eed2c5e07de5f50b1e094d24a25daf37e31df
+  metadata.gz: 3d33ea0e4d124c07ae275376e075ab14d3bcfedc7b5d71fdd23b78882e436c09
+  data.tar.gz: 94d3d70c631aeb9b79aa71fbd18cc920f95cfbe29320c12166d81d1de913cc7a
 SHA512:
-  metadata.gz: fbef301794bb94eaeb405fc8e671a474c4f71076fcebb10ad7ed913d758e08d650ee0589093e1f2c4b96efb733f342b2f4564c1c5e2b73227b00df81ca8773af
-  data.tar.gz: ab5c493d8b61e7e04db967b397511610747091b5f7b3aa1554a7ef9eeb0bbd01554f6c527961e1dd834bfbfe1794100113b3feea97d6c9ea1905dff055a0b6c0
+  metadata.gz: e4ba711128088e03fdf2a0f77e9890d33b6eee5e5e1671b613203e2700fdbd715e690ddf4964bcc82762f144560e83333af7e46f22d82c6c96b408f931a33830
+  data.tar.gz: 2b263c7e7e48d244f30df4efec6358599f31f79f832888a6083b7d3c2dbdaa40458f0216e13142ac9004f20be3efc58c9d2b9f87f57a500da662791ef68151a9

data/README.md

@@ -49,6 +49,8 @@ Options:
   --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)
   --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
@@ -108,7 +110,9 @@ 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
+- `--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

@@ -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,
@@ -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,7 +91,7 @@ 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} -->\n"
 

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:
@@ -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/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
@@ -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.2"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3