knife 17.0.244 → 17.2.15

data/spec/knife_spec_helper.rb

@@ -0,0 +1,241 @@
+#
+# 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.
+
+# If you need to add anything in here, don't.
+# Add it to one of the files in spec/support
+
+# Abuse ruby's constant lookup to avoid undefined constant errors
+
+$LOAD_PATH.unshift File.expand_path("..", __dir__)
+$LOAD_PATH.unshift File.expand_path("../../chef-config/lib", __dir__)
+$LOAD_PATH.unshift File.expand_path("../../chef-utils/lib", __dir__)
+
+require "rubygems"
+require "rspec/mocks"
+require "rexml/document"
+require "webmock/rspec"
+
+require "chef/knife"
+
+# cwd is knife/
+Dir["lib/chef/knife/**/*.rb"]
+  .map { |f| f.gsub("lib/", "") }
+  .map { |f| f.gsub(/\.rb$/, "") }
+  .each { |f| require f }
+
+require "chef/resource_resolver"
+require "chef/provider_resolver"
+
+require "chef/mixins"
+require "chef/dsl"
+
+require "chef/shell"
+require "chef/util/file_edit"
+
+require "chef/config"
+
+require "chef/chef_fs/file_system_cache"
+
+require "chef/api_client_v1"
+
+require "chef/mixin/versioned_api"
+require "chef/server_api_versions"
+
+if ENV["CHEF_FIPS"] == "1"
+  Chef::Config.init_openssl
+end
+
+# If you want to load anything into the testing environment
+# without versioning it, add it to spec/support/local_gems.rb
+require "spec/support/local_gems" if File.exist?(File.join(File.dirname(__FILE__), "support", "local_gems.rb"))
+
+# Explicitly require spec helpers that need to load first
+require "spec/support/platform_helpers"
+require "spec/support/shared/unit/mock_shellout"
+require "spec/support/recipe_dsl_helper"
+require "spec/support/key_helpers"
+require "spec/support/shared/unit/knife_shared"
+require "spec/support/shared/functional/knife"
+require "spec/support/shared/integration/knife_support"
+require "spec/support/shared/matchers/exit_with_code"
+require "spec/support/shared/matchers/match_environment_variable"
+
+# Autoloads support files
+# Excludes support/platforms by default
+# Do not change the gsub.
+Dir["spec/support/**/*.rb"]
+  .reject { |f| f =~ %r{^spec/support/platforms} }
+  .reject { |f| f =~ %r{^spec/support/pedant} }
+  .map { |f| f.gsub(/.rb$/, "") }
+  .map { |f| f.gsub(%r{spec/}, "") }
+  .each { |f| require f }
+
+OHAI_SYSTEM = Ohai::System.new
+OHAI_SYSTEM.all_plugins(["platform", "hostname", "languages/powershell", "uptime"])
+
+test_node = Chef::Node.new
+test_node.automatic["os"] = (OHAI_SYSTEM["os"] || "unknown_os").dup.freeze
+test_node.automatic["platform_family"] = (OHAI_SYSTEM["platform_family"] || "unknown_platform_family").dup.freeze
+test_node.automatic["platform"] = (OHAI_SYSTEM["platform"] || "unknown_platform").dup.freeze
+test_node.automatic["platform_version"] = (OHAI_SYSTEM["platform_version"] || "unknown_platform_version").dup.freeze
+TEST_NODE = test_node.freeze
+TEST_OS = TEST_NODE["os"]
+TEST_PLATFORM = TEST_NODE["platform"]
+TEST_PLATFORM_VERSION = TEST_NODE["platform_version"]
+TEST_PLATFORM_FAMILY = TEST_NODE["platform_family"]
+
+provider_priority_map ||= nil
+resource_priority_map ||= nil
+provider_handler_map ||= nil
+resource_handler_map ||= nil
+
+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.include(RSpec::Matchers)
+  config.include(MockShellout::RSpec)
+  config.filter_run focus: true
+  config.filter_run_excluding external: true
+  config.raise_on_warning = true
+
+  # Explicitly disable :should syntax
+  # And set max_formatted_output_length to nil to prevent RSpec from doing truncation.
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+    c.max_formatted_output_length = nil
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+    c.allow_message_expectations_on_nil = false
+  end
+
+  # TODO - which if any of these filters apply to knife tests?
+  #
+  # Only run these tests on platforms that are also chef workstations
+  config.filter_run_excluding :workstation if solaris? || aix?
+
+  # Tests that randomly fail, but may have value.
+  config.filter_run_excluding volatile: true
+  config.filter_run_excluding volatile_on_solaris: true if solaris?
+  config.filter_run_excluding volatile_from_verify: false
+
+  config.filter_run_excluding skip_buildkite: true if ENV["BUILDKITE"]
+
+  config.filter_run_excluding windows_only: true unless windows?
+  config.filter_run_excluding unix_only: true unless unix?
+
+  # check for particular binaries we need
+
+  running_platform_arch = `uname -m`.strip unless windows?
+
+  config.filter_run_excluding arch: lambda { |target_arch|
+    running_platform_arch != target_arch
+  }
+
+  config.run_all_when_everything_filtered = true
+
+  config.before(:each) do
+    # it'd be nice to run this with connections blocked or only to localhost, but we do make lots
+    # of real connections, so cannot.  we reset it to allow connections every time to avoid
+    # tests setting connections to be disabled and that state leaking into other tests.
+    WebMock.allow_net_connect!
+    Chef.reset!
+    Chef::ChefFS::FileSystemCache.instance.reset!
+    Chef::Config.reset
+    Chef::Log.setup!
+    Chef::ServerAPIVersions.instance.reset!
+    Chef::Config[:log_level] = :fatal
+    Chef::Log.level(Chef::Config[:log_level])
+
+    # By default, treat deprecation warnings as errors in tests.
+    # and set environment variable so the setting persists in child processes
+    Chef::Config.treat_deprecation_warnings_as_errors(true)
+    ENV["CHEF_TREAT_DEPRECATION_WARNINGS_AS_ERRORS"] = "1"
+  end
+
+  # This bit of jankiness guards against specs which accidentally drop privs when running as
+  # root -- which are nearly impossible to debug and so we bail out very hard if this
+  # condition ever happens.  If a spec stubs Process.[e]uid this can throw a false positive
+  # which the spec must work around by unmocking Process.[e]uid to and_call_original in its
+  # after block.
+  # Should not be a problem with knife which does not escalate local privs, but
+  # it seems wise to continue to guard against.
+  if Process.euid == 0 && Process.uid == 0
+    config.after(:each) do
+      if Process.uid != 0
+        RSpec.configure { |c| c.fail_fast = true }
+        raise "rspec was invoked as root, but the last test dropped real uid to #{Process.uid}"
+      end
+      if Process.euid != 0
+        RSpec.configure { |c| c.fail_fast = true }
+        raise "rspec was invoked as root, but the last test dropped effective uid to #{Process.euid}"
+      end
+    end
+  end
+
+  # raise if anyone commits any test to CI with :focus set on it
+  if ENV["CI"]
+    config.before(:example, :focus) do
+      raise "This example was committed with `:focus` and should not have been"
+    end
+  end
+
+  config.before(:suite) do
+    ARGV.clear
+  end
+
+  # Protect Rspec from accidental exit(0) causing rspec to terminate without error
+  config.around(:example) do |ex|
+    ex.run
+  rescue SystemExit => e
+    raise UnexpectedSystemExit.from(e)
+
+  end
+end
+
+require "webrick/utils"
+#    Webrick uses a centralized/synchronized timeout manager. It works by
+#    starting a thread to check for timeouts on an interval. The timeout
+#    checker thread cannot be stopped or canceled in any easy way, and it
+#    makes calls to Time.new, which fail when rspec is in the process of
+#    creating a method stub for that method. Since our tests don't rely on
+#    any timeout behavior enforced by webrick, disable the timeout manager
+#    via a monkey patch.
+#
+#    Hopefully this fails loudly if the webrick code should change. As of this
+#    writing, the relevant code is in webrick/utils, which can be located on
+#    your system with:
+#
+#    $ gem which webrick/utils
+module WEBrick
+  module Utils
+    class TimeoutHandler
+      def initialize; end
+
+      def register(*args); end
+
+      def cancel(*args); end
+    end
+  end
+end
+
+# Enough stuff needs json serialization that I'm just adding it here for equality asserts
+require "chef/json_compat"

