Class: Puppet::Pops::Lookup::HieraConfigV4 Private

# File 'lib/puppet/pops/lookup/hiera_config.rb', line 478

def self.config_type
  return @@CONFIG_TYPE if class_variable_defined?(:@@CONFIG_TYPE)
  tf = Types::TypeFactory
  nes_t = Types::PStringType::NON_EMPTY

  @@CONFIG_TYPE = tf.struct({
    KEY_VERSION => tf.range(4, 4),
    tf.optional(KEY_DATADIR) => nes_t,
    tf.optional(KEY_HIERARCHY) => tf.array_of(tf.struct(
      KEY_BACKEND => nes_t,
      KEY_NAME => nes_t,
      tf.optional(KEY_DATADIR) => nes_t,
      tf.optional(KEY_PATH) => nes_t,
      tf.optional(KEY_PATHS) => tf.array_of(nes_t)
    ))
  })
end

Instance Method Details

#create_configured_data_providers(lookup_invocation, parent_data_provider, _) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/puppet/pops/lookup/hiera_config.rb', line 515

def create_configured_data_providers(lookup_invocation, parent_data_provider, _)
  default_datadir = @config[KEY_DATADIR]
  data_providers = {}

  @config[KEY_HIERARCHY].each do |he|
    name = he[KEY_NAME]
    if data_providers.include?(name)
      first_line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/)
      line = find_line_matching(/\s+name:\s+['"]?#{name}(?:[^\w]|$)/, first_line + 1) if first_line
      unless line
        line = first_line
        first_line = nil
      end
      fail(Issues::HIERA_HIERARCHY_NAME_MULTIPLY_DEFINED, { :name => name, :first_line => first_line }, line)
    end
    original_paths = he[KEY_PATHS] || [he[KEY_PATH] || name]
    datadir = @config_root + (he[KEY_DATADIR] || default_datadir)
    provider_name = he[KEY_BACKEND]
    data_providers[name] = case
    when provider_name == 'json', provider_name == 'yaml'
      create_data_provider(name, parent_data_provider, KEY_DATA_HASH, "#{provider_name}_data", {},
        resolve_paths(datadir, original_paths, lookup_invocation, @config_path.nil?, ".#{provider_name}"))
    when provider_name == 'hocon' &&  Puppet.features.hocon?
      create_data_provider(name, parent_data_provider, KEY_DATA_HASH, 'hocon_data', {},
        resolve_paths(datadir, original_paths, lookup_invocation, @config_path.nil?, '.conf'))
    else
      factory_create_data_provider(lookup_invocation, name, parent_data_provider, provider_name, datadir, original_paths)
    end
  end
  data_providers.values
end

#factory_create_data_provider(lookup_invocation, name, parent_data_provider, provider_name, datadir, original_paths) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/puppet/pops/lookup/hiera_config.rb', line 496

def factory_create_data_provider(lookup_invocation, name, parent_data_provider, provider_name, datadir, original_paths)
  service_type = Registry.hash_of_path_based_data_provider_factories
  provider_factory = Puppet.lookup(:injector).lookup(nil, service_type, PATH_BASED_DATA_PROVIDER_FACTORIES_KEY)[provider_name]
  unless provider_factory
    fail(Issues::HIERA_NO_PROVIDER_FOR_BACKEND, { :name => provider_name }, find_line_matching(/[^\w]#{provider_name}(?:[^\w]|$)/))
  end

  paths = original_paths.map { |path| interpolate(path, lookup_invocation, false) }
  paths = provider_factory.resolve_paths(datadir, original_paths, paths, lookup_invocation)

  provider_factory_version = provider_factory.respond_to?(:version) ? provider_factory.version : 1
  if provider_factory_version == 1
    # Version 1 is not aware of the parent provider
    provider_factory.create(name, paths)
  else
    provider_factory.create(name, paths, parent_data_provider)
  end
end

#validate_config(config, owner) ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/puppet/pops/lookup/hiera_config.rb', line 547

def validate_config(config, owner)
  unless Puppet[:strict] == :off
    Puppet.warn_once(:deprecation, 'hiera.yaml',
      "#{@config_path}: Use of 'hiera.yaml' version 4 is deprecated. It should be converted to version 5", config_path.to_s)
  end
  config[KEY_DATADIR] ||= 'data'
  config[KEY_HIERARCHY] ||= [{ KEY_NAME => 'common', KEY_BACKEND => 'yaml' }]
  Types::TypeAsserter.assert_instance_of(["The Lookup Configuration at '%s'", @config_path], self.class.config_type, config)
end

#version ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



557
558
559

# File 'lib/puppet/pops/lookup/hiera_config.rb', line 557

def version
  4
end

Class: Puppet::Pops::Lookup::HieraConfigV4 Private

Constant Summary

Constants included from Puppet::Plugins::DataProviders

Constants inherited from HieraConfig

Constants included from Puppet::Pops::LabelProvider

Constants included from SubLookup

Instance Attribute Summary

Attributes inherited from HieraConfig

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HieraConfig

Methods included from Puppet::Pops::LabelProvider

Methods included from LocationResolver

Methods included from Interpolation

Methods included from SubLookup

Constructor Details

Class Method Details

.config_type ⇒ Object

Instance Method Details

#create_configured_data_providers(lookup_invocation, parent_data_provider, _) ⇒ Object

#factory_create_data_provider(lookup_invocation, name, parent_data_provider, provider_name, datadir, original_paths) ⇒ Object

#validate_config(config, owner) ⇒ Object

#version ⇒ Object

.config_type ⇒ `Object`

#create_configured_data_providers(lookup_invocation, parent_data_provider, _) ⇒ `Object`

#factory_create_data_provider(lookup_invocation, name, parent_data_provider, provider_name, datadir, original_paths) ⇒ `Object`

#validate_config(config, owner) ⇒ `Object`

#version ⇒ `Object`