allure-ruby-commons 2.13.6 → 2.13.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12cb6b2b1132dd43b17becb6b9a32c47cb9aa44a3be793dc09f083d7e5784370
-  data.tar.gz: a34abfd6a9dff13b8b6b1d571b33f348549c59848579220c4a8add6d5317004c
+  metadata.gz: 53156094ed2444485eb90b07d2f162d1b010a5c07ff57dae0bcc5ad631116a77
+  data.tar.gz: 0520275651cc3e900886d71a605906e6725dd3a34a5d47cde2672332662d39eb
 SHA512:
-  metadata.gz: 1d6bf42ce012302f708869666f94ea4a8a408dc2c17f4989e2b469b3a100458a36226d5b9790ba497b4b69c87306ee437f6825187255f1c00dc9d1a579e5d322
-  data.tar.gz: f15cadf664ae40f2152a86f541bd2a3ef68de4bc60bc72908b04ace4a90753088a6342a3eb63846a95a38b5e311c573223fe5d901fc29c78b2f4cd76f5958ddc
+  metadata.gz: 9c5f0dfb4cb84c3881f90bd684ef103d86c807a84e03d68b0c9dc3f2d444175cf355a15982b6be2cdb60d69c011acbb9cb472c2c462cc847c11a1d6acabce592
+  data.tar.gz: 70fa07d3238b13287733eb165b62dded9330b242dbadd57a2d4099843087515210c535abbbb744a3fabc43d84a33a98ff61d4b5675153ccdf92284a62d25e979

data/README.md

@@ -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

@@ -3,6 +3,7 @@
 
 require "require_all"
 require "uuid"
+
 require_rel "allure_ruby_commons/**/*rb"
 
 # Namespace for classes that handle allure report generation and different framework adaptors
@@ -169,7 +170,7 @@ module Allure
       lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
       yield
       lifecycle.update_test_step { |step| step.status = Status::PASSED }
-    rescue => e
+    rescue StandardError => e
       lifecycle.update_test_step do |step|
         step.status = ResultUtils.status(e)
         step.status_details = ResultUtils.status_details(e)

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -5,13 +5,13 @@ require "forwardable"
 
 module Allure
   # Main class for creating and writing allure results
-  class AllureLifecycle
+  class AllureLifecycle # rubocop:disable Metrics/ClassLength
     extend Forwardable
 
     def initialize
       @test_context = []
       @step_context = []
-      @logger = Logger.new(STDOUT, level: Config.instance.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 { "Stopping test step: #{current_test_step.name}" }
       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
@@ -195,13 +204,14 @@ module Allure
     # @param [Boolean] test_case add attachment to current test case
     # @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}")
-      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")
-      end
+      attachment = ResultUtils.prepare_attachment(name, type)
+      return logger.error { "Can't add attachment, unrecognized mime type: #{type}" } unless attachment
+
+      executable_item = test_case ? @current_test_case : current_executable
+      return logger.error { "Can't add attachment, no test, step or fixture is running" } unless executable_item
+
+      executable_item.attachments.push(attachment)
+      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

@@ -8,20 +8,47 @@ module Allure
   class Config
     include Singleton
 
-    # @return [String] default allure results directory
-    DEFAULT_RESULTS_DIRECTORY = "reports/allure-results"
-    # @return [String] default loggin level
-    DEFAULT_LOGGING_LEVEL = Logger::INFO
+    # @return [Array<String>] valid log levels
+    LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
+    # @return [String] test plan path env var name
+    TESTPLAN_PATH = "ALLURE_TESTPLAN_PATH"
+    # @return [String] test plan file name
+    TESTPLAN_JSON = "testplan.json"
 
-    attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
-    attr_writer :results_directory, :logging_level
+    attr_accessor :results_directory, :logging_level, :link_tms_pattern, :link_issue_pattern, :clean_results_directory
 
-    def results_directory
-      @results_directory || DEFAULT_RESULTS_DIRECTORY
+    def initialize
+      @results_directory = "reports/allure-results"
+      @logging_level = LOGLEVELS.index(ENV.fetch("ALLURE_LOG_LEVEL", "INFO")) || Logger::INFO
     end
 
-    def logging_level
-      @logging_level || DEFAULT_LOGGING_LEVEL
+    # Allure id's of executable tests
+    #
+    # @return [Array]
+    def test_ids
+      @test_ids ||= tests&.map { |test| test[:id] }
+    end
+
+    # Test names of executable tests
+    #
+    # @return [Array]
+    def test_names
+      @test_names ||= tests&.map { |test| test[:selector] }
+    end
+
+    private
+
+    # Tests to execute from allure testplan.json
+    #
+    # @return [Array<Hash>]
+    def tests
+      @tests ||= begin
+        return unless ENV[TESTPLAN_PATH]
+
+        Oj.load_file("#{ENV[TESTPLAN_PATH]}/#{TESTPLAN_JSON}", symbol_keys: true)&.fetch(:tests)
+      end
+    rescue Oj::ParseError
+      nil
     end
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -18,14 +18,14 @@ 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}", Oj.dump(test_result))
     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}", Oj.dump(test_container_result))
     end
 
     # Write allure attachment file
