Puppet Function: assert_private

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/assert_private.rb
Function type:
Ruby 3.x API

Summary

Sets the current class or definition as private.

Overview

assert_private() ⇒ Any

Calling the class or definition from outside the current module will fail.

Returns:

  • (Any) —

    set the current class or definition as private.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/assert_private.rb', line 7

newfunction(:assert_private, doc: <<-DOC
  @summary
    Sets the current class or definition as private.

  @return
    set the current class or definition as private.

  Calling the class or definition from outside the current module will fail.
  DOC
) do |args|
  raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1

  scope = self
  if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name')
    message = nil
    if args[0]&.is_a?(String)
      message = args[0]
    else
      manifest_name = scope.source.name
      manifest_type = scope.source.type
      message = (manifest_type.to_s == 'hostclass') ? 'Class' : 'Definition'
      message += " #{manifest_name} is private"
    end
    raise(Puppet::ParseError, message)
  end
end