allure-report-publisher 3.2.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13fcb7c7d00d54bffa1cab27e27573332a4fd42fc0ff6f54c4e4f7985a2d57b
-  data.tar.gz: 917e091dea4e5f771e6b3386712684335c8cd15ee448f09b4e1a486e88cde874
+  metadata.gz: 88a8af3196d423a0ee46ce8767c747d4cf4ba67619b68ae3bb828782ff2643c1
+  data.tar.gz: f91b7a7c58681a49c425bc37dca27e14c94b2fdd00d0c91253ec930ae79eab63
 SHA512:
-  metadata.gz: 1b2cdb3075fbe04af803e5827a71f0eb6d89dc4a411a9479abb6bdce062e47efb6768a0465a1196184fe3254a0214e14aef3e92b5202acfafd32485251279279
-  data.tar.gz: 3065ba9869d235de689bae099513f0c3c8e074c5d0990521c492d1081f1d66b4aa733108d13af41a8de7c96c6cf02a9743624059cb29036161a4c9665b79e7a6
+  metadata.gz: 24ea145d15bc5968d653c4b1859f5870a8be44450fecad9c69779245e98ef9669f4ee920246f4279a5149888ac78e835396fa44e43cad948f43ac83a0578a6d4
+  data.tar.gz: e25c227fe4fdaddb073bf364fcbff7c71f7345449b336859b926f488d754c82aaf7f9d6a257fd74e341871f42b068823a8d4c3dc7b0e64a7c80551644b43eff9

data/README.md

@@ -5,7 +5,6 @@
 ![Workflow status](https://github.com/andrcuns/allure-report-publisher/workflows/Test/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/maintainability)](https://codeclimate.com/github/andrcuns/allure-report-publisher/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/test_coverage)](https://codeclimate.com/github/andrcuns/allure-report-publisher/test_coverage)
-[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html)
 
 Upload your report to a file storage of your choice.
 
@@ -57,7 +56,6 @@ Options:
   --[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
-  --[no-]unresolved-discussion-on-failure  # Add an unresolved discussion comment on test failure. GitLab only, default: false
   --[no-]debug                      # Print additional debug output, default: false
   --help, -h                        # Print this help
 

data/lib/allure_report_publisher/commands/upload.rb

@@ -76,10 +76,6 @@ module Publisher
              type: :boolean,
              default: false,
              desc: "Ignore missing allure results"
-      option :unresolved_discussion_on_failure,
-             type: :boolean,
-             default: false,
-             desc: "Add an unresolved discussion comment on test failure. GitLab only"
       option :debug,
              type: :boolean,
              default: false,
@@ -134,7 +130,6 @@ module Publisher
             :collapse_summary,
             :flaky_warning_status,
             :summary_table_type,
-            :unresolved_discussion_on_failure,
             :report_title
           )
         )
@@ -148,13 +143,14 @@ module Publisher
         {
           "s3" => Uploaders::S3,
           "gcs" => Uploaders::GCS
-        }[uploader]
+        }.fetch(uploader)
       end
 
       # Validate required args
       #
       # @return [void]
       def validate_args
+        error("Unsupported cloud storage type! Supported types are: s3, gcs") unless %w[s3 gcs].include?(args[:type])
         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]

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

@@ -4,7 +4,7 @@ module Publisher
     #
     class UrlSectionBuilder
       DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/
-      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/
+      JOBS_PATTERN = /<!-- jobs -->(?<jobs>[\s\S]+)<!-- jobs -->/
 
       # Url section builder
       #
@@ -106,7 +106,7 @@ module Publisher
           entry << "<summary>expand test summary</summary>\n" if collapse_summary
           entry << summary.table if summary_type
           entry << "</details>" if collapse_summary
-          entry << "<!-- #{build_name} -->\n"
+          entry << "<!-- #{build_name} -->"
 
           entry.join("\n")
         end
@@ -116,36 +116,31 @@ module Publisher
       #
       # @return [RegExp]
       def job_entry_pattern
-        @job_entry_pattern ||= /<!-- #{build_name} -->\n([\s\S]+)\n<!-- #{build_name} -->\n/
+        @job_entry_pattern ||= /<!-- #{build_name} -->[\s\S]+<!-- #{build_name} -->/
       end
 
       # Allure report url section
       #
       # @return [String]
       def url_section(job_entries: job_entry, separator: true)
-        reports = <<~BODY.strip
-          <!-- allure -->
-          ---
-          #{heading}
-
+        <<~BODY.strip
+          <!-- allure -->#{separator ? "\n---\n" : "\n"}#{heading}\n
           <!-- jobs -->
           #{job_entries}
           <!-- jobs -->
           <!-- allurestop -->
         BODY
-
-        separator ? reports : reports.gsub("---\n", "")
       end
 
       # Return updated jobs section
       #
-      # @param [String] urls
+      # @param [String] body
       # @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)
+      def jobs_section(body)
+        jobs = body.match(JOBS_PATTERN)[:jobs]
+        return jobs.gsub(job_entry_pattern, job_entry).strip if jobs.match?(job_entry_pattern)
 
-        "#{jobs}\n#{job_entry}"
+        "#{jobs.strip}\n#{job_entry}"
       end
     end
   end

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

@@ -33,7 +33,6 @@ module Publisher
       # @option args [Symbol] :summary_table_type
       # @option args [Boolean] :collapse_summay
       # @option args [Boolean] :flaky_warning_status
-      # @option args [Boolean] :unresolved_discussion_on_failure
       # @option args [String] :report_title
       def initialize(**args)
         @report_url = args[:report_url]
