chef 18.10.17 → 19.1.164

data/lib/chef/resource/swap_file.rb

@@ -1,6 +1,6 @@
 #
 # Copyright:: 2012-2018, Seth Vargo
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,26 +21,27 @@ class Chef
   class Resource
     class SwapFile < Chef::Resource
 
-      provides(:swap_file) { true }
+      provides(:swap_file, target_mode: true) { true }
+      target_mode support: :full
 
       description "Use the **swap_file** resource to create or delete swap files on Linux systems, and optionally to manage the swappiness configuration for a host."
       introduced "14.0"
       examples <<~DOC
-        **Create a swap file**
+      **Create a swap file**
 
-        ```ruby
-        swap_file '/dev/sda1' do
-          size 1024
-        end
-        ```
+      ```ruby
+      swap_file '/dev/sda1' do
+        size 1024
+      end
+      ```
 
-        **Remove a swap file**
+      **Remove a swap file**
 
-        ```ruby
-        swap_file '/dev/sda1' do
-          action :remove
-        end
-        ```
+      ```ruby
+      swap_file '/dev/sda1' do
+        action :remove
+      end
+      ```
       DOC
 
       property :path, String,
@@ -84,7 +85,7 @@ class Chef
 
       action :remove, description: "Remove a swapfile and disable swap." do
         swapoff if swap_enabled?
-        remove_swapfile if ::File.exist?(new_resource.path)
+        remove_swapfile if ::TargetIO::File.exist?(new_resource.path)
       end
 
       action_class do
@@ -129,7 +130,7 @@ class Chef
 
         def remove_swapfile
           converge_by "remove swap file #{new_resource.path}" do
-            ::FileUtils.rm(new_resource.path)
+            ::TargetIO::FileUtils.rm(new_resource.path)
           end
         end
 
@@ -186,7 +187,7 @@ class Chef
         def compatible_kernel
           fallocate_location = shell_out("which fallocate").stdout
           Chef::Log.debug("#{new_resource} fallocate location is '#{fallocate_location}'")
-          ::File.exist?(fallocate_location.chomp)
+          ::TargetIO::File.exist?(fallocate_location.chomp)
         end
 
         def compatible_filesystem?
@@ -205,7 +206,7 @@ class Chef
 
         def persist
           fstab = "/etc/fstab"
-          contents = ::File.readlines(fstab)
+          contents = ::TargetIO::File.readlines(fstab)
           addition = "#{new_resource.path} swap swap defaults 0 0"
 
           if contents.any? { |line| line.strip == addition }
@@ -214,7 +215,7 @@ class Chef
             Chef::Log.info("#{new_resource} adding entry to #{fstab} for #{new_resource.path}")
 
             contents << "#{addition}\n"
-            ::File.open(fstab, "w") { |f| f.write(contents.join("")) }
+            ::TargetIO::File.open(fstab, "w") { |f| f.write(contents.join("")) }
           end
         end
       end

data/lib/chef/resource/sysctl.rb

@@ -1,6 +1,6 @@
 #
 # Copyright:: 2018, Webb Agile Solutions Ltd.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -21,68 +21,69 @@ class Chef
   class Resource
     class Sysctl < Chef::Resource
 
-      provides(:sysctl) { true }
-      provides(:sysctl_param) { true }
+      provides(:sysctl, target_mode: true) { true }
+      provides(:sysctl_param, target_mode: true) { true }
+      target_mode support: :full
 
       description "Use the **sysctl** resource to set or remove kernel parameters using the `sysctl` command line tool and configuration files in the system's `sysctl.d` directory. Configuration files managed by this resource are named `99-chef-KEYNAME.conf`."
       examples <<~DOC
-        **Set vm.swappiness**:
+      **Set vm.swappiness**:
 
-        ```ruby
-        sysctl 'vm.swappiness' do
-          value 19
-        end
-        ```
+      ```ruby
+      sysctl 'vm.swappiness' do
+        value 19
+      end
+      ```
 
