chef-cli 1.0.3

data/spec/unit/command/install_spec.rb

@@ -0,0 +1,179 @@
+#
+# 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 "shared/command_with_ui_object"
+require "chef-cli/command/install"
+
+describe ChefCLI::Command::Install do
+
+  it_behaves_like "a command with a UI object"
+
+  let(:params) { [] }
+
+  let(:command) do
+    c = described_class.new
+    c.apply_params!(params)
+    c
+  end
+
+  let(:install_service) { instance_double(ChefCLI::PolicyfileServices::Install) }
+
+  it "disables debug by default" do
+    expect(command.debug?).to be(false)
+  end
+
+  it "doesn't set a config path by default" do
+    expect(command.config_path).to be_nil
+  end
+
+  context "when debug mode is set" do
+
+    let(:params) { [ "-D" ] }
+
+    it "enables debug" do
+      expect(command.debug?).to be(true)
+    end
+  end
+
+  context "when an explicit config file path is given" do
+
+    let(:params) { %w{ -c ~/.chef/alternate_config.rb } }
+
+    let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+    it "sets the config file path to the given value" do
+      expect(command.config_path).to eq("~/.chef/alternate_config.rb")
+    end
+
+    it "loads the config from the given path" do
+      expect(Chef::WorkstationConfigLoader).to receive(:new)
+        .with("~/.chef/alternate_config.rb")
+        .and_return(chef_config_loader)
+      expect(chef_config_loader).to receive(:load)
+      expect(command.chef_config).to eq(Chef::Config)
+    end
+
+  end
+
+  context "with no arguments" do
+
+    it "does not specify a policyfile relative path" do
+      expect(command.policyfile_relative_path).to be(nil)
+    end
+
+    it "creates the installer service with a `nil` policyfile path" do
+      expect(ChefCLI::PolicyfileServices::Install).to receive(:new)
+        .with(hash_including(policyfile: nil, ui: command.ui, root_dir: Dir.pwd, config: Chef::Config))
+        .and_return(install_service)
+      expect(command.installer).to eq(install_service)
+    end
+
+  end
+
+  context "with an explicit policyfile relative path" do
+
+    let(:params) { [ "MyPolicy.rb" ] }
+
+    it "respects the user-supplied path" do
+      expect(command.policyfile_relative_path).to eq("MyPolicy.rb")
+    end
+
+    it "creates the installer service with the specified policyfile path" do
+      expect(ChefCLI::PolicyfileServices::Install).to receive(:new)
+        .with(hash_including(policyfile: "MyPolicy.rb", ui: command.ui, root_dir: Dir.pwd, config: Chef::Config))
+        .and_return(install_service)
+      expect(command.installer).to eq(install_service)
+    end
+
+  end
+
+  describe "running the install" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      command.ui = ui
+      allow(command).to receive(:installer).and_return(install_service)
+    end
+
+    context "when the command is successful" do
+      before do
+        expect(install_service).to receive(:run)
+      end
+
+      it "returns 0" do
+        expect(command.run).to eq(0)
+      end
+    end
+
+    context "when the command is unsuccessful" 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::PolicyfileInstallError.new("install failed", cause)
+      end
+
+      before do
+        expect(install_service).to receive(:run).and_raise(exception)
+      end
+
+      it "returns 1" do
+        expect(command.run).to eq(1)
+      end
+
+      it "displays the exception and cause" do
+        expected_error_text = <<~E
+          Error: install failed
+          Reason: (StandardError) some operation failed
+
+        E
+
+        command.run
+        expect(ui.output).to eq(expected_error_text)
+      end
+
+      context "and debug is enabled" do
+
+        let(:params) { ["-D"] }
+
+        it "displays the exception and cause with backtrace" do
+          expected_error_text = <<~E
+            Error: install failed
+            Reason: (StandardError) some operation failed
+
+
+          E
+
+          expected_error_text << backtrace.join("\n") << "\n"
+
+          command.run
+          expect(ui.output).to eq(expected_error_text)
+        end
+      end
+
+    end
+
+  end
+end

data/spec/unit/command/push_archive_spec.rb

