allure-report-publisher 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7267f00f39421165f5b1fb7c4e975cff6e856d7ff321bf5b90ac7ab629fff6a
-  data.tar.gz: 6189da5c7b8743ee4fb102b01f07e9e419996a249b90a8a43601658f2c1ef6cb
+  metadata.gz: 2212afd20c080df89b88eab18ae8fa96a6b8d00027af95b2b606e9b851b83dde
+  data.tar.gz: b6473ed381ddb267af1fcaee0ef6080a3c8063dac4d56ea5cbf0589457c7598e
 SHA512:
-  metadata.gz: 52e25db16ed4068c4556162fd4bfe917b138f2e814dd2d0bf6a019b8dd462014ba7af39cbc6ebe62f0d547bee4ca5ea0813e0719f138fb4cc0890ee2f501ea33
-  data.tar.gz: 6e1a0903f7923fd2abb0538819f24fce3530827280dd1e568be1dc16942f8bdbdca2c03fe4816e7d3bb00d3b631cfe8a7d4bea0f9af77f3e6c8a9afcfed4ab62
+  metadata.gz: e28a752bdaaf619bf293c6a4f995a17e7cdea913c6c1c89be07dcb14c575a2b78264bbb6fad03d2b1ec574c2d0c72fd04ce84431e7920e6ac7180b5f4006c54c
+  data.tar.gz: aa8f768c03494a14b6dcafc9ada76764b028f750f6ff104627bb669c431321074fbac76ae81ab84df6510988d7cf161a9863c796c6615e343193ae2708979419

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://img.shields.io/gem/v/allure-report-publisher?color=red)](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)
 ![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)
 [![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,31 +29,44 @@ 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
+- `Allure report link`: requires `GITHUB_AUTH_TOKEN` or `GITLAB_AUTH_TOKEN` in order to update pull request description with link to latest report
 
 ```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
-  --result-files-glob=VALUE        # Allure results files glob. Required: true
+  --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
 
 Examples:
-  allure-report-publisher upload s3 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket
-  allure-report-publisher upload s3 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs
+  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
+
+- `AWS authentication`: 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
+
 ## 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"
+      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("Updating pull request description")
+        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
@@ -48,7 +48,7 @@ module Publisher
     # @param [String] message
     # @return [void]
     def error(message)
-      puts colorize(message, :red)
+      warn colorize(message, :red)
       exit(1)
     end
 

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

@@ -0,0 +1,174 @@
+module Publisher
+  # Namespace for providers executing tests
+  #
+  module Providers
+    # Detect CI provider
+    #
+    # @return [Publisher::Providers::Base]
+    def self.provider
+      return Github if ENV["GITHUB_WORKFLOW"]
+      return Gitlab if ENV["GITLAB_CI"]
+    end
+
+    # 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:)
+        @report_url = report_url
+        @update_pr = update_pr
+      end
+
+      # :nocov:
+
+      # Get ci run ID without creating instance of ci provider
+      #
+      # @return [String]
+      def self.run_id
+        raise("Not implemented!")
+      end
+
+      # Get executor info
+      #
+      # @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?
+
+        update_pr_description
+      end
+
+      # :nocov:
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        raise("Not implemented!")
+      end
+
+      private
+
+      attr_reader :report_url, :update_pr
+
+      # Current pull request description
+      #
+      # @return [String]
+      def pr_description
+        raise("Not implemented!")
+      end
+
+      # Update pull request description
+      #
+      # @return [void]
+      def update_pr_description
+        raise("Not implemented!")
+      end
+
+      # Add comment with report url
+      #
+      # @return [void]
+      def add_comment
+        raise("Not implemented!")
+      end
+
+      # Commit SHA url
+      #
+      # @return [String]
+      def sha_url
+        raise("Not implemented!")
+      end
+      # :nocov:
+
+      # Add report url as comment
+      #
+      # @return [Boolean]
+      def comment?
+        update_pr == "comment"
+      end
+
+      # CI run id
+      #
+      # @return [String]
+      def run_id
+        self.class.run_id
+      end
+
+      # Check if PR already has report urls
+      #
+      # @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", "")
+      end
+
+      # Single job report URL entry
+      #
+      # @return [String]
+      def job_entry
+        @job_entry ||= "**#{build_name}**: 📝 [allure report](#{report_url})"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+require "octokit"
+
+module Publisher
+  module Providers
+    # Github implementation
+    #
+    class Github < Provider
+      # Set octokit to autopaginate
+      #
+      Octokit.configure do |config|
+        config.auto_paginate = true
+      end
+
+      # Run id
+      #
+      # @return [String]
+      def self.run_id
+        @run_id ||= ENV["GITHUB_RUN_ID"]
+      end
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["GITHUB_EVENT_NAME"] == "pull_request"
+      end
+
+      # Executor info
+      #
+      # @return [Hash]
+      def executor_info
+        {
+          name: "Github",
+          type: "github",
+          reportName: "AllureReport",
+          url: server_url,
+          reportUrl: report_url,
+          buildUrl: build_url,
+          buildOrder: run_id,
+          buildName: build_name
+        }
+      end
+
+      private
+
+      # Github api client
+      #
+      # @return [Octokit::Client]
+      def client
+        @client ||= begin
+          raise("Missing GITHUB_AUTH_TOKEN environment variable!") unless ENV["GITHUB_AUTH_TOKEN"]
+
+          Octokit::Client.new(access_token: ENV["GITHUB_AUTH_TOKEN"], api_endpoint: ENV["GITHUB_API_URL"])
+        end
+      end
+
+      # Update pull request description
+      #
+      # @return [void]
+      def update_pr_description
+        client.update_pull_request(repository, pr_id, body: updated_pr_description)
+      end
+
+      # Add comment with report url
+      #
+      # @return [void]
+      def add_comment
+        return client.add_comment(repository, pr_id, comment_body) unless comment
+
+        client.update_comment(repository, comment[:id], comment_body)
+      end
+
+      # Existing comment with allure urls
+      #
+      # @return [Sawyer::Resource]
+      def comment
+        @comment ||= client.issue_comments(repository, pr_id).detect do |comment|
+          comment[:body].match?(DESCRIPTION_PATTERN)
+        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 ||= github_event[:number]
+      end
+
+      # Server url
+      #
+      # @return [String]
+      def server_url
+        @server_url ||= ENV["GITHUB_SERVER_URL"]
+      end
+
+      # Build url
+      #
+      # @return [String]
+      def build_url
+        @build_url ||= "#{server_url}/#{repository}/actions/runs/#{run_id}"
+      end
+
+      # Job name
+      #
+      # @return [String]
+      def build_name
+        @build_name ||= ENV[ALLURE_JOB_NAME] || ENV["GITHUB_JOB"]
+      end
+
+      # Github repository
+      #
+      # @return [String]
+      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