path: root/spec/unit/provider/package_spec.rb

#
# Author:: Adam Jacob (<adam@opscode.com>)
# Copyright:: Copyright (c) 2008 Opscode, 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::Package do
  before do
    @node = Chef::Node.new
    @events = Chef::EventDispatch::Dispatcher.new
    @run_context = Chef::RunContext.new(@node, {}, @events)
    @new_resource = Chef::Resource::Package.new('emacs')
    @current_resource = Chef::Resource::Package.new('emacs')
    @provider = Chef::Provider::Package.new(@new_resource, @run_context)
    @provider.current_resource = @current_resource

    @provider.candidate_version = "1.0"
  end

  describe "when installing a package" do
    before(:each) do
      @provider.current_resource = @current_resource
      allow(@provider).to receive(:install_package).and_return(true)
    end

    it "should raise a Chef::Exceptions::Package if no version is specified, and no candidate is available" do
      @provider.candidate_version = nil
      expect { @provider.run_action(:install) }.to raise_error(Chef::Exceptions::Package)
    end

    it "should call preseed_package if a response_file is given" do
      @new_resource.response_file("foo")
      expect(@provider).to receive(:get_preseed_file).with(
        @new_resource.name,
        @provider.candidate_version
      ).and_return("/var/cache/preseed-test")

      expect(@provider).to receive(:preseed_package).with(
        "/var/cache/preseed-test"
      ).and_return(true)
      @provider.run_action(:install)
    end

    it "should not call preseed_package if a response_file is not given" do
      expect(@provider).not_to receive(:preseed_package)
      @provider.run_action(:install)
    end

    it "should install the package at the candidate_version if it is not already installed" do
      expect(@provider).to receive(:install_package).with(
        @new_resource.name,
        @provider.candidate_version
      ).and_return(true)
      @provider.run_action(:install)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should install the package at the version specified if it is not already installed" do
      @new_resource.version("1.0")
      expect(@provider).to receive(:install_package).with(
        @new_resource.name,
        @new_resource.version
      ).and_return(true)
      @provider.run_action(:install)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should install the package at the version specified if a different version is installed" do
      @new_resource.version("1.0")
      allow(@current_resource).to receive(:version).and_return("0.99")
      expect(@provider).to receive(:install_package).with(
        @new_resource.name,
        @new_resource.version
      ).and_return(true)
      @provider.run_action(:install)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should not install the package if it is already installed and no version is specified" do
      @current_resource.version("1.0")
      expect(@provider).not_to receive(:install_package)
      @provider.run_action(:install)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should not install the package if it is already installed at the version specified" do
      @current_resource.version("1.0")
      @new_resource.version("1.0")
      expect(@provider).not_to receive(:install_package)
      @provider.run_action(:install)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should call the candidate_version accessor only once if the package is already installed and no version is specified" do
      @current_resource.version("1.0")
      allow(@provider).to receive(:candidate_version).and_return("1.0")
      @provider.run_action(:install)
    end

    it "should call the candidate_version accessor only once if the package is already installed at the version specified" do
      @current_resource.version("1.0")
      @new_resource.version("1.0")
      @provider.run_action(:install)
    end

    it "should set the resource to updated if it installs the package" do
      @provider.run_action(:install)
      expect(@new_resource).to be_updated
    end

  end

  describe "when upgrading the package" do
    before(:each) do
      allow(@provider).to receive(:upgrade_package).and_return(true)
    end

    it "should upgrade the package if the current version is not the candidate version" do
      expect(@provider).to receive(:upgrade_package).with(
        @new_resource.name,
        @provider.candidate_version
      ).and_return(true)
      @provider.run_action(:upgrade)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should set the resource to updated if it installs the package" do
      @provider.run_action(:upgrade)
      expect(@new_resource).to be_updated
    end

    it "should not install the package if the current version is the candidate version" do
      @current_resource.version "1.0"
      expect(@provider).not_to receive(:upgrade_package)
      @provider.run_action(:upgrade)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should print the word 'uninstalled' if there was no original version" do
      allow(@current_resource).to receive(:version).and_return(nil)
      expect(Chef::Log).to receive(:info).with("package[emacs] upgraded from uninstalled to 1.0")
      @provider.run_action(:upgrade)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should raise a Chef::Exceptions::Package if current version and candidate are nil" do
      allow(@current_resource).to receive(:version).and_return(nil)
      @provider.candidate_version = nil
      expect { @provider.run_action(:upgrade) }.to raise_error(Chef::Exceptions::Package)
    end

    it "should not install the package if candidate version is nil" do
      @current_resource.version "1.0"
      @provider.candidate_version = nil
      expect(@provider).not_to receive(:upgrade_package)
      @provider.run_action(:upgrade)
      expect(@new_resource).not_to be_updated_by_last_action
    end
  end

  describe "When removing the package" do
    before(:each) do
      allow(@provider).to receive(:remove_package).and_return(true)
      @current_resource.version '1.4.2'
    end

    it "should remove the package if it is installed" do
      expect(@provider).to be_removing_package
      expect(@provider).to receive(:remove_package).with('emacs', nil)
      @provider.run_action(:remove)
      expect(@new_resource).to be_updated
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should remove the package at a specific version if it is installed at that version" do
      @new_resource.version "1.4.2"
      expect(@provider).to be_removing_package
      expect(@provider).to receive(:remove_package).with('emacs', '1.4.2')
      @provider.run_action(:remove)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should not remove the package at a specific version if it is not installed at that version" do
      @new_resource.version "1.0"
      expect(@provider).not_to be_removing_package
      expect(@provider).not_to receive(:remove_package)
      @provider.run_action(:remove)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should not remove the package if it is not installed" do
      expect(@provider).not_to receive(:remove_package)
      allow(@current_resource).to receive(:version).and_return(nil)
      @provider.run_action(:remove)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should set the resource to updated if it removes the package" do
      @provider.run_action(:remove)
      expect(@new_resource).to be_updated
    end

  end

  describe "When purging the package" do
    before(:each) do
      allow(@provider).to receive(:purge_package).and_return(true)
      @current_resource.version '1.4.2'
    end

    it "should purge the package if it is installed" do
      expect(@provider).to be_removing_package
      expect(@provider).to receive(:purge_package).with('emacs', nil)
      @provider.run_action(:purge)
      expect(@new_resource).to be_updated
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should purge the package at a specific version if it is installed at that version" do
      @new_resource.version "1.4.2"
      expect(@provider).to be_removing_package
      expect(@provider).to receive(:purge_package).with('emacs', '1.4.2')
      @provider.run_action(:purge)
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should not purge the package at a specific version if it is not installed at that version" do
      @new_resource.version "1.0"
      expect(@provider).not_to be_removing_package
      expect(@provider).not_to receive(:purge_package)
      @provider.run_action(:purge)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should not purge the package if it is not installed" do
      @current_resource.instance_variable_set(:@version, nil)
      expect(@provider).not_to be_removing_package

      expect(@provider).not_to receive(:purge_package)
      @provider.run_action(:purge)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should set the resource to updated if it purges the package" do
      @provider.run_action(:purge)
      expect(@new_resource).to be_updated
    end

  end

  describe "when reconfiguring the package" do
    before(:each) do
      allow(@provider).to receive(:reconfig_package).and_return(true)
    end

    it "should info log, reconfigure the package and update the resource" do
      allow(@current_resource).to receive(:version).and_return('1.0')
      allow(@new_resource).to receive(:response_file).and_return(true)
      expect(@provider).to receive(:get_preseed_file).and_return('/var/cache/preseed-test')
      allow(@provider).to receive(:preseed_package).and_return(true)
      allow(@provider).to receive(:reconfig_package).and_return(true)
      expect(Chef::Log).to receive(:info).with("package[emacs] reconfigured")
      expect(@provider).to receive(:reconfig_package)
      @provider.run_action(:reconfig)
      expect(@new_resource).to be_updated
      expect(@new_resource).to be_updated_by_last_action
    end

    it "should debug log and not reconfigure the package if the package is not installed" do
      allow(@current_resource).to receive(:version).and_return(nil)
      expect(Chef::Log).to receive(:debug).with("package[emacs] is NOT installed - nothing to do")
      expect(@provider).not_to receive(:reconfig_package)
      @provider.run_action(:reconfig)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should debug log and not reconfigure the package if no response_file is given" do
      allow(@current_resource).to receive(:version).and_return('1.0')
      allow(@new_resource).to receive(:response_file).and_return(nil)
      expect(Chef::Log).to receive(:debug).with("package[emacs] no response_file provided - nothing to do")
      expect(@provider).not_to receive(:reconfig_package)
      @provider.run_action(:reconfig)
      expect(@new_resource).not_to be_updated_by_last_action
    end

    it "should debug log and not reconfigure the package if the response_file has not changed" do
      allow(@current_resource).to receive(:version).and_return('1.0')
      allow(@new_resource).to receive(:response_file).and_return(true)
      expect(@provider).to receive(:get_preseed_file).and_return(false)
      allow(@provider).to receive(:preseed_package).and_return(false)
      expect(Chef::Log).to receive(:debug).with("package[emacs] preseeding has not changed - nothing to do")
      expect(@provider).not_to receive(:reconfig_package)
      @provider.run_action(:reconfig)
      expect(@new_resource).not_to be_updated_by_last_action
    end
  end

  describe "when running commands to be implemented by subclasses" do
    it "should raises UnsupportedAction for install" do
      expect { @provider.install_package('emacs', '1.4.2') }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end

    it "should raises UnsupportedAction for upgrade" do
      expect { @provider.upgrade_package('emacs', '1.4.2') }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end

    it "should raises UnsupportedAction for remove" do
      expect { @provider.remove_package('emacs', '1.4.2') }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end

    it "should raises UnsupportedAction for purge" do
      expect { @provider.purge_package('emacs', '1.4.2') }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end

    it "should raise UnsupportedAction for preseed_package" do
      preseed_file = "/tmp/sun-jdk-package-preseed-file.seed"
      expect { @provider.preseed_package(preseed_file) }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end

    it "should raise UnsupportedAction for reconfig" do
      expect { @provider.reconfig_package('emacs', '1.4.2') }.to raise_error(Chef::Exceptions::UnsupportedAction)
    end
  end

  describe "when given a response file" do
    before(:each) do
      @cookbook_repo = File.expand_path(File.join(CHEF_SPEC_DATA, "cookbooks"))
      Chef::Cookbook::FileVendor.fetch_from_disk(@cookbook_repo)

      @node = Chef::Node.new
      cl = Chef::CookbookLoader.new(@cookbook_repo)
      cl.load_cookbooks
      @cookbook_collection = Chef::CookbookCollection.new(cl)

      @run_context = Chef::RunContext.new(@node, @cookbook_collection, @events)
      @provider.run_context = @run_context

      @node.automatic_attrs[:platform] = 'PLATFORM: just testing'
      @node.automatic_attrs[:platform_version] = 'PLATFORM VERSION: just testing'

      @new_resource.response_file('java.response')
      @new_resource.cookbook_name = 'java'
    end

    describe "creating the cookbook file resource to fetch the response file" do
      before do
        expect(Chef::FileCache).to receive(:create_cache_path).with('preseed/java').and_return("/tmp/preseed/java")
      end

      it "sets the preseed resource's runcontext to its own run context" do
        allow(Chef::FileCache).to receive(:create_cache_path).and_return("/tmp/preseed/java")
        expect(@provider.preseed_resource('java', '6').run_context).not_to be_nil
        expect(@provider.preseed_resource('java', '6').run_context).to equal(@provider.run_context)
      end

      it "should set the cookbook name of the remote file to the new resources cookbook name" do
        expect(@provider.preseed_resource('java', '6').cookbook_name).to eq('java')
      end

      it "should set remote files source to the new resources response file" do
        expect(@provider.preseed_resource('java', '6').source).to eq('java.response')
      end

      it "should never back up the cached response file" do
        expect(@provider.preseed_resource('java', '6').backup).to be_false
      end

      it "sets the install path of the resource to $file_cache/$cookbook/$pkg_name-$pkg_version.seed" do
        expect(@provider.preseed_resource('java', '6').path).to eq('/tmp/preseed/java/java-6.seed')
      end
    end

    describe "when installing the preseed file to the cache location" do
      before do
        @node.automatic_attrs[:platform] = :just_testing
        @node.automatic_attrs[:platform_version] = :just_testing

        @response_file_destination = Dir.tmpdir + '/preseed--java--java-6.seed'

        @response_file_resource = Chef::Resource::CookbookFile.new(@response_file_destination, @run_context)
        @response_file_resource.cookbook_name = 'java'
        @response_file_resource.backup(false)
        @response_file_resource.source('java.response')


        expect(@provider).to receive(:preseed_resource).with('java', '6').and_return(@response_file_resource)
      end

      after do
        FileUtils.rm(@response_file_destination) if ::File.exist?(@response_file_destination)
      end

      it "creates the preseed file in the cache" do
        expect(@response_file_resource).to receive(:run_action).with(:create)
        @provider.get_preseed_file("java", "6")
      end

      it "returns the path to the response file if the response file was updated" do
        expect(@provider.get_preseed_file("java", "6")).to eq(@response_file_destination)
      end

      it "should return false if the response file has not been updated" do
        @response_file_resource.updated_by_last_action(false)
        expect(@response_file_resource).not_to be_updated_by_last_action
        # don't let the response_file_resource set updated to true
        expect(@response_file_resource).to receive(:run_action).with(:create)
        expect(@provider.get_preseed_file("java", "6")).to be(false)
      end

    end

  end
end