chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chef/knife/cookbook_create_specs.rb

@@ -1,107 +0,0 @@
-require 'chefspec'
-
-if Chef.const_defined? :Knife
-  module ChefSpec
-    module Knife
-
-      # Knife plugin to create placeholder specs.
-      #
-      # $ knife cookbook create -o . my_new_cookbook
-      # $ knife cookbook create_specs -o . my_new_cookbook
-      # $ rspec my_new_cookbook
-      #
-      # http://help.opscode.com/kb/knife/manage-cookbooks-with-knife
-      class CookbookCreateSpecs < Chef::Knife
-
-        # Implemented as a separate knife command rather than extending the knife built-in create_cookbook_command.
-        # Extension may arguably have been better from the end user perspective but would be much more brittle.
-
-        banner "knife cookbook create_specs COOKBOOK (options)"
-
-        option :cookbook_path,
-               :short => "-o PATH",
-               :long => "--cookbook-path PATH",
-               :description => "The directory where the cookbook specs will be created"
-
-        # Invoke this command and create the new specs
-        def run
-          self.config = Chef::Config.merge!(config)
-          if @name_args.empty?
-            show_usage
-            ui.fatal("You must specify a cookbook name")
-            exit 1
-          end
-
-          if default_cookbook_path_empty? && parameter_empty?(config[:cookbook_path])
-            raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to."
-          end
-
-          create_specs(Array(config[:cookbook_path]).first, @name_args.first)
-        end
-
-        private
-
-        # Has a default cookbook path been set?
-        #
-        # @return [Boolean] True if cookbook path has been set in the Chef config.
-        def default_cookbook_path_empty?
-          Chef::Config[:cookbook_path].nil? || Chef::Config[:cookbook_path].empty?
-        end
-
-        # Create placeholder specs for the cookbook.
-        #
-        # @param [String] dir The directory to create the specs in
-        # @param [String] cookbook The name of the cookbook
-        # @param [String] recipe The name of the recipe to create a spec for
-        def create_specs(dir, cookbook)
-          spec_dir = "#{File.join(dir, cookbook, 'spec')}"
-          FileUtils.mkdir_p spec_dir
-          msg("** Creating specs for cookbook: #{cookbook}")
-          existing_recipes(dir, cookbook).each do |recipe|
-            create_spec(spec_dir, cookbook, recipe)
-          end
-        end
-
-        # The list of recipes for a cookbook
-        #
-        # @param [String] dir The directory
-        # @param [String] cookbook The name of the cookbook
-        # @return [Array] The list of recipes for the cookbook
-        def existing_recipes(dir, cookbook)
-          Dir[File.join(dir, cookbook, 'recipes/*.rb')].map{|recipe| File.basename recipe, '.rb'}
-        end
-
-        # Create a placeholder spec for the cookbook.
-        #
-        # @param [String] spec_dir The directory to create the specs in
-        # @param [String] cookbook The name of the cookbook
-        # @param [String] recipe The name of the recipe to create a spec for
-        def create_spec(spec_dir, cookbook, recipe)
-          unless File.exists?(File.join(spec_dir, "#{recipe}_spec.rb"))
-            open(File.join(spec_dir, "#{recipe}_spec.rb"), "w") do |file|
-              file.puts spec_file_content(cookbook, recipe)
-            end
-          end
-        end
-
-        # Generate the content for the placeholder spec file.
-        #
-        # @param [String] cookbook The name of the cookbook
-        # @param [String] recipe The name of the recipe
-        def spec_file_content(cookbook, recipe)
-          return <<-EOH
-require 'chefspec'
-
-describe '#{cookbook}::#{recipe}' do
-  let (:chef_run) { ChefSpec::ChefRunner.new.converge '#{cookbook}::#{recipe}' }
-  it 'should do something' do
-    pending 'Your recipe examples go here.'
-  end
-end
-          EOH
-        end
-
-      end
-    end
-  end
-end

data/lib/chefspec/chef_runner.rb

