chef 12.19.36 → 14.14.25

data/spec/unit/provider/apt_preference_spec.rb

@@ -0,0 +1,87 @@
+#
+# Author:: Thom May (<thom@chef.io>)
+# Author:: Tim Smith (<tim@chef.io>)
+# Copyright:: 2016-2017, 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"
+
+describe Chef::Provider::AptPreference do
+  let(:new_resource) { Chef::Resource::AptPreference.new("libmysqlclient16.1*") }
+  let(:pref_dir) { Dir.mktmpdir("apt_pref_d") }
+
+  before do
+    stub_const("Chef::Provider::AptPreference::APT_PREFERENCE_DIR", pref_dir)
+    new_resource.pin = "1.0.1"
+    new_resource.pin_priority 1001
+  end
+
+  let(:provider) do
+    node = Chef::Node.new
+    events = Chef::EventDispatch::Dispatcher.new
+    run_context = Chef::RunContext.new(node, {}, events)
+    Chef::Provider::AptPreference.new(new_resource, run_context)
+  end
+
+  it "responds to load_current_resource" do
+    expect(provider).to respond_to(:load_current_resource)
+  end
+
+  context "#action_add" do
+    context "without a preferences.d directory" do
+      before do
+        FileUtils.rmdir pref_dir
+      end
+
+      it "creates the preferences.d directory" do
+        provider.run_action(:add)
+        expect(new_resource).to be_updated_by_last_action
+        expect(File.exist?(pref_dir)).to be true
+        expect(File.directory?(pref_dir)).to be true
+      end
+    end
+
+    context "with a preferences.d directory" do
+      before do
+        FileUtils.mkdir pref_dir unless ::File.exist?(pref_dir)
+        FileUtils.touch("#{pref_dir}/libmysqlclient16.1*.pref")
+        FileUtils.touch("#{pref_dir}/libmysqlclient16.1*")
+      end
+
+      # FileUtils.touch throws "Invalid argument @ utime_failed" in appveyer
+      it "creates a sanitized .pref file and removes the legacy cookbook files", :unix_only do
+        provider.run_action(:add)
+        expect(new_resource).to be_updated_by_last_action
+        expect(File).not_to exist("#{pref_dir}/libmysqlclient16.1*.pref")
+        expect(File).not_to exist("#{pref_dir}/libmysqlclient16.1*")
+        expect(File.read(::File.join(pref_dir, "libmysqlclient16_1wildcard.pref"))).to match(/Package: libmysqlclient16.1*.*Pin: 1.0.1.*Pin-Priority: 1001/m)
+      end
+    end
+  end
+
+  context "#action_delete" do
+    before do
+      FileUtils.mkdir pref_dir unless ::File.exist?(pref_dir)
+      FileUtils.touch("#{pref_dir}/libmysqlclient16_1wildcard.pref")
+    end
+
+    it "deletes the name santized .pref file" do
+      provider.run_action(:remove)
+      expect(new_resource).to be_updated_by_last_action
+      expect(File).not_to exist("#{pref_dir}/libmysqlclient16_1wildcard.pref")
+    end
+  end
+end

data/spec/unit/provider/apt_repository_spec.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) 2016 Chef Software, Inc.
+# Copyright:: 2016-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,38 +18,35 @@
 
 require "spec_helper"
 
-APT_KEY_FINGER = <<-EOF
-/etc/apt/trusted.gpg
---------------------
-pub   1024D/437D05B5 2004-09-12
-      Key fingerprint = 6302 39CC 130E 1A7F D81A  27B1 4097 6EAF 437D 05B5
-uid                  Ubuntu Archive Automatic Signing Key <ftpmaster@ubuntu.com>
-sub   2048g/79164387 2004-09-12
-
-pub   1024D/FBB75451 2004-12-30
-      Key fingerprint = C598 6B4F 1257 FFA8 6632  CBA7 4618 1433 FBB7 5451
-uid                  Ubuntu CD Image Automatic Signing Key <cdimage@ubuntu.com>
-
-pub   4096R/C0B21F32 2012-05-11
-      Key fingerprint = 790B C727 7767 219C 42C8  6F93 3B4F E6AC C0B2 1F32
-uid                  Ubuntu Archive Automatic Signing Key (2012) <ftpmaster@ubuntu.com>
-
-pub   4096R/EFE21092 2012-05-11
-      Key fingerprint = 8439 38DF 228D 22F7 B374  2BC0 D94A A3F0 EFE2 1092
-uid                  Ubuntu CD Image Automatic Signing Key (2012) <cdimage@ubuntu.com>
-
+# Now we are using the option --with-colons that works across old os versions
+# as well as the latest (16.10). This for both `apt-key` and `gpg` commands
+#
+# Output of the command:
+# => apt-key adv --list-public-keys --with-fingerprint --with-colons
+APT_KEY_FINGER = <<~EOF.freeze
+  tru:t:1:1488924856:0:3:1:5
+  pub:-:1024:17:40976EAF437D05B5:2004-09-12:::-:Ubuntu Archive Automatic Signing Key <ftpmaster@ubuntu.com>::scESC:
+  fpr:::::::::630239CC130E1A7FD81A27B140976EAF437D05B5:
+  sub:-:2048:16:251BEFF479164387:2004-09-12::::::e:
+  pub:-:1024:17:46181433FBB75451:2004-12-30:::-:Ubuntu CD Image Automatic Signing Key <cdimage@ubuntu.com>::scSC:
+  fpr:::::::::C5986B4F1257FFA86632CBA746181433FBB75451:
+  pub:-:4096:1:3B4FE6ACC0B21F32:2012-05-11:::-:Ubuntu Archive Automatic Signing Key (2012) <ftpmaster@ubuntu.com>::scSC:
+  fpr:::::::::790BC7277767219C42C86F933B4FE6ACC0B21F32:
+  pub:-:4096:1:D94AA3F0EFE21092:2012-05-11:::-:Ubuntu CD Image Automatic Signing Key (2012) <cdimage@ubuntu.com>::scSC:
+  fpr:::::::::843938DF228D22F7B3742BC0D94AA3F0EFE21092:
 EOF
 
-GPG_FINGER = <<-EOF
-pub  1024D/02A818DD 2009-04-22 Cloudera Apt Repository
-      Key fingerprint = F36A 89E3 3CC1 BD0F 7107  9007 3275 74EE 02A8 18DD
-sub  2048g/D1CA74A1 2009-04-22
+# Output of the command:
+# => gpg --with-fingerprint --with-colons [FILE]
+GPG_FINGER = <<~EOF.freeze
+  pub:-:1024:17:327574EE02A818DD:2009-04-22:::-:Cloudera Apt Repository:
+  fpr:::::::::F36A89E33CC1BD0F71079007327574EE02A818DD:
+  sub:-:2048:16:84080586D1CA74A1:2009-04-22::::
 EOF
 
 describe Chef::Provider::AptRepository do
   let(:new_resource) { Chef::Resource::AptRepository.new("multiverse") }
 
-  let(:shellout_env) { { env: { "LANG" => "en_US", "LANGUAGE" => "en_US" } } }
   let(:provider) do
     node = Chef::Node.new
     events = Chef::EventDispatch::Dispatcher.new
@@ -57,16 +54,27 @@ describe Chef::Provider::AptRepository do
     Chef::Provider::AptRepository.new(new_resource, run_context)
   end
 
+  let(:apt_key_finger_cmd) do
+    %w{apt-key adv --list-public-keys --with-fingerprint --with-colons}
+  end
+
   let(:apt_key_finger) do
-    r = double("Mixlib::ShellOut", stdout: APT_KEY_FINGER, exitstatus: 0, live_stream: true)
-    allow(r).to receive(:run_command)
-    r
+    double("shell_out", stdout: APT_KEY_FINGER, exitstatus: 0, error?: false)
   end
 
   let(:gpg_finger) do
-    r = double("Mixlib::ShellOut", stdout: GPG_FINGER, exitstatus: 0, live_stream: true)
-    allow(r).to receive(:run_command)
-    r
+    double("shell_out", stdout: GPG_FINGER, exitstatus: 0, error?: false)
+  end
+
+  let(:gpg_shell_out_success) do
+    double("shell_out", stdout: "pub  2048R/7BD9BF62 2011-08-19 nginx signing key <signing-key@nginx.com>",
+                        exitstatus: 0, error?: false)
+  end
+
+  let(:gpg_shell_out_failure) do
+    double("shell_out", stderr: "gpg: no valid OpenPGP data found.\n
+                                    gpg: processing message failed: eof",
+                        exitstatus: 1, error?: true)
   end
 
   let(:apt_fingerprints) do
