chef 18.9.4 → 18.11.11

data/lib/chef/resource/ifconfig.rb

@@ -27,51 +27,51 @@ class Chef
 
       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**
+        **Configure a network interface with a static IP**
 
-      ```ruby
-      ifconfig '33.33.33.80' do
-        device 'eth1'
-      end
-      ```
+        ```ruby
+        ifconfig '33.33.33.80' do
+          device 'eth1'
+        end
+        ```
 
-      will create the following interface configuration:
+        will create the following interface configuration:
 
-      ```
-      iface eth1 inet static
-        address 33.33.33.80
-      ```
+        ```
+        iface eth1 inet static
+          address 33.33.33.80
+        ```
 
-      **Configure an interface to use DHCP**
+        **Configure an interface to use DHCP**
 
-      ```ruby
-      ifconfig 'Set eth1 to DHCP' do
-        device 'eth1'
-        bootproto 'dhcp'
-      end
-      ```
+        ```ruby
+        ifconfig 'Set eth1 to DHCP' do
+          device 'eth1'
+          bootproto 'dhcp'
+        end
+        ```
 
-      will create the following interface configuration:
+        will create the following interface configuration:
 
-      ```
-      iface eth1 inet dhcp
-      ```
+        ```
+        iface eth1 inet dhcp
+        ```
 
-      **Update a static IP address with a boot protocol**
+        **Update a static IP address with a boot protocol**
 
-      ```ruby
-      ifconfig "33.33.33.80" do
-        bootproto "dhcp"
-        device "eth1"
-      end
-      ```
+        ```ruby
+        ifconfig "33.33.33.80" do
+          bootproto "dhcp"
+          device "eth1"
+        end
+        ```
 
-      will update the interface configuration from static to dhcp:
+        will update the interface configuration from static to dhcp:
 
-      ```
-      iface eth1 inet dhcp
-        address 33.33.33.80
-      ```
+        ```
+        iface eth1 inet dhcp
+          address 33.33.33.80
+        ```
       DOC
 
       state_attrs :inet_addr, :mask

data/lib/chef/resource/inspec_input.rb

@@ -25,55 +25,55 @@ class Chef
       introduced "17.5"
       examples <<~DOC
 
-      **Activate the default input in the openssh cookbook's compliance segment**:
+        **Activate the default input in the openssh cookbook's compliance segment**:
 
-      ```ruby
-        inspec_input 'openssh' do
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_input 'openssh' do
+            action :add
+          end
+        ```
 
-      **Activate all inputs in the openssh cookbook's compliance segment**:
+        **Activate all inputs in the openssh cookbook's compliance segment**:
 
-      ```ruby
-        inspec_input 'openssh::.*' do
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_input 'openssh::.*' do
+            action :add
+          end
+        ```
 
-      **Add an InSpec input to the Compliance Phase from a hash**:
+        **Add an InSpec input to the Compliance Phase from a hash**:
 
-      ```ruby
-        inspec_input { ssh_custom_path: '/whatever2' }
-      ```
+        ```ruby
+          inspec_input { ssh_custom_path: '/whatever2' }
+        ```
 
-      **Add an InSpec input to the Compliance Phase using the 'name' property to identify the input**:
+        **Add an InSpec input to the Compliance Phase using the 'name' property to identify the input**:
 
-      ```ruby
-        inspec_input "setting my input" do
-          source( { ssh_custom_path: '/whatever2' })
-        end
-      ```
+        ```ruby
+          inspec_input "setting my input" do
+            source( { ssh_custom_path: '/whatever2' })
+          end
+        ```
 
-      **Add an InSpec input to the Compliance Phase using a TOML, JSON, or YAML file**:
+        **Add an InSpec input to the Compliance Phase using a TOML, JSON, or YAML file**:
 
-      ```ruby
-        inspec_input "/path/to/my/input.yml"
-      ```
+        ```ruby
+          inspec_input "/path/to/my/input.yml"
+        ```
 
-      **Add an InSpec input to the Compliance Phase using a TOML, JSON, or YAML file, using the 'name' property**:
+        **Add an InSpec input to the Compliance Phase using a TOML, JSON, or YAML file, using the 'name' property**:
 
-      ```ruby
-        inspec_input "setting my input" do
-          source "/path/to/my/input.yml"
-        end
-      ```
+        ```ruby
+          inspec_input "setting my input" do
+            source "/path/to/my/input.yml"
+          end
+        ```
 
