allure-ruby-commons 2.13.6.3 → 2.13.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6782a168ec07eb3daccfcb0513a9e40bd7da0db4ef59894d9b2ae5c2d299ae2
-  data.tar.gz: 843b87b5733e14c8bbe2a4af21618c47e567d5c351755a22aa07c2ab5470a8a2
+  metadata.gz: e7dae51d906f8c03cbac0b9f14ffabccf8a1ce9fdb0c70b9e27fb3793f34acb7
+  data.tar.gz: 104d5f939e1fdad7417206d2bdb96e7c3b301a74cc7b63073c9d39ddcd7525db
 SHA512:
-  metadata.gz: e6ed4a935fcd9de7bcadac3186f5c1f3f31d58fa3337a6c161496ec19104493368aaf7aa9a47d96062c50c2c65542397adc2fd00137564b8a858c13e26d3d001
-  data.tar.gz: 34d541038f9e832cb7d012663676b8c08d20dc23cf1c0721cd848e20cb37350549a3dd12afa0c4969d004ea4ead82e7a3885d1f43ff9617ef6bba109b4e9bd6c
+  metadata.gz: dc66fddcc805f1a645bd46ec35c518bac76bc6bdbc4ce0612f3edd0acea2173b7d58771bd03ba1bc478cd9af7172c33a1ff3c9c6efe9b99a599297b9031d3f72
+  data.tar.gz: '00830082315dd4ed519da75c1fe12ef565ed1d79080b8e21be17fa8945dce733c26982131cac8463e6e34f898a1918dc27abc47d0b0878321c4c4325e4e615b9'

data/README.md

@@ -54,6 +54,23 @@ Allure.add_attachment(name: "attachment", source: "/path/to/test.txt", type: All
 Allure.add_link(name: "Custom Url", url: "http://www.github.com")
 ```
 
+## Steps
+
+It is possible to mark method definitions to be automatically added to report as steps. The class just needs to extend `AllureStepAnnotation`
+and `step` method needs to be used before the method definition.
+
+```ruby
+class TestHelper
+  extend AllureStepAnnotation
+
+  step("Singleton step")
+  def self.class_method; end
+
+  step("Standard step")
+  def standard_method; end
+end
+```
+
 ## Testing
 
 Install dependencies:

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
@@ -161,15 +162,17 @@ module Allure
       lifecycle.stop_test_step
     end
 
-    # Run passed block as step with given name
+    # Run passed block as step with given name and return result of yield
     # @param [String] name
     # @yield [] step block
-    # @return [void]
+    # @return [Object]
     def run_step(name)
       lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
-      yield
+      result = yield
       lifecycle.update_test_step { |step| step.status = Status::PASSED }
-    rescue => e
+
+      result
+    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
 
@@ -204,13 +204,13 @@ 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

data/lib/allure_ruby_commons/config.rb

@@ -10,12 +10,41 @@ module Allure
 
     # @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"
+
+    attr_accessor :results_directory, :logging_level, :link_tms_pattern, :link_issue_pattern, :clean_results_directory
 
     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
+    # 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
+        Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
+      end
+    rescue Oj::ParseError
+      nil
+    end
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -18,17 +18,14 @@ module Allure
     # @param [Allure::TestResult] test_result
     # @return [void]
     def write_test_result(test_result)
-      write("#{test_result.uuid}#{TEST_RESULT_SUFFIX}", JSON.generate(test_result, max_nesting: false))
+      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}",
-        JSON.generate(test_container_result, max_nesting: false),
-      )
+      write("#{test_container_result.uuid}#{TEST_RESULT_CONTAINER_SUFFIX}", Oj.dump(test_container_result))
     end
 
     # Write allure attachment file
@@ -55,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 [Array<Object>] _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.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

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

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

data/lib/allure_ruby_commons/model/label.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model label object
   class Label < JSONable

data/lib/allure_ruby_commons/model/link.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model link object
   class Link < JSONable

data/lib/allure_ruby_commons/model/parameter.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model parameter object
   class Parameter < JSONable

data/lib/allure_ruby_commons/model/test_result_container.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "jsonable"
-
 module Allure
   # Allure model step result container
   class TestResultContainer < JSONable

data/lib/allure_ruby_commons/step_annotation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Adds support for annotating methods as allure steps
+#
+module AllureStepAnnotation
+  # Mark method definition as allure step
+  #
+  # @param [String] step_name
+  # @return [void]
+  def step(step_name = "")
+    @allure_step = step_name
+  end
+
+  private
+
+  def singleton_method_added(method_name)
+    return super unless @allure_step
+
+    original_method = singleton_method(method_name)
+    step_name = @allure_step.empty? ? method_name.to_s : @allure_step
+    @allure_step = nil
+
+    define_singleton_method(method_name) do |*args, &block|
+      Allure.run_step(step_name) { original_method.call(*args, &block) }
+    end
+  end
+
+  def method_added(method_name)
+    return super unless @allure_step
+
+    original_method = instance_method(method_name)
+    step_name = @allure_step.empty? ? method_name.to_s : @allure_step
+    @allure_step = nil
+
+    define_method(method_name) do |*args, &block|
+      Allure.run_step(step_name) { original_method.bind(self).call(*args, &block) }
+    end
+  end
+end

metadata

@@ -1,36 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.13.6.3
+  version: 2.13.8.2
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2021-02-16 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
@@ -106,6 +118,7 @@ files:
 - lib/allure_ruby_commons/model/test_result.rb
 - lib/allure_ruby_commons/model/test_result_container.rb
 - lib/allure_ruby_commons/result_utils.rb
+- lib/allure_ruby_commons/step_annotation.rb
 homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
@@ -130,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Common library for allure results generation