allure-report-publisher 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818cdc599b432cb8484e95662881253a9f0df4265eb742f3f56f459ecbe57dfd
-  data.tar.gz: a261391b7851b0305883c6cd15a9789854051b30d39184728235641f881fe3fa
+  metadata.gz: f0a1bb3d8d9d7a22c080bcb2ce71fcf4d082d49b8ffd528fb3ef409d4afbf0ef
+  data.tar.gz: 992e16c2cb4ee7feabefd9250efb13f824804e2a30bec5c6f031666f41e8f9a9
 SHA512:
-  metadata.gz: 9e8ea6e47d729b8e484c660a5add949546662deb3d339caf6d95b4e45c5970db7137375cf3dd67764f5dcb7e9b78859eb52f8dfc3da0e5dedbcb7d346a5f5e26
-  data.tar.gz: dec6eec389f65663b7b6f7531796e0e7c0a39a2137e5f94c0dd881e87284ca31b6a268462a7dca99909250b91b911f250e378319dcb3b97930078eaa22b858c9
+  metadata.gz: 9806755fe1c216f8c590e183e0b667060a92017d42991a65663ed74aa8519d8e390e2eafe6dd35d67dacd0f40df3e1c75feab23498869073fe343d2514c02767
+  data.tar.gz: 6a04f0503833d6378c3f4923b159a2567e8b3a9fc3ee642825ec45ef921d514616a2b93c39d50204cd29573dc88723b4ef2c47f9d3c05a30942dff63f6d91433

data/README.md

@@ -45,16 +45,17 @@ Description:
   Generate and upload allure report
 
 Options:
-  --[no-]color                     # Toggle color output
+  --[no-]color                     # Toggle color output, default: false
   --[no-]update-pr                 # Update pull request description with url to allure report, default: false
-  --result-files-glob=VALUE        # Allure results files glob. Required: true
+  --[no-]copy-latest               # Keep copy of latest report at base prefix path, default: false
+  --results-glob=VALUE             # Allure results files glob. Required: true
   --bucket=VALUE                   # Bucket name. Required: true
   --prefix=VALUE                   # Optional prefix for report path. Required: false
   --help, -h                       # Print this help
 
 Examples:
