allure-report-publisher 4.5.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82efde728a5903d3410e98eec0b35a0f9a3789c79619c0aafe92c604937aa1fd
-  data.tar.gz: a1cd5018bc9d904459fe7eaf613dee24907adbe5d0242b6524bb802bca826bb7
+  metadata.gz: 383b5a328cf9acc9c7ef65bf6e63f807d936dc38a4125e908a5ea6c29ac6df18
+  data.tar.gz: 4348a6696f84c9c2fa5c36584b7e8e4313db19965ae2b182aeba8087a2520dc5
 SHA512:
-  metadata.gz: 0fbedf74afe01d091999267911a1d2016686bfa717c3139e888cb25635cbc88d87c216be08cb25876943c78512907a79e5fedfed4de9ddbff1b430b80b1b2f87
-  data.tar.gz: b848cdfeb884f56dda77c0214ecf786ad3f40f9f8af9b71fa3e8a7400110ff1146ce36c15d7d23485694ccc981607f0fbd26f3480e203d34a21ce285ad2cbd3a
+  metadata.gz: a1b0faa886ce9d3ee4ccb0e3d3459190121b40fc136571476caa859f66480e2284d10b38570fea07ace0284b4fd711db114c4151968cdc95882c54b10e11c452
+  data.tar.gz: 710dc295a857b1fdc771f46e9a8c51b018f5832e43fc2e78fd5a9f800c5bfbf3b1326e0c0ae4aea02fd19b577a24dc18d2aedb988f634bda3c9c05fe8b1d2f6e

data/README.md

