chef 16.18.30 → 17.10.163

data/spec/functional/resource/windows_certificate_spec.rb

@@ -22,26 +22,68 @@ require "chef/resource/windows_certificate"
 describe Chef::Resource::WindowsCertificate, :windows_only do
   include Chef::Mixin::PowershellExec
 
-  def create_store
+  def create_store(store_location: "LocalMachine", store_name: store)
     powershell_exec <<~EOC
-      New-Item -Path Cert:\\LocalMachine\\#{store}
+      New-Item -Path Cert:\\#{store_location}\\#{store_name}
     EOC
   end
 
-  def delete_store
+  def delete_store(store_location: "LocalMachine", store_name: store)
     powershell_exec <<~EOC
-      Remove-Item -Path Cert:\\LocalMachine\\#{store} -Recurse
+      Remove-Item -Path Cert:\\#{store_location}\\#{store_name} -Recurse
     EOC
   end
 
-  def certificate_count
+  def certificate_count(store_location: "LocalMachine", store_name: store)
     powershell_exec(<<~EOC).result.to_i
-      (Get-ChildItem -Force -Path Cert:\\LocalMachine\\#{store} | measure).Count
+      (Get-ChildItem -Force -Path Cert:\\#{store_location}\\#{store_name} | measure).Count
+    EOC
+  end
+
+  def list_certificates(store_location: "LocalMachine", store_name: store)
+    powershell_exec(<<~EOC)
+      Get-ChildItem -Force -Path Cert:\\#{store_location}\\#{store_name} -Recurse
+    EOC
+  end
+
+  def refresh_certstore(store_location: "LocalMachine")
+    powershell_exec(<<~EOC)
+      Get-ChildItem -Force -Path Cert:\\#{store_location} -Recurse
     EOC
   end
 
   let(:password) { "P@ssw0rd!" }
   let(:store) { "Chef-Functional-Test" }
+  let(:store_name) { "MY" }
+  let(:store_location) { "LocalMachine" }
+  let(:test_cert_body) do
+    <<~CERT
+-----BEGIN CERTIFICATE-----
+MIIDQTCCAimgAwIBAgIQX3zqNCJbsKlEvzCz3Z9aNDANBgkqhkiG9w0BAQsFADAh
+MR8wHQYDVQQDDBZ3d3cuZHVtbXljaGVmdGVzdHMuY29tMCAXDTIwMDMwNTEwMjcw
+NVoYDzIxMjAwMzA1MTAzNzA2WjAhMR8wHQYDVQQDDBZ3d3cuZHVtbXljaGVmdGVz
+dHMuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtuYKDb6woWIH
+HPPOrcVpgJFVxbkjgk+tsYwbIiqR9jtRaKE6nM/awOgn9/dFF4k8KB8Em0sUx7Vq
+J3YhK2N2cAacgP2Frqqf5znpNBBOg968RoZzGx0EiXFvLsqC4y8ggApWTbMXPRk4
+1a7GlpUpSqI3y5cLeEbzwGQKu8I1I+v7P2fTlnJPHarM7sBbL8bieukkFHYu78iV
+u1wpKOCCfs5DTmJu8WN+z1Mar9vyrWMBlt2wBBgNHPz5mcXUzJHTzaI/D9RGgBgF
+V0IkNqISx/IzR62jjj2g6MgTH4G/0mM6O5sxduM4yGmWZNZpVzh0yMLgH619MZlj
+SMQIN3U/SQIDAQABo3MwcTAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYIKwYB
+BQUHAwIGCCsGAQUFBwMBMCEGA1UdEQQaMBiCFnd3dy5kdW1teWNoZWZ0ZXN0cy5j
+b20wHQYDVR0OBBYEFHwS3gs03m6RcpR+66u4OqGiZdYnMA0GCSqGSIb3DQEBCwUA
+A4IBAQCFHqMjHUfBZahIsKHQIcFCbC1NFh1ZHlJKZzrRBRwRzX19OttHGMyLpDd6
+tM9Ac6LLR8S4QIWg+HF3IrkN+vfTRDZAccj+tIwBRstmdsEz/rAJ79Vb/00mXZQx
+0FPiBDR3hE7On2oo24DU8kJP3v6TrunwtIomVGqrrkwZzvxqyW+WJMB2shGNFw5J
+mKYBiiXsHl4Bi7V4zhXssrLp877sqpNLeXloXBmAlT39SwQTP9ImZaV5R6udqlvo
+Gfgm5PH/WeK6MV3n5ik0v1rS0LwR2o82WlIB6a4iSEbzY3qSLsWOwt8o5QjAVzCR
+tNdbdS3U8nrG73iA2clmF57ARQWC
+-----END CERTIFICATE-----
+    CERT
+  end
+  let(:cert_output_path) { ::File.join(Chef::Config[:file_cache_path], "output.cer") }
+  let(:pfx_output_path) { ::File.join(Chef::Config[:file_cache_path], "output.pfx") }
+  let(:key_output_path) { ::File.join(Chef::Config[:file_cache_path], "output.key") }
+  let(:download_cert_url) { "https://testingchef.blob.core.windows.net/files/test.cer" }
   let(:cer_path) { File.join(CHEF_SPEC_DATA, "windows_certificates", "test.cer") }
   let(:base64_path) { File.join(CHEF_SPEC_DATA, "windows_certificates", "base64_test.cer") }
   let(:pem_path) { File.join(CHEF_SPEC_DATA, "windows_certificates", "test.pem") }
@@ -68,12 +110,18 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
       .and_return(true)
 
     create_store
+
   end
 
-  after { delete_store }
+  after do
+    delete_store
+  end
 
   describe "action: create" do
     it "starts with no certificates" do
+      delete_store
+      create_store
+      foo = list_certificates
       expect(certificate_count).to eq(0)
     end
 
@@ -103,6 +151,15 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
       expect(resource).to be_updated_by_last_action
     end
 
+    it "can add a certificate from a valid url" do
+      stub_request(:get, download_cert_url).to_return(body: test_cert_body)
+      resource.source = download_cert_url
+      resource.run_action(:create)
+
+      expect(certificate_count).to eq(1)
+      expect(resource).to be_updated_by_last_action
+    end
+
     it "can add a base64 encoded certificate idempotently" do
       resource.source = base64_path
       resource.run_action(:create)
@@ -157,11 +214,15 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
 
       expect { resource.run_action(:create) }.to raise_error(OpenSSL::PKCS12::PKCS12Error)
     end
+    after { delete_store }
   end
 
   describe "action: verify" do
+    before do
+      create_store
+    end
     it "fails with no certificates in the store" do
-      expect(Chef::Log).to receive(:info).with("Certificate not found")
+      expect(Chef::Log).to receive(:info).with("Certificate not valid")
 
       resource.source = tests_thumbprint
       resource.run_action(:verify)
@@ -185,7 +246,7 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
       end
 
       it "fails with an invalid thumbprint" do
-        expect(Chef::Log).to receive(:info).with("Certificate not found")
+        expect(Chef::Log).to receive(:info).with("Certificate not valid")
 
         resource.source = others_thumbprint
         resource.run_action(:verify)
@@ -219,7 +280,7 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
       end
 
       it "fails with an invalid thumbprint" do
-        expect(Chef::Log).to receive(:info).with("Certificate not found")
+        expect(Chef::Log).to receive(:info).with("Certificate not valid")
 
         resource.source = others_thumbprint
         resource.run_action(:verify)
@@ -230,13 +291,13 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
   end
 
   describe "action: fetch" do
-    it "does nothing with no certificates in the store" do
-      expect(Chef::Log).not_to receive(:info)
-
-      resource.source = tests_thumbprint
-      resource.run_action(:fetch)
-
-      expect(resource).not_to be_updated_by_last_action
+    context "with no certificate in the store" do
+      it "logs a debug error with no certificates in the store" do
+        expect(Chef::Log).to receive(:debug).with("Certificate Not Found")
+        resource.source = others_thumbprint
+        resource.output_path = cert_output_path
+        resource.run_action(:fetch)
+      end
     end
 
     context "with a certificate in the store" do
@@ -247,43 +308,67 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
 
       it "succeeds with a valid thumbprint" do
         resource.source = tests_thumbprint
+        local_output_path = ::File.join(Chef::Config[:file_cache_path], "test.pem")
+        resource.output_path = local_output_path
+        resource.run_action(:fetch)
+        expect(File.exist?(local_output_path)).to be_truthy
+      end
+
+      it "fails with an invalid thumbprint" do
+        expect(Chef::Log).to receive(:debug).with("Certificate Not Found")
+
+        resource.source = others_thumbprint
 
         Dir.mktmpdir do |dir|
           path = File.join(dir, "test.pem")
-          expect(Chef::Log).to receive(:info).with("Certificate export in #{path}")
 
-          resource.cert_path = path
+          resource.output_path = path
           resource.run_action(:fetch)
-
-          expect(File.exist?(path)).to be_truthy
         end
 
-        expect(resource).not_to be_updated_by_last_action
       end
+    end
 
-      it "fails with an invalid thumbprint" do
-        expect(Chef::Log).not_to receive(:info)
+    context "with a pfx/pkcs12 object in the store" do
+      before do
+        create_store
+        refresh_certstore
+        resource.source = pfx_path
+        resource.pfx_password = password
+        resource.exportable = true
+        resource.run_action(:create)
+      end
 
-        resource.source = others_thumbprint
+      it "exports a PFX file with a valid thumbprint" do
+        resource.source = tests_thumbprint
+        resource.pfx_password = password
+        resource.output_path = pfx_output_path
+        resource.run_action(:fetch)
+        expect(File.exist?(pfx_output_path)).to be_truthy
+      end
 
-        Dir.mktmpdir do |dir|
-          path = File.join(dir, "test.pem")
+      it "exports a key file with a valid thumbprint" do
+        resource.source = tests_thumbprint
+        resource.pfx_password = password
+        resource.output_path = key_output_path
+        resource.run_action(:fetch)
+        expect(File.exist?(key_output_path)).to be_truthy
+      end
 
-          resource.cert_path = path
-          resource.run_action(:fetch)
+      it "throws an exception when output_path is not specified" do
+        resource.source = tests_thumbprint
+        resource.pfx_password = password
+        expect { resource.run_action :fetch }.to raise_error(::Chef::Exceptions::ResourceNotFound)
+      end
 
-          expect(File.exist?(path)).to be_falsy
-        end
+      after { delete_store }
 
-        expect(resource).not_to be_updated_by_last_action
-      end
     end
   end
 
   describe "action: delete" do
-    it "does nothing when attempting to delete a certificate that doesn't exist" do
-      expect(Chef::Log).to receive(:debug).with("Certificate not found")
-
+    it "logs an error when attempting to delete a certificate that doesn't exist" do
+      expect(Chef::Log).to receive(:debug).with("Certificate Not Found")
       resource.source = tests_thumbprint
       resource.run_action(:delete)
     end
@@ -303,7 +388,7 @@ describe Chef::Resource::WindowsCertificate, :windows_only do
       expect(certificate_count).to eq(1)
       expect(resource).to be_updated_by_last_action
 
-      resource.run_action(:delete)
+      expect { resource.run_action :delete }.not_to raise_error
       expect(certificate_count).to eq(1)
       expect(resource).not_to be_updated_by_last_action
 

data/spec/functional/resource/windows_env_spec.rb

@@ -38,7 +38,7 @@ describe Chef::Resource::WindowsEnv, :windows_only do
       if environment_variables && environment_variables.length > 0
         environment_variables.each do |env|
           env_obj = env.wmi_ole_object
-          return env_obj if env_obj.username.split('\\').last.casecmp(test_resource.user) == 0
+          return env_obj if env_obj.username.split("\\").last.casecmp(test_resource.user) == 0
         end
       end
       nil
@@ -93,7 +93,7 @@ describe Chef::Resource::WindowsEnv, :windows_only do
         test_resource.value(env_value1)
         test_resource.user(env_user)
         test_resource.run_action(:create)
-        expect(env_obj.username.split('\\').last.upcase).to eq(env_user)
+        expect(env_obj.username.split("\\").last.upcase).to eq(env_user)
       end
 
       context "when env variable exist with same name" do

data/spec/functional/resource/windows_font_spec.rb

@@ -18,8 +18,7 @@
 
 require "spec_helper"
 
-# these tests hang on Buildkite on Chef 16 Verify pipeline
-describe Chef::Resource::WindowsFont, :windows_only, :broken do
+describe Chef::Resource::WindowsFont, :windows_only, :broken do # these tests hang on Chef-16 and Chef-17 in the verify-pipline.
   let(:resource_name) { "Playmaker.ttf" }
   let(:resource_source) { "https://www.wfonts.com/download/data/2020/05/06/playmaker/Playmaker.ttf" }
 

data/spec/functional/resource/windows_hostname_spec.rb

@@ -0,0 +1,91 @@
+# Author: John McCrae (john.mccrae@progress.com)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "spec_helper"
+require "chef/mixin/powershell_exec"
+require "chef/resource/hostname"
+
+describe Chef::Resource::Hostname, :windows_only do
+  include Chef::Mixin::PowershellExec
+
+  def get_domain_status
+    powershell_exec!("(Get-WmiObject -Class Win32_ComputerSystem).PartofDomain").result
+  end
+
+  let(:new_hostname) { "New-Hostname" }
+  let(:local_domain_user) { "'mydomain\\Groucho'" }
+  let(:local_domain_password) { "'P@ssw0rd'" }
+  let(:local_windows_reboot) { false }
+  let(:domain_status) { get_domain_status }
+
+  let(:run_context) do
+    node = Chef::Node.new
+    node.consume_external_attrs(OHAI_SYSTEM.data, {}) # node[:languages][:powershell][:version]
+    node.automatic["os"] = "windows"
+    node.automatic["platform"] = "windows"
+    node.automatic["platform_version"] = "6.1"
+    node.automatic["kernel"][:machine] = :x86_64 # Only 64-bit architecture is supported
+    empty_events = Chef::EventDispatch::Dispatcher.new
+    Chef::RunContext.new(node, {}, empty_events)
+  end
+
+  subject do
+    new_resource = Chef::Resource::Hostname.new("oldhostname", run_context)
+    new_resource.hostname = "Grendel"
+    new_resource.windows_reboot = false
+    new_resource
+  end
+
+  describe "Changing machine names" do
+    context "The system can be renamed without a user or password when in a Workgroup" do
+      let(:hostname) { "Cucumber" }
+      it "does change" do
+        subject.run_action(:set)
+        expect(subject).to be_updated_by_last_action
+      end
+    end
+
+    describe "Mocking being joined to a domain" do
+      before do
+        allow(subject).to receive(:is_domain_joined?) { true }
+      end
+      context "the system gets renamed when in a domain" do
+        let(:hostname) { "Gherkin" }
+        it "does change the domain account" do
+          subject.windows_reboot true
+          subject.domain_user local_domain_user
+          subject.domain_password local_domain_password
+          subject.run_action(:set)
+          expect(subject).to be_updated_by_last_action
+        end
+      end
+    end
+
+    describe "testing for error handling" do
+      before do
+        allow(subject).to receive(:is_domain_joined?) { true }
+      end
+      context "when a node is renamed while in a domain" do
+        it "and fails because of missing credentials" do
+          subject.windows_reboot true
+          subject.domain_user local_domain_user
+          expect { subject.run_action(:set) }.to raise_error(RuntimeError)
+        end
+      end
+    end
+  end
+end

data/spec/functional/resource/windows_pagefile_spec.rb

@@ -0,0 +1,125 @@
+# Author: John McCrae (john.mccrae@progress.com)
+# Copyright:: Copyright (c) Chef Software Inc.
+# License: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "spec_helper"
+require "chef/mixin/powershell_exec"
+
+describe Chef::Resource::WindowsPagefile, :windows_only do
+  include Chef::Mixin::PowershellExec
+
+  let(:c_path) { "c:\\" }
+  let(:e_path) { "e:\pagefile.sys" }
+
+  let(:run_context) do
+    node = Chef::Node.new
+    node.consume_external_attrs(OHAI_SYSTEM.data, {}) # node[:languages][:powershell][:version]
+    node.automatic["os"] = "windows"
+    node.automatic["platform"] = "windows"
+    node.automatic["platform_version"] = "6.1"
+    node.automatic["kernel"][:machine] = :x86_64 # Only 64-bit architecture is supported
+    empty_events = Chef::EventDispatch::Dispatcher.new
+    Chef::RunContext.new(node, {}, empty_events)
+  end
+
+  subject do
+    new_resource = Chef::Resource::WindowsPagefile.new("pagefile", run_context)
+    new_resource
+  end
+
+  def set_automatic_managed_to_false
+    powershell_code = <<~EOH
+      $computersys = Get-WmiObject Win32_ComputerSystem -EnableAllPrivileges;
+      $computersys.AutomaticManagedPagefile = $False;
+      $computersys.Put();
+    EOH
+    powershell_exec!(powershell_code)
+  end
+
+  def set_automatic_managed_to_true
+    powershell_code = <<~EOH
+      $computersys = Get-WmiObject Win32_ComputerSystem -EnableAllPrivileges;
+      $computersys.AutomaticManagedPagefile = $True;
+      $computersys.Put();
+    EOH
+    powershell_exec!(powershell_code)
+  end
+
+  describe "Setting Up Pagefile Management" do
+    context "Disable Automatic Management" do
+      it "Verifies Automatic Management is Disabled" do
+        set_automatic_managed_to_false
+        subject.path c_path
+        subject.automatic_managed false
+        subject.run_action(:set)
+        expect(subject).not_to be_updated_by_last_action
+      end
+
+      it "Enable Automatic Management " do
+        subject.path c_path
+        subject.automatic_managed true
+        subject.run_action(:set)
+        expect(subject).to be_updated_by_last_action
+      end
+
+      it "Disables Automatic Management" do
+        set_automatic_managed_to_true
+        subject.path c_path
+        subject.automatic_managed false
+        subject.run_action(:set)
+        expect(subject).to be_updated_by_last_action
+      end
+    end
+  end
+
+  describe "Creating a new Pagefile" do
+    context "Create new pagefile" do
+      it "Creates a new pagefile on a different drive that doesn't exist" do
+        subject.path e_path
+        expect { subject.run_action(:set) }.to raise_error(RuntimeError)
+      end
+    end
+
+    context "Update a pagefile" do
+      it "Changes a pagefile to use custom sizes" do
+        subject.path c_path
+        subject.initial_size 128
+        subject.maximum_size 512
+        subject.run_action(:set)
+        expect(subject).to be_updated_by_last_action
+      end
+    end
+  end
+
+  describe "Deleting a Pagefile and Resetting to Automatically Managed" do
+    context "delete the pagefile on disk" do
+      it "deletes the pagefile located at the given path" do
+        subject.path c_path
+        subject.run_action(:delete)
+        expect(subject).to be_updated_by_last_action
+      end
+    end
+
+    context "Re-enable automatic management of pagefiles" do
+      it "Enable Automatic Management " do
+        subject.path c_path
+        subject.automatic_managed true
+        subject.run_action(:set)
+        expect(subject).to be_updated_by_last_action
+      end
+    end
+  end
+end