allure-report-publisher 0.0.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be6f833714e1ff2ad413a9b5148cebd6454b23db763f567586b9e91222513524
-  data.tar.gz: 6984e37c220f693288037522a86716079f3a235634c3ccbdd360056fd186f83c
+  metadata.gz: 0f5c4eb0b467125c36d80b35b99f7ec44ff1561a21bcc305d78a9afc4eaace1d
+  data.tar.gz: a525a10cae5378628ebf74d0a128ae9561db9f13b0ed023b992a404376b8ea1e
 SHA512:
-  metadata.gz: d11ad18cdfb6c1955e521d8aae653b823f5defcfae4b095ae27f9bc9d1d0c89bca0336ab647c543b4c5d2cb92d2bffcd2c23343266b254aa1331984ac02abae9
-  data.tar.gz: 023da790f7233de7da68520ea85e2e0388e6c840d3950ba004118a754f46d4c2c0c4570c76ca29add86cf97cc0dc40d859094df430627f4cf57316df89df6bf7
+  metadata.gz: c51b6b05861023942c761e80c0f777609dd0287f9f0724a4bc0246d7faa28a52ee05b394e85ddae66ea3441aa4a35372a88e2fe9b34c052776af3500570f19c1
+  data.tar.gz: bf3deb92f34c1899fc0c3bdce08cb6fa96652eac0493799b595894c3219baf200acf9a5f784a5ada92d24fe41ced54a9ac043678c82f850206a80d737e9a8909

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

@@ -20,9 +20,9 @@ module Publisher
       option :prefix,
              desc: "Optional prefix for report path. Required: false"
       option :update_pr,
-             type: :boolean,
-             default: false,
-             desc: "Update pull request description with url to allure report"
+             type: :string,
+             values: %w[comment description],
+             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/helpers.rb

@@ -10,7 +10,7 @@ module Publisher
     # @param [Boolean] force_color
     # @return [Pastel]
     def self.pastel(force_color: nil)
-      @pastel ||= Pastel.new(enabled: force_color)
+      @pastel ||= Pastel.new(enabled: force_color, eachline: "\n")
     end
 
     # Check allure cli is installed and executable

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,12 +13,11 @@ module Publisher
     # Base class for CI executor info
     #
     class Provider
-      EXECUTOR_JSON = "executor.json".freeze
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
+      ALLURE_JOB_NAME = "ALLURE_JOB_NAME".freeze
 
-      def initialize(results_path, report_url)
-        @results_path = results_path
+      def initialize(report_url:, update_pr:)
         @report_url = report_url
+        @update_pr = update_pr
       end
 
       # :nocov:
@@ -29,27 +28,23 @@ module Publisher
       def self.run_id
         raise("Not implemented!")
       end
-      # :nocov:
 
-      # Write executor info file
+      # Get executor info
       #
-      # @return [void]
-      def write_executor_info
-        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
-          file.write(executor_info.to_json)
-        end
+      # @return [Hash]
+      def executor_info
+        raise("Not implemented!")
       end
+      # :nocov:
 
       # Add report url to pull request description
       #
       # @return [void]
       def add_report_url
         raise("Not a pull request, skipped!") unless pr?
+        return add_comment if comment?
 
-        reported = pr_description.match?(DESCRIPTION_PATTERN)
-        return update_pr_description(pr_description.gsub(DESCRIPTION_PATTERN, description_template).strip) if reported
-
-        update_pr_description("#{pr_description}\n\n#{description_template}".strip)
+        update_pr_description
       end
 
       # :nocov:
@@ -63,14 +58,7 @@ module Publisher
 
       private
 
-      attr_reader :results_path, :report_url
-
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
+      attr_reader :report_url, :update_pr
 
       # Current pull request description
       #
@@ -81,9 +69,29 @@ module Publisher
 
       # Update pull request description
       #
-      # @param [String] _desc
       # @return [void]
-      def update_pr_description(_desc)
+      def update_pr_description
+        raise("Not implemented!")
+      end
+
+      # Add comment with report url
+      #
+      # @return [void]
+      def add_comment
+        raise("Not implemented!")
+      end
+
+      # Build name
+      #
+      # @return [String]
+      def build_name
+        raise("Not implemented!")
+      end
+
+      # Commit SHA url
+      #
+      # @return [String]
+      def sha_url
         raise("Not implemented!")
       end
       # :nocov:
@@ -95,16 +103,18 @@ module Publisher
         self.class.run_id
       end
 
-      # Allure report url pr description
+      # Add report url as comment
       #
