lookup_spec.rb

require 'spec_helper'
require 'puppet_spec/files'
require 'puppet/pops'
require 'deep_merge/core'

module Puppet::Pops
module Lookup
describe 'The lookup API' do
  include PuppetSpec::Files

  let(:env_name) { 'spec' }
  let(:code_dir) { Puppet[:environmentpath] }
  let(:env_dir) { File.join(code_dir, env_name) }
  let(:env) { Puppet::Node::Environment.create(env_name.to_sym, [File.join(populated_env_dir, 'modules')]) }
  let(:node) { Puppet::Node.new('test', :environment => env) }
  let(:compiler) { Puppet::Parser::Compiler.new(node) }
  let(:pal_compiler) { Puppet::Pal::ScriptCompiler.new(compiler) }
  let(:scope) { compiler.topscope }
  let(:invocation) { Invocation.new(scope) }

  let(:code_dir_content) do
    {
      'hiera.yaml' => <<-YAML.unindent,
        version: 5
        YAML
      'data' => {
        'common.yaml' => <<-YAML.unindent
          a: a (from global)
          d: d (from global)
          mod::e: mod::e (from global)
          YAML
      }
    }
  end

  let(:env_content) do
    {
      'hiera.yaml' => <<-YAML.unindent,
        version: 5
        YAML
      'data' => {
        'common.yaml' => <<-YAML.unindent
          b: b (from environment)
          d: d (from environment)
          mod::f: mod::f (from environment)
          YAML
      }
    }
  end

  let(:mod_content) do
    {
      'hiera.yaml' => <<-YAML.unindent,
        version: 5
        YAML
      'data' => {
        'common.yaml' => <<-YAML.unindent
          mod::c: mod::c (from module)
          mod::e: mod::e (from module)
          mod::f: mod::f (from module)
          mod::g:
            :symbol: symbol key value
            key: string key value
            6: integer key value
            -4: negative integer key value
            2.7: float key value
            '6': string integer key value
          YAML
      }
    }
  end

  let(:populated_env_dir) do
    all_content = code_dir_content.merge(env_name => env_content.merge('modules' => { 'mod' => mod_content }))
    dir_contained_in(code_dir, all_content)
    all_content.keys.each { |key| PuppetSpec::Files.record_tmp(File.join(code_dir, key)) }
    env_dir
  end

  before(:each) do
    Puppet[:hiera_config] = File.join(code_dir, 'hiera.yaml')
    Puppet.push_context(:loaders => Puppet::Pops::Loaders.new(env))
  end

  after(:each) do
    Puppet.pop_context
  end

  context 'when doing automatic parameter lookup' do

    let(:mod_content) do
      {
        'hiera.yaml' => <<-YAML.unindent,
          version: 5
          YAML
        'data' => {
          'common.yaml' => <<-YAML.unindent
            mod::x: mod::x (from module)
            YAML
        },
        'manifests' => {
           'init.pp' => <<-PUPPET.unindent
             class mod($x) {
               notify { $x: }
             }
             PUPPET
        }
      }
    end
    let(:logs) { [] }
    let(:debugs) { logs.select { |log| log.level == :debug }.map { |log| log.message } }

    it 'includes APL in explain output when debug is enabled' do
      Puppet[:log_level] = 'debug'
      Puppet[:code] = 'include mod'
      Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
        compiler.compile
      end
      expect(debugs).to include(/Found key: "mod::x" value: "mod::x \(from module\)"/)
    end
  end

  context 'when hiera YAML data is corrupt' do
    let(:mod_content) do
      {
        'hiera.yaml' => 'version: 5',
        'data' => {
          'common.yaml' => <<-YAML.unindent
            ---
            #mod::classes:
              - cls1
              - cls2
              
            mod::somevar: 1
            YAML
        },
      }
    end
    let(:msg) { /file does not contain a valid yaml hash/ }

    %w(off warning).each do |strict|
      it "logs a warning when --strict is '#{strict}'" do
        Puppet[:strict] = strict
        logs = []
        Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
          expect(Lookup.lookup('mod::somevar', nil, nil, true, nil, invocation)).to be_nil
        end
        expect(logs.map(&:message)).to contain_exactly(msg)
      end
    end

    it 'fails when --strict is "error"' do
      Puppet[:strict] = 'error'
      expect { Lookup.lookup('mod::somevar', nil, nil, true, nil, invocation) }.to raise_error(msg)
    end
  end

  context 'when hiera YAML data is empty' do
    let(:mod_content) do
      {
        'hiera.yaml' => 'version: 5',
        'data' => { 'common.yaml' => '' },
      }
    end
    let(:msg) { /file does not contain a valid yaml hash/ }

    %w(off warning error).each do |strict|
      it "logs a warning when --strict is '#{strict}'" do
        Puppet[:strict] = strict
        logs = []
        Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
          expect(Lookup.lookup('mod::somevar', nil, nil, true, nil, invocation)).to be_nil
        end
        expect(logs.map(&:message)).to contain_exactly(msg)
      end
    end
  end

  context 'when doing lookup' do
    it 'finds data in global layer' do
      expect(Lookup.lookup('a', nil, nil, false, nil, invocation)).to eql('a (from global)')
    end

    it 'finds data in environment layer' do
      expect(Lookup.lookup('b', nil, 'not found', true, nil, invocation)).to eql('b (from environment)')
    end

    it 'global layer wins over environment layer' do
      expect(Lookup.lookup('d', nil, 'not found', true, nil, invocation)).to eql('d (from global)')
    end

    it 'finds data in module layer' do
      expect(Lookup.lookup('mod::c', nil, 'not found', true, nil, invocation)).to eql('mod::c (from module)')
    end

    it 'global layer wins over module layer' do
      expect(Lookup.lookup('mod::e', nil, 'not found', true, nil, invocation)).to eql('mod::e (from global)')
    end

    it 'environment layer wins over module layer' do
      expect(Lookup.lookup('mod::f', nil, 'not found', true, nil, invocation)).to eql('mod::f (from environment)')
    end

    it 'returns the correct types for hash keys' do
      expect(Lookup.lookup('mod::g', nil, 'not found', true, nil, invocation)).to eql(
	      {
          'symbol' => 'symbol key value',
		      'key' => 'string key value',
		      6 => 'integer key value',
          -4 => 'negative integer key value',
		      2.7 => 'float key value',
          '6' => 'string integer key value'
	      }
      )
    end

    it 'can navigate a hash with an integer key using a dotted key' do
      expect(Lookup.lookup('mod::g.6', nil, 'not found', true, nil, invocation)).to eql('integer key value')
    end

    it 'can navigate a hash with a negative integer key using a dotted key' do
      expect(Lookup.lookup('mod::g.-4', nil, 'not found', true, nil, invocation)).to eql('negative integer key value')
    end

    it 'can navigate a hash with an string integer key using a dotted key with quoted integer' do
      expect(Lookup.lookup("mod::g.'6'", nil, 'not found', true, nil, invocation)).to eql('string integer key value')
    end

    context "with 'global_only' set to true in the invocation" do
      let(:invocation) { Invocation.new(scope).set_global_only }

      it 'finds data in global layer' do
        expect(Lookup.lookup('a', nil, nil, false, nil, invocation)).to eql('a (from global)')
      end

      it 'does not find data in environment layer' do
        expect(Lookup.lookup('b', nil, 'not found', true, nil, invocation)).to eql('not found')
      end

      it 'does not find data in module layer' do
        expect(Lookup.lookup('mod::c', nil, 'not found', true, nil, invocation)).to eql('not found')
      end
    end

    context "with 'global_only' set to true in the lookup adapter" do
      it 'finds data in global layer' do
        invocation.lookup_adapter.set_global_only
        expect(Lookup.lookup('a', nil, nil, false, nil, invocation)).to eql('a (from global)')
      end

      it 'does not find data in environment layer' do
        invocation.lookup_adapter.set_global_only
        expect(Lookup.lookup('b', nil, 'not found', true, nil, invocation)).to eql('not found')
      end

      it 'does not find data in module layer' do
        invocation.lookup_adapter.set_global_only
        expect(Lookup.lookup('mod::c', nil, 'not found', true, nil, invocation)).to eql('not found')
      end
    end

    context 'with subclassed lookup adpater' do
      let(:other_dir) { tmpdir('other') }
      let(:other_dir_content) do
        {
          'hiera.yaml' => <<-YAML.unindent,
            version: 5
            hierarchy:
              - name: Common
                path: common.yaml
              - name: More
                path: more.yaml
            YAML
          'data' => {
            'common.yaml' => <<-YAML.unindent,
              a: a (from other global)
              d: d (from other global)
              mixed_adapter_hash:
                a:
                  ab: value a.ab (from other common global)
                  ad: value a.ad (from other common global)
              mod::e: mod::e (from other global)
              lookup_options:
                mixed_adapter_hash:
                  merge: deep
              YAML
            'more.yaml' => <<-YAML.unindent
              mixed_adapter_hash:
                a:
                  aa: value a.aa (from other more global)
                  ac: value a.ac (from other more global)
              YAML
          }
        }
      end

      let(:populated_other_dir) do
        dir_contained_in(other_dir, other_dir_content)
        other_dir
      end

      before(:each) do
        eval(<<-RUBY.unindent)
        class SpecialLookupAdapter < LookupAdapter
           def initialize(compiler)
             super
             set_global_only
             set_global_hiera_config_path(File.join('#{populated_other_dir}', 'hiera.yaml'))
           end
        end
        RUBY
      end

      after(:each) do
        Puppet::Pops::Lookup.send(:remove_const, :SpecialLookupAdapter)
      end

      let(:other_invocation) { Invocation.new(scope, EMPTY_HASH, EMPTY_HASH, nil, SpecialLookupAdapter) }

      it 'finds different data in global layer' do
        expect(Lookup.lookup('a', nil, nil, false, nil, other_invocation)).to eql('a (from other global)')
        expect(Lookup.lookup('a', nil, nil, false, nil, invocation)).to eql('a (from global)')
      end

      it 'does not find data in environment layer' do
        expect(Lookup.lookup('b', nil, 'not found', true, nil, other_invocation)).to eql('not found')
        expect(Lookup.lookup('b', nil, 'not found', true, nil, invocation)).to eql('b (from environment)')
      end

      it 'does not find data in module layer' do
        expect(Lookup.lookup('mod::c', nil, 'not found', true, nil, other_invocation)).to eql('not found')
        expect(Lookup.lookup('mod::c', nil, 'not found', true, nil, invocation)).to eql('mod::c (from module)')
      end

      it 'resolves lookup options using the custom adapter' do
        expect(Lookup.lookup('mixed_adapter_hash', nil, 'not found', true, nil, other_invocation)).to eql(
          {
            'a' => {
              'aa' => 'value a.aa (from other more global)',
              'ab' => 'value a.ab (from other common global)',
              'ac' => 'value a.ac (from other more global)',
              'ad' => 'value a.ad (from other common global)'
            }
          }
        )
      end
    end
  end

  context 'when using plan_hierarchy' do
    let(:code_dir_content) do
      {
        'hiera.yaml' => <<-YAML.unindent,
        version: 5
        plan_hierarchy:
          - path: foo.yaml
            name: Common
        YAML
        'data' => {
          'foo.yaml' => <<-YAML.unindent
          pop: star
          YAML
        }
      }
    end

    it 'uses plan_hierarchy when using ScriptCompiler' do
      Puppet.override(pal_compiler: pal_compiler) do
        expect(Lookup.lookup('pop', nil, nil, true, nil, invocation)).to eq('star')
      end
    end
  end
end
end
end