puppet 6.21.1 → 6.22.1

data/spec/integration/util/windows/adsi_spec.rb

@@ -55,6 +55,24 @@ describe Puppet::Util::Windows::ADSI::User,
       end
     end
   end
+
+  describe '.current_user_name_with_format' do
+    context 'when desired format is NameSamCompatible' do
+      it 'should get the same user name as the current_user_name method but fully qualified' do
+        user_name = Puppet::Util::Windows::ADSI::User.current_user_name
+        fully_qualified_user_name = Puppet::Util::Windows::ADSI::User.current_sam_compatible_user_name
+
+        expect(fully_qualified_user_name).to match(/^.+\\#{user_name}$/)
+      end
+
+      it 'should have the same SID as with the current_user_name method' do
+        user_name = Puppet::Util::Windows::ADSI::User.current_user_name
+        fully_qualified_user_name = Puppet::Util::Windows::ADSI::User.current_sam_compatible_user_name
+
+        expect(Puppet::Util::Windows::SID.name_to_sid(user_name)).to eq(Puppet::Util::Windows::SID.name_to_sid(fully_qualified_user_name))
+      end
+    end
+  end
 end
 
 describe Puppet::Util::Windows::ADSI::Group,

data/spec/integration/util/windows/principal_spec.rb

@@ -7,6 +7,7 @@ describe Puppet::Util::Windows::SID::Principal, :if => Puppet::Util::Platform.wi
   let (:system_bytes) { [1, 1, 0, 0, 0, 0, 0, 5, 18, 0, 0, 0] }
   let (:null_sid_bytes) { [1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] }
   let (:administrator_bytes) { [1, 2, 0, 0, 0, 0, 0, 5, 32, 0, 0, 0, 32, 2, 0, 0] }
+  let (:all_application_packages_bytes) { [1, 2, 0, 0, 0, 0, 0, 15, 2, 0, 0, 0, 1, 0, 0, 0] }
   let (:computer_sid) { Puppet::Util::Windows::SID.name_to_principal(Puppet::Util::Windows::ADSI.computer_name) }
   # BUILTIN is localized on German Windows, but not French
   # looking this up like this dilutes the values of the tests as we're comparing two mechanisms
@@ -121,6 +122,26 @@ describe Puppet::Util::Windows::SID::Principal, :if => Puppet::Util::Platform.wi
       expect(principal.to_s).to eq(builtin_localized)
     end
 
+    it "should always sanitize the account name first" do
+      expect(Puppet::Util::Windows::SID::Principal).to receive(:sanitize_account_name).with('NT AUTHORITY\\SYSTEM').and_call_original
+      Puppet::Util::Windows::SID::Principal.lookup_account_name('NT AUTHORITY\\SYSTEM')
+    end
+
+    it "should be able to create an instance from an account name prefixed by APPLICATION PACKAGE AUTHORITY" do
+      principal = Puppet::Util::Windows::SID::Principal.lookup_account_name('APPLICATION PACKAGE AUTHORITY\\ALL APPLICATION PACKAGES')
+      expect(principal.account).to eq('ALL APPLICATION PACKAGES')
+      expect(principal.sid_bytes).to eq(all_application_packages_bytes)
+      expect(principal.sid).to eq('S-1-15-2-1')
+      expect(principal.domain).to eq('APPLICATION PACKAGE AUTHORITY')
+      expect(principal.domain_account).to eq('APPLICATION PACKAGE AUTHORITY\\ALL APPLICATION PACKAGES')
+      expect(principal.account_type).to eq(:SidTypeWellKnownGroup)
+      expect(principal.to_s).to eq('APPLICATION PACKAGE AUTHORITY\\ALL APPLICATION PACKAGES')
+    end
+
+    it "should fail without proper account name sanitization when it is prefixed by APPLICATION PACKAGE AUTHORITY" do
+      given_account_name = 'APPLICATION PACKAGE AUTHORITY\\ALL APPLICATION PACKAGES'
+      expect { Puppet::Util::Windows::SID::Principal.lookup_account_name(nil, false, given_account_name) }.to raise_error(Puppet::Util::Windows::Error, /No mapping between account names and security IDs was done./)
+    end
   end
 
   describe ".lookup_account_sid" do

data/spec/integration/util/windows/registry_spec.rb

@@ -263,6 +263,12 @@ describe Puppet::Util::Windows::Registry do
           type: Win32::Registry::REG_EXPAND_SZ,
           value: "\0\0\0reg expand string",
           expected_value: ""
+        },
+        {
+          name: 'REG_EXPAND_SZ_2',
+          type: Win32::Registry::REG_EXPAND_SZ,
+          value: "1\x002\x003\x004\x00\x00\x00\x90\xD8UoY".force_encoding("UTF-16LE"),
+          expected_value: "1234"
         }
       ].each do |pair|
         it 'reads up to the first wide null' do

