module Allure

add_attachment(name:, source:, type:, test_case: false) click to toggle source

Add attachment to current test case or step @param [String] name Attachment name @param [File, String] source File or string to save as attachment @param [String] type attachment type defined in {ContentType} or any other valid mime type @param [Boolean] test_case add attachment to current test case instead of test step @return [void]

# File lib/allure-ruby-commons.rb, line 160
def add_attachment(name:, source:, type:, test_case: false)
  lifecycle.add_attachment(name: name, source: source, type: type, test_case: test_case)
end

add_categories(categories) click to toggle source

Manually create categories.json file

if this method is called before test run started and
option clean_results_directory is enabled, the file will be deleted

@param [File, Array<Category>] categories @return [void]

# File lib/allure-ruby-commons.rb, line 178
def add_categories(categories)
  lifecycle.write_categories(categories)
end

add_description(description) click to toggle source

Add description to current test case @param [String] description @return [void]

# File lib/allure-ruby-commons.rb, line 102
def add_description(description)
  lifecycle.update_test_case do |test_case|
    test_case.description = description
  end
end

add_environment(environment) click to toggle source

Manually create environment.properties file

if this method is called before test run started and
option clean_results_directory is enabled, the file will be deleted

@param [Hash<Symbol, String>] environment @return [void]

# File lib/allure-ruby-commons.rb, line 169
def add_environment(environment)
  lifecycle.write_environment(environment)
end

add_link(url:, name: nil, type: "custom") click to toggle source

Add link to current test case @param [String ] url @param [String] name @param [String] type type of the link used to display link icon @return [void]

# File lib/allure-ruby-commons.rb, line 148
def add_link(url:, name: nil, type: "custom")
  lifecycle.update_test_case do |test_case|
    test_case.links.push(Link.new(type, name || url, url))
  end
end

configuration() click to toggle source

Get allure configuration @return [Config]

# File lib/allure-ruby-commons.rb, line 28
def configuration
  Config.instance
end

configure() { |configuration| ... } click to toggle source

Set allure configuration @yieldparam [Config] @yieldreturn [void] @return [void]

# File lib/allure-ruby-commons.rb, line 36
def configure
  yield(configuration)
end

description_html(description_html) click to toggle source

Add html description to current test case @param [String] description_html @return [void]

# File lib/allure-ruby-commons.rb, line 111
def description_html(description_html)
  lifecycle.update_test_case do |test_case|
    test_case.description_html = description_html
  end
end

epic(value) click to toggle source

Add epic to current test case @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 43
def epic(value)
  replace_label(ResultUtils::EPIC_LABEL_NAME, value)
end

feature(value) click to toggle source

Add feature to current test case @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 50
def feature(value)
  replace_label(ResultUtils::FEATURE_LABEL_NAME, value)
end

issue(name, url) click to toggle source

Add issue linkt to current test case @param [String] name @param [String] url @return [void]

# File lib/allure-ruby-commons.rb, line 139
def issue(name, url)
  add_link(name: name, url: url, type: ResultUtils::ISSUE_LINK_TYPE)
end

label(name, value) click to toggle source

Add label to current test case @param [String] name @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 79
def label(name, value)
  lifecycle.update_test_case do |test_case|
    test_case.labels.push(Label.new(name, value))
  end
end

lifecycle() click to toggle source

Get thread specific allure lifecycle object @return [AllureLifecycle]

# File lib/allure-ruby-commons.rb, line 22
def lifecycle
  Thread.current[:lifecycle] ||= AllureLifecycle.new
end

parameter(name, value) click to toggle source

Add parameter to current test case @param [String] name @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 121
def parameter(name, value)
  lifecycle.update_test_case do |test_case|
    test_case.parameters.push(Parameter.new(name, value))
  end
end

replace_label(name, value) click to toggle source

Replace label in current test case

@param [String] name @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 90
def replace_label(name, value)
  lifecycle.update_test_case do |test_case|
    present = test_case.labels.detect { |l| l.name == name }
    return label(name, value) unless present

    test_case.labels.map! { |l| l.name == name ? Label.new(name, value) : l }
  end
end

run_step(name) { || ... } click to toggle source

Run passed block as step with given name and return result of yield @param [String] name @yield [] step block @return [Object]

# File lib/allure-ruby-commons.rb, line 195
def run_step(name)
  lifecycle.start_test_step(StepResult.new(name: name, stage: Stage::RUNNING))
  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)
    step.status_details = ResultUtils.status_details(e)
  end
  raise(e)
ensure
  lifecycle.stop_test_step
end

step(name:, status: nil) click to toggle source

Add step with provided name and optional status to current test step, fixture or test case @param [String] name @param [Symbol] status {Status}, {Status::PASSED} by default @return [void]

# File lib/allure-ruby-commons.rb, line 186
def step(name:, status: nil)
  lifecycle.add_test_step(StepResult.new(name: name, status: status || Status::PASSED, stage: Stage::FINISHED))
  lifecycle.stop_test_step
end

story(value) click to toggle source

Add story to current test case @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 57
def story(value)
  replace_label(ResultUtils::STORY_LABEL_NAME, value)
end

suite(value) click to toggle source

Add suite to current test case @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 64
def suite(value)
  replace_label(ResultUtils::SUITE_LABEL_NAME, value)
end

tag(value) click to toggle source

Add tag to current test case @param [String] value @return [void]

# File lib/allure-ruby-commons.rb, line 71
def tag(value)
  label(ResultUtils::TAG_LABEL_NAME, value)
end

tms(name, url) click to toggle source

Add tms link to current test case @param [String] name @param [String] url @return [void]

# File lib/allure-ruby-commons.rb, line 131
def tms(name, url)
  add_link(name: name, url: url, type: ResultUtils::TMS_LINK_TYPE)
end

Public Class Methods

Public Instance Methods