-  allure-report-publisher upload s3 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket
-  allure-report-publisher upload s3 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs
+  allure-report-publisher upload s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket
+  allure-report-publisher upload s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs
 ```
 
 ## Development

data/lib/allure_report_publisher/commands/base.rb

@@ -5,11 +5,15 @@ module Publisher
     module CommonOptions
       def self.included(mod)
         mod.instance_eval do
-          option :color, type: :boolean, desc: "Toggle color output"
+          option :color, type: :boolean, desc: "Toggle color output, default: false"
           option :update_pr,
                  type: :boolean,
                  default: false,
                  desc: "Update pull request description with url to allure report"
+          option :copy_latest,
+                 type: :boolean,
+                 default: false,
+                 desc: "Keep copy of latest report at base prefix path"
         end
       end
     end

data/lib/allure_report_publisher/commands/upload_s3.rb

@@ -8,24 +8,22 @@ module Publisher
 
       desc "Generate and upload allure report"
 
-      option :result_files_glob, desc: "Allure results files glob. Required: true"
+      option :results_glob, desc: "Allure results files glob. Required: true"
       option :bucket, desc: "Bucket name. Required: true"
       option :prefix, desc: "Optional prefix for report path. Required: false"
 
       example [
-        "--result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket",
-        "--result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs"
+        "--results-glob='path/to/allure-result/**/*' --bucket=my-bucket",
+        "--results-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs"
       ]
 
       def call(**args)
         validate_args(args)
         Helpers.pastel(force_color: args[:color])
 
-        Uploaders::S3.new(
-          args[:result_files_glob],
-          args[:bucket],
-          args[:prefix]
-        ).execute(update_pr: args[:update_pr])
+        Uploaders::S3
+          .new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
+          .execute
       end
 
       private
@@ -35,7 +33,7 @@ module Publisher
       # @param [Hash] args
       # @return [void]
       def validate_args(args)
-        error("Missing argument --result-files-glob!") unless args[:result_files_glob]
+        error("Missing argument --results-glob!") unless args[:results_glob]
         error("Missing argument --bucket!") unless args[:bucket]
       end
     end

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

@@ -13,10 +13,12 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob, bucket, prefix = nil)
+      def initialize(results_glob:, bucket:, update_pr: false, prefix: nil, copy_latest: false)
         @results_glob = results_glob
         @bucket = bucket
         @prefix = prefix
+        @update_pr = update_pr
+        @copy_latest = Providers.provider && copy_latest # copy latest for ci only
       end
 
       # :nocov:
@@ -24,19 +26,19 @@ module Publisher
       # Execute allure report generation and upload
       #
       # @return [void]
-      def execute(update_pr: false)
+      def execute
         check_client_configured
 
-        generate_report
-        upload_history_and_report
-        add_report_url if update_pr
+        generate
+        upload
+        add_url_to_pr
       rescue StandardError => e
         error(e.message)
       end
 
       private
 
-      attr_reader :results_glob, :bucket, :prefix
+      attr_reader :results_glob, :bucket, :prefix, :update_pr, :copy_latest
 
       # Validate if client is properly configured
       # and raise error if it is not
@@ -53,13 +55,28 @@ module Publisher
         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_history_and_report
+      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]
@@ -86,25 +103,43 @@ module Publisher
       # Generate allure report
       #
       # @return [void]
-      def generate_report
+      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_report
+        upload_latest_copy if copy_latest
+      end
+
       # Add allure report url to pull request description
       #
       # @return [void]
-      def add_report_url
-        return unless ci_provider
+      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
-      # :nocov:
 
       # Get run id
       #

data/lib/allure_report_publisher/lib/uploaders/s3_uploader.rb

@@ -7,6 +7,19 @@ module Publisher
     class S3 < Uploader
       private
 
+      # S3 client
+      #
+      # @return [Aws::S3::Client]
+      def s3
+        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
+      rescue Aws::Sigv4::Errors::MissingCredentialsError
+        raise(<<~MSG.strip)
+          missing aws credentials, provide credentials with one of the following options:
+            - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables
+            - ~/.aws/credentials file
+        MSG
+      end
+
       # Validate if client is properly configured
       # and raise error if it is not
       #
@@ -19,7 +32,14 @@ module Publisher
       #
       # @return [String]
       def report_url
-        @report_url ||= ["http://#{bucket}.s3.amazonaws.com", full_prefix, "index.html"].compact.join("/")
+        @report_url ||= url(full_prefix)
+      end
+
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        @latest_report_url ||= url(prefix)
       end
 
       # Add allure history
@@ -39,30 +59,6 @@ module Publisher
         end
       end
 
-      # Upload report to s3
-      #
-      # @return [void]
-      def upload_history_and_report
-        log("Uploading report to s3")
-        Helpers::Spinner.spin("uploading report", done_message: "done. #{report_url}") do
-          upload_history
-          upload_report
-        end
-      end
-
-      # S3 client
-      #
-      # @return [Aws::S3::Client]
-      def s3
-        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
-      rescue Aws::Sigv4::Errors::MissingCredentialsError
-        raise(<<~MSG.strip)
-          missing aws credentials, provide credentials with one of the following options:
-            - AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables
-            - ~/.aws/credentials file
-        MSG
-      end
-
       # Upload allure history
       #
       # @return [void]
@@ -74,7 +70,14 @@ module Publisher
       #
       # @return [void]
       def upload_report
-        upload_to_s3(report_files)
+        upload_to_s3(report_files, full_prefix)
+      end
+
+      # Upload copy of latest run
+      #
+      # @return [void]
+      def upload_latest_copy
+        upload_to_s3(report_files, prefix)
       end
 
       # Upload files to s3
@@ -82,7 +85,7 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @return [Array<Hash>]
-      def upload_to_s3(files, key_prefix = full_prefix)
+      def upload_to_s3(files, key_prefix)
         args = files.map do |file|
           {
             body: File.new(file),
@@ -101,6 +104,14 @@ module Publisher
       def key(*args)
         args.compact.join("/")
       end
+
+      # Report url
+      #
+      # @param [String] path_prefix
+      # @return [String]
+      def url(path_prefix)
+        ["http://#{bucket}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
+      end
     end
   end
 end

data/lib/allure_report_publisher/version.rb

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

metadata

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