Correctly handle DSC resource import failures in start-dscconfiguration --what-if (load_current_resource) context

4 files changed, 163 insertions, 13 deletions

diff --git a/lib/chef/util/dsc/local_configuration_manager.rb b/lib/chef/util/dsc/local_configuration_manager.rb
index 79cfcd2996..f41428081b 100644
--- a/lib/chef/util/dsc/local_configuration_manager.rb
+++ b/lib/chef/util/dsc/local_configuration_manager.rb
@@ -29,14 +29,7 @@ class Chef::Util::DSC
 
     def test_configuration(configuration_document)
       status = run_configuration_cmdlet(configuration_document)
-      unless status.succeeded?
-        # LCM returns an error if any of the resources do not support the opptional What-If
-        if status.stderr.gsub(/\s+/, ' ') =~ /A parameter cannot be found that matches parameter name 'Whatif'/
-          Chef::Log::warn("Received error while testing configuration due to resource not supporting 'WhatIf'")
-        else
-          raise Chef::Exceptions::PowershellCmdletException, "Powershell Cmdlet failed: #{status.stderr.gsub(/\s+/, ' ')}"
-        end
-      end
+      handle_what_if_exception!(status.stderr) unless status.succeeded?
       configuration_update_required?(status.return_value)
     end
 
@@ -57,7 +50,7 @@ class Chef::Util::DSC
       test_only_parameters = ! apply_configuration ? '-whatif; if (! $?) { exit 1 }' : ''
 
       start_operation_timing
-      command_code = "$ProgressPreference = 'SilentlyContinue';start-dscconfiguration -path #{@configuration_path} -wait -force #{test_only_parameters}"
+      command_code = lcm_command_code(@configuration_path, test_only_parameters)
       status = nil
 
       begin
@@ -79,12 +72,35 @@ class Chef::Util::DSC
       status
     end
 
+    def lcm_command_code(configuration_path, test_only_parameters)
+      <<-EOH
+$ProgressPreference = 'SilentlyContinue';start-dscconfiguration -path #{@configuration_path} -wait -force #{test_only_parameters}
+EOH
+    end
+
+    def handle_what_if_exception!(what_if_exception_output)
+        if what_if_exception_output.gsub(/\s+/, ' ') =~ /A parameter cannot be found that matches parameter name 'Whatif'/i
+          # LCM returns an error if any of the resources do not support the opptional What-If
+          Chef::Log::warn("Received error while testing configuration due to resource not supporting 'WhatIf'")
+        elsif output_has_dsc_module_failure?(what_if_exception_output)
+          Chef::Log::warn("Received error while testing configuration due to a module for an imported resource possibly not being fully installed:\n#{what_if_exception_output.gsub(/\s+/, ' ')}")
+        else
+          raise Chef::Exceptions::PowershellCmdletException, "Powershell Cmdlet failed: #{what_if_exception_output.gsub(/\s+/, ' ')}"
+        end
+    end
+
+    def output_has_dsc_module_failure?(what_if_output)
+      !! (what_if_output.match(/\sCimException/) &&
+        what_if_output =~ /ProviderOperationExecutionFailure/ &&
+        what_if_output =~ /\smodule\s+is\s+installed/)
+    end
+
     def configuration_update_required?(what_if_output)
       Chef::Log.debug("DSC: DSC returned the following '-whatif' output from test operation:\n#{what_if_output}")
       begin
         Parser::parse(what_if_output)
       rescue Chef::Util::DSC::LocalConfigurationManager::Parser => e
-        Chef::Log::warn("Could not parse parse LCM output: #{e}")
+        Chef::Log::warn("Could not parse LCM output: #{e}")
         [Chef::Util::DSC::ResourceInfo.new('Unknown DSC Resources', true, ['Unknown changes because LCM output was not parsable.'])]
       end
     end
