allure-ruby-commons 2.13.1 → 2.14.0

data/lib/allure_ruby_commons/config.rb

@@ -1,26 +1,43 @@
 # 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
-
-    class << self
-      attr_accessor :link_tms_pattern, :link_issue_pattern, :clean_results_directory
-      attr_writer :results_directory, :logging_level
-
-      def results_directory
-        @results_directory || DEFAULT_RESULTS_DIRECTORY
-      end
-
-      def logging_level
-        @logging_level || DEFAULT_LOGGING_LEVEL
-      end
+    include Singleton
+
+    # @return [Array<String>] valid log levels
+    LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
+
+    attr_writer :environment, :logger
+
+    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
+
+    # Allure environment
+    #
+    # @return [String]
+    def environment
+      return(@environment) if defined?(@environment)
+
+      @environment ||= ENV["ALLURE_ENVIRONMENT"]
+    end
+
+    # Logger instance
+    #
+    # @return [Logger]
+    def logger
+      @logger ||= Logger.new($stdout, level: logging_level)
     end
   end
 end

data/lib/allure_ruby_commons/file_writer.rb

@@ -9,19 +9,30 @@ module Allure
     TEST_RESULT_CONTAINER_SUFFIX = "-container.json"
     # @return [String] attachment file suffix
     ATTACHMENT_FILE_SUFFIX = "-attachment"
+    # @return [String] environment info file
+    ENVIRONMENT_FILE = "environment.properties"
+    # @return [String] categories definition json
+    CATEGORIES_FILE = "categories.json"
+
+    # File writer instance
+    #
+    # @param [String] results_directory
+    def initialize(results_directory)
+      @results_directory = results_directory
+    end
 
     # Write test result
     # @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
@@ -32,10 +43,32 @@ module Allure
       source.is_a?(File) ? copy(source.path, attachment.source) : write(attachment.source, source)
     end
 
+    # Write allure report environment info
+    # @param [Hash<Symbol, String>] environment
+    # @return [void]
+    def write_environment(environment)
+      environment.reduce("") { |e, (k, v)| e + "#{k}=#{v}\n" }.tap do |env|
+        write(ENVIRONMENT_FILE, env)
+      end
+    end
+
+    # Write categories info
+    # @param [File, Array<Allure::Category>] categories
+    # @return [void]
+    def write_categories(categories)
+      if categories.is_a?(File)
+        copy(categories.path, CATEGORIES_FILE)
+      else
+        write(CATEGORIES_FILE, Oj.dump(categories))
+      end
+    end
+
     private
 
+    attr_reader :results_directory
+
     def output_dir
-      @output_dir ||= FileUtils.mkpath(Allure::Config.results_directory).first
+      @output_dir ||= FileUtils.mkpath(results_directory).first
     end
 
     def write(name, source)

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

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-require "json"
+require "oj"
 
 module Allure
   # General jsonable object implementation
   class JSONable
-    def as_json(_options = {})
+    Oj.default_options = { mode: :custom, use_to_hash: true, ascii_only: true }
+
+    # Return object hash represantation
+    # @return [Hash]
+    def to_hash
       instance_variables.each_with_object({}) do |var, map|
         key = camelcase(var.to_s.delete_prefix("@"))
         value = instance_variable_get(var)
@@ -13,22 +17,26 @@ module Allure
       end
     end
 
-    def to_json(*options)
-      as_json(*options).to_json(*options)
-    end
-
+    # Object comparator
+    # @param [JSONable] other
+    # @return [Booelan]
     def ==(other)
       self.class == other.class && state == other.state
     end
 
     protected
 
+    # Object state
+    # @return [Array]
     def state
       instance_variables.map { |var| instance_variable_get(var) }
     end
 
     private
 
+    # Covert string to camelcase
+    # @param [String] str
+    # @return [String]
     def camelcase(str)
       str = str.gsub(/(?:_+)([a-z])/) { Regexp.last_match(1).upcase }
       str.gsub(/(\A|\s)([A-Z])/) { Regexp.last_match(1) + Regexp.last_match(2).downcase }

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Allure
+  # Defects category
+  class Category < JSONable
+    # @param [String] name
+    # @param [Array<Allure::Status>] matched_statuses
+    # @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
+      @trace_regex = trace_regex
+    end
+  end
+end

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]
@@ -27,9 +27,16 @@ module Allure
       @parameters = options[:parameters] || []
     end
 
-    attr_accessor(
-      :name, :status, :status_details, :stage, :description, :description_html,
-      :steps, :attachments, :parameters, :start, :stop
-    )
+    attr_accessor :name,
+                  :status,
+                  :status_details,
+                  :stage,
+                  :description,
+                  :description_html,
+                  :steps,
+                  :attachments,
+                  :parameters,
+                  :start,
+                  :stop
   end
 end

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.rb

@@ -7,5 +7,6 @@ module Allure
     BROKEN = :broken
     PASSED = :passed
     SKIPPED = :skipped
+    UNKNOWN = :unknown
   end
 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.rb

@@ -5,6 +5,7 @@ module Allure
   class TestResult < ExecutableItem
     # @param [String] uuid
     # @param [String] history_id
+    # @param [String] environment
     # @param [Hash] options
     # @option options [String] :name
     # @option options [String] :full_name
