allure-report-publisher 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2212afd20c080df89b88eab18ae8fa96a6b8d00027af95b2b606e9b851b83dde
-  data.tar.gz: b6473ed381ddb267af1fcaee0ef6080a3c8063dac4d56ea5cbf0589457c7598e
+  metadata.gz: 95dbd5a6e6f9c26a3a2e3623be240fdd6946acd1be0bbab199ba17f764b7dab4
+  data.tar.gz: 1f59fb0652c77dfed7178cae2c6d44cbf7308471c545f17df421998398d5d939
 SHA512:
-  metadata.gz: e28a752bdaaf619bf293c6a4f995a17e7cdea913c6c1c89be07dcb14c575a2b78264bbb6fad03d2b1ec574c2d0c72fd04ce84431e7920e6ac7180b5f4006c54c
-  data.tar.gz: aa8f768c03494a14b6dcafc9ada76764b028f750f6ff104627bb669c431321074fbac76ae81ab84df6510988d7cf161a9863c796c6615e343193ae2708979419
+  metadata.gz: 72825f58185c1096d04c39733fb3292c87135681793fd9818e052dbe770204b6d9eb28b305a59df3b1d07536b723b48b2229993f1786eee279fb2c3bfc05e7a7
+  data.tar.gz: 43ef3a41b8f81f7d067dbba7602e37d9e8ed574ffc7e7d8dbd696a39fedc85e05c92ed90b4ee713c8c9619fd537bd3a062d6da662242aaefad7d377c28d34778

data/README.md

