allure-report-publisher 0.0.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7d2654f1e2f5e4afe6dd64d08bd24a9fc6764d24abfb06f2f52dc66df21d56
-  data.tar.gz: cce27a83826622967fc3847c53275c8b087ef2e9c1aa216da3237081e75e3772
+  metadata.gz: 676e5c29b0fb534f66b54f22f06e5a9c7c3f429d7c2923fd6285139234cd563d
+  data.tar.gz: f68177fdde3a101fb501b47fb82897f7b48ba8e5669a1d1ee5f4a631364505a4
 SHA512:
-  metadata.gz: 0141ca8082a561395e97f93e9b02bbe17e2aa69bfddc2146452769e6009824e29e2e23203e2e36ad54afaacfbb91701f30527e65c6599d5b8d6707b3e7e3ffb1
-  data.tar.gz: 1420f1b3ec4fa386217bd4f0228bf59615772111190adcfb35f4ff68fce1de6eaa8bf39b173ec408ab4ef3c95645c00013c52d4acaca96cc4ab46efbe64bfb7e
+  metadata.gz: 826a881f81782358f580c4c5565c62d8b3dd06156bf224174d58149053c74a5d1e9456040c3dd6a136151ba0c091cf0fe74bcd3e945112dbe3a60eba4e05d6ba
+  data.tar.gz: 50da6a0a16eeb2bd24b1473003515c9fbd58fc28dfc171994129d9a13a796a5fbd2cef76a46358f7736385c6c67fa4dc097abd6f06ed494bc5c27e48b03c236f

data/README.md

@@ -1,6 +1,9 @@
 [![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)](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)
 
@@ -28,7 +31,7 @@ docker pull andrcuns/allure-report-publisher:latest
 
 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
+- `--update-pr=(comment|description)`: requires `GITHUB_AUTH_TOKEN` or `GITLAB_AUTH_TOKEN` in order to update pull request with links to allure reports
 
 ```shell
 $ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload --help
@@ -42,16 +45,16 @@ 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
@@ -60,11 +63,28 @@ Examples:
 
 ### AWS S3
 
-- `AWS authentication`: requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
+Requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
 
 ### Google Cloud Storage
 
-- `GCS authentication`: requires environment variable `GOOGLE_CLOUD_CREDENTIALS_JSON` with contents of credentials.json
+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`
 
 ## Development
 

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,
@@ -42,9 +42,18 @@ module Publisher
         validate_result_files(args[:results_glob])
         Helpers.pastel(force_color: args[:color] || nil)
 
-        uploaders(args[:type])
-          .new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
-          .execute
+        uploader = uploaders(args[:type]).new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
+
+        log("Generating allure report")
+        Spinner.spin("generating") { uploader.generate_report }
+
+        log("Uploading allure report to #{args[:type]}")
+        Spinner.spin("uploading") { uploader.upload }
+        uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
+        return unless args[:update_pr] && uploader.pr?
+
+        log("Adding reports urls")
+        Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
       end
 
       private

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,42 +28,27 @@ 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
 
-      private
-
-      attr_reader :results_path, :report_url
-
       # :nocov:
 
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
-
       # Pull request run
       #
       # @return [Boolean]
@@ -72,6 +56,10 @@ module Publisher
         raise("Not implemented!")
       end
 
+      private
+
+      attr_reader :report_url, :update_pr
+
       # Current pull request description
       #
       # @return [String]
@@ -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]
@@ -12,7 +18,12 @@ module Publisher
         @run_id ||= ENV["GITHUB_RUN_ID"]
       end
 
-      private
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["GITHUB_EVENT_NAME"] == "pull_request"
+      end
 
       # Executor info
       #
@@ -30,6 +41,8 @@ module Publisher
         }
       end
 
+      private
+
       # Github api client
       #
       # @return [Octokit::Client]
@@ -41,11 +54,36 @@ module Publisher
         end
       end
 
-      # Pull request run
+      # Update pull request description
       #
-      # @return [Boolean]
-      def pr?
-        ENV["GITHUB_EVENT_NAME"] == "pull_request"
+      # @return [void]
+      def update_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, 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
@@ -55,19 +93,11 @@ module Publisher
         @pr_description ||= client.pull_request(repository, pr_id)[:body]
       end
 
-      # Update pull request description
-      #
-      # @param [String] _desc
-      # @return [void]
-      def update_pr_description(desc)
-        client.update_pull_request(repository, pr_id, body: desc)
-      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

@@ -12,6 +12,13 @@ module Publisher
         @run_id ||= ENV["CI_PIPELINE_ID"]
       end
 
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+      end
+
       # Get executor info
       #
       # @return [Hash]
@@ -28,6 +35,8 @@ module Publisher
         }
       end
 
+      private
+
       # Current pull request description
       #
       # @return [String]
@@ -37,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
@@ -57,13 +83,6 @@ module Publisher
         end
       end
 
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
-      end
-
       # Merge request iid
       #
       # @return [Integer]
@@ -89,15 +108,25 @@ 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
+      # Gitlab repository
       #
       # @return [String]
       def project
         @project ||= ENV["CI_PROJECT_PATH"]
       end
