Puppet Function: stdlib::str2resource

Defined in:
vendor_modules/stdlib/lib/puppet/functions/stdlib/str2resource.rb
Function type:
Ruby 4.x API

Summary

This converts a string to a puppet resource.

Overview

stdlib::str2resource(String $res_string) ⇒ Any

This attempts to convert a string like 'File' into the puppet resource `File` as detected by the catalog.

Things like 'File[/foo, /bar]' are not supported as a title might contain things like ',' or ' '. There is no clear value seperator to use.

This function can depend on the parse order of your manifests/modules as it inspects the catalog thus far.

Examples:

stdlib::str2resource('File[/foo]') => File[/foo]

Parameters:

  • res_string (String) —

    The string to lookup as a resource

Returns:

  • (Any) —

    Puppet::Resource



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'vendor_modules/stdlib/lib/puppet/functions/stdlib/str2resource.rb', line 15

Puppet::Functions.create_function(:'stdlib::str2resource') do
  # @param res_string The string to lookup as a resource
  # @example
  #   stdlib::str2resource('File[/foo]') => File[/foo]
  # @return Puppet::Resource
  dispatch :str2resource do
    param 'String', :res_string
    # return_type 'Puppet::Resource'
    return_type 'Any'
  end

  def str2resource(res_string)
    type_name, title = Puppet::Resource.type_and_title(res_string, nil)

    resource = closure_scope.findresource(type_name, title)

    if resource.nil?
      raise(Puppet::ParseError, "stdlib::str2resource(): could not find #{type_name}[#{title}], this is parse order dependent and values should not be quoted")
    end

    resource
  end
end