allure-report-publisher 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bb81eada76c7024e4a570187d02e2383677552daef81b14e1e1457ca2fbc6be
-  data.tar.gz: 27db25caad167473b073a6057f82981d648889d800c3fddb879c3c046d5dc951
+  metadata.gz: 4b5ab2c7fe9d71734c9f57324a411d2dfb3034a63152e75a3827f3629375371b
+  data.tar.gz: 56296208184a82b42bfb04c7132788e6b4f924be16c4059a4e03e6782f9f54f2
 SHA512:
-  metadata.gz: 5b3d2e2a7faa93ad323cb24ea892aeb3601c904e30c4fdadaf78732bd903945c7ba2e488440bb5a1d834e0ec62a1616c83aea48e697596edd02d271fcf8d0719
-  data.tar.gz: 400d890b0e1b315d1aab1a246482a31849a38c3a78b231310ffc285b5fd14d677ee3b3badfcf098f9f15d982091f7d85dac6642f5e6b0d0bd2f7e1b5f1509510
+  metadata.gz: 60889df0f7995284adc34651a042f90f29a0a32f93895636b991205eafc078f696dd9f0117f28e3d85b111bf0d7fe84c4daa5a89f95a5cf4a295547a20c9c8b9
+  data.tar.gz: 0a5c6206ed052dd912b57e524190209993d5e58435a5ce4a28d3a1117fd4bc1191b6ae23d441ab2ec98588518bb18bba7aa9b3a9a2b6ed6fdd6c42480d0614ec

data/README.md

@@ -31,7 +31,7 @@ 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
 
-- `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 --help

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

@@ -13,7 +13,6 @@ module Publisher
     # 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:)
@@ -82,20 +81,20 @@ module Publisher
         raise("Not implemented!")
       end
 
-      # Commit SHA url
+      # Build name
       #
       # @return [String]
-      def sha_url
+      def build_name
         raise("Not implemented!")
       end
-      # :nocov:
 
-      # Add report url as comment
+      # Commit SHA url
       #
-      # @return [Boolean]
-      def comment?
-        update_pr == "comment"
+      # @return [String]
+      def sha_url
+        raise("Not implemented!")
       end
+      # :nocov:
 
       # CI run id
       #
@@ -104,70 +103,18 @@ module Publisher
         self.class.run_id
       end
 
-      # Check if PR already has report urls
+      # Add report url as comment
       #
       # @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", "")
+      def comment?
+        update_pr == "comment"
       end
 
-      # Single job report URL entry
+      # Report urls section creator
       #
-      # @return [String]
-      def job_entry
-        @job_entry ||= "**#{build_name}**: 📝 [allure report](#{report_url})"
+      # @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

@@ -58,16 +58,16 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_pull_request(repository, pr_id, body: updated_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, comment_body) unless comment
+        return client.add_comment(repository, pr_id, report_urls.comment_body) unless comment
 
-        client.update_comment(repository, comment[:id], comment_body)
+        client.update_comment(repository, comment[:id], report_urls.comment_body(comment[:body]))
       end
 
       # Existing comment with allure urls
@@ -75,7 +75,7 @@ module Publisher
       # @return [Sawyer::Resource]
       def comment
         @comment ||= client.issue_comments(repository, pr_id).detect do |comment|
-          comment[:body].match?(DESCRIPTION_PATTERN)
+          UrlSectionBuilder.match?(comment[:body])
         end
       end
 

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

@@ -48,16 +48,16 @@ module Publisher
       #
       # @return [void]
       def update_pr_description
-        client.update_merge_request(project, mr_iid, description: updated_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, comment_body) unless 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, comment_body)
+        client.edit_merge_request_note(project, mr_iid, comment.id, report_urls.comment_body(comment.body))
       end
 
       # Existing comment with allure urls
@@ -65,7 +65,7 @@ module Publisher
       # @return [Gitlab::ObjectifiedHash]
       def comment
         client.merge_request_comments(project, mr_iid).auto_paginate.detect do |comment|
-          comment.body.match?(DESCRIPTION_PATTERN)
+          UrlSectionBuilder.match?(comment.body)
         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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrejs Cunskis
@@ -166,6 +166,7 @@ files:
 - lib/allure_report_publisher/lib/providers/_provider.rb
 - lib/allure_report_publisher/lib/providers/github.rb
 - lib/allure_report_publisher/lib/providers/gitlab.rb
+- lib/allure_report_publisher/lib/providers/url_section_builder.rb
 - lib/allure_report_publisher/lib/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/gcs.rb