chef 17.10.0 → 18.0.185

data/spec/unit/provider/user_spec.rb

@@ -178,12 +178,30 @@ describe Chef::Provider::User do
         end
       end
 
-      it "should fail assertions when ruby-shadow cannot be loaded" do
-        expect(@provider).to receive(:require).with("shadow") { raise LoadError }
-        @provider.load_current_resource
-        @provider.action = :create
-        @provider.define_resource_requirements
-        expect { @provider.process_resource_requirements }.to raise_error Chef::Exceptions::MissingLibrary
+      context "when ruby-shadow is supported on the platform" do
+        before do
+          allow(@provider).to receive(:supports_ruby_shadow?).and_return true
+        end
+        it "should fail assertions when ruby-shadow cannot be loaded" do
+          expect(@provider).to receive(:require).with("shadow") { raise LoadError }
+          @provider.load_current_resource
+          @provider.action = :create
+          @provider.define_resource_requirements
+          expect { @provider.process_resource_requirements }.to raise_error Chef::Exceptions::MissingLibrary
+        end
+      end
+
+      context "when ruby-shadow is not supported on the platform" do
+        before do
+          allow(@provider).to receive(:supports_ruby_shadow?).and_return false
+        end
+        it "should not fail any assertions when ruby-shadow cannot be loaded" do
+          expect(@provider).to receive(:require).with("shadow") { raise LoadError }
+          @provider.load_current_resource
+          @provider.action = :create
+          @provider.define_resource_requirements
+          @provider.process_resource_requirements
+        end
       end
 
     end

data/spec/unit/resource/archive_file_spec.rb

@@ -29,7 +29,7 @@ rescue LoadError
   end
 end
 
-describe Chef::Resource::ArchiveFile, :not_supported_on_aix do
+describe Chef::Resource::ArchiveFile, :not_supported_on_aix, :not_supported_on_windows do
   let(:node) { Chef::Node.new }
   let(:events) { Chef::EventDispatch::Dispatcher.new }
   let(:run_context) { Chef::RunContext.new(node, {}, events) }

data/spec/unit/resource/chef_client_config_spec.rb

@@ -134,4 +134,12 @@ describe Chef::Resource::ChefClientConfig do
       expect(provider.format_handler([{ "class" => "Foo", "arguments" => ["'one'", "two", "three"] }])).to eql(["Foo.new('one',two,three)"])
     end
   end
+
+  describe "rubygems_url property" do
+    it "accepts nil, a single URL, or an array of URLs" do
+      expect { resource.rubygems_url(nil) }.not_to raise_error
+      expect { resource.rubygems_url("https://rubygems.internal.example.com") }.not_to raise_error
+      expect { resource.rubygems_url(["https://rubygems.east.example.com", "https://rubygems.west.example.com"]) }.not_to raise_error
+    end
+  end
 end

data/spec/unit/resource/chef_client_cron_spec.rb

@@ -43,6 +43,11 @@ describe Chef::Resource::ChefClientCron do
     expect { resource.splay("-10") }.to raise_error(Chef::Exceptions::ValidationFailed)
   end
 
+  it "set splay to 0" do
+    resource.splay "0"
+    expect(resource.splay).to eql(0)
+  end
+
   it "builds a default value for chef_binary_path dist values" do
     expect(resource.chef_binary_path).to eql("/opt/chef/bin/chef-client")
   end

data/spec/unit/resource/chef_client_launchd_spec.rb

@@ -43,6 +43,11 @@ describe Chef::Resource::ChefClientLaunchd do
     expect { resource.splay("-10") }.to raise_error(Chef::Exceptions::ValidationFailed)
   end
 
+  it "set splay to 0" do
+    resource.splay "0"
+    expect(resource.splay).to eql(0)
+  end
+
   it "builds a default value for chef_binary_path dist values" do
     expect(resource.chef_binary_path).to eql("/opt/chef/bin/chef-client")
   end

data/spec/unit/resource/chef_client_scheduled_task_spec.rb

@@ -43,6 +43,11 @@ describe Chef::Resource::ChefClientScheduledTask do
     expect { resource.splay("-10") }.to raise_error(Chef::Exceptions::ValidationFailed)
   end
 