-      # @return [String]
-      def description_template
-        <<~DESC
-          <!-- allure -->
-          ---
-          📝 [Latest allure report](#{report_url})
-          <!-- allurestop -->
-        DESC
+      # @return [Boolean]
+      def comment?
+        update_pr == "comment"
+      end
+
+      # Report urls section creator
+      #
+      # @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

@@ -5,6 +5,12 @@ module Publisher
     # Github implementation
     #
     class Github < Provider
+      # Set octokit to autopaginate
+      #
+      Octokit.configure do |config|
+        config.auto_paginate = true
+      end
+
       # Run id
       #
       # @return [String]
@@ -19,8 +25,6 @@ module Publisher
         ENV["GITHUB_EVENT_NAME"] == "pull_request"
       end
 
-      private
-
       # Executor info
       #
       # @return [Hash]
@@ -37,6 +41,8 @@ module Publisher
         }
       end
 
+      private
+
       # Github api client
       #
       # @return [Octokit::Client]
@@ -48,26 +54,50 @@ module Publisher
         end
       end
 
-      # Pull request description
+      # Update pull request description
       #
-      # @return [String]
-      def pr_description
-        @pr_description ||= client.pull_request(repository, pr_id)[:body]
+      # @return [void]
+      def update_pr_description
+        client.update_pull_request(repository, pr_id, body: report_urls.updated_pr_description(pr_description))
       end
 
-      # Update pull request description
+      # Add comment with report url
       #
-      # @param [String] _desc
       # @return [void]
-      def update_pr_description(desc)
-        client.update_pull_request(repository, pr_id, body: desc)
+      def add_comment
+        return client.add_comment(repository, pr_id, report_urls.comment_body) unless comment
+
+        client.update_comment(repository, comment[:id], report_urls.comment_body(comment[:body]))
+      end
+
+      # Existing comment with allure urls
+      #
+      # @return [Sawyer::Resource]
+      def comment
+        @comment ||= client.issue_comments(repository, pr_id).detect do |comment|
+          UrlSectionBuilder.match?(comment[:body])
+        end
+      end
+
+      # Github event
+      #
+      # @return [Hash]
+      def github_event
+        @github_event ||= JSON.parse(File.read(ENV["GITHUB_EVENT_PATH"]), symbolize_names: true)
+      end
+
+      # Pull request description
+      #
+      # @return [String]
+      def pr_description
+        @pr_description ||= client.pull_request(repository, pr_id)[:body]
       end
 
       # Pull request id
       #
       # @return [Integer]
       def pr_id
-        @pr_id ||= JSON.parse(File.read(ENV["GITHUB_EVENT_PATH"]))["number"]
+        @pr_id ||= github_event[:number]
       end
 
       # Server url
@@ -88,7 +118,7 @@ module Publisher
       #
       # @return [String]
       def build_name
-        @build_name ||= ENV["GITHUB_JOB"]
+        @build_name ||= ENV[ALLURE_JOB_NAME] || ENV["GITHUB_JOB"]
       end
 
       # Github repository
@@ -97,6 +127,16 @@ module Publisher
       def repository
         @repository ||= ENV["GITHUB_REPOSITORY"]
       end
+
+      # Commit sha url
+      #
+      # @return [String]
+      def sha_url
+        sha = github_event.dig(:pull_request, :head, :sha)
+        short_sha = sha[0..7]
+
+        "[#{short_sha}](#{server_url}/#{repository}/pull/#{pr_id}/commits/#{sha})"
+      end
     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
@@ -35,6 +35,8 @@ module Publisher
         }
       end
 
+      private
+
       # Current pull request description
       #
       # @return [String]
@@ -44,10 +46,27 @@ module Publisher
 
       # Update pull request description
       #
-      # @param [String] desc
       # @return [void]
-      def update_pr_description(desc)
-        client.update_merge_request(project, mr_iid, description: desc)
+      def update_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, report_urls.comment_body) unless comment
+
+        client.edit_merge_request_note(project, mr_iid, comment.id, report_urls.comment_body(comment.body))
+      end
+
+      # Existing comment with allure urls
+      #
+      # @return [Gitlab::ObjectifiedHash]
+      def comment
+        client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
+          UrlSectionBuilder.match?(comment.body)
+        end
       end
 
       # Get gitlab client
@@ -64,11 +83,39 @@ module Publisher
         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
@@ -89,14 +136,17 @@ module Publisher
       #
       # @return [String]
       def build_name
-        @build_name ||= ENV["CI_JOB_NAME"]
+        @build_name ||= ENV[ALLURE_JOB_NAME] || ENV["CI_JOB_NAME"]
       end
 
-      # Github repository
+      # Commit sha url
       #
       # @return [String]
-      def project
-        @project ||= ENV["CI_PROJECT_PATH"]
+      def sha_url
+        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
     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/lib/report_generator.rb

@@ -10,10 +10,10 @@ module Publisher
   class ReportGenerator
     include Helpers
 
