chefspec 5.4.0 → 6.0.0

data/lib/chefspec/api/dnf_package.rb

@@ -0,0 +1,154 @@
+module ChefSpec::API
+  # @since 6.0.0
+  module DnfPackageMatchers
+    ChefSpec.define_matcher :dnf_package
+
+    #
+    # Assert that a +dnf_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "apache2" as a
+    # +dnf_package+:
+    #
+    #     dnf_package 'apache2' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +dnf_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +dnf_package+ was installed
+    #   expect(chef_run).to install_dnf_package('apache2')
+    #
+    # @example Assert that a +dnf_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_dnf_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was installed with attributes
+    #   expect(chef_run).to install_dnf_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was installed using a regex
+    #   expect(chef_run).to install_dnf_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dnf_package+ was _not_ installed
+    #   expect(chef_run).to_not install_dnf_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_dnf_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dnf_package, :install, resource_name)
+    end
+
+    #
+    # Assert that a +dnf_package+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "apache2" as a
+    # +dnf_package+:
+    #
+    #     dnf_package 'apache2' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +dnf_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +dnf_package+ was purged
+    #   expect(chef_run).to purge_dnf_package('apache2')
+    #
+    # @example Assert that a +dnf_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_dnf_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was purged with attributes
+    #   expect(chef_run).to purge_dnf_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was purged using a regex
+    #   expect(chef_run).to purge_dnf_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dnf_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_dnf_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_dnf_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dnf_package, :purge, resource_name)
+    end
+
+    #
+    # Assert that a +dnf_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as a
+    # +dnf_package+:
+    #
+    #     dnf_package 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +dnf_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +dnf_package+ was removed
+    #   expect(chef_run).to remove_dnf_package('apache2')
+    #
+    # @example Assert that a +dnf_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_dnf_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was removed with attributes
+    #   expect(chef_run).to remove_dnf_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was removed using a regex
+    #   expect(chef_run).to remove_dnf_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dnf_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_dnf_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_dnf_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dnf_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that a +dnf_package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "apache2" as a
+    # +dnf_package+:
+    #
+    #     dnf_package 'apache2' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +dnf_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +dnf_package+ was upgraded
+    #   expect(chef_run).to upgrade_dnf_package('apache2')
+    #
+    # @example Assert that a +dnf_package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_dnf_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_dnf_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dnf_package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_dnf_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dnf_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_dnf_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_dnf_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dnf_package, :upgrade, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/msu_package.rb

@@ -0,0 +1,81 @@
+module ChefSpec::API
+  # @since 6.0.0
+  module MsuPackageMatchers
+    ChefSpec.define_matcher :msu_package
+
+    #
+    # Assert that a +msu_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "KB2959977" as a
+    # +msu_package+:
+    #
+    #      msu_package 'KB2959977' do
+    #        source 'C:\Windows8.1-KB2959977-x64.msu'
+    #        action :install
+    #      end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +msu_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +msu_package+ was installed
+    #   expect(chef_run).to install_msu_package('KB2959977')
+    #
+    # @example Assert that a +msu_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_msu_package('KB2959977').with_source('C:\Windows8.1-KB2959977-x64.msu')
+    #
+    # @example Assert that a +msu_package+ was installed with attributes
+    #   expect(chef_run).to install_msu_package('KB2959977').with(source: 'C:\Windows8.1-KB2959977-x64.msu')
+    #
+    # @example Assert that a +msu_package+ was installed using a regex
+    #   expect(chef_run).to install_msu_package('KB2959977').with(source: /.*KB2959977.*/)
+    #
+    # @example Assert that a +msu_package+ was _not_ installed
+    #   expect(chef_run).to_not install_msu_package('KB2959977')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_msu_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:msu_package, :install, resource_name)
+    end
+
+    #
+    # Assert that a +msu_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "KB2959977" as a
+    # +msu_package+:
+    #
+    #     msu_package 'KB2959977' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +msu_package+ resource with ChefSpec.
+    #
+    # @example Assert that a +msu_package+ was removed
+    #   expect(chef_run).to remove_msu_package('KB2959977')
+    #
+    # @example Assert that a +msu_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_msu_package('KB2959977').with_source('C:\Windows8.1-KB2959977-x64.msu')
+    #
+    # @example Assert that a +msu_package+ was removed with attributes
+    #   expect(chef_run).to remove_msu_package('KB2959977').with(source: 'C:\Windows8.1-KB2959977-x64.msu')
+    #
+    # @example Assert that a +msu_package+ was removed using a regex
+    #   expect(chef_run).to remove_msu_package('KB2959977').with(source: /.*KB2959977.*/)
+    #
+    # @example Assert that a +msu_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_msu_package('KB2959977')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_msu_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:msu_package, :remove, resource_name)
+    end
+  end
+end

