allure-report-publisher 0.0.4 → 0.2.0

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

@@ -4,7 +4,7 @@ module Publisher
   module Providers
     # Gitlab implementation
     #
-    class Gitlab < Base
+    class Gitlab < Provider
       # Get ci run ID without creating instance of ci provider
       #
       # @return [String]
@@ -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 = "**#{build_name}**: 📝 [allure report](#{report_url})")
+        @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})"
+      end
+
+      # Job entry pattern
+      #
+      # @return [RegExp]
+      def job_entry_pattern
+        @job_entry_pattern ||= /^\*\*#{build_name}\*\*:.*\[allure report\]\(.*\)$/
+      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,38 +16,76 @@ 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 = bucket
+        @bucket_name = bucket
         @prefix = prefix
         @update_pr = update_pr
-        @copy_latest = Providers.provider && copy_latest # copy latest for ci only
+        @copy_latest = !!(Providers.provider && copy_latest) # copy latest for ci only
       end
 
-      # :nocov:
-
       # Execute allure report generation and upload
       #
       # @return [void]
       def execute
-        check_client_configured
-
-        generate
+        generate_report
         upload
         add_url_to_pr
-      rescue StandardError => e
-        error(e.message)
       end
 
-      private
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        add_history
+        add_executor_info
 
-      attr_reader :results_glob, :bucket, :prefix, :update_pr, :copy_latest
+        ReportGenerator.new(results_glob, results_path, report_path).generate
+      end
 
-      # Validate if client is properly configured
-      # and raise error if it is not
+      # Upload report to storage provider
+      #
+      # @return [void]
+      def upload
+        run_uploads
+      end
+
+      # Add allure report url to pull request description
       #
       # @return [void]
-      def check_client_configured
+      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
+
+      attr_reader :results_glob, :bucket_name, :prefix, :update_pr, :copy_latest
+
+      # :nocov:
+
+      # Cloud provider client
+      #
+      # @return [Object]
+      def client
         raise("Not Implemented!")
       end
 
@@ -55,6 +96,20 @@ module Publisher
         raise("Not Implemented!")
       end
 
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        raise("Not Implemented!")
+      end
+
+      # Download allure history
+      #
+      # @return [void]
+      def download_history
+        raise("Not implemented!")
+      end
+
       # Upload history to s3
       #
       # @return [void]
@@ -81,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
-          yield
-        end
+        create_history_dir
+        download_history
+      rescue HistoryNotFoundError
+        nil
       end
 
       # Add CI executor info
@@ -94,53 +148,20 @@ 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]
       def run_uploads
-        upload_history unless copy_latest # latest report will add a common history folder
+        upload_history unless !run_id || copy_latest
         upload_report
         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]
@@ -154,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
@@ -178,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
@@ -194,7 +215,7 @@ module Publisher
       # @return [Array<Pathname>]
       def report_files
         @report_files ||= Pathname
-                          .glob("#{report_dir}/**/*")
+                          .glob("#{report_path}/**/*")
                           .reject(&:directory?)
       end
     end