knife 17.3.48 → 17.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31ea76674fe3c36ffd7530564334f6984f1b95cff36f966eb4aa31a51b8fc4cc
-  data.tar.gz: 88a1f4d1335f549e881c9142171f0ee831bb8a6848de85808d136da9d083cc53
+  metadata.gz: 70c4e18afa9b4762387d8a0a6c9c75bca9e1e42723a041147bea36c2efaae176
+  data.tar.gz: '00953cd3c86ab1e11eb9ddb9a8fdf8fffbae40705671090169411877fa72a069'
 SHA512:
-  metadata.gz: 18745c29c6a2c249d6ed67eef2d961f3175e4f2f124ba368caed230f2df4c037e58ba14666ca1bae726addc10fd14ae5658be654cc2cb506afc9e4cafe5afb9b
-  data.tar.gz: 63e4f77b325ba95b279d698885a8b92814938ab2c196b5da79ed36a570dc4f0a8ac26c8c56291686f02530cd8e51fb82f2d58f3cd4da13649c7afe271421728a
+  metadata.gz: f2d2130d599b56a3d43bbbbe5f64407dfc19aaec9df4ea87af2b835b950dda18ef1b9eb6cee28fae9ee05bafef8b6fe180219b36f1f7fbe5333b4efcd3236002
+  data.tar.gz: 0d500fcfd9e9aa0830d04bae3f9d4e3712ab52bf6fcd9b87c4f0e3bbb2149f8568d179c41656189b7614bdbdd91e8dbd5d14800c38771275466c5e3c9e0c78f0

data/lib/chef/knife/bootstrap.rb

@@ -20,6 +20,7 @@ require_relative "../knife"
 require_relative "data_bag_secret_options"
 require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 require "license_acceptance/cli_flags/mixlib_cli"
+
 module LicenseAcceptance
   autoload :Acceptor, "license_acceptance/acceptor"
 end
@@ -705,6 +706,8 @@ class Chef
           ui.warn("#{e.message} - trying with pty request")
           conn_options[:pty] = true # ensure we can talk to systems with requiretty set true in sshd config
           retry
+        elsif e.reason == :sudo_missing_terminal
+          ui.error "Sudo password is required for this operation. Please enter password using -P or --ssh-password option"
         elsif config[:use_sudo_password] && (e.reason == :sudo_password_required || e.reason == :bad_sudo_password) && limit < 3
           ui.warn("Failed to authenticate #{conn_options[:user]} to #{server_name} - #{e.message} \n sudo: #{limit} incorrect password attempt")
           sudo_password = ui.ask("Enter sudo password for #{conn_options[:user]}@#{server_name}:", echo: false)

data/lib/chef/knife/bootstrap/train_connector.rb

@@ -240,7 +240,7 @@ class Chef
 
           # Now that everything is populated, fill in anything missing
           # that may be found in user ssh config
-          opts.merge!(missing_opts_from_ssh_config(opts, opts_in))
+          opts.merge!(missing_opts_from_ssh_config(opts))
 
           Train.target_config(opts)
         end
@@ -297,12 +297,12 @@ class Chef
         # in the configuration passed in.
         # This is necessary because train will default these values
         # itself - causing SSH config data to be ignored
-        def missing_opts_from_ssh_config(config, opts_in)
+        def missing_opts_from_ssh_config(config)
           return {} unless config[:backend] == "ssh"
 
           host_cfg = ssh_config_for_host(config[:host])
           opts_out = {}
-          opts_in.each do |key, _value|
+          host_cfg.each do |key, _value|
             if SSH_CONFIG_OVERRIDE_KEYS.include?(key) && !config.key?(key)
               opts_out[key] = host_cfg[key]
             end

data/lib/chef/knife/client_create.rb

@@ -81,6 +81,14 @@ class Chef
           client.public_key File.read(File.expand_path(config[:public_key]))
         end
 
+        # Check the file before creating the client so the api is more transactional.
+        if config[:file]
+          file = config[:file]
+          dir_name = File.dirname(file)
+          check_writable_or_exists(dir_name, "Directory")
+          check_writable_or_exists(file, "File")
+        end
+
         output = edit_hash(client)
         final_client = create_client(output)
         ui.info("Created #{final_client}")
@@ -96,6 +104,19 @@ class Chef
           end
         end
       end
+
+      # To check if file or directory exists or writable and raise exception accordingly
+      def check_writable_or_exists(file, type)
+        if File.exist?(file)
+          unless File.writable?(file)
+            ui.fatal "#{type} #{file} is not writable. Check permissions."
+            exit 1
+          end
+        else
+          ui.fatal "#{type} #{file} does not exist."
+          exit 1
+        end
+      end
     end
   end
 end

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -86,8 +86,8 @@ class Chef
             client_rb << "# Using default node name (fqdn)\n"
           end
 
-          if config[:config_log_level]
-            client_rb << %Q{log_level :#{config[:config_log_level]}\n}
+          if chef_config[:config_log_level]
+            client_rb << %Q{log_level :#{chef_config[:config_log_level]}\n}
           else
             client_rb << "log_level        :auto\n"
           end

data/lib/chef/knife/version.rb

@@ -17,7 +17,7 @@
 class Chef
   class Knife
     KNIFE_ROOT = File.expand_path("../..", __dir__)
-    VERSION = "17.3.48".freeze
+    VERSION = "17.4.18".freeze
   end
 end
 

data/spec/integration/client_create_spec.rb

@@ -50,6 +50,7 @@ describe "knife client create", :workstation do
 
     it "saves the private key to a file" do
       Dir.mktmpdir do |tgt|
+        File.open("#{tgt}/bah.pem", "w") { |pub| pub.write("test key") }
         knife("client create -f #{tgt}/bah.pem bah").should_succeed stderr: out
         expect(File).to exist("#{tgt}/bah.pem")
       end

data/spec/unit/knife/bootstrap_spec.rb

@@ -1307,7 +1307,7 @@ describe Chef::Knife::Bootstrap do
       context "when no identity file is specified" do
         it "generates the expected configuration (no keys, keys_only false)" do
           expect(knife.ssh_identity_opts).to eq( {
-            key_files: [ ],
+            key_files: [],
             keys_only: false,
           })
         end
@@ -2050,6 +2050,19 @@ describe Chef::Knife::Bootstrap do
         expect { knife.do_connect({}) }.to raise_error(expected_error)
       end
     end
+
+    context "when a train sudo error is thrown for missing terminal" do
+      let(:ui_error_msg) { "Sudo password is required for this operation. Please enter password using -P or --ssh-password option" }
+      let(:expected_error) { Train::UserError.new(ui_error_msg, :sudo_missing_terminal) }
+      before do
+        allow(connection).to receive(:connect!).and_raise(expected_error)
+      end
+      it "outputs user friendly error message" do
+        expect { knife.do_connect({}) }.not_to raise_error
+        expect(stderr.string).to include(ui_error_msg)
+      end
+    end
+
   end
 
   describe "validate_winrm_transport_opts!" do

data/spec/unit/knife/client_create_spec.rb

@@ -122,10 +122,12 @@ describe Chef::Knife::ClientCreate do
         end
 
         it "should write the private key to a file" do
-          knife.config[:file] = "/tmp/monkeypants"
+          file = Tempfile.new
+          file_path = file.path
+          knife.config[:file] = file_path
           filehandle = double("Filehandle")
           expect(filehandle).to receive(:print).with("woot")
-          expect(File).to receive(:open).with("/tmp/monkeypants", "w").and_yield(filehandle)
+          expect(File).to receive(:open).with(file_path, "w").and_yield(filehandle)
           knife.run
         end
       end
@@ -164,6 +166,39 @@ describe Chef::Knife::ClientCreate do
           expect(client.validator).to be_truthy
         end
       end
+
+      describe "with -f or --file when dir or file is not writable or does not exists" do
+        let(:dir_path) { File.expand_path(File.join(CHEF_SPEC_DATA, "knife", "temp_dir")) }
+        let(:file_path) { File.expand_path(File.join(dir_path, "tmp.pem")) }
+
+        it "when the directory does not exists" do
+          knife.config[:file] = "example/client1.pem"
+          expect(knife.ui).to receive(:fatal).with("Directory example does not exist.")
+          expect { knife.run }.to raise_error(SystemExit)
+        end
+
+        it "when the directory not writable" do
+          knife.config[:file] = file_path
+          File.chmod(777, dir_path)
+          expect(knife.ui).to receive(:fatal).with("Directory #{dir_path} is not writable. Check permissions.")
+          expect { knife.run }.to raise_error(SystemExit)
+        end
+
+        it "when the file does not exists" do
+          path = "#{dir_path}/client1.pem"
+          knife.config[:file] = path
+          File.chmod(0755, dir_path)
+          expect(knife.ui).to receive(:fatal).with("File #{path} does not exist.")
+          expect { knife.run }.to raise_error(SystemExit)
+        end
+
+        it "when the file is not writable" do
+          knife.config[:file] = file_path
+          File.chmod(777, file_path)
+          expect(knife.ui).to receive(:fatal).with("File #{file_path} is not writable. Check permissions.")
+          expect { knife.run }.to raise_error(SystemExit)
+        end
+      end
     end
   end
 end

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

@@ -169,7 +169,7 @@ describe Chef::Knife::Core::WindowsBootstrapContext do
         echo.file_backup_path  "c:/chef/backup"
         echo.cache_options     ^({:path =^> "C:\\\\chef\\\\cache\\\\checksums", :skip_expires =^> true}^)
         echo.# Using default node name ^(fqdn^)
-        echo.log_level        :auto
+        echo.log_level :info
         echo.log_location       STDOUT
       EXPECTED
       expect(bootstrap_context.config_content).to eq expected

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife
 version: !ruby/object:Gem::Version
-  version: 17.3.48
+  version: 17.4.18
 platform: ruby
 authors:
 - Adam Jacob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -751,6 +751,7 @@ files:
 - spec/data/kitchen/openldap/recipes/woot.rb
 - spec/data/knife-home/.chef/plugins/knife/example_home_subcommand.rb
 - spec/data/knife-site-subcommands/plugins/knife/example_subcommand.rb
+- spec/data/knife/temp_dir/tmp.pem
 - spec/data/knife_subcommand/test_explicit_category.rb
 - spec/data/knife_subcommand/test_name_mapping.rb
 - spec/data/knife_subcommand/test_yourself.rb