puppet 6.27.0 → 7.0.0

data/spec/unit/parser/environment_compiler_spec.rb

@@ -1,730 +0,0 @@
-require 'spec_helper'
-require 'puppet_spec/compiler'
-require 'puppet/parser/environment_compiler'
-
-describe "Application instantiation" do
-  include PuppetSpec::Compiler
-
-  let(:env) { Puppet::Node::Environment.create(:testing, []) }
-  let(:node) { Puppet::Node.new('test', :environment => env) }
-  let(:loaders) { Puppet::Pops::Loaders.new(env) }
-  let(:logs) { [] }
-  let(:notices) { logs.select { |log| log.level == :notice }.map { |log| log.message } }
-  let(:warnings) { logs.select { |log| log.level == :warning }.map { |log| log.message } }
-
-  def compile_collect_log(string)
-    Puppet::Util::Log.with_destination(Puppet::Test::LogCollector.new(logs)) do
-      compile_to_catalog(string, Puppet::Node.new('other', :environment => env))
-    end
-  end
-
-  def compile_to_env_catalog(string, code_id=nil)
-    Puppet[:code] = string
-    Puppet::Parser::EnvironmentCompiler.compile(env, code_id).filter { |r| r.virtual? }
-  end
-
-  before(:each) do
-    allow_any_instance_of(Puppet::Parser::Compiler).to receive(:loaders).and_return(loaders)
-    allow_any_instance_of(Puppet::Parser::EnvironmentCompiler).to receive(:loaders).and_return(loaders)
-    Puppet.push_context({:loaders => loaders, :current_environment => env})
-    Puppet::Type.newtype :cap, :is_capability => true do
-      newparam :name
-      newparam :host
-    end
-  end
-
-  after(:each) do
-    Puppet::Type.rmtype(:cap)
-    Puppet.pop_context()
-  end
-
-  MANIFEST = <<-EOS
-      define prod($host) {
-        notify { "host ${host}":}
-      }
-
-      Prod produces Cap { }
-
-      define cons($host) {
-        notify { "host ${host}": }
-      }
-
-      Cons consumes Cap { }
-
-      application app {
-        prod { one: host => ahost, export => Cap[cap] }
-        cons { two: host => ahost, consume => Cap[cap] }
-        cons { three: consume => Cap[cap] }
-      }
-
-      site {
-        app { anapp:
-          nodes => {
-            Node[first] => Prod[one],
-            Node[second] => Cons[two]
-          }
-        }
-      }
-EOS
-
-MANIFEST_WO_EXPORT = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      cons { two: host => ahost, consume => Cap[cap] }
-    }
-
-    site {
-      app { anapp:
-        nodes => {
-          Node[first] => Prod[one],
-          Node[second] => Cons[two]
-        }
-      }
-    }
-EOS
-
-MANIFEST_WO_NODE = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      prod { one: host => ahost, export => Cap[cap] }
-      cons { two: host => ahost, consume => Cap[cap] }
-    }
-
-    site {
-      app { anapp:
-      }
-    }
-EOS
-
-MANIFEST_WITH_STRING_NODES = <<-EOS
-    application app {
-    }
-
-    site {
-      app { anapp:
-        nodes => "foobar",
-      }
-    }
-EOS
-
-MANIFEST_WITH_FALSE_NODES = <<-EOS
-    application app {
-    }
-
-    site {
-      app { anapp:
-        nodes => false,
-      }
-    }
-EOS
-
-MANIFEST_REQ_WO_EXPORT = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      cons { two: host => ahost, require => Cap[cap] }
-    }
-
-    site {
-      app { anapp:
-        nodes => {
-          Node[first] => Prod[one],
-          Node[second] => Cons[two]
-        }
-      }
-    }
-EOS
-
-MANIFEST_WITH_DOUBLE_EXPORT = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      prod { one: host => ahost, export => Cap[cap] }
-      prod { two: host => anotherhost, export => Cap[cap] }
-      cons { two: host => ahost, consume => Cap[cap] }
-    }
-
-    site {
-      app { anapp:
-        nodes => {
-          Node[first] => Prod[one],
-          Node[second] => Cons[two]
-        }
-      }
-    }
-EOS
-
-FAULTY_MANIFEST = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      prod { one: host => ahost, export => Cap[cap] }
-      cons { two: host => ahost, consume => Cap[cap] }
-    }
-
-    # app is not in site => error
-    app { anapp:
-      nodes => {
-        Node[first] => Prod[one],
-        Node[second] => Cons[two]
-      }
-    }
-EOS
-
-MANIFEST_WITH_SITE = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      prod { one: host => ahost, export => Cap[cap] }
-      cons { two: host => ahost, consume => Cap[cap] }
-    }
-
-    $one = not_the_value_one
-    $two = two
-
-    node default {
-      notify { "on a node": }
-    }
-
-    notify { 'ignore me': }
-
-    site {
-      $one = one
-      app { anapp:
-        nodes => {
-          Node[first] => Prod[$one],
-          Node[second] => Cons[$two]
-        }
-      }
-    }
-EOS
-
-MANIFEST_WITH_ILLEGAL_RESOURCE = <<-EOS
-    define prod($host) {
-      notify { "host ${host}":}
-    }
-
-    Prod produces Cap { }
-
-    define cons($host) {
-      notify { "host ${host}": }
-    }
-
-    Cons consumes Cap { }
-
-    application app {
-      prod { one: host => ahost, export => Cap[cap] }
-      cons { two: consume => Cap[cap] }
-    }
-
-    site {
-      # The rouge expression is here
-      notify { 'fail me': }
-      $one = one
-      app { anapp:
-        nodes => {
-          Node[first] => Prod[one],
-          Node[second] => Cons[two]
-        }
-      }
-    }
-EOS
-
-MANIFEST_WITH_CLASS = <<-EOS
-    define test($host) {
-      notify { "c $host": }
-    }
-
-    class prod($host) {
-      notify { "p $host": }
-    }
-
-    class cons($host) {
-      test { c: host => $host }
-    }
-
-    Class[prod] produces Cap {}
-
-    Class[cons] consumes Cap {}
-
-    application app {
-      class { prod: host => 'ahost', export => Cap[cap]}
-      class { cons: consume => Cap[cap]}
-    }
-
-    site {
-      app { anapp:
-        nodes => {
-          Node[first] => Class[prod],
-          Node[second] => Class[cons]
-        }
-      }
-    }
-EOS
-
-
-  context 'a node catalog' do
-    it "is unaffected for a non-participating node" do
-      catalog = compile_to_catalog(MANIFEST, Puppet::Node.new('other', :environment => env))
-      types = catalog.resource_keys.map { |type, _| type }.uniq.sort
-      expect(types).to eq(["Class", "Stage"])
-    end
-
-    it "an application instance must be contained in a site" do
-      expect { compile_to_catalog(FAULTY_MANIFEST, Puppet::Node.new('first', :environment => env))
-      }.to raise_error(/Application instances .* can only be contained within a Site/)
-    end
-
-    it "does not raise an error when node mappings are not provided" do
-      expect { compile_to_catalog(MANIFEST_WO_NODE, node) }.to_not raise_error
-    end
-
-    it "raises an error if node mapping is a string" do
-      expect { compile_to_catalog(MANIFEST_WITH_STRING_NODES, node)
-      }.to raise_error(/Invalid node mapping in .*: Mapping must be a hash/)
-    end
-
-    it "raises an error if node mapping is false" do
-      expect { compile_to_catalog(MANIFEST_WITH_FALSE_NODES, node)
-      }.to raise_error(/Invalid node mapping in .*: Mapping must be a hash/)
-    end
-
-    it "detects that consumed capability is never exported" do
-      expect { compile_to_env_catalog(MANIFEST_WO_EXPORT)
-      }.to raise_error(/Capability 'Cap\[cap\]' referenced by 'consume' is never exported/)
-    end
-
-    it "detects that required capability is never exported" do
-      expect { compile_to_env_catalog(MANIFEST_REQ_WO_EXPORT)
-      }.to raise_error(/Capability 'Cap\[cap\]' referenced by 'require' is never exported/)
-    end
-
-    it "detects that a capability is exported more than once" do
-      expect { compile_to_env_catalog(MANIFEST_WITH_DOUBLE_EXPORT)
-      }.to raise_error(/'Cap\[cap\]' is exported by both 'Prod\[one\]' and 'Prod\[two\]'/)
-    end
-
-    it "issues deprecation warnings" do
-      expect {compile_collect_log(MANIFEST_WO_NODE)}.not_to raise_error
-      expect(warnings).to include(/Capability Mapping is deprecated/) # there are two of these
-      expect(warnings).to include(/Application is deprecated/)
-      expect(warnings).to include(/Site Definition is deprecated/)
-    end
-
-    context "for producing node" do
-      let(:compiled_node) { Puppet::Node.new('first', :environment => env) }
-      let(:compiled_catalog) { compile_to_catalog(MANIFEST, compiled_node)}
-
-      { "App[anapp]"         => 'application instance',
-        "Cap[cap]"           => 'capability resource',
-        "Prod[one]"          => 'component',
-        "Notify[host ahost]" => 'node resource'
-      }.each do |k,v|
-        it "contains the #{v} (#{k})" do
-            expect(compiled_catalog.resource(k)).not_to be_nil
-        end
-      end
-
-      it "does not contain the consumed resource (Cons[two])" do
-        expect(compiled_catalog.resource("Cons[two]")).to be_nil
-      end
-    end
-
-    context "for consuming node" do
-      let(:compiled_node) { Puppet::Node.new('second', :environment => env) }
-      let(:compiled_catalog) { compile_to_catalog(MANIFEST, compiled_node)}
-      let(:cap) {
-        the_cap = Puppet::Resource.new("Cap", "cap")
-        the_cap["host"] = "ahost"
-        the_cap
-      }
-
-      { "App[anapp]"         => 'application instance',
-        "Cap[cap]"           => 'capability resource',
-        "Cons[two]"          => 'component',
-        "Notify[host ahost]" => 'node resource'
-      }.each do |k,v|
-        it "contains the #{v} (#{k})" do
-            # Mock the connection to Puppet DB
-            expect(Puppet::Resource::CapabilityFinder).to receive(:find).and_return(cap)
-            expect(compiled_catalog.resource(k)).not_to be_nil
-        end
-      end
-
-      it "does not contain the produced resource (Prod[one])" do
-        # Mock the connection to Puppet DB
-        expect(Puppet::Resource::CapabilityFinder).to receive(:find).and_return(cap)
-        expect(compiled_catalog.resource("Prod[one]")).to be_nil
-      end
-    end
-
-    context "for node with class producer" do
-      let(:compiled_node) { Puppet::Node.new('first', :environment => env) }
-      let(:compiled_catalog) { compile_to_catalog(MANIFEST_WITH_CLASS, compiled_node)}
-
-      { "App[anapp]"      => 'application instance',
-        "Cap[cap]"        => 'capability resource',
-        "Class[prod]"     => 'class',
-        "Notify[p ahost]" => 'node resource'
-      }.each do |k,v|
-        it "contains the #{v} (#{k})" do
-          cat = compiled_catalog
-          expect(cat.resource(k)).not_to be_nil
-        end
-      end
-
-      it "does not contain the consumed resource (Class[cons])" do
-        expect(compiled_catalog.resource("Class[cons]")).to be_nil
-      end
-    end
-
-    context "for node with class consumer" do
-      let(:compiled_node) { Puppet::Node.new('second', :environment => env) }
-      let(:compiled_catalog) { compile_to_catalog(MANIFEST_WITH_CLASS, compiled_node)}
-      let(:cap) {
-        the_cap = Puppet::Resource.new("Cap", "cap")
-        the_cap["host"] = "ahost"
-        the_cap
-      }
-
-      { "App[anapp]"      => 'application instance',
-        "Cap[cap]"        => 'capability resource',
-        "Class[cons]"     => 'class',
-        "Notify[c ahost]" => 'node resource'
-      }.each do |k,v|
-        it "contains the #{v} (#{k})" do
-          # Mock the connection to Puppet DB
-          expect(Puppet::Resource::CapabilityFinder).to receive(:find).and_return(cap)
-          expect(compiled_catalog.resource(k)).not_to be_nil
-        end
-      end
-
-      it "does not contain the produced resource (Class[prod])" do
-        # Mock the connection to Puppet DB
-        expect(Puppet::Resource::CapabilityFinder).to receive(:find).and_return(cap)
-        expect(compiled_catalog.resource("Class[prod]")).to be_nil
-      end
-    end
-
-    context "when using a site expression" do
-      # The site expression must be evaluated in a node catalog compilation because
-      # the application instantiations inside it may contain other logic (local variables)
-      # that are used to instantiate an application. The application instances are needed.
-      #
-      it "the node expressions is evaluated" do
-        catalog = compile_to_catalog(MANIFEST_WITH_SITE, Puppet::Node.new('other', :environment => env))
-        types = catalog.resource_keys.map { |type, _| type }.uniq.sort
-        expect(types).to eq(["Class", "Node", "Notify", "Stage"])
-        expect(catalog.resource("Notify[on a node]")).to_not be_nil
-        expect(catalog.resource("Notify[on the site]")).to be_nil
-      end
-
-    end
-
-    context "when using a site expression" do
-      it "the site expression is not evaluated in a node compilation" do
-        catalog = compile_to_catalog(MANIFEST_WITH_SITE, Puppet::Node.new('other', :environment => env))
-        types = catalog.resource_keys.map { |type, _| type }.uniq.sort
-        expect(types).to eq(["Class", "Node", "Notify", "Stage"])
-        expect(catalog.resource("Notify[on a node]")).to_not be_nil
-        expect(catalog.resource("Notify[on the site]")).to be_nil
-      end
-
-    end
-  end
-
-  describe "in the environment catalog" do
-    it "does not fail if there is no site expression" do
-      expect {
-        compile_to_env_catalog(<<-EOC).to_resource
-          notify { 'ignore me':}
-        EOC
-      }.to_not raise_error()
-    end
-
-    it "ignores usage of hiera_include() at topscope for classification" do
-      expect(Puppet).to receive(:debug).with(/Ignoring hiera_include/)
-
-      expect {
-        compile_to_env_catalog(<<-EOC).to_resource
-          hiera_include('classes')
-          site { }
-        EOC
-      }.to_not raise_error()
-
-    end
-
-    it 'removes overriden functions after compile' do
-      expect {
-        compile_to_env_catalog(<<-EOC)
-          hiera_include('classes')
-          site { }
-        EOC
-      }.to_not raise_error()
-      func = Puppet::Pops::Loaders.loaders.puppet_system_loader.load(:function, 'hiera_include')
-      expect(func).to be_a(Puppet::Functions::Function)
-    end
-
-    it "includes components and capability resources" do
-      catalog = compile_to_env_catalog(MANIFEST).to_resource
-      apps = catalog.resources.select do |res|
-        res.resource_type && res.resource_type.application?
-      end
-      expect(apps.size).to eq(1)
-      app = apps.first
-      expect(app["nodes"]).not_to be_nil
-      comps = catalog.direct_dependents_of(app).map(&:ref).sort
-      expect(comps).to eq(["Cons[three]", "Cons[two]", "Prod[one]"])
-
-      prod = catalog.resource("Prod[one]")
-      expect(prod).not_to be_nil
-      expect(prod.export.map(&:ref)).to eq(["Cap[cap]"])
-
-      cons = catalog.resource("Cons[two]")
-      expect(cons).not_to be_nil
-      expect(cons[:consume].ref).to eq("Cap[cap]")
-    end
-
-    it "includes class components" do
-      catalog = compile_to_env_catalog(MANIFEST_WITH_CLASS).to_resource
-      classes = catalog.resources.select do |res|
-        res.type == 'Class' && (res.title == 'Prod' || res.title == 'Cons')
-      end
-      expect(classes.size).to eq(2)
-      expect(classes.map(&:ref).sort).to eq(["Class[Cons]", "Class[Prod]"])
-
-      prod = catalog.resource("Class[prod]")
-      expect(prod).not_to be_nil
-      expect(prod.export.map(&:ref)).to eq(["Cap[cap]"])
-
-      cons = catalog.resource("Class[cons]")
-      expect(cons).not_to be_nil
-      expect(cons[:consume].ref).to eq("Cap[cap]")
-    end
-
-    it "an application instance must be contained in a site" do
-      expect { compile_to_env_catalog(FAULTY_MANIFEST)
-      }.to raise_error(/Application instances .* can only be contained within a Site/)
-    end
-
-    context "when using a site expression" do
-      it "includes components and capability resources" do
-        catalog = compile_to_env_catalog(MANIFEST_WITH_SITE).to_resource
-        apps = catalog.resources.select do |res|
-          res.resource_type && res.resource_type.application?
-        end
-        expect(apps.size).to eq(1)
-        app = apps.first
-        expect(app["nodes"]).not_to be_nil
-        comps = catalog.direct_dependents_of(app).map(&:ref).sort
-        expect(comps).to eq(["Cons[two]", "Prod[one]"])
-
-        prod = catalog.resource("Prod[one]")
-        expect(prod).not_to be_nil
-        expect(prod.export.map(&:ref)).to eq(["Cap[cap]"])
-
-        cons = catalog.resource("Cons[two]")
-        expect(cons).not_to be_nil
-        expect(cons[:consume].ref).to eq("Cap[cap]")
-      end
-
-      it "the site expression is evaluated in an environment compilation" do
-        catalog = compile_to_env_catalog(MANIFEST_WITH_SITE).to_resource
-        types = catalog.resource_keys.map { |type, _| type }.uniq.sort
-        expect(types).to eq(["App", "Class", "Cons", "Prod", "Site", "Stage"])
-        expect(catalog.resource("Notify[on a node]")).to be_nil
-        apps = catalog.resources.select do |res|
-          res.resource_type && res.resource_type.application?
-        end
-        expect(apps.size).to eq(1)
-        app = apps.first
-        comps = catalog.direct_dependents_of(app).map(&:ref).sort
-        expect(comps).to eq(["Cons[two]", "Prod[one]"])
-      end
-
-      it "fails if there are non component resources in the site" do
-        expect {
-          compile_to_env_catalog(MANIFEST_WITH_ILLEGAL_RESOURCE).to_resource
-        }.to raise_error(/Only application components can appear inside a site - Notify\[fail me\] is not allowed \(line: 20\)/)
-      end
-    end
-
-    it "includes code_id if specified" do
-      catalog = compile_to_env_catalog(MANIFEST_WITH_SITE, "12345")
-      expect(catalog.code_id).to eq("12345")
-    end
-
-    it "omits code_id if unspecified" do
-      catalog = compile_to_env_catalog(MANIFEST_WITH_SITE)
-      expect(catalog.code_id).to be_nil
-    end
-  end
-
-
-  describe "when validation of nodes" do
-    it 'validates that the key of a node mapping is a Node' do
-      expect { compile_to_catalog(<<-EOS, Puppet::Node.new('other', :environment => env))
-        application app {
-        }
-
-        site {
-          app { anapp:
-            nodes => {
-              'hello' => Node[other],
-            }
-          }
-        }
-        EOS
-      }.to raise_error(Puppet::Error, /hello is not a Node/)
-    end
-
-    it 'validates that the value of a node mapping is a resource' do
-      expect { compile_to_catalog(<<-EOS, Puppet::Node.new('other', :environment => env))
-        application app {
-        }
-
-        site {
-          app { anapp:
-            nodes => {
-              Node[other] => 'hello'
-            }
-          }
-        }
-      EOS
-      }.to raise_error(Puppet::Error, /hello is not a resource/)
-    end
-
-    it 'validates that the value can be an array or resources' do
-      expect { compile_to_catalog(<<-EOS, Puppet::Node.new('other', :environment => env))
-        define p {
-          notify {$title:}
-        }
-
-        application app {
-          p{one:}
-          p{two:}
-        }
-
-        site {
-          app { anapp:
-            nodes => {
-              Node[other] => [P[one],P[two]]
-            }
-          }
-        }
-      EOS
-      }.not_to raise_error
-    end
-
-    it 'validates that the is bound to exactly one node' do
-      expect { compile_to_catalog(<<-EOS, Puppet::Node.new('first', :environment => env))
-        define p {
-          notify {$title:}
-        }
-
-        application app {
-          p{one:}
-        }
-
-        site {
-          app { anapp:
-            nodes => {
-              Node[first] => P[one],
-              Node[second] => P[one],
-            }
-          }
-        }
-      EOS
-      }.to raise_error(Puppet::Error, /maps component P\[one\] to multiple nodes/)
-    end
-  end
-
-  describe "site containing a resource named 'plan'" do
-    it 'finds an application named plan' do
-      expect {compile_collect_log(<<-PUPPET)}.not_to raise_error
-        define plan::node_file() {
-          file { "/tmp/plans/${name}.txt":
-            content => "this is ${name}.txt",
-          }
-        }
-        Plan::Node_file produces Node_file {}
-        application plan() {
-          plan::node_file { "node_file_${name}":
-            export => Node_file["node_file_${name}"]
-          }
-        }
-        site {
-          plan { "test":
-            nodes       => {
-              Node["test.example.com"] => Plan::Node_file["node_file_plan_test"],
-            }
-          }
-        }
-        PUPPET
-
-      expect(warnings).to include(/Use of future reserved word: 'plan'/)
-    end
-  end
-end