allure-report-publisher 0.0.1 → 0.0.6

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

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

@@ -20,11 +20,8 @@ module Publisher
     #
     # @return [void]
     def generate
-      log("\nGenerating allure report")
-      spin("generating report") do
-        aggregate_results
-        generate_report
-      end
+      aggregate_results
+      generate_report
     end
 
     private
@@ -36,7 +33,7 @@ module Publisher
     # @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)
     end
@@ -48,7 +45,7 @@ module Publisher
       out, _err, status = Open3.capture3(
         "allure generate --clean --output #{report_dir} #{results_dir}"
       )
-      error(out) unless status.success?
+      raise(AllureError, out) unless status.success?
     end
   end
 end

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

@@ -1,5 +1,7 @@
 module Publisher
   module Uploaders
+    class HistoryNotFoundError < StandardError; end
+
     # Uploader implementation
     #
     class Uploader
@@ -13,28 +15,164 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob, bucket, project = nil)
+      def initialize(results_glob:, bucket:, update_pr: false, prefix: nil, copy_latest: false)
         @results_glob = results_glob
-        @bucket = bucket
-        @project = project
+        @bucket_name = bucket
+        @prefix = prefix
+        @update_pr = update_pr
+        @copy_latest = !!(Providers.provider && copy_latest) # copy latest for ci only
       end
 
       # 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_dir, report_dir).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
 
       private
 
-      attr_reader :results_glob, :bucket, :project
+      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
+
+      # 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]
+      def upload_history
+        raise("Not implemented!")
+      end
+
+      # 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
+        create_history_dir
+        download_history
+      rescue HistoryNotFoundError
+        nil
+      end
+
+      # Add CI executor info
+      #
+      # @return [void]
+      def add_executor_info
+        return unless ci_provider
+
+        ci_provider.write_executor_info
+      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(results_dir, report_url)
       end
 
       # Fetch allure report history
@@ -47,21 +185,14 @@ module Publisher
       # Report path prefix
       #
       # @return [String]
-      def prefix
-        @prefix ||= [project, run_id].compact.yield_self do |pre|
+      def full_prefix
+        @full_prefix ||= [prefix, run_id].compact.yield_self do |pre|
           break if pre.empty?
 
           pre.join("/")
         end
       end
 
-      # Run ID
-      #
-      # @return [String]
-      def run_id
-        @run_id ||= ENV["RUN_ID"]
-      end
-
       # Aggregated results directory
       #
       # @return [String]
@@ -84,15 +215,6 @@ module Publisher
                           .glob("#{report_dir}/**/*")
                           .reject(&:directory?)
       end
-
-      # Generate allure report
-      #
-      # @return [void]
-      def generate_report
-        fetch_history if run_id
-
-        ReportGenerator.new(results_glob, results_dir, report_dir).generate
-      end
     end
   end
 end