allure-report-publisher 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1362930b746c980e6cc2130d5a304c1be870a6e79658df5143bda833035773a8
-  data.tar.gz: e23baf8887d7acee4dd919e0e4b71282c6e462476cf0ddd037a6c82d7248a290
+  metadata.gz: f7267f00f39421165f5b1fb7c4e975cff6e856d7ff321bf5b90ac7ab629fff6a
+  data.tar.gz: 6189da5c7b8743ee4fb102b01f07e9e419996a249b90a8a43601658f2c1ef6cb
 SHA512:
-  metadata.gz: 2574999aa80c7d2eb499da7f65e8bc42c3f917331d4c10d014d49f04d75f77e0d0c6d4ada2944eb988bb3f70dc7ebac199200e76bc4be86a723381b4624d23a3
-  data.tar.gz: 28dd428d4fe4d9e52ab381f039772293317d0c667f9580388dd74886dddfaf3fda11b55bd59fcf65e1d6040805bdadeb2ed9118c96e252e7875f2259e7984e90
+  metadata.gz: 52e25db16ed4068c4556162fd4bfe917b138f2e814dd2d0bf6a019b8dd462014ba7af39cbc6ebe62f0d547bee4ca5ea0813e0719f138fb4cc0890ee2f501ea33
+  data.tar.gz: 6e1a0903f7923fd2abb0538819f24fce3530827280dd1e568be1dc16942f8bdbdca2c03fe4816e7d3bb00d3b631cfe8a7d4bea0f9af77f3e6c8a9afcfed4ab62

data/README.md

