chef-cli 1.0.3

data/spec/unit/command/delete_policy_spec.rb

@@ -0,0 +1,206 @@
+#
+# 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-cli/command/delete_policy"
+
+describe ChefCLI::Command::DeletePolicy do
+
+  it_behaves_like "a command with a UI object"
+
+  subject(:command) do
+    described_class.new
+  end
+
+  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(:base_params) { ["example-policy"] }
+
+    before do
+      command.apply_params!(params)
+    end
+
+    context "when given just the policy name" do
+
+      let(:params) { base_params }
+
+      it "sets the policy name" do
+        expect(command.policy_name).to eq("example-policy")
+      end
+
+      it "configures the rm_policy service" do
+        expect(chef_config_loader).to receive(:load)
+        service = command.rm_policy_service
+        expect(service).to be_a(ChefCLI::PolicyfileServices::RmPolicy)
+        expect(service.chef_config).to eq(chef_config)
+        expect(service.ui).to eq(command.ui)
+        expect(service.policy_name).to eq("example-policy")
+      end
+    end
+
+    context "when given a path to the config" do
+
+      let(:params) { base_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(command.rm_policy_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
+
+        let(:params) { base_params }
+
+        it "disables debug by default" do
+          expect(command.debug?).to be(false)
+        end
+
+      end
+
+      context "when debug mode is set" do
+
+        let(:params) { base_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 few arguments" do
+
+      let(:params) { %w{ } }
+
+      it "shows usage and exits" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+
+    context "when given too many arguments" do
+
+      let(:params) { %w{ a-policy-name wut-is-this } }
+
+      it "shows usage and exits" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+
+    context "when the rm_policy 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
+        ChefCLI::DeletePolicyError.new("Failed to delete policy.", cause)
+      end
+
+      before do
+        allow(command.rm_policy_service).to receive(:run).and_raise(exception)
+      end
+
+      it "prints a debugging message and exits non-zero" do
+        expect(command.run(%w{example-policy})).to eq(1)
+
+        expected_output = <<~E
+          Error: Failed to delete policy.
+          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{ example-policy -D })
+
+          expected_output = <<~E
+            Error: Failed to delete policy.
+            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 rm_policy service executes successfully" do
+
+      before do
+        expect(command.rm_policy_service).to receive(:run)
+      end
+
+      it "exits 0" do
+        expect(command.run(%w{example-policy})).to eq(0)
+      end
+
+    end
+
+  end
+end

data/spec/unit/command/diff_spec.rb

@@ -0,0 +1,311 @@
+#
+# 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-cli/command/diff"
+require "chef-cli/service_exceptions"
+
+describe ChefCLI::Command::Diff do
+
+  it_behaves_like "a command with a UI object"
+
+  let(:params) { [] }
+
+  let(:command) do
+    described_class.new
+  end
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:chef_config) { double("Chef::Config") }
+
+  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 "selecting comparison bases" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    let(:http_client) { instance_double("Chef::ServerAPI") }
+
+    let(:differ) { instance_double("ChefCLI::Policyfile::Differ", run_report: nil) }
+
+    let(:pager) { instance_double("ChefCLI::Pager", ui: ui) }
+
+    before do
+      allow(ChefCLI::Pager).to receive(:new).and_return(pager)
+      allow(pager).to receive(:with_pager).and_yield(pager)
+      allow(command).to receive(:materialize_locks).and_return(nil)
+      allow(command).to receive(:differ).and_return(differ)
+      allow(command).to receive(:http_client).and_return(http_client)
+      command.ui = ui
+    end
+
+    context "when no base is given" do
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("No comparison specified")
+      end
+
+    end
+
+    context "when an PolicyfileServiceError is encountered" do
+
+      let(:params) { %w{ --head } }
+
+      context "without a reason" do
+
+        it "prints the exception successfully" do
+          expect(command).to receive(:print_diff).and_raise(ChefCLI::PolicyfileServiceError)
+          expect(command.run(params)).to eq(1)
+          expect(ui.output).to include("Error: ChefCLI::PolicyfileServiceError")
+        end
+
+      end
+
+      context "with a reason" do
+
+        let(:err) { ChefCLI::PolicyfileNestedException.new("msg", RuntimeError.new) }
+
+        it "prints the exception and reason successfully" do
+          expect(command).to receive(:print_diff).and_raise(err)
+          expect(command.run(params)).to eq(1)
+          expect(ui.output).to include("Error: msg\nReason: (RuntimeError) RuntimeError")
+        end
+
+      end
+
+    end
+
+    context "when server and git comparison bases are mixed" do
+
+      let(:params) { %w{ --git gitref policygroup } }
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("Conflicting arguments and options: git and Policy Group comparisons cannot be mixed")
+      end
+
+    end
+
+    context "when specific git comparison bases are mixed with --head" do
+
+      let(:params) { %w{ --head --git gitref } }
+
+      it "prints an error message and exits" do
+        expect(command.run(params)).to eq(1)
+        expect(ui.output).to include("Conflicting git options: --head and --git are exclusive")
+      end
+
+    end
+
+    describe "selecting git comparison bases" do
+
+      context "when the Policyfile isn't named" do
+
+        let(:params) { %w{ --head } }
+
+        it "uses Policyfile.lock.json as the local lock" do
+          expect(command.run(params)).to eq(0)
+          expect(command.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+      context "when the Policyfile is named" do
+
+        context "using the --head option" do
+
+          let(:params) { %w{ policies/OtherPolicy.rb --head } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/OtherPolicy.lock.json")
+          end
+
+        end
+
+        context "using the --git option" do
+
+          let(:params) { %w{ policies/OtherPolicy.rb --git master } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/OtherPolicy.lock.json")
+          end
+
+        end
+
+      end
+
+      context "when given a single commit-ish" do
+
+        let(:params) { %w{ --git master } }
+
+        it "compares the local lock to the commit" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("master")
+          expect(command.new_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Local)
+          expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+      context "when given two commit-ish names" do
+
+        let(:params) { %w{ --git master...dev-branch } }
+
+        it "compares the two commits" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("master")
+          expect(command.new_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Git)
+          expect(command.new_base.ref).to eq("dev-branch")
+        end
+
+      end
+
+      context "when given too many commit-ish names" do
+
+        let(:params) { %w{ --git too...many...things } }
+
+        it "prints an error and exits" do
+          expect(command.run(params)).to eq(1)
+          expect(ui.output).to include("Unable to parse git comparison `too...many...things`. Only 2 references can be specified.")
+        end
+
+      end
+
+      context "when --head is used" do
+
+        let(:params) { %w{ --head } }
+
+        it "compares the local lock to git HEAD" do
+          expect(command.run(params)).to eq(0)
+          expect(command.old_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Git)
+          expect(command.old_base.ref).to eq("HEAD")
+          expect(command.new_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Local)
+          expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+        end
+
+      end
+
+    end
+
+    describe "selecting policy group comparison bases" do
+
+      let(:local_lock_comparison_base) do
+        instance_double("ChefCLI::Policyfile::ComparisonBase::Local")
+      end
+
+      before do
+        allow(command).to receive(:local_lock_comparison_base).and_return(local_lock_comparison_base)
+      end
+
+      context "when the local lockfile cannot be read and parsed" do
+
+        let(:params) { %w{ dev-group } }
+
+        before do
+          allow(local_lock_comparison_base).to receive(:lock).and_raise(ChefCLI::LockfileNotFound)
+        end
+
+        it "prints an error and exits" do
+          expect(command.run(params)).to eq(1)
+        end
+
+      end
+
+      context "when the local lockfile can be read and parsed" do
+        before do
+          allow(local_lock_comparison_base).to receive(:lock).and_return({ "name" => "example-policy" })
+          allow(command).to receive(:differ).and_return(differ)
+          command.ui = ui
+        end
+
+        context "when the Policyfile isn't named" do
+
+          let(:params) { %w{ dev-group } }
+
+          it "uses Policyfile.lock.json as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+          end
+
+        end
+
+        context "when the Policyfile is named" do
+
+          let(:params) { %w{ policies/SomePolicy.rb dev-group } }
+
+          it "uses the corresponding lock as the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.policyfile_lock_relpath).to eq("policies/SomePolicy.lock.json")
+          end
+
+        end
+
+        context "when given a single policy group name" do
+
+          let(:params) { %w{ dev-group } }
+
+          it "compares the policy group's lock to the local lock" do
+            expect(command.run(params)).to eq(0)
+            expect(command.old_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.old_base.group).to eq("dev-group")
+            expect(command.new_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::Local)
+            expect(command.new_base.policyfile_lock_relpath).to eq("Policyfile.lock.json")
+          end
+
+        end
+
+        context "when given two policy group names" do
+
+          let(:params) { %w{ prod-group...stage-group } }
+
+          it "compares the two locks" do
+            expect(command.run(params)).to eq(0)
+            expect(command.old_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.old_base.group).to eq("prod-group")
+            expect(command.new_base).to be_a_kind_of(ChefCLI::Policyfile::ComparisonBase::PolicyGroup)
+            expect(command.new_base.group).to eq("stage-group")
+          end
+
+        end
+
+        context "when given too many policy group names" do
+
+          let(:params) { %w{ prod...stage...dev } }
+
+          it "prints an error and exits" do
+            expect(command.run(params)).to eq(1)
+            expect(ui.output).to include("Unable to parse policy group comparison `prod...stage...dev`. Only 2 references can be specified.")
+          end
+
+        end
+
+      end
+    end
+  end
+end