chef 16.4.41 → 16.8.9

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

@@ -16,36 +16,34 @@
 # limitations under the License.
 #
 
-require_relative "../powershell/cmdlet"
+require_relative "../../mixin/powershell_exec"
 
 class Chef::Util::DSC
   class ConfigurationGenerator
+    include Chef::Mixin::PowershellExec
+
     def initialize(node, config_directory)
       @node = node
       @config_directory = config_directory
     end
 
-    def configuration_document_from_script_code(code, configuration_flags, imports, shellout_flags)
+    def configuration_document_from_script_code(code, configuration_flags, imports)
       Chef::Log.trace("DSC: DSC code:\n '#{code}'")
       generated_script_path = write_document_generation_script(code, "chef_dsc", imports)
       begin
-        configuration_document_from_script_path(generated_script_path, "chef_dsc", configuration_flags, shellout_flags)
+        configuration_document_from_script_path(generated_script_path, "chef_dsc", configuration_flags)
       ensure
         ::FileUtils.rm(generated_script_path)
       end
     end
 
-    def configuration_document_from_script_path(script_path, configuration_name, configuration_flags, shellout_flags)
+    def configuration_document_from_script_path(script_path, configuration_name, configuration_flags)
       validate_configuration_name!(configuration_name)
 
-      document_generation_cmdlet = Chef::Util::Powershell::Cmdlet.new(
-        @node,
-        configuration_document_generation_code(script_path, configuration_name)
-      )
-
-      merged_configuration_flags = get_merged_configuration_flags!(configuration_flags, configuration_name)
+      config_generation_code = configuration_document_generation_code(script_path, configuration_name)
+      switches_string = command_switches_string(get_merged_configuration_flags!(configuration_flags, configuration_name))
 
-      document_generation_cmdlet.run!(merged_configuration_flags, shellout_flags)
+      powershell_exec!("#{config_generation_code} #{switches_string}")
       configuration_document_location = find_configuration_document(configuration_name)
 
       unless configuration_document_location
@@ -59,6 +57,49 @@ class Chef::Util::DSC
 
     protected
 
