chef 15.10.12 → 15.11.3

data/lib/chef/knife/bootstrap/templates/windows-chef-client-msi.erb

@@ -202,10 +202,12 @@ If !ERRORLEVEL!==0 (
   ) else (
       @echo Installation completed successfully
       del /f /q "%CHEF_CLIENT_MSI_LOG_PATH%"
-    )
+  )
 
 <% end %>
 
+@rem This line is required to separate the key_create label from the "block boundary"
+@rem Removing these lines will cause the error "The system cannot find the batch label specified - key_create"
 :key_create
 @endlocal
 

data/lib/chef/knife/cookbook_site_search.rb

@@ -24,7 +24,7 @@ class Chef
   class Knife
     class CookbookSiteSearch < Knife::SupermarketSearch
 
-    # Handle the subclassing (knife doesn't do this :()
+      # Handle the subclassing (knife doesn't do this :()
       dependency_loaders.concat(superclass.dependency_loaders)
 
       banner "knife cookbook site search QUERY (options)"

data/lib/chef/knife/cookbook_site_show.rb

@@ -24,7 +24,7 @@ class Chef
   class Knife
     class CookbookSiteShow < Knife::SupermarketShow
 
-    # Handle the subclassing (knife doesn't do this :()
+      # Handle the subclassing (knife doesn't do this :()
       dependency_loaders.concat(superclass.dependency_loaders)
 
       banner "knife cookbook site show COOKBOOK [VERSION] (options)"

data/lib/chef/knife/cookbook_site_unshare.rb

@@ -25,7 +25,7 @@ class Chef
   class Knife
     class CookbookSiteUnshare < Knife::SupermarketUnshare
 
-    # Handle the subclassing (knife doesn't do this :()
+      # Handle the subclassing (knife doesn't do this :()
       dependency_loaders.concat(superclass.dependency_loaders)
 
       banner "knife cookbook site unshare COOKBOOK (options)"

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -39,6 +39,21 @@ class Chef
           super(config, run_list, chef_config, secret)
         end
 
+        # This is a duplicate of ChefConfig::PathHelper.cleanpath, however
+        # this presumes Windows so we can avoid changing the method definitions
+        # across Chef, ChefConfig, and ChefUtils for the circumstance where
+        # the methods are being run for a system other than the one Ruby is
+        # executing on.
+        #
+        # We only need to cleanpath the paths that we are passing to cmd.exe,
+        # anything written to a configuration file or passed as an argument
+        # will be interpreted by ruby later and do the right thing.
+        def cleanpath(path)
+          path = Pathname.new(path).cleanpath.to_s
+          path = path.gsub(File::SEPARATOR, '\\')
+          path
+        end
+
         def validation_key
           if File.exist?(File.expand_path(@chef_config[:validation_key]))
             IO.read(File.expand_path(@chef_config[:validation_key]))
@@ -158,8 +173,8 @@ class Chef
 
         def start_chef
           bootstrap_environment_option = bootstrap_environment.nil? ? "" : " -E #{bootstrap_environment}"
-          start_chef = "SET \"PATH=%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;#{ChefConfig::Config.c_opscode_dir}\\#{ChefConfig::Dist::DIR_SUFFIX}\\bin;#{ChefConfig::Config.c_opscode_dir}\\#{ChefConfig::Dist::DIR_SUFFIX}\\embedded\\bin\;%PATH%\"\n"
-          start_chef << "chef-client -c #{ChefConfig::Config.etc_chef_dir(true)}/client.rb -j #{ChefConfig::Config.etc_chef_dir(true)}/first-boot.json#{bootstrap_environment_option}\n"
+          start_chef = "SET \"PATH=%SystemRoot%\\system32;%SystemRoot%;%SystemRoot%\\System32\\Wbem;%SYSTEMROOT%\\System32\\WindowsPowerShell\\v1.0\\;C:\\ruby\\bin;#{ChefConfig::Config.c_opscode_dir}\\bin;#{ChefConfig::Config.c_opscode_dir}\\embedded\\bin\;%PATH%\"\n"
+          start_chef << "#{Chef::Dist::CLIENT} -c #{ChefConfig::Config.etc_chef_dir(true)}/client.rb -j #{ChefConfig::Config.etc_chef_dir(true)}/first-boot.json#{bootstrap_environment_option}\n"
         end
 
         def win_wget
