allure-framework/allure-ruby

View on GitHub
allure-ruby-commons/lib/allure_ruby_commons/config.rb

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
# frozen_string_literal: true

require "logger"
require "singleton"
require "rspec/expectations"

module Allure
  # Allure configuration class
  class Config
    include Singleton

    # @return [Array<String>] valid log levels
    LOGLEVELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze

    attr_writer :environment, :logger, :failure_exception

    attr_accessor :results_directory,
                  :logging_level,
                  :link_tms_pattern,
                  :link_issue_pattern,
                  :clean_results_directory,
                  :environment_properties,
                  :categories

    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

    # Exception class that corresponds to test failure
    #
    # @return [Class]
    def failure_exception
      @failure_exception ||= RSpec::Expectations::ExpectationNotMetError
    end
  end
end