allure-report-publisher 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1362930b746c980e6cc2130d5a304c1be870a6e79658df5143bda833035773a8
-  data.tar.gz: e23baf8887d7acee4dd919e0e4b71282c6e462476cf0ddd037a6c82d7248a290
+  metadata.gz: be6f833714e1ff2ad413a9b5148cebd6454b23db763f567586b9e91222513524
+  data.tar.gz: 6984e37c220f693288037522a86716079f3a235634c3ccbdd360056fd186f83c
 SHA512:
-  metadata.gz: 2574999aa80c7d2eb499da7f65e8bc42c3f917331d4c10d014d49f04d75f77e0d0c6d4ada2944eb988bb3f70dc7ebac199200e76bc4be86a723381b4624d23a3
-  data.tar.gz: 28dd428d4fe4d9e52ab381f039772293317d0c667f9580388dd74886dddfaf3fda11b55bd59fcf65e1d6040805bdadeb2ed9118c96e252e7875f2259e7984e90
+  metadata.gz: d11ad18cdfb6c1955e521d8aae653b823f5defcfae4b095ae27f9bc9d1d0c89bca0336ab647c543b4c5d2cb92d2bffcd2c23343266b254aa1331984ac02abae9
+  data.tar.gz: 023da790f7233de7da68520ea85e2e0388e6c840d3950ba004118a754f46d4c2c0c4570c76ca29add86cf97cc0dc40d859094df430627f4cf57316df89df6bf7

data/README.md

