allure-report-publisher 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7267f00f39421165f5b1fb7c4e975cff6e856d7ff321bf5b90ac7ab629fff6a
-  data.tar.gz: 6189da5c7b8743ee4fb102b01f07e9e419996a249b90a8a43601658f2c1ef6cb
+  metadata.gz: 818cdc599b432cb8484e95662881253a9f0df4265eb742f3f56f459ecbe57dfd
+  data.tar.gz: a261391b7851b0305883c6cd15a9789854051b30d39184728235641f881fe3fa
 SHA512:
-  metadata.gz: 52e25db16ed4068c4556162fd4bfe917b138f2e814dd2d0bf6a019b8dd462014ba7af39cbc6ebe62f0d547bee4ca5ea0813e0719f138fb4cc0890ee2f501ea33
-  data.tar.gz: 6e1a0903f7923fd2abb0538819f24fce3530827280dd1e568be1dc16942f8bdbdca2c03fe4816e7d3bb00d3b631cfe8a7d4bea0f9af77f3e6c8a9afcfed4ab62
+  metadata.gz: 9e8ea6e47d729b8e484c660a5add949546662deb3d339caf6d95b4e45c5970db7137375cf3dd67764f5dcb7e9b78859eb52f8dfc3da0e5dedbcb7d346a5f5e26
+  data.tar.gz: dec6eec389f65663b7b6f7531796e0e7c0a39a2137e5f94c0dd881e87284ca31b6a268462a7dca99909250b91b911f250e378319dcb3b97930078eaa22b858c9

data/README.md

@@ -30,6 +30,9 @@ allure-report-publisher will automatically detect if used in CI environment and
 
 ### 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
