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

data/lib/chef/resource/http_request.rb

@@ -24,10 +24,9 @@ class Chef
     class HttpRequest < Chef::Resource
       unified_mode true
 
-      resource_name :http_request
       provides :http_request
 
-      description "Use the http_request resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
+      description "Use the **http_request** resource to send an HTTP request (GET, PUT, POST, DELETE, HEAD, or OPTIONS) with an arbitrary message. This resource is often useful when custom callbacks are necessary."
 
       default_action :get
       allowed_actions :get, :patch, :put, :post, :delete, :head, :options

data/lib/chef/resource/ifconfig.rb

@@ -28,9 +28,9 @@ class Chef
     class Ifconfig < Chef::Resource
       unified_mode true
 
-      resource_name :ifconfig
+      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."
 
       state_attrs :inet_addr, :mask
 
@@ -45,11 +45,11 @@ class Chef
         description: "The hardware address for the network interface."
 
       property :mask, String,
-        description: "The decimal representation of the network mask. For example: 255.255.255.0."
+        description: "The decimal representation of the network mask. For example: `255.255.255.0`."
 
       property :family, String, default: "inet",
-               introduced: "14.0",
-               description: "Networking family option for Debian-based systems; for example: inet or inet6."
+        introduced: "14.0",
+        description: "Networking family option for Debian-based systems; for example: `inet` or `inet6`."
 
       property :inet_addr, String,
         description: "The Internet host address for the network interface."
@@ -81,11 +81,11 @@ class Chef
 
       property :ethtool_opts, String,
         introduced: "13.4",
-        description: "Options to be passed to ethtool(8). For example: -A eth0 autoneg off rx off tx off."
+        description: "Options to be passed to ethtool(8). For example: `-A eth0 autoneg off rx off tx off`."
 
       property :bonding_opts, String,
         introduced: "13.4",
-        description: "Bonding options to pass via BONDING_OPTS on RHEL and CentOS. For example: mode=active-backup miimon=100."
+        description: "Bonding options to pass via `BONDING_OPTS` on RHEL and CentOS. For example: `mode=active-backup miimon=100`."
 
       property :master, String,
         introduced: "13.4",
@@ -93,7 +93,7 @@ class Chef
 
       property :slave, String,
         introduced: "13.4",
-        description: "When set to yes, this device is controlled by the channel bonding interface that is specified via the master property."
+        description: "When set to `yes`, this device is controlled by the channel bonding interface that is specified via the `master` property."
 
       property :vlan, String,
         introduced: "14.4",

data/lib/chef/resource/ips_package.rb

@@ -22,14 +22,22 @@ require_relative "../provider/package/ips"
 class Chef
   class Resource
     class IpsPackage < ::Chef::Resource::Package
-      resource_name :ips_package
-      provides :package, os: "solaris2"
+      unified_mode true
+
       provides :ips_package
+      provides :package, os: "solaris2"
 
-      description "Use the ips_package resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
+      description "Use the **ips_package** resource to manage packages (using Image Packaging System (IPS)) on the Solaris 11 platform."
 
       allowed_actions :install, :remove, :upgrade
 
+      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."
+
       property :accept_license, [TrueClass, FalseClass],
         default: false, desired_state: false,
         description: "Accept an end-user license agreement, automatically."

data/lib/chef/resource/kernel_module.rb

@@ -5,16 +5,17 @@
 #
 # Copyright:: 2016-2018, Shopify Inc.
 # Copyright:: Copyright (c) Chef Software Inc.
-#
 
 require_relative "../resource"
 
 class Chef
   class Resource
     class KernelModule < Chef::Resource
-      resource_name :kernel_module
+      unified_mode true
+
+      provides :kernel_module
 
-      description "Use the kernel_module resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
+      description "Use the **kernel_module** resource to manage kernel modules on Linux systems. This resource can load, unload, blacklist, disable, install, and uninstall modules."
       introduced "14.3"
       examples <<~DOC
         Install and load a kernel module, and ensure it loads on reboot.
@@ -65,7 +66,7 @@ class Chef
 
       property :modname, String,
         description: "An optional property to set the kernel module name if it differs from the resource block's name.",
-        name_property: true, identity: true
+        name_property: true
 
       property :options, Array,
         description: "An optional property to set options for the kernel module.",
@@ -82,15 +83,22 @@ class Chef
       action :install do
         description "Load kernel module, and ensure it loads on reboot."
 
+        with_run_context :root do
+          find_resource(:execute, "update initramfs") do
+            command initramfs_command
+            action :nothing
+          end
+        end
+
         # create options file before loading the module
         unless new_resource.options.nil?
           file "#{new_resource.unload_dir}/options_#{new_resource.modname}.conf" do
             content "options #{new_resource.modname} #{new_resource.options.join(" ")}\n"
-          end.run_action(:create)
+          end
         end
 
         # load the module first before installing
-        new_resource.run_action(:load)
+        action_load
 
         directory new_resource.load_dir do
           recursive true
@@ -100,17 +108,16 @@ class Chef
           content "#{new_resource.modname}\n"
           notifies :run, "execute[update initramfs]", :delayed
         end
+      end
 
+      action :uninstall do
+        description "Unload a kernel module and remove module config, so it doesn't load on reboot."
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
             action :nothing
           end
         end
-      end
-
-      action :uninstall do
-        description "Unload a kernel module and remove module config, so it doesn't load on reboot."
 
         file "#{new_resource.load_dir}/#{new_resource.modname}.conf" do
           action :delete
@@ -126,24 +133,12 @@ class Chef
           action :delete
         end
 
-        with_run_context :root do
-          find_resource(:execute, "update initramfs") do
-            command initramfs_command
-            action :nothing
-          end
-        end
-
-        new_resource.run_action(:unload)
+        action_unload
       end
 
       action :blacklist do
         description "Blacklist a kernel module."
 
-        file "#{new_resource.unload_dir}/blacklist_#{new_resource.modname}.conf" do
-          content "blacklist #{new_resource.modname}"
-          notifies :run, "execute[update initramfs]", :delayed
-        end
-
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
@@ -151,17 +146,17 @@ class Chef
           end
         end
 
-        new_resource.run_action(:unload)
+        file "#{new_resource.unload_dir}/blacklist_#{new_resource.modname}.conf" do
+          content "blacklist #{new_resource.modname}"
+          notifies :run, "execute[update initramfs]", :delayed
+        end
+
+        action_unload
       end
 
       action :disable do
         description "Disable a kernel module."
 
-        file "#{new_resource.unload_dir}/disable_#{new_resource.modname}.conf" do
-          content "install #{new_resource.modname} /bin/false"
-          notifies :run, "execute[update initramfs]", :delayed
-        end
-
         with_run_context :root do
           find_resource(:execute, "update initramfs") do
             command initramfs_command
@@ -169,7 +164,12 @@ class Chef
           end
         end
 
-        new_resource.run_action(:unload)
+        file "#{new_resource.unload_dir}/disable_#{new_resource.modname}.conf" do
+          content "install #{new_resource.modname} /bin/false"
+          notifies :run, "execute[update initramfs]", :delayed
+        end
+
+        action_unload
       end
 
       action :load do

data/lib/chef/resource/ksh.rb

@@ -23,7 +23,9 @@ class Chef
     class Ksh < Chef::Resource::Script
       unified_mode true
 
-      description "Use the ksh resource to execute scripts using the Korn shell (ksh)"\
+      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"\

data/lib/chef/resource/launchd.rb

@@ -21,17 +21,17 @@ require_relative "../resource"
 class Chef
   class Resource
     class Launchd < Chef::Resource
-      resource_name :launchd
+      unified_mode true
       provides :launchd
 
-      description "Use the launchd resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
+      description "Use the **launchd** resource to manage system-wide services (daemons) and per-user services (agents) on the macOS platform."
       introduced "12.8"
 
       default_action :create
       allowed_actions :create, :create_if_missing, :delete, :enable, :disable, :restart
 
       property :label, String,
-        identity: true, name_property: true,
+        name_property: true,
         description: "The unique identifier for the job."
 
       property :backup, [Integer, FalseClass],

data/lib/chef/resource/link.rb

@@ -26,17 +26,16 @@ class Chef
       include Chef::Mixin::Securable
       unified_mode true
 
-      resource_name :link
       provides :link
 
-      description "Use the link resource to create symbolic or hard links.\n\n"\
+      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"\
+                  " 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.”"\
+                  " 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
@@ -44,14 +43,9 @@ class Chef
       default_action :create
       allowed_actions :create, :delete
 
-      def initialize(name, run_context = nil)
-        verify_links_supported!
-        super
-      end
-
       property :target_file, String,
         description: "An optional property to set the target file if it differs from the resource block's name.",
-        name_property: true, identity: true
+        name_property: true
 
       property :to, String,
         description: "The actual file to which the link is to be created."
@@ -73,22 +67,6 @@ class Chef
       def path
         target_file
       end
-
-      private
-
-      # On certain versions of windows links are not supported. Make
-      # sure we are not on such a platform.
-      def verify_links_supported!
-        if ChefUtils.windows?
-          require_relative "../win32/file"
-          begin
-            Chef::ReservedNames::Win32::File.verify_links_supported!
-          rescue Chef::Exceptions::Win32APIFunctionNotImplemented => e
-            Chef::Log.fatal("Link resource is not supported on this version of Windows")
-            raise e
-          end
-        end
-      end
     end
   end
 end

data/lib/chef/resource/locale.rb