-    def initialize(results_glob, results_dir, report_dir)
+    def initialize(results_glob, results_path, report_path)
       @results_glob = results_glob
-      @results_dir = results_dir
-      @report_dir = report_dir
+      @results_path = results_path
+      @report_path = report_path
     end
 
     # Generate allure report
@@ -26,7 +26,7 @@ module Publisher
 
     private
 
-    attr_reader :results_glob, :results_dir, :report_dir
+    attr_reader :results_glob, :results_path, :report_path
 
     # Copy all results files to results directory
     #
@@ -35,7 +35,7 @@ module Publisher
       results = Dir.glob(results_glob)
       raise(NoAllureResultsError, "Missing allure results") if results.empty?
 
-      FileUtils.cp(results, results_dir)
+      FileUtils.cp(results, results_path)
     end
 
     # Generate allure report
@@ -43,7 +43,7 @@ module Publisher
     # @return [void]
     def generate_report
       out, _err, status = Open3.capture3(
-        "allure generate --clean --output #{report_dir} #{results_dir}"
+        "allure generate --clean --output #{report_path} #{results_path}"
       )
       raise(AllureError, out) unless status.success?
     end

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

@@ -7,6 +7,7 @@ module Publisher
     class Uploader
       include Helpers
 
+      EXECUTOR_JSON = "executor.json".freeze
       HISTORY = [
         "categories-trend.json",
         "duration-trend.json",
@@ -15,7 +16,7 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob:, bucket:, update_pr: false, prefix: nil, copy_latest: false)
+      def initialize(results_glob:, bucket:, update_pr: nil, prefix: nil, copy_latest: false)
         @results_glob = results_glob
         @bucket_name = bucket
         @prefix = prefix
@@ -39,7 +40,7 @@ module Publisher
         add_history
         add_executor_info
 
-        ReportGenerator.new(results_glob, results_dir, report_dir).generate
+        ReportGenerator.new(results_glob, results_path, report_path).generate
       end
 
       # Upload report to storage provider
@@ -147,7 +148,9 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        ci_provider.write_executor_info
+        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
+          file.write(ci_provider.executor_info.to_json)
+        end
       end
 
       # Run upload commands
@@ -172,14 +175,14 @@ module Publisher
       def ci_provider
         return @ci_provider if defined?(@ci_provider)
 
-        @ci_provider = Providers.provider&.new(results_dir, report_url)
+        @ci_provider = Providers.provider&.new(report_url: report_url, update_pr: update_pr)
       end
 
       # Fetch allure report history
       #
       # @return [void]
       def create_history_dir
-        FileUtils.mkdir_p(path(results_dir, "history"))
+        FileUtils.mkdir_p(path(results_path, "history"))
       end
 
       # Report path prefix
@@ -196,15 +199,15 @@ module Publisher
       # Aggregated results directory
       #
       # @return [String]
-      def results_dir
-        @results_dir ||= Dir.mktmpdir("allure-results")
+      def results_path
+        @results_path ||= Dir.mktmpdir("allure-results")
       end
 
       # Allure report directory
       #
       # @return [String]
-      def report_dir
-        @report_dir ||= Dir.mktmpdir("allure-report")
+      def report_path
+        @report_path ||= Dir.mktmpdir("allure-report")
       end
 
       # Report files
@@ -212,7 +215,7 @@ module Publisher
       # @return [Array<Pathname>]
       def report_files
         @report_files ||= Pathname
-                          .glob("#{report_dir}/**/*")
+                          .glob("#{report_path}/**/*")
                           .reject(&:directory?)
       end
     end

data/lib/allure_report_publisher/lib/uploaders/gcs.rb

@@ -43,7 +43,7 @@ module Publisher
           file = bucket.file(key(prefix, "history", file_name))
           raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
 
-          file.download(path(results_dir, "history", file_name))
+          file.download(path(results_path, "history", file_name))
         end
       end
 
@@ -77,7 +77,7 @@ module Publisher
         args = files.map do |file|
           {
             file: file.to_s,
-            path: key(key_prefix, file.relative_path_from(report_dir))
+            path: key(key_prefix, file.relative_path_from(report_path))
           }
         end
 

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

@@ -40,7 +40,7 @@ module Publisher
       def download_history
         HISTORY.each do |file|
           client.get_object(
-            response_target: path(results_dir, "history", file),
+            response_target: path(results_path, "history", file),
             key: key(prefix, "history", file),
             bucket: bucket_name
           )
@@ -80,7 +80,7 @@ module Publisher
           {
             body: File.new(file),
             bucket: bucket_name,
-            key: key(key_prefix, file.relative_path_from(report_dir))
+            key: key(key_prefix, file.relative_path_from(report_path))
           }
         end
 

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-05-24 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,21 +29,27 @@ 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
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -160,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