allure-report-publisher 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07a7cbb97bb51a2b34c181118b0f3dab1e8f8dda56bb1f5e54bd9edbd8ef1dbc
-  data.tar.gz: 415d123215bb47736b34c8db0357fd5582e47f0dd682b7591a96fb35bd045df3
+  metadata.gz: ee22a2a52b71b269de3fb6edd02c444b3bf6e553f051bd1e8b495f6cffbb2b80
+  data.tar.gz: e87c8cec9aa3c444cb7d2225d9cc401a9c7f39d0940ed5b57ca8a5d5a2368f77
 SHA512:
-  metadata.gz: 1e49a526285c93956391579ed1f40583e28f92ecdb03032632277c7a747cc8ab7971df2ca2b6e92d9b3eafa566e209c42d5173211d77f6487b3a6c9436f81b33
-  data.tar.gz: 26e2179fa6ad5037c0a9aad9b2c37ffd1d37d70af316cce9cc00cd7dc074eefe9819373ec4594a4507b130f72688298ca566682d6e6ea177a442015f3e56f235
+  metadata.gz: 472478dd1264503de2409b2eb6c2b9fb5239624aff499987d5741ca6ee3d22a9c7397dc85c1af3b9718b7fbfbbcfe1d842e48d1350452877041a40829f59bdc3
+  data.tar.gz: e24e932b8dd7d05e651dcb4622fd50381bde03f931547160918c6ff25b943f858b8e9f19291d5db7da2635d5926faf5fac2d43d33bf38c48d37c3cc77fd55b9b

data/README.md

@@ -54,6 +54,7 @@ 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
 
@@ -157,10 +158,14 @@ Following environment variables can override default CI values:
 
 Additional configuration is done via environment variables
 
+### Authentication
+
 Authentication for MR updates:
 
 - `GITLAB_AUTH_TOKEN`: gitlab access token with api access
 
+### CI values
+
 Following environment variables can override default CI values:
 
 - `ALLURE_JOB_NAME`: overrides default `CI_JOB_NAME` value which is used as name for report url section
@@ -171,6 +176,12 @@ In case merge request triggers a downstream pipeline yet you want to update orig
 - `ALLURE_MERGE_REQUEST_IID`: overrides default `CI_MERGE_REQUEST_IID` value
 - `ALLURE_COMMIT_SHA`: overrides default `CI_MERGE_REQUEST_SOURCE_BRANCH_SHA` or `CI_COMMIT_SHA` values
 
+### Summary comment behavior
+
+If reporter is executed with options `--update-pr=comment` and `--unresolved-discussion-on-failure`, it's possible to additionally configure the unresolved discussion note:
+
+- `ALLURE_FAILURE_ALERT_COMMENT`: comment added to create unresolved discussion note, default: `There are some test failures that need attention`
+
 # Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/allure_report_publisher/commands/upload.rb

@@ -60,6 +60,10 @@ 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,
@@ -104,7 +108,8 @@ module Publisher
             :copy_latest,
             :update_pr,
             :collapse_summary,
-            :summary_table_type
+            :summary_table_type,
+            :unresolved_discussion_on_failure
           )
         )
       end

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

@@ -54,6 +54,16 @@ module Publisher
       end
     end
 
+    # Return non empty environment variable value
+    #
+    # @param [String] name
+    # @return [String, nil]
+    def env(name)
+      return unless ENV[name] && !ENV[name].empty?
+
+      ENV[name]
+    end
+
     # Colorize string
     #
     # @param [String] message

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

@@ -23,6 +23,7 @@ module Publisher
       # @option args [Boolean] :update_pr
       # @option args [String] :summary_type
       # @option args [Boolean] :collapse_summay
+      # @option args [Boolean] :unresolved_discussion_on_failure
       # @option args [Symbol] :summary_table_type
       def initialize(**args)
         @report_url = args[:report_url]
@@ -31,6 +32,7 @@ module Publisher
         @summary_type = args[:summary_type]
         @summary_table_type = args[:summary_table_type]
         @collapse_summary = args[:collapse_summary]
+        @unresolved_discussion_on_failure = args[:unresolved_discussion_on_failure]
       end
 
       # :nocov:
