allure-report-publisher 0.0.2 → 0.1.0

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

@@ -0,0 +1,107 @@
+require "aws-sdk-s3"
+
+module Publisher
+  module Uploaders
+    # Report upload to AWS S3 bucket
+    #
+    class S3 < Uploader
+      private
+
+      # S3 client
+      #
+      # @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 ||= url(full_prefix)
+      end
+
+      # Latest report url
+      #
+      # @return [String]
+      def latest_report_url
+        @latest_report_url ||= url(prefix)
+      end
+
+      # Add allure history
+      #
+      # @return [void]
+      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
+      #
+      # @return [void]
+      def upload_history
+        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
+      end
+
+      # Upload allure report
+      #
+      # @return [void]
+      def upload_report
+        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
+      #
+      # @param [Array<Pathname>] files
+      # @param [String] key_prefix
+      # @return [Array<Hash>]
+      def upload_to_s3(files, key_prefix)
+        args = files.map do |file|
+          {
+            body: File.new(file),
+            bucket: bucket_name,
+            key: key(key_prefix, file.relative_path_from(report_path))
+          }
+        end
+
+        Parallel.each(args, in_threads: 8) { |obj| client.put_object(obj) }
+      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)
+        ["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.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-29 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -32,18 +32,66 @@ dependencies:
         version: 1.95.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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.8'
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '4.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '4.21'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -111,16 +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/ci/_base.rb
-- lib/allure_report_publisher/lib/ci/github_actions.rb
 - lib/allure_report_publisher/lib/helpers/helpers.rb
 - lib/allure_report_publisher/lib/helpers/spinner.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,13 +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"
-        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
-      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/ci/_base.rb

@@ -1,63 +0,0 @@
-module Publisher
-  # CI provider utilities
-  #
-  module CI
-    # Detect CI provider
-    #
-    # @return [Publisher::CI::Base]
-    def self.provider
-      return GithubActions if ENV["GITHUB_WORKFLOW"]
-    end
-
-    # Base class for CI executor info
-    #
-    class Base
-      EXECUTOR_JSON = "executor.json".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
-
-      private
-
-      attr_reader :results_path, :report_url
-
-      # :nocov:
-
-      # Get executor info
-      #
-      # @return [Hash]
-      def executor_info
-        raise("Not implemented!")
-      end
-      # :nocov:
-
-      # CI run id
-      #
-      # @return [String]
-      def run_id
-        self.class.run_id
-      end
-    end
-  end
-end

data/lib/allure_report_publisher/lib/ci/github_actions.rb

@@ -1,50 +0,0 @@
-module Publisher
-  module CI
-    # Github actions executor info
-    #
-    class GithubActions < Base
-      # Run id
-      #
-      # @return [String]
-      def self.run_id
-        @run_id ||= ENV["GITHUB_RUN_ID"]
-      end
-
-      private
-
-      # Executor info
-      #
-      # @return [Hash]
-      def executor_info
-        {
-          name: "Github",
-          type: "github",
-          reportName: "AllureReport",
-          url: server_url,
-          reportUrl: report_url,
-          buildUrl: build_url,
-          buildOrder: run_id,
-          buildName: build_name
-        }
-      end
-
-      # Server url
-      #
-      # @return [String]
-      def server_url
-        @server_url ||= ENV["GITHUB_SERVER_URL"]
-      end
-
-      # Build url
-      #
-      # @return [String]
-      def build_url
-        @build_url ||= "#{server_url}/#{ENV['GITHUB_REPOSITORY']}/actions/runs/#{run_id}"
-      end
-
-      def build_name
-        @build_name ||= ENV["GITHUB_JOB"]
-      end
-    end
-  end
-end

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

@@ -1,94 +0,0 @@
-require "aws-sdk-s3"
-
-module Publisher
-  module Uploaders
-    # Report upload to AWS S3 bucket
-    #
-    class S3 < Uploader
-      def execute
-        generate_report
-        upload_history_and_report
-      end
-
-      private
-
-      # S3 client
-      #
-      # @return [Aws::S3::Client]
-      def s3
-        @s3 ||= Aws::S3::Client.new(region: ENV["AWS_REGION"] || "us-east-1")
-      end
-
-      # Report url
-      #
-      # @return [String]
-      def report_url
-        @report_url ||= ["http://#{bucket}.s3.amazonaws.com", full_prefix, "index.html"].compact.join("/")
-      end
-
-      # 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!")
-        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
-
-      # Upload allure history
-      #
-      # @return [void]
-      def upload_history
-        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
-      end
-
-      def upload_report
-        upload_to_s3(report_files)
-      end
-
-      # Upload files to s3
-      #
-      # @param [Array<Pathname>] files
-      # @param [String] key_prefix
-      # @return [Array<Hash>]
-      def upload_to_s3(files, key_prefix = full_prefix)
-        args = files.map do |file|
-          {
-            body: File.new(file),
-            bucket: bucket,
-            key: key(key_prefix, file.relative_path_from(report_dir))
-          }
-        end
-
-        Parallel.each(args, in_threads: 8) { |obj| s3.put_object(obj) }
-      end
-
-      # Fabricate key for s3 object
-      #
-      # @param [String] *args
-      # @return [String]
-      def key(*args)
-        args.compact.join("/")
-      end
-    end
-  end
-end