knife 17.0.244 → 17.2.15

data/spec/unit/knife/client_bulk_delete_spec.rb

@@ -0,0 +1,166 @@
+#
+# Author:: Stephen Delano (<stephen@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"
+
+describe Chef::Knife::ClientBulkDelete do
+  let(:stdout_io) { StringIO.new }
+  let(:stdout) { stdout_io.string }
+  let(:stderr_io) { StringIO.new }
+  let(:stderr) { stderr_io.string }
+
+  let(:knife) do
+    k = Chef::Knife::ClientBulkDelete.new
+    k.name_args = name_args
+    k.config = option_args
+    allow(k.ui).to receive(:stdout).and_return(stdout_io)
+    allow(k.ui).to receive(:stderr).and_return(stderr_io)
+    allow(k.ui).to receive(:confirm).and_return(knife_confirm)
+    allow(k.ui).to receive(:confirm_without_exit).and_return(knife_confirm)
+    k
+  end
+
+  let(:name_args) { [ "." ] }
+  let(:option_args) { {} }
+
+  let(:knife_confirm) { true }
+
+  let(:nonvalidator_client_names) { %w{tim dan stephen} }
+  let(:nonvalidator_clients) do
+    clients = {}
+
+    nonvalidator_client_names.each do |client_name|
+      client = Chef::ApiClientV1.new
+      client.name(client_name)
+      allow(client).to receive(:destroy).and_return(true)
+      clients[client_name] = client
+    end
+
+    clients
+  end
+
+  let(:validator_client_names) { %w{myorg-validator} }
+  let(:validator_clients) do
+    clients = {}
+
+    validator_client_names.each do |validator_client_name|
+      validator_client = Chef::ApiClientV1.new
+      validator_client.name(validator_client_name)
+      allow(validator_client).to receive(:validator).and_return(true)
+      allow(validator_client).to receive(:destroy).and_return(true)
+      clients[validator_client_name] = validator_client
+    end
+
+    clients
+  end
+
+  let(:client_names) { nonvalidator_client_names + validator_client_names }
+  let(:clients) do
+    nonvalidator_clients.merge(validator_clients)
+  end
+
+  before(:each) do
+    allow(Chef::ApiClientV1).to receive(:list).and_return(clients)
+  end
+
+  describe "run" do
+    describe "without a regex" do
+      let(:name_args) { [ ] }
+
+      it "should exit if the regex is not provided" do
+        expect { knife.run }.to raise_error(SystemExit)
+      end
+    end
+
+    describe "with any clients" do
+      it "should get the list of the clients" do
+        expect(Chef::ApiClientV1).to receive(:list)
+        knife.run
+      end
+
+      it "should print the name of the clients" do
+        knife.run
+        client_names.each do |client_name|
+          expect(stdout).to include(client_name)
+        end
+      end
+
+      it "should confirm you really want to delete them" do
+        expect(knife.ui).to receive(:confirm)
+        knife.run
+      end
+
+      describe "without --delete-validators" do
+        it "should mention that validator clients wont be deleted" do
+          knife.run
+          expect(stdout).to include("The following clients are validators and will not be deleted:")
+          info = stdout.index "The following clients are validators and will not be deleted:"
+          val = stdout.index "myorg-validator"
+          expect(val > info).to be_truthy
+        end
+
+        it "should only delete nonvalidator clients" do
+          nonvalidator_clients.each_value do |c|
+            expect(c).to receive(:destroy)
+          end
+
+          validator_clients.each_value do |c|
+            expect(c).not_to receive(:destroy)
+          end
+
+          knife.run
+        end
+      end
+
+      describe "with --delete-validators" do
+        let(:option_args) { { delete_validators: true } }
+
+        it "should mention that validator clients will be deleted" do
+          knife.run
+          expect(stdout).to include("The following validators will be deleted")
+        end
+
+        it "should confirm twice" do
+          expect(knife.ui).to receive(:confirm).once
+          expect(knife.ui).to receive(:confirm_without_exit).once
+          knife.run
+        end
+
+        it "should delete all clients" do
+          clients.each_value do |c|
+            expect(c).to receive(:destroy)
+          end
+
+          knife.run
+        end
+      end
+    end
+
+    describe "with some clients" do
+      let(:name_args) { [ "^ti" ] }
+
+      it "should only delete clients that match the regex" do
+        expect(clients["tim"]).to receive(:destroy)
+        expect(clients["stephen"]).not_to receive(:destroy)
+        expect(clients["dan"]).not_to receive(:destroy)
+        expect(clients["myorg-validator"]).not_to receive(:destroy)
+        knife.run
+      end
+    end
+  end
+end

