allure-report-publisher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1362930b746c980e6cc2130d5a304c1be870a6e79658df5143bda833035773a8
+  data.tar.gz: e23baf8887d7acee4dd919e0e4b71282c6e462476cf0ddd037a6c82d7248a290
+SHA512:
+  metadata.gz: 2574999aa80c7d2eb499da7f65e8bc42c3f917331d4c10d014d49f04d75f77e0d0c6d4ada2944eb988bb3f70dc7ebac199200e76bc4be86a723381b4624d23a3
+  data.tar.gz: 28dd428d4fe4d9e52ab381f039772293317d0c667f9580388dd74886dddfaf3fda11b55bd59fcf65e1d6040805bdadeb2ed9118c96e252e7875f2259e7984e90

data/README.md

@@ -0,0 +1,55 @@
+[![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
+
+Upload your report to a file storage of your choice.
+
+## Installation
+
+```bash
+gem install allure-report-uploader
+```
+
+## Usage
+
+### AWS S3
+
+```shell
+$ allure-report-publisher upload s3 --help
+Command:
+  allure-report-publisher upload s3
+
+Usage:
+  allure-report-publisher upload s3
+
+Description:
+  Generate and upload allure report
+
+Options:
+  --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
+  --help, -h                       # Print this help
+
+Examples:
+  allure-report-publisher upload s3 --result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket
+```
+
+## 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.
+
+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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/bin/allure-report-publisher

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "allure_report_publisher"
+
+Dry::CLI.new(Publisher::Commands).call

data/lib/allure_report_publisher.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "require_all"
+require "parallel"
+require "dry/cli"
+
+require_rel "allure_report_publisher/helpers"
+require_rel "allure_report_publisher/**/*.rb"
+
+module Publisher
+  # CLI commands
+  #
+  module Commands
+    extend Dry::CLI::Registry
+
+    register "version", Version, aliases: ["-v", "--version"]
+
+    register "upload" do |prefix|
+      prefix.register "s3", UploadS3
+    end
+  end
+end

data/lib/allure_report_publisher/commands/upload_s3.rb

@@ -0,0 +1,41 @@
+module Publisher
+  module Commands
+    # Upload allure report
+    #
+    class UploadS3 < Dry::CLI::Command
+      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"
+
+      example [
+        "--result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket",
+        "--result-files-glob='path/to/allure-result/**/*' --bucket=my-bucket --project=my-project"
+      ]
+
+      def call(**args)
+        validate_args(args)
+
+        Uploaders::S3.new(
+          args[:result_files_glob],
+          args[:bucket],
+          args[:project]
+        ).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/commands/version.rb

@@ -0,0 +1,13 @@
+module Publisher
+  module Commands
+    # Print version number
+    #
+    class Version < Dry::CLI::Command
+      desc "Print version"
+
+      def call(*)
+        puts Publisher::VERSION
+      end
+    end
+  end
+end

data/lib/allure_report_publisher/helpers.rb

@@ -0,0 +1,76 @@
+require "tty-spinner"
+require "pastel"
+require "open3"
+
+module Publisher
+  # General helpers
+  #
+  module Helpers
+    # Colorize string
+    #
+    # @param [String] message
+    # @param [Symbol] color
+    # @return [String]
+    def colorize(message, color)
+      Pastel.new.decorate(message, color)
+    end
+
+    # Log message to stdout
+    #
+    # @param [String] message
+    # @param [String] color
+    # @return [void]
+    def log(message, color = :magenta)
+      puts colorize(message, color)
+    end
+
+    # Print error message and exit
+    #
+    # @param [String] message
+    # @return [void]
+    def error(message)
+      puts colorize(message, :red)
+      exit(1)
+    end
+
+    # Safe join path
+    #
+    # @param [Array<String>] *args
+    # @return [String]
+    def path(*args)
+      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
+    # @return [String] output
+    def execute_shell(command)
+      out, err, status = Open3.capture3(command)
+      raise("Out:\n#{out}\n\nErr:\n#{err}") unless status.success?
+
+      out
+    end
+  end
+end

data/lib/allure_report_publisher/lib/report_generator.rb

@@ -0,0 +1,54 @@
+require "open3"
+
+module Publisher
+  class AllureError < StandardError; end
+
+  class NoAllureResultsError < StandardError; end
+
+  # Allure report generator
+  #
+  class ReportGenerator
+    include Helpers
+
+    def initialize(results_glob, results_dir, report_dir)
+      @results_glob = results_glob
+      @results_dir = results_dir
+      @report_dir = report_dir
+    end
+
+    # Generate allure report
+    #
+    # @return [void]
+    def generate
+      log("\nGenerating allure report")
+      spin("generating report") do
+        aggregate_results
+        generate_report
+      end
+    end
+
+    private
+
+    attr_reader :results_glob, :results_dir, :report_dir
+
+    # Copy all results files to results directory
+    #
+    # @return [void]
+    def aggregate_results
+      results = Dir.glob(results_glob)
+      error("Missing allure results") if results.empty?
+
+      FileUtils.cp(results, results_dir)
+    end
+
+    # Generate allure report
+    #
+    # @return [void]
+    def generate_report
+      out, _err, status = Open3.capture3(
+        "allure generate --clean --output #{report_dir} #{results_dir}"
+      )
+      error(out) unless status.success?
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+module Publisher
+  module Uploaders
+    # Uploader implementation
+    #
+    class Uploader
+      include Helpers
+
+      HISTORY = [
+        "categories-trend.json",
+        "duration-trend.json",
+        "history-trend.json",
+        "history.json",
+        "retry-trend.json"
+      ].freeze
+
+      def initialize(results_glob, bucket, project = nil)
+        @results_glob = results_glob
+        @bucket = bucket
+        @project = project
+      end
+
+      # Execute allure report generation and upload
+      #
+      # @return [void]
+      def execute
+        raise(StandardError, "Not Implemented!")
+      end
+
+      private
+
+      attr_reader :results_glob, :bucket, :project
+
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        raise(StandardError, "Not Implemented!")
+      end
+
+      # Fetch allure report history
+      #
+      # @return [void]
+      def create_history_dir
+        FileUtils.mkdir_p(path(results_dir, "history"))
+      end
+
+      # Report path prefix
+      #
+      # @return [String]
+      def prefix
+        @prefix ||= [project, 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]
+      def results_dir
+        @results_dir ||= Dir.mktmpdir("allure-results")
+      end
+
+      # Allure report directory
+      #
+      # @return [String]
+      def report_dir
+        @report_dir ||= Dir.mktmpdir("allure-report")
+      end
+
+      # Report files
+      #
+      # @return [Array<Pathname>]
+      def report_files
+        @report_files ||= Pathname
+                          .glob("#{report_dir}/**/*")
+                          .reject(&:directory?)
+      end
+
+      # Generate allure report
+      #
+      # @return [void]
+      def generate_report
+        fetch_history if run_id
+
+        ReportGenerator.new(results_glob, results_dir, report_dir).generate
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+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
+      end
+
+      # Report url
+      #
+      # @return [String]
+      def report_url
+        @report_url ||= ["http://#{bucket}.s3.amazonaws.com", prefix, "index.html"].compact.join("/")
+      end
+
+      # Fetch allure history
+      #
+      # @return [void]
+      def fetch_history
+        log("Fetching allure history")
+        spin("fetching history") do
+          create_history_dir
+          HISTORY.each do |file|
+            s3.get_object(
+              response_target: path(results_dir, "history", file),
+              key: key(project, "history", file),
+              bucket: bucket
+            )
+          end
+        end
+      end
+
+      # Upload report to s3
+      #
+      # @return [void]
+      def upload_history_and_report
+        log("\nUploading report to s3")
+        spin("uploading report", done_message: "done. #{report_url}") do
+          upload_history
+          upload_report
+        end
+      end
+
+      # Upload allure history
+      #
+      # @return [void]
+      def upload_history
+        return unless run_id
+
+        upload_to_s3(report_files.select { |file| file.fnmatch?("*/history/*") }, project)
+      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 = 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

data/lib/allure_report_publisher/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: allure-report-publisher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrejs Cunskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-25 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.93.1
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+description: Upload allure reports to different file storage providers
+email:
+- andrejs.cunskis@gmail.com
+executables:
+- allure-report-publisher
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/allure-report-publisher
+- lib/allure_report_publisher.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/report_generator.rb
+- lib/allure_report_publisher/lib/uploaders/_uploader.rb
+- lib/allure_report_publisher/lib/uploaders/s3_uploader.rb
+- lib/allure_report_publisher/version.rb
+homepage: https://github.com/andrcuns/allure-report-uploader
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/andrcuns/allure-report-uploader
+  source_code_uri: https://github.com/andrcuns/allure-report-uploader
+  changelog_uri: https://github.com/andrcuns/allure-report-uploader/releases
+  documentation_uri: https://github.com/andrcuns/allure-report-uploader/blob/master/README.md
+  bug_tracker_uri: https://github.com/andrcuns/allure-report-uploader/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Allure report uploader
+test_files: []