@@ -1,35 +1,33 @@
+# 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)
+[![Docker Pulls](https://img.shields.io/docker/pulls/andrcuns/allure-report-publisher)](https://hub.docker.com/r/andrcuns/allure-report-publisher)
 ![Workflow status](https://github.com/andrcuns/allure-report-publisher/workflows/Test/badge.svg)
-[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](http://allure-reports-andrcuns.s3.amazonaws.com/allure-report-publisher/refs/heads/main/index.html)
+[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html)
 [![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
-
-- `Allure report link`: requires `GITHUB_AUTH_TOKEN` or `GITLAB_AUTH_TOKEN` in order to update pull request description with link to latest report
+# Usage
 
 ```shell
 $ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload --help
@@ -43,44 +41,122 @@ Description:
   Generate and upload allure report
 
 Arguments:
-  TYPE                 # REQUIRED Cloud storage type: (s3/gcs)
+  TYPE                              # REQUIRED Cloud storage type: (s3/gcs)
 
 Options:
-  --results-glob=VALUE             # Allure results files glob. Required: true
-  --bucket=VALUE                   # Bucket name. Required: true
-  --prefix=VALUE                   # Optional prefix for report path. Required: false
-  --[no-]update-pr                 # Update pull request description with url to allure report, default: false
-  --[no-]copy-latest               # Keep copy of latest report at base prefix path, default: false
-  --[no-]color                     # Toggle color output, default: false
-  --help, -h                       # Print this help
+  --results-glob=VALUE              # Allure results files glob. Required: true
+  --bucket=VALUE                    # Bucket name. Required: true
+  --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)
+  --[no-]copy-latest                # Keep copy of latest report at base prefix path, default: false
+  --[no-]color                      # Toggle color output, default: false
+  --help, -h                        # Print this help
 
 Examples:
   allure-report-publisher upload s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket
   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
+
+Requires on of the following environment variables.
+
+credentials.json file location:
+
+- `STORAGE_CREDENTIALS`
+- `STORAGE_KEYFILE`
+- `GOOGLE_CLOUD_CREDENTIALS`
+- `GOOGLE_CLOUD_KEYFILE`
+- `GCLOUD_KEYFILE`
+
+credentials.json contents:
+
+- `GOOGLE_CLOUD_CREDENTIALS_JSON`
+- `STORAGE_CREDENTIALS_JSON`
+- `STORAGE_KEYFILE_JSON`
+- `GOOGLE_CLOUD_CREDENTIALS_JSON`
+- `GOOGLE_CLOUD_KEYFILE_JSON`
+- `GCLOUD_KEYFILE_JSON`
+
+# 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:
 
-- `AWS authentication`: requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
+- `ALLURE_JOB_NAME`: overrides default `CI_JOB_NAME` value which is used as name for report url section
 
-### Google Cloud Storage
+In case merge request triggers a downstream pipeline yet you want to update original merge request, overriding following environment variables might be useful:
 
-- `GCS authentication`: requires environment variable `GOOGLE_CLOUD_CREDENTIALS_JSON` with contents of credentials.json
+- `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
+# 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

@@ -22,7 +22,7 @@ module Publisher
       option :update_pr,
              type: :string,
              values: %w[comment description],
-             desc: "Add report url to PR via comment or description update"
+             desc: "Add report url to PR via comment or description update. Required: false"
       option :copy_latest,
              type: :boolean,
              default: false,
@@ -52,7 +52,7 @@ module Publisher
         uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
         return unless args[:update_pr] && uploader.pr?
 
-        log("Updating pull request description")
+        log("Adding reports urls")
         Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
       end
 

data/lib/allure_report_publisher/lib/helpers/spinner.rb

@@ -99,7 +99,7 @@ module Publisher
     # @param [String] error_message
     # @return [void]
     def spinner_error(error_message)
-      colored_message = colorize(error_message, error_color)
+      colored_message = colorize("failed\n#{error_message}", error_color)
       return spinner.error(colored_message) if tty?
 
       spinner.stop

data/lib/allure_report_publisher/lib/providers/_provider.rb

@@ -13,7 +13,6 @@ module Publisher
     # Base class for CI executor info
     #
     class Provider
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
       ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
 
       def initialize(report_url:, update_pr:)
@@ -82,20 +81,20 @@ module Publisher
         raise("Not implemented!")
       end
 
-      # Commit SHA url
+      # Build name
       #
       # @return [String]
-      def sha_url
+      def build_name
         raise("Not implemented!")
       end
-      # :nocov:
 
-      # Add report url as comment
+      # Commit SHA url
       #
-      # @return [Boolean]
-      def comment?
-        update_pr == "comment"
+      # @return [String]
+      def sha_url
+        raise("Not implemented!")
       end
+      # :nocov:
 
       # CI run id
       #
@@ -104,70 +103,18 @@ module Publisher
         self.class.run_id
       end
 
-      # Check if PR already has report urls
+      # Add report url as comment
       #
       # @return [Boolean]
-      def reported?
-        @reported ||= pr_description.match?(DESCRIPTION_PATTERN)
-      end
-
-      # Full PR description
-      #
-      # @return [String]
-      def updated_pr_description
-        reported? ? existing_pr_description : initial_pr_descripion
-      end
-
-      # Updated PR description
-      #
-      # @return [String]
-      def existing_pr_description
-        pr_description.gsub(DESCRIPTION_PATTERN, pr_body).strip
-      end
-
-      # Initial PR description
-      #
-      # @return [String]
-      def initial_pr_descripion
-        "#{pr_description}\n\n#{pr_body}".strip
-      end
-
-      # Heading for report urls
-      #
-      # @return [String]
-      def heading
-        @heading ||= <<~HEADING.strip
-          # Allure report
-          `allure-report-publisher` generated allure report for #{sha_url}!
-        HEADING
-      end
-
-      # Allure report url pr description
-      #
-      # @return [String]
-      def pr_body
-        @pr_body ||= <<~DESC
-          <!-- allure -->
-          ---
-          #{heading}
-
-          #{job_entry}
-          <!-- allurestop -->
-        DESC
-      end
-
-      # Allure report url comment body
-      #
-      # @return [String]
-      def comment_body
-        @comment_body ||= pr_body.gsub("---\n", "")
+      def comment?
+        update_pr == "comment"
       end
 
-      # Single job report URL entry
+      # Report urls section creator
       #
-      # @return [String]
-      def job_entry
-        @job_entry ||= "**#{build_name}**: 📝 [allure report](#{report_url})"
+      # @return [ReportUrls]
+      def report_urls
+        @report_urls ||= UrlSectionBuilder.new(report_url: report_url, build_name: build_name, sha_url: sha_url)
       end
     end
   end

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

@@ -58,16 +58,16 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_pull_request(repository, pr_id, body: updated_pr_description)
+        client.update_pull_request(repository, pr_id, body: report_urls.updated_pr_description(pr_description))
       end
 
       # Add comment with report url
       #
       # @return [void]
       def add_comment
-        return client.add_comment(repository, pr_id, comment_body) unless comment
+        return client.add_comment(repository, pr_id, report_urls.comment_body) unless comment
 
-        client.update_comment(repository, comment[:id], comment_body)
+        client.update_comment(repository, comment[:id], report_urls.comment_body(comment[:body]))
       end
 
       # Existing comment with allure urls
@@ -75,7 +75,7 @@ module Publisher
       # @return [Sawyer::Resource]
       def comment
         @comment ||= client.issue_comments(repository, pr_id).detect do |comment|
-          comment[:body].match?(DESCRIPTION_PATTERN)
+          UrlSectionBuilder.match?(comment[:body])
         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
@@ -48,16 +48,16 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_merge_request(project, mr_iid, description: updated_pr_description)
+        client.update_merge_request(project, mr_iid, description: report_urls.updated_pr_description(pr_description))
       end
 
       # Add comment with report url
       #
       # @return [void]
       def add_comment
-        return client.create_merge_request_comment(project, mr_iid, comment_body) unless comment
+        return client.create_merge_request_comment(project, mr_iid, report_urls.comment_body) unless comment
 
-        client.edit_merge_request_note(project, mr_iid, comment.id, comment_body)
+        client.edit_merge_request_note(project, mr_iid, comment.id, report_urls.comment_body(comment.body))
       end
 
       # Existing comment with allure urls
@@ -65,7 +65,7 @@ module Publisher
       # @return [Gitlab::ObjectifiedHash]
       def comment
         client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
-          comment.body.match?(DESCRIPTION_PATTERN)
+          UrlSectionBuilder.match?(comment.body)
         end
       end
 
@@ -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

@@ -0,0 +1,97 @@
+module Publisher
+  module Providers
+    # Urls section builder
+    #
+    class UrlSectionBuilder
+      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
+      JOBS_PATTERN = /<!-- jobs -->\n([\s\S]+)\n<!-- jobs -->/.freeze
+
+      def initialize(report_url:, build_name:, sha_url:)
+        @report_url = report_url
+        @build_name = build_name
+        @sha_url = sha_url
+      end
+
+      # Matches url section pattern
+      #
+      # @param [String] urls_block
+      # @return [Boolean]
+      def self.match?(urls_block)
+        urls_block.match?(DESCRIPTION_PATTERN)
+      end
+
+      # Get urls for PR update
+      #
+      # @param [String] pr
+      # @return [String]
+      def updated_pr_description(pr_description)
+        return "#{pr_description}\n\n#{body}" unless pr_description.match?(DESCRIPTION_PATTERN)
+
+        job_entries = jobs_section(pr_description)
+        pr_description.gsub(DESCRIPTION_PATTERN, body(job_entries))
+      end
+
+      # Allure report url comment
+      #
+      # @return [String]
+      def comment_body(pr_comment = nil)
+        return body.gsub("---\n", "") unless pr_comment
+
+        job_entries = jobs_section(pr_comment)
+        body(job_entries).gsub("---\n", "")
+      end
+
+      attr_reader :report_url, :build_name, :sha_url
+
+      private
+
+      # Allure report url pr description
+      #
+      # @return [String]
+      def body(job_entries = job_entry)
+        @body ||= <<~BODY.strip
+          <!-- allure -->
+          ---
+          #{heading}
+
+          <!-- jobs -->
+          #{job_entries}
+          <!-- jobs -->
+          <!-- allurestop -->
+        BODY
+      end
+
+      # Url section heading
+      #
+      # @return [String]
+      def heading
+        @heading ||= "# Allure report\n`allure-report-publisher` generated test report for #{sha_url}!"
+      end
+
+      # Return updated jobs section
+      #
+      # @param [String] urls
+      # @return [String]
+      def jobs_section(urls_block)
+        jobs = urls_block.match(JOBS_PATTERN)[1]
+        return jobs.gsub(job_entry_pattern, job_entry) if jobs.match?(job_entry_pattern)
+
+        "#{jobs}\n#{job_entry}"
+      end
+
+      # Single job report URL entry
+      #
+      # @return [String]
+      def job_entry
+        @job_entry ||= "**#{build_name}**: 📝 [test report](#{report_url})<br />"
+      end
+
+      # Job entry pattern
+      #
+      # @return [RegExp]
+      def job_entry_pattern
+        @job_entry_pattern ||= %r{^\*\*#{build_name}\*\*:.*\[test report\]\(.*\)<br />$}
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2021-05-27 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.96.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.96.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - lib/allure_report_publisher/lib/providers/_provider.rb
 - lib/allure_report_publisher/lib/providers/github.rb
 - lib/allure_report_publisher/lib/providers/gitlab.rb
+- lib/allure_report_publisher/lib/providers/url_section_builder.rb
 - lib/allure_report_publisher/lib/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/gcs.rb