chef 16.6.14-universal-mingw32 → 16.7.61-universal-mingw32

data/lib/chef/resource/file.rb

@@ -56,7 +56,7 @@ class Chef
       allowed_actions :create, :delete, :touch, :create_if_missing
 
       property :path, String, name_property: true,
-        description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash (/) will point to the root of the current working directory of the #{ChefUtils::Dist::Infra::CLIENT} process. This path can vary from system to system. Therefore, using a path that begins with a forward slash (/) is not recommended."
+        description: "The full path to the file, including the file name and its extension. For example: /files/file.txt. Default value: the name of the resource block. Microsoft Windows: A path that begins with a forward slash `/` will point to the root of the current working directory of the #{ChefUtils::Dist::Infra::PRODUCT} process. This path can vary from system to system. Therefore, using a path that begins with a forward slash `/` is not recommended."
 
       property :atomic_update, [ TrueClass, FalseClass ], desired_state: false, default: lazy { docker? && special_docker_files?(path) ? false : Chef::Config[:file_atomic_update] },
         default_description: "False if modifying /etc/hosts, /etc/hostname, or /etc/resolv.conf within Docker containers. Otherwise default to the client.rb 'file_atomic_update' config value.",

data/lib/chef/resource/homebrew_update.rb

@@ -19,11 +19,14 @@
 #
 
 require_relative "../resource"
+require_relative "../mixin/homebrew_user"
 require "chef-utils/dist" unless defined?(ChefUtils::Dist)
 
 class Chef
   class Resource
     class HomebrewUpdate < Chef::Resource
+      include Chef::Mixin::HomebrewUser
+
       unified_mode true
 
       provides(:homebrew_update) { true }
@@ -79,7 +82,7 @@ class Chef
           execute "brew update" do
             command %w{brew update}
             default_env true
-            user Homebrew.owner
+            user find_homebrew_uid
             notifies :touch, "file[#{BREW_STAMP}]", :immediately
           end
         end

data/lib/chef/resource/hostname.rb

@@ -224,7 +224,7 @@ class Chef
         else # windows
           WINDOWS_EC2_CONFIG = 'C:\Program Files\Amazon\Ec2ConfigService\Settings\config.xml'.freeze
 
-          raise "Windows hostnames cannot contain a period." if new_resource.hostname.match?(/\./)
+          raise "Windows hostnames cannot contain a period." if new_resource.hostname.include?(".")
 
           # suppress EC2 config service from setting our hostname
           if ::File.exist?(WINDOWS_EC2_CONFIG)
@@ -240,7 +240,7 @@ class Chef
 
           unless Socket.gethostbyname(Socket.gethostname).first == new_resource.hostname
             converge_by "set hostname to #{new_resource.hostname}" do
-              powershell_out! <<~EOH
+              powershell_exec! <<~EOH
                 $sysInfo = Get-WmiObject -Class Win32_ComputerSystem
                 $sysInfo.Rename("#{new_resource.hostname}")
               EOH

data/lib/chef/resource/ifconfig.rb

@@ -21,16 +21,59 @@ require_relative "../resource"
 
 class Chef
   class Resource
-    # @example set a static ip on eth1
-    #   ifconfig '33.33.33.80' do
-    #     device 'eth1'
-    #   end
     class Ifconfig < Chef::Resource
       unified_mode true
 
       provides :ifconfig
 
-      description "Use the **ifconfig** resource to manage interfaces on Unix and Linux systems."
+      description "Use the **ifconfig** resource to manage interfaces on Unix and Linux systems. Note: This resource requires the ifconfig binary to be present on the system and may require additional packages to be installed first. On Ubuntu 18.04 or later you will need to install the `ifupdown` package, which disables the built in Netplan functionality. Warning: This resource will not work with Fedora release 33 or later."
+      examples <<~DOC
+      **Configure a network interface with a static IP**
+
+      ```ruby
+      ifconfig '33.33.33.80' do
+        device 'eth1'
+      end
+      ```
+
+      will create the following interface configuration:
+
+      ```
+      iface eth1 inet static
+        address 33.33.33.80
+      ```
+
+      **Configure an interface to use DHCP**
+
+      ```ruby
+      ifconfig 'Set eth1 to DHCP' do
+        device 'eth1'
+        bootproto 'dhcp'
+      end
+      ```
+
+      will create the following interface configuration:
+
+      ```
+      iface eth1 inet dhcp
+      ```
+
+      **Update a static IP address with a boot protocol**
+
+      ```ruby
+      ifconfig "33.33.33.80" do
+        bootproto "dhcp"
+        device "eth1"
+      end
+      ```
+
+      will update the interface configuration from static to dhcp:
+
+      ```
+      iface eth1 inet dhcp
+        address 33.33.33.80
+      ```
+      DOC
 
       state_attrs :inet_addr, :mask
 