@@ -52,7 +52,7 @@ module Allure
       if categories.is_a?(File)
         copy(categories.path, CATEGORIES_FILE)
       else
-        write(CATEGORIES_FILE, categories.to_json)
+        write(CATEGORIES_FILE, Oj.dump(categories))
       end
     end
 

data/lib/allure_ruby_commons/model/{jsonable.rb → 01_jsonable.rb}

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require "json"
+require "oj"
 
 module Allure
   # General jsonable object implementation
   class JSONable
-    # Return object has represantation
-    # @param [Hash] _options
+    Oj.default_options = { mode: :custom, use_to_hash: true, ascii_only: true }
+
+    # Return object hash represantation
     # @return [Hash]
-    def as_json(_options = {})
+    def to_hash
       instance_variables.each_with_object({}) do |var, map|
         key = camelcase(var.to_s.delete_prefix("@"))
         value = instance_variable_get(var)
@@ -16,13 +17,6 @@ module Allure
       end
     end
 
-    # Convert object to json string
-    # @param [Array<Object>] options
-    # @return [String]
-    def to_json(*options)
-      as_json(*options).to_json(*options)
-    end
-
     # Object comparator
     # @param [JSONable] other
     # @return [Booelan]

data/lib/allure_ruby_commons/model/attachment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model attachment object
   class Attachment < JSONable
@@ -9,6 +7,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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Defects category
   class Category < JSONable
@@ -10,6 +8,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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model executable item
   class ExecutableItem < JSONable
@@ -16,6 +14,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/label.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 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,36 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.13.6
+  version: 2.13.7
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: uuid
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -40,44 +46,50 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.10'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: require_all
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: uuid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Utilities allowing to implement allure result generation by other test
   frameworks
 email: andrejs.cunskis@gmail.com
@@ -90,12 +102,12 @@ files:
 - lib/allure_ruby_commons/allure_lifecycle.rb
 - lib/allure_ruby_commons/config.rb
 - lib/allure_ruby_commons/file_writer.rb
+- lib/allure_ruby_commons/model/01_jsonable.rb
 - lib/allure_ruby_commons/model/attachment.rb
 - lib/allure_ruby_commons/model/category.rb
 - lib/allure_ruby_commons/model/content_type.rb
 - lib/allure_ruby_commons/model/executable_item.rb
 - lib/allure_ruby_commons/model/fixture_result.rb
-- lib/allure_ruby_commons/model/jsonable.rb
 - lib/allure_ruby_commons/model/label.rb
 - lib/allure_ruby_commons/model/link.rb
 - lib/allure_ruby_commons/model/parameter.rb
@@ -130,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Common library for allure results generation