allure-report-publisher 4.7.1 → 4.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bb8e40a07b6be84137b396ca54ecbf9a2ed982686e7c547440d05f92fafb4f9
-  data.tar.gz: 94ad353721fb09c4466d6d6ff185ac6179e4ce27407859edfa3f56fa49687f2d
+  metadata.gz: eb5c2b6dc7b110284945c9d083603b68b39a573b047f82acebd6045a8b88bd79
+  data.tar.gz: 81fe6d11a19b8040503ccf8a61e620d09fc164a9244423dfff07df89d6f88425
 SHA512:
-  metadata.gz: d8557b6da70706bd0a08981ab50f8e2c3b4b6eea863d2d9fe9001d2d48c4ffbb961c451017fabe5bfaac5100ee1aff9ca9addc9e7704b867daff797968380a02
-  data.tar.gz: 86c8500a73d8d4511088751c79976d2ff3cb19020f4ad64c8feadff9e4026c34c38ecf33c9acc666736081300e8515ce0958745754d966f71ab40073525fd28d
+  metadata.gz: 478172dea4924daea11efe38ce89c4f4db4a927bb19fa7d686e0038d2392930ec359c28dcd787ba992082c0b5992f491a4f5f351a1b49b5f25b7da7f9a59353d
+  data.tar.gz: 29484941212d4952364221f72a88cc6f5b3c00600388ee0c3b35579f79ae64876fa4215f5862d6f5736727dfe4b9f1ce117d87dbd879932a41767f072de68f19

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",
@@ -118,7 +118,7 @@ module Publisher
       # @return [String] output path
       def output
         @output ||= args[:output].then do |path|
-          next if path
+          next path if path && !path.empty?
 
           gitlab_artifacts? ? "allure-report" : File.join(Dir.tmpdir, "allure-report-#{Time.now.to_i}")
         end
@@ -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/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,
@@ -60,7 +61,7 @@ module Publisher
           )
         end
       rescue StandardError => e
-        log("Failed to download allure history: #{e.message}", :yellow)
+        raise(HistoryNotFoundError, e.message)
       end
 
       # Last job from previous pipeline
@@ -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

data/lib/allure_report_publisher/version.rb

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

metadata

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