chef 15.11.3-universal-mingw32 → 16.1.16-universal-mingw32

data/lib/chef/resource/{subversion.rb → scm/subversion.rb}

@@ -17,15 +17,18 @@
 # limitations under the License.
 #
 
-require_relative "scm"
-require_relative "../dist"
+require_relative "../../dist"
 
 class Chef
   class Resource
-    class Subversion < Chef::Resource::Scm
+    class Subversion < Chef::Resource
+      use "scm"
+
       unified_mode true
 
-      description "Use the subversion resource to manage source control resources that exist in a Subversion repository."
+      provides :subversion
+
+      description "Use the **subversion** resource to manage source control resources that exist in a Subversion repository."
 
       allowed_actions :force_export
 
@@ -35,7 +38,7 @@ class Chef
         default: "--no-auth-cache"
 
       property :svn_info_args, [String, nil, FalseClass],
-        description: "Use when the svn info command is used by the #{Chef::Dist::CLIENT} and arguments need to be passed. The svn_arguments command does not work when the svn info command is used.",
+        description: "Use when the `svn info` command is used by #{Chef::Dist::PRODUCT} and arguments need to be passed. The `svn_arguments` command does not work when the `svn info` command is used.",
         coerce: proc { |v| v == false ? nil : v }, # coerce false to nil
         default: "--no-auth-cache"
 
@@ -43,10 +46,10 @@ class Chef
         description: "The location of the svn binary."
 
       property :svn_username, String,
-        description: "The username to use for interacting with subversion."
+        description: "The user name for a user that has access to the Subversion repository."
 
       property :svn_password, String,
-        description: "The password to use for interacting with subversion.",
+        description: "The password for a user that has access to the Subversion repository.",
         sensitive: true, desired_state: false
 
       # Override exception to strip password if any, so it won't appear in logs and different Chef notifications

data/lib/chef/resource/script.rb

@@ -24,11 +24,11 @@ class Chef
     class Script < Chef::Resource::Execute
       unified_mode true
 
-      resource_name :script
+      provides :script
 
       identity_attr :name
 
-      description "Use the script resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby."\
+      description "Use the **script** resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby."\
                   " 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."
@@ -47,10 +47,13 @@ class Chef
         end
       end
 
-      property :code, String, required: true
+      property :code, String, required: true,
+        description: "A quoted string of code to be executed."
+
       property :interpreter, String
-      property :flags, String
 
+      property :flags, String,
+        description: "One or more command line flags that are passed to the interpreter when a command is invoked."
     end
   end
 end

data/lib/chef/resource/service.rb

@@ -27,12 +27,11 @@ class Chef
     class Service < Chef::Resource
       include ChefUtils::DSL::Service
       extend ChefUtils::DSL::Service
+      unified_mode true
 
       provides :service, target_mode: true
 
-      identity_attr :service_name
-
-      description "Use the service resource to manage a service."
+      description "Use the **service** resource to manage a service."
 
       default_action :nothing
       allowed_actions :enable, :disable, :start, :stop, :restart, :reload,
@@ -45,7 +44,7 @@ class Chef
 
       property :service_name, String,
         description: "An optional property to set the service name if it differs from the resource block's name.",
-        name_property: true, identity: true
+        name_property: true
 
       # regex for match against ps -ef when !supports[:has_status] && status == nil
       property :pattern, String,
@@ -83,7 +82,7 @@ class Chef
       # specify overrides for the start_command, stop_command and
       # restart_command properties.
       property :init_command, String,
-        description: "The path to the init script that is associated with the service. Use init_command to prevent the need to specify overrides for the start_command, stop_command, and restart_command properties. When this property is not specified, the #{Chef::Dist::CLIENT} will use the default init command for the service provider being used.",
+        description: "The path to the init script that is associated with the service. Use init_command to prevent the need to specify overrides for the start_command, stop_command, and restart_command properties. When this property is not specified, the #{Chef::Dist::PRODUCT} will use the default init command for the service provider being used.",
         desired_state: false
 
       # if the service is enabled or not
@@ -115,10 +114,10 @@ class Chef
       property :priority, [ Integer, String, Hash ],
         description: "Debian platform only. The relative priority of the program for start and shutdown ordering. May be an integer or a Hash. An integer is used to define the start run levels; stop run levels are then 100-integer. A Hash is used to define values for specific run levels. For example, { 2 => [:start, 20], 3 => [:stop, 55] } will set a priority of twenty for run level two and a priority of fifty-five for run level three."
 
