knife-windows 3.0.16 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bf9ee2c613479ede8ca7162dc326889a69a3936c794d0f8898a014676aa7373
-  data.tar.gz: 7bd86644459d72d726f04a05ebf5556681c7c9500d7265f462bf2faed021fcdf
+  metadata.gz: ac2b46b0151ca71c6c81e0d3596d931ae6b0f0d8854d62e042dea80124484eaf
+  data.tar.gz: 62ed4aea58642c7963c7538099e74ca9f37764c951c546eaedf15d544978143b
 SHA512:
-  metadata.gz: c47e0e9ce82edda40813b9bb78756efa366df609e14fa2b8f35c08e122f1704882576e7edc9a7d82a151befeac2833f05b82f46172c2dae3323fdd9546f75c8c
-  data.tar.gz: d57e52ac773a16fd50274ad0a39a5222fc0b1cea5cc5e3ff2b1b4cec26f49a4ac14b4b8fe72ff0daa53857b6dfb7b01a0fa67e706b77b4e4163f06cb799440b4
+  metadata.gz: e4401141da0bd90233bb91fbd73dfab433db23b932cdd344a9c33b65706813a01d907a2cca364a5a9ff792f118cf3590b2c9bb03ffab7c3b9882ee8801a829ae
+  data.tar.gz: 9bc68889c0fede227babb39ffc07858c65299837271bfc980a698d03a6b7d4da04d6a5edc6ba462d6bf7726a347327f5323cbbd820415a108dbdaf684f5f3326

data/lib/chef/knife/bootstrap_windows_ssh.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright (c) 2011-2020 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,13 +42,12 @@ class Chef
         short: "-p PORT",
         long: "--ssh-port PORT",
         description: "The ssh port",
-        proc: Proc.new { |key| Chef::Config[:knife][:ssh_port] = key.strip }
+        proc: Proc.new { |key| key.strip }
 
       option :ssh_gateway,
         short: "-G GATEWAY",
         long: "--ssh-gateway GATEWAY",
-        description: "The ssh gateway",
-        proc: Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
+        description: "The ssh gateway"
 
       option :forward_agent,
         short: "-A",

data/lib/chef/knife/helpers/bootstrap_windows_base.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright (c) 2011-2020 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,15 +17,11 @@
 #
 
 require "chef/knife"
-require_relative "knife_windows_base"
 require "chef/util/path_helper"
 
 class Chef
   class Knife
     module BootstrapWindowsBase
-
-      include Chef::Knife::KnifeWindowsBase
-
       # :nodoc:
       # Would prefer to do this in a rational way, but can't be done b/c of
       # Mixlib::CLI's design :(
@@ -43,23 +39,19 @@ class Chef
 
           option :bootstrap_version,
             long: "--bootstrap-version VERSION",
-            description: "The version of Chef to install",
-            proc: Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
+            description: "The version of Chef to install"
 
           option :bootstrap_proxy,
             long: "--bootstrap-proxy PROXY_URL",
-            description: "The proxy server for the node being bootstrapped",
-            proc: Proc.new { |p| Chef::Config[:knife][:bootstrap_proxy] = p }
+            description: "The proxy server for the node being bootstrapped"
 
           option :bootstrap_no_proxy,
             long: "--bootstrap-no-proxy [NO_PROXY_URL|NO_PROXY_IP]",
-            description: "Do not proxy locations for the node being bootstrapped; this option is used internally by Opscode",
-            proc: Proc.new { |np| Chef::Config[:knife][:bootstrap_no_proxy] = np }
+            description: "Do not proxy locations for the node being bootstrapped; this option is used internally by Opscode"
 
           option :bootstrap_install_command,
             long: "--bootstrap-install-command COMMANDS",
-            description: "Custom command to install chef-client",
-            proc: Proc.new { |ic| Chef::Config[:knife][:bootstrap_install_command] = ic }
+            description: "Custom command to install chef-client"
 
           option :bootstrap_template,
             short: "-t TEMPLATE",
@@ -76,10 +68,11 @@ class Chef
           option :hint,
             long: "--hint HINT_NAME[=HINT_FILE]",
             description: "Specify Ohai Hint to be set on the bootstrap target. Use multiple --hint options to specify multiple hints.",
