Method: Inspec::Shell#print_matchers_help

Defined in:

lib/inspec/shell.rb

#print_matchers_help ⇒ Object

# File 'lib/inspec/shell.rb', line 166

def print_matchers_help
  puts <<-EOL
Matchers are used to compare resource values to expectations. While some
resources implement their own custom matchers, the following matchers are
common amongst all resources:

#{mark 'be'}

The #{mark 'be'} matcher can be used to compare numeric values.

   its('size') { should be >= 10 }

#{mark 'cmp'}

The #{mark 'cmp'} matcher is like #{mark 'eq'} but less restrictive. It will try
to fit the resource value to the expectation.

"Protocol" likely returns a string, but cmp will ensure it's a number before
comparing:

  its('Protocol') { should cmp 2 }
  its('Protocol') { should cmp '2' }

"users" may return an array, but if it contains only one item, cmp will compare
it as a string or number as needed:

  its('users') { should cmp 'root' }

cmp is not case-sensitive:

  its('log_format') { should cmp 'raw' }
  its('log_format') { should cmp 'RAW' }

#{mark 'eq'}

The #{mark 'eq'} matcher tests for exact equality of two values. Value type
(string, number, etc.) is important and must be the same. For a less-restrictive
comparison matcher, use the #{mark 'cmp'} matcher.

  its('RSAAuthentication') { should_not eq 'no' }

#{mark 'include'}

The #{mark 'include'} matcher tests to see if a value is included in a list.

  its('users') { should include 'my_user' }

#{mark 'match'}

The #{mark 'match'} matcher can be used to test a string for a match using a
regular expression.

  its('content') { should_not match /^MyKey:\\s+some value/ }

For more examples, see: https://www.inspec.io/docs/reference/matchers/

  EOL
end