-      Note that the **inspec_input** resource does not update and will not fire notifications (similar to the log resource). This is done to preserve the ability to use
-      the resource while not causing the updated resource count to be larger than zero. Since the resource does not update the state of the managed node, this behavior
-      is still consistent with the configuration management model. Instead, you should use events to observe configuration changes for the compliance phase. It is
-      possible to use the `notify_group` resource to chain notifications of the two resources, but notifications are the wrong model to use, and you should use pure ruby
-      conditionals instead. Compliance configuration should be independent of other resources and should only be conditional based on state/attributes, not other resources.
+        Note that the **inspec_input** resource does not update and will not fire notifications (similar to the log resource). This is done to preserve the ability to use
+        the resource while not causing the updated resource count to be larger than zero. Since the resource does not update the state of the managed node, this behavior
+        is still consistent with the configuration management model. Instead, you should use events to observe configuration changes for the compliance phase. It is
+        possible to use the `notify_group` resource to chain notifications of the two resources, but notifications are the wrong model to use, and you should use pure ruby
+        conditionals instead. Compliance configuration should be independent of other resources and should only be conditional based on state/attributes, not other resources.
       DOC
 
       property :name, [ Hash, String ]

data/lib/chef/resource/inspec_waiver.rb

@@ -24,87 +24,87 @@ class Chef
       description "Use the **inspec_waiver** resource to add a waiver to the Compliance Phase."
       introduced "17.5"
       examples <<~DOC
-      **Activate the default waiver in the openssh cookbook's compliance segment**:
+        **Activate the default waiver in the openssh cookbook's compliance segment**:
 
-      ```ruby
-        inspec_waiver 'openssh' do
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_waiver 'openssh' do
+            action :add
+          end
+        ```
 
-      **Activate all waivers in the openssh cookbook's compliance segment**:
+        **Activate all waivers in the openssh cookbook's compliance segment**:
 
-      ```ruby
-        inspec_waiver 'openssh::.*' do
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_waiver 'openssh::.*' do
+            action :add
+          end
+        ```
 
-      **Add an InSpec waiver to the Compliance Phase**:
+        **Add an InSpec waiver to the Compliance Phase**:
 
-      ```ruby
-        inspec_waiver 'Add waiver entry for control' do
-          control 'my_inspec_control_01'
-          run_test false
-          justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
-          expiration '2022-01-01'
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_waiver 'Add waiver entry for control' do
+            control 'my_inspec_control_01'
+            run_test false
+            justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
+            expiration '2022-01-01'
+            action :add
+          end
+        ```
 
-      **Add an InSpec waiver to the Compliance Phase using the 'name' property to identify the control**:
+        **Add an InSpec waiver to the Compliance Phase using the 'name' property to identify the control**:
 
-      ```ruby
-        inspec_waiver 'my_inspec_control_01' do
-          justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_waiver 'my_inspec_control_01' do
+            justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
+            action :add
+          end
+        ```
 
-      **Add an InSpec waiver to the Compliance Phase using an arbitrary YAML, JSON, or TOML file**:
+        **Add an InSpec waiver to the Compliance Phase using an arbitrary YAML, JSON, or TOML file**:
 
-      ```ruby
-        # files ending in .yml or .yaml that exist are parsed as YAML
-        inspec_waiver "/path/to/my/waiver.yml"
+        ```ruby
+          # files ending in .yml or .yaml that exist are parsed as YAML
+          inspec_waiver "/path/to/my/waiver.yml"
 
-        inspec_waiver "my-waiver-name" do
-          source "/path/to/my/waiver.yml"
-        end
+          inspec_waiver "my-waiver-name" do
+            source "/path/to/my/waiver.yml"
+          end
 
-        # files ending in .json that exist are parsed as JSON
-        inspec_waiver "/path/to/my/waiver.json"
+          # files ending in .json that exist are parsed as JSON
+          inspec_waiver "/path/to/my/waiver.json"
 
-        inspec_waiver "my-waiver-name" do
-          source "/path/to/my/waiver.json"
-        end
+          inspec_waiver "my-waiver-name" do
+            source "/path/to/my/waiver.json"
+          end
 
-        # files ending in .toml that exist are parsed as TOML
-        inspec_waiver "/path/to/my/waiver.toml"
+          # files ending in .toml that exist are parsed as TOML
+          inspec_waiver "/path/to/my/waiver.toml"
 