@@ -43,7 +42,6 @@ module Publisher
         @summary_table_type = args[:summary_table_type]
         @collapse_summary = args[:collapse_summary]
         @flaky_warning_status = args[:flaky_warning_status]
-        @unresolved_discussion_on_failure = args[:unresolved_discussion_on_failure]
         @report_title = args[:report_title]
       end
 
@@ -65,7 +63,6 @@ module Publisher
                   :collapse_summary,
                   :summary_table_type,
                   :flaky_warning_status,
-                  :unresolved_discussion_on_failure,
                   :report_title
 
       # Current pull request description

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

@@ -38,23 +38,6 @@ module Publisher
         @pr_description ||= client.merge_request(project, mr_iid).description
       end
 
-      # Comment with alert text
-      #
-      # @return [Gitlab::ObjectifiedHash]
-      def alert_comment
-        @alert_comment ||= discussion&.notes&.detect do |note|
-          note.body.include?(alert_comment_text)
-        end
-      end
-
-      # Text for alert comment
-      #
-      # @return [String]
-      def alert_comment_text
-        @alert_comment_text ||=
-          env("ALLURE_FAILURE_ALERT_COMMENT") || "There are some test failures that need attention"
-      end
-
       # Custom sha
       #
       # @return [String]
@@ -96,39 +79,19 @@ module Publisher
       # @return [void]
       def add_comment
         create_or_update_comment
-        create_or_resolve_discussion
       end
 
       # Create or update comment with report url
       #
       # @return [void]
       def create_or_update_comment
-        if main_comment
-          log_debug("Updating summary in comment with id #{discussion.id} in mr !#{mr_iid}")
-
-          return client.edit_merge_request_note(
-            project,
-            mr_iid,
-            main_comment.id,
-            url_section_builder.comment_body(main_comment.body)
-          )
+        unless comment
+          log_debug("Creating comment with summary for mr !#{mr_iid}")
+          return client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body) unless comment
         end
 
-        log_debug("Creating comment with summary for mr ! #{mr_iid}")
-        client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body)
-      end
-
-      # Create or resolve comment discussion
-      #
-      # @return [void]
-      def create_or_resolve_discussion
-        @discussion = nil
-
-        if unresolved_discussion_on_failure && report_has_failures? && !alert_comment
-          client.create_merge_request_discussion_note(project, mr_iid, discussion.id, body: alert_comment_text)
-        elsif alert_comment && !report_has_failures?
-          client.delete_merge_request_discussion_note(project, mr_iid, discussion.id, alert_comment.id)
-        end
+        log_debug("Creating comment with summary for mr !#{mr_iid}")
+        client.edit_merge_request_note(project, mr_iid, comment.id, url_section_builder.comment_body(comment.body))
       end
 
       # Check if allure report has failures
@@ -138,21 +101,14 @@ module Publisher
         main_comment&.body&.include?("❌")
       end
 
-      # Existing discussion that has comment with allure urls
+      # Existing comment with allure urls
       #
       # @return [Gitlab::ObjectifiedHash]
-      def discussion
-        @discussion ||= client.merge_request_discussions(project, mr_iid).auto_paginate.detect do |discussion|
-          discussion.notes.any? { |note| Helpers::UrlSectionBuilder.match?(note.body) }
+      def comment
+        client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
+          Helpers::UrlSectionBuilder.match?(comment.body)
         end
       end
-
-      # Comment/note with allure urls
-      #
-      # @return [Gitlab::ObjectifiedHash]
-      def main_comment
-        discussion&.notes&.detect { |note| Helpers::UrlSectionBuilder.match?(note.body) }
-      end
     end
   end
 end

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

@@ -31,8 +31,8 @@ module Publisher
       def client_args
         @client_args ||= {
           region: ENV["AWS_REGION"] || "us-east-1",
-          force_path_style: ENV["AWS_FORCE_PATH_STYLE"] == "true",
-          endpoint: ENV["AWS_ENDPOINT"]
+          force_path_style: path_style?,
+          endpoint: aws_endpoint
         }.compact
       end
 
@@ -43,6 +43,20 @@ module Publisher
         @latest_report_url ||= url(prefix)
       end
 
+      # Custom aws endpoint
+      #
+      # @return [<String, nil>]
+      def aws_endpoint
+        @aws_endpoint ||= ENV["AWS_ENDPOINT"]
+      end
+
+      # Force aws path style
+      #
+      # @return [Boolean]
+      def path_style?
+        ENV["AWS_FORCE_PATH_STYLE"] == "true"
+      end
+
       # Add allure history
       #
       # @return [void]
@@ -143,7 +157,15 @@ module Publisher
       # @param [String] path_prefix
       # @return [String]
       def url(path_prefix)
-        [base_url || "http://#{bucket_name}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
+        custom_base = if aws_endpoint
+                        path_style? ? "#{aws_endpoint}/#{bucket_name}" : aws_endpoint
+                      end
+
+        [
+          base_url || custom_base || "http://#{bucket_name}.s3.amazonaws.com",
+          path_prefix,
+          "index.html"
+        ].compact.join("/")
       end
 
       # Get file content type

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-06-09 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.144.0
+        version: 1.153.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.144.0
+        version: 1.153.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -235,7 +235,6 @@ homepage: https://github.com/andrcuns/allure-report-uploader
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/andrcuns/allure-report-uploader
   source_code_uri: https://github.com/andrcuns/allure-report-uploader
   changelog_uri: https://github.com/andrcuns/allure-report-uploader/releases
   documentation_uri: https://github.com/andrcuns/allure-report-uploader/blob/master/README.md
@@ -249,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="