-      # timeout only applies to the windows service manager
       property :timeout, Integer,
-        description: "Microsoft Windows platform only. The amount of time (in seconds) to wait before timing out.",
-        desired_state: false
+      description: "The amount of time (in seconds) to wait before timing out.",
+      default: 900,
+      desired_state: false
 
       property :parameters, Hash,
         description: "Upstart only: A hash of parameters to pass to the service command for use in the service definition."

data/lib/chef/resource/smartos_package.rb

@@ -21,11 +21,19 @@ require_relative "package"
 class Chef
   class Resource
     class SmartosPackage < Chef::Resource::Package
-      resource_name :smartos_package
+      unified_mode true
+
       provides :smartos_package
       provides :package, platform_family: "smartos"
 
-      description "Use the smartos_package resource to manage packages for the SmartOS platform."
+      description "Use the **smartos_package** resource to manage packages for the SmartOS platform."
+
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
     end
   end
 end

data/lib/chef/resource/snap_package.rb

@@ -21,9 +21,11 @@ require_relative "package"
 class Chef
   class Resource
     class SnapPackage < Chef::Resource::Package
-      resource_name :snap_package
+      unified_mode true
 
-      description "Use the snap_package resource to manage snap packages on Debian and Ubuntu platforms."
+      provides :snap_package
+
+      description "Use the **snap_package** resource to manage snap packages on Debian and Ubuntu platforms."
       introduced "15.0"
 
       property :channel, String,

data/lib/chef/resource/solaris_package.rb

@@ -22,12 +22,20 @@ require_relative "package"
 class Chef
   class Resource
     class SolarisPackage < Chef::Resource::Package
-      resource_name :solaris_package
+      unified_mode true
+
       provides :solaris_package
       provides :package, os: "solaris2", platform_family: "nexentacore"
       provides :package, os: "solaris2", platform_family: "solaris2", platform_version: "<= 5.10"
 
-      description "The solaris_package resource is used to manage packages for the Solaris platform."
+      description "Use the **solaris_package** resource to manage packages on the Solaris platform."
+
+      property :package_name, String,
+        description: "An optional property to set the package name if it differs from the resource block's name.",
+        identity: true
+
+      property :version, String,
+        description: "The version of a package to be installed or upgraded."
     end
   end
 end

data/lib/chef/resource/ssh_known_hosts_entry.rb

@@ -23,9 +23,11 @@ require_relative "../dist"
 class Chef
   class Resource
     class SshKnownHostsEntry < Chef::Resource
-      resource_name :ssh_known_hosts_entry
+      unified_mode true
 
-      description "Use the ssh_known_hosts_entry resource to add an entry for the specified host in /etc/ssh/ssh_known_hosts or a user's known hosts file if specified."
+      provides :ssh_known_hosts_entry
+
+      description "Use the **ssh_known_hosts_entry** resource to add an entry for the specified host in /etc/ssh/ssh_known_hosts or a user's known hosts file if specified."
       introduced "14.3"
 
       property :host, String,
@@ -45,7 +47,8 @@ class Chef
 
       property :timeout, Integer,
         description: "The timeout in seconds for ssh-keyscan.",
-        default: 30
+        default: 30,
+        desired_state: false
 
       property :mode, String,
         description: "The file mode for the ssh_known_hosts file.",

data/lib/chef/resource/sudo.rb

@@ -24,10 +24,11 @@ require_relative "../resource"
 class Chef
   class Resource
     class Sudo < Chef::Resource
-      resource_name :sudo
+      unified_mode true
+
       provides(:sudo) { true }
 
-      description "Use the sudo resource to add or remove individual sudo entries using sudoers.d files."\
+      description "Use the **sudo** resource to add or remove individual sudo entries using sudoers.d files."\
                   " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the"\
                   " '#includedir' directive introduced in version 1.7.2. This resource does not enforce"\
                   " installation of the required sudo version. Chef-supported releases of Ubuntu, SuSE, Debian,"\
@@ -87,15 +88,15 @@ class Chef
         default: lazy { [] }
 
       property :setenv, [TrueClass, FalseClass],
-        description: "Determines whether or not to permit preservation of the environment with 'sudo -E'.",
+        description: "Determines whether or not to permit preservation of the environment with `sudo -E`.",
         default: false
 
       property :env_keep_add, Array,
-        description: "An array of strings to add to env_keep.",
+        description: "An array of strings to add to `env_keep`.",
         default: lazy { [] }
 
       property :env_keep_subtract, Array,
-        description: "An array of strings to remove from env_keep.",
+        description: "An array of strings to remove from `env_keep`.",
         default: lazy { [] }
 
       property :visudo_path, String,
@@ -148,14 +149,13 @@ class Chef
         validate_properties
 
         if docker? # don't even put this into resource collection unless we're in docker
-          declare_resource(:package, "sudo") do
-            action :nothing
+          package "sudo" do
             not_if "which sudo"
-          end.run_action(:install)
+          end
         end
 
         target = "#{new_resource.config_prefix}/sudoers.d/"
-        declare_resource(:directory, target) unless ::File.exist?(target)
+        directory(target)
 
         Chef::Log.warn("#{new_resource.filename} will be rendered, but will not take effect because the #{new_resource.config_prefix}/sudoers config lacks the includedir directive that loads configs from #{new_resource.config_prefix}/sudoers.d/!") if ::File.readlines("#{new_resource.config_prefix}/sudoers").grep(/includedir/).empty?
         file_path = "#{target}#{new_resource.filename}"
@@ -163,7 +163,7 @@ class Chef
         if new_resource.template
           logger.trace("Template property provided, all other properties ignored.")
 
-          declare_resource(:template, file_path) do
+          template file_path do
             source new_resource.template
             mode "0440"
             variables new_resource.variables
@@ -171,7 +171,7 @@ class Chef
             action :create
           end
         else
-          declare_resource(:template, file_path) do
+          template file_path do
             source ::File.expand_path("../support/sudoer.erb", __FILE__)
             local true
             mode "0440"

data/lib/chef/resource/support/cron.d.erb

@@ -1,4 +1,4 @@
-# Generated by Chef. Changes will be overwritten.
+# Generated by <%= Chef::Dist::PRODUCT %>. Changes will be overwritten.
 <% if @mailto -%>
 MAILTO=<%= @mailto %>
 <% end -%>

data/lib/chef/resource/support/cron_access.erb

@@ -1,4 +1,4 @@
-# Generated by Chef. Changes will be overwritten.
+# Generated by <%= Chef::Dist::PRODUCT %>. Changes will be overwritten.
 <% @users.sort.uniq.each do |user| -%>
 <%= user %>
 <% end -%>

data/lib/chef/resource/support/sudoer.erb

@@ -1,5 +1,4 @@
-# This file is managed by Chef.
-# Do NOT modify this file directly.
+# This file is managed by <%= Chef::Dist::PRODUCT %>. Changes will be overwritten.
 
 <% @command_aliases.each do |a| -%>
 Cmnd_Alias <%= a[:name].upcase %> = <%= a[:command_list].join(', ') %>

data/lib/chef/resource/support/ulimit.erb

@@ -0,0 +1,41 @@
+# Generated by <%= Chef::Dist::PRODUCT %>. Changes will be overwritten.
+
+# Limits settings for <%= @ulimit_user %>
+
+<% unless @filehandle_limit.nil? -%>
+<%= @ulimit_user -%> - nofile <%= @filehandle_limit %>
+<% else -%><% unless @filehandle_soft_limit.nil? -%><%= @ulimit_user -%> soft nofile <%= @filehandle_soft_limit %><% end -%>
+<% unless @filehandle_hard_limit.nil? -%><%= @ulimit_user -%> hard nofile <%= @filehandle_hard_limit %><% end -%>
+<% end -%>
+
+<% unless @process_limit.nil? -%>
+<%= @ulimit_user -%> - nproc <%= @process_limit %>
+<% else -%><% unless @process_soft_limit.nil? -%><%= @ulimit_user -%> soft nproc <%= @process_soft_limit %><% end -%>
+<% unless @process_hard_limit.nil? -%><%= @ulimit_user -%> hard nproc <%= @process_hard_limit %><% end -%>
+<% end -%>
+
+<% unless @memory_limit.nil? -%>
+<%= @ulimit_user -%> - memlock <%= @memory_limit %>
+<% end -%>
+
+<% unless @core_limit.nil? -%>
+<%= @ulimit_user -%> - core <%= @core_limit %>
+<% else -%><% unless @core_soft_limit.nil? -%><%= @ulimit_user -%> soft core <%= @core_soft_limit %><% end -%>
+<% unless @core_hard_limit.nil? -%><%= @ulimit_user -%> hard core <%= @core_hard_limit %><% end -%>
+<% end -%>
+
+<% unless @stack_limit.nil? -%>
+<%= @ulimit_user -%> - stack <%= @stack_limit %>
+<% else -%><% unless @stack_soft_limit.nil? -%><%= @ulimit_user -%> soft stack <%= @stack_soft_limit %><% end -%>
+<% unless @stack_hard_limit.nil? -%><%= @ulimit_user -%> hard stack <%= @stack_hard_limit %><% end -%>
+<% end -%>
+
+<% unless @rtprio_limit.nil? -%>
+<%= @ulimit_user -%> - rtprio <%= @rtprio_limit %>
+<% else -%><% unless @rtprio_soft_limit.nil? -%><%= @ulimit_user -%> soft rtprio <%= @rtprio_soft_limit %><% end -%>
+<% unless @rtprio_hard_limit.nil? -%><%= @ulimit_user -%> hard rtprio <%= @rtprio_hard_limit %><% end -%>
+<% end -%>
+
+<% unless @virt_limit.nil? -%>
+  <%= @ulimit_user -%> - as <%= @virt_limit %>
+<% end -%>