data/lib/chefspec/rspec.rb

@@ -20,4 +20,5 @@ RSpec.configure do |config|
   config.add_setting :platform
   config.add_setting :version
   config.add_setting :server_runner_data_store, default: :in_memory
+  config.add_setting :server_runner_clear_cookbooks, default: true
 end

data/lib/chefspec/server_methods.rb

@@ -10,16 +10,7 @@ module ChefSpec
     # @return [ChefZero::Server]
     #
     def server
-      @server ||= ChefZero::Server.new(
-        # Set the log level from RSpec, defaulting to warn
-        log_level:  RSpec.configuration.log_level || :warn,
-
-        # Set a random port so ChefSpec may be run in multiple contexts
-        port: port,
-
-        # Set the data store
-        data_store: data_store(RSpec.configuration.server_runner_data_store),
-      )
+      ChefSpec::ZeroServer.server
     end
 
     #
@@ -160,7 +151,7 @@ module ChefSpec
     #   to the server
     #
     def load_data(name, key, data = {})
-      @server.load_data({ key => { name => data } })
+      ChefSpec::ZeroServer.load_data(name, key, data)
     end
 
     #
@@ -170,32 +161,10 @@ module ChefSpec
       args.unshift('organizations', 'chef')
 
       if args.size == 3
-        @server.data_store.list(args)
+        server.data_store.list(args)
       else
-        @server.data_store.get(args)
+        server.data_store.get(args)
       end
     end
-
-    #
-    # Generate the DataStore object to be passed in to the ChefZero::Server object
-    #
-    def data_store(option)
-      require "chef_zero/data_store/default_facade"
-
-      store = case option
-              when :in_memory
-                require "chef_zero/data_store/memory_store_v2"
-                ChefZero::DataStore::MemoryStoreV2.new
-              when :on_disk
-                require "tmpdir"
-                require "chef_zero/data_store/raw_file_store"
-                tmpdir = Dir.mktmpdir
-                ChefZero::DataStore::RawFileStore.new(Dir.mktmpdir)
-              else
-                raise ArgumentError, ":#{option} is not a valid server_runner_data_store option. Please use either :in_memory or :on_disk."
-              end
-
-      ChefZero::DataStore::DefaultFacade.new(store, "chef", true)
-    end
   end
 end

data/lib/chefspec/server_runner.rb

@@ -1,7 +1,7 @@
-require 'chef_zero/server'
 require 'chef/cookbook_loader'
 require 'chef/cookbook_uploader'
 
+require_relative 'zero_server'
 require_relative 'file_cache_path_proxy'
 require_relative 'server_methods'
 require_relative 'solo_runner'
@@ -32,39 +32,14 @@ module ChefSpec
       Chef::Config[:chef_server_url]  = server.url
       Chef::Config[:http_retry_count] = 0
 
-      # Start the Chef Zero instance in the background
-      server.start_background
-      at_exit { server.stop if server.running? }
-
       # Unlike the SoloRunner, the node AND server object are yielded for
       # customization
       yield node, self if block_given?
     end
 
-    #
-    # Upload the cookbooks to the Chef Server.
-    #
-    def upload_cookbooks!
-      loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
-      loader.load_cookbooks
-      cookbook_uploader_for(loader).upload_cookbooks
-    end
-
-    #
-    # The uploader for the cookbooks.
-    #
-    # @param [Chef::CookbookLoader] loader
-    #   the Chef cookbook loader
-    #
-    # @return [Chef::CookbookUploader]
-    #
-    def cookbook_uploader_for(loader)
-      Chef::CookbookUploader.new(loader.cookbooks)
-    end
-
     # @see (SoloRunner#converge)
     def converge(*recipe_names)
-      upload_cookbooks!
+      ChefSpec::ZeroServer.upload_cookbooks!
 
       super do
         yield if block_given?
@@ -93,20 +68,5 @@ module ChefSpec
       at_exit { FileUtils.rm_rf(tmp) }
       path
     end