data/spec/support/chef_helpers.rb

@@ -0,0 +1,79 @@
+# 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.
+#
+
+CHEF_SPEC_DATA = File.expand_path(__dir__ + "/../data/")
+CHEF_SPEC_ASSETS = File.expand_path(__dir__ + "/../functional/assets/")
+CHEF_SPEC_BACKUP_PATH = File.join(Dir.tmpdir, "test-backup-path")
+
+def sha256_checksum(path)
+  OpenSSL::Digest.hexdigest("SHA256", File.read(path))
+end
+
+# extracted from Ruby < 2.5 to return a unique temp file name without creating it
+def make_tmpname(prefix_suffix, n = nil)
+  case prefix_suffix
+  when String
+    prefix = prefix_suffix
+    suffix = ""
+  when Array
+    prefix = prefix_suffix[0]
+    suffix = prefix_suffix[1]
+  else
+    raise ArgumentError, "unexpected prefix_suffix: #{prefix_suffix.inspect}"
+  end
+  t = Time.now.strftime("%Y%m%d")
+  path = "#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}"
+  path << "-#{n}" if n
+  path << suffix
+end
+
+# This is a helper to canonicalize paths that we're using in the file
+# tests.
+def canonicalize_path(path)
+  windows? ? path.tr("/", "\\") : path
+end
+
+# Makes a temp directory with a canonical path on any platform.
+# Only really needed to work around an issue on Windows where
+# Ruby's temp library generates paths with short names.
+def make_canonical_temp_directory
+  temp_directory = Dir.mktmpdir
+  if windows?
+    # On Windows, temporary file / directory path names may have shortened
+    # subdirectory names due to reliance on the TMP and TEMP environment variables
+    # in some Windows APIs and duplicated logic in Ruby's temp file implementation.
+    # To work around this in the unit test context, we obtain the long (canonical)
+    # path name via a Windows system call so that this path name can be used
+    # in expectations that assume the ability to canonically name paths in comparisons.
+    # Note that this was not an issue prior to Ruby 2.2 -- with Ruby 2.2,
+    # some Chef code started to use long file names, while Ruby's temp file implementation
+    # continued to return the shortened names -- this would cause these particular tests to
+    # fail if the username happened to be longer than 8 characters.
+    Chef::ReservedNames::Win32::File.get_long_path_name(temp_directory)
+  else
+    temp_directory
+  end
+end
+
+# Check if a cmd exists on the PATH
+def which(cmd)
+  paths = ENV["PATH"].split(File::PATH_SEPARATOR) + [ "/bin", "/usr/bin", "/sbin", "/usr/sbin" ]
+  paths.each do |path|
+    filename = File.join(path, cmd)
+    return filename if File.executable?(filename)
+  end
+  false
+end

