allure-report-publisher 0.0.3 → 0.1.1

data/lib/allure_report_publisher/lib/uploaders/{s3_uploader.rb → s3.rb}

@@ -7,60 +7,46 @@ module Publisher
     class S3 < Uploader
       private
 
-      # Validate if client is properly configured
-      # and raise error if it is not
+      # S3 client
       #
-      # @return [void]
-      def check_client_configured
-        s3
+      # @return [Aws::S3::Client]
+      def client
+        @client ||= 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
 
       # Report url
       #
       # @return [String]
       def report_url
-        @report_url ||= ["http://#{bucket}.s3.amazonaws.com", full_prefix, "index.html"].compact.join("/")
+        @report_url ||= url(full_prefix)
       end
 
-      # Add allure history
+      # Latest report url
       #
-      # @return [void]
-      def add_history
-        super do
-          HISTORY.each do |file|
-            s3.get_object(
-              response_target: path(results_dir, "history", file),
-              key: key(prefix, "history", file),
-              bucket: bucket
-            )
-          end
-        rescue Aws::S3::Errors::NoSuchKey
-          raise("Allure history from previous runs not found!")
-        end
+      # @return [String]
+      def latest_report_url
+        @latest_report_url ||= url(prefix)
       end
 
-      # Upload report to s3
+      # Add allure history
       #
       # @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
+      def download_history
+        HISTORY.each do |file|
+          client.get_object(
+            response_target: path(results_path, "history", file),
+            key: key(prefix, "history", file),
+            bucket: bucket_name
+          )
         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
+      rescue Aws::S3::Errors::NoSuchKey
+        raise(HistoryNotFoundError, "Allure history from previous runs not found!")
       end
 
       # Upload allure history
@@ -74,7 +60,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,16 +75,16 @@ 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),
-            bucket: bucket,
-            key: key(key_prefix, file.relative_path_from(report_dir))
+            bucket: bucket_name,
+            key: key(key_prefix, file.relative_path_from(report_path))
           }
         end
 
-        Parallel.each(args, in_threads: 8) { |obj| s3.put_object(obj) }
+        Parallel.each(args, in_threads: 8) { |obj| client.put_object(obj) }
       end
 
       # Fabricate key for s3 object
@@ -101,6 +94,14 @@ module Publisher
       def key(*args)
         args.compact.join("/")
       end
+
+      # Report url
+      #
+      # @param [String] path_prefix
+      # @return [String]
+      def url(path_prefix)
+        ["http://#{bucket_name}.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.1.1"
 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.1.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -34,16 +34,22 @@ dependencies:
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.17'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-storage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -139,17 +159,17 @@ files:
 - README.md
 - bin/allure-report-publisher
 - lib/allure_report_publisher.rb
-- lib/allure_report_publisher/commands/base.rb
-- lib/allure_report_publisher/commands/upload_s3.rb
+- lib/allure_report_publisher/commands/upload.rb
 - lib/allure_report_publisher/commands/version.rb
 - lib/allure_report_publisher/lib/helpers/helpers.rb
 - lib/allure_report_publisher/lib/helpers/spinner.rb
-- lib/allure_report_publisher/lib/providers/_base.rb
+- 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/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
-- lib/allure_report_publisher/lib/uploaders/s3_uploader.rb
+- lib/allure_report_publisher/lib/uploaders/gcs.rb
+- lib/allure_report_publisher/lib/uploaders/s3.rb
 - lib/allure_report_publisher/version.rb
 homepage: https://github.com/andrcuns/allure-report-uploader
 licenses:

data/lib/allure_report_publisher/commands/base.rb

@@ -1,17 +0,0 @@
-module Publisher
-  module Commands
-    # Common arguments and options definition
-    #
-    module CommonOptions
-      def self.included(mod)
-        mod.instance_eval do
-          option :color, type: :boolean, desc: "Toggle color output"
-          option :update_pr,
-                 type: :boolean,
-                 default: false,
-                 desc: "Update pull request description with url to allure report"
-        end
-      end
-    end
-  end
-end

data/lib/allure_report_publisher/commands/upload_s3.rb

@@ -1,43 +0,0 @@
-module Publisher
-  module Commands
-    # Upload allure report
-    #
-    class UploadS3 < Dry::CLI::Command
-      include CommonOptions
-      include Helpers
-
-      desc "Generate and upload allure report"
-
-      option :result_files_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"
-      ]
-
-      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])
-      end
-
-      private
-
-      # Validate required args
-      #
-      # @param [Hash] args
-      # @return [void]
-      def validate_args(args)
-        error("Missing argument --result-files-glob!") unless args[:result_files_glob]
-        error("Missing argument --bucket!") unless args[:bucket]
-      end
-    end
-  end
-end

data/lib/allure_report_publisher/lib/providers/_base.rb

@@ -1,111 +0,0 @@
-module Publisher
-  # Namespace for providers executing tests
-  #
-  module Providers
-    # Detect CI provider
-    #
-    # @return [Publisher::Providers::Base]
-    def self.provider
-      return Github if ENV["GITHUB_WORKFLOW"]
-      return Gitlab if ENV["GITLAB_CI"]
-    end
-
-    # Base class for CI executor info
-    #
-    class Base
-      EXECUTOR_JSON = "executor.json".freeze
-      DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
-
-      def initialize(results_path, report_url)
-        @results_path = results_path
-        @report_url = report_url
-      end
-
-      # :nocov:
-
-      # Get ci run ID without creating instance of ci provider
-      #
-      # @return [String]
-      def self.run_id
-        raise("Not implemented!")
-      end
-      # :nocov:
-
-      # Write executor info file
-      #
-      # @return [void]
-      def write_executor_info
-        File.open("#{results_path}/#{EXECUTOR_JSON}", "w") do |file|
-          file.write(executor_info.to_json)
-        end
-      end
-
-      # Add report url to pull request description
-      #
-      # @return [void]
-      def add_report_url
-        raise("Not a pull request, skipped!") unless pr?
-
-        reported = pr_description.match?(DESCRIPTION_PATTERN)
-        return update_pr_description(pr_description.gsub(DESCRIPTION_PATTERN, description_template).strip) if reported
-
-        update_pr_description("#{pr_description}\n\n#{description_template}".strip)
-      end
-
-      private
-
-      attr_reader :results_path, :report_url
-
-      # :nocov:
-
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
-
-      # Pull request run
-      #
-      # @return [Boolean]
-      def pr?
-        raise("Not implemented!")
-      end
-
-      # Current pull request description
-      #
-      # @return [String]
-      def pr_description
-        raise("Not implemented!")
-      end
-
-      # Update pull request description
-      #
-      # @param [String] _desc
-      # @return [void]
-      def update_pr_description(_desc)
-        raise("Not implemented!")
-      end
-      # :nocov:
-
-      # CI run id
-      #
-      # @return [String]
-      def run_id
-        self.class.run_id
-      end
-
-      # Allure report url pr description
-      #
-      # @return [String]
-      def description_template
-        <<~DESC
-          <!-- allure -->
-          ---
-          📝 [Latest allure report](#{report_url})
-          <!-- allurestop -->
-        DESC
-      end
-    end
-  end
-end