+  it "set splay to 0" do
+    resource.splay "0"
+    expect(resource.splay).to eql(0)
+  end
+
   it "coerces frequency_modifier to an Integer" do
     resource.frequency_modifier "10"
     expect(resource.frequency_modifier).to eql(10)

data/spec/unit/resource/chef_client_systemd_timer_spec.rb

@@ -105,4 +105,4 @@ describe Chef::Resource::ChefClientSystemdTimer do
       expect(provider.service_content["Service"]["CPUQuota"]).to eq(50)
     end
   end
-end
+end

data/spec/unit/resource/cron_d_spec.rb

@@ -18,7 +18,11 @@
 require "spec_helper"
 
 describe Chef::Resource::CronD do
-  let(:resource) { Chef::Resource::CronD.new("cronify") }
+  let(:node) { Chef::Node.new }
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { Chef::Resource::CronD.new("cronify", run_context) }
+  let(:provider) { resource.provider_for_action(:create) }
 
   it "has a default action of [:create]" do
     expect(resource.action).to eql([:create])
@@ -34,6 +38,38 @@ describe Chef::Resource::CronD do
     expect(resource.cron_name).to eql("cronify")
   end
 
+  context "on linux" do
+    before(:each) do
+      node.automatic_attrs[:os] = "linux"
+    end
+
+    it "the cron_name property is valid" do
+      provider.define_resource_requirements
+
+      expect { resource.cron_name "cron-job";   provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "cron_job_0"; provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "CronJob";    provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "cron!";      provider.process_resource_requirements }.to raise_error "The cron job name should contain letters, numbers, hyphens and underscores only."
+      expect { resource.cron_name "cron job";   provider.process_resource_requirements }.to raise_error "The cron job name should contain letters, numbers, hyphens and underscores only."
+    end
+  end
+
+  context "not on linux" do
+    before(:each) do
+      node.automatic_attrs[:os] = "aix"
+    end
+
+    it "all cron names are valid" do
+      provider.define_resource_requirements
+
+      expect { resource.cron_name "cron-job";   provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "cron_job_0"; provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "CronJob";    provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "cron!";      provider.process_resource_requirements }.not_to raise_error
+      expect { resource.cron_name "cron job";   provider.process_resource_requirements }.not_to raise_error
+    end
+  end
+
   it "the mode property defaults to '0600'" do
     expect(resource.mode).to eql("0600")
   end

data/spec/unit/resource/rest_resource_spec.rb

