chefspec 7.3.3 → 7.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7ad20235c511ac776998d932fedf88069c52f6fd935768b345ae182ae583c1a
-  data.tar.gz: b5c1096a905aaf0b872b8c7b4698bbd55223bc1ab77f772aacaa2da2e13d6e10
+  metadata.gz: '087946db9144fc3c278e7b18e1afefd129d6f964f1008114b00ab5bbe5fbb34e'
+  data.tar.gz: 47809ae0412a69c75c8e2e0eb8f7109adfe86befc62270aa5e3b4659a0d5737b
 SHA512:
-  metadata.gz: a368547ad18bd6d809535741ee89e2547aa4ca94ac69c00b24822032756bc94fdec949b01d2b0361dd9db3efb85d1ca8a0135ec192e15c33cbd8218c79c6325c
-  data.tar.gz: a97c33254a9927d1a63b14cc9188732bce0bbbfa96c26ecfd2078a0be33d798bbbf26e8590d7551d6b4fde4ece9c6624d5717ab400c39eb1aded67f153c7fe8d
+  metadata.gz: 0e988f0d741d4dce1f20c21cf6d8d19eaa6cae90261eaa9e090e99483ef6a249c54a544017fda8aba6bf67d3a7e753c9614c42e75c464733382969eb811ebe67
+  data.tar.gz: 7279c57f503a0b662d840608f79a8cd5b445e19fe3a7302043b3162bd044369a61729ea69098ae9e064539d54e8d7c9691a7922659b5ab5eeca027660178ce21

data/Gemfile

@@ -0,0 +1,23 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'redcarpet'
+  gem 'yard'
+  gem 'pry'
+  gem 'pry-byebug'
+end
+
+if ENV["GEMFILE_MOD"]
+  puts "GEMFILE_MOD: #{ENV['GEMFILE_MOD']}"
+  instance_eval(ENV["GEMFILE_MOD"])
+else
+  gem 'chef', git: "https://github.com/chef/chef"
+  gem 'ohai', git: "https://github.com/chef/ohai"
+end
+
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -0,0 +1,77 @@
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'yard/rake/yardoc_task'
+require 'tmpdir'
+require 'rspec'
+require 'chefspec'
+
+require 'chef/version'
+
+YARD::Rake::YardocTask.new
+
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.rspec_opts = [].tap do |a|
+    a.push('--color')
+    a.push('--format progress')
+  end.join(' ')
+end
+
+failed = []
+start_time = nil
+
+namespace :acceptance do |ns|
+  begin
+    Dir.foreach("examples") do |dir|
+      next if dir == '.' or dir == '..'
+      desc "#{dir} acceptance tests"
+      task dir.to_sym do
+        start_time ||= Time.now
+        Dir.mktmpdir do |tmp|
+          FileUtils.cp_r("examples/#{dir}", tmp)
+
+          pwd = Dir.pwd
+
+          Dir.chdir "#{tmp}/#{dir}" do
+            puts "rspec examples/#{dir}"
+
+            #
+            # This bit of mildly awful magic below is to load each file into an in-memory
+            # RSpec runner while keeping a persistent ChefZero server alive.
+            #
+            load "#{pwd}/lib/chefspec/rspec.rb"
+
+            RSpec.configure do |config|
+              config.color = true
+              config.run_all_when_everything_filtered = true
+              config.filter_run(:focus)
+              config.before(:suite) do
+                ChefSpec::ZeroServer.setup!
+              end
+              config.after(:each) do
+                ChefSpec::ZeroServer.reset!
+              end
+            end
+
+            RSpec.clear_examples
+            exitstatus = RSpec::Core::Runner.run(["spec"])
+            RSpec.reset
+            failed << dir unless exitstatus == 0
+          end
+        end
+      end
+    end
+  rescue Errno::ENOENT # examples dir is probably missing
+    puts "The rake acceptance tests require a full git checkout of chefspec including all examples files!"
+  end
+end
+
+task acceptance: Rake.application.tasks.select { |t| t.name.start_with?("acceptance:") } do
+  puts "Acceptance tests took #{Time.now - start_time} seconds"
+  raise "some tests failed: #{failed.join(', ')}" unless failed.empty?
+end
+
+desc 'Run all tests'
+task :test => [:unit, :acceptance]
+
+task :default => [:test]

