allure-report-publisher 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0a1bb3d8d9d7a22c080bcb2ce71fcf4d082d49b8ffd528fb3ef409d4afbf0ef
-  data.tar.gz: 992e16c2cb4ee7feabefd9250efb13f824804e2a30bec5c6f031666f41e8f9a9
+  metadata.gz: 2d7d2654f1e2f5e4afe6dd64d08bd24a9fc6764d24abfb06f2f52dc66df21d56
+  data.tar.gz: cce27a83826622967fc3847c53275c8b087ef2e9c1aa216da3237081e75e3772
 SHA512:
-  metadata.gz: 9806755fe1c216f8c590e183e0b667060a92017d42991a65663ed74aa8519d8e390e2eafe6dd35d67dacd0f40df3e1c75feab23498869073fe343d2514c02767
-  data.tar.gz: 6a04f0503833d6378c3f4923b159a2567e8b3a9fc3ee642825ec45ef921d514616a2b93c39d50204cd29573dc88723b4ef2c47f9d3c05a30942dff63f6d91433
+  metadata.gz: 0141ca8082a561395e97f93e9b02bbe17e2aa69bfddc2146452769e6009824e29e2e23203e2e36ad54afaacfbb91701f30527e65c6599d5b8d6707b3e7e3ffb1
+  data.tar.gz: 1420f1b3ec4fa386217bd4f0228bf59615772111190adcfb35f4ff68fce1de6eaa8bf39b173ec408ab4ef3c95645c00013c52d4acaca96cc4ab46efbe64bfb7e

data/README.md

@@ -28,36 +28,44 @@ docker pull andrcuns/allure-report-publisher:latest
 
 allure-report-publisher will automatically detect if used in CI environment and add relevant executor info and history
 
-### AWS S3
-
-- `AWS authentication`: requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
 - `Allure report link`: requires `GITHUB_AUTH_TOKEN` or `GITLAB_AUTH_TOKEN` in order to update pull request description with link to latest report
 
 ```shell
-$ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload s3 --help
+$ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload --help
 Command:
-  allure-report-publisher upload s3
+  allure-report-publisher upload
 
 Usage:
-  allure-report-publisher upload s3
+  allure-report-publisher upload TYPE
 
 Description:
   Generate and upload allure report
 
+Arguments:
+  TYPE                 # REQUIRED Cloud storage type: (s3/gcs)
+
 Options:
-  --[no-]color                     # Toggle color output, default: false
-  --[no-]update-pr                 # Update pull request description with url to allure report, default: false
-  --[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
+  --[no-]update-pr                 # Update pull request description with url to allure report, default: false
+  --[no-]copy-latest               # Keep copy of latest report at base prefix path, default: false
+  --[no-]color                     # Toggle color output, default: false
   --help, -h                       # Print this help
 
 Examples:
   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
+  allure-report-publisher upload gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs
 ```
 