@@ -21,23 +21,34 @@ require_relative "../dist"
 class Chef
   class Resource
     class Locale < Chef::Resource
-      resource_name :locale
+      unified_mode true
+      provides :locale
 
-      description "Use the locale resource to set the system's locale."
+      description "Use the **locale** resource to set the system's locale on Debian and Windows systems. Windows support was added in Chef Infra Client 16.0"
       introduced "14.5"
 
-      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
-      LOCALE_CONF = "/etc/locale.conf".freeze
-      LOCALE_REGEX = /\A\S+/.freeze
-      LOCALE_PLATFORM_FAMILIES = %w{debian}.freeze
+      examples <<~DOC
+      Set the lang to 'en_US.UTF-8'
+
+      ```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
+      LOCALE_CONF ||= "/etc/locale.conf".freeze
+      LOCALE_REGEX ||= /\A\S+/.freeze
+      LOCALE_PLATFORM_FAMILIES ||= %w{debian windows}.freeze
 
       property :lang, String,
         description: "Sets the default system language.",
         regex: [LOCALE_REGEX],
-        validation_message: "The provided lang is not valid. It should be a non-empty string without any leading whitespaces."
+        validation_message: "The provided lang is not valid. It should be a non-empty string without any leading whitespace."
 
       property :lc_env, Hash,
-        description: "A Hash of LC_* env variables in the form of ({ 'LC_ENV_VARIABLE' => 'VALUE' }).",
+        description: "A Hash of LC_* env variables in the form of `({ 'LC_ENV_VARIABLE' => 'VALUE' })`.",
         default: lazy { {} },
         coerce: proc { |h|
           if h.respond_to?(:keys)
@@ -48,7 +59,7 @@ class Chef
             end
           end
           unless h.values.all? { |x| x =~ LOCALE_REGEX }
-            error_msg = "Values of option lc_env should be non-empty string without any leading whitespaces."
+            error_msg = "Values of option lc_env should be non-empty string without any leading whitespace."
             raise Chef::Exceptions::ValidationFailed, error_msg
           end
           h
@@ -64,15 +75,32 @@ class Chef
         end
       end
 
+      load_current_value do
+        if windows?
+          lang get_system_locale_windows
+        else
+          begin
+            old_content = ::File.read(LOCALE_CONF)
+            locale_values = Hash[old_content.split("\n").map { |v| v.split("=") }]
+            lang locale_values["LANG"]
+          rescue Errno::ENOENT => e
+            false
+          end
+        end
+      end
+
+      # Gets the System-locale setting for the current computer.
+      # @see https://docs.microsoft.com/en-us/powershell/module/international/get-winsystemlocale
+      # @return [String] the current value of the System-locale setting.
+      #
+      def get_system_locale_windows
+        powershell_exec("Get-WinSystemLocale").result["Name"]
+      end
+
       action :update do
         description "Update the system's locale."
-        begin
-          unless up_to_date?
-            converge_by "Updating System Locale" do
-              generate_locales unless unavailable_locales.empty?
-              update_locale
-            end
-          end
+        converge_if_changed do
+          set_system_locale
         end
       end
 
@@ -92,7 +120,7 @@ class Chef
           end
         end
 
-        # Generates the localisation files from templates using locale-gen.
+        # Generates the localization files from templates using locale-gen.
         # @see http://manpages.ubuntu.com/manpages/cosmic/man8/locale-gen.8.html
         # @raise [Mixlib::ShellOut::ShellCommandFailed] not a supported language or locale
         #
@@ -100,6 +128,21 @@ class Chef
           shell_out!("locale-gen #{unavailable_locales.join(" ")}")
         end
 
+        # Sets the system locale for the current computer.
+        #
+        def set_system_locale
+          if windows?
+            # Sets the system locale for the current computer.
+            # @see https://docs.microsoft.com/en-us/powershell/module/internationalcmdlets/set-winsystemlocale
+            #
+            response = powershell_exec("Set-WinSystemLocale -SystemLocale #{new_resource.lang}")
+            raise response.errors.join(" ") if response.error?
+          else
+            generate_locales unless unavailable_locales.empty?
+            update_locale
+          end
+        end
+
         # Updates system locale by appropriately writing them in /etc/locale.conf
         # @note This locale change won't affect the current run. At this time it is an exercise
         # left to the user to restart or reboot if the locale change is required at
@@ -135,15 +178,6 @@ class Chef
             content.sort.map { |t| t.join("=") }.join("\n") + "\n"
           end
         end
-
-        # @return [Boolean] Whether any modification is required in /etc/locale.conf
-        #
-        def up_to_date?
-          old_content = ::File.read(LOCALE_CONF)
-          new_content == old_content
-        rescue
-          false # We need to create the file if it is not present
-        end
       end
     end
   end