+
+      # Commit sha url
+      #
+      # @return [String]
+      def sha_url
+        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
 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 allure 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}**: 📝 [allure report](#{report_url})<br />"
+      end
+
+      # Job entry pattern
+      #
+      # @return [RegExp]
+      def job_entry_pattern
+        @job_entry_pattern ||= %r{^\*\*#{build_name}\*\*:.*\[allure report\]\(.*\)<br />$}
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -10,35 +10,32 @@ 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
     #
     # @return [void]
     def generate
-      log("Generating allure report")
-      Helpers::Spinner.spin("generating report") do
-        aggregate_results
-        generate_report
-      end
+      aggregate_results
+      generate_report
     end
 
     private
 
-    attr_reader :results_glob, :results_dir, :report_dir
+    attr_reader :results_glob, :results_path, :report_path
 
     # Copy all results files to results directory
     #
     # @return [void]
     def aggregate_results
       results = Dir.glob(results_glob)
-      error("Missing allure results") if results.empty?
+      raise(NoAllureResultsError, "Missing allure results") if results.empty?
 
-      FileUtils.cp(results, results_dir)
+      FileUtils.cp(results, results_path)
     end
 
     # Generate allure report
@@ -46,9 +43,9 @@ 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}"
       )
-      error(out) unless status.success?
+      raise(AllureError, out) unless status.success?
     end
   end
 end

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

@@ -1,10 +1,13 @@
 module Publisher
   module Uploaders
+    class HistoryNotFoundError < StandardError; end
+
     # Uploader implementation
     #
     class Uploader
       include Helpers
 
+      EXECUTOR_JSON = "executor.json".freeze
       HISTORY = [
         "categories-trend.json",
         "duration-trend.json",
@@ -13,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
@@ -25,13 +28,52 @@ module Publisher
       #
       # @return [void]
       def execute
-        client # initialize client and check for errors
-
-        generate
+        generate_report
         upload
         add_url_to_pr
-      rescue StandardError => e
-        error(e.message)
+      end
+
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        add_history
+        add_executor_info
+
+        ReportGenerator.new(results_glob, results_path, report_path).generate
+      end
+
+      # Upload report to storage provider
+      #
+      # @return [void]
+      def upload
+        run_uploads
+      end
+
+      # Add allure report url to pull request description
+      #
+      # @return [void]
+      def add_url_to_pr
+        return unless update_pr && ci_provider
+
+        ci_provider.add_report_url
+      end
+
+      # Uploaded report urls
+      #
+      # @return [Hash<String, String>] uploaded report urls
+      def report_urls
+        urls = { "Report url" => report_url }
+        urls["Latest report url"] = latest_report_url if copy_latest
+
+        urls
+      end
+
+      # Executed in PR pipeline
+      #
+      # @return [Boolean]
+      def pr?
+        ci_provider&.pr?
       end
 
       private
@@ -54,6 +96,13 @@ module Publisher
         raise("Not Implemented!")
       end
 
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        raise("Not Implemented!")
+      end
+
       # Download allure history
       #
       # @return [void]
@@ -87,11 +136,10 @@ module Publisher
       #
       # @return [void]
       def add_history
-        log("Adding allure history")
-        Helpers::Spinner.spin("adding history", exit_on_error: false) do
-          create_history_dir
-          download_history
-        end
+        create_history_dir
+        download_history
+      rescue HistoryNotFoundError
+        nil
       end
 
       # Add CI executor info
@@ -100,32 +148,11 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        log("Adding executor info")
-        Helpers::Spinner.spin("adding executor") do
-          ci_provider.write_executor_info
+        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
+          file.write(ci_provider.executor_info.to_json)
         end
       end
 
-      # Generate allure report
-      #
-      # @return [void]
-      def generate
-        add_history
-        add_executor_info
-
-        ReportGenerator.new(results_glob, results_dir, report_dir).generate
-      end
-
-      # Upload report to storage provider
-      #
-      # @return [void]
-      def upload
-        log("Uploading report")
-        Helpers::Spinner.spin("uploading report") { run_uploads }
-        log("Run report: #{report_url}", :green)
-        log("Latest report: #{latest_report_url}", :green) if copy_latest
-      end
-
       # Run upload commands
       #
       # @return [void]
@@ -135,18 +162,6 @@ module Publisher
         upload_latest_copy if copy_latest
       end
 
-      # Add allure report url to pull request description
-      #
-      # @return [void]
-      def add_url_to_pr
-        return unless update_pr && ci_provider
-
-        log("Adding allure report link to pr description")
-        Helpers::Spinner.spin("adding link", exit_on_error: false) do
-          ci_provider.add_report_url
-        end
-      end
-
       # Get run id
       #
       # @return [String]
@@ -160,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
@@ -184,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
@@ -200,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

@@ -41,9 +41,9 @@ module Publisher
       def download_history
         HISTORY.each do |file_name|
           file = bucket.file(key(prefix, "history", file_name))
-          raise("Allure history from previous runs not found!") unless file
+          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,13 +40,13 @@ 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
           )
         end
       rescue Aws::S3::Errors::NoSuchKey
-        raise("Allure history from previous runs not found!")
+        raise(HistoryNotFoundError, "Allure history from previous runs not found!")
       end
 
       # Upload allure history
@@ -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.5"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -34,16 +34,22 @@ dependencies:
   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