data/spec/unit/knife/client_create_spec.rb

@@ -0,0 +1,169 @@
+#
+# Author:: Adam Jacob (<adam@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"
+
+Chef::Knife::ClientCreate.load_deps
+
+describe Chef::Knife::ClientCreate do
+  let(:stderr) { StringIO.new }
+  let(:stdout) { StringIO.new }
+
+  let(:default_client_hash) do
+    {
+      "name" => "adam",
+      "validator" => false,
+    }
+  end
+
+  let(:client) do
+    Chef::ApiClientV1.new
+  end
+
+  let(:knife) do
+    k = Chef::Knife::ClientCreate.new
+    k.name_args = []
+    allow(k).to receive(:client).and_return(client)
+    allow(k).to receive(:edit_hash).with(client).and_return(client)
+    allow(k.ui).to receive(:stderr).and_return(stderr)
+    allow(k.ui).to receive(:stdout).and_return(stdout)
+    k
+  end
+
+  before do
+    allow(client).to receive(:to_s).and_return("client[adam]")
+    allow(knife).to receive(:create_client).and_return(client)
+  end
+
+  before(:each) do
+    Chef::Config[:node_name] = "webmonkey.example.com"
+  end
+
+  describe "run" do
+    context "when nothing is passed" do
+      # from spec/support/shared/unit/knife_shared.rb
+      it_should_behave_like "mandatory field missing" do
+        let(:name_args) { [] }
+        let(:fieldname) { "client name" }
+      end
+    end
+
+    context "when clientname is passed" do
+      before do
+        knife.name_args = ["adam"]
+      end
+
+      context "when public_key and prevent_keygen are passed" do
+        before do
+          knife.config[:public_key] = "some_key"
+          knife.config[:prevent_keygen] = true
+        end
+
+        it "prints the usage" do
+          expect(knife).to receive(:show_usage)
+          expect { knife.run }.to raise_error(SystemExit)
+        end
+
+        it "prints a relevant error message" do
+          expect { knife.run }.to raise_error(SystemExit)
+          expect(stderr.string).to match(/You cannot pass --public-key and --prevent-keygen/)
+        end
+      end
+
+      it "should create the ApiClient" do
+        expect(knife).to receive(:create_client)
+        knife.run
+      end
+
+      it "should print a message upon creation" do
+        expect(knife).to receive(:create_client)
+        knife.run
+        expect(stderr.string).to match(/Created client.*adam/i)
+      end
+
+      it "should set the Client name" do
+        knife.run
+        expect(client.name).to eq("adam")
+      end
+
+      it "by default it is not a validator" do
+        knife.run
+        expect(client.validator).to be_falsey
+      end
+
+      it "by default it should set create_key to true" do
+        knife.run
+        expect(client.create_key).to be_truthy
+      end
+
+      it "should allow you to edit the data" do
+        expect(knife).to receive(:edit_hash).with(client).and_return(client)
+        knife.run
+      end
+
+      describe "with -f or --file" do
+        before do
+          client.private_key "woot"
+        end
+
+        it "should write the private key to a file" do
+          knife.config[:file] = "/tmp/monkeypants"
+          filehandle = double("Filehandle")
+          expect(filehandle).to receive(:print).with("woot")
+          expect(File).to receive(:open).with("/tmp/monkeypants", "w").and_yield(filehandle)
+          knife.run
+        end
+      end
+
+      describe "with -p or --public-key" do
+        before do
+          knife.config[:public_key] = "some_key"
+          allow(File).to receive(:read).and_return("some_key")
+          allow(File).to receive(:expand_path)
+        end
+
+        it "sets the public key" do
+          knife.run
+          expect(client.public_key).to eq("some_key")
+        end
+      end
+
+      describe "with -k or --prevent-keygen" do
+        before do
+          knife.config[:prevent_keygen] = true
+        end
+
+        it "does not set create_key" do
+          knife.run
+          expect(client.create_key).to be_falsey
+        end
+      end
+
+      describe "with --validator" do
+        before do
+          knife.config[:validator] = true
+        end
+
+        it "should create an validator client" do
+          knife.run
+          expect(client.validator).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/unit/knife/client_delete_spec.rb

@@ -0,0 +1,99 @@
+#
+# Author:: Thomas Bishop (<bishop.thomas@gmail.com>)
+# Copyright:: Copyright 2011-2016, Thomas Bishop
+# 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::ClientDelete do
+  before(:each) do
+    @knife = Chef::Knife::ClientDelete.new
+    # defaults
+    @knife.config = {
+      delete_validators: false,
+    }
+    @knife.name_args = [ "adam" ]
+  end
+
+  describe "run" do
+    it "should delete the client" do
+      expect(@knife).to receive(:delete_object).with(Chef::ApiClientV1, "adam", "client")
+      @knife.run
+    end
+
+    context "receives multiple clients" do
+      let(:clients) { %w{ adam ben charlie } }
+
+      before(:each) do
+        @knife.name_args = clients
+      end
+
+      it "deletes all clients" do
+        clients.each do |client|
+          expect(@knife).to receive(:delete_object).with(Chef::ApiClientV1, client, "client")
+        end
+
+        @knife.run
+      end
+    end
+
+    it "should print usage and exit when a client name is not provided" do
+      @knife.name_args = []
+      expect(@knife).to receive(:show_usage)
+      expect(@knife.ui).to receive(:fatal)
+      expect { @knife.run }.to raise_error(SystemExit)
+    end
+  end
+
+  describe "with a validator" do
+    before(:each) do
+      allow(Chef::Knife::UI).to receive(:confirm).and_return(true)
+      allow(@knife).to receive(:confirm).and_return(true)
+      @client = Chef::ApiClientV1.new
+      expect(Chef::ApiClientV1).to receive(:load).and_return(@client)
+    end
+
+    it "should delete non-validator client if --delete-validators is not set" do
+      @knife.config[:delete_validators] = false
+      expect(@client).to receive(:destroy).and_return(@client)
+      expect(@knife).to receive(:msg)
+
+      @knife.run
+    end
+
+    it "should delete non-validator client if --delete-validators is set" do
+      @knife.config[:delete_validators] = true
+      expect(@client).to receive(:destroy).and_return(@client)
+      expect(@knife).to receive(:msg)
+
+      @knife.run
+    end
+
+    it "should not delete validator client if --delete-validators is not set" do
+      @client.validator(true)
+      expect(@knife.ui).to receive(:fatal)
+      expect { @knife.run }.to raise_error(SystemExit)
+    end
+
+    it "should delete validator client if --delete-validators is set" do
+      @knife.config[:delete_validators] = true
+      expect(@client).to receive(:destroy).and_return(@client)
+      expect(@knife).to receive(:msg)
+
+      @knife.run
+    end
+  end
+end

data/spec/unit/knife/client_edit_spec.rb

@@ -0,0 +1,53 @@
+#
+# Author:: Thomas Bishop (<bishop.thomas@gmail.com>)
+# Copyright:: Copyright 2011-2016, Thomas Bishop
+# 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/api_client_v1"
+
+describe Chef::Knife::ClientEdit do
+  before(:each) do
+    @knife = Chef::Knife::ClientEdit.new
+    @knife.name_args = [ "adam" ]
+    @knife.config[:disable_editing] = true
+  end
+
+  describe "run" do
+    let(:data) do
+      {
+        "name" => "adam",
+        "validator" => false,
+        "admin" => false,
+        "chef_type" => "client",
+        "create_key" => true,
+      }
+    end
+
+    it "should edit the client" do
+      allow(Chef::ApiClientV1).to receive(:load).with("adam").and_return(data)
+      expect(@knife).to receive(:edit_hash).with(data).and_return(data)
+      @knife.run
+    end
+
+    it "should print usage and exit when a client name is not provided" do
+      @knife.name_args = []
+      expect(@knife).to receive(:show_usage)
+      expect(@knife.ui).to receive(:fatal)
+      expect { @knife.run }.to raise_error(SystemExit)
+    end
+  end
+end