@@ -260,7 +275,7 @@ class Chef
         end
 
         def bootstrap_directory
-          ChefConfig::Config.etc_chef_dir(true)
+          cleanpath(ChefConfig::Config.etc_chef_dir(true))
         end
 
         def local_download_path

data/lib/chef/knife/ssh.rb

@@ -547,7 +547,7 @@ class Chef
       end
 
       def get_stripped_unfrozen_value(value)
-        return nil if value.nil?
+        return nil unless value
 
         value.strip
       end

data/lib/chef/mixin/create_path.rb

@@ -53,14 +53,14 @@ class Chef
       private
 
       def create_dir(path)
-          # When doing multithreaded downloads into the file cache, the following
-          # interleaving raises an error here:
-          #
-          # thread1                                     thread2
-          # File.directory?(create_path) <- false
-          #                                             File.directory?(create_path) <- false
-          #                                             Dir.mkdir(create_path)
-          # Dir.mkdir(create_path) <- raises Errno::EEXIST
+        # When doing multithreaded downloads into the file cache, the following
+        # interleaving raises an error here:
+        #
+        # thread1                                     thread2
+        # File.directory?(create_path) <- false
+        #                                             File.directory?(create_path) <- false
+        #                                             Dir.mkdir(create_path)
+        # Dir.mkdir(create_path) <- raises Errno::EEXIST
         Chef::Log.trace("Creating directory #{path}")
         Dir.mkdir(path)
       rescue Errno::EEXIST

data/lib/chef/node/mixin/deep_merge_cache.rb

@@ -19,9 +19,9 @@ class Chef
   class Node
     module Mixin
       module DeepMergeCache
-       # Cache of deep merged values by top-level key.  This is a simple hash which has keys that are the
-       # top-level keys of the node object, and we save the computed deep-merge for that key here.  There is
-       # no cache of subtrees.
+        # Cache of deep merged values by top-level key.  This is a simple hash which has keys that are the
+        # top-level keys of the node object, and we save the computed deep-merge for that key here.  There is
+        # no cache of subtrees.
         attr_accessor :deep_merge_cache
 
         def initialize
@@ -31,10 +31,10 @@ class Chef
           @deep_merge_cache = {}
         end
 
-       # Invalidate a key in the deep_merge_cache.  If called with nil, or no arg, this will invalidate
-       # the entire deep_merge cache.  In the case of the user doing node.default['foo']['bar']['baz']=
-       # that eventually results in a call to reset_cache('foo') here.  A node.default=hash_thing call
-       # must invalidate the entire cache and re-deep-merge the entire node object.
+        # Invalidate a key in the deep_merge_cache.  If called with nil, or no arg, this will invalidate
+        # the entire deep_merge cache.  In the case of the user doing node.default['foo']['bar']['baz']=
+        # that eventually results in a call to reset_cache('foo') here.  A node.default=hash_thing call
+        # must invalidate the entire cache and re-deep-merge the entire node object.
         def reset_cache(path = nil)
           if path.nil?
             deep_merge_cache.clear

data/lib/chef/provider/package/chocolatey.rb

@@ -18,15 +18,16 @@
 require_relative "../package"
 require_relative "../../resource/chocolatey_package"
 require_relative "../../mixin/powershell_out"
+require_relative "../../win32/api/command_line_helper" if ChefUtils.windows?
 
 class Chef
   class Provider
     class Package
       class Chocolatey < Chef::Provider::Package
         include Chef::Mixin::PowershellOut
+        include Chef::ReservedNames::Win32::API::CommandLineHelper if ChefUtils.windows?
 
         provides :chocolatey_package
-
         # Declare that our arguments should be arrays
         use_multipackage_api
 
@@ -209,7 +210,7 @@ class Chef
         # @param include_source [Boolean] should the source parameter be added
         # @return [String] options from new_resource or empty string
         def cmd_args(include_source: true)
-          cmd_args = [ new_resource.options ]
+          cmd_args = new_resource.options.is_a?(String) ? command_line_to_argv_w_helper(new_resource.options) : Array(new_resource.options)
           cmd_args += common_options(include_source: include_source)
           cmd_args
         end

data/lib/chef/provider/service/simple.rb

@@ -117,9 +117,9 @@ class Chef
                 logger.trace("#{@new_resource} is running")
               end
             rescue Mixlib::ShellOut::ShellCommandFailed, SystemCallError
-            # ShellOut sometimes throws different types of Exceptions than ShellCommandFailed.
-            # Temporarily catching different types of exceptions here until we get Shellout fixed.
-            # TODO: Remove the line before one we get the ShellOut fix.
+              # ShellOut sometimes throws different types of Exceptions than ShellCommandFailed.
+              # Temporarily catching different types of exceptions here until we get Shellout fixed.
+              # TODO: Remove the line before one we get the ShellOut fix.
               @status_load_success = false
               @current_resource.running false
               nil

data/lib/chef/provider/windows_task.rb

@@ -426,7 +426,7 @@ class Chef
             when TaskScheduler::AT_LOGON
               # TODO: handle option for this trigger
             when TaskScheduler::AT_SYSTEMSTART
-              # TODO: handle option for this trigger
+            # TODO: handle option for this trigger
           end
         end
 

data/lib/chef/resource/build_essential.rb

@@ -60,7 +60,7 @@ class Chef
          when fedora_derived?
            package %w{ autoconf bison flex gcc gcc-c++ gettext kernel-devel make m4 ncurses-devel patch }
 
-          # Ensure GCC 4 is available on older pre-6 EL
+           # Ensure GCC 4 is available on older pre-6 EL
            package %w{ gcc44 gcc44-c++ } if platform_family?("rhel") && node["platform_version"].to_i < 6
         when freebsd?
           package "devel/gmake"

data/lib/chef/resource/launchd.rb

