allure-report-publisher 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5ab2c7fe9d71734c9f57324a411d2dfb3034a63152e75a3827f3629375371b
-  data.tar.gz: 56296208184a82b42bfb04c7132788e6b4f924be16c4059a4e03e6782f9f54f2
+  metadata.gz: 54d60b7dd8fe199bba542f83cdaf9cab784417050c4fa81f114ea40de9a2227e
+  data.tar.gz: 486c1f70aa161a59277cfb01b5986fa145b2c4e4cf1231b22a064f959195551c
 SHA512:
-  metadata.gz: 60889df0f7995284adc34651a042f90f29a0a32f93895636b991205eafc078f696dd9f0117f28e3d85b111bf0d7fe84c4daa5a89f95a5cf4a295547a20c9c8b9
-  data.tar.gz: 0a5c6206ed052dd912b57e524190209993d5e58435a5ce4a28d3a1117fd4bc1191b6ae23d441ab2ec98588518bb18bba7aa9b3a9a2b6ed6fdd6c42480d0614ec
+  metadata.gz: a303ddf16eeeca0db453aaed7ff554b1214a1b8f9b9c51af6dc27ca082c8c4ba002001b1e4c681e72340302ed42d95c3f2934cd45ed2bab0a6bcd7d29af33751
+  data.tar.gz: 7688b003e010562c258fa4c705c5736df82e8ff71264ecb21f89275f1027d0b0631f504e23b877ff419a37689d07100f6b159f47647387ab9b7f4db08ca6b54e

data/README.md

@@ -1,3 +1,5 @@
+# allure-report-publisher
+
 [![Gem Version](https://img.shields.io/gem/v/allure-report-publisher?color=red)](https://rubygems.org/gems/allure-report-publisher)
 [![Gem Pulls](https://img.shields.io/gem/dt/allure-report-publisher)](https://rubygems.org/gems/allure-report-publisher)
 [![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)
@@ -7,31 +9,25 @@
 [![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)
 
-# allure-report-publisher
-
 Upload your report to a file storage of your choice.
 
 ![Demo](demo.gif)
 
-## Installation
+# Installation
 
-### Rubygems
+## Rubygems
 
 ```shell
 gem install allure-report-uploader
 ```
 
-### Docker
+## Docker
 
 ```shell
 docker pull andrcuns/allure-report-publisher:latest
 ```
 
-## Usage
-
-allure-report-publisher will automatically detect if used in CI environment and add relevant executor info and history
-
-- `--update-pr=(comment|description)`: requires `GITHUB_AUTH_TOKEN` or `GITLAB_AUTH_TOKEN` in order to update pull request with links to allure reports
+# Usage
 
 ```shell
 $ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload --help
@@ -54,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:
@@ -61,11 +58,15 @@ Examples:
   allure-report-publisher upload gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs
 ```
 
-### AWS S3
+# Storage providers
+
+Multiple cloud storage providers are supported
+
+## AWS S3
 
 Requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
 
-### Google Cloud Storage
+## Google Cloud Storage
 
 Requires on of the following environment variables.
 
@@ -86,20 +87,77 @@ credentials.json contents:
 - `GOOGLE_CLOUD_KEYFILE_JSON`
 - `GCLOUD_KEYFILE_JSON`
 
-## Development
+# CI
+
+`allure-report-publisher` will automatically detect if used in CI environment and add relevant executor info and history.
+
+Following CI providers are supported:
+
+- Github Actions
+- Gitlab CI
+
+## Pull requests
+
+It is possible to update pull requests with urls to published reports.
+
+- `--update-pr=(comment|description)`: post report urls in pr description or as a comment
+
+Example:
+
+---
+
+`# Allure report`
+
+`allure-report-publisher` generated test report for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)!
+
+**rspec**: 📝 [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html)
+
+---
+
+## Github Actions
+
+Additional configuration is done via environment variables
+
+Authentication for PR updates:
+
+- `GITHUB_AUTH_TOKEN`: github auth token with api access
+
+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
+
+## Gitlab CI
+
+Additional configuration is done via environment variables
+
+Authentication for MR updates:
+
+- `GITLAB_AUTH_TOKEN`: gitlab access token with api access
+
+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
+
+In case merge request triggers a downstream pipeline yet you want to update original merge request, overriding following environment variables might be useful:
+
+- `ALLURE_PROJECT_PATH`: overrides default `CI_PROJECT_PATH` value
+- `ALLURE_MERGE_REQUEST_IID`: overrides default `CI_MERGE_REQUEST_IID` value
+- `ALLURE_COMMIT_SHA`: overrides default `CI_MERGE_REQUEST_SOURCE_BRANCH_SHA` or `CI_COMMIT_SHA` values
+
+# Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
-## Contributing
+# Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/andrcuns/allure-report-publisher>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).
 
-## License
+# License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+# Code of Conduct
 
 Everyone interacting in the allure-report-publisher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).

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

@@ -16,7 +16,7 @@ module Publisher
       #
       # @return [Boolean]
       def pr?
-        ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+        (allure_project && allure_mr_iid) || ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
       end
 
       # Get executor info
@@ -74,59 +74,90 @@ 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
 
+      # Custom repository name
+      #
+      # @return [String]
+      def allure_project
+        @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")
+      end
+
+      # Custom sha
+      #
+      # @return [String]
+      def allure_sha
+        @allure_sha ||= env("ALLURE_COMMIT_SHA")
+      end
+
+      # Gitlab project path
+      #
+      # @return [String]
+      def project
+        @project ||= allure_project || env("CI_PROJECT_PATH")
+      end
+
       # Merge request iid
       #
       # @return [Integer]
       def mr_iid
-        @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"]
-      end
-
-      # Gitlab repository
-      #
-      # @return [String]
-      def project
-        @project ||= ENV["CI_PROJECT_PATH"]
+        @build_name ||= env(ALLURE_JOB_NAME) || env("CI_JOB_NAME")
       end
 
       # Commit sha url
       #
       # @return [String]
       def sha_url
-        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/providers/url_section_builder.rb

@@ -48,7 +48,7 @@ module Publisher
       # Allure report url pr description
       #
       # @return [String]
-      def body(job_entries = "**#{build_name}**: 📝 [allure report](#{report_url})")
+      def body(job_entries = job_entry)
         @body ||= <<~BODY.strip
           <!-- allure -->
           ---
@@ -65,7 +65,7 @@ module Publisher
       #
       # @return [String]
       def heading
-        @heading ||= "# Allure report\n`allure-report-publisher` generated allure report for #{sha_url}!"
+        @heading ||= "# Allure report\n`allure-report-publisher` generated test report for #{sha_url}!"
       end
 
       # Return updated jobs section
@@ -83,14 +83,14 @@ module Publisher
       #
       # @return [String]
       def job_entry
-        @job_entry ||= "**#{build_name}**: 📝 [allure report](#{report_url})"
+        @job_entry ||= "**#{build_name}**: 📝 [test report](#{report_url})<br />"
       end
 
       # Job entry pattern
       #
       # @return [RegExp]
       def job_entry_pattern
-        @job_entry_pattern ||= /^\*\*#{build_name}\*\*:.*\[allure report\]\(.*\)$/
+        @job_entry_pattern ||= %r{^\*\*#{build_name}\*\*:.*\[test report\]\(.*\)<br />$}
       end
     end
   end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-06-12 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.95.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.95.0
+        version: 1.97.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement