chef-dk 3.9.0 → 3.10.1

data/spec/unit/command/base_spec.rb

@@ -1,172 +1,172 @@
-#
-# Copyright:: Copyright (c) 2014-2018 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 "chef-dk/command/verify"
-
-describe ChefDK::Command::Base do
-  class TestCommand < ChefDK::Command::Base
-    banner "use me please"
-
-    option :argue,
-      short:       "-a ARG",
-      long:        "--arg ARG",
-      description: "An option with a required argument"
-
-    option :user,
-      short: "-u",
-      long: "--user",
-      description: "If the user exists",
-      boolean: true
-
-    def run(params)
-      parse_options(params)
-      msg("thanks for passing me #{config[:user]}")
-    end
-  end
-
-  let(:stderr_io) { StringIO.new }
-  let(:stdout_io) { StringIO.new }
-  let(:command_instance) { TestCommand.new() }
-
-  def stdout
-    stdout_io.string
-  end
-
-  def stderr
-    stderr_io.string
-  end
-
-  before do
-    allow(command_instance).to receive(:stdout).and_return(stdout_io)
-    allow(command_instance).to receive(:stderr).and_return(stderr_io)
-  end
-
-  def run_command(options)
-    command_instance.run_with_default_options(options)
-  end
-
-  it "should print the banner for -h" do
-    run_command(["-h"])
-    expect(stdout).to include("use me please\n")
-  end
-
-  it "should print the banner for --help" do
-    run_command(["--help"])
-    expect(stdout).to include("use me please\n")
-  end
-
-  it "prints the options along with the banner when displaying the help message" do
-    run_command(["--help"])
-    expect(stdout).to include("-u, --user                       If the user exists")
-  end
-
-  it "should print the version for -v" do
-    run_command(["-v"])
-    expect(stdout).to eq("Chef Development Kit Version: #{ChefDK::VERSION}\n")
-  end
-
-  it "should print the version for --version" do
-    run_command(["--version"])
-    expect(stdout).to eq("Chef Development Kit Version: #{ChefDK::VERSION}\n")
-  end
-
-  it "should run the command passing in the custom options for long custom options" do
-    run_command(["--user"])
-    expect(stdout).to eq("thanks for passing me true\n")
-  end
-
-  it "should run the command passing in the custom options for short custom options" do
-    run_command(["-u"])
-    expect(stdout).to eq("thanks for passing me true\n")
-  end
-
-  describe "when given invalid options" do
-
-    it "prints the help banner and exits gracefully" do
-      expect(run_command(%w{-foo})).to eq(1)
-
-      expect(stderr).to eq("ERROR: invalid option: -foo\n\n")
-
-      expected = <<~E
-        use me please
-            -a, --arg ARG                    An option with a required argument
-            -h, --help                       Show this message
-            -u, --user                       If the user exists
-            -v, --version                    Show chef version
-
-      E
-      expect(stdout).to eq(expected)
-    end
-
-  end
-
-  describe "when given an option that requires an argument with no argument" do
-
-    it "prints the help banner and exits gracefully" do
-      expect(run_command(%w{-a})).to eq(1)
-
-      expect(stderr).to eq("ERROR: missing argument: -a\n\n")
-
-      expected = <<~E
-        use me please
-            -a, --arg ARG                    An option with a required argument
-            -h, --help                       Show this message
-            -u, --user                       If the user exists
-            -v, --version                    Show chef version
-
-      E
-      expect(stdout).to eq(expected)
-
-    end
-
-  end
-
-  describe "when parsing Chef's configuration fails" do
-
-    let(:exception_message) do
-      <<~MESSAGE
-        You have an error in your config file /Users/ddeleo/.chef/config.rb (Chef::Exceptions::ConfigurationError)
-
-        Mixlib::Config::UnknownConfigOptionError: Cannot set unsupported config value foo.
-          /Users/person/.chef/config.rb:50:in `from_string'
-        Relevant file content:
-         49: chefdk.generator_cookbook "~/.chef/code_generator"
-         50: chefdk.foo "bar"
-         51:
-
-      MESSAGE
-    end
-
-    let(:exception) { Chef::Exceptions::ConfigurationError.new(exception_message) }
-
-    before do
-      allow(command_instance).to receive(:run).and_raise(exception)
-    end
-
-    it "exits non-zero" do
-      expect(run_command([])).to eq(1)
-    end
-
-    it "prints the exception message to stderr" do
-      run_command([])
-      expect(stderr).to include(exception_message)
-    end
-
-  end
-
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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 "chef-dk/command/verify"
+
+describe ChefDK::Command::Base do
+  class TestCommand < ChefDK::Command::Base
+    banner "use me please"
+
+    option :argue,
+      short:       "-a ARG",
+      long:        "--arg ARG",
+      description: "An option with a required argument"
+
+    option :user,
+      short: "-u",
+      long: "--user",
+      description: "If the user exists",
+      boolean: true
+
+    def run(params)
+      parse_options(params)
+      msg("thanks for passing me #{config[:user]}")
+    end
+  end
+
+  let(:stderr_io) { StringIO.new }
+  let(:stdout_io) { StringIO.new }
+  let(:command_instance) { TestCommand.new() }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  before do
+    allow(command_instance).to receive(:stdout).and_return(stdout_io)
+    allow(command_instance).to receive(:stderr).and_return(stderr_io)
+  end
+
+  def run_command(options)
+    command_instance.run_with_default_options(options)
+  end
+
+  it "should print the banner for -h" do
+    run_command(["-h"])
+    expect(stdout).to include("use me please\n")
+  end
+
+  it "should print the banner for --help" do
+    run_command(["--help"])
+    expect(stdout).to include("use me please\n")
+  end
+
+  it "prints the options along with the banner when displaying the help message" do
+    run_command(["--help"])
+    expect(stdout).to include("-u, --user                       If the user exists")
+  end
+
+  it "should print the version for -v" do
+    run_command(["-v"])
+    expect(stdout).to eq("Chef Development Kit Version: #{ChefDK::VERSION}\n")
+  end
+
+  it "should print the version for --version" do
+    run_command(["--version"])
+    expect(stdout).to eq("Chef Development Kit Version: #{ChefDK::VERSION}\n")
+  end
+
+  it "should run the command passing in the custom options for long custom options" do
+    run_command(["--user"])
+    expect(stdout).to eq("thanks for passing me true\n")
+  end
+
+  it "should run the command passing in the custom options for short custom options" do
+    run_command(["-u"])
+    expect(stdout).to eq("thanks for passing me true\n")
+  end
+
+  describe "when given invalid options" do
+
+    it "prints the help banner and exits gracefully" do
+      expect(run_command(%w{-foo})).to eq(1)
+
+      expect(stderr).to eq("ERROR: invalid option: -foo\n\n")
+
+      expected = <<~E
+        use me please
+            -a, --arg ARG                    An option with a required argument
+            -h, --help                       Show this message
+            -u, --user                       If the user exists
+            -v, --version                    Show chef version
+
+      E
+      expect(stdout).to eq(expected)
+    end
+
+  end
+
+  describe "when given an option that requires an argument with no argument" do
+
+    it "prints the help banner and exits gracefully" do
+      expect(run_command(%w{-a})).to eq(1)
+
+      expect(stderr).to eq("ERROR: missing argument: -a\n\n")
+
+      expected = <<~E
+        use me please
+            -a, --arg ARG                    An option with a required argument
+            -h, --help                       Show this message
+            -u, --user                       If the user exists
+            -v, --version                    Show chef version
+
+      E
+      expect(stdout).to eq(expected)
+
+    end
+
+  end
+
+  describe "when parsing Chef's configuration fails" do
+
+    let(:exception_message) do
+      <<~MESSAGE
+        You have an error in your config file /Users/ddeleo/.chef/config.rb (Chef::Exceptions::ConfigurationError)
+
+        Mixlib::Config::UnknownConfigOptionError: Cannot set unsupported config value foo.
+          /Users/person/.chef/config.rb:50:in `from_string'
+        Relevant file content:
+         49: chefdk.generator_cookbook "~/.chef/code_generator"
+         50: chefdk.foo "bar"
+         51:
+
+      MESSAGE
+    end
+
+    let(:exception) { Chef::Exceptions::ConfigurationError.new(exception_message) }
+
+    before do
+      allow(command_instance).to receive(:run).and_raise(exception)
+    end
+
+    it "exits non-zero" do
+      expect(run_command([])).to eq(1)
+    end
+
+    it "prints the exception message to stderr" do
+      run_command([])
+      expect(stderr).to include(exception_message)
+    end
+
+  end
+
+end

data/spec/unit/command/clean_policy_cookbooks_spec.rb

@@ -1,180 +1,180 @@
-#
-# 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