-
-    #
-    # A randomly assigned, open port for run the Chef Zero server.
-    #
-    # @return [Fixnum]
-    #
-    def port
-      return @port if @port
-
-      @server = TCPServer.new('127.0.0.1', 0)
-      @port   = @server.addr[1].to_i
-      @server.close
-
-      return @port
-    end
   end
 end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '5.4.0'
+  VERSION = '6.0.0'
 end

data/lib/chefspec/zero_server.rb

@@ -0,0 +1,139 @@
+require 'chef_zero/server'
+
+module ChefSpec
+  # Rather than create a ChefZero instance per test case, simply create one
+  # ChefZero instance and reset it for every test case.
+  class ZeroServer
+    class << self
+      extend Forwardable
+      def_delegators :instance, :setup!, :teardown!, :reset!, :upload_cookbooks!, :server, :load_data
+    end
+
+    include Singleton
+
+    # Create the ChefZero Server
+    def initialize
+      @server ||= ChefZero::Server.new(
+        # Set the log level from RSpec, defaulting to warn
+        log_level:  RSpec.configuration.log_level || :warn,
+
+        # Set the data store
+        data_store: data_store(RSpec.configuration.server_runner_data_store),
+      )
+      @cookbooks_uploaded = false
+      @data_loaded = {}
+    end
+
+    #
+    # Start the ChefZero Server
+    #
+    def setup!
+      @server.start_background unless @server.running?
+    end
+
+    #
+    # Remove all the data we just loaded from the ChefZero server
+    #
+    def reset!
+      if RSpec.configuration.server_runner_clear_cookbooks
+        @server.clear_data
+        @cookbooks_uploaded = false
+      else
+        # If we don't want to do a full clear, iterate through each value that we
+        # set and manually remove it.
+        @data_loaded.each do |key, names|
+          if key == "data"
+            names.each { |n| @server.data_store.delete_dir(["organizations", "chef", key, n]) }
+          else
+            names.each { |n| @server.data_store.delete(["organizations", "chef", key, n]) }
+          end
+        end
+      end
+      @data_loaded = {}
+    end
+
+    #
+    # Teardown the ChefZero Server
+    #
+    def teardown!
+      @server.stop if @server.running?
+    end
+
+    #
+    # Upload the cookbooks to the Chef Server.
+    #
+    def upload_cookbooks!
+      return if @cookbooks_uploaded
+      loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
+      loader.load_cookbooks
+      cookbook_uploader_for(loader).upload_cookbooks
+      @cookbooks_uploaded = true
+    end
+
+    #
+    # The URL for the ChefZero Server
+    #
+    def server
+      @server
+    end
+
+    #
+    # Load (and track) data sent to the server
+    #
+    # @param [String] name
+    #   the name or id of the item to load
+    # @param [String, Symbol] key
+    #   the key to load
+    # @param [Hash] data
+    #   the data for the object, which will be converted to JSON and uploaded
+    #   to the server
+    #
+    def load_data(name, key, data)
+      @data_loaded[key] ||= []
+      @data_loaded[key] << name
+      @server.load_data({ key => { name => data } })
+    end
+
+    private
+
+    #
+    # The uploader for the cookbooks.
+    #
+    # @param [Chef::CookbookLoader] loader
+    #   the Chef cookbook loader
+    #
+    # @return [Chef::CookbookUploader]
+    #
+    def cookbook_uploader_for(loader)
+      Chef::CookbookUploader.new(loader.cookbooks)
+    end
+
+    #
+    # Generate the DataStore object to be passed in to the ChefZero::Server object
+    #
+    def data_store(option)
+      require "chef_zero/data_store/default_facade"
+
+      store = case option
+              when :in_memory
+                require "chef_zero/data_store/memory_store_v2"
+                ChefZero::DataStore::MemoryStoreV2.new
+              when :on_disk
+                require "tmpdir"
+                require "chef_zero/data_store/raw_file_store"
+                tmpdir = Dir.mktmpdir
+                ChefZero::DataStore::RawFileStore.new(Dir.mktmpdir)
+              else
+                raise ArgumentError, ":#{option} is not a valid server_runner_data_store option. Please use either :in_memory or :on_disk."
+              end
+
+      ChefZero::DataStore::DefaultFacade.new(store, "chef", true)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:suite) { ChefSpec::ZeroServer.setup! }
+  config.after(:each) { ChefSpec::ZeroServer.reset! }
+  config.after(:suite)  { ChefSpec::ZeroServer.teardown! }
+end