@@ -0,0 +1,381 @@
+#
+# Copyright:: Copyright 2008-2016, Chef, 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 "train"
+require "train-rest"
+
+class RestResourceByQuery < Chef::Resource
+  use "core::rest_resource"
+
+  provides :rest_resource_by_query, target_mode: true
+
+  property :address, String, required: true
+  property :prefix, Integer, required: true
+  property :gateway, String
+
+  rest_api_collection "/api/v1/addresses"
+  rest_api_document   "/api/v1/address/?ip={address}"
+  rest_property_map({
+    address: "address",
+    prefix: "prefix",
+    gateway: "gateway",
+  })
+end
+
+class RestResourceByPath < RestResourceByQuery
+  provides :rest_resource_by_path, target_mode: true
+
+  rest_api_document "/api/v1/address/{address}"
+end
+
+describe "rest_resource using query-based addressing" do
+  let(:train) {
+    Train.create(
+    "rest", {
+      endpoint:   "https://api.example.com/api/v1/",
+      debug_rest: true,
+      logger:     Chef::Log,
+    }
+  ).connection
+  }
+
+  let(:run_context) do
+    cookbook_collection = Chef::CookbookCollection.new([])
+    node = Chef::Node.new
+    node.name "node1"
+    events = Chef::EventDispatch::Dispatcher.new
+    Chef::RunContext.new(node, cookbook_collection, events)
+  end
+
+  let(:resource) do
+    RestResourceByQuery.new("set_address", run_context).tap do |resource|
+      resource.address = "192.0.2.1"
+      resource.prefix = 24
+      resource.action :configure
+    end
+  end
+
+  let(:provider) do
+    resource.provider_for_action(:configure).tap do |provider|
+      provider.current_resource = resource # for some stubby tests that don't call LCR
+      allow(provider).to receive(:api_connection).and_return(train)
+    end
+  end
+
+  before(:each) do
+    allow(Chef::Provider).to receive(:new).and_return(provider)
+  end
+
+  it "should include :configure action" do
+    expect(provider).to respond_to(:action_configure)
+  end
+
+  it "should include :delete action" do
+    expect(provider).to respond_to(:action_delete)
+  end
+
+  it "should include :nothing action" do
+    expect(provider).to respond_to(:action_nothing)
+  end
+
+  it "sets the default action as :configure" do
+    expect(resource.action).to eql([:configure])
+  end
+
+  it "supports :configure action" do
+    expect { resource.action :configure }.not_to raise_error
+  end
+
+  it "supports :delete action" do
+    expect { resource.action :delete }.not_to raise_error
+  end
+
+  it "should mixin RestResourceDSL" do
+    expect(resource.class.ancestors).to include(Chef::DSL::RestResource)
+  end
+
+  describe "#rest_postprocess" do
+    before do
+      provider.singleton_class.send(:public, :rest_postprocess)
+    end
+    it "should have a default rest_postprocess implementation" do
+      expect(provider).to respond_to(:rest_postprocess)
+    end
+
+    it "should have a non-mutating rest_postprocess implementation" do
+      response = "{ data: nil }"
+
+      expect(provider.rest_postprocess(response.dup)).to eq(response)
+    end
+  end
+
+  describe "#rest_errorhandler" do
+    before do
+      provider.singleton_class.send(:public, :rest_errorhandler)
+    end
+
+    it "should have a default rest_errorhandler implementation" do
+      expect(provider).to respond_to(:rest_errorhandler)
+    end
+
+    it "should have a non-mutating rest_errorhandler implementation" do
+      error_obj = StandardError.new
+
+      expect(provider.rest_errorhandler(error_obj.dup)).to eq(error_obj)
+    end
+  end
+
+  describe "#required_properties" do
+    before do
+      provider.singleton_class.send(:public, :required_properties)
+    end
+
+    it "should include required properties only" do
+      expect(provider.required_properties).to contain_exactly(:address, :prefix)
+    end
+  end
+
+  describe "#property_map" do
+    before do
+      provider.singleton_class.send(:public, :property_map)
+    end
+
+    it "should map resource properties to values properly" do
+      expect(provider.property_map).to eq({
+        address: "192.0.2.1",
+        prefix: 24,
+        gateway: nil,
+        name: "set_address",
+      })
+    end
+  end
+
+  describe "#rest_url_collection" do
+    before do
+      provider.singleton_class.send(:public, :rest_url_collection)
+    end
+
+    it "should return collection URLs properly" do
+      expect(provider.rest_url_collection).to eq("/api/v1/addresses")
+    end
+  end
+
+  describe "#rest_url_document" do
+    before do
+      provider.singleton_class.send(:public, :rest_url_document)
+    end
+
+    it "should apply URI templates to document URLs using query syntax properly" do
+      expect(provider.rest_url_document).to eq("/api/v1/address/?ip=192.0.2.1")
+    end
+  end
+
+  # TODO: Test with path-style URLs
+  describe "#rest_identity_implicit" do
+    before do
+      provider.singleton_class.send(:public, :rest_identity_implicit)
+    end
+
+    it "should return implicit identity properties properly" do
+      expect(provider.rest_identity_implicit).to eq({ "ip" => :address })
+    end
+  end
+
+  describe "#rest_identity_values" do
+    before do
+      provider.singleton_class.send(:public, :rest_identity_values)
+    end
+
+    it "should return implicit identity properties and values properly" do
+      expect(provider.rest_identity_values).to eq({ "ip" => "192.0.2.1" })
+    end
+  end
+
+  # TODO: changed_value
+  # TODO: load_current_value
+
+  # this might be a functional test, but it runs on any O/S so I leave it here
+  describe "when managing a resource" do
+    before { WebMock.disable_net_connect! }
+    let(:addresses_exists) { JSON.generate([{ "address": "192.0.2.1" }]) }
+    let(:addresses_other) { JSON.generate([{ "address": "172.16.32.85" }]) }
+    let(:address_exists) { JSON.generate({ "address": "192.0.2.1", "prefix": 24, "gateway": "192.0.2.1" }) }
+    let(:prefix_wrong) { JSON.generate({ "address": "192.0.2.1", "prefix": 25, "gateway": "192.0.2.1" }) }
+
+    it "should be idempotent" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_exists, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: address_exists, headers: { "Content-Type" => "application/json" })
+      resource.run_action(:configure)
+      expect(resource.updated_by_last_action?).to be false
+    end
+
+    it "should PATCH if a property is incorrect" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_exists, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: prefix_wrong, headers: { "Content-Type" => "application/json" })
+      stub_request(:patch, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .with(
+          body: "{\"address\":\"192.0.2.1\",\"prefix\":25}",
+          headers: {
+            "Accept" => "application/json",
+            "Content-Type" => "application/json",
+          }
+        )
+        .to_return(status: 200, body: address_exists, headers: { "Content-Type" => "application/json" })
+      resource.run_action(:configure)
+      expect(resource.updated_by_last_action?).to be true
+    end
+
+    it "should POST if there's no resources at all" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: "[]", headers: { "Content-Type" => "application/json" })
+      stub_request(:post, "https://api.example.com/api/v1/addresses")
+        .with(
+          body: "{\"address\":\"192.0.2.1\",\"prefix\":24,\"ip\":\"192.0.2.1\"}"
+        )
+        .to_return(status: 200, body: address_exists, headers: { "Content-Type" => "application/json" })
+      resource.run_action(:configure)
+      expect(resource.updated_by_last_action?).to be true
+    end
+
+    it "should POST if the specific resource does not exist" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_other, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 404, body: "", headers: {})
+      stub_request(:post, "https://api.example.com/api/v1/addresses")
+        .with(
+          body: "{\"address\":\"192.0.2.1\",\"prefix\":24,\"ip\":\"192.0.2.1\"}"
+        )
+        .to_return(status: 200, body: address_exists, headers: { "Content-Type" => "application/json" })
+      resource.run_action(:configure)
+      expect(resource.updated_by_last_action?).to be true
+    end
+
+    it "should be idempotent if the resouces needs deleting and there are no resources at all" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: "[]", headers: { "Content-Type" => "application/json" })
+      resource.run_action(:delete)
+      expect(resource.updated_by_last_action?).to be false
+    end
+
+    it "should be idempotent if the resource doesn't exist" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_other, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 404, body: "", headers: {})
+      resource.run_action(:delete)
+      expect(resource.updated_by_last_action?).to be false
+    end
+
+    it "should DELETE the resource if it exists and matches" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_exists, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: address_exists, headers: { "Content-Type" => "application/json" })
+      stub_request(:delete, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: "", headers: {})
+      resource.run_action(:delete)
+      expect(resource.updated_by_last_action?).to be true
+    end
+
+    it "should DELETE the resource if it exists and doesn't match" do
+      stub_request(:get, "https://api.example.com/api/v1/addresses")
+        .to_return(status: 200, body: addresses_exists, headers: { "Content-Type" => "application/json" })
+      stub_request(:get, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: prefix_wrong, headers: { "Content-Type" => "application/json" })
+      stub_request(:delete, "https://api.example.com/api/v1/address/?ip=192.0.2.1")
+        .to_return(status: 200, body: "", headers: {})
+      resource.run_action(:delete)
+      expect(resource.updated_by_last_action?).to be true
+    end
+  end
+end
+
+describe "rest_resource using path-based addressing" do
+  let(:train) {
+    Train.create(
+    "rest", {
+      endpoint:   "https://api.example.com/api/v1/",
+      debug_rest: true,
+      logger:     Chef::Log,
+    }
+  ).connection
+  }
+
+  let(:run_context) do
+    cookbook_collection = Chef::CookbookCollection.new([])
+    node = Chef::Node.new
+    node.name "node1"
+    events = Chef::EventDispatch::Dispatcher.new
+    Chef::RunContext.new(node, cookbook_collection, events)
+  end
+
+  let(:resource) do
+    RestResourceByPath.new("set_address", run_context).tap do |resource|
+      resource.address = "192.0.2.1"
+      resource.prefix = 24
+      resource.action :configure
+    end
+  end
+
+  let(:provider) do
+    resource.provider_for_action(:configure).tap do |provider|
+      provider.current_resource = resource # for some stubby tests that don't call LCR
+      allow(provider).to receive(:api_connection).and_return(train)
+    end
+  end
+
+  before(:each) do
+    allow(Chef::Provider).to receive(:new).and_return(provider)
+  end
+
+  describe "#rest_url_document" do
+    before do
+      provider.singleton_class.send(:public, :rest_url_document)
+    end
+
+    it "should apply URI templates to document URLs using path syntax properly" do
+      expect(provider.rest_url_document).to eq("/api/v1/address/192.0.2.1")
+    end
+  end
+
+  describe "#rest_identity_implicit" do
+    before do
+      provider.singleton_class.send(:public, :rest_identity_implicit)
+    end
+
+    it "should return implicit identity properties properly" do
+      expect(provider.rest_identity_implicit).to eq({ "address" => :address })
+    end
+  end
+
+  describe "#rest_identity_values" do
+    before do
+      provider.singleton_class.send(:public, :rest_identity_values)
+    end
+
+    it "should return implicit identity properties and values properly" do
+      expect(provider.rest_identity_values).to eq({ "address" => "192.0.2.1" })
+    end
+  end
+
+end

