allure-report-publisher 0.4.2 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95d9fe3571d7c0a5854a67a41b12167670392acc96301c226588e518a82af6c3
-  data.tar.gz: 681425836f0ae22eb2ddaf92d613fccd3072f33693b55fbbf2ce549c4ee19c8e
+  metadata.gz: 41262f49694d870733005c690d1384d2f95493efe3dd1f4af0f57bdf27871c51
+  data.tar.gz: c4c115289ce0ad2f21adc359b96e6c61d06534227086f9e18808568dfd8dae69
 SHA512:
-  metadata.gz: 5a5461c76b830a1be53fe821519b8f40d355772ad001083f67827e6e62dd7363e593d383073cc98237081f23178fb69e4aa0ddd2d8d551bdb24cfd6473026735
-  data.tar.gz: d02e41c8fdaa9f4e18e3a6e295d25801c8d5d39c57ede1f046e150056e82a7320094b5364a133cc77e37071a3491cce7940cf44ca20a5b7acafc6660664cf290
+  metadata.gz: 8da58fa175adce43b0e8a5a06d7ade6157b99ab8c31f566da1e9cfbc082ee89251da8ba54a3c9bcd37bef72e8554456fd17cb3eecedf839e7864270b6558f3ae
+  data.tar.gz: cdfeefbee4ebdf742614e664e0ab691977b0f5ce4445928ef219bc071a9d98c2410b2ac7b0f69a6a3dd634cf3f3f3731fbf8af7f2a5221279423900176bd84e5

data/README.md

@@ -48,8 +48,9 @@ Options:
   --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)
+  --summary=VALUE                   # Additionally add summary table to PR comment or description. Required: false: (behaviors/suites/packages/total)
   --[no-]copy-latest                # Keep copy of latest report at base prefix path, default: false
-  --[no-]color                      # Toggle color output, default: false
+  --[no-]color                      # Force color output
   --[no-]ignore-missing-results     # Ignore missing allure results, default: false
   --help, -h                        # Print this help
 
@@ -104,9 +105,10 @@ Following CI providers are supported:
 
 ## Pull requests
 
-It is possible to update pull requests with urls to published reports.
+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
 
 Example:
 
@@ -114,9 +116,19 @@ Example:
 
 `# Allure report`
 
-`allure-report-publisher` generated test report for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)!
+`allure-report-publisher` generated test report!
 
-**rspec**: 📝 [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html)
+**rspec**: ✅ [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html) for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)
+
+```markdown
++--------------------------------------------------------+
+|                   total summary                        |
++-----------+--------+--------+---------+-------+--------+
+|           | passed | failed | skipped | flaky | result |
++-----------+--------+--------+---------+-------+--------+
+| Total     | 100    | 0      | 2       | 0     | ✅     |
++-----------+--------+--------+---------+-------+--------+
+```
 
 ---
 

data/lib/allure_report_publisher/commands/upload.rb

@@ -21,16 +21,24 @@ module Publisher
              desc: "Optional prefix for report path. Required: false"
       option :update_pr,
              type: :string,
-             values: %w[comment description],
-             desc: "Add report url to PR via comment or description update. Required: false"
+             desc: "Add report url to PR via comment or description update. Required: false",
+             values: %w[comment description]
+      option :summary,
+             type: :string,
+             desc: "Additionally add summary table to PR comment or description. Required: false",
+             values: [
+               Publisher::Helpers::Summary::BEHAVIORS,
+               Publisher::Helpers::Summary::SUITES,
+               Publisher::Helpers::Summary::PACKAGES,
+               Publisher::Helpers::Summary::TOTAL
+             ]
       option :copy_latest,
              type: :boolean,
              default: false,
              desc: "Keep copy of latest report at base prefix path"
       option :color,
              type: :boolean,
-             default: false,
-             desc: "Toggle color output"
+             desc: "Force color output"
       option :ignore_missing_results,
              type: :boolean,
              default: false,
@@ -42,12 +50,11 @@ module Publisher
       ]
 
       def call(**args)
-        Helpers.pastel(force_color: args[:color] || nil)
+        Helpers.pastel(force_color: args[:color])
+        @args = args
 
