knife 17.2.15 → 17.3.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c302c36fa857871e5f6a8a27f6d138ad86bfeb5ffee1887bd10d7197b7981a73
-  data.tar.gz: c2d3065ce5c79cd01c6095db943faffd6ec1bf877e4ba4abd5734e626d95daf8
+  metadata.gz: 31ea76674fe3c36ffd7530564334f6984f1b95cff36f966eb4aa31a51b8fc4cc
+  data.tar.gz: 88a1f4d1335f549e881c9142171f0ee831bb8a6848de85808d136da9d083cc53
 SHA512:
-  metadata.gz: 96690db49cec67bcad891d57a204f324564ea779d09ef503c251985e4903fe0bd3e7756caaadec14d908fb50363f09b649be1481422ef989f998b3ab992c41c7
-  data.tar.gz: c75c3f9a98308ffcc6b8cd99551c1a7d0bc88d73d9fa995b32adf9f9405fb80200e6b517f6dec7872319481e215b14433dbd6931c4cc6eac317985dce00726ab
+  metadata.gz: 18745c29c6a2c249d6ed67eef2d961f3175e4f2f124ba368caed230f2df4c037e58ba14666ca1bae726addc10fd14ae5658be654cc2cb506afc9e4cafe5afb9b
+  data.tar.gz: 63e4f77b325ba95b279d698885a8b92814938ab2c196b5da79ed36a570dc4f0a8ac26c8c56291686f02530cd8e51fb82f2d58f3cd4da13649c7afe271421728a

data/knife.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |s|
   s.add_dependency "net-ssh-multi", "~> 1.2", ">= 1.2.1"
   s.add_dependency "ed25519", "~> 1.2" # ed25519 ssh key support
   s.add_dependency "bcrypt_pbkdf", "~> 1.1" # ed25519 ssh key support
+  # we can't use this gem until illegal instruction issues are resolved
+  # s.add_dependency "x25519" # ed25519 KEX module
   s.add_dependency "highline", ">= 1.6.9", "< 3" # Used in UI to present a list, no other usage.
 
   s.add_dependency "tty-prompt", "~> 0.21" # knife ui.ask prompt

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

@@ -171,12 +171,12 @@ class Chef
             client_rb << "fips true\n"
           end
 
-          unless chef_config[:file_cache_path].nil?
-            client_rb << "file_cache_path \"#{chef_config[:file_cache_path]}\"\n"
+          unless chef_config[:unix_bootstrap_file_cache_path].nil?
+            client_rb << "file_cache_path \"#{chef_config[:unix_bootstrap_file_cache_path]}\"\n"
           end
 
-          unless chef_config[:file_backup_path].nil?
-            client_rb << "file_backup_path \"#{chef_config[:file_backup_path]}\"\n"
+          unless chef_config[:unix_bootstrap_file_backup_path].nil?
+            client_rb << "file_backup_path \"#{chef_config[:unix_bootstrap_file_backup_path]}\"\n"
           end
 
           client_rb

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

@@ -71,8 +71,8 @@ class Chef
           client_rb = <<~CONFIG
             chef_server_url  "#{chef_config[:chef_server_url]}"
             validation_client_name "#{chef_config[:validation_client_name]}"
-            file_cache_path   "#{ChefConfig::PathHelper.escapepath(ChefConfig::Config.var_chef_dir(windows: true))}\\\\cache"
-            file_backup_path  "#{ChefConfig::PathHelper.escapepath(ChefConfig::Config.var_chef_dir(windows: true))}\\\\backup"
+            file_cache_path   "#{ChefConfig::PathHelper.escapepath(chef_config[:windows_bootstrap_file_cache_path] || "")}"
+            file_backup_path  "#{ChefConfig::PathHelper.escapepath(chef_config[:windows_bootstrap_file_backup_path] || "")}"
             cache_options     ({:path => "#{ChefConfig::PathHelper.escapepath(ChefConfig::Config.etc_chef_dir(windows: true))}\\\\cache\\\\checksums", :skip_expires => true})
           CONFIG
 

data/lib/chef/knife/org_user_add.rb

@@ -29,7 +29,7 @@ class Chef
         description: "Add user to admin group"
 
       deps do
-        require_relative "../org"
+        require "chef/org"
       end
 
       def run

data/lib/chef/knife/ssh.rb