+    def validate_switch_name!(switch_parameter_name)
+      unless switch_parameter_name.match?(/\A[A-Za-z]+[_a-zA-Z0-9]*\Z/)
+        raise ArgumentError, "`#{switch_parameter_name}` is not a valid PowerShell cmdlet switch parameter name"
+      end
+    end
+
+    def escape_parameter_value(parameter_value)
+      parameter_value.gsub(/(`|'|"|#)/, '`\1')
+    end
+
+    def escape_string_parameter_value(parameter_value)
+      "'#{escape_parameter_value(parameter_value)}'"
+    end
+
+    def command_switches_string(switches)
+      command_switches = switches.map do |switch_name, switch_value|
+        if switch_name.class != Symbol
+          raise ArgumentError, "Invalid type `#{switch_name} `for PowerShell switch '#{switch_name}'. The switch must be specified as a Symbol'"
+        end
+
+        validate_switch_name!(switch_name)
+
+        switch_argument = ""
+        switch_present = true
+
+        case switch_value
+        when Numeric, Float
+          switch_argument = switch_value.to_s
+        when FalseClass
+          switch_present = false
+        when TrueClass
+        when String
+          switch_argument = escape_string_parameter_value(switch_value)
+        else
+          raise ArgumentError, "Invalid argument type `#{switch_value.class}` specified for PowerShell switch `:#{switch_name}`. Arguments to PowerShell must be of type `String`, `Numeric`, `Float`, `FalseClass`, or `TrueClass`"
+        end
+
+        switch_present ? ["-#{switch_name.to_s.downcase}", switch_argument].join(" ").strip : ""
+      end
+
+      command_switches.join(" ")
+    end
+
     # From PowerShell error help for the Configuration language element:
     #   Standard names may only contain letters (a-z, A-Z), numbers (0-9), and underscore (_).
     #   The name may not be null or empty, and should start with a letter.

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

@@ -75,23 +75,21 @@ class Chef
           #
 
           def self.parse(lcm_output, test_dsc_configuration)
+            lcm_output = String(lcm_output).split("\n")
             test_dsc_configuration ? test_dsc_parser(lcm_output) : what_if_parser(lcm_output)
           end
 
           def self.test_dsc_parser(lcm_output)
-            lcm_output ||= ""
             current_resource = {}
 
             resources = []
-            lcm_output.lines.each do |line|
+            lcm_output.each do |line|
               op_action , op_value = line.strip.split(":")
               op_action&.strip!
               case op_action
               when "InDesiredState"
                 current_resource[:skipped] = op_value.strip == "True" ? true : false
-              when "ResourcesInDesiredState"
-                current_resource[:name] = op_value.strip if op_value
-              when "ResourcesNotInDesiredState"
+              when "ResourcesInDesiredState", "ResourcesNotInDesiredState"
                 current_resource[:name] = op_value.strip if op_value
               when "ReturnValue"
                 current_resource[:context] = nil
@@ -109,11 +107,10 @@ class Chef
           end
 
           def self.what_if_parser(lcm_output)
-            lcm_output ||= ""
             current_resource = {}
 
             resources = []
-            lcm_output.lines.each do |line|
+            lcm_output.each do |line|
               op_action, op_type, info = parse_line(line)
 
               case op_action

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

@@ -16,25 +16,27 @@
 # limitations under the License.
 #
 
-require_relative "../powershell/cmdlet"
+require_relative "../../mixin/powershell_exec"
 require_relative "lcm_output_parser"
 
 class Chef::Util::DSC
   class LocalConfigurationManager
+    include Chef::Mixin::PowershellExec
+
     def initialize(node, configuration_path)
       @node = node
       @configuration_path = configuration_path
       clear_execution_time
     end
 
-    def test_configuration(configuration_document, shellout_flags)
-      status = run_configuration_cmdlet(configuration_document, false, shellout_flags)
-      log_dsc_exception(status.stderr) unless status.succeeded?
-      configuration_update_required?(status.return_value)
+    def test_configuration(configuration_document)
+      status = run_configuration_cmdlet(configuration_document, false)
+      log_dsc_exception(status.errors.join("\n")) if status.error?
+      configuration_update_required?(status.result)
     end
 
-    def set_configuration(configuration_document, shellout_flags)
-      run_configuration_cmdlet(configuration_document, true, shellout_flags)
+    def set_configuration(configuration_document)
+      run_configuration_cmdlet(configuration_document, true)
     end
 
     def last_operation_execution_time_seconds
@@ -45,7 +47,7 @@ class Chef::Util::DSC
 
     private
 
-    def run_configuration_cmdlet(configuration_document, apply_configuration, shellout_flags)
+    def run_configuration_cmdlet(configuration_document, apply_configuration)
       Chef::Log.trace("DSC: Calling DSC Local Config Manager to #{apply_configuration ? "set" : "test"} configuration document.")
 
       start_operation_timing
@@ -53,11 +55,12 @@ class Chef::Util::DSC
 
       begin
         save_configuration_document(configuration_document)
-        cmdlet = ::Chef::Util::Powershell::Cmdlet.new(@node, lcm_command(apply_configuration))
+        cmd = lcm_command(apply_configuration)
+        Chef::Log.trace("DSC: Calling DSC Local Config Manager with:\n#{cmd}")
+
+        status = powershell_exec(cmd)
         if apply_configuration
-          status = cmdlet.run!({}, shellout_flags)
-        else
-          status = cmdlet.run({}, shellout_flags)
+          status.error!
         end
       ensure
         end_operation_timing
@@ -77,7 +80,7 @@ class Chef::Util::DSC
         ps4_base_command
       else
         if ps_version_gte_5?
-          "#{common_command_prefix} Test-DscConfiguration -path #{@configuration_path} | format-list"
+          "#{common_command_prefix} Test-DscConfiguration -path #{@configuration_path} | format-list | Out-String"
         else
           ps4_base_command + " -whatif; if (! $?) { exit 1 }"
         end
@@ -100,12 +103,12 @@ class Chef::Util::DSC
     end
 
     def whatif_not_supported?(dsc_exception_output)
-      !! (dsc_exception_output.gsub(/[\r\n]+/, "").gsub(/\s+/, " ") =~ /A parameter cannot be found that matches parameter name 'Whatif'/i)
+      !! (dsc_exception_output.gsub(/[\n]+/, "").gsub(/\s+/, " ") =~ /A parameter cannot be found that matches parameter name 'Whatif'/i)
     end
 
     def dsc_module_import_failure?(command_output)
       !! (command_output =~ /\sCimException/ &&
-        command_output =~ /ProviderOperationExecutionFailure/ &&
+        command_output.include?("ProviderOperationExecutionFailure") &&
         command_output =~ /\smodule\s+is\s+installed/)
     end
 

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

@@ -16,14 +16,14 @@
 # limitations under the License.
 #
 
-require_relative "../powershell/cmdlet"
-require_relative "../powershell/cmdlet_result"
+require_relative "../../mixin/powershell_exec"
 require_relative "../../exceptions"
 
 class Chef
   class Util
     class DSC
       class ResourceStore
+        include Chef::Mixin::PowershellExec
 
         def self.instance
           @@instance ||= ResourceStore.new.tap do |store|
@@ -83,19 +83,13 @@ class Chef
 
         # Returns a list of dsc resources
         def query_resources
-          cmdlet = Chef::Util::Powershell::Cmdlet.new(nil, "get-dscresource",
-            :object)
-          result = cmdlet.run
-          result.return_value
+          powershell_exec("get-dscresource").result
         end
 
         # Returns a list of dsc resources matching the provided name
         def query_resource(resource_name)
-          cmdlet = Chef::Util::Powershell::Cmdlet.new(nil, "get-dscresource #{resource_name}",
-            :object)
-          result = cmdlet.run
-          ret_val = result.return_value
-          if ret_val.nil?
+          ret_val = powershell_exec("get-dscresource #{resource_name}").result
+          if ret_val.empty?
             []
           elsif ret_val.is_a? Array
             ret_val

data/lib/chef/util/powershell/ps_credential.rb

@@ -18,24 +18,28 @@
 
 require_relative "../../win32/crypto" if ChefUtils.windows?
 
-class Chef::Util::Powershell
-  class PSCredential
-    def initialize(username, password)
-      @username = username
-      @password = password
-    end
+class Chef
+  class Util
+    class Powershell
+      class PSCredential
+        def initialize(username, password)
+          @username = username
+          @password = password
+        end
 
-    def to_psobject
-      "New-Object System.Management.Automation.PSCredential('#{@username}',('#{encrypt(@password)}' | ConvertTo-SecureString))"
-    end
+        def to_psobject
+          "New-Object System.Management.Automation.PSCredential('#{@username}',('#{encrypt(@password)}' | ConvertTo-SecureString))"
+        end
 
-    alias to_s to_psobject
-    alias to_text to_psobject
+        alias to_s to_psobject
+        alias to_text to_psobject
 
-    private
+        private
 
-    def encrypt(str)
-      Chef::ReservedNames::Win32::Crypto.encrypt(str)
+        def encrypt(str)
+          Chef::ReservedNames::Win32::Crypto.encrypt(str)
+        end
+      end
     end
   end
 end

data/lib/chef/util/threaded_job_queue.rb

@@ -13,8 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "thread"
-
 class Chef
   class Util
     # A simple threaded job queue

data/lib/chef/version.rb

@@ -23,7 +23,7 @@ require_relative "version_string"
 
 class Chef
   CHEF_ROOT = File.expand_path("..", __dir__)
-  VERSION = Chef::VersionString.new("16.4.41")
+  VERSION = Chef::VersionString.new("16.8.9")
 end
 
 #

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

@@ -316,6 +316,7 @@ typedef struct _REPARSE_DATA_BUFFER {
             string_pointer.read_wstring(self[:PrintNameLength] / 2)
           end
         end
+
         class REPARSE_DATA_BUFFER_MOUNT_POINT < FFI::Struct
           layout :SubstituteNameOffset, :ushort,
             :SubstituteNameLength, :ushort,
@@ -333,14 +334,17 @@ typedef struct _REPARSE_DATA_BUFFER {
             string_pointer.read_wstring(self[:PrintNameLength] / 2)
           end
         end
+
         class REPARSE_DATA_BUFFER_GENERIC < FFI::Struct
           layout :DataBuffer, :uchar
         end
+
         class REPARSE_DATA_BUFFER_UNION < FFI::Union
           layout :SymbolicLinkReparseBuffer, REPARSE_DATA_BUFFER_SYMBOLIC_LINK,
             :MountPointReparseBuffer, REPARSE_DATA_BUFFER_MOUNT_POINT,
             :GenericReparseBuffer, REPARSE_DATA_BUFFER_GENERIC
         end
+
         class REPARSE_DATA_BUFFER < FFI::Struct
           layout :ReparseTag, :uint32,
             :ReparseDataLength, :ushort,

data/lib/chef/win32/crypto.rb

@@ -20,7 +20,7 @@ require_relative "error"
 require_relative "api/memory"
 require_relative "api/crypto"
 require_relative "unicode"
-require "digest"
+require "digest" unless defined?(Digest)
 
 class Chef
   module ReservedNames::Win32

data/lib/chef/win32/file.rb

@@ -124,7 +124,7 @@ class Chef
           # Return the link destination (strip off \??\ at the beginning, which is a local filesystem thing)
           link_dest = reparse_buffer.reparse_buffer.substitute_name
           if /^\\\?\?\\/.match?(link_dest)
-            link_dest = link_dest[4..-1]
+            link_dest = link_dest[4..]
           end
           link_dest
         end

data/lib/chef/win32/registry.rb

@@ -21,9 +21,8 @@ require_relative "api"
 require_relative "../mixin/wide_string"
 
 if RUBY_PLATFORM.match?(/mswin|mingw32|windows/)
-  require_relative "../monkey_patches/win32/registry"
+  Win32.autoload :Registry, File.expand_path("../monkey_patches/win32/registry", __dir__)
   require_relative "api/registry"
-  require "win32/registry" unless defined?(Win32::Registry)
   require "win32/api"
 end
 

data/lib/chef/win32/security/sid.rb

@@ -321,7 +321,7 @@ class Chef
             while status == ERROR_MORE_DATA
               status = NetUserEnum(servername, level, filter, bufptr, prefmaxlen, entriesread, totalentries, resume_handle)
 
-              if status == NERR_Success || status == ERROR_MORE_DATA
+              if [NERR_Success, ERROR_MORE_DATA].include?(status)
                 Array.new(entriesread.read_long) do |i|
                   user_info = USER_INFO_3.new(bufptr.read_pointer + i * USER_INFO_3.size)
                   # Check if the account is the Administrator account

data/lib/chef/win32/unicode.rb

@@ -40,7 +40,7 @@ module FFI
         last_char = nil
         while last_char != "\000\000"
           length += 1
-          last_char = get_bytes(0, length * 2)[-2..-1]
+          last_char = get_bytes(0, length * 2)[-2..]
         end
 
         num_wchars = length

data/spec/data/shef-config.rb

@@ -7,5 +7,5 @@ ohai[:disabled_plugins] << "solaris2::cpu" << "solaris2::dmi" << "solaris2::file
 ohai[:disabled_plugins] << "solaris2::virtualization" << "solaris2::zpools"
 ohai[:disabled_plugins] << "c" << "php" << "mono" << "groovy" << "lua" << "erlang"
 ohai[:disabled_plugins] << "kernel" << "linux::filesystem" << "ruby"
-chef_repo_path File.dirname(__FILE__)
+chef_repo_path __dir__
 cookbook_path  "#{chef_repo_path}/cookbooks"

data/spec/functional/event_loggers/windows_eventlog_spec.rb

@@ -19,6 +19,7 @@
 require "spec_helper"
 require "securerandom"
 require "chef/event_loggers/windows_eventlog"
+require "chef-utils"
 if ChefUtils.windows?
   require "win32/eventlog"
   include Win32
@@ -49,7 +50,7 @@ describe Chef::EventLoggers::WindowsEventLogger, :windows_only do
     logger.run_start(version, run_status)
 
     expect(event_log.read(flags, offset).any? do |e|
-      e.source == Chef::Dist::SHORT && e.event_id == 10000 &&
+      e.source == ChefUtils::Dist::Infra::SHORT && e.event_id == 10000 &&
                                         e.string_inserts[0].include?(version)
     end ).to be_truthy
   end
@@ -58,7 +59,7 @@ describe Chef::EventLoggers::WindowsEventLogger, :windows_only do
     logger.run_started(run_status)
 
     expect(event_log.read(flags, offset).any? do |e|
-      e.source == Chef::Dist::SHORT && e.event_id == 10001 &&
+      e.source == ChefUtils::Dist::Infra::SHORT && e.event_id == 10001 &&
                                         e.string_inserts[0].include?(run_id)
     end ).to be_truthy
   end
@@ -68,7 +69,7 @@ describe Chef::EventLoggers::WindowsEventLogger, :windows_only do
     logger.run_completed(node)
 
     expect(event_log.read(flags, offset).any? do |e|
-      e.source == Chef::Dist::SHORT && e.event_id == 10002 &&
+      e.source == ChefUtils::Dist::Infra::SHORT && e.event_id == 10002 &&
                                          e.string_inserts[0].include?(run_id) &&
                                          e.string_inserts[1].include?(elapsed_time.to_s)
     end).to be_truthy
@@ -79,7 +80,7 @@ describe Chef::EventLoggers::WindowsEventLogger, :windows_only do
     logger.run_failed(mock_exception)
 
     expect(event_log.read(flags, offset).any? do |e|
-      e.source == Chef::Dist::SHORT && e.event_id == 10003 &&
+      e.source == ChefUtils::Dist::Infra::SHORT && e.event_id == 10003 &&
         e.string_inserts[0].include?(run_id) &&
         e.string_inserts[1].include?(elapsed_time.to_s) &&
         e.string_inserts[2].include?(mock_exception.class.name) &&
@@ -93,7 +94,7 @@ describe Chef::EventLoggers::WindowsEventLogger, :windows_only do
     logger.run_failed(mock_exception)
 
     expect(event_log.read(flags, offset).any? do |e|
-      e.source == Chef::Dist::SHORT && e.event_id == 10003 &&
+      e.source == ChefUtils::Dist::Infra::SHORT && e.event_id == 10003 &&
         e.string_inserts[0].include?("UNKNOWN") &&
         e.string_inserts[1].include?("UNKNOWN") &&
         e.string_inserts[2].include?(mock_exception.class.name) &&