-        **Remove kernel.msgmax**:
+      **Remove kernel.msgmax**:
 
-        **Note**: This only removes the sysctl.d config for kernel.msgmax. The value will be set back to the kernel default value.
+      **Note**: This only removes the sysctl.d config for kernel.msgmax. The value will be set back to the kernel default value.
 
-        ```ruby
-        sysctl 'kernel.msgmax' do
-          action :remove
-        end
-        ```
+      ```ruby
+      sysctl 'kernel.msgmax' do
+        action :remove
+      end
+      ```
 
-        **Adding Comments to sysctl configuration files**:
+      **Adding Comments to sysctl configuration files**:
 
-        ```ruby
-        sysctl 'vm.swappiness' do
-          value 19
-          comment "define how aggressively the kernel will swap memory pages."
-        end
-        ```
+      ```ruby
+      sysctl 'vm.swappiness' do
+        value 19
+        comment "define how aggressively the kernel will swap memory pages."
+      end
+      ```
 
-        This produces /etc/sysctl.d/99-chef-vm.swappiness.conf as follows:
+      This produces /etc/sysctl.d/99-chef-vm.swappiness.conf as follows:
 
-        ```
-        # define how aggressively the kernel will swap memory pages.
-        vm.swappiness = 1
-        ```
+      ```
+      # define how aggressively the kernel will swap memory pages.
+      vm.swappiness = 1
+      ```
 
-        **Converting sysctl settings from shell scripts**:
+      **Converting sysctl settings from shell scripts**:
 
-        Example of existing settings:
+      Example of existing settings:
 
-        ```bash
-        fs.aio-max-nr = 1048576 net.ipv4.ip_local_port_range = 9000 65500 kernel.sem = 250 32000 100 128
-        ```
+      ```bash
+      fs.aio-max-nr = 1048576 net.ipv4.ip_local_port_range = 9000 65500 kernel.sem = 250 32000 100 128
+      ```
 
-        Converted to sysctl resources:
+      Converted to sysctl resources:
 
-        ```ruby
-        sysctl 'fs.aio-max-nr' do
-          value '1048576'
-        end
+      ```ruby
+      sysctl 'fs.aio-max-nr' do
+        value '1048576'
+      end
 
-        sysctl 'net.ipv4.ip_local_port_range' do
-          value '9000 65500'
-        end
+      sysctl 'net.ipv4.ip_local_port_range' do
+        value '9000 65500'
+      end
 
-        sysctl 'kernel.sem' do
-          value '250 32000 100 128'
-        end
-        ```
+      sysctl 'kernel.sem' do
+        value '250 32000 100 128'
+      end
+      ```
       DOC
 
       introduced "14.0"
@@ -152,7 +153,7 @@ class Chef
 
       action :remove, description: "Remove the kernel parameter and update the `sysctl` settings." do
         # only converge the resource if the file actually exists to delete
-        if ::File.exist?("#{new_resource.conf_dir}/99-chef-#{new_resource.key.tr("/", ".")}.conf")
+        if ::TargetIO::File.exist?("#{new_resource.conf_dir}/99-chef-#{new_resource.key.tr("/", ".")}.conf")
           converge_by "removing sysctl config at #{new_resource.conf_dir}/99-chef-#{new_resource.key.tr("/", ".")}.conf" do
             file "#{new_resource.conf_dir}/99-chef-#{new_resource.key.tr("/", ".")}.conf" do
               action :delete
@@ -216,9 +217,9 @@ class Chef
       # return the value. Raise in case this conf file needs to be created
       # or updated
       def get_sysctld_value(key)
-        raise unless ::File.exist?("/etc/sysctl.d/99-chef-#{key.tr("/", ".")}.conf")
+        raise unless ::TargetIO::File.exist?("/etc/sysctl.d/99-chef-#{key.tr("/", ".")}.conf")
 