@@ -1,41 +1,72 @@
+[![Gem Version](https://img.shields.io/gem/v/allure-report-publisher?color=red)](https://rubygems.org/gems/allure-report-publisher)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/andrcuns/allure-report-publisher?color=blue&label=docker&sort=semver)](https://hub.docker.com/r/andrcuns/allure-report-publisher)
+![Workflow status](https://github.com/andrcuns/allure-report-publisher/workflows/Test/badge.svg)
+[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](http://allure-reports-andrcuns.s3.amazonaws.com/allure-report-publisher/refs/heads/main/index.html)
 [![Maintainability](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/maintainability)](https://codeclimate.com/github/andrcuns/allure-report-publisher/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/210eaa4f74588fb08313/test_coverage)](https://codeclimate.com/github/andrcuns/allure-report-publisher/test_coverage)
 
-# allure-report-uploader
+# allure-report-publisher
 
 Upload your report to a file storage of your choice.
 
+![Demo](demo.gif)
+
 ## Installation
 
-```bash
+### Rubygems
+
+```shell
 gem install allure-report-uploader
 ```
 
+### Docker
+
+```shell
+docker pull andrcuns/allure-report-publisher:latest
+```
+
 ## Usage
 
-### AWS S3
+allure-report-publisher will automatically detect if used in CI environment and add relevant executor info and history
+
+- `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 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:
-  --result-files-glob=VALUE        # Allure results files glob. Required: true
+  --results-glob=VALUE             # Allure results files glob. Required: true
   --bucket=VALUE                   # Bucket name. Required: true
-  --project=VALUE                  # Project name for multiple reports inside single bucket. Required: false
+  --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 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket
+  allure-report-publisher upload s3 --results-glob='path/to/allure-result/**/*' --bucket=my-bucket
+  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.
@@ -44,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at <https://github.com/andrcuns/allure-report-uploader>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/allure-report-uploader/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/andrcuns/allure-report-publisher>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -52,4 +83,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Allure::Report::Uploader project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/allure-report-uploader/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the allure-report-publisher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).

data/lib/allure_report_publisher.rb

@@ -4,7 +4,7 @@ require "require_all"
 require "parallel"
 require "dry/cli"
 
-require_rel "allure_report_publisher/helpers"
+require_rel "allure_report_publisher/lib/helpers/*.rb"
 require_rel "allure_report_publisher/**/*.rb"
 
 module Publisher
@@ -14,9 +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") { Publisher::Helpers.validate_allure_cli_present }

data/lib/allure_report_publisher/commands/upload.rb

@@ -0,0 +1,90 @@
+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)
+
+        uploader = uploaders(args[:type]).new(**args.slice(:results_glob, :bucket, :prefix, :copy_latest, :update_pr))
+
+        log("Generating allure report")
+        Spinner.spin("generating") { uploader.generate_report }
+
+        log("Uploading allure report to #{args[:type]}")
+        Spinner.spin("uploading") { uploader.upload }
+        uploader.report_urls.each { |k, v| log("#{k}: #{v}", :green) }
+        return unless args[:update_pr] && uploader.pr?
+
+        log("Updating pull request description")
+        Spinner.spin("updating", exit_on_error: false) { uploader.add_url_to_pr }
+      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/{helpers.rb → lib/helpers/helpers.rb}

@@ -1,18 +1,37 @@
-require "tty-spinner"
 require "pastel"
 require "open3"
 
 module Publisher
-  # General helpers
+  # Helpers
   #
   module Helpers
+    # Global instance of pastel
+    #
+    # @param [Boolean] force_color
+    # @return [Pastel]
+    def self.pastel(force_color: nil)
+      @pastel ||= Pastel.new(enabled: force_color)
+    end
+
+    # Check allure cli is installed and executable
+    #
+    # @return [void]
+    def self.validate_allure_cli_present
+      _out, status = Open3.capture2("which allure")
+      return if status.success?
+
+      Helpers.error(
+        "Allure cli is missing! See https://docs.qameta.io/allure/#_installing_a_commandline on how to install it!"
+      )
+    end
+
     # Colorize string
     #
     # @param [String] message
     # @param [Symbol] color
     # @return [String]
     def colorize(message, color)
-      Pastel.new.decorate(message, color)
+      Helpers.pastel.decorate(message, color)
     end
 
     # Log message to stdout
@@ -29,7 +48,7 @@ module Publisher
     # @param [String] message
     # @return [void]
     def error(message)
-      puts colorize(message, :red)
+      warn colorize(message, :red)
       exit(1)
     end
 
@@ -41,27 +60,6 @@ module Publisher
       File.join(args).to_s
     end
 
-    # Execute code inside spinner
-    #
-    # @param [String] message
-    # @param [Boolean] auto_debrief
-    # @param [String] done_message
-    # @return [Boolean]
-    def spin(message, done_message: "done")
-      spinner = TTY::Spinner.new(
-        "[:spinner] #{message} ...",
-        format: :dots,
-        success_mark: colorize(TTY::Spinner::TICK, :green),
-        error_mark: colorize(TTY::Spinner::CROSS, :red)
-      )
-      spinner.auto_spin
-      yield
-      spinner.success(done_message)
-    rescue StandardError => e
-      spinner.error(colorize(e.message, :red))
-      exit(1)
-    end
-
     # Execute shell command
     #
     # @param [String] command
@@ -72,5 +70,7 @@ module Publisher
 
       out
     end
+
+    module_function :colorize, :log, :error, :path, :execute_shell
   end
 end

data/lib/allure_report_publisher/lib/helpers/spinner.rb

@@ -0,0 +1,109 @@
+require "tty-spinner"
+
+module Publisher
+  # Helpers
+  #
+  module Helpers
+    # Spinner helper class
+    #
+    class Spinner
+      include Helpers
+
+      def initialize(spinner_message, exit_on_error: true)
+        @spinner_message = spinner_message
+        @exit_on_error = exit_on_error
+      end
+
+      # Run code block inside spinner
+      #
+      # @param [String] spinner_message
+      # @param [String] done_message
+      # @param [Boolean] exit_on_error
+      # @param [Proc] &block
+      # @return [void]
+      def self.spin(spinner_message, done_message: "done", exit_on_error: true, &block)
+        new(spinner_message, exit_on_error: exit_on_error).spin(done_message, &block)
+      end
+
+      # Run code block inside spinner
+      #
+      # @param [String] done_message
+      # @return [Boolean]
+      def spin(done_message = "done")
+        spinner.auto_spin
+        yield
+        spinner_success(done_message)
+      rescue StandardError => e
+        spinner_error(e.message)
+        exit(1) if exit_on_error
+      end
+    end
+
+    private
+
+    attr_reader :spinner_message, :exit_on_error
+
+    # Error message color
+    #
+    # @return [Symbol]
+    def error_color
+      @error_color ||= exit_on_error ? :red : :yellow
+    end
+
+    # Success mark
+    #
+    # @return [String]
+    def success_mark
+      @success_mark ||= colorize(TTY::Spinner::TICK, :green)
+    end
+
+    # Error mark
+    #
+    # @return [String]
+    def error_mark
+      colorize(TTY::Spinner::CROSS, error_color)
+    end
+
+    # Spinner instance
+    #
+    # @return [TTY::Spinner]
+    def spinner
+      @spinner ||= TTY::Spinner.new(
+        "[:spinner] #{spinner_message} ...",
+        format: :dots,
+        success_mark: success_mark,
+        error_mark: error_mark
+      )
+    end
+
+    # Check tty
+    #
+    # @return [Boolean]
+    def tty?
+      spinner.send(:tty?)
+    end
+
+    # Return spinner success
+    #
+    # @param [String] done_message
+    # @return [void]
+    def spinner_success(done_message)
+      return spinner.success(done_message) if tty?
+
+      spinner.stop
+      puts("[#{success_mark}] #{spinner_message} ... #{done_message}")
+    end
+
+    # Return spinner error
+    #
+    # @param [String] error_message
+    # @return [void]
+    def spinner_error(error_message)
+      colored_message = colorize(error_message, error_color)
+      return spinner.error(colored_message) if tty?
+
+      spinner.stop
+      puts("[#{error_mark}] #{spinner_message} ... #{colored_message}")
+    end
+  end
+end

data/lib/allure_report_publisher/lib/providers/_provider.rb

@@ -0,0 +1,111 @@
+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 Provider
+      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
+
+      # :nocov:
+
+      # Pull request run
+      #
+      # @return [Boolean]
+      def pr?
+        raise("Not implemented!")
+      end
+
+      private
+
+      attr_reader :results_path, :report_url
+
+      # Get executor info
+      #
+      # @return [Hash]
+      def executor_info
+        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