allure-ruby-commons 2.13.6.4 → 2.13.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a51c9949322455ac55cd973f942ba0392f51171fad89f23d0e16cbe16224014b
-  data.tar.gz: 7b4c8ccfca17187f553e9f5192a19fbe23dc84c780b73d057a29da9eed92ed61
+  metadata.gz: 1bc521722448d5d7f665ad0030bde72f700e59b9e03446ae018f5ba6138b7bc3
+  data.tar.gz: 13b5dda45f54667133b4563f14bcecbf53b3d47e4900877779681dc2fe0d6848
 SHA512:
-  metadata.gz: e71a93d78c8efdfd477953644f58a1495fa6baca06592ddd5206c4abfc088d292a8f3a61ae72fe98d4db589144d4c0c8194a18a9e675cbecaeeb98d80265079b
-  data.tar.gz: 6d44b2fed79aa4258cfca49e4f0bc709f2aef144292fa6760191772eae4d4a4b763510f9ded50c8b146df635a44d80bf6725ac059843839f030ecd649553ad2c
+  metadata.gz: af6d41eec7edcb5ed2729afda19583d80cc2a437ccb6c6881b9faccaee2f4cfa578b26eb53422617ad1bf5cb883e76767dbbea15f2d921865d35f320ab803ac3
+  data.tar.gz: 2bd20a058c6fabf324056e8543c56567dc49cade84ed60420e0bf6224dce10dd601ecb6fff274a1727321d452b30c1664dca7d47b3815532d87fa0e99f902b45

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

@@ -64,6 +64,13 @@ module Allure
       label(ResultUtils::SUITE_LABEL_NAME, value)
     end
 
+    # Add tag to current test case
+    # @param [String] value
+    # @return [void]
+    def tag(value)
+      label(ResultUtils::TAG_LABEL_NAME, value)
+    end
+
     # Add label to current test case
     # @param [String] name
     # @param [String] value
@@ -162,14 +169,16 @@ 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 }
+
+      result
     rescue StandardError => e
       lifecycle.update_test_step do |step|
         step.status = ResultUtils.status(e)

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/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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 version: !ruby/object:Gem::Version
-  version: 2.13.6.4
+  version: 2.13.8.3
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: require_all
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +77,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -72,6 +87,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         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
@@ -84,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
@@ -100,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
@@ -124,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