knife 17.0.244 → 17.2.15

data/spec/unit/knife/core/hashed_command_loader_spec.rb

@@ -0,0 +1,112 @@
+#
+# Copyright:: Copyright (c) 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 "knife_spec_helper"
+
+describe Chef::Knife::SubcommandLoader::HashedCommandLoader do
+  before do
+    allow(ChefUtils).to receive(:windows?) { false }
+  end
+
+  let(:plugin_manifest) do
+    {
+      "_autogenerated_command_paths" => {
+        "plugins_paths" => {
+          "cool_a" => ["/file/for/plugin/a"],
+          "cooler_b" => ["/file/for/plugin/b"],
+        },
+        "plugins_by_category" => {
+          "cool" => [
+            "cool_a",
+          ],
+          "cooler" => [
+            "cooler_b",
+          ],
+        },
+      },
+    }
+  end
+
+  let(:loader) do
+    Chef::Knife::SubcommandLoader::HashedCommandLoader.new(
+      File.join(CHEF_SPEC_DATA, "knife-site-subcommands"),
+      plugin_manifest
+    )
+  end
+
+  describe "#list_commands" do
+    before do
+      allow(File).to receive(:exist?).and_return(true)
+    end
+
+    it "lists all commands by category when no argument is given" do
+      expect(loader.list_commands).to eq({ "cool" => ["cool_a"], "cooler" => ["cooler_b"] })
+    end
+
+    it "lists only commands in the given category when a category is given" do
+      expect(loader.list_commands("cool")).to eq({ "cool" => ["cool_a"] })
+    end
+
+    context "when the plugin path is invalid" do
+      before do
+        expect(File).to receive(:exist?).with("/file/for/plugin/b").and_return(false)
+      end
+
+      it "lists all commands by category when no argument is given" do
+        expect(Chef::Log).to receive(:error).with(/There are plugin files specified in the knife cache that cannot be found/)
+        expect(Chef::Log).to receive(:error).with("Missing files:\n\t/file/for/plugin/b")
+        expect(loader.list_commands).to eq({})
+      end
+    end
+  end
+
+  describe "#subcommand_files" do
+    it "lists all the files" do
+      expect(loader.subcommand_files).to eq(["/file/for/plugin/a", "/file/for/plugin/b"])
+    end
+  end
+
+  describe "#load_commands" do
+    before do
+      allow(Kernel).to receive(:load).and_return(true)
+    end
+
+    it "returns false for non-existant commands" do
+      expect(loader.load_command(["nothere"])).to eq(false)
+    end
+
+    it "loads the correct file and returns true if the command exists" do
+      allow(File).to receive(:exist?).and_return(true)
+      expect(Kernel).to receive(:load).with("/file/for/plugin/a").and_return(true)
+      expect(loader.load_command(["cool_a"])).to eq(true)
+    end
+  end
+
+  describe "#subcommand_for_args" do
+    it "returns the subcommands for an exact match" do
+      expect(loader.subcommand_for_args(["cooler_b"])).to eq("cooler_b")
+    end
+
+    it "finds the right subcommand even when _'s are elided" do
+      expect(loader.subcommand_for_args(%w{cooler b})).to eq("cooler_b")
+    end
+
+    it "returns nil if the the subcommand isn't in our manifest" do
+      expect(loader.subcommand_for_args(["cooler c"])).to eq(nil)
+    end
+  end
+end

data/spec/unit/knife/core/node_editor_spec.rb

