chef 17.4.38 → 17.7.22

data/spec/unit/resource/chef_client_scheduled_task_spec.rb

@@ -25,6 +25,11 @@ describe Chef::Resource::ChefClientScheduledTask do
   let(:resource) { Chef::Resource::ChefClientScheduledTask.new("fakey_fakerton", run_context) }
   let(:provider) { resource.provider_for_action(:add) }
 
+  before do
+    allow(ENV).to receive(:[]).and_call_original
+    allow(ENV).to receive(:[]).with("COMSPEC").and_return("C:\\Windows\\System32\\cmd.exe")
+  end
+
   it "sets the default action as :add" do
     expect(resource.action).to eql([:add])
   end
@@ -73,11 +78,75 @@ describe Chef::Resource::ChefClientScheduledTask do
     expect(resource.chef_binary_path).to eql("C:/opscode/chef/bin/chef-client")
   end
 
+  context "priority" do
+    it "default value is 7" do
+      expect(resource.priority).to eq(7)
+    end
+
+    it "raise error when priority value less than 0" do
+      expect { resource.priority(-1) }.to raise_error(Chef::Exceptions::ValidationFailed, "Option priority's value -1 should be in range of 0 to 10!")
+    end
+
+    it "raise error when priority values is greater than 10" do
+      expect { resource.priority 11 }.to raise_error(Chef::Exceptions::ValidationFailed, "Option priority's value 11 should be in range of 0 to 10!")
+    end
+  end
+
   it "supports :add and :remove actions" do
     expect { resource.action :add }.not_to raise_error
     expect { resource.action :remove }.not_to raise_error
   end
 
+  it "expects use_consistent_splay to be true when set" do
+    resource.use_consistent_splay = true
+    expect(resource.use_consistent_splay).to eql(true)
+  end
+
+  context "when configured to use a consistent splay" do
+    before do
+      node.automatic_attrs[:shard_seed] = nil
+      allow(node).to receive(:name).and_return("test_node")
+      resource.config_directory = "C:/chef" # Allows local unit testing on nix flavors
+      resource.use_consistent_splay = true
+    end
+
+    it "sleeps the same amount each time based on splay before running the task" do
+      expect(provider.full_command).to eql("C:\\Windows\\System32\\cmd.exe /c \"C:/windows/system32/windowspowershell/v1.0/powershell.exe Start-Sleep -s 272 && C:/opscode/chef/bin/chef-client -L C:/chef/log/client.log -c C:/chef/client.rb\"")
+    end
+  end
+
+  describe "#consistent_splay_command" do
+    context "when use_consistent_splay is false" do
+      it "returns nil" do
+        expect(provider.consistent_splay_command).to eql(nil)
+      end
+    end
+
+    context "when use_consistent_splay is true" do
+      before do
+        resource.use_consistent_splay true
+        allow(provider).to receive(:splay_sleep_time).and_return(222)
+      end
+
+      it "returns a powershell sleep command to be appended to the chef client run command" do
+        expect(provider.consistent_splay_command).to eql("C:/windows/system32/windowspowershell/v1.0/powershell.exe Start-Sleep -s 222 && ")
+      end
+    end
+  end
+
+  describe "#splay_sleep_time" do
+    it "uses shard_seed attribute if present" do
+      node.automatic_attrs[:shard_seed] = "73399073"
+      expect(provider.splay_sleep_time(300)).to satisfy { |v| v >= 0 && v <= 300 }
+    end
+
+    it "uses a hex conversion of a md5 hash of the splay if present" do
+      node.automatic_attrs[:shard_seed] = nil
+      allow(node).to receive(:name).and_return("test_node")
+      expect(provider.splay_sleep_time(300)).to satisfy { |v| v >= 0 && v <= 300 }
+    end
+  end
+
   describe "#client_cmd" do
     it "creates a valid command if using all default properties" do
       expect(provider.client_cmd).to eql("C:/opscode/chef/bin/chef-client -L /etc/chef/log/client.log -c /etc/chef/client.rb") | eql("C:/opscode/chef/bin/chef-client -L C:\\chef/log/client.log -c C:\\chef/client.rb")

data/spec/unit/resource/chocolatey_config_spec.rb

@@ -41,7 +41,7 @@ describe Chef::Resource::ChocolateyConfig do
   # we save off the ENV and set ALLUSERSPROFILE so these specs will work on *nix and non-C drive Windows installs
   before(:each) do
     @original_env = ENV.to_hash
-    ENV["ALLUSERSPROFILE"] = 'C:\ProgramData'
+    ENV["ALLUSERSPROFILE"] = "C:\\ProgramData"
   end
 
   after(:each) do

data/spec/unit/resource/chocolatey_feature_spec.rb

@@ -41,7 +41,7 @@ describe Chef::Resource::ChocolateyFeature do
   # we save off the ENV and set ALLUSERSPROFILE so these specs will work on *nix and non-C drive Windows installs
   before(:each) do
     @original_env = ENV.to_hash
