Module: TTYtest::Matchers

Included in:
Capture
Defined in:
lib/ttytest/matchers.rb

Overview

Assertions for ttytest2.

Constant Summary collapse

METHODS = 
public_instance_methods

Instance Method Summary collapse

Instance Method Details

#assert_contents(expected) ⇒ Object Also known as: assert_matches, assert_screen

Asserts the full contents of the terminal

Parameters:

  • expected (String) —

    the full expected contents of the terminal. Trailing whitespace on each line is ignored

Raises:

  • (MatchError) —

    if the terminal doesn’t match the expected content



189
190
191
192
193
194
195
196
 
# File 'lib/ttytest/matchers.rb', line 189

def assert_contents(expected)
  matched, diff = matched(expected, rows)

  return if matched

  raise MatchError,
        "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
end

#assert_contents_at(row_start, row_end, expected) ⇒ Object Also known as: assert_matches_at, assert_rows

Asserts the contents of the terminal at specified rows

Parameters:

  • expected (String) —

    the expected contents of the terminal at specified rows. Trailing whitespace on each line is ignored

Raises:

  • (MatchError) —

    if the terminal doesn’t match the expected content



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ttytest/matchers.rb', line 203

def assert_contents_at(row_start, row_end, expected)
  validate(row_end)
  row_end += 1 if row_end.zero?

  matched, diff = matched(expected, rows.slice(row_start, row_end))

  return if matched

  raise MatchError,
        "screen did not match expected content:\n--- expected\n+++ actual\n#{diff.join("\n")}"
end

#assert_cursor_hidden ⇒ Object

Raises:



162
163
164
165
166
 
# File 'lib/ttytest/matchers.rb', line 162

def assert_cursor_hidden
  return if cursor_hidden?

  raise MatchError, "expected cursor to be hidden was visible\nEntire screen:\n#{self}"
end

#assert_cursor_position(x, y) ⇒ Object

Asserts that the cursor is in the expected position

Parameters:

  • x (Integer) —

    cursor x (row) position, starting from 0

  • y (Integer) —

    cursor y (column) position, starting from 0

Raises:

  • (MatchError) —

    if the cursor position doesn’t match



144
145
146
147
148
149
150
151
152
 
# File 'lib/ttytest/matchers.rb', line 144

def assert_cursor_position(x, y)
  expected = [x, y]
  actual = [cursor_x, cursor_y]

  return if actual == expected

  raise MatchError,
        "expected cursor to be at #{expected.inspect} but was at #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_cursor_visible ⇒ Object

Raises:



155
156
157
158
159
 
# File 'lib/ttytest/matchers.rb', line 155

def assert_cursor_visible
  return if cursor_visible?

  raise MatchError, "expected cursor to be visible was hidden\nEntire screen:\n#{self}"
end

#assert_file_contains(file_path, needle) ⇒ Object

Raises:



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/ttytest/matchers.rb', line 229

def assert_file_contains(file_path, needle)
  raise file_not_found_error(file_path) unless File.exist?(file_path)
  raise file_is_dir_error(file_path) unless File.file?(file_path)

  file_contains = false
  File.foreach(file_path) do |line|
    if line.include?(needle)
      file_contains = true
      break
    end
  end
  return if file_contains

  raise MatchError,
        "File with path #{file_path} did not contain #{needle}.\nEntire screen:\n#{self}"
end

#assert_file_doesnt_exist(file_path) ⇒ Object

Raises:



222
223
224
225
226
227
 
# File 'lib/ttytest/matchers.rb', line 222

def assert_file_doesnt_exist(file_path)
  return unless File.exist?(file_path) || File.file?(file_path)

  raise MatchError,
        "File with path #{file_path} was found or is a directory when it was asserted it did not exist.\nEntire screen:\n#{self}"
end

#assert_file_exists(file_path) ⇒ Object 



217
218
219
220
 
# File 'lib/ttytest/matchers.rb', line 217

def assert_file_exists(file_path)
  raise file_not_found_error(file_path) unless File.exist?(file_path)
  raise file_is_dir_error(file_path) unless File.file?(file_path)
end

#assert_file_has_permissions(file_path, permissions) ⇒ Object

Raises:



246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/ttytest/matchers.rb', line 246

def assert_file_has_permissions(file_path, permissions)
  raise file_not_found_error(file_path) unless File.exist?(file_path)
  raise file_is_dir_error(file_path) unless File.file?(file_path)

  file_mode = File.stat(file_path).mode
  perms_octal = format('%o', file_mode)[-3...]
  return if perms_octal == permissions

  raise MatchError,
        "File had permissions #{perms_octal}, not #{permissions} as expected.\n Entire screen:\n#{self}"
end

#assert_row(row_number, expected) ⇒ Object Also known as: assert_line

Asserts the contents of a single row match the value expected

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • expected (String) —

    the expected value of the row. Any trailing whitespace is ignored

Raises:

  • (MatchError) —

    if the row doesn’t match exactly



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/ttytest/matchers.rb', line 10

def assert_row(row_number, expected)
  validate(row_number)
  expected = expected.rstrip
  actual = row(row_number)

  return if !actual.nil? && actual == expected

  raise MatchError,
        "expected row #{row_number} to be #{expected.inspect} but got #{get_inspection(actual)}\n
        Entire screen:\n#{self}"