@@ -0,0 +1,211 @@
+#
+# Author:: Jordan Running (<jr@chef.io>)
+# Copyright:: Copyright (c) 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 "knife_spec_helper"
+require "chef/knife/core/node_editor"
+
+describe Chef::Knife::NodeEditor do
+  let(:node_data) do
+    { "name" => "test_node",
+      "chef_environment" => "production",
+      "automatic" => { "foo" => "bar" },
+      "default" => { "alpha" => { "bravo" => "charlie", "delta" => "echo" } },
+      "normal" => { "alpha" => { "bravo" => "hotel" }, "tags" => [] },
+      "override" => { "alpha" => { "bravo" => "foxtrot", "delta" => "golf" } },
+      "policy_name" => nil,
+      "policy_group" => nil,
+      "run_list" => %w{role[comedy] role[drama] recipe[mystery]},
+    }
+  end
+
+  let(:node) { Chef::Node.from_hash(node_data) }
+
+  let(:ui) { double "ui" }
+  let(:base_config) { { editor: "cat" } }
+  let(:config) { base_config.merge(all_attributes: false) }
+
+  subject { described_class.new(node, ui, config) }
+
+  describe "#view" do
+    it "returns a Hash with only the name, chef_environment, normal, " +
+      "policy_name, policy_group, and run_list properties" do
+        expected = node_data.select do |key,|
+          %w{ name chef_environment normal
+              policy_name policy_group run_list }.include?(key)
+        end
+
+        expect(subject.view).to eq(expected)
+      end
+
+    context "when config[:all_attributes] == true" do
+      let(:config) { base_config.merge(all_attributes: true) }
+
+      it "returns a Hash with all of the node's properties" do
+        expect(subject.view).to eq(node_data)
+      end
+    end
+  end
+
+  describe "#apply_updates" do
+    context "when the node name is changed" do
+      before(:each) do
+        allow(ui).to receive(:warn)
+        allow(ui).to receive(:confirm).and_return(true)
+      end
+
+      it "emits a warning and prompts for confirmation" do
+        data = subject.view.merge("name" => "foo_new_name_node")
+        updated_node = subject.apply_updates(data)
+
+        expect(ui).to have_received(:warn)
+          .with "Changing the name of a node results in a new node being " +
+            "created, test_node will not be modified or removed."
+
+        expect(ui).to have_received(:confirm)
+          .with("Proceed with creation of new node")
+
+        expect(updated_node).to be_a(Chef::Node)
+      end
+    end
+
+    context "when config[:all_attributes] == false" do
+      let(:config) { base_config.merge(all_attributes: false) }
+
+      let(:updated_data) do
+        subject.view.merge(
+          "normal" => { "alpha" => { "bravo" => "hotel2" }, "tags" => [ "xyz" ] },
+          "policy_name" => "mypolicy",
+          "policy_group" => "prod",
+          "run_list" => %w{role[drama] recipe[mystery]}
+        )
+      end
+
+      it "returns a node with run_list and normal_attrs changed" do
+        updated_node = subject.apply_updates(updated_data)
+        expect(updated_node).to be_a(Chef::Node)
+
+        # Expected to have been changed
+        expect(updated_node.normal_attrs).to eql(updated_data["normal"])
+        expect(updated_node.policy_name).to eql(updated_data["policy_name"])
+        expect(updated_node.policy_group).to eql(updated_data["policy_group"])
+        expect(updated_node.chef_environment).to eql(updated_data["policy_group"])
+        expect(updated_node.run_list.map(&:to_s)).to eql(updated_data["run_list"])
+
+        # Expected not to have changed
+        expect(updated_node.default_attrs).to eql(node.default_attrs)
+        expect(updated_node.override_attrs).to eql(node.override_attrs)
+        expect(updated_node.automatic_attrs).to eql(node.automatic_attrs)
+      end
+    end
+
+    context "when config[:all_attributes] == true" do
+      let(:config) { base_config.merge(all_attributes: true) }
+
+      let(:updated_data) do
+        subject.view.merge(
+          "default"   => { "alpha" => { "bravo" => "charlie2", "delta" => "echo2" } },
+          "normal"    => { "alpha" => { "bravo" => "hotel2" }, "tags" => [ "xyz" ] },
+          "override"  => { "alpha" => { "bravo" => "foxtrot2", "delta" => "golf2" } },
+          "policy_name" => "mypolicy",
+          "policy_group" => "prod",
+          "run_list" => %w{role[drama] recipe[mystery]}
+        )
+      end
+
+      it "returns a node with all editable properties changed" do
+        updated_node = subject.apply_updates(updated_data)
+        expect(updated_node).to be_a(Chef::Node)
+
+        expect(updated_node.chef_environment).to eql(updated_data["policy_group"])
+        expect(updated_node.automatic_attrs).to eql(updated_data["automatic"])
+        expect(updated_node.normal_attrs).to eql(updated_data["normal"])
+        expect(updated_node.default_attrs).to eql(updated_data["default"])
+        expect(updated_node.override_attrs).to eql(updated_data["override"])
+        expect(updated_node.policy_name).to eql(updated_data["policy_name"])
+        expect(updated_node.policy_group).to eql(updated_data["policy_group"])
+        expect(updated_node.run_list.map(&:to_s)).to eql(updated_data["run_list"])
+      end
+    end
+  end
+
+  describe "#updated?" do
+    context "before the node has been edited" do
+      it "returns false" do
+        expect(subject.updated?).to be false
+      end
+    end
+
+    context "after the node has been edited" do
+      context "and changes were made" do
+        let(:updated_data) do
+          subject.view.merge(
+            "default"   => { "alpha" => { "bravo" => "charlie2", "delta" => "echo2" } },
+            "normal"    => { "alpha" => { "bravo" => "hotel2" }, "tags" => [ "xyz" ] },
+            "override"  => { "alpha" => { "bravo" => "foxtrot2", "delta" => "golf2" } },
+            "policy_name"  => "mypolicy",
+            "policy_group" => "prod",
+            "run_list" => %w{role[drama] recipe[mystery]}
+          )
+        end
+
+        context "and changes affect only editable properties" do
+          before(:each) do
+            allow(ui).to receive(:edit_hash)
+              .with(subject.view)
+              .and_return(updated_data)
+
+            subject.edit_node
+          end
+
+          it "returns an array of the changed property names" do
+            expect(subject.updated?).to eql %w{ chef_environment normal policy_name policy_group run_list }
+          end
+        end
+
+        context "and the changes include non-editable properties" do
+          before(:each) do
+            data = updated_data.merge("bad_property" => "bad_value")
+
+            allow(ui).to receive(:edit_hash)
+              .with(subject.view)
+              .and_return(data)
+
+            subject.edit_node
+          end
+
+          it "returns an array of property names that doesn't include " +
+            "the non-editable properties" do
+              expect(subject.updated?).to eql %w{ chef_environment normal policy_name policy_group run_list }
+            end
+        end
+      end
+
+      context "and changes were not made" do
+        before(:each) do
+          allow(ui).to receive(:edit_hash)
+            .with(subject.view)
+            .and_return(subject.view.dup)
+
+          subject.edit_node
+        end
+
+        it { is_expected.not_to be_updated }
+      end
+    end
+  end
+end

data/spec/unit/knife/core/object_loader_spec.rb

@@ -0,0 +1,81 @@
+#
+# Author:: Daniel DeLeo (<dan@chef.io>)
+# Author:: Juanje Ojeda (<juanje.ojeda@gmail.com>)
+# Copyright:: Copyright (c) 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 "knife_spec_helper"
+require "chef/knife/core/object_loader"
+
+describe Chef::Knife::Core::ObjectLoader do
+  before(:each) do
+    @knife = Chef::Knife.new
+    @stdout = StringIO.new
+    allow(@knife.ui).to receive(:stdout).and_return(@stdout)
+    Dir.chdir(File.join(CHEF_SPEC_DATA, "object_loader"))
+  end
+
+  shared_examples_for "Chef object" do |chef_class|
+    it "should create a #{chef_class} object" do
+      expect(@object).to be_a_kind_of(chef_class)
+    end
+
+    it "should has a attribute 'name'" do
+      expect(@object.name).to eql("test")
+    end
+  end
+
+  {
+    "nodes" => Chef::Node,
+    "roles" => Chef::Role,
+    "environments" => Chef::Environment,
+  }.each do |repo_location, chef_class|
+
+    describe "when the file is a #{chef_class}" do
+      before do
+        @loader = Chef::Knife::Core::ObjectLoader.new(chef_class, @knife.ui)
+      end
+
+      describe "when the file is a Ruby" do
+        before do
+          @object = @loader.load_from(repo_location, "test.rb")
+        end
+
+        it_behaves_like "Chef object", chef_class
+      end
+
+      # NOTE: This is check for the bug described at CHEF-2352
+      describe "when the file is a JSON" do
+        describe "and it has defined 'json_class'" do
+          before do
+            @object = @loader.load_from(repo_location, "test_json_class.json")
+          end
+
+          it_behaves_like "Chef object", chef_class
+        end
+
+        describe "and it has not defined 'json_class'" do
+          before do
+            @object = @loader.load_from(repo_location, "test.json")
+          end
+
+          it_behaves_like "Chef object", chef_class
+        end
+      end
+    end
+  end
+
+end

data/spec/unit/knife/core/status_presenter_spec.rb

@@ -0,0 +1,54 @@
+# Copyright:: Copyright (c) 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 "knife_spec_helper"
+
+describe Chef::Knife::Core::StatusPresenter do
+  describe "#summarize_json" do
+    let(:presenter) { Chef::Knife::Core::StatusPresenter.new(double(:ui), double(:config, :[] => "")) }
+
+    let(:node) do
+      Chef::Node.new.tap do |n|
+        n.automatic_attrs["name"] = "my_node"
+        n.automatic_attrs["ipaddress"] = "127.0.0.1"
+      end
+    end
+
+    let(:result) { JSON.parse(presenter.summarize_json([node])).first }
+
+    it "uses the first of public_ipv4_addrs when present" do
+      node.automatic_attrs["cloud"] = { "public_ipv4_addrs" => ["2.2.2.2"] }
+
+      expect(result["ip"]).to eq("2.2.2.2")
+    end
+
+    it "falls back to ipaddress when public_ipv4_addrs is empty" do
+      node.automatic_attrs["cloud"] = { "public_ipv4_addrs" => [] }
+
+      expect(result["ip"]).to eq("127.0.0.1")
+    end
+
+    it "falls back to ipaddress when cloud attributes are empty" do
+      node.automatic_attrs["cloud"] = {}
+
+      expect(result["ip"]).to eq("127.0.0.1")
+    end
+
+    it "falls back to ipaddress when cloud attributes is not present" do
+      expect(result["ip"]).to eq("127.0.0.1")
+    end
+  end
+end