data/chefspec.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require 'chefspec/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'chefspec'
+  s.version       = ChefSpec::VERSION
+  s.authors       = ['Andrew Crump', 'Seth Vargo']
+  s.email         = ['andrew.crump@ieee.org', 'sethvargo@gmail.com']
+  s.summary       = 'Write RSpec examples and generate coverage reports for ' \
+                    'Chef recipes!'
+  s.description   = 'ChefSpec is a unit testing and resource coverage ' \
+                    '(code coverage) framework for testing Chef cookbooks ' \
+                    'ChefSpec makes it easy to write examples and get fast ' \
+                    'feedback on cookbook changes without the need for ' \
+                    'virtual machines or cloud servers.'
+  s.homepage      = 'https://github.com/chefspec/chefspec'
+  s.license       = 'MIT'
+
+  # Packaging
+  s.files         = %w{LICENSE Rakefile Gemfile chefspec.gemspec} + Dir.glob("{lib,templates,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_dependency 'chef',    '>= 12.16.42'
+  s.add_dependency 'fauxhai', '>= 4'
+  s.add_dependency 'rspec',   '~> 3.0'
+end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '7.3.3'
+  VERSION = '7.3.4'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'chefspec'
+require 'support/hash'
+
+
+ChefSpec::Coverage.start! do
+  set_template 'table.erb'
+end
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+  config.filter_run(focus: true)
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/hash.rb

@@ -0,0 +1,35 @@
+#
+# An extension of a Hash that allows mash-style like lookups.
+#
+# @private
+#
+class Hash
+  # Like, seriously Windows?
+  undef_method(:timeout)
+
+  #
+  # Monkey-patch to allow mash-style look ups for tests
+  #
+  def method_missing(m, *args, &block)
+    if has_key?(m.to_sym)
+      self[m.to_sym]
+    elsif has_key?(m.to_s)
+      self[m.to_s]
+    else
+      super
+    end
+  end
+
+  #
+  # Monkey-patch to stdlib Hash to correspond to Mash-style lookup
+  #
+  # @see Hash#respond_to?
+  #
+  def respond_to?(m, include_private = false)
+    if has_key?(m.to_sym) || has_key?(m.to_s)
+      true
+    else
+      super
+    end
+  end
+end

data/spec/unit/cacher_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'chefspec/cacher'
+
+describe ChefSpec::Cacher do
+  let(:klass) do
+    Class.new(RSpec::Core::ExampleGroup) do
+      extend ChefSpec::Cacher
+
+      def self.metadata
+        { parent_example_group: { location: 'spec' } }
+      end
+    end
+  end
+
+  let(:cache) { described_class.class_variable_get(:@@cache) }
+  let(:preserve_cache) { false }
+
+  before(:each) { described_class.class_variable_set(:@@cache, {}) unless preserve_cache }
+
+  describe 'cached' do
+    it 'lazily defines the results for the cache' do
+      klass.cached(:chef_run)
+      expect(klass).to be_method_defined(:chef_run)
+    end
+
+    it 'adds the item to the cache when called' do
+      runner = double(:runner)
+      klass.cached(:chef_run) { runner }
+      klass.new.chef_run
+
+      expect(cache[Thread.current.object_id]).to have_key('spec.chef_run')
+      expect(cache[Thread.current.object_id]['spec.chef_run']).to eq(runner)
+    end
+
+    context 'when multithreaded environment' do
+      it 'is thread safe' do
+        (1..2).each do |n|
+          Thread.new do
+            klass.cached(:chef_run) { n }
+            expect(klass.new.chef_run).to eq(n)
+          end.join
+        end
+      end
+    end
+
+    context 'when example groups are defined by looping' do
+      let(:preserve_cache) { true }
+
+      ['first', 'second', 'third'].each do |iteration|
+        context "on the #{iteration} iteration" do
+          context 'in caching context' do
+            cached(:cached_iteration) { iteration }
+            it 'caches the iteration for this context' do
+              expect(cached_iteration).to eq iteration
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe 'cached!' do
+    it 'loads the value at runtime' do
+      expect(klass).to receive(:cached).with(:chef_run).once
+      expect(klass).to receive(:before).once
+
+      klass.cached!(:chef_run) { }
+    end
+  end
+end

data/spec/unit/coverage/filters_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+# Note: These specs don't use Berkshelf code directly as this project doesn't
+# have a direct dependency on Berkshelf and loading it would impact the
+# perfance of these specs. While not ideal, the test doubles provide enough of
+# a standin for Berkshelf to exercise the `#matches?` behavior.
+describe ChefSpec::Coverage::BerkshelfFilter do
+  let(:dependencies) do
+    [double('Berkshelf::Dependency', metadata?: true, name: "cookbookery")]
+  end
+  let(:berksfile) { double('Berkshelf::Berksfile', dependencies: dependencies) }
+  let(:resource) { Chef::Resource.new('theone') }
+  subject { described_class.new(berksfile) }
+
+  describe '#matches?' do
+    it 'returns truthy if resource source_line is nil' do
+      expect(subject.matches?(resource)).to be_truthy
+    end
+
+    context 'when resource#source_line is under target cookbook' do
+      it 'normal unix path returns truthy' do
+        resource.source_line =
+          '/path/to/cookbooks/nope/recipes/default.rb:22'
+        expect(subject.matches?(resource)).to be_truthy
+      end
+
+      it 'normal windows path returns truthy' do
+        resource.source_line =
+          'C:\\path\\to\\cookbooks\\nope\\recipes\\default.rb:22'
+        expect(subject.matches?(resource)).to be_truthy
+      end
+
+      it 'mixed windows path returns truthy' do
+        resource.source_line =
+          'C:\\path\\to\\cookbooks/nope/recipes/default.rb:22'
+        expect(subject.matches?(resource)).to be_truthy
+      end
+    end
+
+    context 'when resource#source_line is not under target cookbook' do
+      it 'normal unix path returns falsey' do
+        resource.source_line =
+          '/path/to/cookbooks/cookbookery/recipes/default.rb:22'
+        expect(subject.matches?(resource)).to be_falsey
+      end
+
+      it 'normal windows path returns falsey' do
+        resource.source_line =
+          'C:\\path\\to\\cookbooks\\cookbookery\\recipes\\default.rb:22'
+        expect(subject.matches?(resource)).to be_falsey
+      end
+
+      it 'mixed windows path returns falsey' do
+        resource.source_line =
+          'C:\\path\\to\\cookbooks/cookbookery/recipes/default.rb:22'
+        expect(subject.matches?(resource)).to be_falsey
+      end
+    end
+  end
+end

data/spec/unit/deprecations_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe ChefSpec::Runner do
+  before do
+    allow_any_instance_of(ChefSpec::SoloRunner)
+      .to receive(:dry_run?)
+      .and_return(true)
+    allow(ChefSpec::Runner).to receive(:deprecated)
+  end
+
+  describe '#define_runner_method' do
+    before do
+      allow(ChefSpec).to receive(:define_matcher)
+    end
+
+    it 'prints a deprecation' do
+      expect(ChefSpec::Runner).to receive(:deprecated)
+        .with("`ChefSpec::Runner.define_runner_method' is deprecated."\
+          " It is being used in the my_custom_resource resource matcher." \
+          " Please use `ChefSpec.define_matcher' instead.")
+      ChefSpec::Runner.define_runner_method(:my_custom_resource)
+    end
+
+    it 'calls ChefSpec#define_matcher' do
+      expect(ChefSpec).to receive(:define_matcher).with(:my_custom_resource).once
+      ChefSpec::Runner.define_runner_method(:my_custom_resource)
+    end
+
+  end
+end
+
+describe ChefSpec::Server do
+  before do
+    allow(ChefSpec::Server).to receive(:deprecated)
+  end
+
+  it 'prints a deprecation for any method called' do
+    expect(ChefSpec::Server).to receive(:deprecated)
+      .with("`ChefSpec::Server.any_method' is deprecated. There is no longer" \
+        " a global Chef Server instance. Please use a ChefSpec::SoloRunner" \
+        " instead. More documentation can be found in the ChefSpec README."
+      )
+    expect {
+      ChefSpec::Server.any_method
+    }.to raise_error(ChefSpec::Error::NoConversionError)
+  end
+
+  it 'raises non-conversion error for any method called' do
+    expect{ChefSpec::Server.any_method}
+      .to raise_error(ChefSpec::Error::NoConversionError)
+  end
+
+end

data/spec/unit/errors_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module ChefSpec::Error
+  describe CommandNotStubbed do
+    let(:instance) { described_class.new(args: ['cat']) }
+
+    it 'raises an exception with the correct message' do
+      instance
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          Executing a real command is disabled. Unregistered command:
+
+              command("cat")
+
+          You can stub this command with:
+
+              stub_command("cat").and_return(...)
+        EOH
+      }
+    end
+  end
+
+  describe CookbookPathNotFound do
+    let(:instance) { described_class.new }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I could not find or infer a cookbook_path from your current working directory.
+          Please make sure you put your specs (tests) under a directory named 'spec' or
+          manually set the cookbook path in the RSpec configuration.
+        EOH
+      }
+    end
+  end
+
+  describe GemLoadError do
+    let(:instance) { described_class.new(gem: 'bacon', name: 'bacon') }
+
+    it 'raises an exception with the correct message' do
+      expect { raise instance }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          I could not load the 'bacon' gem! You must have the gem installed
+          on your local system before you can use the bacon plugin.
+          You can install bacon by running:
+
+              gem install bacon
+
+          or add bacon to your Gemfile and run the `bundle` command to install.
+        EOH
+      }
+    end
+  end
+end