allure-report-publisher 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f7655105dbfd46700acb9b6045fdb563542697d88891f2ac1983d6d6d9a2cc3
-  data.tar.gz: d13ed56a3356b42060fa10ccc665765d2e3453cbd1090f483198b6c03a636555
+  metadata.gz: b57fedd5eddc21b48d4c01d4c8858cf4c3c2638d239973a195612fbc14e885f5
+  data.tar.gz: c3745051f24d11bbc89c229aaceddb2c8f4cb97fce2b8e6a8029c0c36099e353
 SHA512:
-  metadata.gz: 7ff3f600d92b168111027c203e3b0d61b25aae3ba99cb01df372d0e0003ca6706fe3dfa5c07c2402f6d0e5f90eff19f95b790877a466d46e8627c90fc9177932
-  data.tar.gz: 7799a9144ceb663551f461a0e503ec9051f9be0588bbf60598d8cf7953b67fd3771ea5eec68ab0aff259d15c7a67422a65d5739278a8215af9a8992a939f70d6
+  metadata.gz: bc55ecf458d787dc7813fe08bc8e12459cda59e73eeb8fe2de3ab6b52730382ba8e1af563d0181ac82eb612cc9f684795c4a1921e77b853834c6f7df4e078c45
+  data.tar.gz: 4e134f36135b30fd8e1185ea85091d5d477cb90b95082b606d490dba6fc519d38c6e7d4e5b4ab7ca6f2b656426822c97fc5e510daf1de12153a281a03e914c33

data/README.md

@@ -47,6 +47,7 @@ Options:
   --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)
   --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
@@ -68,7 +69,7 @@ Examples:
 
 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`
+Example: `--results-glob` can be configured via `ALLURE_RESULTS_GLOB`
 
 # Storage providers
 
@@ -156,6 +157,7 @@ Authentication for PR updates:
 Following environment variables can override default CI values:
 
 - `ALLURE_JOB_NAME`: overrides default `GITHUB_JOB` value which is used as name for report url section
+- `ALLURE_RUN_ID`: overrides default `GITHUB_RUN_ID` value which is used as name for the run number
 
 ### allure-publish-action
 
@@ -176,6 +178,7 @@ Authentication for MR updates:
 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
+- `ALLURE_RUN_ID`: overrides default `CI_PIPELINE_ID` value which is used as name for the run number
 
 In case merge request triggers a downstream pipeline yet you want to update original merge request, overriding following environment variables might be useful:
 

data/lib/allure_report_publisher/commands/upload.rb

@@ -29,6 +29,9 @@ module Publisher
              type: :string,
              default: "Allure Report",
              desc: "Title for url section in PR comment/description. Required: false"
+      option :report_name,
+             type: :string,
+             desc: "Custom report name in final Allure report. Required: false"
       option :summary,
              type: :string,
              desc: "Additionally add summary table to PR comment or description. Required: false",
@@ -109,7 +112,7 @@ module Publisher
       def uploader
         @uploader ||= uploaders(args[:type]).new(
           result_paths: @result_paths,
-          **args.slice(:bucket, :prefix, :base_url, :copy_latest)
+          **args.slice(:bucket, :prefix, :base_url, :copy_latest, :report_name)
         )
       end
 

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

@@ -12,6 +12,7 @@ module Publisher
 
       def_delegators :"Publisher::Providers::Info::Gitlab.instance",
                      :allure_project,
+                     :mr_iid,
                      :allure_mr_iid,
                      :server_url,
                      :build_name
@@ -68,13 +69,6 @@ module Publisher
         @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]

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

@@ -7,6 +7,7 @@ module Publisher
       #
       class Base
         ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
+        ALLURE_RUN_ID = "ALLURE_RUN_ID".freeze
 
         # :nocov:
 

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

@@ -34,7 +34,7 @@ module Publisher
         #
         # @return [String]
         def run_id
-          @run_id ||= env("GITHUB_RUN_ID")
+          @run_id ||= env(ALLURE_RUN_ID) || env("GITHUB_RUN_ID")
         end
 
         # Server url

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

@@ -27,14 +27,14 @@ module Publisher
         #
         # @return [Boolean]
         def pr?
-          !!(allure_project && allure_mr_iid) || ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+          !!((allure_project && allure_mr_iid) || mr_iid)
         end
 
         # Get ci run ID without creating instance of ci provider
         #
         # @return [String]
         def run_id
-          @run_id ||= ENV["CI_PIPELINE_ID"]
+          @run_id ||= env(ALLURE_RUN_ID) || ENV["CI_PIPELINE_ID"]
         end
 
         # Server url
@@ -58,6 +58,13 @@ module Publisher
           @allure_project ||= env("ALLURE_PROJECT_PATH")
         end
 
+        # Merge request iid
+        #
+        # @return [Integer]
+        def mr_iid
+          @mr_iid ||= allure_mr_iid || env("CI_MERGE_REQUEST_IID")
+        end
+
         # Custom mr iid name
         #
         # @return [String]

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,8 +10,9 @@ module Publisher
   class ReportGenerator
     include Helpers
 
-    def initialize(result_paths)
+    def initialize(result_paths, report_name)
       @result_paths = result_paths.join(" ")
+      @report_name = report_name
     end
 
     # Generate allure report
@@ -44,14 +45,18 @@ module Publisher
 
     # @return [String] result paths string
     attr_reader :result_paths
+    # @return [String] custom report name
+    attr_reader :report_name
 
     # Generate allure report
     #
     # @return [void]
     def generate_report
       log_debug("Generating allure report")
-      cmd = "allure generate --clean --output #{report_path} #{common_info_path} #{result_paths}"
-      out = execute_shell(cmd)
+      cmd = ["allure generate --clean"]
+      cmd << "--report-name '#{report_name}'" if report_name
+      cmd << "--output #{report_path} #{common_info_path} #{result_paths}"
+      out = execute_shell(cmd.join(" "))
       log_debug("Generated allure report. #{out}".strip)
 
       deduplicate_executors

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

@@ -30,12 +30,14 @@ module Publisher
       # @option args [String] :prefix
       # @option args [String] :base_url
       # @option args [String] :copy_latest
+      # @option args [String] :report_name
       def initialize(**args)
         @result_paths = args[:result_paths]
         @bucket_name = args[:bucket]
         @prefix = args[:prefix]
         @base_url = args[:base_url]
         @copy_latest = ci_info && args[:copy_latest] # copy latest for ci only
+        @report_name = args[:report_name]
       end
 
       # Execute allure report generation and upload
@@ -94,7 +96,8 @@ module Publisher
                   :bucket_name,
                   :prefix,
                   :base_url,
-                  :copy_latest
+                  :copy_latest,
+                  :report_name
 
       def_delegator :report_generator, :common_info_path
 
@@ -155,7 +158,7 @@ module Publisher
       #
       # @return [Publisher::ReportGenerator]
       def report_generator
-        @report_generator ||= ReportGenerator.new(result_paths)
+        @report_generator ||= ReportGenerator.new(result_paths, report_name)
       end
 
       # Report path prefix

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-01-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.142.0
+        version: 1.143.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.142.0
+        version: 1.143.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Allure report uploader