data/spec/unit/resource/selinux_boolean_spec.rb

@@ -0,0 +1,92 @@
+#
+# 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::SelinuxBoolean do
+  let(:node) { Chef::Node.new }
+  let(:events) { Chef::EventDispatch::Dispatcher.new }
+  let(:run_context) { Chef::RunContext.new(node, {}, events) }
+  let(:resource) { Chef::Resource::SelinuxBoolean.new("fakey_fakerton", run_context) }
+  let(:provider) { resource.provider_for_action(:set) }
+  let(:selinux_state) { double("shellout!", stdout: "permissive") }
+
+  it "sets boolean proprty as name_property" do
+    expect(resource.boolean).to eql("fakey_fakerton")
+  end
+
+  it "sets the default action as :set" do
+    expect(resource.action).to eql([:set])
+  end
+
+  it "supports :set action" do
+    expect { resource.action :set }.not_to raise_error
+  end
+
+  context "coercing value property" do
+    it "should set value properly to 'on' when valid parameter is sent and is literal positive" do
+      resource.value = 1
+      expect(resource.value).to eql("on")
+
+      resource.value = "true"
+      expect(resource.value).to eql("on")
+
+      resource.value = true
+      expect(resource.value).to eql("on")
+    end
+
+    it "should set value properly to 'off' when valid parameter is sent and is literal negative" do
+      resource.value = 0
+      expect(resource.value).to eql("off")
+
+      resource.value = "false"
+      expect(resource.value).to eql("off")
+
+      resource.value = false
+      expect(resource.value).to eql("off")
+    end
+
+    it "should raise an exception if invalid parameter is sent" do
+      expect do
+        resource.value = "ON"
+      end.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "#Chef::SELinux::CommonHelpers" do
+    context "#selinux_permissive?" do
+      it "should return true if selinux_state is :permissive" do
+        allow(provider).to receive(:shell_out!).and_return(selinux_state)
+        expect(provider.selinux_permissive?).to eql(true)
+      end
+    end
+
+    context "#selinux_disabled?" do
+      it "should return false if selinux_state is :permissive" do
+        allow(provider).to receive(:shell_out!).and_return(selinux_state)
+        expect(provider.selinux_disabled?).to eql(false)
+      end
+    end
+
+    context "#selinux_enforcing?" do
+      it "should return false if selinux_state is :permissive" do
+        allow(provider).to receive(:shell_out!).and_return(selinux_state)
+        expect(provider.selinux_enforcing?).to eql(false)
+      end
+    end
+  end
+end