chef 18.7.10 → 18.8.46

data/spec/support/matchers/leak.rb

@@ -1,96 +0,0 @@
-#
-# Author:: Seth Chisamore (<schisamo@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.
-#
-
-module Matchers
-  module LeakBase
-    include RSpec::Matchers
-
-    def initialize(opts = {})
-      @warmup = opts[:warmup] || 5
-      @iterations = opts[:iterations] || 100
-      @variance = opts[:variance] || 5000
-    end
-
-    def failure_message
-      "expected final measure [#{@final_measure}] to be greater than or within +/- #{@variance} delta of initial measure [#{@initial_measure}]"
-    end
-
-    def failure_message_when_negated
-      "expected final measure [#{@final_measure}] to be less than or within +/- #{@variance} delta of initial measure [#{@initial_measure}]"
-    end
-
-    private
-
-    def match(measure, given_proc)
-      profiler.start
-
-      @initial_measure = 0
-      @final_measure = 0
-
-      @warmup.times do
-        given_proc.call
-      end
-
-      @initial_measure = profiler.send(measure)
-
-      @iterations.times do
-        given_proc.call
-      end
-
-      profiler.stop
-
-      @final_measure = profiler.send(measure)
-      @final_measure > (@initial_measure + @variance)
-    end
-
-    def profiler
-      @profiler ||= if ChefUtils.windows?
-                      require File.join(__dir__, "..", "platforms", "prof", "win32")
-                      RSpec::Prof::Win32::Profiler.new
-                    else
-                      require File.join(__dir__, "..", "prof", "gc")
-                      RSpec::Prof::GC::Profiler.new
-                    end
-    end
-
-  end
-
-  class LeakMemory
-    include LeakBase
-
-    def matches?(given_proc)
-      match(:working_set_size, given_proc)
-    end
-  end
-
-  class LeakHandles
-    include LeakBase
-
-    def matches?(given_proc)
-      match(:handle_count, given_proc)
-    end
-  end
-
-  def leak_memory(opts, &block)
-    Matchers::LeakMemory.new(opts, &block)
-  end
-
-  def leak_handles(opts, &block)
-    Matchers::LeakHandles.new(opts, &block)
-  end
-end

data/spec/support/mock/platform.rb

@@ -1,33 +0,0 @@
-# makes Chef think it's running on a certain platform..useful for unit testing
-# platform-specific functionality.
-#
-# If a block is given yields to the block with +RUBY_PLATFORM+ set to
-# 'i386-mingw32' (windows) or 'x86_64-darwin11.2.0' (unix).  Useful for
-# testing code that mixes in platform specific modules like +Chef::Mixin::Securable+
-# or +Chef::FileAccessControl+
-RSpec.configure do |c|
-  c.include(Module.new do
-    def platform_mock(platform = :unix)
-      case platform
-      when :windows
-        Chef::Config.set_defaults_for_windows
-        allow(ChefUtils).to receive(:windows?).and_return(true)
-        stub_const("ENV", ENV.to_hash.merge("SYSTEMDRIVE" => "C:"))
-        stub_const("RUBY_PLATFORM", "i386-mingw32")
-        stub_const("File::PATH_SEPARATOR", ";")
-        stub_const("File::ALT_SEPARATOR", "\\")
-      when :unix
-        Chef::Config.set_defaults_for_nix
-        allow(ChefUtils).to receive(:windows?).and_return(false)
-        stub_const("ENV", ENV.to_hash.merge("SYSTEMDRIVE" => nil))
-        stub_const("RUBY_PLATFORM", "x86_64-darwin11.2.0")
-        stub_const("File::PATH_SEPARATOR", ":")
-        stub_const("File::ALT_SEPARATOR", nil)
-      else
-        raise "#{__method__}: unrecognized platform '#{platform}', expected one of ':unix' or ':windows'"
-      end
-
-      yield
-    end
-  end)
-end

data/spec/support/platform_helpers.rb

