allure-report-publisher 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be6f833714e1ff2ad413a9b5148cebd6454b23db763f567586b9e91222513524
-  data.tar.gz: 6984e37c220f693288037522a86716079f3a235634c3ccbdd360056fd186f83c
+  metadata.gz: 2212afd20c080df89b88eab18ae8fa96a6b8d00027af95b2b606e9b851b83dde
+  data.tar.gz: b6473ed381ddb267af1fcaee0ef6080a3c8063dac4d56ea5cbf0589457c7598e
 SHA512:
-  metadata.gz: d11ad18cdfb6c1955e521d8aae653b823f5defcfae4b095ae27f9bc9d1d0c89bca0336ab647c543b4c5d2cb92d2bffcd2c23343266b254aa1331984ac02abae9
-  data.tar.gz: 023da790f7233de7da68520ea85e2e0388e6c840d3950ba004118a754f46d4c2c0c4570c76ca29add86cf97cc0dc40d859094df430627f4cf57316df89df6bf7
+  metadata.gz: e28a752bdaaf619bf293c6a4f995a17e7cdea913c6c1c89be07dcb14c575a2b78264bbb6fad03d2b1ec574c2d0c72fd04ce84431e7920e6ac7180b5f4006c54c
+  data.tar.gz: aa8f768c03494a14b6dcafc9ada76764b028f750f6ff104627bb669c431321074fbac76ae81ab84df6510988d7cf161a9863c796c6615e343193ae2708979419

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"
       option :copy_latest,
              type: :boolean,
              default: false,

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/providers/_provider.rb

@@ -13,12 +13,12 @@ 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 +29,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 +59,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,13 +70,33 @@ 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
+
+      # 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]
@@ -95,17 +104,71 @@ module Publisher
         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 description_template
-        <<~DESC
+      def pr_body
+        @pr_body ||= <<~DESC
           <!-- allure -->
           ---
-          📝 [Latest allure report](#{report_url})
+          #{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

@@ -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: updated_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, 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 ||= 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

@@ -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: updated_pr_description)
+      end
+
+      # Add comment with report url
+      #
+      # @return [void]
+      def add_comment
+        return client.create_merge_request_comment(project, mr_iid, comment_body) unless comment
+
+        client.edit_merge_request_note(project, mr_iid, comment.id, 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|
+          comment.body.match?(DESCRIPTION_PATTERN)
+        end
       end
 
       # Get gitlab client
@@ -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/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.1.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.1.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 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