@@ -18,8 +19,10 @@ module Allure
     # @option options [Array<Allure::Link>] :links ([])
     # @option options [Array<Allure::Attachment>] :attachments ([])
     # @option options [Array<Allure::Parameter>] :parameters ([])
-    def initialize(uuid: UUID.generate, history_id: UUID.generate, **options)
+    def initialize(uuid: UUID.generate, history_id: UUID.generate, environment: nil, **options)
       super
+
+      @name = test_name(options[:name], environment)
       @uuid = uuid
       @history_id = history_id
       @full_name = options[:full_name] || "Unnamed"
@@ -27,6 +30,23 @@ module Allure
       @links = options[:links] || []
     end
 
-    attr_accessor :uuid, :history_id, :full_name, :labels, :links
+    attr_accessor :uuid,
+                  :history_id,
+                  :full_name,
+                  :labels,
+                  :links
+
+    private
+
+    # Test name prefixed with allure environment
+    #
+    # @param [String] name
+    # @param [String] environment
+    # @return [String]
+    def test_name(name, environment)
+      return name unless environment
+
+      "#{environment}: #{name}"
+    end
   end
 end

data/lib/allure_ruby_commons/model/test_result_container.rb

@@ -1,10 +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 = []

data/lib/allure_ruby_commons/result_utils.rb

@@ -46,14 +46,26 @@ module Allure
         Label.new(HOST_LABEL_NAME, Socket.gethostname)
       end
 
+      # Language label
+      # @return [Allure::Label]
       def language_label
         Label.new(LANGUAGE_LABEL_NAME, "ruby")
       end
 
+      # Framework label
+      # @param [String] value
+      # @return [Allure::Label]
       def framework_label(value)
         Label.new(FRAMEWORK_LABEL_NAME, value)
       end
 
+      # Epic label
+      # @param [String] value
+      # @return [Allure::Label]
+      def epic_label(value)
+        Label.new(EPIC_LABEL_NAME, value)
+      end
+
       # Feature label
       # @param [String] value
       # @return [Allure::Label]
@@ -61,6 +73,13 @@ module Allure
         Label.new(FEATURE_LABEL_NAME, value)
       end
 
+      # Story label
+      # @param [String] value
+      # @return [Allure::Label]
+      def story_label(value)
+        Label.new(STORY_LABEL_NAME, value)
+      end
+
       # Package label
       # @param [String] value
       # @return [Allure::Label]
@@ -89,13 +108,6 @@ module Allure
         Label.new(SUB_SUITE_LABEL_NAME, value)
       end
 
-      # Story label
-      # @param [String] value
-      # @return [Allure::Label]
-      def story_label(value)
-        Label.new(STORY_LABEL_NAME, value)
-      end
-
       # Test case label
       # @param [String] value
       # @return [Allure::Label]
@@ -119,23 +131,25 @@ module Allure
 
       # TMS link
       # @param [String] value
+      # @param [String] link_pattern
       # @return [Allure::Link]
-      def tms_link(value)
-        Link.new(TMS_LINK_TYPE, value, tms_url(value))
+      def tms_link(value, link_pattern)
+        Link.new(TMS_LINK_TYPE, value, url(value, link_pattern))
       end
 
       # Issue link
       # @param [String] value
+      # @param [String] link_pattern
       # @return [Allure::Link]
-      def issue_link(value)
-        Link.new(ISSUE_LINK_TYPE, value, issue_url(value))
+      def issue_link(value, link_pattern)
+        Link.new(ISSUE_LINK_TYPE, value, url(value, link_pattern))
       end
 
       # Get status based on exception type
       # @param [Exception] exception
       # @return [Symbol]
       def status(exception)
-        expectation_error?(exception) ? Status::FAILED : Status::BROKEN
+        exception.is_a?(RSpec::Expectations::ExpectationNotMetError) ? Status::FAILED : Status::BROKEN
       end
 
       # Get exception status detail
@@ -145,19 +159,20 @@ module Allure
         StatusDetails.new(message: exception&.message, trace: exception&.backtrace&.join("\n"))
       end
 
-      private
-
-      def tms_url(value)
-        Allure.configuration.link_tms_pattern.sub("{}", value)
+      # Allure attachment object
+      # @param [String] name
+      # @param [String] type
+      # @return [Allure::Attachment]
+      def prepare_attachment(name, type)
+        extension = ContentType.to_extension(type) || return
+        file_name = "#{UUID.generate}-attachment.#{extension}"
+        Attachment.new(name: name, source: file_name, type: type)
       end
 
-      def issue_url(value)
-        Allure.configuration.link_issue_pattern.sub("{}", value)
-      end
+      private
 
-      def expectation_error?(exception)
-        exception.instance_of?(RSpec::Expectations::ExpectationNotMetError) ||
-          exception.instance_of?(RSpec::Expectations::MultipleExpectationsNotMetError)
+      def url(value, link_pattern)
+        link_pattern.sub("{}", value)
       end
     end
   end

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

data/lib/allure_ruby_commons/testplan.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Allure
+  class TestPlan
+    # @return [String] test plan path env var name
+    TESTPLAN_PATH = "ALLURE_TESTPLAN_PATH"
+
+    class << self
+      # 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 ||= Oj.load_file(ENV[TESTPLAN_PATH], symbol_keys: true)&.fetch(:tests) if ENV[TESTPLAN_PATH]
+      rescue Oj::ParseError
+        nil
+      end
+    end
+  end
+end