@@ -81,58 +89,126 @@ C5986B4F1257FFA86632CBA746181433FBB75451
   end
 
   describe "#is_key_id?" do
-    it "should detect a key" do
+    it "detects a key" do
       expect(provider.is_key_id?("A4FF2279")).to be_truthy
     end
-    it "should detect a key with a hex signifier" do
+    it "detects a key with a hex signifier" do
       expect(provider.is_key_id?("0xA4FF2279")).to be_truthy
     end
-    it "should reject a key with the wrong length" do
+    it "rejects a key with the wrong length" do
       expect(provider.is_key_id?("4FF2279")).to be_falsey
     end
-    it "should reject a key with non-hex characters" do
+    it "rejects a key with non-hex characters" do
       expect(provider.is_key_id?("A4KF2279")).to be_falsey
     end
   end
 
   describe "#extract_fingerprints_from_cmd" do
-    before do
-      expect(Mixlib::ShellOut).to receive(:new).and_return(apt_key_finger)
+    it "runs the desired command" do
+      expect(provider).to receive(:shell_out).and_return(apt_key_finger)
+      provider.extract_fingerprints_from_cmd(*apt_key_finger_cmd)
     end
 
-    it "should run the desired command" do
-      expect(apt_key_finger).to receive(:run_command)
-      provider.extract_fingerprints_from_cmd("apt-key finger")
+    it "returns a list of key fingerprints" do
+      expect(provider).to receive(:shell_out).and_return(apt_key_finger)
+      expect(provider.extract_fingerprints_from_cmd(*apt_key_finger_cmd)).to eql(apt_fingerprints)
     end
+  end
 
-    it "should return a list of key fingerprints" do
-      expect(provider.extract_fingerprints_from_cmd("apt-key finger")).to eql(apt_fingerprints)
+  describe "#cookbook_name" do
+    it "returns 'test' when the cookbook property is set" do
+      new_resource.cookbook("test")
+      expect(provider.cookbook_name).to eq("test")
     end
   end
 
   describe "#no_new_keys?" do
     before do
-      allow(provider).to receive(:extract_fingerprints_from_cmd).with("apt-key finger").and_return(apt_fingerprints)
+      allow(provider).to receive(:extract_fingerprints_from_cmd).with(*apt_key_finger_cmd).and_return(apt_fingerprints)
     end
 
     let(:file) { "/tmp/remote-gpg-keyfile" }
 
-    it "should match a set of keys" do
-      allow(provider).to receive(:extract_fingerprints_from_cmd).with("gpg --with-fingerprint #{file}").and_return(Array(apt_fingerprints.first))
+    it "matches a set of keys" do
+      allow(provider).to receive(:extract_fingerprints_from_cmd)
+        .with("gpg", "--with-fingerprint", "--with-colons", file)
+        .and_return(Array(apt_fingerprints.first))
       expect(provider.no_new_keys?(file)).to be_truthy
     end
 
-    it "should notice missing keys" do
-      allow(provider).to receive(:extract_fingerprints_from_cmd).with("gpg --with-fingerprint #{file}").and_return(%w{ F36A89E33CC1BD0F71079007327574EE02A818DD })
+    it "notices missing keys" do
+      allow(provider).to receive(:extract_fingerprints_from_cmd)
+        .with("gpg", "--with-fingerprint", "--with-colons", file)
+        .and_return(%w{ F36A89E33CC1BD0F71079007327574EE02A818DD })
       expect(provider.no_new_keys?(file)).to be_falsey
     end
   end
 
+  describe "#key_type" do
+    it "returns :remote_file with an http URL" do
+      expect(provider.key_type("https://www.chef.io/key")).to eq(:remote_file)
+    end
+
+    it "returns :cookbook_file with a chef managed file" do
+      expect(provider).to receive(:has_cookbook_file?).and_return(true)
+      expect(provider.key_type("/foo/bar.key")).to eq(:cookbook_file)
+    end
+
+    it "throws exception if an unknown file specified" do
+      expect(provider).to receive(:has_cookbook_file?).and_return(false)
+      expect { provider.key_type("/foo/bar.key") }.to raise_error(Chef::Exceptions::FileNotFound)
+    end
+  end
+
+  describe "#keyserver_install_cmd" do
+    it "returns keyserver install command" do
+      expect(provider.keyserver_install_cmd("ABC", "gpg.mit.edu")).to eq("apt-key adv --no-tty --recv --keyserver hkp://gpg.mit.edu:80 ABC")
+    end
+
+    it "uses proxy if key_proxy property is set" do
+      new_resource.key_proxy("proxy.mycorp.dmz:3128")
+      expect(provider.keyserver_install_cmd("ABC", "gpg.mit.edu")).to eq("apt-key adv --no-tty --recv --keyserver-options http-proxy=proxy.mycorp.dmz:3128 --keyserver hkp://gpg.mit.edu:80 ABC")
+    end
+
+    it "properly handles keyservers passed with hkp:// URIs" do
+      expect(provider.keyserver_install_cmd("ABC", "hkp://gpg.mit.edu")).to eq("apt-key adv --no-tty --recv --keyserver hkp://gpg.mit.edu ABC")
+    end
+  end
+
+  describe "#is_ppa_url" do
+    it "returns true if the URL starts with ppa:" do
+      expect(provider.is_ppa_url?("ppa://example.com")).to be_truthy
+    end
+
+    it "returns false if the URL does not start with ppa:" do
+      expect(provider.is_ppa_url?("example.com")).to be_falsey
+    end
+  end
+
+  describe "#repo_components" do
+    it "returns 'main' if a PPA and components property not set" do
+      expect(provider).to receive(:is_ppa_url?).and_return(true)
+      expect(provider.repo_components).to eq("main")
+    end
+
+    it "returns components property if a PPA and components is set" do
+      new_resource.components(["foo"])
+      expect(provider).to receive(:is_ppa_url?).and_return(true)
+      expect(provider.repo_components).to eq(["foo"])
+    end
+
+    it "returns components property if not a PPA" do
+      new_resource.components(["foo"])
+      expect(provider).to receive(:is_ppa_url?).and_return(false)
+      expect(provider.repo_components).to eq(["foo"])
+    end
+  end
+
   describe "#install_ppa_key" do
     let(:url) { "https://launchpad.net/api/1.0/~chef/+archive/main" }
     let(:key) { "C5986B4F1257FFA86632CBA746181433FBB75451" }
 
-    it "should get a key" do
+    it "gets a key" do
       simples = double("HTTP")
       allow(simples).to receive(:get).and_return("\"#{key}\"")
       expect(Chef::HTTP::Simple).to receive(:new).with(url).and_return(simples)
@@ -142,42 +218,37 @@ C5986B4F1257FFA86632CBA746181433FBB75451
   end
 
   describe "#make_ppa_url" do
-    it "should ignore non-ppa repositories" do
-      expect(provider.make_ppa_url("some_string")).to be_nil
-    end
-
-    it "should create a URL" do
+    it "creates a URL" do
       expect(provider).to receive(:install_ppa_key).with("chef", "main").and_return(true)
       expect(provider.make_ppa_url("ppa:chef/main")).to eql("http://ppa.launchpad.net/chef/main/ubuntu")
     end
   end
 
   describe "#build_repo" do
-    it "should create a repository string" do
+    it "creates a repository string" do
       target = %Q{deb      "http://test/uri" unstable main\n}
       expect(provider.build_repo("http://test/uri", "unstable", "main", false, nil)).to eql(target)
     end
 
-    it "should create a repository string with no distribution" do
+    it "creates a repository string with no distribution" do
       target = %Q{deb      "http://test/uri" main\n}
       expect(provider.build_repo("http://test/uri", nil, "main", false, nil)).to eql(target)
     end
 
-    it "should create a repository string with source" do
+    it "creates a repository string with source" do
       target = %Q{deb      "http://test/uri" unstable main\ndeb-src  "http://test/uri" unstable main\n}
       expect(provider.build_repo("http://test/uri", "unstable", "main", false, nil, true)).to eql(target)
     end
 
-    it "should create a repository string with options" do
+    it "creates a repository string with options" do
       target = %Q{deb      [trusted=yes] "http://test/uri" unstable main\n}
       expect(provider.build_repo("http://test/uri", "unstable", "main", true, nil)).to eql(target)
     end
 
-    it "should handle a ppa repo" do
+    it "handles a ppa repo" do
       target = %Q{deb      "http://ppa.launchpad.net/chef/main/ubuntu" unstable main\n}
       expect(provider).to receive(:make_ppa_url).with("ppa:chef/main").and_return("http://ppa.launchpad.net/chef/main/ubuntu")
       expect(provider.build_repo("ppa:chef/main", "unstable", "main", false, nil)).to eql(target)
     end
   end
-
 end

data/spec/unit/provider/apt_update_spec.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Thom May (<thom@chef.io>)
-# Copyright:: Copyright (c) 2016 Chef Software, Inc.
+# Copyright:: Copyright (c) 2016-2018, Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,6 +37,8 @@ describe Chef::Provider::AptUpdate do
     Chef::Provider::AptUpdate.new(new_resource, run_context)
   end
 
+  let(:apt_update_cmd) { %w{apt-get -q update} }
+
   it "responds to load_current_resource" do
     expect(provider).to respond_to(:load_current_resource)
   end
@@ -45,7 +47,7 @@ describe Chef::Provider::AptUpdate do
     before do
       FileUtils.rmdir config_dir
       expect(File.exist?(config_dir)).to be false
-      allow_any_instance_of(Chef::Provider::Execute).to receive(:shell_out!).with("apt-get -q update", anything())
+      allow_any_instance_of(Chef::Provider::Execute).to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
     end
 
     it "should create the directory" do
@@ -64,7 +66,7 @@ describe Chef::Provider::AptUpdate do
   describe "#action_update" do
     it "should update the apt cache" do
       provider.load_current_resource
-      expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out!).with("apt-get -q update", anything())
+      expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
       provider.run_action(:update)
       expect(new_resource).to be_updated_by_last_action
     end
@@ -79,14 +81,14 @@ describe Chef::Provider::AptUpdate do
 
     it "should run if the time stamp is old" do
       expect(File).to receive(:mtime).with("#{stamp_dir}/update-success-stamp").and_return(Time.now - 86_500)
-      expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out!).with("apt-get -q update", anything())
+      expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
       provider.run_action(:periodic)
       expect(new_resource).to be_updated_by_last_action
     end
 
     it "should not run if the time stamp is new" do
       expect(File).to receive(:mtime).with("#{stamp_dir}/update-success-stamp").and_return(Time.now)
-      expect_any_instance_of(Chef::Provider::Execute).not_to receive(:shell_out!).with("apt-get -q update", anything())
+      expect_any_instance_of(Chef::Provider::Execute).not_to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
       provider.run_action(:periodic)
       expect(new_resource).to_not be_updated_by_last_action
     end
@@ -98,14 +100,14 @@ describe Chef::Provider::AptUpdate do
 
       it "should run if the time stamp is old" do
         expect(File).to receive(:mtime).with("#{stamp_dir}/update-success-stamp").and_return(Time.now - 500)
-        expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out!).with("apt-get -q update", anything())
+        expect_any_instance_of(Chef::Provider::Execute).to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
         provider.run_action(:periodic)
         expect(new_resource).to be_updated_by_last_action
       end
 
       it "should not run if the time stamp is new" do
         expect(File).to receive(:mtime).with("#{stamp_dir}/update-success-stamp").and_return(Time.now - 300)
-        expect_any_instance_of(Chef::Provider::Execute).not_to receive(:shell_out!).with("apt-get -q update", anything())
+        expect_any_instance_of(Chef::Provider::Execute).not_to receive(:shell_out_compacted!).with(*apt_update_cmd, anything())
         provider.run_action(:periodic)
         expect(new_resource).to_not be_updated_by_last_action
       end

data/spec/unit/provider/cookbook_file/content_spec.rb

@@ -20,7 +20,7 @@ require "spec_helper"
 
 describe Chef::Provider::CookbookFile::Content do
 
-  let(:new_resource) { double("Chef::Resource::CookbookFile (new)", :cookbook_name => "apache2", :cookbook => "apache2") }
+  let(:new_resource) { double("Chef::Resource::CookbookFile (new)", cookbook_name: "apache2", cookbook: "apache2") }
   let(:content) do
     @run_context = double("Chef::RunContext")
     @current_resource = double("Chef::Resource::CookbookFile (current)")