@@ -76,20 +76,20 @@ class Chef
       property :start_calendar_interval, [Hash, Array],
         description: "A Hash (similar to crontab) that defines the calendar frequency at which a job is started or an Array.",
         coerce: proc { |type|
-                  # Coerce into an array of hashes to make validation easier
+          # Coerce into an array of hashes to make validation easier
           array = if type.is_a?(Array)
                     type
                   else
                     [type]
                   end
 
-                  # Check to make sure that our array only has hashes
+          # Check to make sure that our array only has hashes
           unless array.all? { |obj| obj.is_a?(Hash) }
             error_msg = "start_calendar_interval must be a single hash or an array of hashes!"
             raise Chef::Exceptions::ValidationFailed, error_msg
           end
 
-                  # Make sure the hashes don't have any incorrect keys/values
+          # Make sure the hashes don't have any incorrect keys/values
           array.each do |entry|
             allowed_keys = %w{Minute Hour Day Weekday Month}
             unless entry.keys.all? { |key| allowed_keys.include?(key) }
@@ -105,7 +105,7 @@ class Chef
             end
           end
 
-                  # Don't return array if we only have one entry
+          # Don't return array if we only have one entry
           if array.size == 1
             array.first
           else

data/lib/chef/resource/macos_userdefaults.rb

@@ -61,9 +61,9 @@ class Chef
         desired_state: false,
         skip_docs: true
 
-       # coerce various ways of representing a boolean into either 0 (false) or 1 (true)
-       # which is what the defaults CLI expects. Why? Well defaults itself accepts a few
-       # different formats, but when you do a read command it all comes back as 1 or 0.
+      # coerce various ways of representing a boolean into either 0 (false) or 1 (true)
+      # which is what the defaults CLI expects. Why? Well defaults itself accepts a few
+      # different formats, but when you do a read command it all comes back as 1 or 0.
       def coerce_booleans(val)
         return 1 if [true, "TRUE", "1", "true", "YES", "yes"].include?(val)
         return 0 if [false, "FALSE", "0", "false", "NO", "no"].include?(val)

data/lib/chef/resource/windows_firewall_rule.rb

@@ -41,7 +41,7 @@ class Chef
         description: "The local address the firewall rule applies to."
 
       property :local_port, [String, Integer, Array],
-               # split various formats of comma separated lists and provide a sorted array of strings to match PS output
+        # split various formats of comma separated lists and provide a sorted array of strings to match PS output
         coerce: proc { |d| d.is_a?(String) ? d.split(/\s*,\s*/).sort : Array(d).sort.map(&:to_s) },
         description: "The local port the firewall rule applies to."
 
@@ -49,7 +49,7 @@ class Chef
         description: "The remote address the firewall rule applies to."
 
       property :remote_port, [String, Integer, Array],
-               # split various formats of comma separated lists and provide a sorted array of strings to match PS output
+        # split various formats of comma separated lists and provide a sorted array of strings to match PS output
         coerce: proc { |d| d.is_a?(String) ? d.split(/\s*,\s*/).sort : Array(d).sort.map(&:to_s) },
         description: "The remote port the firewall rule applies to."
 
@@ -72,7 +72,7 @@ class Chef
         description: "The profile the firewall rule applies to.",
         coerce: proc { |p| Array(p).map(&:downcase).map(&:to_sym).sort },
         callbacks: {
-          "contains values not in :public, :private :domain, :any or :notapplicable" => lambda { |p|
+          "contains values not in :public, :private, :domain, :any or :notapplicable" => lambda { |p|
             p.all? { |e| %i{public private domain any notapplicable}.include?(e) }
           },
         }
@@ -106,6 +106,10 @@ class Chef
         else
           state = Chef::JSONCompat.from_json(output.stdout)
         end
+
+        # Need to reverse `$rule.Profile.ToString()` in powershell command
+        current_profiles = state["profile"].split(", ").map(&:to_sym)
+
         local_address state["local_address"]
         local_port Array(state["local_port"]).sort
         remote_address state["remote_address"]
@@ -113,7 +117,7 @@ class Chef
         direction state["direction"]
         protocol state["protocol"]
         firewall_action state["firewall_action"]
-        profile state["profile"]
+        profile current_profiles
         program state["program"]
         service state["service"]
         interface_type state["interface_type"]

data/lib/chef/resource/windows_share.rb

@@ -149,8 +149,8 @@ class Chef
         raise "The windows_share resource relies on PowerShell cmdlets not present in Windows releases prior to 8/2012. Cannot continue!" if node["platform_version"].to_f < 6.3
       end
 
-# given the string output of Get-SmbShareAccess parse out
-# arrays of full access users, change users, and read only users
+      # given the string output of Get-SmbShareAccess parse out
+      # arrays of full access users, change users, and read only users
       def parse_permissions(results_string)
         json_results = Chef::JSONCompat.from_json(results_string)
         json_results = [json_results] unless json_results.is_a?(Array) # single result is not an array
@@ -171,8 +171,8 @@ class Chef
         [f_users, c_users, r_users]
       end
 
-# local names are returned from Get-SmbShareAccess in the full format MACHINE\\NAME
-# but users of this resource would simply say NAME so we need to strip the values for comparison
+      # local names are returned from Get-SmbShareAccess in the full format MACHINE\\NAME
+      # but users of this resource would simply say NAME so we need to strip the values for comparison
       def stripped_account(name)
         name.slice!("#{node["hostname"]}\\")
         name

data/lib/chef/resource/windows_task.rb

@@ -159,16 +159,16 @@ class Chef
 
       private
 
-        ## Resource is not idempotent when day, start_day is not provided with frequency :weekly
-        ## we set start_day when not given by user as current date based on which we set the day property for current current date day is monday ..
-        ## we set the monday as the day so at next run when  new_resource.day is nil and current_resource day is monday due to which udpate gets called
+      ## Resource is not idempotent when day, start_day is not provided with frequency :weekly
+      ## we set start_day when not given by user as current date based on which we set the day property for current current date day is monday ..
+      ## we set the monday as the day so at next run when  new_resource.day is nil and current_resource day is monday due to which udpate gets called
       def idempotency_warning_for_frequency_weekly(day, start_day)
         if start_day.nil? && day.nil?
           logger.warn "To maintain idempotency for frequency :weekly provide start_day, start_time and day."
         end
       end
 
-        # Validate the passed value is numeric values only if it is a string
+      # Validate the passed value is numeric values only if it is a string
       def numeric_value_in_string?(val)
         return true if Integer(val)
       rescue ArgumentError
@@ -194,7 +194,7 @@ class Chef
         end
       end
 
-        # returns true if frequency_modifer has values First, second, third, fourth, last, lastday
+      # returns true if frequency_modifer has values First, second, third, fourth, last, lastday
       def frequency_modifier_includes_days_of_weeks?(frequency_modifier)
         frequency_modifier = frequency_modifier.to_s.split(",")
         frequency_modifier.map! { |value| value.strip.upcase }
@@ -209,7 +209,7 @@ class Chef
         raise ArgumentError, "Invalid value passed for `random_delay`. Please pass seconds as an Integer (e.g. 60) or a String with numeric values only (e.g. '60')." unless numeric_value_in_string?(random_delay)
       end
 
-        # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~f
+      # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~f
       def validate_start_day(start_day, frequency)
         if start_day && frequency == :none
           raise ArgumentError, "`start_day` property is not supported with frequency: #{frequency}"
@@ -221,7 +221,7 @@ class Chef
         end
       end
 
-        # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~
+      # @todo when we drop ruby 2.3 support this should be converted to .match?() instead of =~
       def validate_start_time(start_time, frequency)
         if start_time
           raise ArgumentError, "`start_time` property is not supported with `frequency :none`" if frequency == :none
@@ -321,7 +321,7 @@ class Chef
         end
       end
 
-        # This method returns true if day has values from 1-31 which is a days of moths and used with frequency :monthly
+      # This method returns true if day has values from 1-31 which is a days of moths and used with frequency :monthly
       def days_includes_days_of_months?(days)
         days.map! { |day| day.to_s.strip.downcase }
         (days - VALID_DAYS_OF_MONTH).empty?
@@ -339,11 +339,11 @@ class Chef
         end
       end
 
-        # Converts the number of seconds to an ISO8601 duration format and returns it.
-        # Ref : https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
-        # e.g.
-        # ISO8601::Duration.new(65707200).to_s
-        # returns 'PT65707200S'
+      # Converts the number of seconds to an ISO8601 duration format and returns it.
+      # Ref : https://github.com/arnau/ISO8601/blob/master/lib/iso8601/duration.rb#L18-L23
+      # e.g.
+      # ISO8601::Duration.new(65707200).to_s
+      # returns 'PT65707200S'
       def sec_to_dur(seconds)
         ISO8601::Duration.new(seconds.to_i).to_s
       end

data/lib/chef/resource_inspector.rb

@@ -68,8 +68,8 @@ module ResourceInspector
     dir, name = File.split(path)
     Chef::Cookbook::FileVendor.fetch_from_disk(path)
     loader = Chef::CookbookLoader.new(dir)
-    cookbooks = loader.load_cookbooks
-    resources = cookbooks[name].files_for(:resources)
+    cookbook = loader.load_cookbook(name)
+    resources = cookbook.files_for(:resources)
 
     resources.each_with_object({}) do |r, res|
       pth = r["full_path"]
@@ -82,13 +82,14 @@ module ResourceInspector
   # otherwise, if we have a path then extract all the resources from the cookbook
   # or else do a list of built in resources
   #
+  # @param arguments [Array, String] One of more paths to a cookbook or a resource file to inspect
   # @param complete [TrueClass, FalseClass] Whether to show properties defined in the base Resource class
   # @return [String] JSON formatting of all resources
   def self.inspect(arguments = [], complete: false)
     output = if arguments.empty?
                ObjectSpace.each_object(Class).select { |k| k < Chef::Resource }.each_with_object({}) { |klass, acc| acc[klass.resource_name] = extract_resource(klass) }
              else
-               arguments.each_with_object({}) do |arg, acc|
+               Array(arguments).each_with_object({}) do |arg, acc|
                  if File.directory?(arg)
                    extract_cookbook(arg, complete).each { |k, v| acc[k] = v }
                  else

data/lib/chef/util/dsc/lcm_output_parser.rb

@@ -160,9 +160,9 @@ class Chef
 
           def self.parse_line(line)
             if match = line.match(/^.*?:.*?:\s*LCM:\s*\[(.*?)\](.*)/)
-                # If the line looks like
-                # What If: [machinename]: LCM: [op_action op_type] message
-                # extract op_action, op_type, and message
+              # If the line looks like
+              # What If: [machinename]: LCM: [op_action op_type] message
+              # extract op_action, op_type, and message
               operation, info = match.captures
               op_action, op_type = operation.strip.split(" ").map { |m| m.downcase.to_sym }
             else

data/lib/chef/version.rb

@@ -23,7 +23,7 @@ require_relative "version_string"
 
 class Chef
   CHEF_ROOT = File.expand_path("../..", __FILE__)
-  VERSION = Chef::VersionString.new("15.10.12")
+  VERSION = Chef::VersionString.new("15.11.3")
 end
 
 #

data/lib/chef/win32/api/command_line_helper.rb

@@ -0,0 +1,89 @@
+#
+# Author:: Kapil Chouhan <kapil.chouhan@msystechnologies.com>
+# Copyright:: Copyright 2013-2020, Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require_relative "../api"
+
+class Chef
+  module ReservedNames::Win32
+    module API
+      module CommandLineHelper
+        # extend Chef::ReservedNames::Win32
+        extend Chef::ReservedNames::Win32::API
+
+        ###############################################
+        # Win32 API Bindings
+        ###############################################
+
+        ffi_lib "Shell32"
+
+=begin
+LPWSTR * CommandLineToArgvW(
+  LPCWSTR lpCmdLine,
+  int     *pNumArgs
+);
+=end
+
+        safe_attach_function :command_line_to_argv_w, :CommandLineToArgvW, %i{pointer pointer}, :pointer
+
+        ffi_lib "Kernel32"
+
+=begin
+LPSTR GetCommandLineA();
+=end
+
+        safe_attach_function :get_command_line, :GetCommandLineA, [], :pointer
+
+=begin
+HLOCAL LocalFree(
+  _Frees_ptr_opt_ HLOCAL hMem
+);
+=end
+
+        safe_attach_function :local_free, :LocalFree, [:pointer], :pointer
+
+        ###############################################
+        # Helpers
+        ###############################################
+
+        # It takes the supplied string and splits it into an array.
+        def command_line_to_argv_w_helper(args)
+          arguments_list = []
+          argv = args.to_wstring
+          result = get_command_line
+          argc = FFI::MemoryPointer.new(:int)
+
+          # Parses a Unicode command line string
+          # It is return an array of pointers to the command line arguments.
+          # Along with a count of such arguments
+          result = command_line_to_argv_w(argv, argc)
+          str_ptr = result.read_pointer
+          offset = 0
+          number_of_agrs = argc.read_int
+          number_of_agrs.times do
+            new_str_pointer = str_ptr.+(offset)
+            argument = new_str_pointer.read_wstring
+            arguments_list << argument
+            offset = offset + argument.length * 2 + 2
+          end
+          local_free(result)
+          arguments_list
+        end
+      end
+    end
+  end
+end