-        k, v = ::File.read("/etc/sysctl.d/99-chef-#{key.tr("/", ".")}.conf").match(/(.*) = (.*)/).captures
+        k, v = ::Target_IO::File.read("/etc/sysctl.d/99-chef-#{key.tr("/", ".")}.conf").match(/(.*) = (.*)/).captures
         raise "Unknown sysctl key!" if k.nil?
         raise "Unknown sysctl value!" if v.nil?
 

data/lib/chef/resource/systemd_unit.rb

@@ -24,50 +24,53 @@ class Chef
   class Resource
     class SystemdUnit < Chef::Resource
 
-      provides(:systemd_unit) { true }
+      provides(:systemd_unit, target_mode: true) { true }
+      target_mode support: :full,
+        introduced: "15.1",
+        updated: "19.0"
 
       description "Use the **systemd_unit** resource to create, manage, and run [systemd units](https://www.freedesktop.org/software/systemd/man/systemd.html#Concepts)."
       introduced "12.11"
       examples <<~DOC
-        **Create systemd service unit file from a Hash**
-
-        ```ruby
-        systemd_unit 'etcd.service' do
-          content({ Unit: {
-                    Description: 'Etcd',
-                    Documentation: ['https://coreos.com/etcd', 'man:etcd(1)'],
-                    After: 'network.target',
-                  },
-                  Service: {
-                    Type: 'notify',
-                    ExecStart: '/usr/local/etcd',
-                    Restart: 'always',
-                  },
-                  Install: {
-                    WantedBy: 'multi-user.target',
-                  } })
-          action [:create, :enable]
-        end
-        ```
+      **Create systemd service unit file from a Hash**
+
+      ```ruby
+      systemd_unit 'etcd.service' do
+        content({ Unit: {
+                  Description: 'Etcd',
+                  Documentation: ['https://coreos.com/etcd', 'man:etcd(1)'],
+                  After: 'network.target',
+                },
+                Service: {
+                  Type: 'notify',
+                  ExecStart: '/usr/local/etcd',
+                  Restart: 'always',
+                },
+                Install: {
+                  WantedBy: 'multi-user.target',
+                } })
+        action [:create, :enable]
+      end
+      ```
 
-        **Create systemd service unit file from a String**
+      **Create systemd service unit file from a String**
 
-        ```ruby
-        systemd_unit 'sysstat-collect.timer' do
-          content <<~EOU
-          [Unit]
-          Description=Run system activity accounting tool every 10 minutes
+      ```ruby
+      systemd_unit 'sysstat-collect.timer' do
+        content <<~EOU
+        [Unit]
+        Description=Run system activity accounting tool every 10 minutes
 
-          [Timer]
-          OnCalendar=*:00/10
+        [Timer]
+        OnCalendar=*:00/10
 
-          [Install]
-          WantedBy=sysstat.service
-          EOU
+        [Install]
+        WantedBy=sysstat.service
+        EOU
 
-          action [:create, :enable]
-        end
-        ```
+        action [:create, :enable]
+      end
+      ```
       DOC
 
       default_action :nothing
@@ -89,7 +92,7 @@ class Chef
 
       # User-provided properties
       property :user, String, desired_state: false,
-        description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
+               description: "The user account that the systemd unit process is run under. The path to the unit for that user would be something like '/etc/systemd/user/sshd.service'. If no user account is specified, the systemd unit will run under a 'system' account, with the path to the unit being something like '/etc/systemd/system/sshd.service'."
 
       property :content, [String, Hash],
         description: "A string or hash that contains a systemd [unit file](https://www.freedesktop.org/software/systemd/man/systemd.unit.html) definition that describes the properties of systemd-managed entities, such as services, sockets, devices, and so on. In #{ChefUtils::Dist::Infra::PRODUCT} 14.4 or later, repeatable options can be implemented with an array."
@@ -103,9 +106,9 @@ class Chef
         description: "Specifies if the unit will be verified before installation. Systemd can be overly strict when verifying units, so in certain cases it is preferable not to verify the unit."
 
       property :unit_name, String, desired_state: false,