@@ -102,6 +145,10 @@ class Chef
       property :gateway, String,
         introduced: "14.4",
         description: "The gateway to use for the interface."
+
+      property :bridge, String,
+        introduced: "16.7",
+        description: "The bridge interface this interface is a member of on Red Hat based systems."
     end
   end
 end

data/lib/chef/resource/ksh.rb

@@ -27,10 +27,10 @@ class Chef
 
       description "Use the **ksh** resource to execute scripts using the Korn shell (ksh)"\
                   " interpreter. This resource may also use any of the actions and properties"\
-                  " that are available to the execute resource. Commands that are executed"\
+                  " that are available to the **execute** resource. Commands that are executed"\
                   " with this resource are (by their nature) not idempotent, as they are"\
-                  " typically unique to the environment in which they are run. Use not_if"\
-                  " and only_if to guard this resource for idempotence."
+                  " typically unique to the environment in which they are run. Use `not_if`"\
+                  " and `only_if` to guard this resource for idempotence."
       introduced "12.6"
 
       def initialize(name, run_context = nil)

data/lib/chef/resource/lwrp_base.rb

@@ -63,17 +63,15 @@ class Chef
 
           Chef::Log.trace("Loaded contents of #{filename} into resource #{resource_name} (#{resource_class})")
 
-          LWRPBase.loaded_lwrps[filename] = true
-
           # wire up the default resource name after the class is parsed only if we haven't declared one.
           # (this ordering is important for MapCollision deprecation warnings)
           resource_class.provides resource_name.to_sym unless Chef::ResourceResolver.includes_handler?(resource_name.to_sym, self)
 
+          LWRPBase.loaded_lwrps[filename] = resource_class
+
           resource_class
         end
 
-        alias :attribute :property
-
         # Adds +action_names+ to the list of valid actions for this resource.
         # Does not include superclass's action list when appending.
         def actions(*action_names)
@@ -88,7 +86,7 @@ class Chef
 
         # @deprecated
         def valid_actions(*args)
-          Chef::Log.warn("`valid_actions' is deprecated, please use allowed_actions `instead'!")
+          Chef::Log.warn("`valid_actions` is deprecated, please use `allowed_actions` instead!")
           allowed_actions(*args)
         end
 

data/lib/chef/resource/mount.rb

@@ -41,6 +41,7 @@ class Chef
         sensitive: true
 
       property :mount_point, String, name_property: true,
+               coerce: proc { |arg| arg.chomp("/") }, # Removed "/" from the end of str, because it was causing idempotency issue.
                description: "The directory (or path) in which the device is to be mounted. Defaults to the name of the resource block if not provided."
 
       property :device, String, identity: true,
@@ -65,7 +66,7 @@ class Chef
 
       property :options, [Array, String, nil],
         description: "An array or comma separated list of options for the mount.",
-        coerce: proc { |arg| arg.is_a?(String) ? arg.split(",") : arg },
+        coerce: proc { |arg| mount_options(arg) }, # Please see #mount_options method.
         default: %w{defaults}
 
       property :dump, [Integer, FalseClass],
@@ -94,6 +95,11 @@ class Chef
         @fstype = nil
       end
 
+      # Returns array of string without leading and trailing whitespace.
+      def mount_options(options)
+        (options.is_a?(String) ? options.split(",") : options).collect(&:strip)
+      end
+
     end
   end
 end

data/lib/chef/resource/perl.rb

@@ -32,9 +32,9 @@ class Chef
 
       description "Use the **perl** resource to execute scripts using the Perl interpreter."\
                   " This resource may also use any of the actions and properties that are"\
-                  " available to the execute resource. Commands that are executed with this"\
+                  " available to the **execute** resource. Commands that are executed with this"\
                   " resource are (by their nature) not idempotent, as they are typically"\