@@ -134,6 +134,18 @@ class Chef
         boolean: true,
         default: false
 
+      option :pty,
+        long: "--[no-]pty",
+        description: "Request a PTY, enabled by default.",
+        boolean: true,
+        default: true
+
+      option :require_pty,
+        long: "--[no-]require-pty",
+        description: "Raise exception if a PTY cannot be acquired, disabled by default.",
+        boolean: true,
+        default: false
+
       def session
         ssh_error_handler = Proc.new do |server|
           if config[:on_error]
@@ -353,26 +365,26 @@ class Chef
         ui.msg(str)
       end
 
-      def ssh_command(command, subsession = nil)
+      # @param command [String] the command to run
+      # @param session_list [???] list of sessions, one per node
+      #
+      def ssh_command(command, session_list = session)
+        stderr = ""
         exit_status = 0
-        subsession ||= session
         command = fixup_sudo(command)
         command.force_encoding("binary") if command.respond_to?(:force_encoding)
-        begin
-          open_session(subsession, command)
-        rescue => e
-          open_session(subsession, command, true)
-        end
-      end
-
-      def open_session(subsession, command, pty = false)
-        stderr = ""
-        exit_status = 0
-        subsession.open_channel do |chan|
+        session_list.open_channel do |chan|
           if config[:on_error] && exit_status != 0
             chan.close
           else
-            chan.request_pty if pty
+            if config[:pty]
+              chan.request_pty do |ch, success|
+                unless success
+                  ui.warn("Failed to obtain a PTY from #{ch.connection.host}")
+                  raise ArgumentError, "Request for PTY failed" if config[:require_pty]
+                end
+              end
+            end
             chan.exec command do |ch, success|
               raise ArgumentError, "Cannot execute #{command}" unless success
 
@@ -383,13 +395,11 @@ class Chef
                   ichannel.send_data("#{get_password}\n")
                 end
               end
-
               ch.on_extended_data do |_, _type, data|
-                raise ArgumentError if data.eql?("sudo: no tty present and no askpass program specified\n")
+                raise ArgumentError, "No PTY present. If a PTY is required use --require-pty" if data.eql?("sudo: no tty present and no askpass program specified\n")
 
                 stderr += data
               end
-
               ch.on_request "exit-status" do |ichannel, data|
                 exit_status = [exit_status, data.read_long].max
               end
@@ -398,6 +408,8 @@ class Chef
         end
         session.loop
         exit_status
+      ensure
+        session_list.close
       end
 
       def get_password

data/lib/chef/knife/supermarket_unshare.rb

@@ -50,7 +50,8 @@ class Chef
         rescue Net::HTTPClientException => e
           raise e unless /Forbidden/.match?(e.message)
 
-          ui.error "Forbidden: You must be the maintainer of #{@cookbook_name} to unshare it."
+          ui.error "Forbidden: You must be the maintainer of #{@cookbook_name} to unshare it & #{config[:supermarket_site]} must allow maintainers to unshare cookbooks."
+          ui.warn "The default supermarket #{default_config[:supermarket_site]} does not allow maintainers to unshare cookbooks."
           exit 1
         end
 

data/lib/chef/knife/version.rb

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

data/spec/integration/commands_spec.rb