@@ -76,7 +78,8 @@ module Publisher
                   :update_pr,
                   :summary_type,
                   :collapse_summary,
-                  :summary_table_type
+                  :summary_table_type,
+                  :unresolved_discussion_on_failure
 
       # Current pull request description
       #

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

@@ -58,28 +58,68 @@ module Publisher
         )
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # Add comment with report url
       #
       # @return [void]
       def add_comment
-        unless comment
+        if main_comment
+          log_debug("Updating summary in comment with id #{discussion.id} in mr !#{mr_iid}")
+
+          client.edit_merge_request_note(
+            project,
+            mr_iid,
+            main_comment.id,
+            url_section_builder.comment_body(main_comment.body)
+          )
+        else
           log_debug("Creating comment with summary for mr ! #{mr_iid}")
-          return client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body)
+          client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body)
+        end
+
+        @discussion = nil
+
+        if unresolved_discussion_on_failure && main_comment&.body&.include?("❌") && !alert_comment
+          client.create_merge_request_discussion_note(project, mr_iid, discussion.id, body: alert_comment_text)
+        elsif alert_comment
+          client.delete_merge_request_discussion_note(project, mr_iid, discussion.id, alert_comment.id)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # Existing discussion that has 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) }
         end
+      end
 
-        log_debug("Updating summary in comment with id #{comment.id} in mr !#{mr_iid}")
-        client.edit_merge_request_note(project, mr_iid, comment.id, url_section_builder.comment_body(comment.body))
+      # Comment/note with allure urls
+      #
+      # @return [Gitlab::ObjectifiedHash]
+      def main_comment
+        discussion&.notes&.detect { |note| Helpers::UrlSectionBuilder.match?(note.body) }
       end
 
-      # Existing comment with allure urls
+      # Comment with alert text
       #
       # @return [Gitlab::ObjectifiedHash]
-      def comment
-        client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
-          Helpers::UrlSectionBuilder.match?(comment.body)
+      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
+
       # Get gitlab client
       #
       # @return [Gitlab::Client]
@@ -159,16 +199,6 @@ module Publisher
 
         "[#{short_sha}](#{server_url}/#{project}/-/merge_requests/#{mr_iid}/diffs?commit_id=#{sha})"
       end
-
-      # Return non empty environment variable value
-      #
-      # @param [String] name
-      # @return [String, nil]
-      def env(name)
-        return unless ENV[name] && !ENV[name].empty?
-
-        ENV[name]
-      end
     end
   end
 end

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

@@ -33,6 +33,7 @@ module Publisher
       # @option args [String] :summary_type
       # @option args [Symbol] :summary_table_type
       # @option args [Boolean] :collapse_summary
+      # @option args [Boolean] :unresolved_discussion_on_failure
       # @option args [String] :copy_latest
       def initialize(**args)
         @result_paths = args[:result_paths]
@@ -44,6 +45,7 @@ module Publisher
         @summary_table_type = args[:summary_table_type]
         @copy_latest = (Providers.provider && args[:copy_latest]) # copy latest for ci only
         @collapse_summary = args[:collapse_summary]
+        @unresolved_discussion_on_failure = args[:unresolved_discussion_on_failure]
       end
 
       # Execute allure report generation and upload
@@ -111,7 +113,8 @@ module Publisher
                   :copy_latest,
                   :summary_type,
                   :collapse_summary,
-                  :summary_table_type
+                  :summary_table_type,
+                  :unresolved_discussion_on_failure
 
       def_delegators :report_generator, :common_info_path, :report_path
 
@@ -213,7 +216,8 @@ module Publisher
           update_pr: update_pr,
           summary_type: summary_type,
           summary_table_type: summary_table_type,
-          collapse_summary: collapse_summary
+          collapse_summary: collapse_summary,
+          unresolved_discussion_on_failure: unresolved_discussion_on_failure
         )
       end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-25 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.121.0
+        version: 1.123.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.121.0
+        version: 1.123.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -202,194 +202,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.3
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: allure-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.20.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.20.0
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !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.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !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.49.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.0
 description: Upload allure reports to different file storage providers
 email:
 - andrejs.cunskis@gmail.com