data/spec/support/key_helpers.rb

@@ -0,0 +1,102 @@
+#
+# Author:: Tyler Cloke (<tyler@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.
+#
+
+shared_examples_for "a knife key command" do
+  let(:stderr) { StringIO.new }
+  let(:command) do
+    c = described_class.new([])
+    c.ui.config[:disable_editing] = true
+    allow(c.ui).to receive(:stderr).and_return(stderr)
+    allow(c.ui).to receive(:stdout).and_return(stderr)
+    allow(c).to receive(:show_usage)
+    c
+  end
+
+  context "before apply_params! is called" do
+    context "when apply_params! is called with invalid args (missing actor)" do
+      let(:params) { [] }
+      it "shows the usage" do
+        expect(command).to receive(:show_usage)
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+      end
+
+      it "outputs the proper error" do
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+        expect(stderr.string).to include(command.actor_missing_error)
+      end
+
+      it "exits 1" do
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+      end
+    end
+  end # before apply_params! is called
+
+  context "after apply_params! is called with valid args" do
+    before do
+      command.apply_params!(params)
+    end
+
+    it "properly defines the actor" do
+      expect(command.actor).to eq("charmander")
+    end
+  end # after apply_params! is called with valid args
+
+  context "when the command is run" do
+    before do
+      allow(command).to receive(:service_object).and_return(service_object)
+      allow(command).to receive(:name_args).and_return(["charmander"])
+    end
+
+    context "when the command is successful" do
+      before do
+        expect(service_object).to receive(:run)
+      end
+    end
+  end
+end # a knife key command
+
+shared_examples_for "a knife key command with a keyname as the second arg" do
+  let(:stderr) { StringIO.new }
+  let(:command) do
+    c = described_class.new([])
+    c.ui.config[:disable_editing] = true
+    allow(c.ui).to receive(:stderr).and_return(stderr)
+    allow(c.ui).to receive(:stdout).and_return(stderr)
+    allow(c).to receive(:show_usage)
+    c
+  end
+
+  context "before apply_params! is called" do
+    context "when apply_params! is called with invalid args (missing keyname)" do
+      let(:params) { ["charmander"] }
+      it "shows the usage" do
+        expect(command).to receive(:show_usage)
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+      end
+
+      it "outputs the proper error" do
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+        expect(stderr.string).to include(command.keyname_missing_error)
+      end
+
+      it "exits 1" do
+        expect { command.apply_params!(params) }.to exit_with_code(1)
+      end
+    end
+  end # before apply_params! is called
+end