data/lib/chef/resource/swap_file.rb

@@ -20,10 +20,11 @@ require_relative "../resource"
 class Chef
   class Resource
     class SwapFile < Chef::Resource
-      resource_name :swap_file
+      unified_mode true
+
       provides(:swap_file) { true }
 
-      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."
+      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"
 
       property :path, String,
@@ -38,8 +39,9 @@ class Chef
         default: false
 
       property :timeout, Integer,
-        description: "Timeout for 'dd' / 'fallocate' commands.",
-        default: 600
+        description: "Timeout for `dd` / `fallocate` commands.",
+        default: 600,
+        desired_state: false
 
       property :swappiness, Integer,
         description: "The swappiness value to set on the system."
@@ -60,7 +62,7 @@ class Chef
           end
         end
         if new_resource.swappiness
-          declare_resource(:sysctl, "vm.swappiness") do
+          sysctl "vm.swappiness" do
             value new_resource.swappiness
           end
         end

data/lib/chef/resource/sysctl.rb

@@ -20,15 +20,75 @@ require_relative "../resource"
 class Chef
   class Resource
     class Sysctl < Chef::Resource
-      resource_name :sysctl
+      unified_mode true
+
       provides(:sysctl) { true }
       provides(:sysctl_param) { true }
 
-      description "Use the sysctl resource to set or remove kernel parameters using the sysctl"\
+      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. If"\
                   " an existing value was already set for the value it will be backed up to the node"\
                   " and restored if the :remove action is used later."
+      examples <<~DOC
+      **Set vm.swappiness**:
+
+      ```ruby
+      sysctl 'vm.swappiness' do
+        value 19
+      end
+      ```
+
+      **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.
+
+      ```ruby
+      sysctl 'kernel.msgmax' do
+        action :remove
+      end
+      ```
+
+      **Adding Comments to sysctl configuration files**:
+
+      ```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:
+
+      ```
+      # define how aggressively the kernel will swap memory pages.
+      vm.swappiness = 1
+      ```
+
+      **Converting sysctl settings from shell scripts**:
+
+      Example of existing settings:
+
+      ```bash
+      fs.aio-max-nr = 1048576 net.ipv4.ip_local_port_range = 9000 65500 kernel.sem = 250 32000 100 128
+      ```
+
+      Converted to sysctl resources:
+
+      ```ruby
+      sysctl 'fs.aio-max-nr' do
+        value '1048576'
+      end
+
+      sysctl 'net.ipv4.ip_local_port_range' do
+        value '9000 65500'
+      end
+
+      sysctl 'kernel.sem' do
+        value '250 32000 100 128'
+      end
+      ```
+      DOC
 
       introduced "14.0"
 
@@ -43,7 +103,7 @@ class Chef
       property :value, [Array, String, Integer, Float],
         description: "The value to set.",
         coerce: proc { |v| coerce_value(v) },
-        required: true
+        required: [:apply]
 
       property :comment, [Array, String],
         description: "Comments, placed above the resource setting in the generated file. For multi-line comments, use an array of strings, one per line.",
@@ -56,7 +116,6 @@ class Chef
 
       def after_created
         raise "The sysctl resource requires Linux as it needs sysctl and the sysctl.d directory functionality." unless node["os"] == "linux"
-        raise "The sysctl resource does not support SLES releases less than 12 as it requires a sysctl.d directory" if platform_family?("suse") && node["platform_version"].to_i < 12
       end
 
       def coerce_value(v)