-        validate_args(args)
-        validate_result_files(args[:results_glob], args[:ignore_missing_results])
-
-        uploader = uploaders(args[:type]).new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
+        validate_args
+        validate_result_files
 
         log("Generating allure report")
         Spinner.spin("generating") { uploader.generate_report }
@@ -63,6 +70,24 @@ module Publisher
 
       private
 
+      attr_reader :args
+
+      # Uploader instance
+      #
+      # @return [Publisher::Uploaders::Uploader]
+      def uploader
+        @uploader ||= uploaders(args[:type]).new(
+          summary_type: args[:summary],
+          **args.slice(
+            :results_glob,
+            :bucket,
+            :prefix,
+            :copy_latest,
+            :update_pr
+          )
+        )
+      end
+
       # Uploader class
       #
       # @param [String] uploader
@@ -76,9 +101,8 @@ module Publisher
 
       # Validate required args
       #
-      # @param [Hash] args
       # @return [void]
-      def validate_args(args)
+      def validate_args
         error("Missing argument --results-glob!") unless args[:results_glob]
         error("Missing argument --bucket!") unless args[:bucket]
       end
@@ -87,7 +111,9 @@ module Publisher
       #
       # @param [String] results_glob
       # @return [void]
-      def validate_result_files(results_glob, ignore)
+      def validate_result_files
+        results_glob = args[:results_glob]
+        ignore = args[:ignore_missing_results]
         return unless Dir.glob(results_glob).empty?
 
         log("Glob '#{results_glob}' did not match any files!", ignore ? :yellow : :red)

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

@@ -0,0 +1,133 @@
+require "terminal-table"
+
+module Publisher
+  module Helpers
+    # Test summary table generator
+    #
+    class Summary
+      BEHAVIORS = "behaviors".freeze
+      PACKAGES = "packages".freeze
+      SUITES = "suites".freeze
+      TOTAL = "total".freeze
+
+      # Summary table generator
+      #
+      # @param [String] report_path
+      # @param [String] summary_type
+      def initialize(report_path, summary_type)
+        @report_path = report_path
+        @summary_type = summary_type || TOTAL
+      end
+
+      # Summary table
+      #
+      # @return [Terminal::Table]
+      def table
+        return terminal_table([short_summary]) if summary_type == TOTAL
+
+        terminal_table(expanded_summary)
+      end
+
+      # Test run status emoji
+      #
+      # @return [String]
+      def status
+        short_summary.last
+      end
+
+      private
+
+      attr_reader :report_path, :summary_type
+
+      # Expanded summary table
+      #
+      # @return [Array<Array>]
+      def expanded_summary
+        @expanded_summary ||= summary_data.map do |name, summary|
+          [name, *summary.values, status_icon(summary[:failed], summary[:flaky])]
+        end
+      end
+
+      # Short summary table
+      #
+      # @return [Array<String>]
+      def short_summary
+        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|
+          hsh[:passed] += entry[:passed]
+          hsh[:failed] += entry[:failed]
+          hsh[:skipped] += entry[:skipped]
+          hsh[:flaky] += entry[:flaky]
+        end
+
+        @short_summary = [
+          "Total",
+          sum[:passed],
+          sum[:failed],
+          sum[:skipped],
+          sum[:flaky],
+          status_icon(sum[:failed], sum[:flaky])
+        ]
+      end
+
+      # Status icon based on run results
+      #
+      # @param [Integer] failed
+      # @param [Integer] flaky
+      # @return [String]
+      def status_icon(failed, flaky)
+        return flaky.zero? ? "✅" : "⚠️" if failed.zero?
+
+        "❌"
+      end
+
+      # Summary terminal table
+      #
+      # @param [Array] rows
+      # @return [Terminal::Table]
+      def terminal_table(rows)
+        Terminal::Table.new do |table|
+          table.title = "#{summary_type} summary"
+          table.headings = ["", "passed", "failed", "skipped", "flaky", "result"]
+          table.rows = rows
+        end
+      end
+
+      # Data json
+      #
+      # @return [Hash]
+      def data_json
+        @data_json ||= JSON.parse(
+          File.read(File.join(report_path, "data", "#{summary_type == TOTAL ? SUITES : summary_type}.json")),
+          symbolize_names: true
+        )
+      end
+
+      # Summary data
+      #
+      # @return [Hash<Hash>]
+      def summary_data
+        data_json[:children].each_with_object({}) do |entry, result|
+          result[entry[:name]] = fetch_results(entry)
+        end
+      end
+
+      # Fetch test results
+      #
+      # @param [Hash] entry
+      # @param [Hash] summary
+      # @return [Hash]
+      def fetch_results(entry, summary = { passed: 0, failed: 0, skipped: 0, flaky: 0 })
+        entry[:children].each { |item| fetch_results(item, summary) } if entry.key?(:children)
+
+        summary[:passed] += 1 if entry[:status] == "passed"
+        summary[:skipped] += 1 if entry[:status] == "skipped"
+        summary[:flaky] += 1 if entry[:flaky]
+        summary[:failed] += 1 if %w[failed broken].include?(entry[:status])
+
+        summary
+      end
+    end
+  end
+end

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