@@ -0,0 +1,55 @@
+#
+# Author:: Marc Pardise (<marc@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 "chef/knife"
+
+Chef::Knife.subcommand_loader.load_commands
+commands = Chef::Knife::SubcommandLoader.generate_hash["_autogenerated_command_paths"]["plugins_paths"].keys
+
+# Directly execute each support knife command
+context "Command Sanity Check: executing ", :workstation do
+  describe "bundle exec knife" do
+    commands.each do |command|
+      command_name = command.gsub("_", " ")
+      modified_command, expected_result = case command_name
+                                          when /knife/
+                                            # because rspec is the actual executable running, the option parser error message
+                                            # is invalid from within the test.
+                                            next
+                                          when /config (use|get|list) profile.*/
+                                            # hyphenated special cases
+                                            [command_name, /^USAGE: knife config #{$1}-profile.*/]
+                                          when /(role|node|env) (env )?run list(.*)/
+                                            # underscored special cases...
+                                            env_part = $2.nil? ? "" : "env_"
+                                            ["#{$1} #{$2}run_list#{$3}", /^USAGE: knife #{$1} #{env_part}run_list#{$3}.*/]
+                                          else
+                                            [ command_name, /^USAGE: knife #{command_name}.*/]
+                                          end
+
+      # By using bundle exec knife instead of directly loading the command class or using the knife() helper,
+      # we ensure that this is a valid end-to-end test.  This operates on the assumption
+      # that we continue to require the command class to be fully loaded so that it can handle the parsing of
+      # its own options.
+      full_command = "#{modified_command} --invalid-option outputs usage for '#{modified_command}' to stdout"
+      it full_command do
+        result = `bundle exec knife #{full_command}`
+        expect(result).to match(expected_result)
+      end
+    end
+  end
+end

data/spec/integration/cookbook_download_spec.rb

@@ -66,7 +66,7 @@ describe "knife cookbook download", :workstation do
         Downloading root_files
         Cookbook downloaded to #{tmpdir}/x-1.0.1
       EOM
-                                                                            )
+      )
     end
   end
 end

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

@@ -80,16 +80,16 @@ describe Chef::Knife::Core::BootstrapContext do
     end
   end
 
-  describe "when file_cache_path is set" do
-    let(:chef_config) { { file_cache_path: "/home/opscode/cache" } }
-    it "sets file_cache_path in the generated config file" do
+  describe "when unix_bootstrap_file_cache_path is set" do
+    let(:chef_config) { { unix_bootstrap_file_cache_path: "/home/opscode/cache" } }
+    it "sets unix_bootstrap_file_cache_path in the generated config file" do
       expect(bootstrap_context.config_content).to include("file_cache_path \"/home/opscode/cache\"")
     end
   end
 
-  describe "when file_backup_path is set" do
-    let(:chef_config) { { file_backup_path: "/home/opscode/backup" } }
-    it "sets file_backup_path in the generated config file" do
+  describe "when unix_bootstrap_file_backup_path is set" do
+    let(:chef_config) { { unix_bootstrap_file_backup_path: "/home/opscode/backup" } }
+    it "sets unix_bootstrap_file_backup_path in the generated config file" do
       expect(bootstrap_context.config_content).to include("file_backup_path \"/home/opscode/backup\"")
     end
   end

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

@@ -154,8 +154,8 @@ describe Chef::Knife::Core::WindowsBootstrapContext do
           config_log_location: STDOUT,
           chef_server_url: "http://chef.example.com:4444",
           validation_client_name: "chef-validator-testing",
-          file_cache_path: "c:/chef/cache",
-          file_backup_path: "c:/chef/backup",
+          windows_bootstrap_file_cache_path: "c:/chef/cache",
+          windows_bootstrap_file_backup_path: "c:/chef/backup",
           cache_options: ({ path: "c:/chef/cache/checksums", skip_expires: true })
         )
       )
@@ -165,8 +165,8 @@ describe Chef::Knife::Core::WindowsBootstrapContext do
       expected = <<~EXPECTED
         echo.chef_server_url  "http://chef.example.com:4444"
         echo.validation_client_name "chef-validator-testing"
-        echo.file_cache_path   "C:\\\\chef\\\\cache"
-        echo.file_backup_path  "C:\\\\chef\\\\backup"
+        echo.file_cache_path   "c:/chef/cache"
+        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

data/spec/unit/knife/ssh_spec.rb

@@ -289,7 +289,7 @@ describe Chef::Knife::Ssh do
     let(:execution_channel2) { double(:execution_channel, on_data: nil, on_extended_data: nil) }
     let(:session_channel2) { double(:session_channel, request_pty: nil) }
 
-    let(:session) { double(:session, loop: nil) }
+    let(:session) { double(:session, loop: nil, close: nil) }
 
     let(:command) { "false" }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife
 version: !ruby/object:Gem::Version
-  version: 17.2.15
+  version: 17.3.48
 platform: ruby
 authors:
 - Adam Jacob
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-config
@@ -950,6 +950,7 @@ files:
 - spec/integration/client_key_show_spec.rb
 - spec/integration/client_list_spec.rb
 - spec/integration/client_show_spec.rb
+- spec/integration/commands_spec.rb
 - spec/integration/common_options_spec.rb
 - spec/integration/config_list_spec.rb
 - spec/integration/config_show_spec.rb
@@ -1148,7 +1149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: The knife CLI for Chef Infra.