allure-ruby-commons 2.13.5.rc.1 → 2.13.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5e32590e85ab38aeb176662bbc9347d4db8f403b1a79faff049d54cc42ef148
-  data.tar.gz: a9fac0c1035c7a7e17aa4f08f07f461cf08c6d4dad69f10a935b08d0bb1393c1
+  metadata.gz: 2dde5d93b183282927b03e256e2d9cbe933fd234aa9230545b7d91f074111a20
+  data.tar.gz: 8c05594912decb62f1fc9cc52ebdc85ff9a506c6bd1cbb8cb0a71f7d54102dca
 SHA512:
-  metadata.gz: 9f101580f643b021d6854a9eb21e5aad0ff0d52a379b6dde1777390a50274bc9a513f51c0546729f3500f0d82759e6704fb25176d980e16db73064da79cb8131
-  data.tar.gz: d7acaf42f7f33cc2b7dd6fd81d99a40055603abe06cd1df1136e1472c0de6e2c18824f0b26e520e1ddf7a76be606940dc7de737dcc14a2131a829eccfd5e8c04
+  metadata.gz: f8feed62b8a1f8c1182566623ac01e35356f6ce43dc86479b76175ae0cee0480517df3f5bc349a624a8ae4769acc1e72e10ccde649fc204debe508dd8b104783
+  data.tar.gz: f58060aa2b39d17b5a28b7ae222c049d96d734a64ea238d27a2fa536fd4010015fe11c3abbd43cb6ce28ec1b7548dffa245dc7c75f1fdf622c1e0cb04a24551c

data/README.md

@@ -11,7 +11,7 @@ you can just create the report of any other kind using the basic Allure terms.
 Add the dependency to your Gemfile
 
 ```ruby
- gem 'allure-ruby-commons'
+ gem "allure-ruby-commons"
 ```
 
 ## Configuration
@@ -19,13 +19,13 @@ Add the dependency to your Gemfile
 Following configuration options are supported:
 
 ```ruby
-    Allure.configure do |c|
-      c.results_directory = "/whatever/you/like"
-      c.clean_results_directory = true
-      c.logging_level = Logger::INFO
+    Allure.configure do |config|
+      config.results_directory = "/whatever/you/like"
+      config.clean_results_directory = true
+      config.logging_level = Logger::INFO
       # these are used for creating links to bugs or test cases where {} is replaced with keys of relevant items
-      c.link_tms_pattern = "http://www.jira.com/browse/{}"
-      c.link_issue_pattern = "http://www.jira.com/browse/{}"
+      config.link_tms_pattern = "http://www.jira.com/browse/{}"
+      config.link_issue_pattern = "http://www.jira.com/browse/{}"
     end
 ```
 