@@ -1,275 +0,0 @@
-require 'chef'
-require 'chef/client'
-require 'chef/cookbook_loader'
-require 'fauxhai'
-
-require 'chefspec/matchers/shared'
-
-begin
-  require 'berkshelf'
-rescue LoadError; end
-
-# ChefSpec allows you to write rspec examples for Chef recipes to gain faster feedback without the need to converge a
-# node.
-module ChefSpec
-
-  # The main entry point for running recipes within RSpec.
-  class ChefRunner
-
-    @resources = []
-
-    @needs_formatter_registered = Chef::Config.respond_to?(:add_formatter)
-    @nfr_mutex = Mutex.new
-
-    def self.register_formatter
-      return unless @needs_formatter_registered
-      @nfr_mutex.synchronize do
-        return unless @needs_formatter_registered
-        @needs_formatter_registered = false
-        # As of Chef 11, Chef uses custom formatters which munge the RSpec output.
-        # This uses a custom formatter which basically tells Chef to shut up.
-        Chef::Config.add_formatter('chefspec')
-      end
-    end
-
-    attr_accessor :resources
-    attr_reader :step_into
-    attr_reader :run_context
-    attr_reader :node
-    attr_reader :stubbed_commands
-
-    # Instantiate a new runner to run examples with.
-    #
-    # @param [Hash] options The options for the new runner
-    # @option options [String] :cookbook_path The path to the chef cookbook(s) to be tested.
-    # @option options [Symbol] :log_level The log level to use (default is :warn)
-    # @option options [String] :platform The platform to load Ohai attributes from (must be present in fauxhai)
-    # @option options [String] :version The version of the platform to load Ohai attributes from (must be present in fauxhai)
-    # @option options [String] :ohai_data_path Path of a json file that will be passed to fauxhai as :path option
-    # @yield [node] Configuration block for Chef::Node
-    def initialize(options={})
-      # Because we evaluate the "caller" in this method, we need to call
-      # it first so that the path is correctly calculated.
-      @default_cookbook_path = default_cookbook_path
-
-      defaults = {
-        :cookbook_path => cookbook_paths,
-        :log_level => :warn,
-        :dry_run => false,
-        :step_into => [],
-        :evaluate_guards => false
-      }
-      options = {:cookbook_path => options} unless options.respond_to?(:to_hash) # backwards-compatibility
-      @options = defaults.merge(options)
-
-      the_runner = self
-      @resources = []
-      @step_into = @options[:step_into]
-      @do_dry_run = @options[:dry_run]
-      @evaluate_guards = @options[:evaluate_guards]
-      @actually_run_shell_guards = @options[:actually_run_shell_guards]
-      @stubbed_commands = []
-
-      Chef::Resource::Conditional.class_eval do
-        if self.class.methods.include?(:class_variable_set)
-          self.class_variable_set :@@runner, the_runner
-        else
-          @@runner = the_runner
-        end
-        def runner
-          if self.class.methods.include?(:class_variable_get)
-            self.class.send(:class_variable_get, :@@runner)
-          else
-            @@runner
-          end
-        end
-      end
-
-      Chef::Resource.class_eval do
-        alias :old_run_action :run_action unless method_defined?(:old_run_action)
-
-        if self.class.methods.include?(:class_variable_set)
-          self.class_variable_set :@@runner, the_runner
-        else
-          @@runner = the_runner
-        end
-
-        def run_action(*args)
-          action = args.first
-          runner = if self.class.methods.include?(:class_variable_get)
-            self.class.class_variable_get(:@@runner)
-          else
-            @@runner
-          end
-
-          if runner.evaluate_guards?
-            if self.respond_to?(:should_skip?) # Chef >= 0.10
-              if self.method(:should_skip?).arity == 1
-                return if self.should_skip?(action)
-              else
-                return if self.should_skip?
-              end
-            end
-          end
-
-          if runner.step_into.include?(self.resource_name.to_s)
-            # Ignore not_if / only_if guards
-            if self.only_if.is_a?(Array) # 0.10.x
-              self.instance_eval { @not_if = []; @only_if = [] }
-            else # 0.9.x
-              self.only_if { true }
-              self.not_if { false }
-            end
-            self.old_run_action(action)
-          end
-
-          Chef::Log.info("Processing #{self} action #{action} (#{defined_at})") if self.respond_to? :defined_at
-          runner.resources << self
-        end
-      end
-
-      Chef::Config[:solo] = true
-      Chef::Config[:cache_type] = "Memory"
-      Chef::Config[:cache_options] = { :path => File.join(File.expand_path('~'), '.chef', 'checksums') }
-      Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest) }
-      Chef::Config[:cookbook_path] = Array(@options[:cookbook_path])
-      Chef::Config[:client_key] = nil
-
-      # it should be saved to an instance variable to prevent automatic
-      # unlinking during garbage collection
-      @dummy_config = Tempfile.new 'chef-config'
-      Chef::Config[:config_file] = @dummy_config.path
-
-      self.class.register_formatter
-
-      Chef::Log.verbose = true if Chef::Log.respond_to?(:verbose)
-      Chef::Log.level(@options[:log_level])
-      @client = Chef::Client.new
-      fake_ohai(@client.ohai)
-      @client.load_node if @client.respond_to?(:load_node) # chef >= 10.14.0
-      @node = @client.build_node
-      if block_given?
-        yield @node
-      end
-    end
-
-    def stub_command(command, result)
-      # We want to preserve insertion order so that stubs are applied in a
-      # known order. Ruby 1.9 hashes behave like this but we are still
-      # supporting 1.8.
-      @stubbed_commands.reject!{|existing_cmd, _| existing_cmd == command}
-      @stubbed_commands << [command, result]
-      self
-    end
-
-    # Run the specified recipes, but without actually converging the node.
-    #
-    # @param [array] recipe_names The names of the recipes to execute
-    # @return ChefSpec::ChefRunner The runner itself
-    def converge(*recipe_names)
-      @node.run_list.reset!
-      recipe_names.each do |recipe_name|
-        @node.run_list << recipe_name
-      end
-      return self if @do_dry_run
-
-      @client.instance_eval do
-        if defined?(@expanded_run_list_with_versions) # 0.10.x
-          @run_list_expansion = @node.expand!('disk')
-          @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings
-        end
-      end
-
-      @resources = []
-      if @client.respond_to?(:setup_run_context) # 0.10.x
-        @run_context = @client.setup_run_context
-      else
-        @run_context = Chef::RunContext.new(@client.node, Chef::CookbookCollection.new(Chef::CookbookLoader.new)) # 0.9.x
-      end
-      runner = Chef::Runner.new(@run_context)
-      runner.converge
-      self
-    end
-
-    def evaluate_guards?
-      !! @evaluate_guards
-    end
-
-    def actually_run_shell_guards?
-      !! @actually_run_shell_guards
-    end
-
-    FILE_RESOURCES    = %w(directory cookbook_file file template link remote_directory remote_file)
-    PACKAGE_RESOURCES = %w(package apt_package dpkg_package easy_install_package freebsd_package macports_package portage_package rpm_package chef_gem solaris_package yum_package zypper_package python_pip)
-    SCRIPT_RESOURCES  = %w(script powershell bash csh perl python ruby)
-    MISC_RESOURCES    = %w(cron env user execute service log route ruby_block git subversion group mount ohai ifconfig deploy http_request)
-
-    (FILE_RESOURCES + PACKAGE_RESOURCES + SCRIPT_RESOURCES + MISC_RESOURCES).sort.uniq.each do |type|
-      define_method(type) do |name|
-        find_resource(type, name)
-      end
-    end
-
-    # This runner as a string.
-    #
-    # @return [String] Currently includes the run_list. Format of the string may change between versions of this gem.
-    def to_s
-      return "chef_run: #{@node.run_list.to_s}" unless @node.run_list.empty?
-      'chef_run'
-    end
-
-    # Find the resource with the declared type and name
-    #
-    # @param [String] type The type of resource - e.g. 'file' or 'directory'
-    # @param [String] name The resource name
-    # @return [Chef::Resource] The matching resource, or Nil
-    def find_resource(type, name)
-      resources.find{|resource| resource_type(resource) == type and resource.name == name}
-    end
-
-    private
-
-    # Populate basic OHAI attributes required to get recipes working. This is a minimal set - if your recipe example
-    # does conditional execution based on these values or additional attributes you can set these via
-    # node.automatic_attrs.
-    #
-    # This method now relies on fauxhai to set node attributes.
-    #
-    # @param [Ohai::System] ohai The ohai instance to set fake attributes on
-    def fake_ohai(ohai)
-      data = if @options.has_key?(:ohai_data_path)
-              Fauxhai::Mocker.new(:path => @options[:ohai_data_path]).data
-             else
-              Fauxhai::Mocker.new(:platform => @options[:platform], :version => @options[:version]).data
-             end
-      data.each_pair do |attribute, value|
-        ohai[attribute] = value
-      end
-    end
-
-    # Infer the default cookbook path from the location of the calling spec.
-    #
-    # @return [String] The path to the cookbooks directory
-    def default_cookbook_path
-      Pathname.new(File.join(caller(2).first.split(':').slice(0..-3).join(':'), '..', '..', '..')).cleanpath.to_s
-    end
-
-    # The cookbook path, appended with some "common" directories to search
-    # as well (such as vendor/cookbooks)
-    #
-    # @return [Array<String>] The cookbook_paths
-    def cookbook_paths
-      vendor_path = File.expand_path(File.join('vendor', 'cookbooks'))
-      test_path   = File.expand_path(File.join('test', 'cookbooks'))
-      spec_path   = File.expand_path(File.join('spec', 'cookbooks'))
-
-      Array(@default_cookbook_path).
-        push(vendor_path).
-        push(test_path).
-        push(spec_path).
-        select { |path| File.exists?(path) }
-    end
-
-  end
-
-end

