allure-report-publisher 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5c4eb0b467125c36d80b35b99f7ec44ff1561a21bcc305d78a9afc4eaace1d
-  data.tar.gz: a525a10cae5378628ebf74d0a128ae9561db9f13b0ed023b992a404376b8ea1e
+  metadata.gz: 420438541bb271acbd5087eeb32afa461f9970d6fea36bd8b7394ac7392a5364
+  data.tar.gz: 762b5f3cdc21a57aa4dcfca924bac0cb5138ecb85c6bd154bffc9d92c24bc8bc
 SHA512:
-  metadata.gz: c51b6b05861023942c761e80c0f777609dd0287f9f0724a4bc0246d7faa28a52ee05b394e85ddae66ea3441aa4a35372a88e2fe9b34c052776af3500570f19c1
-  data.tar.gz: bf3deb92f34c1899fc0c3bdce08cb6fa96652eac0493799b595894c3219baf200acf9a5f784a5ada92d24fe41ced54a9ac043678c82f850206a80d737e9a8909
+  metadata.gz: b348c695ea4c51981aa0c02f1a7172ec10789109adfb9ad11262612e394694b0d15ef82fbfaba85e4fe3c7d8e2407b6a17afce78eeeabe94e41b271da62de983
+  data.tar.gz: 39fa239c54ea236ae902e1cf203bbb643495c94f140d2d06e8e3a1c37b408b2c8dac1ff6acc839fe4fa30cc7ef1ebcc5a69c7f47e4096949d88dd6c7592abeaa

data/README.md

@@ -50,6 +50,7 @@ Options:
   --update-pr=VALUE                 # Add report url to PR via comment or description update. Required: false: (comment/description)
   --[no-]copy-latest                # Keep copy of latest report at base prefix path, default: false
   --[no-]color                      # Toggle color output, default: false
+  --[no-]ignore-missing-results     # Ignore missing allure results, default: false
   --help, -h                        # Print this help
 
 Examples:
@@ -65,6 +66,12 @@ Multiple cloud storage providers are supported
 
 Requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
 
+Additional configuration:
+
+- `AWS_REGION`: configure s3 region, default: `us-east-1`
+- `AWS_FORCE_PATH_STYLE`: when set to true, the bucket name is always left in the request URI and never moved to the host as a sub-domain, default: `false`
+- `AWS_ENDPOINT`: custom s3 endpoint when used with other s3 compatible storage
+
 ## Google Cloud Storage
 
 Requires on of the following environment variables.

data/lib/allure_report_publisher/commands/upload.rb

@@ -31,6 +31,10 @@ module Publisher
              type: :boolean,
              default: false,
              desc: "Toggle color output"
+      option :ignore_missing_results,
+             type: :boolean,
+             default: false,
+             desc: "Ignore missing allure results"
 
       example [
         "s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket",
@@ -38,10 +42,11 @@ module Publisher
       ]
 
       def call(**args)
-        validate_args(args)
-        validate_result_files(args[:results_glob])
         Helpers.pastel(force_color: args[:color] || nil)
 
+        validate_args(args)
+        validate_result_files(args[:results_glob], args[:ignore_missing_results])
+
         uploader = uploaders(args[:type]).new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
 
         log("Generating allure report")
@@ -82,8 +87,11 @@ module Publisher
       #
       # @param [String] results_glob
       # @return [void]
-      def validate_result_files(results_glob)
-        Dir.glob(results_glob).empty? && error("Glob '#{results_glob}' did not match any files!")
+      def validate_result_files(results_glob, ignore)
+        return unless Dir.glob(results_glob).empty?
+
+        log("Glob '#{results_glob}' did not match any files!", ignore ? :yellow : :red)
+        exit(ignore ? 0 : 1)
       end
     end
   end

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

@@ -74,11 +74,11 @@ module Publisher
       # @return [Gitlab::Client]
       def client
         @client ||= begin
-          raise("Missing GITLAB_AUTH_TOKEN environment variable!") unless ENV["GITLAB_AUTH_TOKEN"]
+          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"]
+            private_token: env("GITLAB_AUTH_TOKEN")
           )
         end
       end
@@ -87,67 +87,77 @@ module Publisher
       #
       # @return [String]
       def allure_project
-        @allure_project ||= ENV["ALLURE_PROJECT_PATH"]
+        @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"]
+        @allure_mr_iid ||= env("ALLURE_MERGE_REQUEST_IID")
       end
 
       # Custom sha
       #
       # @return [String]
       def allure_sha
-        @allure_sha ||= ENV["ALLURE_COMMIT_SHA"]
+        @allure_sha ||= env("ALLURE_COMMIT_SHA")
       end
 
       # Gitlab project path
       #
       # @return [String]
       def project
-        @project ||= allure_project || ENV["CI_PROJECT_PATH"]
+        @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"]
+        @mr_iid ||= allure_mr_iid || env("CI_MERGE_REQUEST_IID")
       end
 
       # Server url
       #
       # @return [String]
       def server_url
-        @server_url ||= ENV["CI_SERVER_URL"]
+        @server_url ||= env("CI_SERVER_URL")
       end
 
       # Build url
       #
       # @return [String]
       def build_url
-        @build_url ||= ENV["CI_PIPELINE_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"]
+        @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"]
+        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
+
+      # Return non empty environment variable value
+      #
+      # @param [String] name
+      # @return [String, nil]
+      def env(name)
+        return unless ENV[name] && !ENV[name].empty?
+
+        ENV[name]
+      end
     end
   end
 end

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

@@ -11,7 +11,7 @@ module Publisher
       #
       # @return [Aws::S3::Client]
       def client
-        @client ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
+        @client ||= Aws::S3::Client.new(client_args)
       rescue Aws::Sigv4::Errors::MissingCredentialsError
         raise(<<~MSG.strip)
           missing aws credentials, provide credentials with one of the following options:
@@ -20,6 +20,14 @@ module Publisher
         MSG
       end
 
+      def client_args
+        @client_args ||= {
+          region: ENV["AWS_REGION"] || "us-east-1",
+          force_path_style: ENV["AWS_FORCE_PATH_STYLE"] == "true",
+          endpoint: ENV["AWS_ENDPOINT"]
+        }.compact
+      end
+
       # Report url
       #
       # @return [String]

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-24 00:00:00.000000000 Z
+date: 2021-07-02 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.96.0
+        version: 1.97.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.96.0
+        version: 1.97.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement