chef 14.2.0 → 14.3.37

data/lib/chef/resource/template.rb

@@ -53,7 +53,7 @@ class Chef
         set_or_return(
           :source,
           file,
-          :kind_of => [ String, Array ]
+          kind_of: [ String, Array ]
         )
       end
 

data/lib/chef/resource/user.rb

@@ -51,7 +51,7 @@ class Chef
         set_or_return(
           :username,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -59,7 +59,7 @@ class Chef
         set_or_return(
           :comment,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -67,8 +67,8 @@ class Chef
         set_or_return(
           :uid,
           arg,
-          :kind_of => [ String, Integer, NilClass ],
-          :coerce => proc { |x| x || nil }
+          kind_of: [ String, Integer, NilClass ],
+          coerce: proc { |x| x || nil }
         )
       end
 
@@ -76,8 +76,8 @@ class Chef
         set_or_return(
           :gid,
           arg,
-          :kind_of => [ String, Integer, NilClass ],
-          :coerce => proc { |x| x || nil }
+          kind_of: [ String, Integer, NilClass ],
+          coerce: proc { |x| x || nil }
         )
       end
 
@@ -87,7 +87,7 @@ class Chef
         set_or_return(
           :home,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -95,7 +95,7 @@ class Chef
         set_or_return(
           :shell,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -103,7 +103,7 @@ class Chef
         set_or_return(
           :password,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -111,7 +111,7 @@ class Chef
         set_or_return(
           :salt,
           arg,
-          :kind_of => [ String ]
+          kind_of: [ String ]
         )
       end
 
@@ -119,7 +119,7 @@ class Chef
         set_or_return(
           :iterations,
           arg,
-          :kind_of => [ Integer ]
+          kind_of: [ Integer ]
         )
       end
 
@@ -127,7 +127,7 @@ class Chef
         set_or_return(
           :system,
           arg,
-          :kind_of => [ TrueClass, FalseClass ]
+          kind_of: [ TrueClass, FalseClass ]
         )
       end
 
@@ -135,7 +135,7 @@ class Chef
         set_or_return(
           :manage_home,
           arg,
-          :kind_of => [ TrueClass, FalseClass ]
+          kind_of: [ TrueClass, FalseClass ]
         )
       end
 
@@ -143,7 +143,7 @@ class Chef
         set_or_return(
           :force,
           arg,
-          :kind_of => [ TrueClass, FalseClass ]
+          kind_of: [ TrueClass, FalseClass ]
         )
       end
 
@@ -151,7 +151,7 @@ class Chef
         set_or_return(
           :non_unique,
           arg,
-          :kind_of => [ TrueClass, FalseClass ]
+          kind_of: [ TrueClass, FalseClass ]
         )
       end
     end

data/lib/chef/resource/windows_feature_dism.rb

@@ -17,6 +17,7 @@
 #
 
 require "chef/resource"
+require "chef/platform/query_helpers"
 
 class Chef
   class Resource
@@ -30,7 +31,7 @@ class Chef
 
       property :feature_name, [Array, String],
                description: "The name of the feature/role(s) to install if it differs from the resource name.",
-               coerce: proc { |x| to_lowercase_array(x) },
+               coerce: proc { |x| to_formatted_array(x) },
                name_property: true
 
       property :source, String,
@@ -44,12 +45,12 @@ class Chef
                description: "Specifies a timeout (in seconds) for feature install.",
                default: 600
 
-      def to_lowercase_array(x)
+      # @return [Array] lowercase the array unless we're on < Windows 2012
+      def to_formatted_array(x)
         x = x.split(/\s*,\s*/) if x.is_a?(String) # split multiple forms of a comma separated list
 
-        # dism on windows < 2012 is case sensitive so only downcase when on 2012+
-        # @todo when we're really ready to remove support for Windows 2008 R2 this check can go away
-        node["platform_version"].to_f < 6.2 ? x : x.map(&:downcase)
+        # feature installs on windows < 2012 are case sensitive so only downcase when on 2012+
+        older_than_win_2012_or_8? ? x : x.map(&:downcase)
       end
 
       action :install do
@@ -116,7 +117,7 @@ class Chef
         def features_to_install
           @install ||= begin
             # disabled features are always available to install
-            available_for_install = node["dism_features_cache"]["disabled"]
+            available_for_install = node["dism_features_cache"]["disabled"].dup
 
             # if the user passes a source then removed features are also available for installation
             available_for_install.concat(node["dism_features_cache"]["removed"]) if new_resource.source
@@ -200,7 +201,7 @@ class Chef
           # dism on windows 2012+ isn't case sensitive so it's best to compare
           # lowercase lists so the user input doesn't need to be case sensitive
           # @todo when we're ready to remove windows 2008R2 the gating here can go away
-          feature_details.downcase! unless node["platform_version"].to_f < 6.2
+          feature_details.downcase! unless older_than_win_2012_or_8?
           node.override["dism_features_cache"][feature_type] << feature_details
         end
 
@@ -208,7 +209,7 @@ class Chef
         # @return [void]
         def fail_if_removed
           return if new_resource.source # if someone provides a source then all is well
-          if node["platform_version"].to_f > 6.2
+          if node["platform_version"].to_f > 6.2 # 2012R2 or later
             return if registry_key_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing') && registry_value_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing', name: "LocalSourcePath") # if source is defined in the registry, still fine
           end
           removed = new_resource.feature_name & node["dism_features_cache"]["removed"]
@@ -218,7 +219,7 @@ class Chef
         # Fail unless we're on windows 8+ / 2012+ where deleting a feature is supported
         # @return [void]
         def raise_if_delete_unsupported
-          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not support on Windows releases before Windows 8/2012. Cannot continue!" unless node["platform_version"].to_f >= 6.2
+          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not supported on Windows releases before Windows 8/2012. Cannot continue!" if older_than_win_2012_or_8?
         end
       end
     end

data/lib/chef/resource/windows_feature_powershell.rb

@@ -19,6 +19,7 @@
 require "chef/mixin/powershell_out"
 require "chef/json_compat"
 require "chef/resource"
+require "chef/platform/query_helpers"
 
 class Chef
   class Resource
@@ -35,7 +36,7 @@ class Chef
 
       property :feature_name, [Array, String],
                description: "The name of the feature/role(s) to install if it differs from the resource name.",
-               coerce: proc { |x| to_lowercase_array(x) },
+               coerce: proc { |x| to_formatted_array(x) },
                name_property: true
 
       property :source, String,
@@ -54,9 +55,13 @@ class Chef
                description: "",
                default: false
 
-      def to_lowercase_array(x)
+      # Converts strings of features into an Array. Array objects are lowercased unless we're on < 8/2k12+.
+      # @return [Array] array of features
+      def to_formatted_array(x)
         x = x.split(/\s*,\s*/) if x.is_a?(String) # split multiple forms of a comma separated list
-        x.map(&:downcase)
+
+        # feature installs on windows < 8/2012 are case sensitive so only downcase when on 2012+
+        older_than_win_2012_or_8? ? x : x.map(&:downcase)
       end
 
       include Chef::Mixin::PowershellOut
@@ -73,8 +78,8 @@ class Chef
           converge_by("install Windows feature#{'s' if features_to_install.count > 1} #{features_to_install.join(',')}") do
             install_command = "#{install_feature_cmdlet} #{features_to_install.join(',')}"
             install_command << " -IncludeAllSubFeature"  if new_resource.all
-            if node["platform_version"].to_f < 6.2 && (new_resource.source || new_resource.management_tools)
-              Chef::Log.warn("The 'source' and 'management_tools' properties are not available on Windows 2012R2 or great. Skipping these properties!")
+            if older_than_win_2012_or_8? && (new_resource.source || new_resource.management_tools)
+              Chef::Log.warn("The 'source' and 'management_tools' properties are only available on Windows 8/2012 or greater. Skipping these properties!")
             else
               install_command << " -Source \"#{new_resource.source}\"" if new_resource.source
               install_command << " -IncludeManagementTools" if new_resource.management_tools
@@ -144,16 +149,20 @@ class Chef
         # @raise [RuntimeError] Raise if powershell is < 3.0
         def raise_on_old_powershell
           # be super defensive about the powershell lang plugin not being there
-          return if node["languages"] && node["languages"]["powershell"] && node["languages"]["powershell"]["version"].to_i > 3
+          return if node["languages"] && node["languages"]["powershell"] && node["languages"]["powershell"]["version"].to_i >= 3
           raise "The windows_feature_powershell resource requires PowerShell 3.0 or later. Please install PowerShell 3.0+ before running this resource." if powershell_version < 3
         end
 
+        # The appropriate cmdlet to install a windows feature based on windows release
+        # @return [String]
         def install_feature_cmdlet
-          node["platform_version"].to_f < 6.2 ? "Import-Module ServerManager; Add-WindowsFeature" : "Install-WindowsFeature"
+          older_than_win_2012_or_8? ? "Add-WindowsFeature" : "Install-WindowsFeature"
         end
 
+        # The appropriate cmdlet to remove a windows feature based on windows release
+        # @return [String]
         def remove_feature_cmdlet
-          node["platform_version"].to_f < 6.2 ? "Import-Module ServerManager; Remove-WindowsFeature" : "Uninstall-WindowsFeature"
+          older_than_win_2012_or_8? ? "Remove-WindowsFeature" : "Uninstall-WindowsFeature"
         end
 
         # @return [Array] features the user has requested to install which need installation
@@ -220,8 +229,9 @@ class Chef
         # fetch the list of available feature names and state in JSON and parse the JSON
         def parsed_feature_list
           # Grab raw feature information from dism command line
-          raw_list_of_features = if node["platform_version"].to_f < 6.2
-                                   powershell_out!("Import-Module ServerManager; Get-WindowsFeature | Select-Object -Property Name,InstallState | ConvertTo-Json -Compress", timeout: new_resource.timeout).stdout
+          # Windows < 2012 doesn't present a state value so we have to check if the feature is installed or not
+          raw_list_of_features = if older_than_win_2012_or_8? # make the older format look like the new format, warts and all
+                                   powershell_out!('Get-WindowsFeature | Select-Object -Property Name, @{Name=\"InstallState\"; Expression = {If ($_.Installed) { 1 } Else { 0 }}} | ConvertTo-Json -Compress', timeout: new_resource.timeout).stdout
                                  else
                                    powershell_out!("Get-WindowsFeature | Select-Object -Property Name,InstallState | ConvertTo-Json -Compress", timeout: new_resource.timeout).stdout
                                  end
@@ -232,14 +242,15 @@ class Chef
         # add the features values to the appropriate array
         # @return [void]
         def add_to_feature_mash(feature_type, feature_details)
-          node.override["powershell_features_cache"][feature_type] << feature_details.downcase # lowercase so we can compare properly
+          # add the lowercase feature name to the mash unless we're on < 2012 where they're case sensitive
+          node.override["powershell_features_cache"][feature_type] << (older_than_win_2012_or_8? ? feature_details : feature_details.downcase)
         end
 
         # Fail if any of the packages are in a removed state
         # @return [void]
         def fail_if_removed
           return if new_resource.source # if someone provides a source then all is well
-          if node["platform_version"].to_f > 6.2
+          if node["platform_version"].to_f > 6.2 # 2012R2 or later
             return if registry_key_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing') && registry_value_exists?('HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Servicing', name: "LocalSourcePath") # if source is defined in the registry, still fine
           end
           removed = new_resource.feature_name & node["powershell_features_cache"]["removed"]
@@ -248,7 +259,7 @@ class Chef
 
         # Fail unless we're on windows 8+ / 2012+ where deleting a feature is supported
         def raise_if_delete_unsupported
-          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not support on Windows releases before Windows 8/2012. Cannot continue!" unless node["platform_version"].to_f >= 6.2
+          raise Chef::Exceptions::UnsupportedAction, "#{self} :delete action not supported on Windows releases before Windows 8/2012. Cannot continue!" if older_than_win_2012_or_8?
         end
       end
     end

data/lib/chef/resource/windows_script.rb

@@ -45,7 +45,7 @@ class Chef
         result = set_or_return(
           :architecture,
           arg,
-          :kind_of => Symbol
+          kind_of: Symbol
         )
       end
 

data/lib/chef/resource/windows_service.rb

@@ -28,10 +28,10 @@ class Chef
         automatic: SERVICE_AUTO_START,
         manual: SERVICE_DEMAND_START,
         disabled: SERVICE_DISABLED,
-      }
+      }.freeze
 
       # Until #1773 is resolved, you need to manually specify the windows_service resource
-      # to use action :configure_startup and attribute startup_type
+      # to use action :configure_startup and properties startup_type
 
       provides(:windows_service) { true }
       provides :service, os: "windows"

data/lib/chef/resource/windows_task.rb

@@ -63,10 +63,10 @@ class Chef
       attr_accessor :exists, :task, :command_arguments
 
       SYSTEM_USERS = ['NT AUTHORITY\SYSTEM', "SYSTEM", 'NT AUTHORITY\LOCALSERVICE', 'NT AUTHORITY\NETWORKSERVICE', 'BUILTIN\USERS', "USERS"].freeze
-      VALID_WEEK_DAYS = %w{ mon tue wed thu fri sat sun * }
+      VALID_WEEK_DAYS = %w{ mon tue wed thu fri sat sun * }.freeze
       VALID_DAYS_OF_MONTH = ("1".."31").to_a << "last" << "lastday"
-      VALID_MONTHS = %w{JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC *}
-      VALID_WEEKS = %w{FIRST SECOND THIRD FOURTH LAST LASTDAY}
+      VALID_MONTHS = %w{JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC *}.freeze
+      VALID_WEEKS = %w{FIRST SECOND THIRD FOURTH LAST LASTDAY}.freeze
 
       def after_created
         if random_delay

data/lib/chef/resource_definition.rb

@@ -62,7 +62,7 @@ class Chef
     end
 
     def to_s
-      "#{name}"
+      (name).to_s
     end
   end
 end

data/lib/chef/resource_inspector.rb

@@ -43,6 +43,7 @@ module ResourceInspector
     data[:actions] = resource.allowed_actions
     data[:examples] = resource.examples
     data[:introduced] = resource.introduced
+    data[:preview] = resource.preview_resource
 
     properties = unless complete
                    resource.properties.reject { |_, k| k.options[:declared_in] == Chef::Resource }

data/lib/chef/resource_reporter.rb

@@ -72,7 +72,7 @@ class Chef
         as_hash["result"] = action.to_s
         if success?
         else
-          #as_hash["result"] = "failed"
+          # as_hash["result"] = "failed"
         end
         if new_resource.cookbook_name
           as_hash["cookbook_name"] = new_resource.cookbook_name
@@ -96,7 +96,7 @@ class Chef
     attr_reader :exception
     attr_reader :error_descriptions
 
-    PROTOCOL_VERSION = "0.1.0"
+    PROTOCOL_VERSION = "0.1.0".freeze
 
     def initialize(rest_client)
       if Chef::Config[:enable_reporting] && !Chef::Config[:why_run]
@@ -120,8 +120,8 @@ class Chef
       if reporting_enabled?
         begin
           resource_history_url = "reports/nodes/#{node_name}/runs"
-          server_response = @rest_client.post(resource_history_url, { :action => :start, :run_id => run_id,
-                                                                      :start_time => start_time.to_s }, headers)
+          server_response = @rest_client.post(resource_history_url, { action: :start, run_id: run_id,
+                                                                      start_time: start_time.to_s }, headers)
         rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
           handle_error_starting_run(e, resource_history_url)
         end

data/lib/chef/resources.rb

@@ -27,7 +27,9 @@ require "chef/resource/build_essential"
 require "chef/resource/cookbook_file"
 require "chef/resource/chef_gem"
 require "chef/resource/chef_handler"
+require "chef/resource/chocolatey_config"
 require "chef/resource/chocolatey_package"
+require "chef/resource/chocolatey_source"
 require "chef/resource/cron"
 require "chef/resource/csh"
 require "chef/resource/directory"
@@ -49,6 +51,7 @@ require "chef/resource/homebrew_cask"
 require "chef/resource/homebrew_package"
 require "chef/resource/homebrew_tap"
 require "chef/resource/ifconfig"
+require "chef/resource/kernel_module"
 require "chef/resource/ksh"
 require "chef/resource/launchd"
 require "chef/resource/link"
@@ -68,6 +71,7 @@ require "chef/resource/pacman_package"
 require "chef/resource/paludis_package"
 require "chef/resource/perl"
 require "chef/resource/portage_package"
+require "chef/resource/powershell_package_source"
 require "chef/resource/powershell_script"
 require "chef/resource/osx_profile"
 require "chef/resource/python"
@@ -92,6 +96,7 @@ require "chef/resource/sudo"
 require "chef/resource/sysctl"
 require "chef/resource/swap_file"
 require "chef/resource/systemd_unit"
+require "chef/resource/ssh_known_hosts_entry"
 require "chef/resource/windows_service"
 require "chef/resource/subversion"
 require "chef/resource/smartos_package"

data/lib/chef/role.rb

@@ -55,7 +55,7 @@ class Chef
       set_or_return(
         :name,
         arg,
-        :regex => /^[\-[:alnum:]_]+$/
+        regex: /^[\-[:alnum:]_]+$/
       )
     end
 
@@ -63,7 +63,7 @@ class Chef
       set_or_return(
         :description,
         arg,
-        :kind_of => String
+        kind_of: String
       )
     end
 
@@ -86,7 +86,7 @@ class Chef
     end
 
     def active_run_list_for(environment)
-      @env_run_lists.has_key?(environment) ? environment : "_default"
+      @env_run_lists.key?(environment) ? environment : "_default"
     end
 
     # Per environment run lists
@@ -118,7 +118,7 @@ class Chef
       set_or_return(
         :default_attributes,
         arg,
-        :kind_of => Hash
+        kind_of: Hash
       )
     end
 
@@ -126,7 +126,7 @@ class Chef
       set_or_return(
         :override_attributes,
         arg,
-        :kind_of => Hash
+        kind_of: Hash
       )
     end
 
@@ -141,8 +141,8 @@ class Chef
         "override_attributes" => @override_attributes,
         "chef_type" => "role",
 
-        #Render to_json correctly for run_list items (both run_list and evn_run_lists)
-        #so malformed json does not result
+        # Render to_json correctly for run_list items (both run_list and evn_run_lists)
+        # so malformed json does not result
         "run_list" => run_list.run_list.map { |item| item.to_s },
         "env_run_lists" => env_run_lists_without_default.inject({}) do |accumulator, (k, v)|
           accumulator[k] = v.map { |x| x.to_s }
@@ -175,7 +175,7 @@ class Chef
 
       # _default run_list is in 'run_list' for newer clients, and
       # 'recipes' for older clients.
-      env_run_list_hash = { "_default" => (o.has_key?("run_list") ? o["run_list"] : o["recipes"]) }
+      env_run_list_hash = { "_default" => (o.key?("run_list") ? o["run_list"] : o["recipes"]) }
 
       # Clients before 0.10 do not include env_run_lists, so only
       # merge if it's there.