allure-report-publisher 0.0.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a1bb3d8d9d7a22c080bcb2ce71fcf4d082d49b8ffd528fb3ef409d4afbf0ef
-  data.tar.gz: 992e16c2cb4ee7feabefd9250efb13f824804e2a30bec5c6f031666f41e8f9a9
+  metadata.gz: 4b5ab2c7fe9d71734c9f57324a411d2dfb3034a63152e75a3827f3629375371b
+  data.tar.gz: 56296208184a82b42bfb04c7132788e6b4f924be16c4059a4e03e6782f9f54f2
 SHA512:
-  metadata.gz: 9806755fe1c216f8c590e183e0b667060a92017d42991a65663ed74aa8519d8e390e2eafe6dd35d67dacd0f40df3e1c75feab23498869073fe343d2514c02767
-  data.tar.gz: 6a04f0503833d6378c3f4923b159a2567e8b3a9fc3ee642825ec45ef921d514616a2b93c39d50204cd29573dc88723b4ef2c47f9d3c05a30942dff63f6d91433
+  metadata.gz: 60889df0f7995284adc34651a042f90f29a0a32f93895636b991205eafc078f696dd9f0117f28e3d85b111bf0d7fe84c4daa5a89f95a5cf4a295547a20c9c8b9
+  data.tar.gz: 0a5c6206ed052dd912b57e524190209993d5e58435a5ce4a28d3a1117fd4bc1191b6ae23d441ab2ec98588518bb18bba7aa9b3a9a2b6ed6fdd6c42480d0614ec

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,36 +31,61 @@ 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
 
-### AWS S3
-
-- `AWS authentication`: requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
-- `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 s3 --help
+$ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload --help
 Command:
-  allure-report-publisher upload s3
+  allure-report-publisher upload
 
 Usage:
-  allure-report-publisher upload s3
+  allure-report-publisher upload TYPE
 
 Description:
   Generate and upload allure report
 
+Arguments:
+  TYPE                              # REQUIRED Cloud storage type: (s3/gcs)
+
 Options:
-  --[no-]color                     # Toggle color output, default: 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
-  --results-glob=VALUE             # Allure results files glob. Required: true
-  --bucket=VALUE                   # Bucket name. Required: true
-  --prefix=VALUE                   # Optional prefix for report path. Required: 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 s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs
+  allure-report-publisher upload gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs
 ```
 
+### 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`
+
 ## 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.

data/lib/allure_report_publisher.rb

@@ -14,11 +14,8 @@ module Publisher
     extend Dry::CLI::Registry
 
     register "version", Version, aliases: ["-v", "--version"]
-
-    register "upload" do |prefix|
-      prefix.register "s3", UploadS3
-    end
+    register "upload", Upload, aliases: ["u"]
   end
 end
 
-Publisher::Commands.before("upload s3") { Publisher::Helpers.validate_allure_cli_present }
+Publisher::Commands.before("upload") { Publisher::Helpers.validate_allure_cli_present }

data/lib/allure_report_publisher/commands/upload.rb

@@ -0,0 +1,90 @@
+module Publisher
+  module Commands
+    # Upload allure report
+    #
+    class Upload < Dry::CLI::Command
+      include Helpers
+
+      desc "Generate and upload allure report"
+
+      argument :type,
+               type: :string,
+               required: true,
+               values: %w[s3 gcs],
+               desc: "Cloud storage type"
+
+      option :results_glob,
+             desc: "Allure results files glob. Required: true"
+      option :bucket,
+             desc: "Bucket name. Required: true"
+      option :prefix,
+             desc: "Optional prefix for report path. Required: false"
+      option :update_pr,
+             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,
+             desc: "Keep copy of latest report at base prefix path"
+      option :color,
+             type: :boolean,
+             default: false,
+             desc: "Toggle color output"
+
+      example [
+        "s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket",
+        "gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs"
+      ]
+
+      def call(**args)
+        validate_args(args)
+        validate_result_files(args[:results_glob])
+        Helpers.pastel(force_color: args[:color] || nil)
+
+        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
+
+      # Uploader class
+      #
+      # @param [String] uploader
+      # @return [Publisher::Uploaders::Uploader]
+      def uploaders(uploader)
+        {
+          "s3" => Uploaders::S3,
+          "gcs" => Uploaders::GCS
+        }[uploader]
+      end
+
+      # Validate required args
+      #
+      # @param [Hash] args
+      # @return [void]
+      def validate_args(args)
+        error("Missing argument --results-glob!") unless args[:results_glob]
+        error("Missing argument --bucket!") unless args[:bucket]
+      end
+
+      # Check if allure results present
+      #
+      # @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!")
+      end
+    end
+  end
+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/{_base.rb → _provider.rb}

@@ -12,13 +12,12 @@ module Publisher
 
     # Base class for CI executor info
     #
-    class Base
-      EXECUTOR_JSON = "executor.json".freeze
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
+    class Provider
+      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

@@ -4,7 +4,13 @@ module Publisher
   module Providers
     # Github implementation
     #
-    class Github < Base
+    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