-                  " unique to the environment in which they are run. Use not_if and only_if"\
+                  " unique to the environment in which they are run. Use `not_if` and `only_if`"\
                   " to guard this resource for idempotence."
     end
   end

data/lib/chef/resource/plist.rb

@@ -151,9 +151,7 @@ class Chef
           value.to_i
         when "float"
           value.to_f
-        when "string"
-          value
-        when "dictionary"
+        when "string", "dictionary"
           value
         when nil
           ""
@@ -168,9 +166,7 @@ class Chef
           "array"
         when Integer
           "integer"
-        when FalseClass
-          "bool"
-        when TrueClass
+        when FalseClass, TrueClass
           "bool"
         when Hash
           "dict"

data/lib/chef/resource/powershell_package_source.rb

@@ -16,7 +16,6 @@
 #
 
 require_relative "../resource"
-require_relative "../json_compat"
 
 class Chef
   class Resource
@@ -57,11 +56,11 @@ class Chef
 
       load_current_value do
         cmd = load_resource_state_script(source_name)
-        repo = powershell_out!(cmd)
-        if repo.stdout.empty?
+        repo = powershell_exec!(cmd)
+        if repo.result.empty?
           current_value_does_not_exist!
         else
-          status = Chef::JSONCompat.from_json(repo.stdout)
+          status = repo.result
         end
         url status["url"]
         trusted status["trusted"]
@@ -78,28 +77,28 @@ class Chef
           if package_source_exists?
             converge_if_changed :url, :trusted, :publish_location, :script_source_location, :script_publish_location do
               update_cmd = build_ps_repository_command("Set", new_resource)
-              res = powershell_out(update_cmd)
-              raise "Failed to update #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+              res = powershell_exec(update_cmd)
+              raise "Failed to update #{new_resource.source_name}: #{res.errors}" if res.error?
             end
           else
             converge_by("register source: #{new_resource.source_name}") do
               register_cmd = build_ps_repository_command("Register", new_resource)
-              res = powershell_out(register_cmd)
-              raise "Failed to register #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+              res = powershell_exec(register_cmd)
+              raise "Failed to register #{new_resource.source_name}: #{res.errors}" if res.error?
             end
           end
         else
           if package_source_exists?
             converge_if_changed :url, :trusted, :provider_name do
               update_cmd = build_package_source_command("Set", new_resource)
-              res = powershell_out(update_cmd)
-              raise "Failed to update #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+              res = powershell_exec(update_cmd)
+              raise "Failed to update #{new_resource.source_name}: #{res.errors}" if res.error?
             end
           else
             converge_by("register source: #{new_resource.source_name}") do
               register_cmd = build_package_source_command("Register", new_resource)
-              res = powershell_out(register_cmd)
-              raise "Failed to register #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+              res = powershell_exec(register_cmd)
+              raise "Failed to register #{new_resource.source_name}: #{res.errors}" if res.error?
             end
           end
         end
@@ -110,16 +109,16 @@ class Chef
         if package_source_exists?
           unregister_cmd = "Get-PackageSource -Name '#{new_resource.source_name}' | Unregister-PackageSource"
           converge_by("unregister source: #{new_resource.source_name}") do
-            res = powershell_out(unregister_cmd)
-            raise "Failed to unregister #{new_resource.source_name}: #{res.stderr}" unless res.stderr.empty?
+            res = powershell_exec(unregister_cmd)
+            raise "Failed to unregister #{new_resource.source_name}: #{res.errors}" if res.error?
           end
         end
       end
 
       action_class do
         def package_source_exists?
-          cmd = powershell_out!("(Get-PackageSource -Name '#{new_resource.source_name}' -WarningAction SilentlyContinue).Name")
-          cmd.stdout.downcase.strip == new_resource.source_name.downcase
+          cmd = powershell_exec!("(Get-PackageSource -Name '#{new_resource.source_name}' -ErrorAction SilentlyContinue).Name")
+          !cmd.result.empty? && cmd.result.to_s.downcase.strip == new_resource.source_name.downcase
         end
 
         def psrepository_cmdlet_appropriate?
