Sha256: e886a6be4412d173772ef416381a575c1c2c6a7b078df64127322ac4a505111a

Contents?: true

Size: 1.37 KB

Versions: 35

Compression:

Stored size: 1.37 KB

Contents

# The `yaml_data` is a hiera 5 `data_hash` data provider function.
# See [the configuration guide documentation](https://docs.puppet.com/puppet/latest/hiera_config_yaml_5.html#configuring-a-hierarchy-level-built-in-backends) for
# how to use this function.
#
# @since 4.8.0
#
require 'yaml'

Puppet::Functions.create_function(:yaml_data) do
  dispatch :yaml_data do
    param 'Struct[{path=>String[1]}]', :options
    param 'Puppet::LookupContext', :context
  end

  argument_mismatch :missing_path do
    param 'Hash', :options
    param 'Puppet::LookupContext', :context
  end

  def yaml_data(options, context)
    path = options['path']
    context.cached_file_data(path) do |content|
      begin
        data = YAML.load(content, path)
        if data.is_a?(Hash)
          Puppet::Pops::Lookup::HieraConfig.symkeys_to_string(data)
        else
          Puppet.warning(_("%{path}: file does not contain a valid yaml hash" % { path: path }))
          {}
        end
      rescue YAML::SyntaxError => ex
        # Psych errors includes the absolute path to the file, so no need to add that
        # to the message
        raise Puppet::DataBinding::LookupError, "Unable to parse #{ex.message}"
      end
    end
  end

  def missing_path(options, context)
    "one of 'path', 'paths' 'glob', 'globs' or 'mapped_paths' must be declared in hiera.yaml when using this data_hash function"
  end
end

Version data entries

35 entries across 35 versions & 2 rubygems

Version Path
puppet-5.3.7 lib/puppet/functions/yaml_data.rb
puppet-5.3.7-x86-mingw32 lib/puppet/functions/yaml_data.rb
puppet-5.3.7-x64-mingw32 lib/puppet/functions/yaml_data.rb
puppet-5.3.7-universal-darwin lib/puppet/functions/yaml_data.rb
bolt-0.20.3 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.20.2 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.19.1 vendored/puppet/lib/puppet/functions/yaml_data.rb
puppet-5.3.6 lib/puppet/functions/yaml_data.rb
puppet-5.3.6-x86-mingw32 lib/puppet/functions/yaml_data.rb
puppet-5.3.6-x64-mingw32 lib/puppet/functions/yaml_data.rb
puppet-5.3.6-universal-darwin lib/puppet/functions/yaml_data.rb
bolt-0.19.0 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.18.2 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.18.1 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.18.0 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.17.2 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.17.1 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.17.0 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.16.4 vendored/puppet/lib/puppet/functions/yaml_data.rb
bolt-0.16.3 vendored/puppet/lib/puppet/functions/yaml_data.rb