Puppet Function: parseyaml

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

Summary

This function accepts YAML as a string and converts it into the correct Puppet structure.

Overview

parseyaml() ⇒ Any

> Note:

The optional second argument can be used to pass a default value that will
be returned if the parsing of YAML string have failed.

Returns:

  • (Any) —

    converted YAML into Puppet structure



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/parseyaml.rb', line 7

newfunction(:parseyaml, type: :rvalue, doc: <<-DOC
  @summary
    This function accepts YAML as a string and converts it into the correct
    Puppet structure.

  @return
    converted YAML into Puppet structure

  > *Note:*
    The optional second argument can be used to pass a default value that will
    be returned if the parsing of YAML string have failed.
DOC
) do |arguments|
  raise ArgumentError, 'Wrong number of arguments. 1 or 2 arguments should be provided.' unless arguments.length >= 1
  require 'yaml'

  begin
    YAML.load(arguments[0]) || arguments[1] # rubocop:disable Security/YAMLLoad : using YAML.safe_load causes the code to break
    # in ruby 1.9.3 Psych::SyntaxError is a RuntimeException
    # this still needs to catch that and work also on rubies that
    # do not have Psych available.
  rescue StandardError, Psych::SyntaxError => e # rubocop:disable Lint/ShadowedException : See above
    raise e unless arguments[1]
    arguments[1]
  end
end