@@ -3,8 +3,6 @@
 [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/andrcuns/allure-report-publisher?color=blue&label=docker&sort=semver)](https://hub.docker.com/r/andrcuns/allure-report-publisher)
 [![Docker Pulls](https://img.shields.io/docker/pulls/andrcuns/allure-report-publisher)](https://hub.docker.com/r/andrcuns/allure-report-publisher)
 ![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)
 
 Upload your report to a file storage of your choice.
 
@@ -38,22 +36,23 @@ Description:
   Generate and upload allure report
 
 Arguments:
-  TYPE                              # REQUIRED Cloud storage type: (s3/gcs)
+  TYPE                              # REQUIRED Cloud storage type: (gcs/s3/gitlab-artifacts)
 
 Options:
   --results-glob=VALUE              # Glob pattern to return allure results directories. Required: true
-  --bucket=VALUE                    # Bucket name. Required: true
-  --prefix=VALUE                    # Optional prefix for report path. Required: false
+  --bucket=VALUE                    # Bucket name. Required: true (gcs|s3), false (gitlab-artifacts)
+  --output=VALUE                    # Output directory for the report. Required: false. Defaults to 'allure-report' for gitlab-artifacts and random temporary directory for cloud based storage
+  --prefix=VALUE                    # Optional prefix for report path. Required: false. Ignored for gitlab-artifacts
   --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description/actions)
   --report-title=VALUE              # Title for url section in PR comment/description. Required: false, default: "Allure Report"
   --report-name=VALUE               # Custom report name in final Allure report. Required: false
   --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
+  --base-url=VALUE                  # Use custom base url instead of default cloud provider one. Required: false. Ignored for gitlab-artifacts
   --parallel=VALUE                  # Number of parallel threads to use for report file upload to cloud storage. Required: false, default: 8
   --[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-]copy-latest                # Keep copy of latest report at base prefix path. Ignored for gitlab-artifacts, default: false
   --[no-]color                      # Force color output
   --[no-]ignore-missing-results     # Ignore missing allure results, default: false
   --[no-]debug                      # Print additional debug output, default: false
@@ -62,6 +61,17 @@ Options:
 Examples:
   allure-report-publisher upload s3 --results-glob='path/to/allure-results' --bucket=my-bucket
   allure-report-publisher upload gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs
+  allure-report-publisher upload gitlab-artifacts --results-glob='paths/to/**/allure-results'
+```
+
+## Extra arguments
+
+You can pass any extra arguments to the `allure generate` command by using `--` before the arguments.
+
+Example:
+
+```shell
+allure-report-publisher upload s3 --results-glob='path/to/allure-results' --bucket=my-bucket -- --lang en
 ```
 
 ## Environment variables
@@ -105,6 +115,23 @@ credentials.json contents:
 - `GOOGLE_CLOUD_KEYFILE_JSON`
 - `GCLOUD_KEYFILE_JSON`
 
+## Gitlab Artifacts
+
+This storage provider is only supported for GitLab CI. Because GitLab does not expose public api for uploading artifacts, a job must be configured to upload the report as an artifact. Example:
+
+```yaml
+# .gitlab-ci.yml
+artifacts:
+  paths:
+    - allure-report
+```
+
+where `allure-report` is the directory containing the generated Allure report and can be overridden via `--output` option.
+
+Requires environment variable `GITLAB_AUTH_TOKEN` where token is a GitLab personal access token with `api` scope capable of downloading artifacts and retrieving job and pipeline information.
+
+This provider is meant to be used with [GitLab CI](#gitlab-ci).
+
 # CI
 
 `allure-report-publisher` will automatically detect if used in CI environment and add relevant executor info and history.

data/lib/allure_report_publisher/commands/upload.rb

@@ -7,20 +7,25 @@ module Publisher
     class Upload < Dry::CLI::Command
       include Helpers
 
+      STORAGE_PROVIDERS = %w[gcs s3 gitlab-artifacts].freeze
+
       desc "Generate and upload allure report"
 
       argument :type,
                type: :string,
                required: true,
-               values: %w[s3 gcs],
+               values: STORAGE_PROVIDERS,
                desc: "Cloud storage type"
 
+      # rubocop:disable Layout/LineLength
       option :results_glob,
              desc: "Glob pattern to return allure results directories. Required: true"
       option :bucket,
-             desc: "Bucket name. Required: true"
+             desc: "Bucket name. Required: true (gcs|s3), false (gitlab-artifacts)"
+      option :output,
+             desc: "Output directory for the report. Required: false. Defaults to 'allure-report' for gitlab-artifacts and random temporary directory for cloud based storage"
       option :prefix,
-             desc: "Optional prefix for report path. Required: false"
+             desc: "Optional prefix for report path. Required: false. Ignored for gitlab-artifacts"
       option :update_pr,
              type: :string,
              desc: "Add report url to PR via comment or description update. Required: false",
@@ -52,7 +57,7 @@ module Publisher
              ]
       option :base_url,
              type: :string,
-             desc: "Use custom base url instead of default cloud provider one. Required: false"
+             desc: "Use custom base url instead of default cloud provider one. Required: false. Ignored for gitlab-artifacts"
       option :parallel,
              type: :integer,
              desc: "Number of parallel threads to use for report file upload to cloud storage. Required: false",
@@ -68,7 +73,7 @@ module Publisher
       option :copy_latest,
              type: :boolean,
              default: false,
-             desc: "Keep copy of latest report at base prefix path"
+             desc: "Keep copy of latest report at base prefix path. Ignored for gitlab-artifacts"
       option :color,
              type: :boolean,
              desc: "Force color output"
@@ -80,22 +85,24 @@ module Publisher
              type: :boolean,
              default: false,
              desc: "Print additional debug output"
+      # rubocop:enable Layout/LineLength
 
       example [
         "s3 --results-glob='path/to/allure-results' --bucket=my-bucket",
-        "gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs"
+        "gcs --results-glob='paths/to/**/allure-results' --bucket=my-bucket --prefix=my-project/prs",
+        "gitlab-artifacts --results-glob='paths/to/**/allure-results'"
       ]
 
-      def call(**args)
-        Helpers.pastel(force_color: args[:color])
-        @args = args
+      def call(args: [], **arguments)
+        Helpers.pastel(force_color: arguments[:color])
+        @args = arguments
 
-        validate_args
+        validate_args!
         scan_results_paths
 
-        generate_report
+        generate_report(args)
         upload_report
-        return unless args[:update_pr] && Providers.info&.pr?
+        return unless arguments[:update_pr] && Providers.info&.pr?
 
         add_report_urls
       rescue StandardError => e
@@ -106,6 +113,17 @@ module Publisher
 
       attr_reader :args
 
+      # Report output path
+      #
+      # @return [String] output path
+      def output
+        @output ||= args[:output].then do |path|
+          next if path
+
+          gitlab_artifacts? ? "allure-report" : File.join(Dir.tmpdir, "allure-report-#{Time.now.to_i}")
+        end
+      end
+
       # Uploader instance
       #
       # @return [Publisher::Uploaders::Uploader]
@@ -113,6 +131,7 @@ module Publisher
         @uploader ||= uploaders(args[:type]).new(
           result_paths: @result_paths,
           parallel: parallel_threads,
+          output: output,
           **args.slice(:bucket, :prefix, :base_url, :copy_latest, :report_name)
         )
       end
@@ -123,7 +142,7 @@ module Publisher
       def ci_provider
         @ci_provider = Providers.provider&.new(
           report_url: uploader.report_url,
-          report_path: uploader.report_path,
+          report_path: output,
           summary_type: args[:summary],
           **args.slice(
             :update_pr,
@@ -142,19 +161,39 @@ module Publisher
       def uploaders(uploader)
         {
           "s3" => Uploaders::S3,
-          "gcs" => Uploaders::GCS
+          "gcs" => Uploaders::GCS,
+          "gitlab-artifacts" => Uploaders::GitlabArtifacts
         }.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])
+      def validate_args!
+        validate_base_args!
+        validate_base_url!
+        cast_parallel_threads_arg!
+      end
+
+      # Check base arguments
+      #
+      # @return [void]
+      def validate_base_args!
+        unless STORAGE_PROVIDERS.include?(args[:type])
+          error("Unsupported storage type! Supported types are: #{STORAGE_PROVIDERS.join(', ')}")
+        end
+
         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]
-        validate_parallel_args
+        error("Missing argument --bucket!") unless gitlab_artifacts? || args[:bucket]
+      end
+
+      # Check base URL is a valid URI
+      #
+      # @return [void]
+      def validate_base_url!
+        return unless args[:base_url] && !gitlab_artifacts?
+
+        URI.parse(args[:base_url])
       rescue URI::InvalidURIError
         error("Invalid --base-url value!")
       end
@@ -169,7 +208,7 @@ module Publisher
       rescue ArgumentError
         error("Invalid --parallel value, must be a positive number!")
       end
-      alias validate_parallel_args parallel_threads
+      alias cast_parallel_threads_arg! parallel_threads
 
       # Scan for allure results paths
       #
@@ -186,12 +225,20 @@ module Publisher
         exit(ignore ? 0 : 1)
       end
 
+      # Gitlab artifacts store
+      #
+      # @return [Boolean] true if gitlab artifacts store is used
+      def gitlab_artifacts?
+        args[:type] == "gitlab-artifacts"
+      end
+
       # Generate allure report
       #
+      # @param [Array<String>] extra_args
       # @return [void]
-      def generate_report
+      def generate_report(extra_args)
         log("Generating allure report")
-        Spinner.spin("generating", debug: args[:debug]) { uploader.generate_report }
+        Spinner.spin("generating", debug: args[:debug]) { uploader.generate_report(extra_args) }
       end
 
       # Upload report to cloud storage
@@ -199,7 +246,13 @@ module Publisher
       # @return [void]
       def upload_report
         log("Uploading allure report to #{args[:type]}")
-        Spinner.spin("uploading", debug: args[:debug]) { uploader.upload }
+        # gitlab-artifacts by default will raise error with info about upload using artifacts
+        spinner_args = {
+          debug: args[:debug],
+          exit_on_error: !gitlab_artifacts?,
+          failed_message: gitlab_artifacts? ? "skipped" : nil
+        }.compact
+        Spinner.spin("uploading", **spinner_args) { uploader.upload }
         uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
       end
 

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

@@ -64,6 +64,18 @@ module Publisher
       ENV[name]
     end
 
+    # Return environment variable as integer if it's numeric
+    #
+    # @param [String] name
+    # @return [Integer, nil]
+    def env_int(name)
+      value = env(name)
+      return unless value
+      raise("Invalid integer value for #{name}") unless value.match?(/\A-?\d+\z/)
+
+      value.to_i
+    end
+
     module_function
 
     # Colorize string

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

@@ -24,20 +24,27 @@ module Publisher
       # @param [Boolean] exit_on_error
       # @param [Proc] &block
       # @return [void]
-      def self.spin(spinner_message, done_message: "done", exit_on_error: true, debug: false, &block)
-        new(spinner_message, exit_on_error: exit_on_error, debug: debug).spin(done_message, &block)
+      def self.spin(
+        spinner_message,
+        done_message: "done",
+        failed_message: "failed",
+        exit_on_error: true,
+        debug: false,
+        &block
+      )
+        new(spinner_message, exit_on_error: exit_on_error, debug: debug).spin(done_message, failed_message, &block)
       end
 
       # Run code block inside spinner
       #
       # @param [String] done_message
       # @return [Boolean]
-      def spin(done_message = "done")
+      def spin(done_message = "done", failed_message = "failed")
         spinner.auto_spin
         yield
         spinner_success(done_message)
       rescue StandardError => e
-        spinner_error(e)
+        spinner_error(e, done_message: failed_message)
         raise(Failure, e.message) if exit_on_error
       ensure
         print_debug
@@ -119,8 +126,8 @@ module Publisher
     #
     # @param [StandardError] error
     # @return [void]
-    def spinner_error(error)
-      message = ["failed", error.message]
+    def spinner_error(error, done_message: "failed")
+      message = [done_message, error.message]
       log_debug("Error: #{error.message}\n#{error.backtrace.join("\n")}")
 
       colored_message = colorize(message.compact.join("\n"), error_color)

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

@@ -19,18 +19,8 @@ module Publisher
       def_delegators :"Publisher::Providers::Info::Github.instance",
                      :repository,
                      :server_url,
-                     :build_name
-
-      # Github api client
-      #
-      # @return [Octokit::Client]
-      def client
-        @client ||= begin
-          raise("Missing GITHUB_AUTH_TOKEN environment variable!") unless ENV["GITHUB_AUTH_TOKEN"]
-
-          Octokit::Client.new(access_token: ENV["GITHUB_AUTH_TOKEN"], api_endpoint: ENV["GITHUB_API_URL"])
-        end
-      end
+                     :build_name,
+                     :client
 
       # Update pull request description
       #

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

@@ -15,21 +15,8 @@ module Publisher
                      :mr_iid,
                      :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
+                     :build_name,
+                     :client
 
       # Current pull request description
       #

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

@@ -11,6 +11,13 @@ module Publisher
 
         # :nocov:
 
+        # CI provider api client
+        #
+        # @return [Object]
+        def client
+          raise("Not implemented!")
+        end
+
         # CI Provider executor info
         #
         # @param [String] report_url

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

@@ -23,6 +23,17 @@ module Publisher
           }
         end
 
+        # Github api client
+        #
+        # @return [Octokit::Client]
+        def client
+          @client ||= begin
+            raise("Missing GITHUB_AUTH_TOKEN environment variable!") unless ENV["GITHUB_AUTH_TOKEN"]
+
+            Octokit::Client.new(access_token: ENV["GITHUB_AUTH_TOKEN"], api_endpoint: ENV["GITHUB_API_URL"])
+          end
+        end
+
         # Pull request run
         #
         # @return [Boolean]

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

@@ -23,6 +23,20 @@ module Publisher
           }
         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
+
         # Pull request run
         #
         # @return [Boolean]
@@ -32,9 +46,48 @@ module Publisher
 
         # Get ci run ID without creating instance of ci provider
         #
-        # @return [String]
+        # @return [Integer]
         def run_id
-          @run_id ||= env(ALLURE_RUN_ID) || ENV["CI_PIPELINE_ID"]
+          @run_id ||= env_int(ALLURE_RUN_ID) || env_int("CI_PIPELINE_ID")
+        end
+
+        # CI job ID
+        #
+        # @return [Integer]
+        def job_id
+          @job_id ||= env_int("CI_JOB_ID")
+        end
+
+        # Gitlab pages hostname
+        #
+        # @return [String]
+        def pages_hostname
+          @pages_hostname ||= env("CI_PAGES_HOSTNAME")
+        end
+
+        # CI project name
+        #
+        # @return [String]
+        def project_name
+          @project_name ||= env("CI_PROJECT_NAME")
+        end
+
+        # CI project ID
+        #
+        # @return [Integer]
+        def project_id
+          @project_id ||= env_int("CI_PROJECT_ID")
+        end
+
+        # Project directory
+        #
+        # @return [String] build directory
+        def build_dir
+          @build_dir ||= env("CI_PROJECT_DIR")
+        end
+
+        def branch
+          @branch ||= env("CI_MERGE_REQUEST_SOURCE_BRANCH_NAME") || env("CI_COMMIT_REF_NAME")
         end
 
         # Server url
@@ -62,21 +115,28 @@ module Publisher
         #
         # @return [Integer]
         def mr_iid
-          @mr_iid ||= allure_mr_iid || env("CI_MERGE_REQUEST_IID")
+          @mr_iid ||= allure_mr_iid || env_int("CI_MERGE_REQUEST_IID")
         end
 
         # Custom mr iid name
         #
-        # @return [String]
+        # @return [Integer]
         def allure_mr_iid
-          @allure_mr_iid ||= env("ALLURE_MERGE_REQUEST_IID")
+          @allure_mr_iid ||= env_int("ALLURE_MERGE_REQUEST_IID")
         end
 
-        # Job name
+        # Job name used in report
         #
         # @return [String]
         def build_name
-          @build_name ||= env(ALLURE_JOB_NAME) || env("CI_JOB_NAME")
+          @build_name ||= env(ALLURE_JOB_NAME) || job_name
+        end
+
+        # CI job name
+        #
+        # @return [String]
+        def job_name
+          @job_name ||= env("CI_JOB_NAME")
         end
       end
     end

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,18 +10,20 @@ module Publisher
   class ReportGenerator
     include Helpers
 
-    def initialize(result_paths, report_name)
+    def initialize(result_paths, report_name, report_path)
       @result_paths = result_paths.join(" ")
       @report_name = report_name
+      @report_path = report_path
     end
 
     # Generate allure report
     #
+    # @param [Array<String>] extra_args
     # @return [void]
-    def generate
+    def generate(extra_args = [])
       create_common_path
 
-      generate_report
+      generate_report(extra_args)
     end
 
     # Common path for history and executor info
@@ -34,12 +36,8 @@ module Publisher
     end
     alias create_common_path common_info_path
 
-    # Allure report directory
-    #
-    # @return [String]
-    def report_path
-      @report_path ||= File.join(Dir.tmpdir, "allure-report-#{Time.now.to_i}")
-    end
+    # @return [String] report path
+    attr_reader :report_path
 
     private
 
@@ -51,11 +49,13 @@ module Publisher
     # Generate allure report
     #
     # @return [void]
-    def generate_report
+    def generate_report(extra_args)
       log_debug("Generating allure report")
       cmd = ["allure generate --clean"]
       cmd << "--report-name '#{report_name}'" if report_name
       cmd << "--output #{report_path} #{common_info_path} #{result_paths}"
+      cmd.push(*extra_args) if extra_args.any?
+
       out = execute_shell(cmd.join(" "))
       log_debug("Generated allure report. #{out}".strip)
 

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

@@ -30,6 +30,7 @@ module Publisher
       # @option args [String] :copy_latest
       # @option args [String] :report_name
       # @option args [Integer] :parallel
+      # @option args [String] :output
       def initialize(**args)
         @result_paths = args[:result_paths]
         @bucket_name = args[:bucket]
@@ -38,24 +39,17 @@ module Publisher
         @copy_latest = ci_info && args[:copy_latest] # copy latest for ci only
         @report_name = args[:report_name]
         @parallel = args[:parallel]
-      end
-
-      # Execute allure report generation and upload
-      #
-      # @return [void]
-      def execute
-        generate_report
-        upload
+        @report_path = args[:output]
       end
 
       # Generate allure report
       #
       # @return [void]
-      def generate_report
+      def generate_report(extra_arguments = [])
         add_history
         add_executor_info
 
-        report_generator.generate
+        report_generator.generate(extra_arguments)
       end
 
       # Upload report to storage provider
@@ -98,7 +92,8 @@ module Publisher
                   :base_url,
                   :copy_latest,
                   :report_name,
-                  :parallel
+                  :parallel,
+                  :report_path
 
       def_delegator :report_generator, :common_info_path
 
@@ -159,7 +154,7 @@ module Publisher
       #
       # @return [Publisher::ReportGenerator]
       def report_generator
-        @report_generator ||= ReportGenerator.new(result_paths, report_name)
+        @report_generator ||= ReportGenerator.new(result_paths, report_name, report_path)
       end
 
       # Report path prefix
@@ -218,7 +213,7 @@ module Publisher
         end
       end
 
-      # Fetch allure report history
+      # Create allure report history dir
       #
       # @return [void]
       def create_history_dir

data/lib/allure_report_publisher/lib/uploaders/gitlab_artifacts.rb

@@ -0,0 +1,122 @@
+module Publisher
+  module Uploaders
+    # Uploads artifacts to GitLab
+    #
+    class GitlabArtifacts < Uploader
+      extend Forwardable
+
+      def initialize(**args)
+        super
+
+        # gitlab artifacts do not support having url to latest report
+        @copy_latest = false
+      end
+
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        @report_url ||= "https://#{pages_hostname}/-/#{project_name}/-/jobs/#{job_id}/artifacts/#{report_path}/index.html"
+      end
+
+      # No-op method as gitlab does not expose api to upload artifacts
+      #
+      # @return [void]
+      def upload
+        raise("Gitlab artifacts does not support upload operation! Report upload must be configured in the CI job.")
+      end
+
+      private
+
+      def_delegators :ci_info,
+                     :pages_hostname,
+                     :project_name,
+                     :project_id,
+                     :job_name,
+                     :job_id,
+                     :branch,
+                     :build_dir,
+                     :build_name,
+                     :server_url,
+                     :client
+
+      # Download allure history
+      #
+      # @return [void]
+      def download_history
+        log_debug("Downloading allure history from previous executions")
+
+        unless previous_job_id
+          log_debug("Previous execution not found, skipping history download")
+          return
+        end
+
+        log_debug("Fetching history from artifacts of job: #{previous_job_id}")
+        HISTORY.each do |file_name|
+          download_artifact_file(
+            previous_job_id,
+            "#{report_path}/history/#{file_name}",
+            path(common_info_path, "history", file_name)
+          )
+        end
+      end
+
+      # Last job from previous pipeline
+      #
+      # @return [Integer, nil] job id or nil if not found
+      def previous_job_id
+        return @previous_job_id if defined?(@previous_job_id)
+
+        log_debug("Fetching previous pipelines for ref: #{branch}")
+        pipelines = client.pipelines(
+          project_id,
+          ref: branch,
+          per_page: 50
+        ).map(&:id)
+        return @previous_pipeline_job_id = nil if pipelines.size < 2
+
+        previous_pipeline_index = pipelines.index(run_id) + 1
+        return @previous_job_id = nil if previous_pipeline_index >= pipelines.size
+
+        log_debug("Fetching last job id from pipeline: #{pipelines[previous_pipeline_index]}")
+        @previous_job_id = client.pipeline_jobs(
+          project_id,
+          pipelines[previous_pipeline_index],
+          scope: %w[success failed]
+        ).find { |job| job.name == build_name }&.id
+      end
+
+      # Current ref pipelines
+      #
+      # @return [Array<Hash>]
+      def pipelines
+        @pipelines ||= client.pipelines(project_id, ref: branch, per_page: 10)
+      end
+
+      def latest_job
+        @latest_job ||= pipelines.max_by(&:id)
+      end
+
+      # CI info
+      #
+      # @return [Providers::Info::Gitlab]
+      def ci_info
+        Providers::Info::Gitlab.instance
+      end
+
+      # Download specific artifact file
+      #
+      # @param job_id [Integer] job id
+      # @param artifact_path [String] path within artifacts
+      # @param local_path [String] local file path to save
+      # @return [void]
+      def download_artifact_file(job_id, artifact_path, local_path)
+        log_debug("Downloading artifact file: #{artifact_path} to #{local_path}")
+        # this will only work with history json files, see: https://github.com/NARKOZ/gitlab/issues/621
+        response = client.download_job_artifact_file(project_id, job_id, artifact_path)
+
+        File.write(local_path, response.to_json)
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.7.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -18,7 +18,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.184.0
+        version: 1.197.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: 1.93.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.184.0
+        version: 1.197.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
         version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -48,7 +48,7 @@ dependencies:
         version: '0.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +240,7 @@ files:
 - lib/allure_report_publisher/lib/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/gcs.rb
+- lib/allure_report_publisher/lib/uploaders/gitlab_artifacts.rb
 - lib/allure_report_publisher/lib/uploaders/s3.rb
 - lib/allure_report_publisher/version.rb
 homepage: https://github.com/andrcuns/allure-report-uploader
@@ -265,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Allure report uploader
 test_files: []