data/spec/support/platform_helpers.rb

@@ -0,0 +1,251 @@
+require "fcntl"
+require "chef/mixin/shell_out"
+require "ohai/mixin/http_helper"
+require "ohai/mixin/gce_metadata"
+require "spec/support/chef_helpers"
+
+class ShellHelpers
+  extend Chef::Mixin::ShellOut
+end
+
+# magic stolen from bundler/spec/support/less_than_proc.rb
+class DependencyProc < Proc
+  attr_accessor :present
+
+  def self.with(present)
+    provided = Gem::Version.new(present.dup)
+    new do |required|
+      !Gem::Requirement.new(required).satisfied_by?(provided)
+    end.tap { |l| l.present = present }
+  end
+
+  def inspect
+    "\"#{present}\""
+  end
+end
+
+def ruby_64bit?
+  RbConfig::CONFIG["host_cpu"].include?("x86_64")
+end
+
+def ruby_32bit?
+  RbConfig::CONFIG["host_cpu"].include?("i686")
+end
+
+def windows?
+  # NOTE this deliberately does not use ChefUtils.windows? because otherwise it would
+  # pick up the node out of tests, while this tests the hosts running the specs.
+  !!(RUBY_PLATFORM =~ /mswin|mingw|windows/)
+end
+
+def ohai
+  # This is defined in spec_helper; it has the `platform` populated.
+  OHAI_SYSTEM
+end
+
+require "wmi-lite/wmi" if windows?
+
+def windows_domain_joined?
+  return false unless windows?
+
+  wmi = WmiLite::Wmi.new
+  computer_system = wmi.first_of("Win32_ComputerSystem")
+  computer_system["partofdomain"]
+end
+
+def windows_2012r2?
+  return false unless windows?
+
+  (win32_os_version && win32_os_version.start_with?("6.3"))
+end
+
+def windows_gte_10?
+  return false unless windows?
+
+  Gem::Requirement.new(">= 10").satisfied_by?(Gem::Version.new(win32_os_version))
+end
+
+def win32_os_version
+  @win32_os_version ||= begin
+    wmi = WmiLite::Wmi.new
+    host = wmi.first_of("Win32_OperatingSystem")
+    host["version"]
+  end
+end
+
+def windows_powershell_dsc?
+  return false unless windows?
+
+  supports_dsc = false
+  begin
+    wmi = WmiLite::Wmi.new("root/microsoft/windows/desiredstateconfiguration")
+    lcm = wmi.query("SELECT * FROM meta_class WHERE __this ISA 'MSFT_DSCLocalConfigurationManager'")
+    supports_dsc = !! lcm
+  rescue WmiLite::WmiException
+  end
+  supports_dsc
+end
+
+def windows_user_right?(right)
+  return false unless windows?
+
+  require "chef/win32/security"
+  Chef::ReservedNames::Win32::Security.get_account_right(ENV["USERNAME"]).include?(right)
+end
+
+# detects if the hardware is 64-bit (evaluates to true in "WOW64" mode in a 32-bit app on a 64-bit system)
+def windows64?
+  windows? && ( ENV["PROCESSOR_ARCHITECTURE"] == "AMD64" || ENV["PROCESSOR_ARCHITEW6432"] == "AMD64" )
+end
+
+# detects if the hardware is 32-bit
+def windows32?
+  windows? && !windows64?
+end
+
+def unix?
+  !windows?
+end
+
+def linux?
+  RUBY_PLATFORM.include?("linux")
+end
+
+def macos?
+  RUBY_PLATFORM.include?("darwin")
+end
+
+def macos_gte_11?
+  macos? && !!(ohai[:platform_version].to_i >= 11)
+end
+
+def solaris?
+  RUBY_PLATFORM.include?("solaris")
+end
+
+def freebsd?
+  RUBY_PLATFORM.include?("freebsd")
+end
+
+def intel_64bit?
+  !!(ohai[:kernel][:machine] == "x86_64")
+end
+
+def rhel?
+  !!(ohai[:platform_family] == "rhel")
+end
+
+def rhel6?
+  rhel? && !!(ohai[:platform_version].to_i == 6)
+end
+
+def opensuse?
+  suse? && !!(ohai[:platform_version].to_i >= 15)
+end
+
+def rhel7?
+  rhel? && !!(ohai[:platform_version].to_i == 7)
+end
+
+def rhel8?
+  rhel? && !!(ohai[:platform_version].to_i == 8)
+end
+
+def rhel_gte_8?
+  rhel? && !!(ohai[:platform_version].to_i >= 8)
+end
+
+def debian_family?
+  !!(ohai[:platform_family] == "debian")
+end
+
+def aix?
+  RUBY_PLATFORM.include?("aix")
+end
+
+def wpar?
+  !((ohai[:virtualization] || {})[:wpar_no].nil?)
+end
+
+def supports_cloexec?
+  Fcntl.const_defined?("F_SETFD") && Fcntl.const_defined?("FD_CLOEXEC")
+end
+
+def selinux_enabled?
+  # This code is currently copied from lib/chef/util/selinux to make
+  # specs independent of product.
+  selinuxenabled_path = which("selinuxenabled")
+  if selinuxenabled_path
+    cmd = Mixlib::ShellOut.new(selinuxenabled_path, returns: [0, 1])
+    cmd_result = cmd.run_command
+    case cmd_result.exitstatus
+    when 1
+      false
+    when 0
+      true
+    else
+      raise "Unknown exit code from command #{selinuxenabled_path}: #{cmd.exitstatus}"
+    end
+  else
+    # We assume selinux is not enabled if selinux utils are not
+    # installed.
+    false
+  end
+end
+
+def suse?
+  !!(ohai[:platform_family] == "suse")
+end
+
+def root?
+  return false if windows?
+
+  Process.euid == 0
+end
+
+def openssl_gte_101?
+  OpenSSL::OPENSSL_VERSION_NUMBER >= 10001000
+end
+
+def openssl_lt_101?
+  !openssl_gte_101?
+end
+
+def aes_256_gcm?
+  OpenSSL::Cipher.ciphers.include?("aes-256-gcm")
+end
+
+def fips?
+  ENV["CHEF_FIPS"] == "1"
+end
+
+class HttpHelper
+  extend Ohai::Mixin::HttpHelper
+  def self.logger
+    Chef::Log
+  end
+end
+
+def gce?
+  HttpHelper.can_socket_connect?(Ohai::Mixin::GCEMetadata::GCE_METADATA_ADDR, 80)
+rescue SocketError
+  false
+end
+
+def ifconfig?
+  which("ifconfig")
+end
+
+def choco_installed?
+  result = ShellHelpers.shell_out("choco --version")
+  result.stderr.empty?
+rescue
+  false
+end
+
+def pwsh_installed?
+  result = ShellHelpers.shell_out("pwsh.exe --version")
+  result.stderr.empty?
+rescue
+  false
+end