class Cucumber::Formatter::Junit

The formatter used for --format junit

Public Class Methods

new(config) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 20
def initialize(config)
  config.on_event :before_test_case, &method(:on_before_test_case)
  config.on_event :after_test_case, &method(:on_after_test_case)
  config.on_event :after_test_step, &method(:on_after_test_step)
  config.on_event :finished_testing, &method(:on_finished_testing)
  @reportdir = ensure_dir(config.out_stream, "junit")
  @config = config
  @features_data = Hash.new { |h,k| h[k] = {
    feature: nil,
    failures: 0,
    errors: 0,
    tests: 0,
    skipped: 0,
    time: 0,
    builder: Builder::XmlMarkup.new(:indent => 2)
  }}
end

Public Instance Methods

on_after_test_case(event) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 56
def on_after_test_case(event)
  test_case = event.test_case
  result = event.result.with_filtered_backtrace(Cucumber::Formatter::BacktraceFilter)
  test_case_name = NameBuilder.new(test_case)
  scenario = test_case_name.scenario_name
  scenario_designation = "#{scenario}#{test_case_name.name_suffix}"
  output = create_output_string(test_case, scenario, result, test_case_name.row_name)
  build_testcase(result, scenario_designation, output)

  Interceptor::Pipe.unwrap! :stdout
  Interceptor::Pipe.unwrap! :stderr
end
on_after_test_step(event) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 50
def on_after_test_step(event)
  return if @failing_step_source

  @failing_step_source = event.test_step.source.last unless event.result.ok?(@config.strict?)
end
on_before_test_case(event) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 38
def on_before_test_case(event)
  test_case = event.test_case
  unless same_feature_as_previous_test_case?(test_case.feature)
    start_feature(test_case.feature)
  end
  @failing_step_source = nil
  # In order to fill out <system-err/> and <system-out/>, we need to
  # intercept the $stderr and $stdout
  @interceptedout = Interceptor::Pipe.wrap(:stdout)
  @interceptederr = Interceptor::Pipe.wrap(:stderr)
end
on_finished_testing(event) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 69
def on_finished_testing(event)
  @features_data.each { |file, data| end_feature(data) }
end

Private Instance Methods

basename(feature_file) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 164
def basename(feature_file)
  File.basename(feature_file.gsub(/[\\/]/, '-'), '.feature')
end
build_testcase(result, scenario_designation, output) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 117
def build_testcase(result, scenario_designation, output)
  duration = ResultBuilder.new(result).test_case_duration
  @current_feature_data[:time] += duration
  classname = @current_feature_data[:feature].name
  name = scenario_designation

  @current_feature_data[:builder].testcase(:classname => classname, :name => name, :time => "%.6f" % duration) do
    if !result.passed? && result.ok?(@config.strict?)
      @current_feature_data[:builder].skipped
      @current_feature_data[:skipped] += 1
    elsif !result.passed?
      status = result.to_sym
      exception = get_backtrace_object(result)
      @current_feature_data[:builder].failure(:message => "#{status} #{name}", :type => status) do
        @current_feature_data[:builder].cdata! output
        @current_feature_data[:builder].cdata!(format_exception(exception)) if exception
      end
      @current_feature_data[:failures] += 1
    end
    @current_feature_data[:builder].tag!('system-out') do
      @current_feature_data[:builder].cdata! strip_control_chars(@interceptedout.buffer.join)
    end
    @current_feature_data[:builder].tag!('system-err') do
      @current_feature_data[:builder].cdata! strip_control_chars(@interceptederr.buffer.join)
    end
  end
  @current_feature_data[:tests] += 1
end
create_output_string(test_case, scenario, result, row_name) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 101
def create_output_string(test_case, scenario, result, row_name)
  output = "#{test_case.keyword}: #{scenario}\n\n"
  return output if result.ok?(@config.strict?)
  if test_case.keyword == "Scenario"
    output += "#{@failing_step_source.keyword}" unless hook?(@failing_step_source)
    output += "#{@failing_step_source.name}\n"
  else
    output += "Example row: #{row_name}\n"
  end
  output + "\nMessage:\n"
end
end_feature(feature_data) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 85
def end_feature(feature_data)
  @testsuite = Builder::XmlMarkup.new(:indent => 2)
  @testsuite.instruct!
  @testsuite.testsuite(
    :failures => feature_data[:failures],
    :errors => feature_data[:errors],
    :skipped => feature_data[:skipped],
    :tests => feature_data[:tests],
    :time => "%.6f" % feature_data[:time],
    :name => feature_data[:feature].name ) do
    @testsuite << feature_data[:builder].target!
  end

  write_file(feature_result_filename(feature_data[:feature].file), @testsuite.target!)
end
feature_result_filename(feature_file) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 160
def feature_result_filename(feature_file)
  File.join(@reportdir, "TEST-#{basename(feature_file)}.xml")
end
format_exception(exception) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 156
def format_exception(exception)
  (["#{exception.message} (#{exception.class})"] + exception.backtrace).join("\n")
end
get_backtrace_object(result) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 146
def get_backtrace_object(result)
  if result.failed?
    return result.exception
  elsif result.backtrace
    return result
  else
    return nil
  end
end
hook?(step) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 113
def hook?(step)
  ["Before hook", "After hook", "AfterStep hook"].include? step.name
end
same_feature_as_previous_test_case?(feature) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 75
def same_feature_as_previous_test_case?(feature)
  @current_feature_data && @current_feature_data[:feature].file == feature.file && @current_feature_data[:feature].location == feature.location
end
start_feature(feature) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 79
def start_feature(feature)
  raise UnNamedFeatureError.new(feature.file) if feature.name.empty?
  @current_feature_data = @features_data[feature.file]
  @current_feature_data[:feature] = feature unless @current_feature_data[:feature]
end
strip_control_chars(cdata) click to toggle source

strip control chars from cdata, to make it safe for external parsers

# File lib/cucumber/formatter/junit.rb, line 173
def strip_control_chars(cdata)
  cdata.scan(/[[:print:]\t\n\r]/).join
end
write_file(feature_filename, data) click to toggle source
# File lib/cucumber/formatter/junit.rb, line 168
def write_file(feature_filename, data)
  File.open(feature_filename, 'w') { |file| file.write(data) }
end