allure-report-publisher 0.0.4 → 0.2.0

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

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

@@ -10,8 +10,8 @@ module Publisher
       # S3 client
       #
       # @return [Aws::S3::Client]
-      def s3
-        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
+      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:
@@ -20,14 +20,6 @@ module Publisher
         MSG
       end
 
-      # Validate if client is properly configured
-      # and raise error if it is not
-      #
-      # @return [void]
-      def check_client_configured
-        s3
-      end
-
       # Report url
       #
       # @return [String]
@@ -45,18 +37,16 @@ module Publisher
       # Add allure history
       #
       # @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!")
+      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
+      rescue Aws::S3::Errors::NoSuchKey
+        raise(HistoryNotFoundError, "Allure history from previous runs not found!")
       end
 
       # Upload allure history
@@ -89,12 +79,12 @@ module Publisher
         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
@@ -110,7 +100,7 @@ module Publisher
       # @param [String] path_prefix
       # @return [String]
       def url(path_prefix)
-        ["http://#{bucket}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
+        ["http://#{bucket_name}.s3.amazonaws.com", path_prefix, "index.html"].compact.join("/")
       end
     end
   end

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 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,18 @@ 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/providers/url_section_builder.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,21 +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, 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
-  end
-end

data/lib/allure_report_publisher/commands/upload_s3.rb

@@ -1,41 +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 :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 [
-        "--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.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
-          .execute
-      end
-
-      private
-
-      # Validate required args
-      #
-      # @param [Hash] args
-      # @return [void]
-      def validate_args(args)
-        error("Missing argument --results-glob!") unless args[:results_glob]
-        error("Missing argument --bucket!") unless args[:bucket]
-      end
-    end
-  end
-end