chef-dk 0.15.16 → 0.16.28

data/spec/spec_helper.rb

@@ -1,51 +1,51 @@
-#
-# Copyright:: Copyright (c) 2014 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 'rubygems'
-require 'rspec/mocks'
-require 'test_helpers'
-
-# needed since we stub it for every test
-require 'chef/workstation_config_loader'
-require 'chef/config'
-
-RSpec.configure do |c|
-  running_on_windows = (RUBY_PLATFORM =~ /mswin|mingw|windows/)
-
-  c.include ChefDK
-  c.include TestHelpers
-
-  # Avoid loading config.rb/knife.rb unintentionally
-  c.before(:each) do
-    Chef::Config.reset
-    Chef::Config.treat_deprecation_warnings_as_errors(true)
-    allow_any_instance_of(Chef::WorkstationConfigLoader).to receive(:load)
-  end
-
-  c.after(:all) { clear_tempdir }
-
-  c.filter_run :focus => true
-  c.run_all_when_everything_filtered = true
-  # Tests that randomly fail, but may have value.
-  c.filter_run_excluding :volatile => true
-  c.filter_run_excluding :skip_on_windows => true if running_on_windows
-
-  c.mock_with(:rspec) do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-end
+#
+# Copyright:: Copyright (c) 2014 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 'rubygems'
+require 'rspec/mocks'
+require 'test_helpers'
+
+# needed since we stub it for every test
+require 'chef/workstation_config_loader'
+require 'chef/config'
+
+RSpec.configure do |c|
+  running_on_windows = (RUBY_PLATFORM =~ /mswin|mingw|windows/)
+
+  c.include ChefDK
+  c.include TestHelpers
+
+  # Avoid loading config.rb/knife.rb unintentionally
+  c.before(:each) do
+    Chef::Config.reset
+    Chef::Config.treat_deprecation_warnings_as_errors(true)
+    allow_any_instance_of(Chef::WorkstationConfigLoader).to receive(:load)
+  end
+
+  c.after(:all) { clear_tempdir }
+
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+  # Tests that randomly fail, but may have value.
+  c.filter_run_excluding :volatile => true
+  c.filter_run_excluding :skip_on_windows => true if running_on_windows
+
+  c.mock_with(:rspec) do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+end

data/spec/test_helpers.rb

@@ -1,84 +1,84 @@
-#
-# Copyright:: Copyright (c) 2014 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 'fileutils'
-require 'tmpdir'
-
-module TestHelpers
-
-  # A globally accessible place where we can put some state to verify that a
-  # test performed a certain operation.
-  def self.test_state
-    @test_state ||= {}
-  end
-
-  def self.reset!
-    @test_state = nil
-  end
-
-  def test_state
-    TestHelpers.test_state
-  end
-
-  def fixtures_path
-    File.expand_path(File.dirname(__FILE__) + "/unit/fixtures/")
-  end
-
-  def project_root
-    File.expand_path("../..", __FILE__)
-  end
-
-  def reset_tempdir
-    clear_tempdir
-    FileUtils.mkdir_p(tempdir)
-  end
-
-  def clear_tempdir
-    FileUtils.rm_rf(tempdir)
-    @tmpdir = nil
-  end
-
-  def tempdir
-    @tmpdir ||= Dir.mktmpdir("chef-dk")
-    File.realpath(@tmpdir)
-  end
-
-  class TestUI
-
-    attr_reader :output_stream
-
-    def initialize
-      @output_stream = StringIO.new
-    end
-
-    def err(message)
-      @output_stream.puts(message)
-    end
-
-    def msg(message)
-      @output_stream.puts(message)
-    end
-
-    def print(message)
-      @output_stream.print(message)
-    end
-
-    def output
-      @output_stream.string
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014 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 'fileutils'
+require 'tmpdir'
+
+module TestHelpers
+
+  # A globally accessible place where we can put some state to verify that a
+  # test performed a certain operation.
+  def self.test_state
+    @test_state ||= {}
+  end
+
+  def self.reset!
+    @test_state = nil
+  end
+
+  def test_state
+    TestHelpers.test_state
+  end
+
+  def fixtures_path
+    File.expand_path(File.dirname(__FILE__) + "/unit/fixtures/")
+  end
+
+  def project_root
+    File.expand_path("../..", __FILE__)
+  end
+
+  def reset_tempdir
+    clear_tempdir
+    FileUtils.mkdir_p(tempdir)
+  end
+
+  def clear_tempdir
+    FileUtils.rm_rf(tempdir)
+    @tmpdir = nil
+  end
+
+  def tempdir
+    @tmpdir ||= Dir.mktmpdir("chef-dk")
+    File.realpath(@tmpdir)
+  end
+
+  class TestUI
+
+    attr_reader :output_stream
+
+    def initialize
+      @output_stream = StringIO.new
+    end
+
+    def err(message)
+      @output_stream.puts(message)
+    end
+
+    def msg(message)
+      @output_stream.puts(message)
+    end
+
+    def print(message)
+      @output_stream.print(message)
+    end
+
+    def output
+      @output_stream.string
+    end
+  end
+end

data/spec/unit/chef_runner_spec.rb

@@ -54,14 +54,16 @@ describe ChefDK::ChefRunner do
   end
 
   it "configures a formatter for the chef run" do
-    expect(chef_runner.formatter).to be_a(Chef::EventDispatch::Dispatcher)
+    expect(chef_runner.event_dispatcher).to be_a(Chef::EventDispatch::Dispatcher)
 
-    # TODO: Once https://github.com/chef/chef/pull/3340 is merged/released,
-    # just use `formatter.subscribers`
-    subscribers = chef_runner.formatter.instance_variable_get(:@subscribers)
+    subscribers = chef_runner.event_dispatcher.subscribers
 
     expect(subscribers.size).to eq(1)
-    expect(subscribers.first).to be_a(Chef::Formatters::Doc)
+    expect(subscribers.first).to be_a(ChefDK::QuieterDocFormatter)
+  end
+
+  it "extends the recipe DSL with ChefDK's extensions" do
+    expect(Chef::DSL::Recipe.included_modules).to include(ChefDK::RecipeDSLExt)
   end
 
   it "detects the platform with ohai" do

data/spec/unit/command/clean_policy_cookbooks_spec.rb

@@ -1,181 +1,181 @@
-#
-# Copyright:: Copyright (c) 2015 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'
-require 'shared/command_with_ui_object'
-require 'chef-dk/command/clean_policy_cookbooks'
-
-describe ChefDK::Command::CleanPolicyCookbooks do
-
-  it_behaves_like "a command with a UI object"
-
-  subject(:command) do
-    described_class.new
-  end
-
-  let(:clean_policy_cookbooks_service) { command.clean_policy_cookbooks_service }
-
-  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
-
-  let(:chef_config) { double("Chef::Config") }
-
-  # nil means the config loader will do the default path lookup
-  let(:config_arg) { nil }
-
-  before do
-    stub_const("Chef::Config", chef_config)
-    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
-  end
-
-  describe "parsing args and options" do
-    let(:params) { [] }
-
-    before do
-      command.apply_params!(params)
-    end
-
-    context "when given a path to the config" do
-
-      let(:params) { %w[ -c ~/otherstuff/config.rb ] }
-
-      let(:config_arg) { "~/otherstuff/config.rb" }
-
-      before do
-        expect(chef_config_loader).to receive(:load)
-      end
-
-      it "reads the chef/knife config" do
-        expect(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
-        expect(command.chef_config).to eq(chef_config)
-        expect(clean_policy_cookbooks_service.chef_config).to eq(chef_config)
-      end
-
-    end
-
-    describe "settings that require loading chef config" do
-
-      before do
-        allow(chef_config_loader).to receive(:load)
-      end
-
-      context "with no params" do
-
-        it "disables debug by default" do
-          expect(command.debug?).to be(false)
-        end
-
-      end
-
-      context "when debug mode is set" do
-
-        let(:params) { [ "-D" ] }
-
-        it "enables debug" do
-          expect(command.debug?).to be(true)
-        end
-
-      end
-
-    end
-
-  end
-
-  describe "running the command" do
-
-    let(:ui) { TestHelpers::TestUI.new }
-
-    before do
-      allow(chef_config_loader).to receive(:load)
-      command.ui = ui
-    end
-
-    context "when given too many arguments" do
-
-      let(:params) { %w[ wut-is-this ] }
-
-      it "shows usage and exits" do
-        expect(command.run(params)).to eq(1)
-      end
-
-    end
-
-    context "when the clean policies service raises an exception" do
-
-      let(:backtrace) { caller[0...3] }
-
-      let(:cause) do
-        e = StandardError.new("some operation failed")
-        e.set_backtrace(backtrace)
-        e
-      end
-
-      let(:exception) do
-        ChefDK::PolicyfileCleanError.new("Failed to delete some policy revisions.", cause)
-      end
-
-      before do
-        allow(clean_policy_cookbooks_service).to receive(:run).and_raise(exception)
-      end
-
-      it "prints a debugging message and exits non-zero" do
-        expect(command.run([])).to eq(1)
-
-        expected_output=<<-E
-Error: Failed to delete some policy revisions.
-Reason: (StandardError) some operation failed
-
-E
-
-        expect(ui.output).to eq(expected_output)
-      end
-
-      context "when debug is enabled" do
-
-        it "includes the backtrace in the error" do
-
-          command.run(%w[ -D ])
-
-          expected_output=<<-E
-Error: Failed to delete some policy revisions.
-Reason: (StandardError) some operation failed
-
-
-E
-          expected_output << backtrace.join("\n") << "\n"
-
-          expect(ui.output).to eq(expected_output)
-        end
-
-      end
-
-    end
-
-    context "when the clean policies service executes successfully" do
-
-      before do
-        expect(clean_policy_cookbooks_service).to receive(:run)
-      end
-
-      it "exits 0" do
-        expect(command.run([])).to eq(0)
-      end
-
-    end
-
-  end
-end
-
+#
+# Copyright:: Copyright (c) 2015 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'
+require 'shared/command_with_ui_object'
+require 'chef-dk/command/clean_policy_cookbooks'
+
+describe ChefDK::Command::CleanPolicyCookbooks do
+
+  it_behaves_like "a command with a UI object"
+
+  subject(:command) do
+    described_class.new
+  end
+
+  let(:clean_policy_cookbooks_service) { command.clean_policy_cookbooks_service }
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:chef_config) { double("Chef::Config") }
+
+  # nil means the config loader will do the default path lookup
+  let(:config_arg) { nil }
+
+  before do
+    stub_const("Chef::Config", chef_config)
+    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+  end
+
+  describe "parsing args and options" do
+    let(:params) { [] }
+
+    before do
+      command.apply_params!(params)
+    end
+
+    context "when given a path to the config" do
+
+      let(:params) { %w[ -c ~/otherstuff/config.rb ] }
+
+      let(:config_arg) { "~/otherstuff/config.rb" }
+
+      before do
+        expect(chef_config_loader).to receive(:load)
+      end
+
+      it "reads the chef/knife config" do
+        expect(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+        expect(command.chef_config).to eq(chef_config)
+        expect(clean_policy_cookbooks_service.chef_config).to eq(chef_config)
+      end
+
+    end
+
+    describe "settings that require loading chef config" do
+
+      before do
+        allow(chef_config_loader).to receive(:load)
+      end
+
+      context "with no params" do
+
+        it "disables debug by default" do
+          expect(command.debug?).to be(false)
+        end
+
+      end
+
+      context "when debug mode is set" do
+
+        let(:params) { [ "-D" ] }
+
+        it "enables debug" do
+          expect(command.debug?).to be(true)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "running the command" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      allow(chef_config_loader).to receive(:load)
+      command.ui = ui
+    end
+
+    context "when given too many arguments" do
+
+      let(:params) { %w[ wut-is-this ] }
+
+      it "shows usage and exits" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+
+    context "when the clean policies service raises an exception" do
+
+      let(:backtrace) { caller[0...3] }
+
+      let(:cause) do
+        e = StandardError.new("some operation failed")
+        e.set_backtrace(backtrace)
+        e
+      end
+
+      let(:exception) do
+        ChefDK::PolicyfileCleanError.new("Failed to delete some policy revisions.", cause)
+      end
+
+      before do
+        allow(clean_policy_cookbooks_service).to receive(:run).and_raise(exception)
+      end
+
+      it "prints a debugging message and exits non-zero" do
+        expect(command.run([])).to eq(1)
+
+        expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+E
+
+        expect(ui.output).to eq(expected_output)
+      end
+
+      context "when debug is enabled" do
+
+        it "includes the backtrace in the error" do
+
+          command.run(%w[ -D ])
+
+          expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+
+E
+          expected_output << backtrace.join("\n") << "\n"
+
+          expect(ui.output).to eq(expected_output)
+        end
+
+      end
+
+    end
+
+    context "when the clean policies service executes successfully" do
+
+      before do
+        expect(clean_policy_cookbooks_service).to receive(:run)
+      end
+
+      it "exits 0" do
+        expect(command.run([])).to eq(0)
+      end
+
+    end
+
+  end
+end
+