puppet 7.29.1-x86-mingw32 → 8.0.1-x86-mingw32

data/spec/integration/data_binding_spec.rb

@@ -0,0 +1,278 @@
+require 'spec_helper'
+require 'puppet/indirector/hiera'
+
+require 'puppet_spec/compiler'
+require 'puppet/indirector/data_binding/hiera'
+
+describe "Data binding" do
+  include PuppetSpec::Files
+  include PuppetSpec::Compiler
+
+  let(:dir) { tmpdir("puppetdir") }
+  let(:data) {{
+    'global' => {
+      'testing::binding::value' => 'the value',
+      'testing::binding::calling_class' => '%{calling_class}',
+      'testing::binding::calling_class_path' => '%{calling_class_path}'
+    }
+  }}
+  let(:hash_data) {{
+    'global' => {
+      'testing::hash::options' => {
+        'key'  => 'value',
+        'port' => '80',
+        'bind' => 'localhost'
+      }
+    },
+    'agent.example.com' => {
+      'testing::hash::options' => {
+        'key'  => 'new value',
+        'port' => '443'
+      }
+    }
+  }}
+  let(:hash_data_with_lopts) {{
+    'global' => {
+      'testing::hash::options' => {
+        'key'  => 'value',
+        'port' => '80',
+        'bind' => 'localhost'
+      }
+    },
+    'agent.example.com' => {
+      'lookup_options' => {
+        'testing::hash::options' => {
+          'merge' => 'deep'
+        }
+      },
+      'testing::hash::options' => {
+        'key'  => 'new value',
+        'port' => '443'
+      }
+    }
+  }}
+
+  before do
+    # Drop all occurances of cached hiera instances. This will reset @hiera in Puppet::Indirector::Hiera, Testing::DataBinding::Hiera,
+    # and Puppet::DataBinding::Hiera. Different classes are active as indirection depending on configuration
+    ObjectSpace.each_object(Class).select {|klass| klass <= Puppet::Indirector::Hiera }.each { |klass| klass.instance_variable_set(:@hiera, nil) }
+    Puppet[:data_binding_terminus] = 'hiera'
+    Puppet[:modulepath] = dir
+  end
+
+  context "with testing::binding and global data only" do
+    it "looks up global data from hiera" do
+      configure_hiera_for_one_tier(data)
+
+      create_manifest_in_module("testing", "binding.pp",
+                                <<-MANIFEST)
+      class testing::binding($value,
+                             $calling_class,
+                             $calling_class_path,
+                             $calling_module = $module_name) {}
+      MANIFEST
+
+      catalog = compile_to_catalog("include testing::binding")
+      resource = catalog.resource('Class[testing::binding]')
+
+      expect(resource[:value]).to eq("the value")
+      expect(resource[:calling_class]).to eq("testing::binding")
+      expect(resource[:calling_class_path]).to eq("testing/binding")
+      expect(resource[:calling_module]).to eq("testing")
+    end
+  end
+
+  context "with testing::hash and global data only" do
+    it "looks up global data from hiera" do
+      configure_hiera_for_one_tier(hash_data)
+
+      create_manifest_in_module("testing", "hash.pp",
+                                <<-MANIFEST)
+      class testing::hash($options) {}
+      MANIFEST
+
+      catalog = compile_to_catalog("include testing::hash")
+      resource = catalog.resource('Class[testing::hash]')
+
+      expect(resource[:options]).to eq({
+	'key'  => 'value',
+	'port' => '80',
+	'bind' => 'localhost'
+      })
+    end
+  end
+
+  context "with custom clientcert" do
+    it "merges global data with agent.example.com data from hiera" do
+      configure_hiera_for_two_tier(hash_data)
+
+      create_manifest_in_module("testing", "hash.pp",
+                                <<-MANIFEST)
+      class testing::hash($options) {}
+      MANIFEST
+
+      catalog = compile_to_catalog("include testing::hash")
+      resource = catalog.resource('Class[testing::hash]')
+
+      expect(resource[:options]).to eq({
+            'key'  => 'new value',
+            'port' => '443',
+      })
+    end
+  end
+
+  context "with custom clientcert and with lookup_options" do
+    it "merges global data with agent.example.com data from hiera" do
+      configure_hiera_for_two_tier(hash_data_with_lopts)
+
+      create_manifest_in_module("testing", "hash.pp",
+                                <<-MANIFEST)
+      class testing::hash($options) {}
+      MANIFEST
+
+      catalog = compile_to_catalog("include testing::hash")
+      resource = catalog.resource('Class[testing::hash]')
+
+      expect(resource[:options]).to eq({
+        'key'  => 'new value',
+        'port' => '443',
+	      'bind' => 'localhost',
+      })
+    end
+  end
+
+  context "with plan_hierarchy key" do
+    context "using Hiera 5" do
+      let(:hiera_config) { <<~CONF  }
+      ---
+      version: 5
+      plan_hierarchy:
+        - path: global
+          name: Common
+      CONF
+
+      it "ignores plan_hierarchy outside of a Bolt plan" do
+        configure_hiera_for_plan_hierarchy(data, hiera_config)
+
+        create_manifest_in_module("testing", "binding.pp",
+                                  <<-MANIFEST)
+      class testing::binding($value) {}
+        MANIFEST
+
+        expect { compile_to_catalog("include testing::binding") }
+          .to raise_error(/Class\[Testing::Binding\]: expects a value for parameter 'value'/)
+      end
+    end
+
+    context "with invalid data" do
+      let(:hiera_config) { <<~CONF  }
+      ---
+      version: 5
+      plan_hierarchy:
+        - pop: the question
+      CONF
+
+      it "raises a validation error" do
+        configure_hiera_for_plan_hierarchy(data, hiera_config)
+
+        create_manifest_in_module("testing", "binding.pp",
+                                  <<-MANIFEST)
+      class testing::binding($value) {}
+        MANIFEST
+
+        expect { compile_to_catalog("include testing::binding") }
+          .to raise_error(/entry 'plan_hierarchy' index 0 unrecognized key 'pop'/)
+      end
+    end
+
+    context "with Hiera 3" do
+      let(:hiera_config) { <<~CONF  }
+      ---
+      plan_hierarchy: ['global']
+      CONF
+
+      it "errors with plan_hierarchy key" do
+        configure_hiera_for_plan_hierarchy(data, hiera_config)
+
+        create_manifest_in_module("testing", "binding.pp",
+                                  <<-MANIFEST)
+      class testing::binding($value) {}
+        MANIFEST
+
+        expect { compile_to_catalog("include testing::binding") }
+          .to raise_error(/unrecognized key 'plan_hierarchy'/)
+
+      end
+    end
+  end
+
+
+  def configure_hiera_for_one_tier(data)
+    hiera_config_file = tmpfile("hiera.yaml")
+
+    File.open(hiera_config_file, 'w:UTF-8') do |f|
+      f.write("---
+        :yaml:
+          :datadir: #{dir}
+        :hierarchy: ['global']
+        :logger: 'noop'
+        :backends: ['yaml']
+      ")
+    end
+
+    data.each do | file, contents |
+      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
+        f.write(YAML.dump(contents))
+      end
+    end
+
+    Puppet[:hiera_config] = hiera_config_file
+  end
+
+  def configure_hiera_for_plan_hierarchy(data, config)
+    hiera_config_file = tmpfile("hiera.yaml")
+
+    File.open(hiera_config_file, 'w:UTF-8') do |f|
+      f.write(config)
+    end
+
+    data.each do | file, contents |
+      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
+        f.write(YAML.dump(contents))
+      end
+    end
+
+    Puppet[:hiera_config] = hiera_config_file
+  end
+
+  def configure_hiera_for_two_tier(data)
+    hiera_config_file = tmpfile("hiera.yaml")
+
+    File.open(hiera_config_file, 'w:UTF-8') do |f|
+      f.write("---
+        :yaml:
+          :datadir: #{dir}
+        :hierarchy: ['agent.example.com', 'global']
+        :logger: 'noop'
+        :backends: ['yaml']
+      ")
+    end
+
+    data.each do | file, contents |
+      File.open(File.join(dir, "#{file}.yaml"), 'w:UTF-8') do |f|
+        f.write(YAML.dump(contents))
+      end
+    end
+
+    Puppet[:hiera_config] = hiera_config_file
+  end
+
+  def create_manifest_in_module(module_name, name, manifest)
+    module_dir = File.join(dir, module_name, 'manifests')
+    FileUtils.mkdir_p(module_dir)
+
+    File.open(File.join(module_dir, name), 'w:UTF-8') do |f|
+      f.write(manifest)
+    end
+  end
+end

data/spec/integration/defaults_spec.rb

@@ -0,0 +1,279 @@
+require 'spec_helper'
+
+require 'puppet/defaults'
+
+describe "Puppet defaults" do
+
+  describe "when default_manifest is set" do
+    it "returns ./manifests by default" do
+      expect(Puppet[:default_manifest]).to eq('./manifests')
+    end
+  end
+
+  describe "when disable_per_environment_manifest is set" do
+    it "returns false by default" do
+      expect(Puppet[:disable_per_environment_manifest]).to eq(false)
+    end
+
+    it "errors when set to true and default_manifest is not an absolute path" do
+      expect {
+        Puppet[:default_manifest] = './some/relative/manifest.pp'
+        Puppet[:disable_per_environment_manifest] = true
+      }.to raise_error Puppet::Settings::ValidationError, /'default_manifest' setting must be.*absolute/
+    end
+  end
+
+  describe "when setting the :masterport" do
+    it "should also set :serverport to the same value" do
+      Puppet.settings[:masterport] = 3939
+      expect(Puppet.settings[:serverport]).to eq(3939)
+    end
+
+    it "should not overwrite :serverport if explicitly set" do
+      Puppet.settings[:serverport] = 9000
+      Puppet.settings[:masterport] = 9001
+      expect(Puppet.settings[:serverport]).to eq(9000)
+    end
+  end
+
+  describe "when setting the :factpath" do
+    it "should add the :factpath to Facter's search paths" do
+      expect(Facter).to receive(:search).with("/my/fact/path")
+
+      Puppet.settings[:factpath] = "/my/fact/path"
+    end
+  end
+
+  describe "when setting the :certname" do
+    it "should fail if the certname is not downcased" do
+      expect { Puppet.settings[:certname] = "Host.Domain.Com" }.to raise_error(ArgumentError)
+    end
+
+    it 'can set it to a value containing all digits' do
+      Puppet.settings[:certname] = "000000000180"
+      expect(Puppet.settings[:certname]).to eq("000000000180")
+    end
+  end
+
+  describe "when setting :node_name_value" do
+    it "should default to the value of :certname" do
+      Puppet.settings[:certname] = 'blargle'
+      expect(Puppet.settings[:node_name_value]).to eq('blargle')
+    end
+  end
+
+  describe "when setting the :node_name_fact" do
+    it "should fail when also setting :node_name_value" do
+      expect do
+        Puppet.settings[:node_name_value] = "some value"
+        Puppet.settings[:node_name_fact] = "some_fact"
+      end.to raise_error("Cannot specify both the node_name_value and node_name_fact settings")
+    end
+
+    it "should not fail when using the default for :node_name_value" do
+      expect do
+        Puppet.settings[:node_name_fact] = "some_fact"
+      end.not_to raise_error
+    end
+  end
+
+  it "should have a clientyamldir setting" do
+    expect(Puppet.settings[:clientyamldir]).not_to be_nil
+  end
+
+  it "should have different values for the yamldir and clientyamldir" do
+    expect(Puppet.settings[:yamldir]).not_to eq(Puppet.settings[:clientyamldir])
+  end
+
+  it "should have a client_datadir setting" do
+    expect(Puppet.settings[:client_datadir]).not_to be_nil
+  end
+
+  it "should have different values for the server_datadir and client_datadir" do
+    expect(Puppet.settings[:server_datadir]).not_to eq(Puppet.settings[:client_datadir])
+  end
+
+  # See #1232
+  it "should not specify a user or group for the clientyamldir" do
+    expect(Puppet.settings.setting(:clientyamldir).owner).to be_nil
+    expect(Puppet.settings.setting(:clientyamldir).group).to be_nil
+  end
+
+  it "should use the service user and group for the yamldir" do
+    allow(Puppet.settings).to receive(:service_user_available?).and_return(true)
+    allow(Puppet.settings).to receive(:service_group_available?).and_return(true)
+    expect(Puppet.settings.setting(:yamldir).owner).to eq(Puppet.settings[:user])
+    expect(Puppet.settings.setting(:yamldir).group).to eq(Puppet.settings[:group])
+  end
+
+  it "should specify that the host private key should be owned by the service user" do
+    allow(Puppet.settings).to receive(:service_user_available?).and_return(true)
+    expect(Puppet.settings.setting(:hostprivkey).owner).to eq(Puppet.settings[:user])
+  end
+
+  it "should specify that the host certificate should be owned by the service user" do
+    allow(Puppet.settings).to receive(:service_user_available?).and_return(true)
+    expect(Puppet.settings.setting(:hostcert).owner).to eq(Puppet.settings[:user])
+  end
+
+  [:modulepath, :factpath].each do |setting|
+    it "should configure '#{setting}' not to be a file setting, so multi-directory settings are acceptable" do
+      expect(Puppet.settings.setting(setting)).to be_instance_of(Puppet::Settings::PathSetting)
+    end
+  end
+
+  describe "on a Unix-like platform it", :if => Puppet.features.posix? do
+    it "should add /usr/sbin and /sbin to the path if they're not there" do
+      Puppet::Util.withenv("PATH" => "/usr/bin#{File::PATH_SEPARATOR}/usr/local/bin") do
+        Puppet.settings[:path] = "none" # this causes it to ignore the setting
+        expect(ENV["PATH"].split(File::PATH_SEPARATOR)).to be_include("/usr/sbin")
+        expect(ENV["PATH"].split(File::PATH_SEPARATOR)).to be_include("/sbin")
+      end
+    end
+  end
+
+  describe "on a Windows-like platform it", :if => Puppet::Util::Platform.windows? do
+    let (:rune_utf8) { "\u16A0\u16C7\u16BB\u16EB\u16D2\u16E6\u16A6\u16EB\u16A0\u16B1\u16A9\u16A0\u16A2\u16B1\u16EB\u16A0\u16C1\u16B1\u16AA\u16EB\u16B7\u16D6\u16BB\u16B9\u16E6\u16DA\u16B3\u16A2\u16D7" }
+
+    it "path should not add anything" do
+      path = "c:\\windows\\system32#{File::PATH_SEPARATOR}c:\\windows"
+      Puppet::Util.withenv("PATH" => path) do
+        Puppet.settings[:path] = "none" # this causes it to ignore the setting
+        expect(ENV["PATH"]).to eq(path)
+      end
+    end
+
+    it "path should support UTF8 characters" do
+      path = "c:\\windows\\system32#{File::PATH_SEPARATOR}c:\\windows#{File::PATH_SEPARATOR}C:\\" + rune_utf8
+      Puppet::Util.withenv("PATH" => path) do
+        Puppet.settings[:path] = "none" # this causes it to ignore the setting
+
+        expect(ENV['Path']).to eq(path)
+      end
+    end
+  end
+
+  it "should default to json for the preferred serialization format" do
+    expect(Puppet.settings.value(:preferred_serialization_format)).to eq("json")
+  end
+
+  it "should default to true the disable_i18n setting" do
+    expect(Puppet.settings.value(:disable_i18n)).to eq(true)
+  end
+
+  it "should have a setting for determining the configuration version and should default to an empty string" do
+    expect(Puppet.settings[:config_version]).to eq("")
+  end
+
+  describe "when enabling reports" do
+    it "should use the default server value when report server is unspecified" do
+      Puppet.settings[:server] = "server"
+      expect(Puppet.settings[:report_server]).to eq("server")
+    end
+
+    it "should use the default serverport value when report port is unspecified" do
+      Puppet.settings[:serverport] = "1234"
+      expect(Puppet.settings[:report_port]).to eq(1234)
+    end
+
+    it "should use the default masterport value when report port is unspecified" do
+      Puppet.settings[:masterport] = "1234"
+      expect(Puppet.settings[:report_port]).to eq(1234)
+    end
+
+    it "should use report_port when set" do
+      Puppet.settings[:serverport] = "1234"
+      Puppet.settings[:report_port] = "5678"
+      expect(Puppet.settings[:report_port]).to eq(5678)
+    end
+  end
+
+  it "should have a 'prerun_command' that defaults to the empty string" do
+    expect(Puppet.settings[:prerun_command]).to eq("")
+  end
+
+  it "should have a 'postrun_command' that defaults to the empty string" do
+    expect(Puppet.settings[:postrun_command]).to eq("")
+  end
+
+  it "should have a 'certificate_revocation' setting that defaults to true" do
+    expect(Puppet.settings[:certificate_revocation]).to be_truthy
+  end
+
+  describe "reportdir" do
+    subject { Puppet.settings[:reportdir] }
+    it { is_expected.to eq("#{Puppet[:vardir]}/reports") }
+  end
+
+  describe "reporturl" do
+    subject { Puppet.settings[:reporturl] }
+    it { is_expected.to eq("http://localhost:3000/reports/upload") }
+  end
+
+  describe "when configuring color" do
+    subject { Puppet.settings[:color] }
+    it { is_expected.to eq("ansi") }
+  end
+
+  describe "daemonize" do
+    it "should default to true", :unless => Puppet::Util::Platform.windows? do
+      expect(Puppet.settings[:daemonize]).to eq(true)
+    end
+
+    describe "on Windows", :if => Puppet::Util::Platform.windows? do
+      it "should default to false" do
+        expect(Puppet.settings[:daemonize]).to eq(false)
+      end
+
+      it "should raise an error if set to true" do
+        expect { Puppet.settings[:daemonize] = true }.to raise_error(/Cannot daemonize on Windows/)
+      end
+    end
+  end
+
+  describe "diff" do
+    it "should default to 'diff' on POSIX", :unless => Puppet::Util::Platform.windows? do
+      expect(Puppet.settings[:diff]).to eq('diff')
+    end
+
+    it "should default to '' on Windows", :if => Puppet::Util::Platform.windows? do
+      expect(Puppet.settings[:diff]).to eq('')
+    end
+  end
+
+  describe "when configuring hiera" do
+    it "should have a hiera_config setting" do
+      expect(Puppet.settings[:hiera_config]).not_to be_nil
+    end
+  end
+
+  describe "when configuring the data_binding terminus" do
+    it "should have a data_binding_terminus setting" do
+      expect(Puppet.settings[:data_binding_terminus]).not_to be_nil
+    end
+
+    it "should be set to hiera by default" do
+      expect(Puppet.settings[:data_binding_terminus]).to eq(:hiera)
+    end
+
+    it "to be neither 'hiera' nor 'none', a deprecation warning is logged" do
+      expect(@logs).to eql([])
+      Puppet[:data_binding_terminus] = 'magic'
+      expect(@logs[0].to_s).to match(/Setting 'data_binding_terminus' is deprecated/)
+    end
+
+    it "to not log a warning if set to 'none' or 'hiera'" do
+      expect(@logs).to eql([])
+      Puppet[:data_binding_terminus] = 'none'
+      Puppet[:data_binding_terminus] = 'hiera'
+      expect(@logs).to eql([])
+    end
+  end
+
+  describe "agent_catalog_run_lockfile" do
+    it "(#2888) is not a file setting so it is absent from the Settings catalog" do
+      expect(Puppet.settings.setting(:agent_catalog_run_lockfile)).not_to be_a_kind_of Puppet::Settings::FileSetting
+      expect(Puppet.settings.setting(:agent_catalog_run_lockfile)).to be_a Puppet::Settings::StringSetting
+    end
+  end
+end

data/spec/integration/directory_environments_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe "directory environments" do
+  let(:args) { ['--configprint', 'modulepath', '--environment', 'direnv'] }
+  let(:puppet) { Puppet::Application[:apply] }
+
+  context "with a single directory environmentpath" do
+    before(:each) do
+      environmentdir = PuppetSpec::Files.tmpdir('envpath')
+      Puppet[:environmentpath] = environmentdir
+      FileUtils.mkdir_p(environmentdir + "/direnv/modules")
+    end
+
+    it "config prints the environments modulepath" do
+      Puppet.settings.initialize_global_settings(args)
+      expect {
+        puppet.run
+      }.to exit_with(0)
+       .and output(%r{/direnv/modules}).to_stdout
+    end
+
+    it "config prints the cli --modulepath despite environment" do
+      args << '--modulepath' << '/completely/different'
+      Puppet.settings.initialize_global_settings(args)
+      expect {
+        puppet.run
+      }.to exit_with(0)
+       .and output(%r{/completely/different}).to_stdout
+    end
+
+    it 'given an 8.3 style path on Windows, will config print an expanded path',
+      :if => Puppet::Util::Platform.windows? do
+
+      # ensure an 8.3 style path is set for environmentpath
+      shortened = Puppet::Util::Windows::File.get_short_pathname(Puppet[:environmentpath])
+      expanded = Puppet::FileSystem.expand_path(shortened)
+
+      Puppet[:environmentpath] = shortened
+      expect(Puppet[:environmentpath]).to match(/~/)
+
+      Puppet.settings.initialize_global_settings(args)
+      expect {
+        puppet.run
+      }.to exit_with(0)
+       .and output(a_string_matching(expanded)).to_stdout
+    end
+  end
+
+  context "with an environmentpath having multiple directories" do
+    let(:args) { ['--configprint', 'modulepath', '--environment', 'otherdirenv'] }
+
+    before(:each) do
+      envdir1 = File.join(Puppet[:confdir], 'env1')
+      envdir2 = File.join(Puppet[:confdir], 'env2')
+      Puppet[:environmentpath] = [envdir1, envdir2].join(File::PATH_SEPARATOR)
+      FileUtils.mkdir_p(envdir2 + "/otherdirenv/modules")
+    end
+
+    it "config prints a directory environment modulepath" do
+      Puppet.settings.initialize_global_settings(args)
+      expect {
+        puppet.run
+      }.to exit_with(0)
+       .and output(%r{otherdirenv/modules}).to_stdout
+    end
+  end
+end