@@ -1,284 +0,0 @@
-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 windows_11?
-  return false unless windows?
-
-  Gem::Requirement.new(">= 10.0.22621").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 freebsd_gte_12_3?
-  RUBY_PLATFORM.include?("freebsd") && !!(ohai[:platform_version].to_f >= 12.3)
-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 amazon_linux?
-  ohai[:platform_family] == "amazon"
-end
-
-def wpar?
-  !((ohai[:virtualization] || {})[:wpar_no].nil?)
-end
-
-def s390x?
-  RUBY_PLATFORM.include?("s390x")
-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_mode_build?
-  return false if ENV.fetch("BUILDKITE_PIPELINE_SLUG", "") =~ /verify$/
-
-  if ENV.include?("BUILDKITE_LABEL") # try keying directly off Buildkite environments
-    # regex version of chef/chef-foundation:.expeditor/release.omnibus.yml:fips-platforms
-    [/el-.*-x86_64/, /el-.*-ppc64/, /el-.*aarch/, /ubuntu-/, /windows-/, /amazon-2/].any? do |os_arch|
-      ENV["BUILDKITE_LABEL"].match?(os_arch)
-    end
-  else
-    # if you're testing your local build
-    OpenSSL::OPENSSL_FIPS
-  end
-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

data/spec/support/platforms/prof/gc.rb

@@ -1,51 +0,0 @@
-#
-# Author:: Seth Chisamore (<schisamo@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.
-#
-
-module RSpec
-  module Prof
-    module GC
-      class Profiler
-
-        # GC 1 invokes.
-        # Index    Invoke Time(sec)       Use Size(byte)     Total Size(byte)         Total Object                    GC time(ms)
-        #     1               0.012               159240               212940                10647         0.00000000000001530000
-        LINE_PATTERN = /^\s+([\d\.]*)\s+([\d\.]*)\s+([\d\.]*)\s+([\d\.]*)\s+([\d\.]*)\s+([\d\.]*)$/.freeze
-
-        def start
-          ::GC::Profiler.enable unless ::GC::Profiler.enabled?
-        end
-
-        def stop
-          ::GC::Profiler.disable
-        end
-
-        def working_set_size
-          ::GC.start
-          ::GC::Profiler.result.scan(LINE_PATTERN)[-1][2].to_i if ::GC::Profiler.enabled?
-        ensure
-          ::GC::Profiler.clear
-        end
-
-        def handle_count
-          0
-        end
-
-      end
-    end
-  end
-end

data/spec/support/platforms/prof/win32.rb

@@ -1,45 +0,0 @@
-#
-# Author:: Seth Chisamore (<schisamo@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/win32/process"
-
-module RSpec
-  module Prof
-    module Win32
-      class Profiler
-
-        def start
-          GC.start
-        end
-
-        def stop
-          GC.start
-        end
-
-        def working_set_size
-          Chef::ReservedNames::Win32::Process.get_current_process.memory_info[:WorkingSetSize]
-        end
-
-        def handle_count
-          Chef::ReservedNames::Win32::Process.get_current_process.handle_count
-        end
-      end
-
-    end
-  end
-end

data/spec/support/platforms/win32/spec_service.rb

@@ -1,57 +0,0 @@
-#
-# Author:: Serdar Sutay (<serdar@lambda.local>)
-# 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 RUBY_PLATFORM.match?(/mswin|mingw|windows/)
-  require "win32/daemon"
-
-  class SpecService < ::Win32::Daemon
-    def service_init
-      @test_service_file = "#{ENV["TMP"]}/spec_service_file"
-    end
-
-    def service_main(*startup_parameters)
-      while running?
-        unless File.exist?(@test_service_file)
-          File.open(@test_service_file, "wb") do |f|
-            f.write("This file is created by SpecService")
-          end
-        end
-
-        sleep 1
-      end
-    end
-
-    ################################################################################
-    # Control Signal Callback Methods
-    ################################################################################
-
-    def service_stop; end
-
-    def service_pause; end
-
-    def service_resume; end
-
-    def service_shutdown; end
-  end
-
-  # To run this file as a service, it must be called as a script from within
-  # the Windows Service framework.  In that case, kick off the main loop!
-  if __FILE__ == $0
-    SpecService.mainloop
-  end
-end

data/spec/support/recipe_dsl_helper.rb