-            proc: Proc.new { |h|
-              Chef::Config[:knife][:hints] ||= {}
+            proc: Proc.new { |h, accumulator|
+              accumulator ||= {}
               name, path = h.split("=")
-              Chef::Config[:knife][:hints][name] = path ? Chef::JSONCompat.parse(::File.read(path)) : {}
+              accumulator[name] = path ? Chef::JSONCompat.parse(::File.read(path)) : {}
+              accumulator
             }
 
           option :first_boot_attributes,
@@ -151,12 +144,12 @@ class Chef
           option :bootstrap_vault_item,
             long: "--bootstrap-vault-item VAULT_ITEM",
             description: 'A single vault and item to update as "vault:item"',
-            proc: Proc.new { |i|
+            proc: Proc.new { |i, accumulator|
               (vault, item) = i.split(/:/)
-              Chef::Config[:knife][:bootstrap_vault_item] ||= {}
-              Chef::Config[:knife][:bootstrap_vault_item][vault] ||= []
-              Chef::Config[:knife][:bootstrap_vault_item][vault].push(item)
-              Chef::Config[:knife][:bootstrap_vault_item]
+              accumulator ||= {}
+              accumulator[vault] ||= []
+              accumulator[vault].push(item)
+              accumulator
             }
 
           option :policy_name,

data/lib/chef/knife/helpers/winrm_base.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright (c) 2011-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -42,14 +42,12 @@ class Chef
             short: "-x USERNAME",
             long: "--winrm-user USERNAME",
             description: "The WinRM username",
-            default: "Administrator",
-            proc: Proc.new { |key| Chef::Config[:knife][:winrm_user] = key }
+            default: "Administrator"
 
           option :winrm_password,
             short: "-P PASSWORD",
             long: "--winrm-password PASSWORD",
-            description: "The WinRM password",
-            proc: Proc.new { |key| Chef::Config[:knife][:winrm_password] = key }
+            description: "The WinRM password"
 
           option :winrm_shell,
             long: "--winrm-shell SHELL",
@@ -61,42 +59,32 @@ class Chef
             short: "-w TRANSPORT",
             long: "--winrm-transport TRANSPORT",
             description: "The WinRM transport type. Valid choices are [ssl, plaintext]",
-            default: "plaintext",
-            proc: Proc.new { |transport|
-              Chef::Config[:knife][:winrm_port] = "5986" if transport == "ssl"
-              Chef::Config[:knife][:winrm_transport] = transport
-            }
+            default: "plaintext"
 
           option :winrm_port,
             short: "-p PORT",
             long: "--winrm-port PORT",
-            description: "The WinRM port, by default this is '5985' for 'plaintext' and '5986' for 'ssl' winrm transport",
-            default: "5985",
-            proc: Proc.new { |key| Chef::Config[:knife][:winrm_port] = key }
+            description: "The WinRM port, by default this is '5985' for 'plaintext' and '5986' for 'ssl' winrm transport"
 
           option :kerberos_keytab_file,
             short: "-T KEYTAB_FILE",
             long: "--keytab-file KEYTAB_FILE",
-            description: "The Kerberos keytab file used for authentication",
-            proc: Proc.new { |keytab| Chef::Config[:knife][:kerberos_keytab_file] = keytab }
+            description: "The Kerberos keytab file used for authentication"
 
           option :kerberos_realm,
             short: "-R KERBEROS_REALM",
             long: "--kerberos-realm KERBEROS_REALM",
-            description: "The Kerberos realm used for authentication",
-            proc: Proc.new { |realm| Chef::Config[:knife][:kerberos_realm] = realm }
+            description: "The Kerberos realm used for authentication"
 
           option :kerberos_service,
             short: "-S KERBEROS_SERVICE",
             long: "--kerberos-service KERBEROS_SERVICE",
-            description: "The Kerberos service used for authentication",
-            proc: Proc.new { |service| Chef::Config[:knife][:kerberos_service] = service }
+            description: "The Kerberos service used for authentication"
 
           option :ca_trust_file,
             short: "-f CA_TRUST_FILE",
             long: "--ca-trust-file CA_TRUST_FILE",
-            description: "The Certificate Authority (CA) trust file used for SSL transport",
-            proc: Proc.new { |trust| Chef::Config[:knife][:ca_trust_file] = trust }
+            description: "The Certificate Authority (CA) trust file used for SSL transport"
 
           option :winrm_ssl_verify_mode,
             long: "--winrm-ssl-verify-mode SSL_VERIFY_MODE",
@@ -111,8 +99,7 @@ class Chef
           option :winrm_authentication_protocol,
             long: "--winrm-authentication-protocol AUTHENTICATION_PROTOCOL",
             description: "The authentication protocol used during WinRM communication. The supported protocols are #{WINRM_AUTH_PROTOCOL_LIST.join(",")}. Default is 'negotiate'.",
-            default: "negotiate",
-            proc: Proc.new { |protocol| Chef::Config[:knife][:winrm_authentication_protocol] = protocol }
+            default: "negotiate"
 
           option :session_timeout,
             long: "--session-timeout Minutes",

data/lib/chef/knife/helpers/winrm_knife_base.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Steven Murawski (<smurawski@chef.io)
-# Copyright:: Copyright (c) 2015-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,7 @@
 require "chef/knife"
 require_relative "winrm_base"
 require_relative "winrm_shared_options"
-require_relative "knife_windows_base"
+require_relative "winrm_session"
 
 class Chef
   class Knife
@@ -39,10 +39,9 @@ class Chef
 
           include Chef::Knife::WinrmBase
           include Chef::Knife::WinrmSharedOptions
-          include Chef::Knife::KnifeWindowsBase
 
           def validate_winrm_options!
-            winrm_auth_protocol = locate_config_value(:winrm_authentication_protocol)
+            winrm_auth_protocol = config[:winrm_authentication_protocol]
 
             unless Chef::Knife::WinrmBase::WINRM_AUTH_PROTOCOL_LIST.include?(winrm_auth_protocol)
               ui.error "Invalid value '#{winrm_auth_protocol}' for --winrm-authentication-protocol option."
@@ -120,7 +119,7 @@ class Chef
             @session_results = []
             queue = Queue.new
             @winrm_sessions.each { |s| queue << s }
-            num_sessions = locate_config_value(:concurrency)
+            num_sessions = config[:concurrency]
             num_targets = @winrm_sessions.length
             num_sessions = (num_sessions.nil? || num_sessions == 0) ? num_targets : [num_sessions, num_targets].min
 
@@ -146,7 +145,7 @@ class Chef
             if authorization_error?(e)
               unless config[:suppress_auth_failure]
                 # Display errors if the caller hasn't opted to retry
-                ui.error "Failed to authenticate to #{s.host} as #{locate_config_value(:winrm_user)}"
+                ui.error "Failed to authenticate to #{s.host} as #{config[:winrm_user]}"
                 ui.info "Response: #{e.message}"
                 ui.info get_failed_authentication_hint
                 raise e
@@ -202,33 +201,35 @@ class Chef
           end
 
           def resolve_session_options
+            config[:winrm_port] ||= ( config[:winrm_transport] == "ssl" ) ? "5986" : "5985"
+
             @session_opts = {
               user: resolve_winrm_user,
-              password: locate_config_value(:winrm_password),
-              port: locate_config_value(:winrm_port),
+              password: config[:winrm_password],
+              port: config[:winrm_port],
               operation_timeout: resolve_winrm_session_timeout,
               basic_auth_only: resolve_winrm_basic_auth,
               disable_sspi: resolve_winrm_disable_sspi,
               transport: resolve_winrm_transport,
               no_ssl_peer_verification: resolve_no_ssl_peer_verification,
               ssl_peer_fingerprint: resolve_ssl_peer_fingerprint,
-              shell: locate_config_value(:winrm_shell),
-              codepage: locate_config_value(:winrm_codepage),
+              shell: config[:winrm_shell],
+              codepage: config[:winrm_codepage],
             }
 
             if @session_opts[:user] && (not @session_opts[:password])
-              @session_opts[:password] = Chef::Config[:knife][:winrm_password] = config[:winrm_password] = get_password
+              @session_opts[:password] = config[:winrm_password] = get_password
             end
 
             if @session_opts[:transport] == :kerberos
               @session_opts.merge!(resolve_winrm_kerberos_options)
             end
 
-            @session_opts[:ca_trust_path] = locate_config_value(:ca_trust_file) if locate_config_value(:ca_trust_file)
+            @session_opts[:ca_trust_path] = config[:ca_trust_file] if config[:ca_trust_file]
           end
 
           def resolve_winrm_user
-            user = locate_config_value(:winrm_user)
+            user = config[:winrm_user]
 
             # Prefixing with '.\' when using negotiate
             # to auth user against local machine domain
@@ -244,23 +245,23 @@ class Chef
 
           def resolve_winrm_session_timeout
             # 30 min (Default) OperationTimeout for long bootstraps fix for KNIFE_WINDOWS-8
-            locate_config_value(:session_timeout).to_i * 60 if locate_config_value(:session_timeout)
+            config[:session_timeout].to_i * 60 if config[:session_timeout]
           end
 
           def resolve_winrm_basic_auth
-            locate_config_value(:winrm_authentication_protocol) == "basic"
+            config[:winrm_authentication_protocol] == "basic"
           end
 
           def resolve_winrm_kerberos_options
             kerberos_opts = {}
-            kerberos_opts[:keytab] = locate_config_value(:kerberos_keytab_file) if locate_config_value(:kerberos_keytab_file)
-            kerberos_opts[:realm] = locate_config_value(:kerberos_realm) if locate_config_value(:kerberos_realm)
-            kerberos_opts[:service] = locate_config_value(:kerberos_service) if locate_config_value(:kerberos_service)
+            kerberos_opts[:keytab] = config[:kerberos_keytab_file] if config[:kerberos_keytab_file]
+            kerberos_opts[:realm] = config[:kerberos_realm] if config[:kerberos_realm]
+            kerberos_opts[:service] = config[:kerberos_service] if config[:kerberos_service]
             kerberos_opts
           end
 
           def resolve_winrm_transport
-            transport = locate_config_value(:winrm_transport).to_sym
+            transport = config[:winrm_transport].to_sym
             if config.any? { |k, v| k.to_s =~ /kerberos/ && !v.nil? }
               transport = :kerberos
             elsif transport != :ssl && negotiate_auth?
@@ -271,11 +272,11 @@ class Chef
           end
 
           def resolve_no_ssl_peer_verification
-            locate_config_value(:ca_trust_file).nil? && config[:winrm_ssl_verify_mode] == :verify_none && resolve_winrm_transport == :ssl
+            config[:ca_trust_file].nil? && config[:winrm_ssl_verify_mode] == :verify_none && resolve_winrm_transport == :ssl
           end
 
           def resolve_ssl_peer_fingerprint
-            locate_config_value(:ssl_peer_fingerprint)
+            config[:ssl_peer_fingerprint]
           end
 
           def resolve_winrm_disable_sspi
@@ -287,7 +288,7 @@ class Chef
           end
 
           def negotiate_auth?
-            locate_config_value(:winrm_authentication_protocol) == "negotiate"
+            config[:winrm_authentication_protocol] == "negotiate"
           end
 
           def warn_no_ssl_peer_verification

data/lib/chef/knife/windows_cert_generate.rb

@@ -27,8 +27,8 @@ class Chef
       banner "knife windows cert generate FILE_PATH (options)"
 
       deps do
-        require "openssl"
-        require "socket"
+        require "openssl" unless defined?(OpenSSL)
+        require "socket" unless defined?(Socket)
       end
 
       option :hostname,
@@ -98,7 +98,7 @@ class Chef
         cert.add_extension(ef.create_extension("subjectKeyIdentifier", "hash", false))
         cert.add_extension(ef.create_extension("authorityKeyIdentifier", "keyid:always", false))
         cert.add_extension(ef.create_extension("extendedKeyUsage", "1.3.6.1.5.5.7.3.1", false))
-        cert.sign(rsa_key, OpenSSL::Digest::SHA1.new)
+        cert.sign(rsa_key, OpenSSL::Digest.new("SHA1"))
         @thumbprint = OpenSSL::Digest::SHA1.new(cert.to_der)
         cert
       end

data/lib/chef/knife/windows_listener_create.rb

@@ -22,7 +22,7 @@ class Chef
   class Knife
     class WindowsListenerCreate < Knife
       deps do
-        require "openssl"
+        require "openssl" unless defined?(OpenSSL)
       end
 
       banner "knife windows listener create (options)"

data/lib/chef/knife/winrm.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright (c) 2011-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,14 +18,12 @@
 
 require "chef/knife"
 require_relative "helpers/winrm_knife_base" # WinrmCommandSharedFunctions
-require_relative "helpers/knife_windows_base"
 
 class Chef
   class Knife
     class Winrm < Knife
 
       include Chef::Knife::WinrmCommandSharedFunctions
-      include Chef::Knife::KnifeWindowsBase
 
       deps do
         require_relative "windows_cert_generate"

data/lib/knife-windows/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Windows
-    VERSION = "3.0.16".freeze
+    VERSION = "4.0.5".freeze
     MAJOR, MINOR, TINY = VERSION.split(".")
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 
 # Author:: Adam Edwards (<adamed@chef.io>)
-# Copyright:: Copyright (c) 2012-2020 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,7 +22,22 @@ def sample_data(file_name)
   File.read(file)
 end
 
+class UnexpectedSystemExit < RuntimeError
+  def self.from(system_exit)
+    new(system_exit.message).tap { |e| e.set_backtrace(system_exit.backtrace) }
+  end
+end
+
 RSpec.configure do |config|
+  config.raise_on_warning = true
+  config.raise_errors_for_deprecations!
   config.run_all_when_everything_filtered = true
   config.filter_run focus: true
+  config.around(:example) do |ex|
+    begin
+      ex.run
+    rescue SystemExit => e
+      raise UnexpectedSystemExit.from(e)
+    end
+  end
 end

data/spec/unit/knife/winrm_spec.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Bryan McLellan <btm@chef.io>
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -250,7 +250,7 @@ describe Chef::Knife::Winrm do
         end
 
         it "sets the user specified winrm port" do
-          Chef::Config[:knife] = { winrm_port: "5988" }
+          winrm_command_http.config[:knife] = { winrm_port: "5988" }
           expect(Chef::Knife::WinrmSession).to receive(:new).with(hash_including(transport: :plaintext)).and_call_original
           expect(WinRM::Connection).to receive(:new).with(hash_including(transport: :plaintext)).and_return(winrm_connection)
           winrm_command_http.configure_chef
@@ -269,7 +269,7 @@ describe Chef::Knife::Winrm do
         let(:winrm_command_https) { Chef::Knife::Winrm.new(["-m", "localhost", "-x", "testuser", "-P", "testpassword", "--winrm-transport", "ssl", "echo helloworld"]) }
 
         it "uses the https uri scheme if the ssl transport is specified" do
-          Chef::Config[:knife] = { winrm_transport: "ssl" }
+          winrm_command_http.config[:winrm_transport] = "ssl"
           expect(Chef::Knife::WinrmSession).to receive(:new).with(hash_including(transport: :ssl)).and_call_original
           expect(WinRM::Connection).to receive(:new).with(hash_including(endpoint: "https://localhost:5986/wsman")).and_return(winrm_connection)
           winrm_command_https.configure_chef
@@ -277,7 +277,7 @@ describe Chef::Knife::Winrm do
         end
 
         it "uses the winrm port '5986' by default for ssl transport" do
-          Chef::Config[:knife] = { winrm_transport: "ssl" }
+          winrm_command_http.config[:winrm_transport] = "ssl"
           expect(Chef::Knife::WinrmSession).to receive(:new).with(hash_including(transport: :ssl)).and_call_original
           expect(WinRM::Connection).to receive(:new).with(hash_including(endpoint: "https://localhost:5986/wsman")).and_return(winrm_connection)
           winrm_command_https.configure_chef
@@ -361,8 +361,8 @@ describe Chef::Knife::Winrm do
 
     before(:each) do
       allow(Chef::Knife::WinrmSession).to receive(:new).and_return(session)
-      Chef::Config[:knife] = { winrm_transport: "plaintext" }
       @winrm = Chef::Knife::Winrm.new(["-m", "localhost", "-x", "testuser", "-P", "testpassword", "--winrm-authentication-protocol", "basic", "echo helloworld"])
+      @winrm.config[:winrm_transport] = "plaintext"
     end
 
     it "returns with 0 if the command succeeds" do
@@ -375,7 +375,6 @@ describe Chef::Knife::Winrm do
       command_status = 510
 
       @winrm.config[:returns] = "0"
-      Chef::Config[:knife][:returns] = [0]
 
       allow(@winrm).to receive(:relay_winrm_command)
       allow(@winrm.ui).to receive(:error)
@@ -386,7 +385,6 @@ describe Chef::Knife::Winrm do
     it "exits with non-zero status if the command fails and returns config is set to 0" do
       command_status = 1
       @winrm.config[:returns] = "0,53"
-      Chef::Config[:knife][:returns] = [0, 53]
       allow(@winrm).to receive(:relay_winrm_command).and_return(command_status)
       allow(@winrm.ui).to receive(:error)
       allow(session).to receive(:exit_code).and_return(command_status)
@@ -395,7 +393,7 @@ describe Chef::Knife::Winrm do
 
     it "exits with a zero status if the command returns an expected non-zero status" do
       command_status = 53
-      Chef::Config[:knife][:returns] = [0, 53]
+      @winrm.config[:returns] = "0,53"
       allow(@winrm).to receive(:relay_winrm_command).and_return(command_status)
       allow(session).to receive(:exit_codes).and_return({ "thishost" => command_status })
       exit_code = @winrm.run
@@ -448,7 +446,7 @@ describe Chef::Knife::Winrm do
 
     context "when winrm_authentication_protocol specified" do
       before do
-        Chef::Config[:knife] = { winrm_transport: "plaintext" }
+        @winrm.config[:winrm_transport] = "plaintext"
         allow(@winrm).to receive(:relay_winrm_command).and_return(0)
       end