-        inspec_waiver "my-waiver-name" do
-          source "/path/to/my/waiver.toml"
-        end
-      ```
+          inspec_waiver "my-waiver-name" do
+            source "/path/to/my/waiver.toml"
+          end
+        ```
 
-      **Add an InSpec waiver to the Compliance Phase using a hash**:
+        **Add an InSpec waiver to the Compliance Phase using a hash**:
 
-      ```ruby
-        my_hash = { "ssh-01" => {
-          "expiration_date" => "2033-07-31",
-          "run" => false,
-          "justification" => "because"
-        } }
+        ```ruby
+          my_hash = { "ssh-01" => {
+            "expiration_date" => "2033-07-31",
+            "run" => false,
+            "justification" => "because"
+          } }
 
-        inspec_waiver "my-waiver-name" do
-          source my_hash
-        end
-      ```
+          inspec_waiver "my-waiver-name" do
+            source my_hash
+          end
+        ```
 
-      Note that the **inspec_waiver** resource does not update and will not fire notifications (similar to the log resource). This is done to preserve the ability to use
-      the resource while not causing the updated resource count to be larger than zero. Since the resource does not update the state of the managed node, this behavior
-      is still consistent with the configuration management model. Instead, you should use events to observe configuration changes for the compliance phase. It is
-      possible to use the `notify_group` resource to chain notifications of the two resources, but notifications are the wrong model to use, and you should use pure ruby
-      conditionals instead. Compliance configuration should be independent of other resources and should only be conditional based on state/attributes, not other resources.
+        Note that the **inspec_waiver** resource does not update and will not fire notifications (similar to the log resource). This is done to preserve the ability to use
+        the resource while not causing the updated resource count to be larger than zero. Since the resource does not update the state of the managed node, this behavior
+        is still consistent with the configuration management model. Instead, you should use events to observe configuration changes for the compliance phase. It is
+        possible to use the `notify_group` resource to chain notifications of the two resources, but notifications are the wrong model to use, and you should use pure ruby
+        conditionals instead. Compliance configuration should be independent of other resources and should only be conditional based on state/attributes, not other resources.
       DOC
 
       property :control, String,

data/lib/chef/resource/inspec_waiver_file_entry.rb

@@ -28,35 +28,35 @@ class Chef
       description "Use the **inspec_waiver_file_entry** resource to add or remove entries from an InSpec waiver file. This can be used in conjunction with the Compliance Phase."
       introduced "17.1"
       examples <<~DOC
-      **Add an InSpec waiver entry to a given waiver file**:
-
-      ```ruby
-        inspec_waiver_file_entry 'Add waiver entry for control' do
-          file_path 'C:\\chef\\inspec_waiver_file.yml'
-          control 'my_inspec_control_01'
-          run_test false
-          justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
-          expiration '2022-01-01'
-          action :add
-        end
-      ```
+        **Add an InSpec waiver entry to a given waiver file**:
+
+        ```ruby
+          inspec_waiver_file_entry 'Add waiver entry for control' do
+            file_path 'C:\\chef\\inspec_waiver_file.yml'
+            control 'my_inspec_control_01'
+            run_test false
+            justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
+            expiration '2022-01-01'
+            action :add
+          end
+        ```
 
-      **Add an InSpec waiver entry to a given waiver file using the 'name' property to identify the control**:
+        **Add an InSpec waiver entry to a given waiver file using the 'name' property to identify the control**:
 
-      ```ruby
-        inspec_waiver_file_entry 'my_inspec_control_01' do
-          justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
-          action :add
-        end
-      ```
+        ```ruby
+          inspec_waiver_file_entry 'my_inspec_control_01' do
+            justification "The subject of this control is not managed by #{ChefUtils::Dist::Infra::PRODUCT} on the systems in policy group \#{node['policy_group']}"
+            action :add
+          end
+        ```
 
-      **Remove an InSpec waiver entry to a given waiver file**:
+        **Remove an InSpec waiver entry to a given waiver file**:
 
-      ```ruby
-        inspec_waiver_file_entry "my_inspec_control_01" do
-          action :remove
-        end
-      ```
+        ```ruby
+          inspec_waiver_file_entry "my_inspec_control_01" do
+            action :remove
+          end
+        ```
       DOC
 
       property :control, String,

data/lib/chef/resource/ksh.rb

@@ -24,11 +24,11 @@ class Chef
 
       provides :ksh
 
