knife 18.2.7 → 18.3.0

data/spec/unit/knife/client_create_spec.rb

@@ -1,232 +1,232 @@
-#
-# 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
-
-  let(:tmpdir) { Dir.mktmpdir }
-  let(:file_path) { File.join(tmpdir, "client.pem") }
-  let(:dir_path) { File.dirname(file_path) }
-
-  before do
-    allow(File).to receive(:exist?).and_call_original
-    allow(File).to receive(:exist?).with(file_path).and_return(false)
-    allow(File).to receive(:exist?).with(dir_path).and_return(true)
-    allow(File).to receive(:directory?).with(dir_path).and_return(true)
-    allow(File).to receive(:writable?).with(file_path).and_return(true)
-    allow(File).to receive(:writable?).with(dir_path).and_return(true)
-  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
-          knife.config[:file] = file_path
-          client.private_key "woot"
-        end
-
-        it "should write the private key to a file" do
-          filehandle = double("Filehandle")
-          expect(filehandle).to receive(:print).with("woot")
-          expect(File).to receive(:open).with(file_path, "w").and_yield(filehandle)
-          knife.run
-        end
-
-        context "when the directory does not exist" do
-          before { allow(File).to receive(:exist?).with(dir_path).and_return(false) }
-
-          it "writes a fatal message and exits 1" do
-            expect(knife.ui).to receive(:fatal).with("Directory #{dir_path} does not exist. Please create and retry.")
-            expect { knife.run }.to raise_error(SystemExit)
-          end
-        end
-
-        context "when the directory is not writable" do
-          before { allow(File).to receive(:writable?).with(dir_path).and_return(false) }
-
-          it "writes a fatal message and exits 1" do
-            expect(knife.ui).to receive(:fatal).with("Directory #{dir_path} is not writable. Please check the permissions.")
-            expect { knife.run }.to raise_error(SystemExit)
-          end
-        end
-
-        context "when the directory is a file" do
-          before { allow(File).to receive(:directory?).with(dir_path).and_return(false) }
-
-          it "writes a fatal message and exits 1" do
-            expect(knife.ui).to receive(:fatal).with("#{dir_path} exists, but is not a directory. Please update your file path (--file #{file_path}) or re-create #{dir_path} as a directory.")
-            expect { knife.run }.to raise_error(SystemExit)
-          end
-        end
-
-        context "when the file does not exist" do
-          before do
-            allow(File).to receive(:exist?).with(file_path).and_return(false)
-          end
-
-          it "does not log a fatal message and does not raise exception" do
-            expect(knife.ui).not_to receive(:fatal)
-            expect { knife.run }.not_to raise_error
-          end
-        end
-
-        context "when the file exists and is not writable" do
-          before do
-            allow(File).to receive(:exist?).with(file_path).and_return(true)
-            allow(File).to receive(:writable?).with(file_path).and_return(false)
-          end
-
-          it "writes a fatal message and exits 1" do
-            expect(knife.ui).to receive(:fatal).with("File #{file_path} is not writable. Please check the permissions.")
-            expect { knife.run }.to raise_error(SystemExit)
-          end
-        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
+#
+# 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
+
+  let(:tmpdir) { Dir.mktmpdir }
+  let(:file_path) { File.join(tmpdir, "client.pem") }
+  let(:dir_path) { File.dirname(file_path) }
+
+  before do
+    allow(File).to receive(:exist?).and_call_original
+    allow(File).to receive(:exist?).with(file_path).and_return(false)
+    allow(File).to receive(:exist?).with(dir_path).and_return(true)
+    allow(File).to receive(:directory?).with(dir_path).and_return(true)
+    allow(File).to receive(:writable?).with(file_path).and_return(true)
+    allow(File).to receive(:writable?).with(dir_path).and_return(true)
+  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
+          knife.config[:file] = file_path
+          client.private_key "woot"
+        end
+
+        it "should write the private key to a file" do
+          filehandle = double("Filehandle")
+          expect(filehandle).to receive(:print).with("woot")
+          expect(File).to receive(:open).with(file_path, "w").and_yield(filehandle)
+          knife.run
+        end
+
+        context "when the directory does not exist" do
+          before { allow(File).to receive(:exist?).with(dir_path).and_return(false) }
+
+          it "writes a fatal message and exits 1" do
+            expect(knife.ui).to receive(:fatal).with("Directory #{dir_path} does not exist. Please create and retry.")
+            expect { knife.run }.to raise_error(SystemExit)
+          end
+        end
+
+        context "when the directory is not writable" do
+          before { allow(File).to receive(:writable?).with(dir_path).and_return(false) }
+
+          it "writes a fatal message and exits 1" do
+            expect(knife.ui).to receive(:fatal).with("Directory #{dir_path} is not writable. Please check the permissions.")
+            expect { knife.run }.to raise_error(SystemExit)
+          end
+        end
+
+        context "when the directory is a file" do
+          before { allow(File).to receive(:directory?).with(dir_path).and_return(false) }
+
+          it "writes a fatal message and exits 1" do
+            expect(knife.ui).to receive(:fatal).with("#{dir_path} exists, but is not a directory. Please update your file path (--file #{file_path}) or re-create #{dir_path} as a directory.")
+            expect { knife.run }.to raise_error(SystemExit)
+          end
+        end
+
+        context "when the file does not exist" do
+          before do
+            allow(File).to receive(:exist?).with(file_path).and_return(false)
+          end
+
+          it "does not log a fatal message and does not raise exception" do
+            expect(knife.ui).not_to receive(:fatal)
+            expect { knife.run }.not_to raise_error
+          end
+        end
+
+        context "when the file exists and is not writable" do
+          before do
+            allow(File).to receive(:exist?).with(file_path).and_return(true)
+            allow(File).to receive(:writable?).with(file_path).and_return(false)
+          end
+
+          it "writes a fatal message and exits 1" do
+            expect(knife.ui).to receive(:fatal).with("File #{file_path} is not writable. Please check the permissions.")
+            expect { knife.run }.to raise_error(SystemExit)
+          end
+        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

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