Puppet Function: assert::equal

Defined in:
lib/puppet/functions/assert/equal.rb
Function type:
Ruby 4.x API

Overview

assert::equal(Any $result, Any $expected) ⇒ Any

Accepts two parameters that must be of the same type and returns true if both parameters are equal, or raises a Puppet::Error if they are not equal.

~~~ puppet

assert::equal([1,2,3], [1,2,3])
'foo'.assert::equal('foo')
[1,2,3].assert::equal(sort([3,2,1]))

~~~

~~~ puppet

'foo'.assert::equal(bar)
'true'.assert::equal(true)
assert::equal(1,2)

~~~

Examples:

expected to pass

expected to raise an exception

Parameters:

  • result (Any)
  • expected (Any)

Returns:

  • (Any) 


19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/puppet/functions/assert/equal.rb', line 19

Puppet::Functions.create_function(:'assert::equal') do
  dispatch :test do
    param 'Any', :result
    param 'Any', :expected
  end

  def test(result, expected)
    raise Puppet::Error, "expected result #{expected} does not equal actual result #{result}" unless result == expected
    return true
  end
end