data/spec/spec_helper.rb

@@ -160,10 +160,20 @@ RSpec.configure do |config|
   PUPPET_FACTER_2_GCE_URL = %r{^http://metadata/computeMetadata/v1(beta1)?}.freeze
   PUPPET_FACTER_3_GCE_URL = "http://metadata.google.internal/computeMetadata/v1/?recursive=true&alt=json".freeze
 
+  # Facter azure metadata endpoint
+  PUPPET_FACTER_AZ_URL = "http://169.254.169.254/metadata/instance?api-version=2020-09-01"
+
+  # Facter EC2 endpoint
+  PUPPET_FACTER_EC2_METADATA_URL = 'http://169.254.169.254/latest/meta-data/'
+  PUPPET_FACTER_EC2_USERDATA_URL = 'http://169.254.169.254/latest/user-data/'
+
   config.around :each do |example|
-    # Ignore requests from Facter GCE fact in Travis
+    # Ignore requests from Facter to external services
     stub_request(:get, PUPPET_FACTER_2_GCE_URL)
     stub_request(:get, PUPPET_FACTER_3_GCE_URL)
+    stub_request(:get, PUPPET_FACTER_AZ_URL)
+    stub_request(:get, PUPPET_FACTER_EC2_METADATA_URL)
+    stub_request(:get, PUPPET_FACTER_EC2_USERDATA_URL)
 
     # Enable VCR if the example is tagged with `:vcr` metadata.
     if example.metadata[:vcr]

data/spec/unit/application/facts_spec.rb

@@ -3,7 +3,7 @@ require 'puppet/application/facts'
 
 describe Puppet::Application::Facts do
   let(:app) { Puppet::Application[:facts] }
-  let(:values) { {"filesystems" => "apfs,autofs,devfs", "macaddress" => "64:52:11:22:03:25"} }
+  let(:values) { {"filesystems" => "apfs,autofs,devfs", "macaddress" => "64:52:11:22:03:2e"} }
 
   before :each do
     Puppet::Node::Facts.indirection.terminus_class = :memory
@@ -21,7 +21,7 @@ describe Puppet::Application::Facts do
       name: whatever
       values:
         filesystems: apfs,autofs,devfs
-        macaddress: "64:52:11:22:03:25"
+        macaddress: "64:52:11:22:03:2e"
     END
 
     expect {
@@ -42,7 +42,7 @@ describe Puppet::Application::Facts do
       name: #{Puppet[:certname]}
       values:
         filesystems: apfs,autofs,devfs
-        macaddress: "64:52:11:22:03:25"
+        macaddress: "64:52:11:22:03:2e"
     END
 
     expect {
@@ -50,4 +50,483 @@ describe Puppet::Application::Facts do
     }.to exit_with(0)
      .and output(expected).to_stdout
   end
+
+  context 'when show action is called' do
+    let(:expected) { <<~END }
+      {
+        "filesystems": "apfs,autofs,devfs",
+        "macaddress": "64:52:11:22:03:2e"
+      }
+    END
+
+    before :each do
+      Puppet::Node::Facts.indirection.terminus_class = :facter
+      allow(Facter).to receive(:resolve).and_return(values)
+      app.command_line.args = %w{show}
+    end
+
+    it 'correctly displays facts with default formatting' do
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(expected).to_stdout
+    end
+
+    it 'displays a single fact value' do
+      app.command_line.args << 'filesystems' << '--value-only'
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output("apfs,autofs,devfs\n").to_stdout
+    end
+
+    it "warns and ignores value-only when multiple fact names are specified" do
+      app.command_line.args << 'filesystems' << 'macaddress' << '--value-only'
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(expected).to_stdout
+       .and output(/it can only be used when querying for a single fact/).to_stderr
+    end
+
+    {
+      "type_hash" => [{'a' => 2}, "{\n  \"a\": 2\n}"],
+      "type_array" => [[], "[\n\n]"],
+      "type_string" => ["str", "str"],
+      "type_int" => [1, "1"],
+      "type_float" => [1.0, "1.0"],
+      "type_true" => [true, "true"],
+      "type_false" => [false, "false"],
+      "type_nil" => [nil, ""],
+      "type_sym" => [:sym, "sym"]
+    }.each_pair do |name, values|
+      it "renders '#{name}' as '#{values.last}'" do
+        fact_value = values.first
+        fact_output = values.last
+
+        allow(Facter).to receive(:resolve).and_return({name => fact_value})
+
+        app.command_line.args << name << '--value-only'
+        expect {
+          app.run
+        }.to exit_with(0)
+         .and output("#{fact_output}\n").to_stdout
+      end
+    end
+  end
+
+  context 'when diff action is called' do
+    let(:facter3_facts) { <<~END }
+{
+  "hypervisors": {
+    "vmware": {
+      "version": ""
+    }
+  },
+  "networking": {
+    "interfaces": {
+      "lo": {
+        "bindings6": [
+          {
+            "network": "::1"
+          }
+        ]
+      },
+      "em0.1": {
+        "ip": "0.0.0.0"
+      }
+    }
+  },
+  "macaddress": "64:52:11:22:03:2e",
+  "obsolete_fact": "true",
+  "mountpoints": {
+    "/var": {
+      "options": [
+        "noatime",
+        "journaled",
+        "nobrowse"
+      ]
+    }
+  }
+}
+END
+
+    let(:facter4_facts) { <<~END }
+{
+  "hypervisors": {
+    "vmware": {
+      "version": "ESXi 6.7"
+    }
+  },
+  "networking": {
+    "interfaces": {
+      "lo": {
+        "bindings6": [
+          {
+            "network": "::1",
+            "scope6": "host"
+          }
+        ]
+      },
+      "em0.1": {
+        "ip": "127.0.0.1"
+      }
+    }
+  },
+  "macaddress": "64:52:11:22:03:2e",
+  "mountpoints": {
+    "/var": {
+      "options": [
+        "noatime",
+        "nobrowse",
+        "journaled"
+      ]
+    }
+  }
+}
+END
+
+    before :each do
+      Puppet::Node::Facts.indirection.terminus_class = :facter
+      app.command_line.args = %w{diff}
+
+      allow(Facter).to receive(:value).with('facterversion').and_return('3.99.0')
+      allow(Puppet::Util::Execution).to receive(:execute).with(/puppet facts show --no-facterng/, combine:false).and_return(facter3_facts)
+      allow(Puppet::Util::Execution).to receive(:execute).with(/puppet facts show --facterng/, combine:false).and_return(facter4_facts)
+    end
+
+    # Workaround for YAML issue on Ubuntu where null values get space as key
+    let(:regex) { false }
+    shared_examples_for 'correctly rendering output' do |render_format|
+      it 'correctly displays output' do
+        app.command_line.args << '--structured' if structured
+        app.command_line.args << '--exclude' << exclude if exclude
+        app.command_line.args << '--render-as' << render_format if render_format
+        expect {
+          app.run
+        }.to exit_with(0)
+         .and output(regex ? /#{expected_output}/ : expected_output).to_stdout
+      end
+    end
+
+    context 'when no exclude regex is provided via CLI' do
+      let(:exclude) { nil }
+      context 'when structured is requested' do
+        let(:structured) { true }
+        context 'when rendering is set to default' do
+          let(:expected_output) { <<~END }
+{
+  "hypervisors": {
+    "vmware": {
+      "version": {
+        "new_value": "ESXi 6.7",
+        "old_value": ""
+      }
+    }
+  },
+  "mountpoints": {
+    "/var": {
+      "options": {
+        "1": {
+          "new_value": "nobrowse",
+          "old_value": "journaled"
+        },
+        "2": {
+          "new_value": "journaled",
+          "old_value": "nobrowse"
+        }
+      }
+    }
+  },
+  "networking": {
+    "interfaces": {
+      "em0.1": {
+        "ip": {
+          "new_value": "127.0.0.1",
+          "old_value": "0.0.0.0"
+        }
+      },
+      "lo": {
+        "bindings6": {
+          "0": {
+            "scope6": {
+              "new_value": "host",
+              "old_value": null
+            }
+          }
+        }
+      }
+    }
+  },
+  "obsolete_fact": {
+    "new_value": null,
+    "old_value": "true"
+  }
+}
+END
+
+          it_behaves_like 'correctly rendering output'
+        end
+
+        context 'when rendering is set to yaml' do
+          # Workaround for YAML issue on Ubuntu where null values get space as key
+          let(:regex) { true }
+          let(:expected_output) { <<~END }
+---
+hypervisors:
+  vmware:
+    version:
+      :new_value: ESXi 6\.7
+      :old_value: ''
+mountpoints:
+  "/var":
+    options:
+      1:
+        :new_value: nobrowse
+        :old_value: journaled
+      2:
+        :new_value: journaled
+        :old_value: nobrowse
+networking:
+  interfaces:
+    em0\.1:
+      ip:
+        :new_value: 127\.0\.0\.1
+        :old_value: 0\.0\.0\.0
+    lo:
+      bindings6:
+        0:
+          scope6:
+            :new_value: host
+            :old_value:\s?
+obsolete_fact:
+  :new_value:\s?
+  :old_value: 'true'
+END
+
+          it_behaves_like 'correctly rendering output', 'yaml'
+        end
+
+        context 'when rendering is set to json' do
+          let(:expected_output) { <<~END }
+{"hypervisors":{"vmware":{"version":{"new_value":"ESXi 6.7","old_value":""}}},\
+"mountpoints":{"/var":{"options":{"1":{"new_value":"nobrowse","old_value":"journaled"},\
+"2":{"new_value":"journaled","old_value":"nobrowse"}}}},"networking":{"interfaces":\
+{"em0.1":{"ip":{"new_value":"127.0.0.1","old_value":"0.0.0.0"}},"lo":{"bindings6":\
+{"0":{"scope6":{"new_value":"host","old_value":null}}}}}},"obsolete_fact":\
+{"new_value":null,"old_value":"true"}}
+END
+
+          it_behaves_like 'correctly rendering output', 'json'
+        end
+      end
+
+      context 'when structured is not requested' do
+        let(:structured) { false }
+        context 'when rendering is set to default' do
+          let(:expected_output) { <<~END }
+{
+  "hypervisors.vmware.version": {
+    "new_value": "ESXi 6.7",
+    "old_value": ""
+  },
+  "mountpoints./var.options.1": {
+    "new_value": "nobrowse",
+    "old_value": "journaled"
+  },
+  "mountpoints./var.options.2": {
+    "new_value": "journaled",
+    "old_value": "nobrowse"
+  },
+  "networking.interfaces.\\"em0.1\\".ip": {
+    "new_value": "127.0.0.1",
+    "old_value": "0.0.0.0"
+  },
+  "networking.interfaces.lo.bindings6.0.scope6": {
+    "new_value": "host",
+    "old_value": null
+  },
+  "obsolete_fact": {
+    "new_value": null,
+    "old_value": "true"
+  }
+}
+END
+
+          it_behaves_like 'correctly rendering output'
+        end
+
+        context 'when rendering is set to yaml' do
+          # Workaround for YAML issue on Ubuntu where null values get space as key
+          let(:regex) { true }
+          let(:expected_output) { <<~END }
+---
+hypervisors\.vmware\.version:
+  :new_value: ESXi 6\.7
+  :old_value: ''
+mountpoints\./var\.options\.1:
+  :new_value: nobrowse
+  :old_value: journaled
+mountpoints\./var\.options\.2:
+  :new_value: journaled
+  :old_value: nobrowse
+networking\.interfaces\."em0\.1"\.ip:
+  :new_value: 127\.0\.0\.1
+  :old_value: 0\.0\.0\.0
+networking\.interfaces\.lo\.bindings6\.0\.scope6:
+  :new_value: host
+  :old_value:\s?
+obsolete_fact:
+  :new_value:\s?
+  :old_value: 'true'
+END
+
+          it_behaves_like 'correctly rendering output', 'yaml'
+        end
+
+        context 'when rendering is set to json' do
+          let(:expected_output) { <<~END }
+{"hypervisors.vmware.version":{"new_value":"ESXi 6.7","old_value":""},\
+"mountpoints./var.options.1":{"new_value":"nobrowse","old_value":"journaled"},\
+"mountpoints./var.options.2":{"new_value":"journaled","old_value":"nobrowse"},\
+"networking.interfaces.\\"em0.1\\".ip":{"new_value":"127.0.0.1",\
+"old_value":"0.0.0.0"},"networking.interfaces.lo.bindings6.0.scope6":\
+{"new_value":"host","old_value":null},"obsolete_fact":{"new_value":null,\
+"old_value":"true"}}
+END
+
+          it_behaves_like 'correctly rendering output', 'json'
+        end
+      end
+    end
+
+    context 'when unwanted facts are excluded from diff via CLI option' do
+      let(:exclude) { '^mountpoints\./var\.options.*$|^obsolete_fact$|^hypervisors' }
+      context 'when structured is requested' do
+        let(:structured) { true }
+        context 'when rendering is set to default' do
+          let(:expected_output) { <<~END }
+{
+  "networking": {
+    "interfaces": {
+      "em0.1": {
+        "ip": {
+          "new_value": "127.0.0.1",
+          "old_value": "0.0.0.0"
+        }
+      },
+      "lo": {
+        "bindings6": {
+          "0": {
+            "scope6": {
+              "new_value": "host",
+              "old_value": null
+            }
+          }
+        }
+      }
+    }
+  }
+}
+END
+
+          it_behaves_like 'correctly rendering output'
+        end
+
+        context 'when rendering is set to yaml' do
+          # Workaround for YAML issue on Ubuntu where null values get space as key
+          let(:regex) { true }
+          let(:expected_output) { <<~END }
+---
+networking:
+  interfaces:
+    em0\.1:
+      ip:
+        :new_value: 127\.0\.0\.1
+        :old_value: 0\.0\.0\.0
+    lo:
+      bindings6:
+        0:
+          scope6:
+            :new_value: host
+            :old_value:\s?
+END
+
+          it_behaves_like 'correctly rendering output', 'yaml'
+        end
+
+        context 'when rendering is set to json' do
+          let(:expected_output) { <<~END }
+{"networking":{"interfaces":{"em0.1":{"ip":{"new_value":"127.0.0.1",\
+"old_value":"0.0.0.0"}},"lo":{"bindings6":{"0":{"scope6":{"new_value":\
+"host","old_value":null}}}}}}}
+END
+
+          it_behaves_like 'correctly rendering output', 'json'
+        end
+      end
+
+      context 'when structured is not requested' do
+        let(:structured) { false }
+        context 'when rendering is set to default' do
+          let(:expected_output) { <<~END }
+{
+  "networking.interfaces.\\"em0.1\\".ip": {
+    "new_value": "127.0.0.1",
+    "old_value": "0.0.0.0"
+  },
+  "networking.interfaces.lo.bindings6.0.scope6": {
+    "new_value": "host",
+    "old_value": null
+  }
+}
+END
+
+          it_behaves_like 'correctly rendering output'
+        end
+
+        context 'when rendering is set to yaml' do
+          # Workaround for YAML issue on Ubuntu where null values get space as key
+          let(:regex) { true }
+          let(:expected_output) { <<~END }
+---
+networking\.interfaces\."em0\.1"\.ip:
+  :new_value: 127\.0\.0\.1
+  :old_value: 0\.0\.0\.0
+networking\.interfaces\.lo\.bindings6\.0\.scope6:
+  :new_value: host
+  :old_value:\s?
+END
+
+          it_behaves_like 'correctly rendering output', 'yaml'
+        end
+
+        context 'when rendering is set to json' do
+          let(:expected_output) { <<~END }
+{"networking.interfaces.\\"em0.1\\".ip":{"new_value":"127.0.0.1",\
+"old_value":"0.0.0.0"},"networking.interfaces.lo.bindings6.0.scope6":\
+{"new_value":"host","old_value":null}}
+END
+
+          it_behaves_like 'correctly rendering output', 'json'
+        end
+      end
+    end
+  end
+
+  context 'when default action is called' do
+    before :each do
+      Puppet::Node::Facts.indirection.terminus_class = :memory
+      facts = Puppet::Node::Facts.new('whatever', values)
+      Puppet::Node::Facts.indirection.save(facts)
+    end
+
+    it 'calls find action' do
+      expect {
+        app.run
+      }.to exit_with(0)
+       .and output(anything).to_stdout
+      expect(app.action.name).to eq(:find)
+    end
+  end
 end