end

#assert_row_at(row_number, column_start, column_end, expected) ⇒ Object Also known as: assert_line_at

Asserts the contents of a single row contains the expected string at a specific position

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • column_start (Integer) —

    the column position to start comparing expected against

  • columns_end (Integer) —

    the column position to end comparing expected against

  • expected (String) —

    the expected value that the row starts with. Any trailing whitespace is ignored

Raises:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ttytest/matchers.rb', line 43

def assert_row_at(row_number, column_start, column_end, expected)
  validate(row_number)
  expected = expected.rstrip
  actual = row(row_number)
  column_end += 1

  return if !actual.nil? && actual[column_start, column_end].eql?(expected)

  inspection = get_inspection_bounded(actual, column_start, column_end)

  raise MatchError,
        "expected row #{row_number} to contain #{expected[column_start,
                                                          column_end]} at #{column_start}-#{column_end} and got #{inspection}\nEntire screen:\n#{self}"
end

#assert_row_ends_with(row_number, expected) ⇒ Object

Asserts the contents of a single row end with expected

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • expected (String) —

    the expected value that the row starts with. Any trailing whitespace is ignored

Raises:



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ttytest/matchers.rb', line 96

def assert_row_ends_with(row_number, expected)
  validate(row_number)
  expected = expected.rstrip
  actual = row(row_number)

  return if !actual.nil? && actual.end_with?(expected)

  raise MatchError,
        "expected row #{row_number} to end with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_row_is_empty(row_number) ⇒ Object Also known as: assert_line_is_empty

Asserts the specified row is empty

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

Raises:



26
27
28
29
30
31
32
33
34
 
# File 'lib/ttytest/matchers.rb', line 26

def assert_row_is_empty(row_number)
  validate(row_number)
  actual = row(row_number)

  return if actual == ''

  raise MatchError,
        "expected row #{row_number} to be empty but got #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_row_like(row_number, expected) ⇒ Object Also known as: assert_row_contains, assert_line_contains, assert_line_like

Asserts the contents of a single row contains the value expected

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • expected (String) —

    the expected value contained in the row. Any trailing whitespace is ignored

Raises:



63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ttytest/matchers.rb', line 63

def assert_row_like(row_number, expected)
  validate(row_number)
  expected = expected.rstrip
  actual = row(row_number)

  return if !actual.nil? && actual.include?(expected)

  raise MatchError,
        "expected row #{row_number} to be like #{expected.inspect} but got #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_row_regexp(row_number, regexp_str) ⇒ Object

Asserts the contents of a single row match against the passed in regular expression

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • regexp_str (String) —

    the regular expression as a string that will be used to match with.

Raises:

  • (MatchError) —

    if the row doesn’t match against the regular expression



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/ttytest/matchers.rb', line 111

def assert_row_regexp(row_number, regexp_str)
  validate(row_number)
  regexp = Regexp.new(regexp_str)
  actual = row(row_number)

  return if !actual.nil? && actual.match?(regexp)

  raise MatchError,
        "expected row #{row_number} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_row_starts_with(row_number, expected) ⇒ Object

Asserts the contents of a single row starts with expected string

Parameters:

  • row_number (Integer) —

    the row (starting from 0) to test against

  • expected (String) —

    the expected value that the row starts with. Any trailing whitespace is ignored

Raises:



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/ttytest/matchers.rb', line 81

def assert_row_starts_with(row_number, expected)
  validate(row_number)
  expected = expected.rstrip
  actual = row(row_number)

  return if !actual.nil? && actual.start_with?(expected)

  raise MatchError,
        "expected row #{row_number} to start with #{expected.inspect} and got #{get_inspection(actual)}\nEntire screen:\n#{self}"
end

#assert_rows_each_match_regexp(row_start, row_end, regexp_str) ⇒ Object

Asserts the contents of a multiple rows each match against the passed in regular expression

Parameters:

  • row_start (Integer) —

    the row (starting from 0) to test against

  • row_end (Integer) —

    the last row to test against

  • regexp_str (String) —

    the regular expression as a string that will be used to match with.

Raises:

  • (MatchError) —

    if the row doesn’t match against the regular expression



127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ttytest/matchers.rb', line 127

def assert_rows_each_match_regexp(row_start, row_end, regexp_str)
  validate(row_end)
  regexp = Regexp.new(regexp_str)
  row_end += 1 if row_end.zero?

  rows.slice(row_start, row_end).each_with_index do |actual_row, index|
    next if !actual_row.nil? && actual_row.match?(regexp)

    raise MatchError,
          "expected row #{index} to match regexp #{regexp_str} but it did not. Row value #{get_inspection(actual_row)}\nEntire screen:\n#{self}"
  end
end

#matched(expected, actual) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ttytest/matchers.rb', line 168

def matched(expected, actual)
  expected_rows = expected.split("\n")
  diff = []
  matched = true
  actual.each_with_index do |actual_row, index|
    expected_row = (expected_rows[index] || '').rstrip
    if actual_row != expected_row
      diff << "-#{expected_row}"
      diff << "+#{actual_row}"
      matched = false
    else
      diff << " #{actual_row}".rstrip
    end
  end

  [matched, diff]
end