puppet 5.3.4 → 6.29.0

data/spec/unit/pops/loaders/loader_spec.rb

@@ -0,0 +1,516 @@
+require 'spec_helper'
+require 'puppet_spec/files'
+require 'puppet_spec/compiler'
+
+require 'puppet/pops'
+require 'puppet/loaders'
+
+module Puppet::Pops
+module Loader
+describe 'The Loader' do
+  include PuppetSpec::Compiler
+  include PuppetSpec::Files
+
+  before(:each) do
+    Puppet[:tasks] = true
+  end
+
+  let(:testing_env) do
+    {
+      'testing' => {
+        'functions' => functions,
+        'lib' => { 'puppet' => lib_puppet },
+        'manifests' => manifests,
+        'modules' => modules,
+        'plans' => plans,
+        'tasks' => tasks,
+        'types' => types,
+      }
+    }
+  end
+
+  let(:functions) { {} }
+  let(:manifests) { {} }
+  let(:modules) { {} }
+  let(:plans) { {} }
+  let(:lib_puppet) { {} }
+  let(:tasks) { {} }
+  let(:types) { {} }
+
+  let(:environments_dir) { Puppet[:environmentpath] }
+
+  let(:testing_env_dir) do
+    dir_contained_in(environments_dir, testing_env)
+    env_dir = File.join(environments_dir, 'testing')
+    PuppetSpec::Files.record_tmp(env_dir)
+    env_dir
+  end
+
+  let(:modules_dir) { File.join(testing_env_dir, 'modules') }
+  let(:env) { Puppet::Node::Environment.create(:testing, [modules_dir]) }
+  let(:node) { Puppet::Node.new('test', :environment => env) }
+  let(:loader) { Loaders.find_loader(nil) }
+  let(:tasks_feature) { false }
+
+  before(:each) do
+    Puppet[:tasks] = tasks_feature
+    loaders = Loaders.new(env)
+    Puppet.push_context(:loaders => loaders)
+    loaders.pre_load
+  end
+
+  after(:each) { Puppet.pop_context }
+
+  context 'when doing discovery' do
+    context 'of things' do
+      it 'finds statically basic types' do
+        expect(loader.discover(:type)).to include(tn(:type, 'integer'))
+      end
+
+      it 'finds statically loaded types' do
+        expect(loader.discover(:type)).to include(tn(:type, 'file'))
+      end
+
+      it 'finds statically loaded Object types' do
+        expect(loader.discover(:type)).to include(tn(:type, 'puppet::ast::accessexpression'))
+      end
+
+      context 'in environment' do
+        let(:types) {
+          {
+            'global.pp' => <<-PUPPET.unindent,
+              type Global = Integer
+              PUPPET
+            'environment' => {
+              'env.pp' => <<-PUPPET.unindent,
+                type Environment::Env = String
+                PUPPET
+            }
+          }
+        }
+
+        let(:functions) {
+          {
+            'globfunc.pp' => 'function globfunc() {}',
+            'environment' => {
+              'envfunc.pp' => 'function environment::envfunc() {}'
+            }
+          }
+        }
+
+        let(:lib_puppet) {
+          {
+            'functions' => {
+              'globrubyfunc.rb' => 'Puppet::Functions.create_function(:globrubyfunc) { def globrubyfunc; end }',
+              'environment' => {
+                'envrubyfunc.rb' => "Puppet::Functions.create_function(:'environment::envrubyfunc') { def envrubyfunc; end }",
+              }
+            }
+          }
+        }
+
+        it 'finds global types in environment' do
+          expect(loader.discover(:type)).to include(tn(:type, 'global'))
+        end
+
+        it 'finds global functions in environment' do
+          expect(loader.discover(:function)).to include(tn(:function, 'lookup'))
+        end
+
+        it 'finds types prefixed with Environment in environment' do
+          expect(loader.discover(:type)).to include(tn(:type, 'environment::env'))
+        end
+
+        it 'finds global functions in environment' do
+          expect(loader.discover(:function)).to include(tn(:function, 'globfunc'))
+        end
+
+        it 'finds functions prefixed with Environment in environment' do
+          expect(loader.discover(:function)).to include(tn(:function, 'environment::envfunc'))
+        end
+
+        it 'finds global ruby functions in environment' do
+          expect(loader.discover(:function)).to include(tn(:function, 'globrubyfunc'))
+        end
+
+        it 'finds ruby functions prefixed with Environment in environment' do
+          expect(loader.discover(:function)).to include(tn(:function, 'environment::envrubyfunc'))
+        end
+
+        it 'can filter the list of discovered entries using a block' do
+          expect(loader.discover(:function) { |t| t.name =~ /rubyfunc\z/ }).to contain_exactly(
+            tn(:function, 'environment::envrubyfunc'),
+            tn(:function, 'globrubyfunc')
+          )
+        end
+
+        context 'with multiple modules' do
+          let(:metadata_json_a) {
+              {
+                'name' => 'example/a',
+                'version' => '0.1.0',
+                'source' => 'git@github.com/example/example-a.git',
+                'dependencies' => [{'name' => 'c', 'version_range' => '>=0.1.0'}],
+                'author' => 'Bob the Builder',
+                'license' => 'Apache-2.0'
+              }
+          }
+
+          let(:metadata_json_b) {
+            {
+              'name' => 'example/b',
+              'version' => '0.1.0',
+              'source' => 'git@github.com/example/example-b.git',
+              'dependencies' => [{'name' => 'c', 'version_range' => '>=0.1.0'}],
+              'author' => 'Bob the Builder',
+              'license' => 'Apache-2.0'
+            }
+          }
+
+          let(:metadata_json_c) {
+            {
+              'name' => 'example/c',
+              'version' => '0.1.0',
+              'source' => 'git@github.com/example/example-c.git',
+              'dependencies' => [],
+              'author' => 'Bob the Builder',
+              'license' => 'Apache-2.0'
+            }
+          }
+
+          let(:modules) {
+            {
+              'a' => {
+                'functions' => a_functions,
+                'lib' => { 'puppet' => a_lib_puppet },
+                'plans' => a_plans,
+                'tasks' => a_tasks,
+                'types' => a_types,
+                'metadata.json' => metadata_json_a.to_json
+              },
+              'b' => {
+                'functions' => b_functions,
+                'lib' => { 'puppet' => b_lib_puppet },
+                'plans' => b_plans,
+                'tasks' => b_tasks,
+                'types' => b_types,
+                'metadata.json' => metadata_json_b.to_json
+              },
+              'c' => {
+                'types' => c_types,
+                'tasks' => c_tasks,
+                'metadata.json' => metadata_json_c.to_json
+              },
+            }
+          }
+
+          let(:a_plans) {
+            {
+              'aplan.pp' => <<-PUPPET.unindent,
+                plan a::aplan() {}
+                PUPPET
+            }
+          }
+
+          let(:a_types) {
+            {
+              'atype.pp' => <<-PUPPET.unindent,
+                type A::Atype = Integer
+                PUPPET
+            }
+          }
+
+          let(:a_tasks) {
+            {
+              'atask' => '',
+            }
+          }
+
+          let(:a_functions) {
+            {
+              'afunc.pp' => 'function a::afunc() {}',
+            }
+          }
+
+          let(:a_lib_puppet) {
+            {
+              'functions' => {
+                'a' => {
+                  'arubyfunc.rb' => "Puppet::Functions.create_function(:'a::arubyfunc') { def arubyfunc; end }",
+                }
+              }
+            }
+          }
+
+          let(:b_plans) {
+            {
+              'init.pp' => <<-PUPPET.unindent,
+                plan b() {}
+                PUPPET
+              'aplan.pp' => <<-PUPPET.unindent,
+                plan b::aplan() {}
+                PUPPET
+              'yamlplan.yaml' => '{}',
+              'conflict.yaml' => '{}',
+              'conflict.pp' => <<-PUPPET.unindent,
+                plan b::conflict() {}
+                PUPPET
+            }
+          }
+
+          let(:b_types) {
+            {
+              'atype.pp' => <<-PUPPET.unindent,
+                type B::Atype = Integer
+                PUPPET
+            }
+          }
+
+          let(:b_tasks) {
+            {
+              'init.json' => <<-JSON.unindent,
+                {
+                  "description": "test task b",
+                  "parameters": {}
+                }
+                JSON
+              'init.sh' => "# doing exactly nothing\n",
+              'atask' => "# doing exactly nothing\n",
+              'atask.json' => <<-JSON.unindent,
+                {
+                  "description": "test task b::atask",
+                  "input_method": "stdin",
+                  "parameters": {
+                    "string_param": {
+                      "description": "A string parameter",
+                      "type": "String[1]"
+                    },
+                    "int_param": {
+                      "description": "An integer parameter",
+                      "type": "Integer"
+                    }
+                  }
+                }
+                JSON
+            }
+          }
+
+          let(:b_functions) {
+            {
+              'afunc.pp' => 'function b::afunc() {}',
+            }
+          }
+
+          let(:b_lib_puppet) {
+            {
+              'functions' => {
+                'b' => {
+                  'arubyfunc.rb' => "Puppet::Functions.create_function(:'b::arubyfunc') { def arubyfunc; end }",
+                }
+              }
+            }
+          }
+
+          let(:c_types) {
+            {
+              'atype.pp' => <<-PUPPET.unindent,
+                type C::Atype = Integer
+            PUPPET
+            }
+          }
+
+          let(:c_tasks) {
+            {
+              'foo.sh' => <<-SH.unindent,
+                # This is a task that does nothing
+                SH
+              'fee.md' => <<-MD.unindent,
+                This is not a task because it has .md extension
+                MD
+              'fum.conf' => <<-CONF.unindent,
+                text=This is not a task because it has .conf extension
+                CONF
+              'bad_syntax.sh' => '',
+              'bad_syntax.json' => <<-TXT.unindent,
+                text => This is not a task because JSON is unparsable
+                TXT
+              'missing_adjacent.json' => <<-JSON.unindent,
+                {
+                  "description": "This is not a task because there is no adjacent file with the same base name",
+                  "parameters": { "string_param": { "type": "String[1]" } }
+                }
+                JSON
+            }
+          }
+
+          it 'private loader finds types in all modules' do
+            expect(loader.private_loader.discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(
+              contain_exactly(tn(:type, 'a::atype'), tn(:type, 'b::atype'), tn(:type, 'c::atype')))
+          end
+
+          it 'module loader finds types only in itself' do
+            expect(Loaders.find_loader('a').discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(
+              contain_exactly(tn(:type, 'a::atype')))
+          end
+
+          it 'private loader finds functions in all modules' do
+            expect(loader.private_loader.discover(:function) { |t| t.name =~ /^.::.*\z/ }).to(
+              contain_exactly(tn(:function, 'a::afunc'), tn(:function, 'b::afunc'), tn(:function, 'a::arubyfunc'), tn(:function, 'b::arubyfunc')))
+          end
+
+          it 'module loader finds functions only in itself' do
+            expect(Loaders.find_loader('a').discover(:function) { |t| t.name =~ /^.::.*\z/ }).to(
+              contain_exactly(tn(:function, 'a::afunc'), tn(:function, 'a::arubyfunc')))
+          end
+
+          it 'discover is only called once on dependent loader' do
+            times_called = 0
+            allow_any_instance_of(ModuleLoaders::FileBased).to receive(:discover).with(:type, nil, Pcore::RUNTIME_NAME_AUTHORITY) { times_called += 1 }.and_return([])
+            expect(loader.private_loader.discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(contain_exactly())
+            expect(times_called).to eq(4)
+          end
+
+          context 'with tasks enabled' do
+            let(:tasks_feature) { true }
+
+            it 'private loader finds plans in all modules' do
+              expect(loader.private_loader.discover(:plan) { |t| t.name =~ /^.(?:::.*)?\z/ }).to(
+                contain_exactly(tn(:plan, 'b'), tn(:plan, 'a::aplan'), tn(:plan, 'b::aplan'), tn(:plan, 'b::conflict')))
+            end
+
+            it 'module loader finds plans only in itself' do
+              expect(Loaders.find_loader('a').discover(:plan)).to(
+                contain_exactly(tn(:plan, 'a::aplan')))
+            end
+
+            context 'with a yaml plan instantiator defined' do
+              before :each do
+                Puppet.push_context(:yaml_plan_instantiator => double(:create => double('plan')))
+              end
+
+              after :each do
+                Puppet.pop_context
+              end
+
+              it 'module loader finds yaml plans' do
+                expect(Loaders.find_loader('b').discover(:plan)).to(
+                  include(tn(:plan, 'b::yamlplan')))
+              end
+
+              it 'module loader excludes plans with both .pp and .yaml versions' do
+                expect(Loaders.find_loader('b').discover(:plan)).not_to(
+                  include(tn(:plan, 'b::conflict')))
+              end
+            end
+
+            it 'private loader finds types in all modules' do
+              expect(loader.private_loader.discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(
+                contain_exactly(tn(:type, 'a::atype'), tn(:type, 'b::atype'), tn(:type, 'c::atype')))
+            end
+
+            it 'private loader finds tasks in all modules' do
+              expect(loader.private_loader.discover(:task) { |t| t.name =~ /^.(?:::.*)?\z/ }).to(
+                contain_exactly(tn(:task, 'a::atask'), tn(:task, 'b::atask'), tn(:task, 'b'), tn(:task, 'c::foo')))
+            end
+
+            it 'module loader finds types only in itself' do
+              expect(Loaders.find_loader('a').discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(
+                contain_exactly(tn(:type, 'a::atype')))
+            end
+
+            it 'module loader finds tasks only in itself' do
+              expect(Loaders.find_loader('a').discover(:task) { |t| t.name =~ /^.::.*\z/ }).to(
+                contain_exactly(tn(:task, 'a::atask')))
+            end
+
+            it 'module loader does not consider files with .md and .conf extension to be tasks' do
+              expect(Loaders.find_loader('c').discover(:task) { |t| t.name =~ /(?:foo|fee|fum)\z/ }).to(
+                contain_exactly(tn(:task, 'c::foo')))
+            end
+
+            it 'without error_collector, invalid task metadata results in warnings' do
+              logs = []
+              Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
+                expect(Loaders.find_loader('c').discover(:task)).to(
+                  contain_exactly(tn(:task, 'c::foo')))
+              end
+              expect(logs.select { |log| log.level == :warning }.map { |log| log.message }).to(
+                contain_exactly(/unexpected token/, /No source besides task metadata was found/)
+              )
+            end
+
+            it 'with error_collector, errors are collected and no warnings are logged' do
+              logs = []
+              error_collector = []
+              Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
+                expect(Loaders.find_loader('c').discover(:task, error_collector)).to(
+                  contain_exactly(tn(:task, 'c::foo')))
+              end
+              expect(logs.select { |log| log.level == :warning }.map { |log| log.message }).to be_empty
+              expect(error_collector.size).to eql(2)
+              expect(error_collector.all? { |e| e.is_a?(Puppet::DataTypes::Error) })
+              expect(error_collector.all? { |e| e.issue_code == Puppet::Pops::Issues::LOADER_FAILURE.issue_code })
+              expect(error_collector.map { |e| e.details['original_error'] }).to(
+                contain_exactly(/unexpected token/, /No source besides task metadata was found/)
+              )
+            end
+
+            context 'and an environment without directory' do
+              let(:environments_dir) { tmpdir('loader_spec') }
+              let(:env) { Puppet::Node::Environment.create(:none_such, [modules_dir]) }
+
+              it 'an EmptyLoader is used and module loader finds types' do
+                expect_any_instance_of(Puppet::Pops::Loader::ModuleLoaders::EmptyLoader).to receive(:find).and_return(nil)
+                expect(Loaders.find_loader('a').discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(
+                  contain_exactly(tn(:type, 'a::atype')))
+              end
+
+              it 'an EmptyLoader is used and module loader finds tasks' do
+                expect_any_instance_of(Puppet::Pops::Loader::ModuleLoaders::EmptyLoader).to receive(:find).and_return(nil)
+                expect(Loaders.find_loader('a').discover(:task) { |t| t.name =~ /^.::.*\z/ }).to(
+                  contain_exactly(tn(:task, 'a::atask')))
+              end
+            end
+          end
+
+          context 'with no explicit dependencies' do
+            let(:modules) do
+              {
+                'a' => {
+                  'functions' => a_functions,
+                  'lib' => { 'puppet' => a_lib_puppet },
+                  'plans' => a_plans,
+                  'tasks' => a_tasks,
+                  'types' => a_types,
+                },
+                'b' => {
+                  'functions' => b_functions,
+                  'lib' => { 'puppet' => b_lib_puppet },
+                  'plans' => b_plans,
+                  'tasks' => b_tasks,
+                  'types' => b_types,
+                },
+                'c' => {
+                  'types' => c_types,
+                },
+              }
+            end
+
+            it 'discover is only called once on dependent loader' do
+              times_called = 0
+              allow_any_instance_of(ModuleLoaders::FileBased).to receive(:discover).with(:type, nil, Pcore::RUNTIME_NAME_AUTHORITY) { times_called += 1 }.and_return([])
+              expect(loader.private_loader.discover(:type) { |t| t.name =~ /^.::.*\z/ }).to(contain_exactly())
+              expect(times_called).to eq(4)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def tn(type, name)
+    TypedName.new(type, name)
+  end
+end
+end
+end