diff --git a/lib/chef/util/powershell/cmdlet_result.rb b/lib/chef/util/powershell/cmdlet_result.rb
index 390ee8cbc1..696013e684 100644
--- a/lib/chef/util/powershell/cmdlet_result.rb
+++ b/lib/chef/util/powershell/cmdlet_result.rb
@@ -38,7 +38,7 @@ class Chef::Util::Powershell
         @status.stdout
       end
     end
-    
+
     def succeeded?
       @succeeded = @status.status.exitstatus == 0
     end
diff --git a/spec/unit/util/dsc/lcm_output_parser_spec.rb b/spec/unit/util/dsc/lcm_output_parser_spec.rb
index 802c0ea429..05aa072a94 100644
--- a/spec/unit/util/dsc/lcm_output_parser_spec.rb
+++ b/spec/unit/util/dsc/lcm_output_parser_spec.rb
@@ -20,11 +20,11 @@ require 'chef/util/dsc/lcm_output_parser'
 
 describe Chef::Util::DSC::LocalConfigurationManager::Parser do
   context 'empty input parameter' do
-    it 'returns an emtpy array for a 0 length string' do
+    it 'returns an empty array for a 0 length string' do
       Chef::Util::DSC::LocalConfigurationManager::Parser::parse('').should be_empty
     end
 
-    it 'returns an emtpy array for a nil input' do
+    it 'returns an empty array for a nil input' do
       Chef::Util::DSC::LocalConfigurationManager::Parser::parse('').should be_empty
     end
   end
diff --git a/spec/unit/util/dsc/local_configuration_manager_spec.rb b/spec/unit/util/dsc/local_configuration_manager_spec.rb
new file mode 100644
index 0000000000..1b0d8b27db
--- /dev/null
+++ b/spec/unit/util/dsc/local_configuration_manager_spec.rb
@@ -0,0 +1,134 @@
+#

+# Author:: Adam Edwards <adamed@getchef.com>

+# Copyright:: Copyright (c) 2014 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 'chef'

+require 'chef/util/dsc/local_configuration_manager'

+

+describe Chef::Util::DSC::LocalConfigurationManager do

+

+  let(:lcm) { Chef::Util::DSC::LocalConfigurationManager.new(nil, 'tmp') }

+

+  let(:normal_lcm_output) { <<-EOH

+logtype: [machinename]: LCM:  [ Start  Set      ]

+logtype: [machinename]: LCM:  [ Start  Resource ] [name]

+logtype: [machinename]: LCM:  [ End    Resource ] [name]

+logtype: [machinename]: LCM:  [ End    Set      ]

+EOH

+  }

+

+  let(:no_whatif_lcm_output) { <<-EOH

+Start-DscConfiguration : A parameter cannot be found that matches parameter name 'whatif'.

+At line:1 char:123

++ run-somecommand -whatif

++                        ~~~~~~~~

+    + CategoryInfo          : InvalidArgument: (:) [Start-DscConfiguration], ParameterBindingException

+    + FullyQualifiedErrorId : NamedParameterNotFound,SomeCompany.SomeAssembly.Commands.RunSomeCommand

+EOH

+  }

+

+  let(:dsc_resource_import_failure_output) { <<-EOH

+PowerShell provider MSFT_xWebsite failed to execute Test-TargetResource functionality with error message: Please ensure that WebAdministration module is installed. + CategoryInfo : InvalidOperation: (:) [], CimException + FullyQualifiedErrorId : ProviderOperationExecutionFailure + PSComputerName : . PowerShell provider MSFT_xWebsite failed to execute Test-TargetResource functionality with error message: Please ensure that WebAdministration module is installed. + CategoryInfo : InvalidOperation: (:) [], CimException + FullyQualifiedErrorId : ProviderOperationExecutionFailure + PSComputerName : . The SendConfigurationApply function did not succeed. + CategoryInfo : NotSpecified: (root/Microsoft/...gurationManager:String) [], CimException + FullyQualifiedErrorId : MI RESULT 1 + PSComputerName : .

+EOH

+  }

+