-    ENV["ALLUSERSPROFILE"] = 'C:\ProgramData'
+    ENV["ALLUSERSPROFILE"] = "C:\\ProgramData"
   end
 
   after(:each) do

data/spec/unit/resource/chocolatey_source_spec.rb

@@ -54,7 +54,7 @@ describe Chef::Resource::ChocolateySource do
     allow(resource).to receive(:provider_for_action).and_return(enable_provider)
     allow(resource.class).to receive(:new).and_return(current_resource)
     @original_env = ENV.to_hash
-    ENV["ALLUSERSPROFILE"] = 'C:\ProgramData'
+    ENV["ALLUSERSPROFILE"] = "C:\\ProgramData"
   end
 
   after(:each) do

data/spec/unit/resource/file/verification/json_spec.rb

@@ -0,0 +1,72 @@
+#
+# Author:: Antony Thomas (<antonydeepak@gmail.com>)
+# Copyright:: Copyright (c) Facebook, Inc. and its affiliates.
+# 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::Resource::File::Verification::Json do
+  let(:parent_resource) { Chef::Resource.new("llama") }
+
+  before(:all) do
+    @valid_json = "valid-#{Time.now.to_i}.json"
+    f = File.new(@valid_json, "w")
+    f.write('{
+      "foo": "bar"
+    }')
+    f.close
+
+    @invalid_json = "invalid-#{Time.now.to_i}.json"
+    f = File.new(@invalid_json, "w")
+    f.write("{
+      'foo': 'bar'
+    }")
+    f.close
+
+    @empty_json = "empty-#{Time.now.to_i}.json"
+    File.new(@empty_json, "w").close
+  end
+
+  context "verify" do
+    it "returns true for valid json" do
+      v = Chef::Resource::File::Verification::Json.new(parent_resource, :json, {})
+      expect(v.verify(@valid_json)).to eq(true)
+    end
+
+    it "returns false for invalid json" do
+      v = Chef::Resource::File::Verification::Json.new(parent_resource, :json, {})
+      expect(v.verify(@invalid_json)).to eq(false)
+    end
+
+    it "returns true for empty file" do
+      # Expectation here is different from that of default JSON parser included in ruby 2.4+.
+      # The default parser considers empty string as invalid JSON
+      # https://stackoverflow.com/questions/30621802/why-does-json-parse-fail-with-the-empty-string,
+      # however JSONCompat parses an empty string to `nil`.
+      # We are retaining the behavior of JSONCompat for two reasons
+      # - It is universal inside Chef codebase
+      # - It can be helpful to not throw an error when a `file` or `template` is empty
+      v = Chef::Resource::File::Verification::Json.new(parent_resource, :json, {})
+      expect(v.verify(@empty_json)).to eq(true)
+    end
+  end
+
+  after(:all) do
+    File.delete(@valid_json)
+    File.delete(@invalid_json)
+    File.delete(@empty_json)
+  end
+end

data/spec/unit/resource/file/verification/yaml_spec.rb

