allure-report-publisher 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7d2654f1e2f5e4afe6dd64d08bd24a9fc6764d24abfb06f2f52dc66df21d56
-  data.tar.gz: cce27a83826622967fc3847c53275c8b087ef2e9c1aa216da3237081e75e3772
+  metadata.gz: be6f833714e1ff2ad413a9b5148cebd6454b23db763f567586b9e91222513524
+  data.tar.gz: 6984e37c220f693288037522a86716079f3a235634c3ccbdd360056fd186f83c
 SHA512:
-  metadata.gz: 0141ca8082a561395e97f93e9b02bbe17e2aa69bfddc2146452769e6009824e29e2e23203e2e36ad54afaacfbb91701f30527e65c6599d5b8d6707b3e7e3ffb1
-  data.tar.gz: 1420f1b3ec4fa386217bd4f0228bf59615772111190adcfb35f4ff68fce1de6eaa8bf39b173ec408ab4ef3c95645c00013c52d4acaca96cc4ab46efbe64bfb7e
+  metadata.gz: d11ad18cdfb6c1955e521d8aae653b823f5defcfae4b095ae27f9bc9d1d0c89bca0336ab647c543b4c5d2cb92d2bffcd2c23343266b254aa1331984ac02abae9
+  data.tar.gz: 023da790f7233de7da68520ea85e2e0388e6c840d3950ba004118a754f46d4c2c0c4570c76ca29add86cf97cc0dc40d859094df430627f4cf57316df89df6bf7

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://img.shields.io/gem/v/allure-report-publisher?color=red)](https://rubygems.org/gems/allure-report-publisher)
 [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/andrcuns/allure-report-publisher?color=blue&label=docker&sort=semver)](https://hub.docker.com/r/andrcuns/allure-report-publisher)
 ![Workflow status](https://github.com/andrcuns/allure-report-publisher/workflows/Test/badge.svg)
+[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](http://allure-reports-andrcuns.s3.amazonaws.com/allure-report-publisher/refs/heads/main/index.html)
 [![Maintainability](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/maintainability)](https://codeclimate.com/github/andrcuns/allure-report-publisher/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/test_coverage)](https://codeclimate.com/github/andrcuns/allure-report-publisher/test_coverage)
 

data/lib/allure_report_publisher/commands/upload.rb

@@ -42,9 +42,18 @@ module Publisher
         validate_result_files(args[:results_glob])
         Helpers.pastel(force_color: args[:color] || nil)
 
-        uploaders(args[:type])
-          .new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
-          .execute
+        uploader = uploaders(args[:type]).new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
+
+        log("Generating allure report")
+        Spinner.spin("generating") { uploader.generate_report }
+
+        log("Uploading allure report to #{args[:type]}")
+        Spinner.spin("uploading") { uploader.upload }
+        uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
+        return unless args[:update_pr] && uploader.pr?
+
+        log("Updating pull request description")
+        Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
       end
 
       private

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

@@ -52,12 +52,19 @@ module Publisher
         update_pr_description("#{pr_description}\n\n#{description_template}".strip)
       end
 
+      # :nocov:
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        raise("Not implemented!")
+      end
+
       private
 
       attr_reader :results_path, :report_url
 
-      # :nocov:
-
       # Get executor info
       #
       # @return [Hash]
@@ -65,13 +72,6 @@ module Publisher
         raise("Not implemented!")
       end
 
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        raise("Not implemented!")
-      end
-
       # Current pull request description
       #
       # @return [String]

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

@@ -12,6 +12,13 @@ module Publisher
         @run_id ||= ENV["GITHUB_RUN_ID"]
       end
 
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        ENV["GITHUB_EVENT_NAME"] == "pull_request"
+      end
+
       private
 
       # Executor info
@@ -41,13 +48,6 @@ module Publisher
         end
       end
 
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        ENV["GITHUB_EVENT_NAME"] == "pull_request"
-      end
-
       # Pull request description
       #
       # @return [String]

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

@@ -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]
@@ -57,13 +64,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]

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -20,11 +20,8 @@ module Publisher
     #
     # @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
@@ -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
@@ -25,13 +27,52 @@ module Publisher
       #
       # @return [void]
       def execute
-        client # initialize client and check for errors
-
-        generate
+        generate_report
         upload
         add_url_to_pr
-      rescue StandardError => e
-        error(e.message)
+      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
@@ -54,6 +95,13 @@ module Publisher
         raise("Not Implemented!")
       end
 
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        raise("Not Implemented!")
+      end
+
       # Download allure history
       #
       # @return [void]
@@ -87,11 +135,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
-          download_history
-        end
+        create_history_dir
+        download_history
+      rescue HistoryNotFoundError
+        nil
       end
 
       # Add CI executor info
@@ -100,30 +147,7 @@ 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
-        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
+        ci_provider.write_executor_info
       end
 
       # Run upload commands
@@ -135,18 +159,6 @@ module Publisher
         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]

data/lib/allure_report_publisher/lib/uploaders/gcs.rb

@@ -41,7 +41,7 @@ module Publisher
       def download_history
         HISTORY.each do |file_name|
           file = bucket.file(key(prefix, "history", file_name))
-          raise("Allure history from previous runs not found!") unless file
+          raise(HistoryNotFoundError, "Allure history from previous runs not found!") unless file
 
           file.download(path(results_dir, "history", file_name))
         end

data/lib/allure_report_publisher/lib/uploaders/s3.rb

@@ -46,7 +46,7 @@ module Publisher
           )
         end
       rescue Aws::S3::Errors::NoSuchKey
-        raise("Allure history from previous runs not found!")
+        raise(HistoryNotFoundError, "Allure history from previous runs not found!")
       end
 
       # Upload allure history

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3