allure-report-publisher 1.8.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28ab75e7680995e9117eb144cb3091561c5149f2fca4e93b89ed7dc06bbbf5fb
-  data.tar.gz: ad1ef5249b916969807efb60619261ba3e24e2063d5914204fe17ded16abb928
+  metadata.gz: 1f7655105dbfd46700acb9b6045fdb563542697d88891f2ac1983d6d6d9a2cc3
+  data.tar.gz: d13ed56a3356b42060fa10ccc665765d2e3453cbd1090f483198b6c03a636555
 SHA512:
-  metadata.gz: fada5ee179171b07a3387bd56abdff395413824d8819210c176e7b683fbd8caf3fab58d367c1ec33be89353324395ed6230ad3f763155f4d73a5b2ba95196f47
-  data.tar.gz: bc06329051f0d2a8317202e9e91b8438225e905beab68ef3ea735547e1c4167b67fe05e3bcb19eca82d577b4ec2d67e54af2d403b09b5e8f43f560f5c1738698
+  metadata.gz: 7ff3f600d92b168111027c203e3b0d61b25aae3ba99cb01df372d0e0003ca6706fe3dfa5c07c2402f6d0e5f90eff19f95b790877a466d46e8627c90fc9177932
+  data.tar.gz: 7799a9144ceb663551f461a0e503ec9051f9be0588bbf60598d8cf7953b67fd3771ea5eec68ab0aff259d15c7a67422a65d5739278a8215af9a8992a939f70d6

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)
-[![Known Vulnerabilities](https://snyk.io/test/github/andrcuns/allure-report-publisher/badge.svg)](https://snyk.io/test/github/andrcuns/allure-report-publisher)
 [![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.
@@ -47,9 +46,11 @@ 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/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
+  --report-title=VALUE              # Title for url section in PR comment/description. Required: false, default: "Allure Report"
+  --summary=VALUE                   # Additionally add summary table to PR comment or description. Required: false: (behaviors/suites/packages/total), default: "total"
+  --summary-table-type=VALUE        # Summary table type. Required: false: (ascii/markdown), default: "ascii"
   --base-url=VALUE                  # Use custom base url instead of default cloud provider one. Required: false
+  --[no-]flaky-warning-status       # Mark run with a '!' status in PR comment/description if report contains flaky tests, default: false
   --[no-]collapse-summary           # Create summary as a collapsible section, default: false
   --[no-]copy-latest                # Keep copy of latest report at base prefix path, default: false
   --[no-]color                      # Force color output
@@ -65,7 +66,7 @@ Examples:
 
 ## Environment variables
 
-All named options can be configured via environment variables. Environment variables are prefixed with `ALLURE_REPORT_` and uppercased.
+All named options can be configured via environment variables. Environment variables are prefixed with `ALLURE_` and uppercased.
 
 Example: `--results-glob` can be configured via `ALLURE_REPORT_RESULTS_GLOB`
 
@@ -188,6 +189,10 @@ If reporter is executed with options `--update-pr=comment` and `--unresolved-dis
 
 - `ALLURE_FAILURE_ALERT_COMMENT`: comment added to create unresolved discussion note, default: `There are some test failures that need attention`
 
+### CI/CD catalog resource
+
+[allure-report-publisher CI/CD catalog resource](https://gitlab.com/andrcuns/allure-report-publisher) can be used to easily integrate report publishing in to Gitlab CI pipelines.
+
 # 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

@@ -25,9 +25,14 @@ module Publisher
              type: :string,
              desc: "Add report url to PR via comment or description update. Required: false",
              values: %w[comment description actions]
+      option :report_title,
+             type: :string,
+             default: "Allure Report",
+             desc: "Title for url section in PR comment/description. Required: false"
       option :summary,
              type: :string,
              desc: "Additionally add summary table to PR comment or description. Required: false",
+             default: Publisher::Helpers::Summary::TOTAL,
              values: [
                Publisher::Helpers::Summary::BEHAVIORS,
                Publisher::Helpers::Summary::SUITES,
@@ -45,6 +50,10 @@ module Publisher
       option :base_url,
              type: :string,
              desc: "Use custom base url instead of default cloud provider one. Required: false"
+      option :flaky_warning_status,
+             type: :boolean,
+             default: false,
+             desc: "Mark run with a '!' status in PR comment/description if report contains flaky tests"
       option :collapse_summary,
              type: :boolean,
              default: false,
@@ -83,7 +92,7 @@ module Publisher
 
         generate_report
         upload_report
-        return unless args[:update_pr] && uploader.pr?
+        return unless args[:update_pr] && Providers.info&.pr?
 
         add_report_urls
       rescue StandardError => e
@@ -99,17 +108,26 @@ module Publisher
       # @return [Publisher::Uploaders::Uploader]
       def uploader
         @uploader ||= uploaders(args[:type]).new(
-          summary_type: args[:summary],
           result_paths: @result_paths,
+          **args.slice(:bucket, :prefix, :base_url, :copy_latest)
+        )
+      end
+
+      # CI provider instance
+      #
+      # @return [Publisher::Providers::Base]
+      def ci_provider
+        @ci_provider = Providers.provider&.new(
+          report_url: uploader.report_url,
+          report_path: uploader.report_path,
+          summary_type: args[:summary],
           **args.slice(
-            :bucket,
-            :prefix,
-            :base_url,
-            :copy_latest,
             :update_pr,
             :collapse_summary,
+            :flaky_warning_status,
             :summary_table_type,
-            :unresolved_discussion_on_failure
+            :unresolved_discussion_on_failure,
+            :report_title
           )
         )
       end
@@ -173,7 +191,7 @@ module Publisher
       # @return [void]
       def add_report_urls
         log("Adding reports urls")
-        Spinner.spin("updating", exit_on_error: false, debug: args[:debug]) { uploader.add_result_summary }
+        Spinner.spin("updating", exit_on_error: false, debug: args[:debug]) { ci_provider.add_result_summary }
       end
 
       # Handle error during upload command

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

@@ -121,7 +121,8 @@ module Publisher
     # @return [void]
     def spinner_error(error)
       message = ["failed", error.message]
-      message << error.backtrace if debug
+      log_debug("Error: #{error.message}\n#{error.backtrace.join("\n")}")
+
       colored_message = colorize(message.compact.join("\n"), error_color)
       return spinner.error(colored_message) if tty?
 

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

@@ -9,18 +9,20 @@ module Publisher
       PACKAGES = "packages".freeze
       SUITES = "suites".freeze
       TOTAL = "total".freeze
-      MARKDOWN = :markdown
-      ASCII = :ascii
+      MARKDOWN = "markdown".freeze
+      ASCII = "ascii".freeze
 
       # Summary table generator
       #
       # @param [String] report_path
       # @param [String] summary_type
       # @param [String] markdown
-      def initialize(report_path, summary_type, table_type = ASCII)
+      # @param [Boolean] flaky_warning_status
+      def initialize(report_path, summary_type, table_type = ASCII, flaky_warning_status: false)
         @report_path = report_path
         @summary_type = summary_type || TOTAL
         @table_type = table_type
+        @flaky_warning_status = flaky_warning_status
       end
 
       # Summary table
@@ -51,7 +53,7 @@ module Publisher
 
       private
 
-      attr_reader :report_path, :summary_type, :table_type
+      attr_reader :report_path, :summary_type, :table_type, :flaky_warning_status
 
       # Expanded summary table
       #
@@ -102,7 +104,7 @@ module Publisher
       # @return [String]
       def status_icon(passed, failed, flaky)
         return "➖" if passed.zero? && failed.zero?
-        return flaky.zero? ? "✅" : "❗" if failed.zero?
+        return !flaky_warning_status || flaky.zero? ? "✅" : "❗" if failed.zero?
 
         "❌"
       end
@@ -113,7 +115,7 @@ module Publisher
       def terminal_table
         Terminal::Table.new do |table|
           table.title = "#{summary_type} summary" unless markdown?
-          table.style = { border: table_type }
+          table.style = { border: table_type.to_sym }
           table.headings = ["", "passed", "failed", "skipped", "flaky", "total", "result"]
           yield(table)
         end

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

@@ -14,6 +14,8 @@ module Publisher
       # @param [String] sha_url
       # @param [String] summary_type
       # @param [String] collapse_summary
+      # @param [Boolean] flaky_warning_status
+      # @param [String] report_title
       def initialize(**args)
         @report_url = args[:report_url]
         @report_path = args[:report_path]
@@ -22,6 +24,8 @@ module Publisher
         @summary_type = args[:summary_type]
         @summary_table_type = args[:summary_table_type]
         @collapse_summary = args[:collapse_summary]
+        @flaky_warning_status = args[:flaky_warning_status]
+        @report_title = args[:report_title]
       end
 
       # Matches url section pattern
@@ -64,7 +68,9 @@ module Publisher
                   :sha_url,
                   :summary_type,
                   :summary_table_type,
-                  :collapse_summary
+                  :collapse_summary,
+                  :flaky_warning_status,
+                  :report_title
 
       private
 
@@ -72,14 +78,21 @@ module Publisher
       #
       # @return [String]
       def heading
-        @heading ||= "# Allure report\n`allure-report-publisher` generated test report!"
+        @heading ||= "# #{report_title}\n" \
+                     "[`allure-report-publisher`](https://github.com/andrcuns/allure-report-publisher) " \
+                     "generated test report!"
       end
 
       # Test run summary
       #
       # @return [Helpers::Summary]
       def summary
-        @summary ||= Helpers::Summary.new(report_path, summary_type, summary_table_type)
+        @summary ||= Helpers::Summary.new(
+          report_path,
+          summary_type,
+          summary_table_type,
+          flaky_warning_status: flaky_warning_status
+        )
       end
 
       # Single job report URL entry

data/lib/allure_report_publisher/lib/parser.rb

@@ -5,6 +5,8 @@ module Dry
     module Parser
       class InvalidEnvValue < StandardError; end
 
+      ENV_VAR_PREFIX = "ALLURE_".freeze
+
       class << self
         def call(command, arguments, prog_name)
           original_arguments = arguments.dup
@@ -45,7 +47,7 @@ module Dry
         end
 
         def option_from_env(option)
-          name = "ALLURE_REPORT_#{option.name.to_s.upcase}"
+          name = "#{ENV_VAR_PREFIX}#{option.name.to_s.upcase}"
           value = ENV[name]
           return if value.nil? || value.empty?
           return if option.boolean? && !%w[true false].include?(value)

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

@@ -2,7 +2,7 @@ module Publisher
   # Namespace for providers executing tests
   #
   module Providers
-    # Detect CI provider
+    # CI provider class
     #
     # @return [Publisher::Providers::Base]
     def self.provider
@@ -11,11 +11,18 @@ module Publisher
       Gitlab if ENV["GITLAB_CI"]
     end
 
+    # CI info class
+    #
+    # @return [Info::Base]
+    def self.info
+      return Info::Github.instance if ENV["GITHUB_WORKFLOW"]
+
+      Info::Gitlab.instance if ENV["GITLAB_CI"]
+    end
+
     # Base class for CI executor info
     #
     class Provider
-      ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
-
       # CI provider base
       #
       # @param [Hash] args
@@ -23,9 +30,11 @@ module Publisher
       # @option args [String] :report_path
       # @option args [Boolean] :update_pr
       # @option args [String] :summary_type
+      # @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 [Symbol] :summary_table_type
+      # @option args [String] :report_title
       def initialize(**args)
         @report_url = args[:report_url]
         @report_path = args[:report_path]
@@ -33,45 +42,20 @@ module Publisher
         @summary_type = args[:summary_type]
         @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
 
-      # :nocov:
-
-      # Get ci run ID without creating instance of ci provider
-      #
-      # @return [String]
-      def self.run_id
-        raise("Not implemented!")
-      end
-
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
-      # :nocov:
-
       # Add report url to pull request description
       #
       # @return [void]
       def add_result_summary
-        raise("Not a pull request, skipped!") unless pr?
         return add_comment if comment?
 
         update_pr_description
       end
 
-      # :nocov:
-
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        raise("Not implemented!")
-      end
-
       private
 
       attr_reader :report_url,
@@ -80,7 +64,9 @@ module Publisher
                   :summary_type,
                   :collapse_summary,
                   :summary_table_type,
-                  :unresolved_discussion_on_failure
+                  :flaky_warning_status,
+                  :unresolved_discussion_on_failure,
+                  :report_title
 
       # Current pull request description
       #
@@ -102,29 +88,8 @@ module Publisher
       def add_comment
         raise("Not implemented!")
       end
-
-      # Build name
-      #
-      # @return [String]
-      def build_name
-        raise("Not implemented!")
-      end
-
-      # Commit SHA url
-      #
-      # @return [String]
-      def sha_url
-        raise("Not implemented!")
-      end
       # :nocov:
 
-      # CI run id
-      #
-      # @return [String]
-      def run_id
-        self.class.run_id
-      end
-
       # Add report url as comment
       #
       # @return [Boolean]
@@ -143,7 +108,9 @@ module Publisher
           sha_url: sha_url,
           summary_type: summary_type,
           summary_table_type: summary_table_type,
-          collapse_summary: collapse_summary
+          collapse_summary: collapse_summary,
+          flaky_warning_status: flaky_warning_status,
+          report_title: report_title
         )
       end
     end

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

@@ -6,6 +6,7 @@ module Publisher
     #
     class Github < Provider
       include Helpers
+      extend Forwardable
 
       # Set octokit to autopaginate
       #
@@ -13,38 +14,13 @@ module Publisher
         config.auto_paginate = true
       end
 
-      # Run id
-      #
-      # @return [String]
-      def self.run_id
-        @run_id ||= ENV["GITHUB_RUN_ID"]
-      end
-
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        ENV["GITHUB_EVENT_NAME"] == "pull_request"
-      end
-
-      # Executor info
-      #
-      # @return [Hash]
-      def executor_info
-        {
-          name: "Github",
-          type: "github",
-          reportName: "AllureReport",
-          url: server_url,
-          reportUrl: report_url,
-          buildUrl: build_url,
-          buildOrder: run_id,
-          buildName: build_name
-        }
-      end
-
       private
 
+      def_delegators :"Publisher::Providers::Info::Github.instance",
+                     :repository,
+                     :server_url,
+                     :build_name
+
       # Github api client
       #
       # @return [Octokit::Client]
@@ -109,34 +85,6 @@ module Publisher
         @pr_id ||= github_event[:number]
       end
 
-      # Server url
-      #
-      # @return [String]
-      def server_url
-        @server_url ||= ENV["GITHUB_SERVER_URL"]
-      end
-
-      # Build url
-      #
-      # @return [String]
-      def build_url
-        @build_url ||= "#{server_url}/#{repository}/actions/runs/#{run_id}"
-      end
-
-      # Job name
-      #
-      # @return [String]
-      def build_name
-        @build_name ||= ENV[ALLURE_JOB_NAME] || ENV["GITHUB_JOB"]
-      end
-
-      # Github repository
-      #
-      # @return [String]
-      def repository
-        @repository ||= ENV["GITHUB_REPOSITORY"]
-      end
-
       # Commit sha url
       #
       # @return [String]

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

@@ -6,44 +6,83 @@ module Publisher
     #
     class Gitlab < Provider
       include Helpers
+      extend Forwardable
 
-      # Get ci run ID without creating instance of ci provider
+      private
+
+      def_delegators :"Publisher::Providers::Info::Gitlab.instance",
+                     :allure_project,
+                     :allure_mr_iid,
+                     :server_url,
+                     :build_name
+
+      # Get gitlab client
+      #
+      # @return [Gitlab::Client]
+      def client
+        @client ||= begin
+          raise("Missing GITLAB_AUTH_TOKEN environment variable!") unless env("GITLAB_AUTH_TOKEN")
+
+          ::Gitlab::Client.new(
+            endpoint: "#{server_url}/api/v4",
+            private_token: env("GITLAB_AUTH_TOKEN")
+          )
+        end
+      end
+
+      # Current pull request description
       #
       # @return [String]
-      def self.run_id
-        @run_id ||= ENV["CI_PIPELINE_ID"]
+      def pr_description
+        @pr_description ||= client.merge_request(project, mr_iid).description
       end
 
-      # Pull request run
+      # Comment with alert text
       #
-      # @return [Boolean]
-      def pr?
-        (allure_project && allure_mr_iid) || ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+      # @return [Gitlab::ObjectifiedHash]
+      def alert_comment
+        @alert_comment ||= discussion&.notes&.detect do |note|
+          note.body.include?(alert_comment_text)
+        end
       end
 
-      # Get executor info
+      # Text for alert comment
       #
-      # @return [Hash]
-      def executor_info
-        {
-          name: "Gitlab",
-          type: "gitlab",
-          reportName: "AllureReport",
-          url: server_url,
-          reportUrl: report_url,
-          buildUrl: build_url,
-          buildOrder: run_id,
-          buildName: build_name
-        }
+      # @return [String]
+      def alert_comment_text
+        @alert_comment_text ||=
+          env("ALLURE_FAILURE_ALERT_COMMENT") || "There are some test failures that need attention"
       end
 
-      private
+      # Custom sha
+      #
+      # @return [String]
+      def allure_sha
+        @allure_sha ||= env("ALLURE_COMMIT_SHA")
+      end
 
-      # Current pull request description
+      # Gitlab project path
       #
       # @return [String]
-      def pr_description
-        @pr_description ||= client.merge_request(project, mr_iid).description
+      def project
+        @project ||= allure_project || env("CI_MERGE_REQUEST_PROJECT_PATH") || env("CI_PROJECT_PATH")
+      end
+
+      # Merge request iid
+      #
+      # @return [Integer]
+      def mr_iid
+        @mr_iid ||= allure_mr_iid || env("CI_MERGE_REQUEST_IID")
+      end
+
+      # Commit sha url
+      #
+      # @return [String]
+      def sha_url
+        sha = allure_sha || env("CI_MERGE_REQUEST_SOURCE_BRANCH_SHA") || env("CI_COMMIT_SHA")
+        short_sha = sha[0..7]
+
+        "[#{short_sha}](#{server_url}/#{project}/-/merge_requests/#{mr_iid}/diffs?commit_id=#{sha})"
       end
 
       # Update pull request description
@@ -58,25 +97,37 @@ module Publisher
         )
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity
       # Add comment with report url
       #
       # @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}")
 
-          client.edit_merge_request_note(
+          return 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}")
-          client.create_merge_request_comment(project, mr_iid, url_section_builder.comment_body)
         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
@@ -93,8 +144,6 @@ module Publisher
         main_comment&.body&.include?("❌")
       end
 
-      # rubocop:enable Metrics/PerceivedComplexity
-
       # Existing discussion that has comment with allure urls
       #
       # @return [Gitlab::ObjectifiedHash]
@@ -110,103 +159,6 @@ module Publisher
       def main_comment
         discussion&.notes&.detect { |note| Helpers::UrlSectionBuilder.match?(note.body) }
       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
-
-      # Get gitlab client
-      #
-      # @return [Gitlab::Client]
-      def client
-        @client ||= begin
-          raise("Missing GITLAB_AUTH_TOKEN environment variable!") unless env("GITLAB_AUTH_TOKEN")
-
-          ::Gitlab::Client.new(
-            endpoint: "#{server_url}/api/v4",
-            private_token: env("GITLAB_AUTH_TOKEN")
-          )
-        end
-      end
-
-      # Custom repository name
-      #
-      # @return [String]
-      def allure_project
-        @allure_project ||= env("ALLURE_PROJECT_PATH")
-      end
-
-      # Custom mr iid name
-      #
-      # @return [String]
-      def allure_mr_iid
-        @allure_mr_iid ||= env("ALLURE_MERGE_REQUEST_IID")
-      end
-
-      # Custom sha
-      #
-      # @return [String]
-      def allure_sha
-        @allure_sha ||= env("ALLURE_COMMIT_SHA")
-      end
-
-      # Gitlab project path
-      #
-      # @return [String]
-      def project
-        @project ||= allure_project || env("CI_MERGE_REQUEST_PROJECT_PATH") || env("CI_PROJECT_PATH")
-      end
-
-      # Merge request iid
-      #
-      # @return [Integer]
-      def mr_iid
-        @mr_iid ||= allure_mr_iid || env("CI_MERGE_REQUEST_IID")
-      end
-
-      # Server url
-      #
-      # @return [String]
-      def server_url
-        @server_url ||= env("CI_SERVER_URL")
-      end
-
-      # Build url
-      #
-      # @return [String]
-      def build_url
-        @build_url ||= env("CI_PIPELINE_URL")
-      end
-
-      # Job name
-      #
-      # @return [String]
-      def build_name
-        @build_name ||= env(ALLURE_JOB_NAME) || env("CI_JOB_NAME")
-      end
-
-      # Commit sha url
-      #
-      # @return [String]
-      def sha_url
-        sha = allure_sha || env("CI_MERGE_REQUEST_SOURCE_BRANCH_SHA") || env("CI_COMMIT_SHA")
-        short_sha = sha[0..7]
-
-        "[#{short_sha}](#{server_url}/#{project}/-/merge_requests/#{mr_iid}/diffs?commit_id=#{sha})"
-      end
     end
   end
 end

data/lib/allure_report_publisher/lib/providers/info/_base.rb

@@ -0,0 +1,39 @@
+require "singleton"
+
+module Publisher
+  module Providers
+    module Info
+      # Base class for CI executor info
+      #
+      class Base
+        ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
+
+        # :nocov:
+
+        # CI Provider executor info
+        #
+        # @param [String] report_url
+        # @return [Hash]
+        def executor(_report_url)
+          raise("Not implemented!")
+        end
+
+        # Running on pull request/merge request
+        #
+        # @return [Boolean]
+        def pr?
+          raise("Not implemented!")
+        end
+
+        # Pipeline run id
+        #
+        # @return [Integer]
+        def run_id
+          raise("Not implemented!")
+        end
+
+        # :nocov:
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Publisher
+  module Providers
+    module Info
+      # Github executor info
+      #
+      class Github < Base
+        include Singleton
+        include Helpers
+
+        # Executor info
+        #
+        # @return [Hash]
+        def executor(report_url)
+          {
+            name: "Github",
+            type: "github",
+            reportName: "AllureReport",
+            reportUrl: report_url,
+            url: server_url,
+            buildUrl: build_url,
+            buildOrder: run_id,
+            buildName: build_name
+          }
+        end
+
+        # Pull request run
+        #
+        # @return [Boolean]
+        def pr?
+          env("GITHUB_EVENT_NAME") == "pull_request"
+        end
+
+        # Run id
+        #
+        # @return [String]
+        def run_id
+          @run_id ||= env("GITHUB_RUN_ID")
+        end
+
+        # Server url
+        #
+        # @return [String]
+        def server_url
+          @server_url ||= env("GITHUB_SERVER_URL")
+        end
+
+        # Job name
+        #
+        # @return [String]
+        def build_name
+          @build_name ||= env(ALLURE_JOB_NAME) || env("GITHUB_JOB")
+        end
+
+        # Github repository
+        #
+        # @return [String]
+        def repository
+          @repository ||= env("GITHUB_REPOSITORY")
+        end
+
+        # Build url
+        #
+        # @return [String]
+        def build_url
+          @build_url ||= "#{server_url}/#{repository}/actions/runs/#{run_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module Publisher
+  module Providers
+    module Info
+      # Gitlab executor info
+      #
+      class Gitlab < Base
+        include Singleton
+        include Helpers
+
+        # Executor info
+        #
+        # @return [Hash]
+        def executor(report_url)
+          {
+            name: "Gitlab",
+            type: "gitlab",
+            reportName: "AllureReport",
+            reportUrl: report_url,
+            url: server_url,
+            buildUrl: build_url,
+            buildOrder: run_id,
+            buildName: build_name
+          }
+        end
+
+        # Pull request run
+        #
+        # @return [Boolean]
+        def pr?
+          !!(allure_project && allure_mr_iid) || ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+        end
+
+        # Get ci run ID without creating instance of ci provider
+        #
+        # @return [String]
+        def run_id
+          @run_id ||= ENV["CI_PIPELINE_ID"]
+        end
+
+        # Server url
+        #
+        # @return [String]
+        def server_url
+          @server_url ||= env("CI_SERVER_URL")
+        end
+
+        # Build url
+        #
+        # @return [String]
+        def build_url
+          @build_url ||= env("CI_PIPELINE_URL")
+        end
+
+        # Custom repository name
+        #
+        # @return [String]
+        def allure_project
+          @allure_project ||= env("ALLURE_PROJECT_PATH")
+        end
+
+        # Custom mr iid name
+        #
+        # @return [String]
+        def allure_mr_iid
+          @allure_mr_iid ||= env("ALLURE_MERGE_REQUEST_IID")
+        end
+
+        # Job name
+        #
+        # @return [String]
+        def build_name
+          @build_name ||= env(ALLURE_JOB_NAME) || env("CI_JOB_NAME")
+        end
+      end
+    end
+  end
+end

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

@@ -29,23 +29,13 @@ module Publisher
       # @option args [String] :bucket
       # @option args [String] :prefix
       # @option args [String] :base_url
-      # @option args [Boolean] :update_pr
-      # @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]
         @bucket_name = args[:bucket]
         @prefix = args[:prefix]
         @base_url = args[:base_url]
-        @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]
-        @unresolved_discussion_on_failure = args[:unresolved_discussion_on_failure]
+        @copy_latest = ci_info && args[:copy_latest] # copy latest for ci only
       end
 
       # Execute allure report generation and upload
@@ -54,7 +44,6 @@ module Publisher
       def execute
         generate_report
         upload
-        add_result_summary
       end
 
       # Generate allure report
@@ -76,16 +65,6 @@ module Publisher
         upload_latest_copy if copy_latest
       end
 
-      # Add allure report url to pull request description
-      #
-      # @return [void]
-      def add_result_summary
-        return unless update_pr && ci_provider
-
-        log_debug("Adding test result summary")
-        ci_provider.add_result_summary
-      end
-
       # Uploaded report urls
       #
       # @return [Hash<String, String>] uploaded report urls
@@ -96,27 +75,35 @@ module Publisher
         urls
       end
 
-      # Executed in PR pipeline
+      # :nocov:
+
+      # Report url
       #
-      # @return [Boolean]
-      def pr?
-        ci_provider&.pr?
+      # @return [String]
+      def report_url
+        raise("Not Implemented!")
       end
 
+      # :nocov:
+
+      def_delegator :report_generator, :report_path
+
       private
 
       attr_reader :result_paths,
                   :bucket_name,
                   :prefix,
                   :base_url,
-                  :update_pr,
-                  :copy_latest,
-                  :summary_type,
-                  :collapse_summary,
-                  :summary_table_type,
-                  :unresolved_discussion_on_failure
+                  :copy_latest
 
-      def_delegators :report_generator, :common_info_path, :report_path
+      def_delegator :report_generator, :common_info_path
+
+      # CI info
+      #
+      # @return [Providers::Info::Base]
+      def ci_info
+        Providers.info
+      end
 
       # :nocov:
 
@@ -127,13 +114,6 @@ module Publisher
         raise("Not Implemented!")
       end
 
-      # Report url
-      #
-      # @return [String]
-      def report_url
-        raise("Not Implemented!")
-      end
-
       # Latest report url
       #
       # @return [String]
@@ -168,6 +148,7 @@ module Publisher
       def upload_latest_copy
         raise("Not implemented!")
       end
+
       # :nocov:
 
       # Allure report generator
@@ -201,24 +182,7 @@ module Publisher
       #
       # @return [String]
       def run_id
-        @run_id ||= Providers.provider&.run_id
-      end
-
-      # Get CI provider
-      #
-      # @return [Publisher::Providers::Base]
-      def ci_provider
-        return @ci_provider if defined?(@ci_provider)
-
-        @ci_provider = Providers.provider&.new(
-          report_url: report_url,
-          report_path: report_path,
-          update_pr: update_pr,
-          summary_type: summary_type,
-          summary_table_type: summary_table_type,
-          collapse_summary: collapse_summary,
-          unresolved_discussion_on_failure: unresolved_discussion_on_failure
-        )
+        @run_id ||= ci_info&.run_id
       end
 
       # Add allure history
@@ -236,10 +200,10 @@ module Publisher
       #
       # @return [void]
       def add_executor_info
-        return unless ci_provider
+        return unless ci_info
 
-        json = ci_provider.executor_info.to_json
-        log_debug("Saving ci executor info:\n#{JSON.pretty_generate(ci_provider.executor_info)}")
+        json = JSON.pretty_generate(ci_info.executor(report_url))
+        log_debug("Saving ci executor info:\n#{json}")
         # allure-report will fail to pick up reportUrl in history tab if executor.json is not present alongside results
         [common_info_path, *result_paths].each do |path|
           file = File.join(path, EXECUTOR_JSON)

data/lib/allure_report_publisher/lib/uploaders/gcs.rb

@@ -5,6 +5,13 @@ module Publisher
     # Google cloud storage uploader implementation
     #
     class GCS < Uploader
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        @report_url ||= url(full_prefix)
+      end
+
       private
 
       # GCS client
@@ -21,13 +28,6 @@ module Publisher
         @bucket ||= client.bucket(bucket_name, skip_lookup: true)
       end
 
-      # Report url
-      #
-      # @return [String]
-      def report_url
-        @report_url ||= url(full_prefix)
-      end
-
       # Latest report url
       #
       # @return [String]

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

@@ -6,6 +6,13 @@ module Publisher
     # Report upload to AWS S3 bucket
     #
     class S3 < Uploader
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        @report_url ||= url(full_prefix)
+      end
+
       private
 
       # S3 client
@@ -29,13 +36,6 @@ module Publisher
         }.compact
       end
 
-      # Report url
-      #
-      # @return [String]
-      def report_url
-        @report_url ||= url(full_prefix)
-      end
-
       # Latest report url
       #
       # @return [String]

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-11-02 00:00:00.000000000 Z
+date: 2023-12-08 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.137.0
+        version: 1.142.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.137.0
+        version: 1.142.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -211,7 +211,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- bin/allure-report-publisher
+- exe/allure-report-publisher
 - lib/allure_report_publisher.rb
 - lib/allure_report_publisher/commands/upload.rb
 - lib/allure_report_publisher/commands/version.rb
@@ -223,6 +223,9 @@ files:
 - 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/info/_base.rb
+- lib/allure_report_publisher/lib/providers/info/github.rb
+- lib/allure_report_publisher/lib/providers/info/gitlab.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