@@ -0,0 +1,131 @@
+module Publisher
+  module Helpers
+    # Urls section builder
+    #
+    class UrlSectionBuilder
+      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
+      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/.freeze
+
+      # Url section builder
+      #
+      # @param [String] report_url
+      # @param [String] report_path
+      # @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
+      end
+
+      # Matches url section pattern
+      #
+      # @param [String] urls_block
+      # @return [Boolean]
+      def self.match?(urls_block)
+        urls_block.match?(DESCRIPTION_PATTERN)
+      end
+
+      # PR description with allure report urls
+      #
+      # @param [String] pr_description
+      # @return [String]
+      def updated_pr_description(pr_description)
+        stripped_description = (pr_description || "").strip
+
+        return url_section(separator: false) if stripped_description == ""
+        return "#{pr_description}\n\n#{url_section}" unless pr_description.match?(DESCRIPTION_PATTERN)
+
+        job_entries = jobs_section(pr_description)
+        non_empty = stripped_description != pr_description.match(DESCRIPTION_PATTERN)[0]
+        pr_description.gsub(DESCRIPTION_PATTERN, url_section(job_entries: job_entries, separator: non_empty))
+      end
+
+      # Comment body with allure report urls
+      #
+      # @param [String] pr_comment
+      # @return [String]
+      def comment_body(pr_comment = nil)
+        return url_section(separator: false) unless pr_comment
+
+        job_entries = jobs_section(pr_comment)
+        url_section(job_entries: job_entries, separator: false)
+      end
+
+      attr_reader :report_url,
+                  :report_path,
+                  :build_name,
+                  :sha_url,
+                  :summary_type
+
+      private
+
+      # Url section heading
+      #
+      # @return [String]
+      def heading
+        @heading ||= "# Allure report\n`allure-report-publisher` generated test report!"
+      end
+
+      # Test run summary
+      #
+      # @return [Helpers::Summary]
+      def summary
+        @summary ||= Helpers::Summary.new(report_path, summary_type)
+      end
+
+      # Single job report URL entry
+      #
+      # @return [String]
+      def job_entry
+        @job_entry ||= begin
+          entry = ["<!-- #{build_name} -->"]
+          entry << "**#{build_name}**: #{summary.status} [test report](#{report_url}) for #{sha_url}"
+          entry << "```markdown\n#{summary.table}\n```" if summary_type
+          entry << "<!-- #{build_name} -->"
+
+          entry.join("\n")
+        end
+      end
+
+      # Job entry pattern
+      #
+      # @return [RegExp]
+      def job_entry_pattern
+        @job_entry_pattern ||= /<!-- #{build_name} -->\n([\s\S]+)\n<!-- #{build_name} -->/
+      end
+
+      # Allure report url section
+      #
+      # @return [String]
+      def url_section(job_entries: job_entry, separator: true)
+        reports = <<~BODY.strip
+          <!-- allure -->
+          ---
+          #{heading}
+
+          <!-- jobs -->
+          #{job_entries}
+          <!-- jobs -->
+          <!-- allurestop -->
+        BODY
+
+        separator ? reports : reports.gsub("---\n", "")
+      end
+
+      # Return updated jobs section
+      #
+      # @param [String] urls
+      # @return [String]
+      def jobs_section(urls_block)
+        jobs = urls_block.match(JOBS_PATTERN)[1]
+        return jobs.gsub(job_entry_pattern, job_entry) if jobs.match?(job_entry_pattern)
+
+        "#{jobs}\n#{job_entry}"
+      end
+    end
+  end
+end

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

@@ -15,9 +15,15 @@ module Publisher
     class Provider
       ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
 
-      def initialize(report_url:, update_pr:)
+      # CI provider base
+      #
+      # @param [String] report_url
+      # @param [Boolean] update_pr
+      def initialize(report_url:, report_path:, update_pr:, summary_type:)
         @report_url = report_url
+        @report_path = report_path
         @update_pr = update_pr
+        @summary_type = summary_type
       end
 
       # :nocov:
@@ -58,7 +64,10 @@ module Publisher
 
       private
 
-      attr_reader :report_url, :update_pr
+      attr_reader :report_url,
+                  :report_path,
+                  :update_pr,
+                  :summary_type
 
       # Current pull request description
       #
@@ -113,8 +122,14 @@ module Publisher
       # Report urls section creator
       #
       # @return [ReportUrls]
-      def report_urls
-        @report_urls ||= UrlSectionBuilder.new(report_url: report_url, build_name: build_name, sha_url: sha_url)
+      def url_section_builder
+        @url_section_builder ||= Helpers::UrlSectionBuilder.new(
+          report_url: report_url,
+          report_path: report_path,
+          build_name: build_name,
+          sha_url: sha_url,
+          summary_type: summary_type
+        )
       end
     end
   end

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

@@ -58,16 +58,16 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_pull_request(repository, pr_id, body: report_urls.updated_pr_description(pr_description))
+        client.update_pull_request(repository, pr_id, body: url_section_builder.updated_pr_description(pr_description))
       end
 
       # Add comment with report url
       #
       # @return [void]
       def add_comment
-        return client.add_comment(repository, pr_id, report_urls.comment_body) unless comment
+        return client.add_comment(repository, pr_id, url_section_builder.comment_body) unless comment
 
-        client.update_comment(repository, comment[:id], report_urls.comment_body(comment[:body]))
+        client.update_comment(repository, comment[:id], url_section_builder.comment_body(comment[:body]))
       end
 
       # Existing comment with allure urls
@@ -75,7 +75,7 @@ module Publisher
       # @return [Sawyer::Resource]
       def comment
         @comment ||= client.issue_comments(repository, pr_id).detect do |comment|
-          UrlSectionBuilder.match?(comment[:body])
+          Helpers::UrlSectionBuilder.match?(comment[:body])
         end
       end
 

data/lib/allure_report_publisher/lib/providers/gitlab.rb

@@ -48,16 +48,20 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_merge_request(project, mr_iid, description: report_urls.updated_pr_description(pr_description))
+        client.update_merge_request(
+          project,
+          mr_iid,
+          description: url_section_builder.updated_pr_description(pr_description)
+        )
       end
 
       # Add comment with report url
       #
       # @return [void]
       def add_comment
-        return client.create_merge_request_comment(project, mr_iid, report_urls.comment_body) unless comment
+        return client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body) unless comment
 
-        client.edit_merge_request_note(project, mr_iid, comment.id, report_urls.comment_body(comment.body))
+        client.edit_merge_request_note(project, mr_iid, comment.id, url_section_builder.comment_body(comment.body))
       end
 
       # Existing comment with allure urls
@@ -65,7 +69,7 @@ module Publisher
       # @return [Gitlab::ObjectifiedHash]
       def comment
         client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
-          UrlSectionBuilder.match?(comment.body)
+          Helpers::UrlSectionBuilder.match?(comment.body)
         end
       end
 

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,10 +10,8 @@ module Publisher
   class ReportGenerator
     include Helpers
 
-    def initialize(results_glob, results_path, report_path)
+    def initialize(results_glob)
       @results_glob = results_glob
-      @results_path = results_path
-      @report_path = report_path
     end
 
     # Generate allure report
@@ -24,9 +22,23 @@ module Publisher
       generate_report
     end
 
+    # Aggregated results directory
+    #
+    # @return [String]
+    def results_path
+      @results_path ||= Dir.mktmpdir("allure-results")
+    end
+
+    # Allure report directory
+    #
+    # @return [String]
+    def report_path
+      @report_path ||= Dir.mktmpdir("allure-report")
+    end
+
     private
 
-    attr_reader :results_glob, :results_path, :report_path
+    attr_reader :results_glob
 
     # Copy all results files to results directory
     #

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

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Publisher
   module Uploaders
     class HistoryNotFoundError < StandardError; end
@@ -6,6 +8,7 @@ module Publisher
     #
     class Uploader
       include Helpers
+      extend Forwardable
 
       EXECUTOR_JSON = "executor.json".freeze
       HISTORY = [
@@ -16,11 +19,12 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob:, bucket:, update_pr: nil, prefix: nil, copy_latest: false)
+      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
       end
 
@@ -40,7 +44,7 @@ module Publisher
         add_history
         add_executor_info
 
-        ReportGenerator.new(results_glob, results_path, report_path).generate
+        report_generator.generate
       end
 
       # Upload report to storage provider
@@ -78,7 +82,14 @@ module Publisher
 
       private
 
-      attr_reader :results_glob, :bucket_name, :prefix, :update_pr, :copy_latest
+      attr_reader :results_glob,
+                  :bucket_name,
+                  :prefix,
+                  :update_pr,
+                  :copy_latest,
+                  :summary_type
+
+      def_delegators :report_generator, :results_path, :report_path
 
       # :nocov:
 
@@ -132,34 +143,31 @@ module Publisher
       end
       # :nocov:
 
-      # Add allure history
+      # Allure report generator
       #
-      # @return [void]
-      def add_history
-        create_history_dir
-        download_history
-      rescue HistoryNotFoundError
-        nil
+      # @return [Publisher::ReportGenerator]
+      def report_generator
+        @report_generator ||= ReportGenerator.new(results_glob)
       end
 
-      # Add CI executor info
+      # Report path prefix
       #
-      # @return [void]
-      def add_executor_info
-        return unless ci_provider
+      # @return [String]
+      def full_prefix
+        @full_prefix ||= [prefix, run_id].compact.yield_self do |pre|
+          break if pre.empty?
 
-        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
-          file.write(ci_provider.executor_info.to_json)
+          pre.join("/")
         end
       end
 
-      # Run upload commands
+      # Report files
       #
-      # @return [void]
-      def run_uploads
-        upload_history unless !run_id || copy_latest
-        upload_report
-        upload_latest_copy if copy_latest
+      # @return [Array<Pathname>]
+      def report_files
+        @report_files ||= Pathname
+                          .glob("#{report_path}/**/*")
+                          .reject(&:directory?)
       end
 
       # Get run id
@@ -175,48 +183,47 @@ module Publisher
       def ci_provider
         return @ci_provider if defined?(@ci_provider)
 
-        @ci_provider = Providers.provider&.new(report_url: report_url, update_pr: update_pr)
+        @ci_provider = Providers.provider&.new(
+          report_url: report_url,
+          report_path: report_path,
+          update_pr: update_pr,
+          summary_type: summary_type
+        )
       end
 
-      # Fetch allure report history
+      # Add allure history
       #
       # @return [void]
-      def create_history_dir
-        FileUtils.mkdir_p(path(results_path, "history"))
+      def add_history
+        create_history_dir
+        download_history
+      rescue HistoryNotFoundError
+        nil
       end
 
-      # Report path prefix
+      # Add CI executor info
       #
-      # @return [String]
-      def full_prefix
-        @full_prefix ||= [prefix, run_id].compact.yield_self do |pre|
-          break if pre.empty?
-
-          pre.join("/")
-        end
-      end
+      # @return [void]
+      def add_executor_info
+        return unless ci_provider
 
-      # Aggregated results directory
-      #
-      # @return [String]
-      def results_path
-        @results_path ||= Dir.mktmpdir("allure-results")
+        File.write("#{results_path}/#{EXECUTOR_JSON}", ci_provider.executor_info.to_json)
       end
 
-      # Allure report directory
+      # Run upload commands
       #
-      # @return [String]
-      def report_path
-        @report_path ||= Dir.mktmpdir("allure-report")
+      # @return [void]
+      def run_uploads
+        upload_history unless !run_id || copy_latest
+        upload_report
+        upload_latest_copy if copy_latest
       end
 
-      # Report files
+      # Fetch allure report history
       #
-      # @return [Array<Pathname>]
-      def report_files
-        @report_files ||= Pathname
-                          .glob("#{report_path}/**/*")
-                          .reject(&:directory?)
+      # @return [void]
+      def create_history_dir
+        FileUtils.mkdir_p(path(results_path, "history"))
       end
     end
   end

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