+  let(:lcm_status) {

+    double("LCM cmdlet status", :stderr => lcm_standard_error, :return_value => lcm_standard_output, :succeeded? => lcm_cmdlet_success)

+  }

+

+  describe 'test_configuration method invocation' do

+    context 'when interacting with the LCM using a PowerShell cmdlet' do

+      before(:each) do

+        allow(lcm).to receive(:run_configuration_cmdlet).and_return(lcm_status)

+      end

+      context 'that returns successfully' do

+        before(:each) do

+          allow(lcm).to receive(:run_configuration_cmdlet).and_return(lcm_status)

+        end

+

+        let(:lcm_standard_output) { normal_lcm_output }

+        let(:lcm_standard_error) { nil }

+        let(:lcm_cmdlet_success) { true }

+

+        it 'should successfully return resource information for normally formatted output when cmdlet the cmdlet succeeds' do

+          test_configuration_result = lcm.test_configuration('config')

+          expect(test_configuration_result.class).to be(Array)

+          expect(test_configuration_result.length).to be > 0

+          expect(Chef::Log).not_to receive(:warn)

+        end

+      end

+

+      context 'that fails due to missing what-if switch in DSC resource cmdlet implementation' do

+        let(:lcm_standard_output) { '' }

+        let(:lcm_standard_error) { no_whatif_lcm_output }

+        let(:lcm_cmdlet_success) { false }

+

+        it 'should should return a (possibly empty) array of ResourceInfo instances' do

+          expect(Chef::Log).to receive(:warn)

+          test_configuration_result = nil

+          expect {test_configuration_result = lcm.test_configuration('config')}.not_to raise_error

+          expect(test_configuration_result.class).to be(Array)

+        end

+      end

+

+      context 'that fails due to a DSC resource not being imported before StartDSCConfiguration -whatif is executed' do

+        let(:lcm_standard_output) { '' }

+        let(:lcm_standard_error) { dsc_resource_import_failure_output }

+        let(:lcm_cmdlet_success) { false }

+

+        it 'should log a warning if the message is formatted as expected when a resource import failure occurs' do

+          expect(Chef::Log).to receive(:warn)

+          expect(lcm).to receive(:output_has_dsc_module_failure?).and_call_original

+          test_configuration_result = nil

+          expect {test_configuration_result = lcm.test_configuration('config')}.not_to raise_error

+        end

+

+        it 'should return a (possibly empty) array of ResourceInfo instances' do

+          expect(Chef::Log).to receive(:warn)

+          test_configuration_result = nil

+          expect {test_configuration_result = lcm.test_configuration('config')}.not_to raise_error

+          expect(test_configuration_result.class).to be(Array)

+        end

+      end

+

+      context 'that fails due to an PowerShell cmdlet error that cannot be handled' do

+        let(:lcm_standard_output) { 'some output' }

+        let(:lcm_standard_error) { 'Abort, Retry, Fail?' }

+        let(:lcm_cmdlet_success) { false }

+

+        it 'should raise a Chef::Exceptions::PowershellCmdletException' do

+          expect(Chef::Log).not_to receive(:warn)

+          expect(lcm).to receive(:output_has_dsc_module_failure?).and_call_original

+          expect {lcm.test_configuration('config')}.to raise_error(Chef::Exceptions::PowershellCmdletException)

+        end

+      end

+    end

+

+    it 'should identify a correctly formatted error message as a resource import failure' do

+      expect(lcm.send(:output_has_dsc_module_failure?, dsc_resource_import_failure_output)).to be(true)

+    end

+

+    it 'should not identify an incorrectly formatted error message as a resource import failure' do

+      expect(lcm.send(:output_has_dsc_module_failure?, dsc_resource_import_failure_output.gsub('module', 'gibberish'))).to be(false)

+    end

+

+    it 'should not identify a message without a CimException reference as a resource import failure' do

+      expect(lcm.send(:output_has_dsc_module_failure?, dsc_resource_import_failure_output.gsub('CimException', 'ArgumentException'))).to be(false)

+    end

+  end

+end

+