diff options
| -rw-r--r-- | lib/chef/provider/apt_update.rb | 78 | ||||
| -rw-r--r-- | lib/chef/providers.rb | 1 | ||||
| -rw-r--r-- | lib/chef/resource/apt_update.rb | 33 | ||||
| -rw-r--r-- | lib/chef/resources.rb | 1 | ||||
| -rw-r--r-- | spec/unit/provider/apt_update_spec.rb | 113 | ||||
| -rw-r--r-- | spec/unit/resource/apt_update_spec.rb | 38 |
6 files changed, 264 insertions, 0 deletions
diff --git a/lib/chef/provider/apt_update.rb b/lib/chef/provider/apt_update.rb new file mode 100644 index 0000000000..00c3ad16bb --- /dev/null +++ b/lib/chef/provider/apt_update.rb @@ -0,0 +1,78 @@ +# +# Author:: Thom May (<thom@chef.io>) +# Copyright:: Copyright (c) 2016 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 "chef/resource" +require "chef/dsl/declare_resource" + +class Chef + class Provider + class AptUpdate < Chef::Provider + include Chef::DSL::DeclareResource + + provides :apt_update, os: "linux" + + APT_CONF_DIR = "/etc/apt/apt.conf.d" + STAMP_DIR = "/var/lib/apt/periodic" + + def whyrun_supported? + true + end + + def load_current_resource + end + + def action_periodic + if !apt_up_to_date? + converge_by "update new lists of packages" do + do_update + end + end + end + + def action_update + converge_by "force update new lists of packages" do + do_update + end + end + + private + # Determines whether we need to run `apt-get update` + # + # @return [Boolean] + def apt_up_to_date? + ::File.exist?("#{STAMP_DIR}/update-success-stamp") && + ::File.mtime("#{STAMP_DIR}/update-success-stamp") > Time.now - new_resource.frequency + end + + def do_update + [STAMP_DIR, APT_CONF_DIR].each do |d| + build_resource(:directory, d, caller[0]) do + recursive true + end.run_action(:create) + end + + build_resource(:file, "#{APT_CONF_DIR}/15update-stamp", caller[0]) do + content "APT::Update::Post-Invoke-Success {\"touch #{STAMP_DIR}/update-success-stamp 2>/dev/null || true\";};" + end.run_action(:create_if_missing) + + shell_out!("apt-get -q update") + end + + end + end +end diff --git a/lib/chef/providers.rb b/lib/chef/providers.rb index b024be5b62..935933d326 100644 --- a/lib/chef/providers.rb +++ b/lib/chef/providers.rb @@ -16,6 +16,7 @@ # limitations under the License. # +require "chef/provider/apt_update" require "chef/provider/batch" require "chef/provider/breakpoint" require "chef/provider/cookbook_file" diff --git a/lib/chef/resource/apt_update.rb b/lib/chef/resource/apt_update.rb new file mode 100644 index 0000000000..df2033b063 --- /dev/null +++ b/lib/chef/resource/apt_update.rb @@ -0,0 +1,33 @@ +# +# Author:: Thom May (<thom@chef.io>) +# Copyright:: Copyright (c) 2016 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 "chef/resource" + +class Chef + class Resource + class AptUpdate < Chef::Resource + resource_name :apt_update + provides :apt_update, os: "linux" + + property :frequency, Integer, default: 86_400 + + default_action :periodic + allowed_actions :update, :periodic + end + end +end diff --git a/lib/chef/resources.rb b/lib/chef/resources.rb index dc1b195d25..647db5fc00 100644 --- a/lib/chef/resources.rb +++ b/lib/chef/resources.rb @@ -17,6 +17,7 @@ # require "chef/resource/apt_package" +require "chef/resource/apt_update" require "chef/resource/bash" require "chef/resource/batch" require "chef/resource/breakpoint" diff --git a/spec/unit/provider/apt_update_spec.rb b/spec/unit/provider/apt_update_spec.rb new file mode 100644 index 0000000000..b72f7d9a76 --- /dev/null +++ b/spec/unit/provider/apt_update_spec.rb @@ -0,0 +1,113 @@ +# +# Author:: Thom May (<thom@chef.io>) +# Copyright:: Copyright (c) 2016 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::AptUpdate do + let(:new_resource) { Chef::Resource::AptUpdate.new("update") } + + let(:config_dir) { Dir.mktmpdir("apt_update_apt_conf_d") } + let(:config_file) { File.join(config_dir, "15update-stamp") } + let(:stamp_dir) { Dir.mktmpdir("apt_update_periodic") } + + before do + stub_const("Chef::Provider::AptUpdate::APT_CONF_DIR", config_dir) + stub_const("Chef::Provider::AptUpdate::STAMP_DIR", stamp_dir) + end + + let(:provider) do + node = Chef::Node.new + events = Chef::EventDispatch::Dispatcher.new + run_context = Chef::RunContext.new(node, {}, events) + Chef::Provider::AptUpdate.new(new_resource, run_context) + end + + it "responds to load_current_resource" do + expect(provider).to respond_to(:load_current_resource) + end + + context "when the apt config directory does not exist" do + before do + FileUtils.rmdir config_dir + expect(File.exist?(config_dir)).to be_falsey + allow(provider).to receive(:shell_out!).with("apt-get -q update") + end + + it "should create the directory" do + provider.run_action(:update) + expect(File.exist?(config_dir)).to be_truthy + expect(File.directory?(config_dir)).to be_truthy + end + + it "should create the config file" do + provider.run_action(:update) + expect(File.exist?(config_file)).to be_truthy + expect(File.read(config_file)).to match(/^APT::Update.*#{stamp_dir}/) + end + end + + describe "#action_update" do + it "should update the apt cache" do + provider.load_current_resource + expect(provider).to receive(:shell_out!).with("apt-get -q update").and_return(double) + provider.run_action(:update) + expect(new_resource).to be_updated_by_last_action + end + end + + describe "#action_periodic" do + before do + allow(File).to receive(:exist?) + expect(File).to receive(:exist?).with("#{stamp_dir}/update-success-stamp").and_return(true) + end + + 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(provider).to receive(:shell_out!).with("apt-get -q update") + 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(provider).to_not receive(:shell_out!).with("apt-get -q update") + provider.run_action(:periodic) + expect(new_resource).to_not be_updated_by_last_action + end + + context "with a different frequency" do + before do + new_resource.frequency(400) + end + + 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(provider).to receive(:shell_out!).with("apt-get -q update") + 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(provider).to_not receive(:shell_out!).with("apt-get -q update") + provider.run_action(:periodic) + expect(new_resource).to_not be_updated_by_last_action + end + end + end +end diff --git a/spec/unit/resource/apt_update_spec.rb b/spec/unit/resource/apt_update_spec.rb new file mode 100644 index 0000000000..8015cb03b3 --- /dev/null +++ b/spec/unit/resource/apt_update_spec.rb @@ -0,0 +1,38 @@ +# +# Author:: Thom May (<thom@chef.io>) +# Copyright:: Copyright (c) 2016 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::AptUpdate do + + let(:resource) { Chef::Resource::AptUpdate.new("update") } + + it "should create a new Chef::Resource::AptUpdate" do + expect(resource).to be_a_kind_of(Chef::Resource) + expect(resource).to be_a_kind_of(Chef::Resource::AptUpdate) + end + + it "the default frequency should be 1 day" do + expect(resource.frequency).to eql(86_400) + end + + it "the frequency should accept integers" do + resource.frequency(400) + expect(resource.frequency).to eql(400) + end +end |