-        name_property: true,
-        description: "The name of the unit file if it differs from the resource block's name.",
-        introduced: "13.7"
+               name_property: true,
+               description: "The name of the unit file if it differs from the resource block's name.",
+               introduced: "13.7"
 
       def to_ini
         case content

data/lib/chef/resource/template.rb

@@ -2,7 +2,7 @@
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Seth Chisamore (<schisamo@chef.io>)
 # Author:: Tyler Cloke (<tyler@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -35,7 +35,8 @@ class Chef
     # template resource follow the same file specificity rules as the remote_file and file resources.
     class Template < Chef::Resource::File
 
-      provides :template
+      provides :template, target_mode: true
+      target_mode support: :full
 
       include Chef::Mixin::Securable
 

data/lib/chef/resource/timezone.rb

@@ -2,7 +2,7 @@
 # Author:: Kirill Kouznetsov <agon.smith@gmail.com>
 #
 # Copyright:: 2018, Kirill Kouznetsov.
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -23,32 +23,33 @@ class Chef
   class Resource
     class Timezone < Chef::Resource
 
-      provides :timezone
+      provides :timezone, target_mode: true
+      target_mode support: :full
 
       description "Use the **timezone** resource to change the system timezone on Windows, Linux, and macOS hosts. Timezones are specified in tz database format, with a complete list of available TZ values for Linux and macOS here: <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>. On Windows systems run `tzutil /l` for a complete list of valid timezones."
       introduced "14.6"
       examples <<~DOC
-        **Set the timezone to UTC**
+      **Set the timezone to UTC**
 
-        ```ruby
-        timezone 'UTC'
-        ```
+      ```ruby
+      timezone 'UTC'
+      ```
 
-        **Set the timezone to America/Los_Angeles with a friendly resource name on Linux/macOS**
+      **Set the timezone to America/Los_Angeles with a friendly resource name on Linux/macOS**
 
-        ```ruby
-        timezone "Set the host's timezone to America/Los_Angeles" do
-          timezone 'America/Los_Angeles'
-        end
-        ```
+      ```ruby
+      timezone "Set the host's timezone to America/Los_Angeles" do
+        timezone 'America/Los_Angeles'
+      end
+      ```
 
-        **Set the timezone to PST with a friendly resource name on Windows**
+      **Set the timezone to PST with a friendly resource name on Windows**
 
-        ```ruby
-        timezone "Set the host's timezone to PST" do
-          timezone 'Pacific Standard time'
-        end
-        ```
+      ```ruby
+      timezone "Set the host's timezone to PST" do
+        timezone 'Pacific Standard time'
+      end
+      ```
       DOC
 
       property :timezone, String,
@@ -96,10 +97,10 @@ class Chef
       # @since 16.5
       # @return [String] timezone id
       def current_rhel_tz
-        return nil unless ::File.exist?("/etc/sysconfig/clock")
+        return nil unless ::TargetIO::File.exist?("/etc/sysconfig/clock")
 
         # https://rubular.com/r/aoj01L3bKBM7wh
-        /ZONE="(.*)"/.match(::File.read("/etc/sysconfig/clock"))[1]
+        /ZONE="(.*)"/.match(::TargetIO::File.read("/etc/sysconfig/clock"))[1]
       end
 
       load_current_value do
@@ -155,13 +156,13 @@ class Chef
                 execute "tzdata-update" do
                   command "/usr/sbin/tzdata-update"
                   action :nothing
-                  only_if { ::File.executable?("/usr/sbin/tzdata-update") }
+                  only_if { ::TargetIO::File.executable?("/usr/sbin/tzdata-update") }
                   subscribes :run, "file[/etc/sysconfig/clock]", :immediately
                 end
 
                 link "/etc/localtime" do
                   to "/usr/share/zoneinfo/#{new_resource.timezone}"
-                  not_if { ::File.executable?("/usr/sbin/tzdata-update") }
+                  not_if { ::TargetIO::File.executable?("/usr/sbin/tzdata-update") }
                 end
               when "mac_os_x"
                 shell_out!(["sudo", "systemsetup", "-settimezone", new_resource.timezone])

data/lib/chef/resource/user/aix_user.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,8 +22,9 @@ class Chef
     class User
       class AixUser < Chef::Resource::User
 
-        provides :aix_user
-        provides :user, os: "aix"
+        provides :aix_user, target_mode: true
+        provides :user, os: "aix", target_mode: true
+        target_mode support: :full
       end
     end
   end

data/lib/chef/resource/user/linux_user.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,9 +22,9 @@ class Chef
     class User
       class LinuxUser < Chef::Resource::User
 
-        provides :linux_user
-        provides :user, os: "linux"
-
+        provides :linux_user, target_mode: true
+        provides :user, os: "linux", target_mode: true
+        target_mode support: :full
       end
     end
   end

data/lib/chef/resource/user/mac_user.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Ryan Cragun (<ryan@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -61,6 +61,7 @@ class Chef
 
         provides :mac_user
         provides :user, platform: "mac_os_x"
+        target_mode support: false
 
         introduced "15.3"
 
@@ -90,9 +91,9 @@ class Chef
 
           password
         },
-          callbacks: {
-            "Password length must be >= 4" => ->(password) { password.size >= 4 },
-          }
+        callbacks: {
+          "Password length must be >= 4" => ->(password) { password.size >= 4 },
+        }
 
         # Overload home so we set our default.
         property :home, String, description: "The user home directory", default: lazy { "/Users/#{name}" }

data/lib/chef/resource/user/pw_user.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,8 +22,9 @@ class Chef
     class User
       class PwUser < Chef::Resource::User
 
-        provides :pw_user
-        provides :user, os: "freebsd"
+        provides :pw_user, target_mode: true
+        provides :user, os: "freebsd", target_mode: true
+        target_mode support: :full
       end
     end
   end

data/lib/chef/resource/user/solaris_user.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,8 +22,9 @@ class Chef
     class User
       class SolarisUser < Chef::Resource::User
 
-        provides :solaris_user
-        provides :user, os: %w{omnios solaris2}
+        provides :solaris_user, target_mode: true
+        provides :user, os: %w{omnios solaris2}, target_mode: true
+        target_mode support: :full
       end
     end
   end

data/lib/chef/resource/user/windows_user.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,6 +24,7 @@ class Chef
 
         provides :windows_user
         provides :user, os: "windows"
+        target_mode support: false
 
         property :full_name, String,
           description: "The full name of the user.",

data/lib/chef/resource/user.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) Chef Software Inc.
+# Copyright:: Copyright (c) 2009-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -23,6 +23,7 @@ class Chef
     class User < Chef::Resource
 
       description "Use the **user** resource to add users, update existing users, remove users, and to lock/unlock user passwords."
+      target_mode support: :full
 
       default_action :create
       allowed_actions :create, :remove, :modify, :manage, :lock, :unlock
@@ -74,14 +75,14 @@ class Chef
       alias_method :group, :gid
 
       property :expire_date, [ String, NilClass ],
-        description: "(Linux) The date on which the user account will be disabled. The date is specified in YYYY-MM-DD format.",
-        introduced: "18.0",
-        desired_state: false
+               description: "(Linux) The date on which the user account will be disabled. The date is specified in YYYY-MM-DD format.",
+               introduced: "18.0",
+               desired_state: false
 
       property :inactive, [ String, Integer, NilClass ],
-        description: "(Linux) The number of days after a password expires until the account is permanently disabled. A value of `0` disables the account as soon as the password has expired, and a value of `-1` disables the feature.",
-        introduced: "18.0",
-        desired_state: false
+               description: "(Linux) The number of days after a password expires until the account is permanently disabled. A value of `0` disables the account as soon as the password has expired, and a value of `-1` disables the feature.",
+               introduced: "18.0",
+               desired_state: false
     end
   end
 end