@@ -0,0 +1,153 @@
+#
+# 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/push_archive"
+
+describe ChefCLI::Command::PushArchive do
+
+  subject(:command) { described_class.new }
+
+  let(:policy_group) { "staging" }
+
+  let(:archive_path) { "mypolicy-abc123.tgz" }
+
+  it_behaves_like "a command with a UI object"
+
+  let(:ui) { TestHelpers::TestUI.new }
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:config_arg) { nil }
+
+  before do
+    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+  end
+
+  describe "evaluating params" do
+
+    before do
+      command.ui = ui
+    end
+
+    context "when given no arguments" do
+
+      it "prints the banner message and exits non-zero" do
+        expect(command.run([])).to eq(1)
+        expect(ui.output).to include(described_class.banner)
+      end
+
+    end
+
+    context "when the archive path is omitted" do
+
+      it "prints the banner message and exits non-zero" do
+        expect(command.run([policy_group])).to eq(1)
+        expect(ui.output).to include(described_class.banner)
+      end
+
+    end
+
+    context "when all required arguments are given" do
+
+      let(:params) { [ policy_group, archive_path ] }
+
+      before do
+        command.apply_params!(params)
+      end
+
+      it "disables debug by default" do
+        expect(command.debug?).to be(false)
+      end
+
+      context "and debug mode is set" do
+
+        let(:params) { [ policy_group, archive_path, "-D" ] }
+
+        it "enables debug messages" do
+          expect(command.debug?).to be(true)
+        end
+
+      end
+
+      describe "configuring settings that depend on the chef config file" do
+
+        before do
+          expect(chef_config_loader).to receive(:load)
+        end
+
+        it "sets the policy group" do
+          expect(command.policy_group).to eq(policy_group)
+          expect(command.push_archive_service.policy_group).to eq(policy_group)
+        end
+
+        it "sets the path to the archive file" do
+          expect(command.archive_path).to eq(archive_path)
+          expect(command.push_archive_service.archive_file).to eq(File.expand_path(archive_path))
+        end
+      end
+
+    end
+
+  end
+
+  describe "running the push operation" do
+
+    let(:push_archive_service) { instance_double("ChefCLI::PolicyfileServices::PushArchive") }
+
+    let(:params) { [ policy_group, archive_path ] }
+
+    before do
+      allow(command).to receive(:push_archive_service).and_return(push_archive_service)
+      command.ui = ui
+    end
+
+    context "when the push is successful" do
+
+      it "exits 0" do
+        expect(push_archive_service).to receive(:run)
+        expect(command.run(params)).to eq(0)
+      end
+
+    end
+
+    context "when the push in not successful" 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::PolicyfilePushArchiveError.new("push failed", cause)
+      end
+
+      before do
+        expect(push_archive_service).to receive(:run).and_raise(exception)
+      end
+
+      it "exits non-zero" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+  end
+end

data/spec/unit/command/push_spec.rb

@@ -0,0 +1,198 @@
+#
+# 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 "shared/command_with_ui_object"
+require "chef-cli/command/push"
+
+describe ChefCLI::Command::Push do
+
+  it_behaves_like "a command with a UI object"
+
+  let(:policy_group) { "dev" }
+
+  let(:params) { [policy_group] }
+
+  let(:command) do
+    described_class.new
+  end
+
+  let(:push_service) { instance_double(ChefCLI::PolicyfileServices::Push) }
+
+  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
+
+  context "after evaluating params" do
+
+    before do
+      command.apply_params!(params)
+    end
+
+    it "disables debug by default" do
+      expect(command.debug?).to be(false)
+    end
+
+    describe "when configuring components that depend on chef config" do
+
+      before do
+        expect(chef_config_loader).to receive(:load)
+      end
+
+      it "reads the chef/knife config" do
+        expect(command.chef_config).to eq(chef_config)
+      end
+
+      it "configures the Push service" do
+        expect(ChefCLI::PolicyfileServices::Push).to receive(:new)
+          .with(policyfile: nil, ui: command.ui, policy_group: policy_group, config: chef_config, root_dir: Dir.pwd)
+          .and_return(push_service)
+        expect(command.push).to eq(push_service)
+      end
+
+      context "and an explicit Policyfile is given" do
+
+        let(:params) { [policy_group, "MyPolicy.rb"] }
+
+        it "configures the Push service with the given Policyfile" do
+          expect(ChefCLI::PolicyfileServices::Push).to receive(:new)
+            .with(policyfile: "MyPolicy.rb", ui: command.ui, policy_group: policy_group, config: chef_config, root_dir: Dir.pwd)
+            .and_return(push_service)
+          expect(command.push).to eq(push_service)
+        end
+
+      end
+    end
+
+    context "when debug mode is set" do
+
+      let(:params) { [ policy_group, "-D" ] }
+
+      it "enables debug" do
+        expect(command.debug?).to be(true)
+      end
+
+    end
+
+  end
+
+  describe "running the push operation" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      command.ui = ui
+    end
+
+    context "when invoked without arguments" do
+
+      let(:params) { [] }
+
+      it "prints the banner and returns 1" do
+        expect(command.run).to eq(1)
+      end
+
+    end
+
+    context "with valid arguments" do
+
+      before do
+        expect(command).to receive(:push).and_return(push_service)
+      end
+
+      context "when the push is successful" do
+
+        before do
+          expect(push_service).to receive(:run)
+        end
+
+        it "returns 0" do
+          expect(command.run(params)).to eq(0)
+        end
+
+      end
+
+      context "when the push operation 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::PolicyfilePushError.new("push failed", cause)
+        end
+
+        before do
+          expect(push_service).to receive(:run).and_raise(exception)
+        end
+
+        it "exits 1" do
+          expect(command.run(params)).to eq(1)
+        end
+
+        it "describes the error" do
+          command.run(params)
+
+          expected_output = <<~E
+            Error: push failed
+            Reason: (StandardError) some operation failed
+
+          E
+
+          expect(ui.output).to eq(expected_output)
+        end
+
+        context "when debug is enabled" do
+
+          before do
+            params << "-D"
+          end
+
+          it "includes the backtrace in the error" do
+
+            command.run(params)
+
+            expected_output = <<~E
+              Error: push failed
+              Reason: (StandardError) some operation failed
+
+
+            E
+            expected_output << backtrace.join("\n") << "\n"
+
+            expect(ui.output).to eq(expected_output)
+          end
+
+        end
+
+      end
+    end
+
+  end
+
+end