@@ -1,83 +0,0 @@
-#
-# This is a helper for functional tests to embed the recipe DSL directly into the rspec example blocks using
-# unified mode.
-#
-# If you wind up wanting to stub/expect on internal details of the resource/provider you are not testing the
-# public API and are trying to write a unit test, which this is not designed for.
-#
-# If you want to start writing full recipes and testing them, doing notifies/subscribes/etc then you are writing
-# an integration test, and not a functional single-resource test, which this is not designed for.
-#
-# Examples:
-#
-# it "creates a file" do
-#   FileUtils.rm_f("/tmp/foo.xyz")
-#   file "/tmp/foo.xyz" do           # please use proper tmpdir though
-#     content "whatever"
-#   end.should_be_updated
-#   expect(IO.read("/tmp/foo.xyz").to eql("content")
-# end
-#
-# it "is idempotent" do
-#   FileUtils.rm_f("/tmp/foo.xyz")
-#   file "/tmp/foo.xyz" do           # please use proper tmpdir though
-#     content "whatever"
-#   end.should_be_updated
-#   file "/tmp/foo.xyz" do           # please use proper tmpdir though
-#     content "whatever"
-#   end.should_not_be_updated
-#   expect(IO.read("/tmp/foo.xyz").to eql("content")
-# end
-#
-# it "has a failure" do
-#   FileUtils.rm_f("/tmp/foo.xyz")
-#   expect { file "/tmp/lksjdflksjdf/foo.xyz" do
-#     content "whatever"
-#   end }.to raise_error(Chef::Exception::EnclosingDirectoryDoesNotExist)
-# end
-#
-module RecipeDSLHelper
-  include Chef::DSL::Recipe
-  def event_dispatch
-    @event_dispatch ||= Chef::EventDispatch::Dispatcher.new
-  end
-
-  def node
-    @node ||= Chef::Node.new.tap do |n|
-      # clone the global ohai data to keep tests fast but reasonably isolated
-      n.consume_external_attrs(OHAI_SYSTEM.data.dup, {})
-    end
-  end
-
-  def run_context
-    @run_context ||= Chef::RunContext.new(node, {}, event_dispatch).tap do |rc|
-      rc.resource_collection.unified_mode = true
-      Chef::Runner.new(rc)
-    end
-  end
-
-  def cookbook_name
-    "rspec"
-  end
-
-  def recipe_name
-    "default"
-  end
-
-  def declare_resource(type, name, created_at: nil, run_context: self.run_context, &resource_attrs_block)
-    created_at = caller[0]
-    rspec_context = self
-    # we slightly abuse the "enclosing_provider" method_missing magic to send methods to the rspec example block so that
-    # rspec `let` methods work as arguments to resource properties
-    resource = super(type, name, created_at: created_at, run_context: run_context, enclosing_provider: rspec_context, &resource_attrs_block)
-    # we also inject these methods to make terse expression of checking the updated status (so it is more readiable and
-    # therefore should get used more -- even though it is "should" vs. "expect")
-    resource.define_singleton_method(:should_be_updated) do
-      rspec_context.expect(self).to be_updated
-    end
-    resource.define_singleton_method(:should_not_be_updated) do
-      rspec_context.expect(self).not_to be_updated
-    end
-    resource
-  end
-end

data/spec/support/ruby_installer.rb

@@ -1,51 +0,0 @@
-#
-# 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.
-
-def add_libarchive_dll_directory
-  require "ruby_installer"
-  libarchive_paths = Dir.glob("{#{Gem.dir},C:/hab}/**/libarchive.dll").map { |f| File.expand_path(f) }
-  if libarchive_paths.empty?
-    $stderr.puts <<~EOL
-      !!!!
-        We couldn't find a libarchive.dll in #{Gem.dir} or C:/hab
-
-        If this is running in a CI/CD environment, this may end up causing failures
-        in the tests for archive_file. If this is not running in a CI/CD
-        environment then it may be safe to ignore this. That is especially true if
-        you're not using the Ruby Installer as your Ruby runtime.
-      !!!!
-    EOL
-    return
-  end
-
-  $stderr.puts "\nFound the following libarchive paths:\n\n#{libarchive_paths.map { |f| "- #{f}\n" }.join}\n\n"
-  libarchive_path = libarchive_paths.first
-  libarchive_dir = File.dirname(libarchive_path)
-
-  if defined?(RubyInstaller::Build) && RubyInstaller::Build.methods.include?(:add_dll_directory)
-    $stderr.puts "Adding #{libarchive_dir} as a DLL load path using RubyInstaller::Build#add_dll_directory"
-    RubyInstaller::Build.add_dll_directory(libarchive_dir)
-  elsif defined?(RubyInstaller::Runtime) && RubyInstaller::Runtime.methods.include?(:add_dll_directory)
-    $stderr.puts "Adding #{libarchive_dir} as a DLL load path using RubyInstaller::Runtime#add_dll_directory"
-    RubyInstaller::Runtime.add_dll_directory(libarchive_dir)
-  else
-    $stderr.puts "Unable to find the right namespace to call #add_dll_directory! Please raise an issue on [GitHub](https://github.com/chef/chef/issues/new/choose)."
-  end
-rescue LoadError
-  $stderr.puts "Failed to load ruby_installer. Assuming Ruby Installer is not being used."
-end
-
-add_libarchive_dll_directory if RUBY_PLATFORM.match?(/mswin|mingw|windows/)