allure-report-publisher 0.0.2 → 0.1.0

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

@@ -0,0 +1,132 @@
+require "gitlab"
+
+module Publisher
+  module Providers
+    # Gitlab implementation
+    #
+    class Gitlab < Provider
+      # Get ci run ID without creating instance of ci provider
+      #
+      # @return [String]
+      def self.run_id
+        @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]
+      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
+
+      private
+
+      # Current pull request description
+      #
+      # @return [String]
+      def pr_description
+        @pr_description ||= client.merge_request(project, mr_iid).description
+      end
+
+      # Update pull request description
+      #
+      # @return [void]
+      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
+      #
+      # @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
+
+      # 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[ALLURE_JOB_NAME] || ENV["CI_JOB_NAME"]
+      end
+
+      # 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,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,61 +16,130 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob, bucket, prefix = nil)
+      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
       end
 
-      # :nocov:
-
       # Execute allure report generation and upload
       #
       # @return [void]
       def execute
-        raise(StandardError, "Not Implemented!")
+        generate_report
+        upload
+        add_url_to_pr
+      end
+
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        add_history
+        add_executor_info
+
+        ReportGenerator.new(results_glob, results_path, report_path).generate
+      end
+
+      # Upload report to storage provider
+      #
+      # @return [void]
+      def upload
+        run_uploads
+      end
+
+      # Add allure report url to pull request description
+      #
+      # @return [void]
+      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
-      # :nocov:
 
       private
 
-      attr_reader :results_glob, :bucket, :prefix
+      attr_reader :results_glob, :bucket_name, :prefix, :update_pr, :copy_latest
 
       # :nocov:
 
+      # Cloud provider client
+      #
+      # @return [Object]
+      def client
+        raise("Not Implemented!")
+      end
+
       # Report url
       #
       # @return [String]
       def report_url
-        raise(StandardError, "Not Implemented!")
+        raise("Not Implemented!")
       end
-      # :nocov:
 
-      # Get run id
+      # Latest report url
       #
       # @return [String]
-      def run_id
-        @run_id ||= CI.provider&.run_id
+      def latest_report_url
+        raise("Not Implemented!")
       end
 
-      # Get CI provider
+      # Download allure history
       #
-      # @return [Publisher::CI::Base]
-      def ci_provider
-        return @ci_provider if defined?(@ci_provider)
+      # @return [void]
+      def download_history
+        raise("Not implemented!")
+      end
+
+      # Upload history to s3
+      #
+      # @return [void]
+      def upload_history
+        raise("Not implemented!")
+      end
 
-        @ci_provider = CI.provider&.new(results_dir, report_url)
+      # Upload report to s3
+      #
+      # @return [void]
+      def upload_report
+        raise("Not implemented!")
+      end
+
+      # Upload copy of latest run
+      #
+      # @return [void]
+      def upload_latest_copy
+        raise("Not implemented!")
       end
+      # :nocov:
 
       # Add allure history
       #
       # @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
@@ -76,17 +148,41 @@ module Publisher
       def add_executor_info
         return unless ci_provider
 
-        log("Adding executor info")
-        Helpers::Spinner.spin("adding") 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
 
+      # Run upload commands
+      #
+      # @return [void]
+      def run_uploads
+        upload_history unless !run_id || copy_latest
+        upload_report
+        upload_latest_copy if copy_latest
+      end
+
+      # 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(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
@@ -103,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
@@ -119,19 +215,9 @@ module Publisher
       # @return [Array<Pathname>]
       def report_files
         @report_files ||= Pathname
-                          .glob("#{report_dir}/**/*")
+                          .glob("#{report_path}/**/*")
                           .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/gcs.rb

@@ -0,0 +1,104 @@
+require "google/cloud/storage"
+
+module Publisher
+  module Uploaders
+    # Google cloud storage uploader implementation
+    #
+    class GCS < Uploader
+      private
+
+      # GCS client
+      #
+      # @return [Google::Cloud::Storage::Project]
+      def client
+        @client ||= Google::Cloud::Storage.new
+      end
+
+      # GCS bucket
+      #
+      # @return [Google::Cloud::Storage::Bucket]
+      def bucket
+        @bucket ||= client.bucket(bucket_name, skip_lookup: true)
+      end
+
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        @report_url ||= url(full_prefix)
+      end
+
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        @latest_report_url ||= url(prefix)
+      end
+
+      # Download allure history
+      #
+      # @return [void]
+      def download_history
+        HISTORY.each do |file_name|
+          file = bucket.file(key(prefix, "history", file_name))
+          raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
+
+          file.download(path(results_path, "history", file_name))
+        end
+      end
+
+      # Upload allure history
+      #
+      # @return [void]
+      def upload_history
+        upload_to_gcs(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+      end
+
+      # Upload allure report
+      #
+      # @return [void]
+      def upload_report
+        upload_to_gcs(report_files, full_prefix)
+      end
+
+      # Upload copy of latest run
+      #
+      # @return [void]
+      def upload_latest_copy
+        upload_to_gcs(report_files, prefix)
+      end
+
+      # Upload files to s3
+      #
+      # @param [Array<Pathname>] files
+      # @param [String] key_prefix
+      # @return [Array<Hash>]
+      def upload_to_gcs(files, key_prefix)
+        args = files.map do |file|
+          {
+            file: file.to_s,
+            path: key(key_prefix, file.relative_path_from(report_path))
+          }
+        end
+
+        Parallel.each(args, in_threads: 8) { |obj| bucket.create_file(obj[:file], obj[:path]) }
+      end
+
+      # Fabricate key for s3 object
+      #
+      # @param [String] *args
+      # @return [String]
+      def key(*args)
+        args.compact.join("/")
+      end
+
+      # Report url
+      #
+      # @param [String] path_prefix
+      # @return [String]
+      def url(path_prefix)
+        ["https://storage.googleapis.com", bucket_name, path_prefix, "index.html"].compact.join("/")
+      end
+    end
+  end
+end