Module: Beaker::DSL::Assertions

Includes:
Minitest::Assertions
Included in:
Beaker::DSL
Defined in:
lib/beaker/dsl/assertions.rb

Overview

Any custom assertions for Test::Unit or minitest live here. You may include them in your own testing if you wish, override them, or re-open the class to register new ones for use within TestCase.

You may use any test/unit assertion within your assertion. The assertion below assumes access to the method #result which will contain the output (according to the interface defined in Result). When writing your own, to make them more portable and less brittle it is recommended that you pass the result or direct object for asserting against into your assertion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#assertions ⇒ Object 



29
30
31
 
# File 'lib/beaker/dsl/assertions.rb', line 29

def assertions
  @assertions || 0
end

Instance Method Details

#assert_output(exp_out, msg = 'Output lines did not match') ⇒ Object

Make assertions about the content of console output.

By default, each line of output is assumed to come from STDOUT. You may specify the stream explicitly by annotating the line with a stream marker. (If your line literally requires any stream marker at the beginning of a line, you must prefix the line with an explicit stream marker.) The currently recognized markers are:

  • “STDOUT> ”

  • “STDERR> ”

  • “OUT> ”

  • “ERR> ”

  • “1> ”

  • “2> ”

Any leading common indentation is automatically removed from the output parameter. For cases where this matters (e.g. every line should be indented), you should prefix the line with an explicit stream marker.

Examples:

Assert order of interleaved output streams

assert_output <<-CONSOLE
  STDOUT> 0123456789
  STDERR> ^- This is left aligned
  STDOUT>   01234567890
  STDERR>   ^- This is indented 2 characters.
CONSOLE

Assert all content went to STDOUT

assert_output <<-CONSOLE
  0123456789
  ^- This is left aligned
    01234567890
    ^- This is indented 2 characters.
CONSOLE

Parameters:

  • exp_out (String) —

    The expected console output, optionally annotated with stream markers.

  • msg (String) (defaults to: 'Output lines did not match') —

    An explanatory message about why the test failure is relevant.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/beaker/dsl/assertions.rb', line 75

def assert_output(exp_out, msg = 'Output lines did not match')
  # Remove the minimal consistent indentation from the input;
  # useful for clean HEREDOCs.
  indentation = exp_out.lines.map { |line| line[/^ */].length }.min
  cleaned_exp = exp_out.gsub(/^ {#{indentation}}/, '')

  # Divide output based on expected destination
  out, err = cleaned_exp.lines.partition do |line|
    line !~ /^((STD)?ERR|2)> /
  end
  our_out, our_err, our_output = [
    out.join, err.join, cleaned_exp,
  ].map do |str|
    str.gsub(/^((STD)?(ERR|OUT)|[12])> /, '')
  end

  # Exercise assertions about output
  assert_equal our_output, (result.nil? ? '' : result.output), msg
  assert_equal our_out,    (result.nil? ? '' : result.stdout),
               'The contents of STDOUT did not match expectations'
  assert_equal our_err,    (result.nil? ? '' : result.stderr),
               'The contents of STDERR did not match expectations'
end