@@ -1,4 +1,5 @@
 require "aws-sdk-s3"
+require "mini_mime"
 
 module Publisher
   module Uploaders
@@ -88,7 +89,8 @@ module Publisher
           {
             body: File.new(file),
             bucket: bucket_name,
-            key: key(key_prefix, file.relative_path_from(report_path))
+            key: key(key_prefix, file.relative_path_from(report_path)),
+            content_type: MiniMime.lookup_by_filename(file).content_type
           }
         end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-04-15 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.110.0
+        version: 1.114.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.110.0
+        version: 1.114.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.31'
+- !ruby/object:Gem::Dependency
+  name: mini_mime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +148,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +176,174 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: allure-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.44.3
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com
@@ -163,10 +359,11 @@ files:
 - lib/allure_report_publisher/commands/version.rb
 - lib/allure_report_publisher/lib/helpers/helpers.rb
 - lib/allure_report_publisher/lib/helpers/spinner.rb
+- lib/allure_report_publisher/lib/helpers/summary.rb
+- lib/allure_report_publisher/lib/helpers/url_section_builder.rb
 - lib/allure_report_publisher/lib/providers/_provider.rb
 - lib/allure_report_publisher/lib/providers/github.rb
 - lib/allure_report_publisher/lib/providers/gitlab.rb
-- lib/allure_report_publisher/lib/providers/url_section_builder.rb
 - lib/allure_report_publisher/lib/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/gcs.rb
@@ -197,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Allure report uploader

data/lib/allure_report_publisher/lib/providers/url_section_builder.rb

@@ -1,97 +0,0 @@
-module Publisher
-  module Providers
-    # Urls section builder
-    #
-    class UrlSectionBuilder
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
-      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/.freeze
-
-      def initialize(report_url:, build_name:, sha_url:)
-        @report_url = report_url
-        @build_name = build_name
-        @sha_url = sha_url
-      end
-
-      # Matches url section pattern
-      #
-      # @param [String] urls_block
-      # @return [Boolean]
-      def self.match?(urls_block)
-        urls_block.match?(DESCRIPTION_PATTERN)
-      end
-
-      # Get urls for PR update
-      #
-      # @param [String] pr
-      # @return [String]
-      def updated_pr_description(pr_description)
-        return "#{pr_description}\n\n#{body}" unless pr_description.match?(DESCRIPTION_PATTERN)
-
-        job_entries = jobs_section(pr_description)
-        pr_description.gsub(DESCRIPTION_PATTERN, body(job_entries))
-      end
-
-      # Allure report url comment
-      #
-      # @return [String]
-      def comment_body(pr_comment = nil)
-        return body.gsub("---\n", "") unless pr_comment
-
-        job_entries = jobs_section(pr_comment)
-        body(job_entries).gsub("---\n", "")
-      end
-
-      attr_reader :report_url, :build_name, :sha_url
-
-      private
-
-      # Allure report url pr description
-      #
-      # @return [String]
-      def body(job_entries = job_entry)
-        @body ||= <<~BODY.strip
-          <!-- allure -->
-          ---
-          #{heading}
-
-          <!-- jobs -->
-          #{job_entries}
-          <!-- jobs -->
-          <!-- allurestop -->
-        BODY
-      end
-
-      # Url section heading
-      #
-      # @return [String]
-      def heading
-        @heading ||= "# Allure report\n`allure-report-publisher` generated test report for #{sha_url}!"
-      end
-
-      # Return updated jobs section
-      #
-      # @param [String] urls
-      # @return [String]
-      def jobs_section(urls_block)
-        jobs = urls_block.match(JOBS_PATTERN)[1]
-        return jobs.gsub(job_entry_pattern, job_entry) if jobs.match?(job_entry_pattern)
-
-        "#{jobs}\n#{job_entry}"
-      end
-
-      # Single job report URL entry
-      #
-      # @return [String]
-      def job_entry
-        @job_entry ||= "**#{build_name}**: 📝 [test report](#{report_url})<br />"
-      end
-
-      # Job entry pattern
-      #
-      # @return [RegExp]
-      def job_entry_pattern
-        @job_entry_pattern ||= %r{^\*\*#{build_name}\*\*:.*\[test report\]\(.*\)<br />$}
-      end
-    end
-  end
-end