@@ -133,6 +132,7 @@ class Chef
           cmd << " -PublishLocation '#{new_resource.publish_location}'" if new_resource.publish_location
           cmd << " -ScriptSourceLocation '#{new_resource.script_source_location}'" if new_resource.script_source_location
           cmd << " -ScriptPublishLocation '#{new_resource.script_publish_location}'" if new_resource.script_publish_location
+          cmd << " | Out-Null"
           cmd
         end
 
@@ -141,6 +141,7 @@ class Chef
           cmd << " -Location '#{new_resource.url}'" if new_resource.url
           cmd << " -Trusted:#{new_resource.trusted ? "$true" : "$false"}"
           cmd << " -ProviderName '#{new_resource.provider_name}'" if new_resource.provider_name
+          cmd << " | Out-Null"
           cmd
         end
       end
@@ -157,11 +158,11 @@ class Chef
             if ((Get-PackageSource -Name '#{name}').ProviderName -eq 'PowerShellGet') {
                 (Get-PSRepository -Name '#{name}') | Select @{n='source_name';e={$_.Name}}, @{n='url';e={$_.SourceLocation}},
                 @{n='trusted';e={$_.Trusted}}, @{n='provider_name';e={$_.PackageManagementProvider}}, @{n='publish_location';e={$_.PublishLocation}},
-                @{n='script_source_location';e={$_.ScriptSourceLocation}}, @{n='script_publish_location';e={$_.ScriptPublishLocation}} | ConvertTo-Json
+                @{n='script_source_location';e={$_.ScriptSourceLocation}}, @{n='script_publish_location';e={$_.ScriptPublishLocation}}
             }
             else {
                 (Get-PackageSource -Name '#{name}') | Select @{n='source_name';e={$_.Name}}, @{n='url';e={$_.Location}},
-                @{n='provider_name';e={$_.ProviderName}}, @{n='trusted';e={$_.IsTrusted}} | ConvertTo-Json
+                @{n='provider_name';e={$_.ProviderName}}, @{n='trusted';e={$_.IsTrusted}}
             }
         }
       EOH

data/lib/chef/resource/powershell_script.rb

@@ -26,6 +26,12 @@ class Chef
 
       provides :powershell_script, os: "windows"
 
+      description <<~DESC
+        Use the **powershell_script** resource to execute a script using the Windows PowerShell interpreter, much like how the script and script-based resources **bash**, **csh**, **perl**, **python**, and **ruby** are used. The **powershell_script** resource is specific to the Microsoft Windows platform, but may use both the the Windows PowerShell interpreter or the PowerShell Core (pwsh) interpreter as of Chef Infra Client 16.6 and later.
+
+        The **powershell_script** resource creates and executes a temporary file rather than running the command inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use `not_if` and `only_if` conditionals to guard this resource for idempotence.
+      DESC
+
       property :flags, String,
         description: "A string that is passed to the Windows PowerShell command"
 