-      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"\
-                  " 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`"\
+      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" \
+                  " 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."
       introduced "12.6"
 

data/lib/chef/resource/launchd.rb

@@ -136,7 +136,7 @@ class Chef
         description: "Sets the log mask to `LOG_DEBUG` for this job."
 
       property :disabled, [ TrueClass, FalseClass ], default: false,
-               description: "Hints to `launchctl` to not submit this job to launchd."
+        description: "Hints to `launchctl` to not submit this job to launchd."
 
       property :enable_globbing, [ TrueClass, FalseClass ],
         description: "Update program arguments before invocation."
@@ -190,7 +190,7 @@ class Chef
 
       property :nice, Integer,
         description: "The program scheduling priority value in the range -20 to 19.",
-        callbacks: { "should be a Integer between -20 and 19" => proc { |v| v >= -20 && v <= 19 } }
+        callbacks: { "should be a Integer between -20 and 19" => proc { |v| v.between?(-20, 19) } }
 
       property :on_demand, [ TrueClass, FalseClass ],
         description: "Keep a job alive. Only applies to macOS version 10.4 (and earlier); use `keep_alive` instead for newer versions."

data/lib/chef/resource/link.rb

@@ -27,14 +27,14 @@ class Chef
 
       provides :link
 
-      description "Use the **link** resource to create symbolic or hard links.\n\n"\
-                  "A symbolic link—sometimes referred to as a soft link—is a directory entry"\
-                  " that associates a file name with a string that contains an absolute or"\
-                  " relative path to a file on any file system. In other words, 'a file that"\
-                  " contains a path that points to another file.' A symbolic link creates a new"\
-                  " file with a new inode that points to the inode location of the original file.\n\n"\
-                  "A hard link is a directory entry that associates a file with another file in the"\
-                  " same file system. In other words, 'multiple directory entries to the same file.'"\
+      description "Use the **link** resource to create symbolic or hard links.\n\n" \
+                  "A symbolic link—sometimes referred to as a soft link—is a directory entry" \
+                  " that associates a file name with a string that contains an absolute or" \
+                  " relative path to a file on any file system. In other words, 'a file that" \
+                  " contains a path that points to another file.' A symbolic link creates a new" \
+                  " file with a new inode that points to the inode location of the original file.\n\n" \
+                  "A hard link is a directory entry that associates a file with another file in the" \
+                  " same file system. In other words, 'multiple directory entries to the same file.'" \
                   " A hard link creates a new file that points to the same inode as the original file."
 
       state_attrs :owner # required since it's not a property below

data/lib/chef/resource/locale.rb

@@ -27,13 +27,13 @@ class Chef
       introduced "14.5"
 
       examples <<~DOC
-      Set the lang to 'en_US.UTF-8'
+        Set the lang to 'en_US.UTF-8'
 
-      ```ruby
-        locale 'set system locale' do
-          lang 'en_US.UTF-8'
-        end
-      ```
+        ```ruby
+          locale 'set system locale' do
+            lang 'en_US.UTF-8'
+          end
+        ```
       DOC
 
       LC_VARIABLES ||= %w{LC_ADDRESS LC_COLLATE LC_CTYPE LC_IDENTIFICATION LC_MEASUREMENT LC_MESSAGES LC_MONETARY LC_NAME LC_NUMERIC LC_PAPER LC_TELEPHONE LC_TIME}.freeze

data/lib/chef/resource/log.rb

@@ -32,10 +32,10 @@ class Chef
 
       provides :log, target_mode: true
 
-      description "Use the **log** resource to create log entries. The log resource behaves"\
-                  " like any other resource: built into the resource collection during the"\
-                  " compile phase, and then run during the execution phase. (To create a log"\
-                  " entry that is not built into the resource collection, use Chef::Log instead"\
+      description "Use the **log** resource to create log entries. The log resource behaves" \
+                  " like any other resource: built into the resource collection during the" \
+                  " compile phase, and then run during the execution phase. (To create a log" \
+                  " entry that is not built into the resource collection, use Chef::Log instead" \
                   " of the log resource.)"
 
       property :message, String,

data/lib/chef/resource/mdadm.rb

@@ -25,55 +25,55 @@ class Chef
 
       provides :mdadm
 
-      description "Use the **mdadm** resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource"\
-                  " will create and assemble an array, but it will not create the config file that is used to persist the array upon"\
-                  " reboot. If the config file is required, it must be done by specifying a template with the correct array layout,"\
+      description "Use the **mdadm** resource to manage RAID devices in a Linux environment using the mdadm utility. The mdadm resource" \
+                  " will create and assemble an array, but it will not create the config file that is used to persist the array upon" \
+                  " reboot. If the config file is required, it must be done by specifying a template with the correct array layout," \
                   " and then by using the mount provider to create a file systems table (fstab) entry."
 
       examples <<~DOC
-      **Create and assemble a RAID 0 array**
+        **Create and assemble a RAID 0 array**
 
-      The mdadm command can be used to create RAID arrays. For example, a RAID 0 array named /dev/md0 with 10 devices would have a command similar to the following:
+        The mdadm command can be used to create RAID arrays. For example, a RAID 0 array named /dev/md0 with 10 devices would have a command similar to the following:
 
-      ```
-      mdadm --create /dev/md0 --level=0 --raid-devices=10 /dev/s01.../dev/s10
-      ```
+        ```
+        mdadm --create /dev/md0 --level=0 --raid-devices=10 /dev/s01.../dev/s10
+        ```
 
-      where /dev/s01 .. /dev/s10 represents 10 devices (01, 02, 03, and so on). This same command, when expressed as a recipe using the mdadm resource, would be similar to:
+        where /dev/s01 .. /dev/s10 represents 10 devices (01, 02, 03, and so on). This same command, when expressed as a recipe using the mdadm resource, would be similar to:
 
-      ```ruby
-      mdadm '/dev/md0' do
-        devices [ '/dev/s01', ... '/dev/s10' ]
-        level 0
-        action :create
-      end
-      ```
+        ```ruby
+        mdadm '/dev/md0' do
+          devices [ '/dev/s01', ... '/dev/s10' ]
+          level 0
+          action :create
+        end
+        ```
 
-      (again, where /dev/s01 .. /dev/s10 represents devices /dev/s01, /dev/s02, /dev/s03, and so on).
+        (again, where /dev/s01 .. /dev/s10 represents devices /dev/s01, /dev/s02, /dev/s03, and so on).
 
-      **Create and assemble a RAID 1 array**
+        **Create and assemble a RAID 1 array**
 
-      ```ruby
-      mdadm '/dev/md0' do
-        devices [ '/dev/sda', '/dev/sdb' ]
-        level 1
-        action [ :create, :assemble ]
-      end
-      ```
+        ```ruby
+        mdadm '/dev/md0' do
+          devices [ '/dev/sda', '/dev/sdb' ]
+          level 1
+          action [ :create, :assemble ]
+        end
+        ```
 
-      **Create and assemble a RAID 5 array**
+        **Create and assemble a RAID 5 array**
 
-      The mdadm command can be used to create RAID arrays. For example, a RAID 5 array named /dev/sd0 with 4, and a superblock type of 0.90 would be similar to:
+        The mdadm command can be used to create RAID arrays. For example, a RAID 5 array named /dev/sd0 with 4, and a superblock type of 0.90 would be similar to:
 
-      ```ruby
-      mdadm '/dev/sd0' do
-        devices [ '/dev/s1', '/dev/s2', '/dev/s3', '/dev/s4' ]
-        level 5
-        metadata '0.90'
-        chunk 32
-        action :create
-      end
-      ```
+        ```ruby
+        mdadm '/dev/sd0' do
+          devices [ '/dev/s1', '/dev/s2', '/dev/s3', '/dev/s4' ]
+          level 5
+          metadata '0.90'
+          chunk 32
+          action :create
+        end
+        ```
       DOC
 
       default_action :create

data/lib/chef/resource/mount.rb

@@ -41,11 +41,11 @@ class Chef
         sensitive: true
 
       property :mount_point, String, name_property: true,
-               coerce: proc { |arg| (arg == "/" || arg.match?(":/$")) ? 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."
+        coerce: proc { |arg| (arg == "/" || arg.match?(":/$")) ? 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,
-               description: "Required for `:umount` and `:remount` actions (for the purpose of checking the mount command output for presence). The special block device or remote node, a label, or a uuid to be mounted."
+        description: "Required for `:umount` and `:remount` actions (for the purpose of checking the mount command output for presence). The special block device or remote node, a label, or a uuid to be mounted."
 
       property :device_type, [String, Symbol],
         description: "The type of device: :device, :label, or :uuid",

data/lib/chef/resource/msu_package.rb

@@ -54,7 +54,7 @@ class Chef
         default: lazy { package_name }
 
       property :checksum, String, desired_state: false,
-               description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."
+        description: "SHA-256 digest used to verify the checksum of the downloaded MSU package."
 
       property :timeout, [String, Integer],
         default: 3600,