+
 ```shell
 $ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload s3 --help
 Command:
@@ -43,6 +46,7 @@ Description:
 
 Options:
   --[no-]color                     # Toggle color output
+  --[no-]update-pr                 # Update pull request description with url to allure report, default: false
   --result-files-glob=VALUE        # Allure results files glob. Required: true
   --bucket=VALUE                   # Bucket name. Required: true
   --prefix=VALUE                   # Optional prefix for report path. Required: false

data/lib/allure_report_publisher/commands/base.rb

@@ -6,6 +6,10 @@ module Publisher
       def self.included(mod)
         mod.instance_eval do
           option :color, type: :boolean, desc: "Toggle color output"
+          option :update_pr,
+                 type: :boolean,
+                 default: false,
+                 desc: "Update pull request description with url to allure report"
         end
       end
     end

data/lib/allure_report_publisher/commands/upload_s3.rb

@@ -25,7 +25,7 @@ module Publisher
           args[:result_files_glob],
           args[:bucket],
           args[:prefix]
-        ).execute
+        ).execute(update_pr: args[:update_pr])
       end
 
       private

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

@@ -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/_base.rb

@@ -0,0 +1,111 @@
+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 Base
+      EXECUTOR_JSON = "executor.json".freeze
+      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
+
+      def initialize(results_path, report_url)
+        @results_path = results_path
+        @report_url = report_url
+      end
+
+      # :nocov:
+
+      # Get ci run ID without creating instance of ci provider
+      #
+      # @return [String]
+      def self.run_id
+        raise("Not implemented!")
+      end
+      # :nocov:
+
+      # Write executor info file
+      #
+      # @return [void]
+      def write_executor_info
+        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
+          file.write(executor_info.to_json)
+        end
+      end
+
+      # Add report url to pull request description
+      #
+      # @return [void]
+      def add_report_url
+        raise("Not a pull request, skipped!") unless pr?
+
+        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)
+      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]
+      def pr?
+        raise("Not implemented!")
+      end
+
+      # Current pull request description
+      #
+      # @return [String]
+      def pr_description
+        raise("Not implemented!")
+      end
+
+      # Update pull request description
+      #
+      # @param [String] _desc
+      # @return [void]
+      def update_pr_description(_desc)
+        raise("Not implemented!")
+      end
+      # :nocov:
+
+      # CI run id
+      #
+      # @return [String]
+      def run_id
+        self.class.run_id
+      end
+
+      # Allure report url pr description
+      #
+      # @return [String]
+      def description_template
+        <<~DESC
+          <!-- allure -->
+          ---
+          📝 [Latest allure report](#{report_url})
+          <!-- allurestop -->
+        DESC
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+require "octokit"
+
+module Publisher
+  module Providers
+    # Github implementation
+    #
+    class Github < Base
+      # Run id
+      #
+      # @return [String]
+      def self.run_id
+        @run_id ||= ENV["GITHUB_RUN_ID"]
+      end
+
+      private
+
+      # 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
+
+      # 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
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["GITHUB_EVENT_NAME"] == "pull_request"
+      end
+
+      # Pull request description
+      #
+      # @return [String]
+      def pr_description
+        @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"]
+      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["GITHUB_JOB"]
+      end
+
+      # Github repository
+      #
+      # @return [String]
+      def repository
+        @repository ||= ENV["GITHUB_REPOSITORY"]
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/lib/providers/gitlab.rb

@@ -0,0 +1,103 @@
+require "gitlab"
+
+module Publisher
+  module Providers
+    # Gitlab implementation
+    #
+    class Gitlab < Base
+      # Get ci run ID without creating instance of ci provider
+      #
+      # @return [String]
+      def self.run_id
+        @run_id ||= ENV["CI_PIPELINE_ID"]
+      end
+
+      # Get executor info
+      #
+      # @return [Hash]
+      def executor_info
+        {
+          name: "Gitlab",
+          type: "gitlab",
+          reportName: "AllureReport",
+          url: server_url,
+          reportUrl: report_url,
+          buildUrl: build_url,
+          buildOrder: run_id,
+          buildName: build_name
+        }
+      end
+
+      # Current pull request description
+      #
+      # @return [String]
+      def pr_description
+        @pr_description ||= client.merge_request(project, mr_iid).description
+      end
+
+      # Update pull request description
+      #
+      # @param [String] desc
+      # @return [void]
+      def update_pr_description(desc)
+        client.update_merge_request(project, mr_iid, description: desc)
+      end
+
+      # Get gitlab client
+      #
+      # @return [Gitlab::Client]
+      def client
+        @client ||= begin
+          raise("Missing GITLAB_AUTH_TOKEN environment variable!") unless ENV["GITLAB_AUTH_TOKEN"]
+
+          ::Gitlab::Client.new(
+            endpoint: "#{server_url}/api/v4",
+            private_token: ENV["GITLAB_AUTH_TOKEN"]
+          )
+        end
+      end
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["CI_PIPELINE_SOURCE"] == "merge_request_event"
+      end
+
+      # Merge request iid
+      #
+      # @return [Integer]
+      def mr_iid
+        @mr_iid ||= ENV["CI_MERGE_REQUEST_IID"]
+      end
+
+      # Server url
+      #
+      # @return [String]
+      def server_url
+        @server_url ||= ENV["CI_SERVER_URL"]
+      end
+
+      # Build url
+      #
+      # @return [String]
+      def build_url
+        @build_url ||= ENV["CI_PIPELINE_URL"]
+      end
+
+      # Job name
+      #
+      # @return [String]
+      def build_name
+        @build_name ||= ENV["CI_JOB_NAME"]
+      end
+
+      # Github repository
+      #
+      # @return [String]
+      def project
+        @project ||= ENV["CI_PROJECT_PATH"]
+      end
+    end
+  end
+end

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

@@ -24,39 +24,40 @@ module Publisher
       # Execute allure report generation and upload
       #
       # @return [void]
-      def execute
-        raise(StandardError, "Not Implemented!")
+      def execute(update_pr: false)
+        check_client_configured
+
+        generate_report
+        upload_history_and_report
+        add_report_url if update_pr
+      rescue StandardError => e
+        error(e.message)
       end
-      # :nocov:
 
       private
 
       attr_reader :results_glob, :bucket, :prefix
 
-      # :nocov:
-
-      # Report url
+      # Validate if client is properly configured
+      # and raise error if it is not
       #
-      # @return [String]
-      def report_url
-        raise(StandardError, "Not Implemented!")
+      # @return [void]
+      def check_client_configured
+        raise("Not Implemented!")
       end
-      # :nocov:
 
-      # Get run id
+      # Report url
       #
       # @return [String]
-      def run_id
-        @run_id ||= CI.provider&.run_id
+      def report_url
+        raise("Not Implemented!")
       end
 
-      # Get CI provider
+      # Upload report to s3
       #
-      # @return [Publisher::CI::Base]
-      def ci_provider
-        return @ci_provider if defined?(@ci_provider)
-
-        @ci_provider = CI.provider&.new(results_dir, report_url)
+      # @return [void]
+      def upload_history_and_report
+        raise("Not implemented!")
       end
 
       # Add allure history
@@ -77,11 +78,50 @@ module Publisher
         return unless ci_provider
 
         log("Adding executor info")
-        Helpers::Spinner.spin("adding") do
+        Helpers::Spinner.spin("adding executor") do
           ci_provider.write_executor_info
         end
       end
 
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        add_history
+        add_executor_info
+
+        ReportGenerator.new(results_glob, results_dir, report_dir).generate
+      end
+
+      # Add allure report url to pull request description
+      #
+      # @return [void]
+      def add_report_url
+        return unless 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
+      # :nocov:
+
+      # Get run id
+      #
+      # @return [String]
+      def run_id
+        @run_id ||= Providers.provider&.run_id
+      end
+
+      # Get CI provider
+      #
+      # @return [Publisher::Providers::Base]
+      def ci_provider
+        return @ci_provider if defined?(@ci_provider)
+
+        @ci_provider = Providers.provider&.new(results_dir, report_url)
+      end
+
       # Fetch allure report history
       #
       # @return [void]
@@ -122,16 +162,6 @@ module Publisher
                           .glob("#{report_dir}/**/*")
                           .reject(&:directory?)
       end
-
-      # Generate allure report
-      #
-      # @return [void]
-      def generate_report
-        add_history
-        add_executor_info
-
-        ReportGenerator.new(results_glob, results_dir, report_dir).generate
-      end
     end
   end
 end

data/lib/allure_report_publisher/lib/uploaders/s3_uploader.rb

@@ -5,18 +5,14 @@ module Publisher
     # Report upload to AWS S3 bucket
     #
     class S3 < Uploader
-      def execute
-        generate_report
-        upload_history_and_report
-      end
-
       private
 
-      # S3 client
+      # Validate if client is properly configured
+      # and raise error if it is not
       #
-      # @return [Aws::S3::Client]
-      def s3
-        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
+      # @return [void]
+      def check_client_configured
+        s3
       end
 
       # Report url
@@ -54,6 +50,19 @@ module Publisher
         end
       end
 
+      # S3 client
+      #
+      # @return [Aws::S3::Client]
+      def s3
+        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
+      rescue Aws::Sigv4::Errors::MissingCredentialsError
+        raise(<<~MSG.strip)
+          missing aws credentials, provide credentials with one of the following options:
+            - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables
+            - ~/.aws/credentials file
+        MSG
+      end
+
       # Upload allure history
       #
       # @return [void]
@@ -61,6 +70,9 @@ module Publisher
         upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
       end
 
+      # Upload allure report
+      #
+      # @return [void]
       def upload_report
         upload_to_s3(report_files)
       end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -44,6 +44,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -114,10 +142,11 @@ files:
 - lib/allure_report_publisher/commands/base.rb
 - lib/allure_report_publisher/commands/upload_s3.rb
 - lib/allure_report_publisher/commands/version.rb
-- lib/allure_report_publisher/lib/ci/_base.rb
-- lib/allure_report_publisher/lib/ci/github_actions.rb
 - lib/allure_report_publisher/lib/helpers/helpers.rb
 - lib/allure_report_publisher/lib/helpers/spinner.rb
+- lib/allure_report_publisher/lib/providers/_base.rb
+- lib/allure_report_publisher/lib/providers/github.rb
+- lib/allure_report_publisher/lib/providers/gitlab.rb
 - lib/allure_report_publisher/lib/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/s3_uploader.rb

data/lib/allure_report_publisher/lib/ci/_base.rb

@@ -1,63 +0,0 @@
-module Publisher
-  # CI provider utilities
-  #
-  module CI
-    # Detect CI provider
-    #
-    # @return [Publisher::CI::Base]
-    def self.provider
-      return GithubActions if ENV["GITHUB_WORKFLOW"]
-    end
-
-    # Base class for CI executor info
-    #
-    class Base
-      EXECUTOR_JSON = "executor.json".freeze
-
-      def initialize(results_path, report_url)
-        @results_path = results_path
-        @report_url = report_url
-      end
-
-      # :nocov:
-
-      # Get ci run ID without creating instance of ci provider
-      #
-      # @return [String]
-      def self.run_id
-        raise("Not implemented!")
-      end
-      # :nocov:
-
-      # Write executor info file
-      #
-      # @return [void]
-      def write_executor_info
-        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
-          file.write(executor_info.to_json)
-        end
-      end
-
-      private
-
-      attr_reader :results_path, :report_url
-
-      # :nocov:
-
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
-      # :nocov:
-
-      # CI run id
-      #
-      # @return [String]
-      def run_id
-        self.class.run_id
-      end
-    end
-  end
-end

data/lib/allure_report_publisher/lib/ci/github_actions.rb

@@ -1,50 +0,0 @@
-module Publisher
-  module CI
-    # Github actions executor info
-    #
-    class GithubActions < Base
-      # Run id
-      #
-      # @return [String]
-      def self.run_id
-        @run_id ||= ENV["GITHUB_RUN_ID"]
-      end
-
-      private
-
-      # 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
-
-      # 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}/#{ENV['GITHUB_REPOSITORY']}/actions/runs/#{run_id}"
-      end
-
-      def build_name
-        @build_name ||= ENV["GITHUB_JOB"]
-      end
-    end
-  end
-end