@@ -0,0 +1,67 @@
+#
+# Author:: Antony Thomas (<antonydeepak@gmail.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"
+
+describe Chef::Resource::File::Verification::Yaml do
+  let(:parent_resource) { Chef::Resource.new("llama") }
+
+  before(:all) do
+    @valid_yaml = "valid-#{Time.now.to_i}.yaml"
+    f = File.new(@valid_yaml, "w")
+    f.write("# comment
+        svc:
+          mysqlPassword: sepppasswd
+        ")
+    f.close
+
+    @invalid_yaml = "invalid-#{Time.now.to_i}.yaml"
+    f = File.new(@invalid_yaml, "w")
+    f.write("# comment
+        svc:
+          mysqlPassword: 'sepppasswd
+        ")
+    f.close
+
+    @empty_yaml = "empty-#{Time.now.to_i}.yaml"
+    File.new(@empty_yaml, "w").close
+  end
+
+  context "verify" do
+    it "returns true for valid yaml" do
+      v = Chef::Resource::File::Verification::Yaml.new(parent_resource, :yaml, {})
+      expect(v.verify(@valid_yaml)).to eq(true)
+    end
+
+    it "returns false for invalid yaml" do
+      v = Chef::Resource::File::Verification::Yaml.new(parent_resource, :yaml, {})
+      expect(v.verify(@invalid_yaml)).to eq(false)
+    end
+
+    it "returns true for empty file" do
+      v = Chef::Resource::File::Verification::Yaml.new(parent_resource, :yaml, {})
+      expect(v.verify(@empty_yaml)).to eq(true)
+    end
+  end
+
+  after(:all) do
+    File.delete(@valid_yaml)
+    File.delete(@invalid_yaml)
+    File.delete(@empty_yaml)
+  end
+end

data/spec/unit/resource/inspec_input_spec.rb

@@ -0,0 +1,300 @@
+#
+# 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"
+
+describe Chef::Resource::InspecInput do
+  def load_input(filename)
+    path = "/var/chef/cache/cookbooks/acme_compliance/compliance/inputs/#{filename}"
+    run_context.input_collection << Chef::Compliance::Input.from_yaml(events, input_yaml, path, "acme_compliance")
+  end
+
+  let(:node) { Chef::Node.new }
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) do
+    Chef::RunContext.new(node, {}, events).tap do |rc|
+    end
+  end
+  let(:collection) { double("resource collection") }
+  let(:input_yaml) do
+    <<~EOH
+ssh_custom_path: "/whatever2"
+    EOH
+  end
+  let(:input_json) do
+    <<~EOH
+    { "ssh_custom_path": "/whatever2" }
+    EOH
+  end
+  let(:input_toml) do
+    <<~EOH
+ssh_custom_path = "/whatever2"
+    EOH
+  end
+  let(:input_hash) do
+    { ssh_custom_path: "/whatever2" }
+  end
+  let(:resource) do
+    Chef::Resource::InspecInput.new("ssh-01", run_context)
+  end
+  let(:provider) { resource.provider_for_action(:add) }
+
+  before do
+    allow(run_context).to receive(:resource_collection).and_return(collection)
+  end
+
+  it "sets the default action as :add" do
+    expect(resource.action).to eql([:add])
+  end
+
+  context "with a input in a cookbook" do
+    it "enables the input by the name of the cookbook" do
+      load_input("default.yml")
+      resource.name "acme_compliance"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "enables the input with a regular expression for the cookbook" do
+      load_input("default.yml")
+      resource.name "acme_comp.*"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "enables the input with an explicit name" do
+      load_input("default.yml")
+      resource.name "acme_compliance::default"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "fails when the cookbook name is wrong" do
+      load_input("default.yml")
+      resource.name "evil_compliance"
+      expect { resource.run_action(:add) }.to raise_error(StandardError)
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "enables the input when its not named default" do
+      load_input("ssh01.yml")
+      resource.name "acme_compliance::ssh01"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "fails when it is not named default and you attempt to enable the default" do
+      load_input("ssh01.yml")
+      resource.name "acme_compliance"
+      expect { resource.run_action(:add) }.to raise_error(StandardError)
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "succeeds with a regexp that matches the cookbook name" do
+      load_input("ssh01.yml")
+      resource.name "acme_comp.*::ssh01"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "succeeds with a regexp that matches the file name" do
+      load_input("ssh01.yml")
+      resource.name "acme_compliance::ssh.*"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "succeeds with a regexps for both the file name and cookbook name" do
+      load_input("ssh01.yml")
+      resource.name "acme_comp.*::ssh.*"
+      resource.run_action(:add)
+      expect(run_context.input_collection.first).to be_enabled
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "fails with regexps that do not match" do
+      load_input("ssh01.yml")
+      resource.name "evil_comp.*::etcd.*"
+      expect { resource.run_action(:add) }.to raise_error(StandardError)
+    end
+
+    it "substring matches without regexps should fail when they are at the end" do
+      load_input("ssh01.yml")
+      resource.name "acme_complianc::ssh0"
+      expect { resource.run_action(:add) }.to raise_error(StandardError)
+    end
+
+    it "substring matches without regexps should fail when they are at the start" do
+      load_input("ssh01.yml")
+      resource.name "cme_compliance::sh01"
+      expect { resource.run_action(:add) }.to raise_error(StandardError)
+    end
+  end
+
+  context "with a input in a file" do
+    it "loads a YAML file" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".yaml"])
+      tempfile.write input_yaml
+      tempfile.close
+      resource.name tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a YAML file in a source attribute" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".yaml"])
+      tempfile.write input_yaml
+      tempfile.close
+      resource.name "my-resource-name"
+      resource.source tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a YML file" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".yml"])
+      tempfile.write input_yaml
+      tempfile.close
+      resource.name tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a YML file using the source attribute" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".yml"])
+      tempfile.write input_yaml
+      tempfile.close
+      resource.name "my-resource-name"
+      resource.source tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a JSON file" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".json"])
+      tempfile.write input_json
+      tempfile.close
+      resource.name tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a JSON file using the source attribute" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".json"])
+      tempfile.write input_json
+      tempfile.close
+      resource.name "my-resource-name"
+      resource.source tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a TOML file" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".toml"])
+      tempfile.write input_toml
+      tempfile.close
+      resource.name tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a TOML file using the source attribute" do
+      tempfile = Tempfile.new(["spec-compliance-test", ".toml"])
+      tempfile.write input_toml
+      tempfile.close
+      resource.name "my-resource-name"
+      resource.source tempfile.path
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+
+    it "loads a Hash" do
+      resource.source input_hash
+
+      resource.run_action(:add)
+
+      expect(run_context.input_collection.first).to be_enabled
+      expect(run_context.input_collection.size).to be 1
+      expect(run_context.input_collection.first.cookbook_name).to be nil
+      expect(run_context.input_collection.first.path).to be nil
+      expect(run_context.input_collection.first.pathname).to be nil
+      expect(resource).not_to be_updated_by_last_action
+    end
+  end
+end