@@ -35,6 +35,10 @@ Getting the configuration object:
 Allure.configuration
 ```
 
+### Log level
+
+Log level can be also configured via environment variable `ALLURE_LOG_LEVEL` which accepts one of the following values: `DEBUG INFO WARN ERROR FATAL UNKNOWN`.
+
 ## Allure lifecycle
 
 Reports are built using API defined in AllureLifecycle class and using allure specific entities defined in models.

data/lib/allure-ruby-commons.rb

@@ -9,30 +9,30 @@ require_rel "allure_ruby_commons/**/*rb"
 module Allure
   class << self
     # Get thread specific allure lifecycle object
-    # @return [Allure::AllureLifecycle]
+    # @return [AllureLifecycle]
     def lifecycle
       Thread.current[:lifecycle] ||= AllureLifecycle.new
     end
 
     # Set lifecycle object
-    # @param [Allure::AllureLifecycle] lifecycle
+    # @param [AllureLifecycle] lifecycle
     # @return [void]
     def lifecycle=(lifecycle)
       Thread.current[:lifecycle] = lifecycle
     end
 
     # Get allure configuration
-    # @return [Allure::Config]
+    # @return [Config]
     def configuration
-      Config
+      Config.instance
     end
 
     # Set allure configuration
-    # @yieldparam [Allure::Config]
+    # @yieldparam [Config]
     # @yieldreturn [void]
     # @return [void]
     def configure
-      yield(Config)
+      yield(configuration)
     end
 
     # Add epic to current test case
@@ -131,7 +131,7 @@ module Allure
     # Add attachment to current test case or step
     # @param [String] name Attachment name
     # @param [File, String] source File or string to save as attachment
-    # @param [String] type attachment type defined in {Allure::ContentType} or any other valid mime type
+    # @param [String] type attachment type defined in {ContentType} or any other valid mime type
     # @param [Boolean] test_case add attachment to current test case instead of test step
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)
@@ -146,7 +146,7 @@ module Allure
     end
 
     # Add categories info
-    # @param [File, Array<Allure::Category>] categories
+    # @param [File, Array<Category>] categories
     # @return [void]
     def add_categories(categories)
       lifecycle.write_categories(categories)
@@ -154,7 +154,7 @@ module Allure
 
     # Add step with provided name and optional status to current test step, fixture or test case
     # @param [String] name
-    # @param [Symbol] status <Allure::Status>, <Allure::Status::PASSED> by default
+    # @param [Symbol] status {Status}, {Status::PASSED} by default
     # @return [void]
     def step(name:, status: nil)
       lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -11,7 +11,7 @@ module Allure
     def initialize
       @test_context = []
       @step_context = []
-      @logger = Logger.new(STDOUT, level: Config.logging_level)
+      @logger = Logger.new(STDOUT, level: Config.instance.logging_level)
       @file_writer = FileWriter.new
     end
 
@@ -22,6 +22,8 @@ module Allure
     # @return [Allure::TestResultContainer]
     def start_test_container(test_result_container)
       test_result_container.tap do |container|
+        logger.debug { "Starting test container: #{container.name}" }
+
         container.start = ResultUtils.timestamp
         @test_context.push(container)
       end
@@ -36,7 +38,7 @@ module Allure
     # @return [void]
     def update_test_container
       unless current_test_result_container
-        return logger.error("Could not update test container, no container is running.")
+        return logger.error { "Could not update test container, no container is running." }
       end
 
       yield(current_test_result_container)
@@ -46,10 +48,11 @@ module Allure
     # @return [void]
     def stop_test_container
       unless current_test_result_container
-        return logger.error("Could not stop test container, no container is running.")
+        return logger.error { "Could not stop test container, no container is running." }
       end
 
       current_test_result_container.tap do |container|
+        logger.debug { "Stopping container: #{container.name}" }
         container.stop = ResultUtils.timestamp
         file_writer.write_test_result_container(container)
         clear_last_test_container
@@ -62,9 +65,10 @@ module Allure
     def start_test_case(test_result)
       clear_step_context
       unless current_test_result_container
-        return logger.error("Could not start test case, test container is not started")
+        return logger.error { "Could not start test case, test container is not started" }
       end
 
+      logger.debug("Starting test case: #{test_result.name}")
       test_result.start = ResultUtils.timestamp
       test_result.stage = Stage::RUNNING
       test_result.labels.push(ResultUtils.thread_label, ResultUtils.host_label, ResultUtils.language_label)
@@ -80,7 +84,7 @@ module Allure
     # @yieldreturn [void]
     # @return [void]
     def update_test_case
-      return logger.error("Could not update test case, no test case running") unless @current_test_case
+      return logger.error { "Could not update test case, no test case running" } unless @current_test_case
 
       yield(@current_test_case)
     end
@@ -88,8 +92,9 @@ module Allure
     # Stop current test case and write result
     # @return [void]
     def stop_test_case
-      return logger.error("Could not stop test case, no test case is running") unless @current_test_case
+      return logger.error { "Could not stop test case, no test case is running" } unless @current_test_case
 
+      logger.debug { "Stopping test case: #{@current_test_case.name}" }
       @current_test_case.stop = ResultUtils.timestamp
       @current_test_case.stage = Stage::FINISHED
       file_writer.write_test_result(@current_test_case)
@@ -101,8 +106,9 @@ module Allure
     # @param [Allure::StepResult] step_result
     # @return [Allure::StepResult]
     def start_test_step(step_result)
-      return logger.error("Could not start test step, no test case is running") unless @current_test_case
+      return logger.error { "Could not start test step, no test case is running" } unless @current_test_case
 
+      logger.debug { "Starting test step: #{step_result.name}" }
       step_result.start = ResultUtils.timestamp
       step_result.stage = Stage::RUNNING
       add_test_step(step_result)
@@ -117,7 +123,7 @@ module Allure
     # @yieldreturn [void]
     # @return [void]
     def update_test_step
-      return logger.error("Could not update test step, no step is running") unless current_test_step
+      return logger.error { "Could not update test step, no step is running" } unless current_test_step
 
       yield(current_test_step)
     end
@@ -125,8 +131,9 @@ module Allure
     # Stop current test step
     # @return [void]
     def stop_test_step
-      return logger.error("Could not stop test step, no step is running") unless current_test_step
+      return logger.error { "Could not stop test step, no step is running" } unless current_test_step
 
+      logger.debug { "Stoping test step: #{current_test_step.stop}" }
       current_test_step.stop = ResultUtils.timestamp
       current_test_step.stage = Stage::FINISHED
       clear_last_test_step
@@ -160,6 +167,7 @@ module Allure
         return false
       end
 
+      logger.debug { "Starting fixture: #{fixture_result.name}" }
       fixture_result.start = ResultUtils.timestamp
       fixture_result.stage = Stage::RUNNING
     end
@@ -172,7 +180,7 @@ module Allure
     # @yieldreturn [void]
     # @return [void]
     def update_fixture
-      return logger.error("Could not update fixture, fixture is not started") unless @current_fixture
+      return logger.error { "Could not update fixture, fixture is not started" } unless @current_fixture
 
       yield(@current_fixture)
     end
@@ -180,8 +188,9 @@ module Allure
     # Stop current test fixture
     # @return [void]
     def stop_fixture
-      return logger.error("Could not stop fixture, fixture is not started") unless @current_fixture
+      return logger.error { "Could not stop fixture, fixture is not started" } unless @current_fixture
 
+      logger.debug { "Stopping fixture: #{@current_fixture.name}" }
       @current_fixture.stop = ResultUtils.timestamp
       @current_fixture.stage = Stage::FINISHED
       clear_current_fixture
@@ -196,12 +205,13 @@ module Allure
     # @return [void]
     def add_attachment(name:, source:, type:, test_case: false)
       attachment = ResultUtils.prepare_attachment(name, type) || begin
-        return logger.error("Can't add attachment, unrecognized mime type: #{type}")
+        return logger.error { "Can't add attachment, unrecognized mime type: #{type}" }
       end
       executable_item = (test_case && @current_test_case) || current_executable
       executable_item&.attachments&.push(attachment) || begin
-        return logger.error("Can't add attachment, no test, step or fixture is running")
+        return logger.error { "Can't add attachment, no test, step or fixture is running" }
       end
+      logger.debug { "Adding attachment '#{name}' to '#{executable_item.name}'" }
       write_attachment(source, attachment)
     end
 
@@ -218,7 +228,7 @@ module Allure
     # @return [void]
     def clean_results_dir
       Allure.configuration.tap do |c|
-        FileUtils.rm_f(Dir.glob("#{c.results_directory}/*")) if c.clean_results_directory
+        FileUtils.rm_f(Dir.glob("#{c.results_directory}/**/*")) if c.clean_results_directory
       end
     end
 

data/lib/allure_ruby_commons/config.rb

@@ -1,26 +1,21 @@
 # frozen_string_literal: true
 
 require "logger"
+require "singleton"
 
 module Allure
   # Allure configuration class
   class Config
-    # @return [String] default allure results directory
-    DEFAULT_RESULTS_DIRECTORY = "reports/allure-results"
-    # @return [String] default loggin level
-    DEFAULT_LOGGING_LEVEL = Logger::INFO
+    include Singleton
 
-    class << self
-      attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
-      attr_writer :results_directory, :logging_level
+    # @return [Array<String>] valid log levels
+    LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
 
-      def results_directory
-        @results_directory || DEFAULT_RESULTS_DIRECTORY
-      end
-
-      def logging_level
-        @logging_level || DEFAULT_LOGGING_LEVEL
-      end
+    def initialize
+      @results_directory = "reports/allure-results"
+      @logging_level = LOGLEVELS.index(ENV.fetch("ALLURE_LOG_LEVEL", "INFO")) || Logger::INFO
     end
+
+    attr_accessor :results_directory, :logging_level, :link_tms_pattern, :link_issue_pattern, :clean_results_directory
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -18,14 +18,17 @@ module Allure
     # @param [Allure::TestResult] test_result
     # @return [void]
     def write_test_result(test_result)
-      write("#{test_result.uuid}#{TEST_RESULT_SUFFIX}", test_result.to_json)
+      write("#{test_result.uuid}#{TEST_RESULT_SUFFIX}", JSON.generate(test_result, max_nesting: false))
     end
 
     # Write test result container
     # @param [Allure::TestResultContainer] test_container_result
     # @return [void]
     def write_test_result_container(test_container_result)
-      write("#{test_container_result.uuid}#{TEST_RESULT_CONTAINER_SUFFIX}", test_container_result.to_json)
+      write(
+        "#{test_container_result.uuid}#{TEST_RESULT_CONTAINER_SUFFIX}",
+        JSON.generate(test_container_result, max_nesting: false),
+      )
     end
 
     # Write allure attachment file
@@ -59,7 +62,7 @@ module Allure
     private
 
     def output_dir
-      @output_dir ||= FileUtils.mkpath(Allure::Config.results_directory).first
+      @output_dir ||= FileUtils.mkpath(Config.instance.results_directory).first
     end
 
     def write(name, source)

data/lib/allure_ruby_commons/model/attachment.rb

@@ -9,6 +9,8 @@ module Allure
     # @param [String] type attachment type, {Allure::ContentType}
     # @param [String] source attachment file name
     def initialize(name:, type:, source:)
+      super()
+
       @name = name
       @type = type
       @source = source

data/lib/allure_ruby_commons/model/category.rb

@@ -10,6 +10,8 @@ module Allure
     # @param [String, Regexp] message_regex
     # @param [String, Regexp] trace_regex
     def initialize(name:, matched_statuses: nil, message_regex: nil, trace_regex: nil)
+      super()
+
       @name = name
       @matched_statuses = matched_statuses
       @message_regex = message_regex

data/lib/allure_ruby_commons/model/executable_item.rb

@@ -16,6 +16,8 @@ module Allure
     # @option options [Array<Allure::Attachment>] :attachments ([])
     # @option options [Array<Allure::Parameter>] :parameters ([])
     def initialize(**options)
+      super()
+
       @name = options[:name]
       @description = options[:description]
       @description_html = options[:description_html]

data/lib/allure_ruby_commons/model/jsonable.rb

@@ -6,9 +6,9 @@ module Allure
   # General jsonable object implementation
   class JSONable
     # Return object has represantation
-    # @param [Hash] _options
+    # @param [Array<Object>] _options
     # @return [Hash]
-    def as_json(_options = {})
+    def as_json(*_options)
       instance_variables.each_with_object({}) do |var, map|
         key = camelcase(var.to_s.delete_prefix("@"))
         value = instance_variable_get(var)
@@ -20,7 +20,7 @@ module Allure
     # @param [Array<Object>] options
     # @return [String]
     def to_json(*options)
-      as_json(*options).to_json(*options)
+      as_json.to_json(*options)
     end
 
     # Object comparator

data/lib/allure_ruby_commons/model/label.rb

@@ -6,6 +6,8 @@ module Allure
   # Allure model label object
   class Label < JSONable
     def initialize(name, value)
+      super()
+
       @name = name
       @value = value
     end

data/lib/allure_ruby_commons/model/link.rb

@@ -6,6 +6,8 @@ module Allure
   # Allure model link object
   class Link < JSONable
     def initialize(type, name, url)
+      super()
+
       @type = type
       @name = name
       @url = url

data/lib/allure_ruby_commons/model/parameter.rb

@@ -6,6 +6,8 @@ module Allure
   # Allure model parameter object
   class Parameter < JSONable
     def initialize(name, value)
+      super()
+
       @name = name
       @value = value
     end

data/lib/allure_ruby_commons/model/status_details.rb

@@ -9,6 +9,8 @@ module Allure
     # @param [String] message
     # @param [String] trace
     def initialize(known: false, muted: false, flaky: false, message: nil, trace: nil)
+      super()
+
       @known = known
       @muted = muted
       @flaky = flaky

data/lib/allure_ruby_commons/model/test_result_container.rb

@@ -6,6 +6,8 @@ module Allure
   # Allure model step result container
   class TestResultContainer < JSONable
     def initialize(uuid: UUID.generate, name: "Unnamed")
+      super()
+
       @uuid = uuid
       @name = name
       @children = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.13.5.rc.1
+  version: 2.13.6.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -126,9 +126,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: