Merge pull request #213 from puppetlabs/cat-1869-add_configurable_timeout

(CAT-1869) - Add configurable dsc_timeout param for dsc type

Author: pmcmaw

.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-05-28 13:36:04 UTC using RuboCop version 1.50.2.
+# on 2024-06-07 10:17:46 UTC using RuboCop version 1.50.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
 Lint/ConstantDefinitionInBlock:
@@ -44,7 +44,7 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns, inherit_mode.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 116
+  Max: 134
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.

REFERENCE.md

@@ -67,12 +67,17 @@ An optional property that specifies that the DSC resource should be invoked.
 
 The following parameters are available in the `dsc` type.
 
+* [`dsc_timeout`](#-dsc--dsc_timeout)
 * [`module`](#-dsc--module)
 * [`name`](#-dsc--name)
 * [`properties`](#-dsc--properties)
 * [`provider`](#-dsc--provider)
 * [`resource_name`](#-dsc--resource_name)
 
+##### <a name="-dsc--dsc_timeout"></a>`dsc_timeout`
+
+Specify a timeout for Invoke-DscResource.
+
 ##### <a name="-dsc--module"></a>`module`
 
 Name of the DSC Resource module to use. For example, the xPSDesiredStateConfiguration DSC Resource module contains

lib/puppet/provider/base_dsc_lite/powershell.rb

@@ -56,25 +56,39 @@ def self.template_path
     File.expand_path(Pathname.new(__FILE__).dirname)
   end
 
+  def set_timeout
+    resource[:dsc_timeout] ? resource[:dsc_timeout] * 1000 : 1_200_000
+  end
+
+  def compile_timeout_msg(timeout)
+    "The DSC Resource did not respond within the timeout limit of #{timeout} milliseconds. \
+    This can occur if the DSC Resource is stuck in an infinite loop, or if the DSC Resource is waiting for user input. \
+    Please check the DSC Resource for any prompts that may require user input, and ensure that the DSC Resource does not contain any infinite loops. \
+    If the DSC Resource is functioning correctly, you may need to increase the timeout limit using the 'dsc_timeout' parameter"
+  end
+
   def ps_manager
     debug_output = Puppet::Util::Log.level == :debug
     Pwsh::Manager.instance(command(:powershell), Pwsh::Manager.powershell_args, debug: debug_output)
   end
 
-  DSC_LITE_COMMAND_TIMEOUT = 1_200_000 # 20 minutes
-
   def exists?
+    timeout = set_timeout
+    Puppet.debug "Dsc Timeout: #{timeout} milliseconds"
     version = Facter.value(:powershell_version)
     Puppet.debug "PowerShell Version: #{version}"
     script_content = ps_script_content('test')
     Puppet.debug "\n" + self.class.redact_content(script_content)
 
     if Pwsh::Manager.windows_powershell_supported?
-      output = ps_manager.execute(script_content, DSC_LITE_COMMAND_TIMEOUT)[:stdout]
+      output = ps_manager.execute(script_content, timeout)[:stdout]
     else
       self.class.upgrade_message
       output = powershell(Pwsh::Manager.powershell_args, script_content)
     end
+
+    raise Puppet::Error, compile_timeout_msg(timeout) if output.nil?
+
     Puppet.debug "Dsc Resource returned: #{output}"
     data = JSON.parse(output)
     raise(data['errormessage']) unless data['errormessage'].empty?
@@ -87,15 +101,20 @@ def exists?
   end
 
   def create
+    timeout = set_timeout
+    Puppet.debug "Dsc Timeout: #{timeout} milliseconds"
     script_content = ps_script_content('set')
     Puppet.debug "\n" + self.class.redact_content(script_content)
 
     if Pwsh::Manager.windows_powershell_supported?
-      output = ps_manager.execute(script_content, DSC_LITE_COMMAND_TIMEOUT)[:stdout]
+      output = ps_manager.execute(script_content, timeout)[:stdout]
     else
       self.class.upgrade_message
       output = powershell(Pwsh::Manager.powershell_args, script_content)
     end
+
+    raise Puppet::Error, compile_timeout_msg(timeout) if output.nil?
+
     Puppet.debug "Create Dsc Resource returned: #{output}"
     data = JSON.parse(output)
 

lib/puppet/type/dsc.rb

@@ -58,6 +58,13 @@ def change_to_s(currentvalue, newvalue)
     end
   end
 
+  newparam(:dsc_timeout) do
+    desc 'Specify a timeout for Invoke-DscResource.'
+    validate do |value|
+      raise "#{name} should be an Integer" unless value.is_a? Integer
+    end
+  end
+
   newparam(:resource_name) do
     desc 'Name of the DSC Resource to use. For example, the xRemoteFile DSC Resource.'
     validate do |value|

spec/acceptance/dsc_type/psdesiredstateconfiguration_spec.rb

@@ -34,6 +34,21 @@ module => 'PSDesiredStateConfiguration',
     MANIFEST
   end
 
+  let(:dsc_timeout_manifest) do
+    <<-MANIFEST
+    dsc { "Running Script":
+      resource_name => 'Script',
+      module        => 'PSDesiredStateConfiguration',
+      dsc_timeout   => 1,
+      properties    => {
+        getscript  => 'Start-Sleep -Seconds 2',
+        testscript => '$false',
+        setscript  => 'Start-Sleep -Seconds 2',
+      },
+    }
+    MANIFEST
+  end
+
   context 'create a standard DSC File' do
     it 'applies manifest' do
       apply_manifest(dsc_manifest, catch_failures: true) do |result|
@@ -46,6 +61,15 @@ module => 'PSDesiredStateConfiguration',
     end
   end
 
+  context 'times out when execution time is greater than dsc_timeout' do
+    it 'applies manifest' do
+      apply_manifest(dsc_timeout_manifest, expect_failures: true) do |result|
+        expect(result.stderr).to match(%r{The DSC Resource did not respond within the timeout limit of 1000 milliseconds})
+      end
+      sleep(15) # Wait for the DSC Resource to finish execution
+    end
+  end
+
   context 'remove a standard DSC File' do
     it 'applies manifest' do
       apply_manifest(dsc_remove_manifest, catch_failures: true) do |result|