@@ -1,22 +1,37 @@
+[![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)
 [![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
 
+allure-report-publisher will automatically detect if used in CI environment and add relevant executor info and history
+
 ### AWS S3
 
 ```shell
-$ allure-report-publisher upload s3 --help
+$ (allure-report-publisher|docker run --rm andrcuns/allure-report-publisher:latest) upload s3 --help
 Command:
   allure-report-publisher upload s3
 
@@ -27,13 +42,15 @@ Description:
   Generate and upload allure report
 
 Options:
+  --[no-]color                     # Toggle color output
   --result-files-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
   --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 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project/prs
 ```
 
 ## Development
@@ -44,7 +61,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 +69,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
@@ -20,3 +20,5 @@ module Publisher
     end
   end
 end
+
+Publisher::Commands.before("upload s3") { Publisher::Helpers.validate_allure_cli_present }

data/lib/allure_report_publisher/commands/base.rb

@@ -0,0 +1,13 @@
+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

@@ -3,26 +3,28 @@ module Publisher
     # 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 :project, desc: "Project name for multiple reports inside single bucket. Required: false"
+      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"
+        "--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[:project]
+          args[:prefix]
         ).execute
       end
 

data/lib/allure_report_publisher/lib/ci/_base.rb

@@ -0,0 +1,63 @@
+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

@@ -0,0 +1,50 @@
+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/{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
@@ -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/report_generator.rb

@@ -20,8 +20,8 @@ module Publisher
     #
     # @return [void]
     def generate
-      log("\nGenerating allure report")
-      spin("generating report") do
+      log("Generating allure report")
+      Helpers::Spinner.spin("generating report") do
         aggregate_results
         generate_report
       end

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

@@ -13,22 +13,27 @@ module Publisher
         "retry-trend.json"
       ].freeze
 
-      def initialize(results_glob, bucket, project = nil)
+      def initialize(results_glob, bucket, prefix = nil)
         @results_glob = results_glob
         @bucket = bucket
-        @project = project
+        @prefix = prefix
       end
 
+      # :nocov:
+
       # Execute allure report generation and upload
       #
       # @return [void]
       def execute
         raise(StandardError, "Not Implemented!")
       end
+      # :nocov:
 
       private
 
-      attr_reader :results_glob, :bucket, :project
+      attr_reader :results_glob, :bucket, :prefix
+
+      # :nocov:
 
       # Report url
       #
@@ -36,6 +41,46 @@ module Publisher
       def report_url
         raise(StandardError, "Not Implemented!")
       end
+      # :nocov:
+
+      # Get run id
+      #
+      # @return [String]
+      def run_id
+        @run_id ||= CI.provider&.run_id
+      end
+
+      # Get CI provider
+      #
+      # @return [Publisher::CI::Base]
+      def ci_provider
+        return @ci_provider if defined?(@ci_provider)
+
+        @ci_provider = CI.provider&.new(results_dir, report_url)
+      end
+
+      # Add allure history
+      #
+      # @return [void]
+      def add_history
+        log("Adding allure history")
+        Helpers::Spinner.spin("adding history", exit_on_error: false) do
+          create_history_dir
+          yield
+        end
+      end
+
+      # Add CI executor info
+      #
+      # @return [void]
+      def add_executor_info
+        return unless ci_provider
+
+        log("Adding executor info")
+        Helpers::Spinner.spin("adding") do
+          ci_provider.write_executor_info
+        end
+      end
 
       # Fetch allure report history
       #
@@ -47,21 +92,14 @@ module Publisher
       # Report path prefix
       #
       # @return [String]
-      def prefix
-        @prefix ||= [project, run_id].compact.yield_self do |pre|
+      def full_prefix
+        @full_prefix ||= [prefix, run_id].compact.yield_self do |pre|
           break if pre.empty?
 
           pre.join("/")
         end
       end
 
-      # Run ID
-      #
-      # @return [String]
-      def run_id
-        @run_id ||= ENV["RUN_ID"]
-      end
-
       # Aggregated results directory
       #
       # @return [String]
@@ -89,7 +127,8 @@ module Publisher
       #
       # @return [void]
       def generate_report
-        fetch_history if run_id
+        add_history
+        add_executor_info
 
         ReportGenerator.new(results_glob, results_dir, report_dir).generate
       end

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

@@ -16,30 +16,30 @@ module Publisher
       #
       # @return [Aws::S3::Client]
       def s3
-        @s3 ||= Aws::S3::Client.new
+        @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", prefix, "index.html"].compact.join("/")
+        @report_url ||= ["http://#{bucket}.s3.amazonaws.com", full_prefix, "index.html"].compact.join("/")
       end
 
-      # Fetch allure history
+      # Add allure history
       #
       # @return [void]
-      def fetch_history
-        log("Fetching allure history")
-        spin("fetching history") do
-          create_history_dir
+      def add_history
+        super do
           HISTORY.each do |file|
             s3.get_object(
               response_target: path(results_dir, "history", file),
-              key: key(project, "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
 
@@ -47,8 +47,8 @@ module Publisher
       #
       # @return [void]
       def upload_history_and_report
-        log("\nUploading report to s3")
-        spin("uploading report", done_message: "done. #{report_url}") do
+        log("Uploading report to s3")
+        Helpers::Spinner.spin("uploading report", done_message: "done. #{report_url}") do
           upload_history
           upload_report
         end
@@ -58,9 +58,7 @@ module Publisher
       #
       # @return [void]
       def upload_history
-        return unless run_id
-
-        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, project)
+        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, prefix)
       end
 
       def upload_report
@@ -72,7 +70,7 @@ module Publisher
       # @param [Array<Pathname>] files
       # @param [String] key_prefix
       # @return [Array<Hash>]
-      def upload_to_s3(files, key_prefix = prefix)
+      def upload_to_s3(files, key_prefix = full_prefix)
         args = files.map do |file|
           {
             body: File.new(file),

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: allure-report-publisher
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-25 00:00:00.000000000 Z
+date: 2021-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.95.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.95.0
 - !ruby/object:Gem::Dependency
   name: dry-cli
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +111,13 @@ 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/version.rb
-- lib/allure_report_publisher/helpers.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/report_generator.rb
 - lib/allure_report_publisher/lib/uploaders/_uploader.rb
 - lib/allure_report_publisher/lib/uploaders/s3_uploader.rb