@@ -58,15 +64,6 @@ class Chef
           ```
         DESC
 
-      description "Use the **powershell_script** resource to execute a script using the Windows PowerShell"\
-                  " interpreter, much like how the script and script-based resources—bash, csh, perl, python,"\
-                  " and ruby—are used. The powershell_script is specific to the Microsoft Windows platform"\
-                  " and the Windows PowerShell interpreter.\n\n The powershell_script resource creates and"\
-                  " executes a temporary file (similar to how the script resource behaves), rather than running"\
-                  " the command inline. Commands that are executed with this resource are (by their nature) not"\
-                  " idempotent, as they are typically unique to the environment in which they are run. Use not_if"\
-                  " and only_if to guard this resource for idempotence."
-
       def initialize(*args)
         super
         @default_guard_interpreter = resource_name
@@ -79,7 +76,7 @@ class Chef
       # default for this resource, this method can be removed since
       # guard context and recipe resource context will have the
       # same behavior.
-      def self.get_default_attributes(opts)
+      def self.get_default_attributes
         { convert_boolean_return: true }
       end
     end

data/lib/chef/resource/python.rb

@@ -31,9 +31,9 @@ class Chef
 
       description "Use the **python** resource to execute scripts using the Python interpreter."\
                   " This resource may also use any of the actions and properties that are available"\
-                  " to the execute resource. Commands that are executed with this resource are (by"\
+                  " to the **execute** resource. Commands that are executed with this resource are (by"\
                   " their nature) not idempotent, as they are typically unique to the environment in"\
-                  " which they are run. Use not_if and only_if to guard this resource for idempotence."
+                  " which they are run. Use `not_if` and `only_if` to guard this resource for idempotence."
     end
   end
 end

data/lib/chef/resource/registry_key.rb

@@ -27,7 +27,96 @@ class Chef
       provides(:registry_key) { true }
 
       description "Use the **registry_key** resource to create and delete registry keys in Microsoft Windows."
-      introduced "11.0"
+      examples <<~'DOC'
+      **Create a registry key**
+
+      ```ruby
+      registry_key 'HKEY_LOCAL_MACHINE\\path-to-key\\Policies\\System' do
+        values [{
+          name: 'EnableLUA',
+          type: :dword,
+          data: 0
+        }]
+        action :create
+      end
+      ```
+
+      **Create a registry key with binary data: "\x01\x02\x03"**:
+
+      ```ruby
+      registry_key 'HKEY_CURRENT_USER\ChefTest' do
+        values [{
+          :name => "test",
+          :type => :binary,
+          :data => [0, 1, 2].map(&:chr).join
+        }]
+        action :create
+      end
+      ```
+
+      **Create 32-bit key in redirected wow6432 tree**
+
+      In 64-bit versions of Microsoft Windows, HKEY_LOCAL_MACHINE\SOFTWARE\Example is a re-directed key. In the following examples, because HKEY_LOCAL_MACHINE\SOFTWARE\Example is a 32-bit key, the output will be “Found 32-bit key” if they are run on a version of Microsoft Windows that is 64-bit:
+
+      ```ruby
+      registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\Example' do
+        architecture :i386
+        recursive true
+        action :create
+      end
+      ```
+
+      **Set proxy settings to be the same as those used by Chef Infra Client**
+
+      ```ruby
+      proxy = URI.parse(Chef::Config[:http_proxy])
+      registry_key 'HKCU\Software\Microsoft\path\to\key\Internet Settings' do
+        values [{name: 'ProxyEnable', type: :reg_dword, data: 1},
+                {name: 'ProxyServer', data: "#{proxy.host}:#{proxy.port}"},
+                {name: 'ProxyOverride', type: :reg_string, data: <local>},
+               ]
+        action :create
+      end
+      ```
+
+      **Set the name of a registry key to "(Default)"**
+
+      ```ruby
+      registry_key 'Set (Default) value' do
+        key 'HKLM\Software\Test\Key\Path'
+        values [
+          {name: '', type: :string, data: 'test'},
+        ]
+        action :create
+      end
+      ```
+
+      **Delete a registry key value**
+
+      ```ruby
+      registry_key 'HKEY_LOCAL_MACHINE\SOFTWARE\path\to\key\AU' do
+        values [{
+          name: 'NoAutoRebootWithLoggedOnUsers',
+          type: :dword,
+          data: ''
+          }]
+        action :delete
+      end
+      ```
+
+      Note: If data: is not specified, you get an error: Missing data key in RegistryKey values hash
+
+      **Delete a registry key and its subkeys, recursively**
+
+      ```ruby
+      registry_key 'HKCU\SOFTWARE\Policies\path\to\key\Themes' do
+        recursive true
+        action :delete_key
+      end
+      ```
+
+      Note: Be careful when using the :delete_key action with the recursive attribute. This will delete the registry key, all of its values and all of the names, types, and data associated with them. This cannot be undone by Chef Infra Client.
+      DOC
 
       state_attrs :values
 
@@ -72,6 +161,8 @@ class Chef
 
       property :key, String, name_property: true
 
+      VALID_VALUE_HASH_KEYS = %i{name type data}.freeze
+
       def values(arg = nil)
         if not arg.nil?
           if arg.is_a?(Hash)
@@ -89,7 +180,7 @@ class Chef
             raise ArgumentError, "Missing name key in RegistryKey values hash" unless v.key?(:name)
 
             v.each_key do |key|
-              raise ArgumentError, "Bad key #{key} in RegistryKey values hash" unless %i{name type data}.include?(key)
+              raise ArgumentError, "Bad key #{key} in RegistryKey values hash" unless VALID_VALUE_HASH_KEYS.include?(key)
             end
             raise ArgumentError, "Type of name => #{v[:name]} should be string" unless v[:name].is_a?(String)