+### AWS S3
+
+- `AWS authentication`: requires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`
+
+### Google Cloud Storage
+
+- `GCS authentication`: requires environment variable `GOOGLE_CLOUD_CREDENTIALS_JSON` with contents of credentials.json
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/allure_report_publisher.rb

@@ -14,11 +14,8 @@ module Publisher
     extend Dry::CLI::Registry
 
     register "version", Version, aliases: ["-v", "--version"]
-
-    register "upload" do |prefix|
-      prefix.register "s3", UploadS3
-    end
+    register "upload", Upload, aliases: ["u"]
   end
 end
 
-Publisher::Commands.before("upload s3") { Publisher::Helpers.validate_allure_cli_present }
+Publisher::Commands.before("upload") { Publisher::Helpers.validate_allure_cli_present }

data/lib/allure_report_publisher/commands/upload.rb

@@ -0,0 +1,81 @@
+module Publisher
+  module Commands
+    # Upload allure report
+    #
+    class Upload < Dry::CLI::Command
+      include Helpers
+
+      desc "Generate and upload allure report"
+
+      argument :type,
+               type: :string,
+               required: true,
+               values: %w[s3 gcs],
+               desc: "Cloud storage type"
+
+      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"
+      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"
+      option :color,
+             type: :boolean,
+             default: false,
+             desc: "Toggle color output"
+
+      example [
+        "s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket",
+        "gcs --results-glob='path/to/allure-result/**/*' --bucket=my-bucket --prefix=my-project/prs"
+      ]
+
+      def call(**args)
+        validate_args(args)
+        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
+      end
+
+      private
+
+      # Uploader class
+      #
+      # @param [String] uploader
+      # @return [Publisher::Uploaders::Uploader]
+      def uploaders(uploader)
+        {
+          "s3" => Uploaders::S3,
+          "gcs" => Uploaders::GCS
+        }[uploader]
+      end
+
+      # 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
+
+      # Check if allure results present
+      #
+      # @param [String] results_glob
+      # @return [void]
+      def validate_result_files(results_glob)
+        Dir.glob(results_glob).empty? && error("Glob '#{results_glob}' did not match any files!")
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/lib/providers/{_base.rb → _provider.rb}

@@ -12,7 +12,7 @@ module Publisher
 
     # Base class for CI executor info
     #
-    class Base
+    class Provider
       EXECUTOR_JSON = "executor.json".freeze
       DESCRIPTION_PATTERN = /<!-- allure -->[\s\S]+<!-- allurestop -->/.freeze
 

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

@@ -4,7 +4,7 @@ module Publisher
   module Providers
     # Github implementation
     #
-    class Github < Base
+    class Github < Provider
       # Run id
       #
       # @return [String]

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

@@ -4,7 +4,7 @@ module Publisher
   module Providers
     # Gitlab implementation
     #
-    class Gitlab < Base
+    class Gitlab < Provider
       # Get ci run ID without creating instance of ci provider
       #
       # @return [String]

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

@@ -15,19 +15,17 @@ module Publisher
 
       def initialize(results_glob:, bucket:, update_pr: false, prefix: nil, copy_latest: false)
         @results_glob = results_glob
-        @bucket = bucket
+        @bucket_name = bucket
         @prefix = prefix
         @update_pr = update_pr
-        @copy_latest = Providers.provider && copy_latest # copy latest for ci only
+        @copy_latest = !!(Providers.provider && copy_latest) # copy latest for ci only
       end
 
-      # :nocov:
-
       # Execute allure report generation and upload
       #
       # @return [void]
       def execute
-        check_client_configured
+        client # initialize client and check for errors
 
         generate
         upload
@@ -38,13 +36,14 @@ module Publisher
 
       private
 
-      attr_reader :results_glob, :bucket, :prefix, :update_pr, :copy_latest
+      attr_reader :results_glob, :bucket_name, :prefix, :update_pr, :copy_latest
 
-      # Validate if client is properly configured
-      # and raise error if it is not
+      # :nocov:
+
+      # Cloud provider client
       #
-      # @return [void]
-      def check_client_configured
+      # @return [Object]
+      def client
         raise("Not Implemented!")
       end
 
@@ -55,6 +54,13 @@ module Publisher
         raise("Not Implemented!")
       end
 
+      # Download allure history
+      #
+      # @return [void]
+      def download_history
+        raise("Not implemented!")
+      end
+
       # Upload history to s3
       #
       # @return [void]
@@ -84,7 +90,7 @@ module Publisher
         log("Adding allure history")
         Helpers::Spinner.spin("adding history", exit_on_error: false) do
           create_history_dir
-          yield
+          download_history
         end
       end
 
@@ -124,7 +130,7 @@ module Publisher
       #
       # @return [void]
       def run_uploads
-        upload_history unless copy_latest # latest report will add a common history folder
+        upload_history unless !run_id || copy_latest
         upload_report
         upload_latest_copy if copy_latest
       end

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("Allure history from previous runs not found!") unless file
+
+          file.download(path(results_dir, "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_dir))
+          }
+        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_dir, "history", file),
+            key: key(prefix, "history", file),
+            bucket: bucket_name
+          )
         end
+      rescue Aws::S3::Errors::NoSuchKey
+        raise("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,
+            bucket: bucket_name,
             key: key(key_prefix, file.relative_path_from(report_dir))
           }
         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.0.5"
 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.0.5
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -58,6 +58,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 +153,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,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