data/lib/chefspec/helpers/describe.rb

@@ -1,17 +0,0 @@
-module ChefSpec
-  module Helpers
-    module Describe
-      def described_recipe
-        metahash = self.class.metadata
-        while metahash.has_key? :example_group
-          metahash = metahash[:example_group]
-        end
-        metahash[:description_args].first
-      end
-
-      def described_cookbook
-        described_recipe.split('::').first
-      end
-    end
-  end
-end

data/lib/chefspec/matchers/cron.rb

@@ -1,7 +0,0 @@
-require 'chefspec/matchers/shared'
-
-module ChefSpec
-  module Matchers
-    define_resource_matchers([:create, :delete], [:cron], :name)
-  end
-end

data/lib/chefspec/matchers/env.rb

@@ -1,8 +0,0 @@
-
-require 'chefspec/matchers/shared'
-
-module ChefSpec
-  module Matchers
-    define_resource_matchers([:create, :delete,:modify], [:env], :key_name)
-  end
-end

data/lib/chefspec/matchers/execute.rb

@@ -1,33 +0,0 @@
-require 'chefspec/matchers/shared'
-
-module ChefSpec
-  module Matchers
-    RSpec::Matchers.define :execute_command do |command|
-      match do |chef_run|
-        if @attributes
-          chef_run.resources.any? do |resource|
-            expected_resource?(resource,command) &&
-              expected_attributes?(resource)
-          end
-        else
-          chef_run.resources.any? do |resource|
-            expected_resource?(resource,command)
-          end
-        end
-      end
-
-      chain :with do |attributes|
-        @attributes = attributes
-      end
-
-      def expected_resource?(resource,command)
-        resource_type(resource) == 'execute' &&
-          command === resource.command
-      end
-
-      def expected_attributes?(resource)
-        @attributes.all? { |k,v| resource.send(k) == v }
-      end
-    end
-  end
-end