allure-report-publisher 4.7.2 → 4.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9194381dcb70e7baa4e84f45701be5a52f2092e9247b082a8728ddc1a7e50e
-  data.tar.gz: 5831373722f1cc7fba6c15a7c560a6dbe14813c484e654ccbe8b6608997437f4
+  metadata.gz: 7b42958bc772951cf42ff0866ff1b6817f83a8c7adb27d1bc010d853bed1cf08
+  data.tar.gz: 3dbb36855c6252822622e96ce6c793fe2af42ff9d5da5bca7bf7cd6700bdd32e
 SHA512:
-  metadata.gz: 0ae5230e086cfd5567bc08f40b6e08ddaabf0311303c8e9d8f96482f35aff969ad0e16107eb42aa59ec2ce507cad7be22c9f9080a46ee2b72a7744f3dde9fd95
-  data.tar.gz: f58585e71f8f4277052dbf058ef22ee82c554bccb85f15c9d21157914fcee568f65a63eda029c41487f5d065ee277c0e8b41855b45249bc3eab4f1e1c8cd27d6
+  metadata.gz: 85f21038dff84dbe1a2d0f2ca6ab8045606d0b664d975df2b567f4cb5c532b4d49a979eb6e45afbabd92c475b7a162c71bc42e8076f25494435d906223da2c10
+  data.tar.gz: b7a77a045f429c315772d4e9441d55e03ed451e0ab9c2ff8fe4a9d81a3c39875f51709fc97fe23751804f5527abe2c3dcfe0f14ca5ca5252c9fb5265d34738b9

data/README.md

@@ -48,7 +48,7 @@ Options:
   --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. Ignored for gitlab-artifacts
+  --base-url=VALUE                  # Use custom base url instead of default cloud provider one. Required: false. For gitlab-artifacts, replaces default gitlab.io pages hostname
   --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

data/lib/allure_report_publisher/commands/upload.rb

@@ -57,7 +57,7 @@ module Publisher
              ]
       option :base_url,
              type: :string,
-             desc: "Use custom base url instead of default cloud provider one. Required: false. Ignored for gitlab-artifacts"
+             desc: "Use custom base url instead of default cloud provider one. Required: false. For gitlab-artifacts, replaces default gitlab.io pages hostname"
       option :parallel,
              type: :integer,
              desc: "Number of parallel threads to use for report file upload to cloud storage. Required: false",
@@ -191,7 +191,7 @@ module Publisher
       #
       # @return [void]
       def validate_base_url!
-        return unless args[:base_url] && !gitlab_artifacts?
+        return unless args[:base_url]
 
         URI.parse(args[:base_url])
       rescue URI::InvalidURIError

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

@@ -58,18 +58,11 @@ module Publisher
           @job_id ||= env_int("CI_JOB_ID")
         end
 
-        # Gitlab pages hostname
+        # Full project path
         #
-        # @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")
+        # @return [String] full project path
+        def project_path
+          @project_path ||= env("CI_PROJECT_PATH")
         end
 
         # CI project ID

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

@@ -177,6 +177,13 @@ module Publisher
                           .reject(&:directory?)
       end
 
+      # History files array
+      #
+      # @return [Array<Pathname>]
+      def history_files
+        @history_files ||= report_files.select { |file| file.fnmatch?("*/history/*") }
+      end
+
       # Get run id
       #
       # @return [String]

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

@@ -41,12 +41,13 @@ module Publisher
       def download_history
         log_debug("Downloading previous run history")
         HISTORY.each do |file_name|
-          file = bucket.file(key(prefix, "history", file_name))
+          source_file = key(prefix, "history", file_name)
+          file = bucket.file(source_file)
           raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
 
           file_path = path(common_info_path, "history", file_name)
           file.download(file_path)
-          log_debug("Downloaded '#{file_name}' as '#{file_path}'")
+          log_debug("Downloaded '#{source_file}' to '#{file_path}'")
         end
       end
 
@@ -55,7 +56,7 @@ module Publisher
       # @return [void]
       def upload_history
         log_debug("Uploading report history")
-        upload_to_gcs(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+        upload_to_gcs(history_files, prefix)
       end
 
       # Upload allure report

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

@@ -5,6 +5,8 @@ module Publisher
     class GitlabArtifacts < Uploader
       extend Forwardable
 
+      DEFAULT_PAGES_DOMAIN = "gitlab.io".freeze
+
       def initialize(**args)
         super
 
@@ -16,7 +18,7 @@ module Publisher
       #
       # @return [String]
       def report_url
-        @report_url ||= "https://#{pages_hostname}/-/#{project_name}/-/jobs/#{job_id}/artifacts/#{report_path}/index.html"
+        @report_url ||= "#{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
@@ -29,8 +31,7 @@ module Publisher
       private
 
       def_delegators :ci_info,
-                     :pages_hostname,
-                     :project_name,
+                     :project_path,
                      :project_id,
                      :job_name,
                      :job_id,
@@ -95,8 +96,29 @@ module Publisher
         @pipelines ||= client.pipelines(project_id, ref: branch, per_page: 10)
       end
 
-      def latest_job
-        @latest_job ||= pipelines.max_by(&:id)
+      # Top level group name
+      #
+      # @return [String]
+      def top_level_group
+        @top_level_group ||= project_path.split("/").first
+      end
+
+      # Project path without top level group name
+      #
+      # @return [String]
+      def project_name
+        @project_name ||= project_path.split("/")[1..].join("/")
+      end
+
+      # Pages hostname
+      #
+      # @return [String]
+      def pages_hostname
+        # built in variables of gitlab CI return incorrect pages hostname so it needs to be built manually
+        return "https://#{top_level_group}.#{DEFAULT_PAGES_DOMAIN}" unless base_url
+
+        host, scheme = URI.parse(base_url).then { |uri| [uri.host, uri.scheme || "https"] }
+        "#{scheme}://#{top_level_group}.#{host}"
       end
 
       # CI info
@@ -117,7 +139,7 @@ module Publisher
         # 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)
+        File.write(local_path, response.string)
       end
     end
   end

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

@@ -63,13 +63,14 @@ module Publisher
       def download_history
         log_debug("Downloading previous run history")
         HISTORY.each do |file_name|
+          source_file = key(prefix, "history", file_name)
           file_path = path(common_info_path, "history", file_name)
           client.get_object(
             response_target: file_path,
-            key: key(prefix, "history", file_name),
+            key: source_file,
             bucket: bucket_name
           )
-          log_debug("Downloaded '#{file_name}' as '#{file_path}'")
+          log_debug("Downloaded '#{source_file}' to '#{file_path}'")
         end
       rescue Aws::S3::Errors::NoSuchKey
         raise(HistoryNotFoundError, "Allure history from previous runs not found!")
@@ -80,7 +81,7 @@ module Publisher
       # @return [void]
       def upload_history
         log_debug("Uploading report history")
-        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+        upload_to_s3(history_files, prefix)
       end
 
       # Upload allure report

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 4.7.4
 platform: ruby
 authors:
 - Andrejs Cunskis