From e54533b1fd79a196bae8a812a1e88b2ededec300 Mon Sep 17 00:00:00 2001 From: Jay Mundrawala Date: Thu, 4 Sep 2014 12:05:25 -0700 Subject: DscScript resource will raise an error if dsc is not available --- lib/chef/exceptions.rb | 2 + lib/chef/platform/query_helpers.rb | 6 +- lib/chef/resource/dsc_script.rb | 19 +++- spec/functional/resource/dsc_script_spec.rb | 7 +- spec/unit/platform/query_helpers_spec.rb | 23 +++++ spec/unit/provider/dsc_script_spec.rb | 6 +- spec/unit/resource/dsc_script_spec.rb | 147 +++++++++++++++++----------- 7 files changed, 147 insertions(+), 63 deletions(-) diff --git a/lib/chef/exceptions.rb b/lib/chef/exceptions.rb index a535ee484a..2b93914c45 100644 --- a/lib/chef/exceptions.rb +++ b/lib/chef/exceptions.rb @@ -181,6 +181,8 @@ class Chef class ChildConvergeError < RuntimeError; end + class NoProviderAvailable < RuntimeError; end + class MissingRole < RuntimeError NULL = Object.new diff --git a/lib/chef/platform/query_helpers.rb b/lib/chef/platform/query_helpers.rb index f6f5309de5..334ab278d1 100644 --- a/lib/chef/platform/query_helpers.rb +++ b/lib/chef/platform/query_helpers.rb @@ -45,7 +45,11 @@ class Chef is_server_2003 end - end + def supports_dsc?(node) + node[:languages] && node[:languages][:powershell] && + node[:languages][:powershell][:version].to_i >= 4 + end + end end end diff --git a/lib/chef/resource/dsc_script.rb b/lib/chef/resource/dsc_script.rb index 37546c3b6a..2972ace1aa 100644 --- a/lib/chef/resource/dsc_script.rb +++ b/lib/chef/resource/dsc_script.rb @@ -16,6 +16,8 @@ # limitations under the License. # +require 'chef/exceptions' + class Chef class Resource class DscScript < Chef::Resource @@ -26,7 +28,12 @@ class Chef super @allowed_actions.push(:run) @action = :run - provider(Chef::Provider::DscScript) + if(run_context && Chef::Platform.supports_dsc?(run_context.node)) + @provider = Chef::Provider::DscScript + else + raise Chef::Exceptions::NoProviderAvailable, + "#{powershell_info_str(run_context)}\nPowershell 4.0 or higher was not detected on your system and is required to use the dsc_script resource." + end end def code(arg=nil) @@ -118,6 +125,16 @@ class Chef :kind_of => [ Integer ] ) end + + private + + def powershell_info_str(run_context) + if run_context && run_context.node[:languages] && run_context.node[:languages][:powershell] + install_info = "Powershell #{run_context.node[:languages][:powershell][:version]} was found on the system." + else + install_info = 'Powershell was not found.' + end + end end end end diff --git a/spec/functional/resource/dsc_script_spec.rb b/spec/functional/resource/dsc_script_spec.rb index 2aa1f35772..fa13296c02 100644 --- a/spec/functional/resource/dsc_script_spec.rb +++ b/spec/functional/resource/dsc_script_spec.rb @@ -65,10 +65,11 @@ describe Chef::Resource::DscScript, :windows_powershell_dsc_only do let(:env_value2) { 'value2' } let(:dsc_test_run_context) { node = Chef::Node.new - node.default['platform'] = 'windows' - node.default['platform_version'] = '6.1' - node.default['kernel'][:machine] = + node.automatic['platform'] = 'windows' + node.automatic['platform_version'] = '6.1' + node.automatic['kernel'][:machine] = is_i386_process_on_x86_64_windows? ? :x86_64 : :i386 + node.automatic[:languages][:powershell][:version] = '4.0' empty_events = Chef::EventDispatch::Dispatcher.new Chef::RunContext.new(node, {}, empty_events) } diff --git a/spec/unit/platform/query_helpers_spec.rb b/spec/unit/platform/query_helpers_spec.rb index 2414bdf552..6adea5eecf 100644 --- a/spec/unit/platform/query_helpers_spec.rb +++ b/spec/unit/platform/query_helpers_spec.rb @@ -30,3 +30,26 @@ describe "Chef::Platform#windows_server_2003?" do expect { Thread.fork { Chef::Platform.windows_server_2003? }.join }.not_to raise_error end end + +describe 'Chef::Platform#supports_dsc?' do + it 'returns false if powershell is not present' do + node = Chef::Node.new + Chef::Platform.supports_dsc?(node).should be_false + end + + ['1.0', '2.0', '3.0'].each do |version| + it "returns false for Powershell #{version}" do + node = Chef::Node.new + node.automatic[:languages][:powershell][:version] = version + Chef::Platform.supports_dsc?(node).should be_false + end + end + + ['4.0', '5.0'].each do |version| + it "returns true for Powershell #{version}" do + node = Chef::Node.new + node.automatic[:languages][:powershell][:version] = version + Chef::Platform.supports_dsc?(node).should be_true + end + end +end diff --git a/spec/unit/provider/dsc_script_spec.rb b/spec/unit/provider/dsc_script_spec.rb index 3f8006e594..8a7a7b5c6a 100644 --- a/spec/unit/provider/dsc_script_spec.rb +++ b/spec/unit/provider/dsc_script_spec.rb @@ -22,7 +22,11 @@ require 'chef/util/dsc/resource_info' require 'spec_helper' describe Chef::Provider::DscScript do - let (:node) { Chef::Node.new } + let (:node) { + node = Chef::Node.new + node.automatic[:languages][:powershell][:version] = '4.0' + node + } let (:events) { Chef::EventDispatch::Dispatcher.new } let (:run_context) { Chef::RunContext.new(node, {}, events) } let (:resource) { Chef::Resource::DscScript.new("script", run_context) } diff --git a/spec/unit/resource/dsc_script_spec.rb b/spec/unit/resource/dsc_script_spec.rb index 7156079937..cbd502a61c 100644 --- a/spec/unit/resource/dsc_script_spec.rb +++ b/spec/unit/resource/dsc_script_spec.rb @@ -19,76 +19,109 @@ require 'spec_helper' describe Chef::Resource::DscScript do - let(:dsc_test_run_context) { - node = Chef::Node.new - empty_events = Chef::EventDispatch::Dispatcher.new - Chef::RunContext.new(node, {}, empty_events) - } let(:dsc_test_resource_name) { 'DSCTest' } - let(:dsc_test_resource) { - Chef::Resource::DscScript.new(dsc_test_resource_name, dsc_test_run_context) - } - let(:configuration_code) {'echo "This is supposed to create a configuration document."'} - let(:configuration_path) {'c:/myconfigs/formatc.ps1'} - let(:configuration_name) { 'formatme' } - let(:configuration_data) { '@{AllNodes = @( @{ NodeName = "localhost"; PSDscAllowPlainTextPassword = $true })}' } - let(:configuration_data_script) { 'c:/myconfigs/data/safedata.psd1' } - - it "has a default action of `:run`" do - expect(dsc_test_resource.action).to eq(:run) - end - it "has an allowed_actions attribute with only the `:run` and `:nothing` attributes" do - expect(dsc_test_resource.allowed_actions.to_set).to eq([:run,:nothing].to_set) - end + context 'when Powershell supports Dsc' do + let(:dsc_test_run_context) { + node = Chef::Node.new + node.automatic[:languages][:powershell][:version] = '4.0' + empty_events = Chef::EventDispatch::Dispatcher.new + Chef::RunContext.new(node, {}, empty_events) + } + let(:dsc_test_resource) { + Chef::Resource::DscScript.new(dsc_test_resource_name, dsc_test_run_context) + } + let(:configuration_code) {'echo "This is supposed to create a configuration document."'} + let(:configuration_path) {'c:/myconfigs/formatc.ps1'} + let(:configuration_name) { 'formatme' } + let(:configuration_data) { '@{AllNodes = @( @{ NodeName = "localhost"; PSDscAllowPlainTextPassword = $true })}' } + let(:configuration_data_script) { 'c:/myconfigs/data/safedata.psd1' } - it "allows the code attribute to be set" do - dsc_test_resource.code(configuration_code) - expect(dsc_test_resource.code).to eq(configuration_code) - end + it "has a default action of `:run`" do + expect(dsc_test_resource.action).to eq(:run) + end - it "allows the command attribute to be set" do - dsc_test_resource.command(configuration_path) - expect(dsc_test_resource.command).to eq(configuration_path) - end + it "has an allowed_actions attribute with only the `:run` and `:nothing` attributes" do + expect(dsc_test_resource.allowed_actions.to_set).to eq([:run,:nothing].to_set) + end - it "allows the configuration_name attribute to be set" do - dsc_test_resource.configuration_name(configuration_name) - expect(dsc_test_resource.configuration_name).to eq(configuration_name) - end + it "allows the code attribute to be set" do + dsc_test_resource.code(configuration_code) + expect(dsc_test_resource.code).to eq(configuration_code) + end - it "allows the configuration_data attribute to be set" do - dsc_test_resource.configuration_data(configuration_data) - expect(dsc_test_resource.configuration_data).to eq(configuration_data) - end + it "allows the command attribute to be set" do + dsc_test_resource.command(configuration_path) + expect(dsc_test_resource.command).to eq(configuration_path) + end - it "allows the configuration_data_script attribute to be set" do - dsc_test_resource.configuration_data_script(configuration_data_script) - expect(dsc_test_resource.configuration_data_script).to eq(configuration_data_script) - end + it "allows the configuration_name attribute to be set" do + dsc_test_resource.configuration_name(configuration_name) + expect(dsc_test_resource.configuration_name).to eq(configuration_name) + end - it "raises an ArgumentError exception if an attempt is made to set the code attribute when the command attribute is already set" do - dsc_test_resource.command(configuration_path) - expect { dsc_test_resource.code(configuration_code) }.to raise_error(ArgumentError) - end + it "allows the configuration_data attribute to be set" do + dsc_test_resource.configuration_data(configuration_data) + expect(dsc_test_resource.configuration_data).to eq(configuration_data) + end - it "raises an ArgumentError exception if an attempt is made to set the command attribute when the code attribute is already set" do - dsc_test_resource.code(configuration_code) - expect { dsc_test_resource.command(configuration_path) }.to raise_error(ArgumentError) - end + it "allows the configuration_data_script attribute to be set" do + dsc_test_resource.configuration_data_script(configuration_data_script) + expect(dsc_test_resource.configuration_data_script).to eq(configuration_data_script) + end + + it "raises an ArgumentError exception if an attempt is made to set the code attribute when the command attribute is already set" do + dsc_test_resource.command(configuration_path) + expect { dsc_test_resource.code(configuration_code) }.to raise_error(ArgumentError) + end + + it "raises an ArgumentError exception if an attempt is made to set the command attribute when the code attribute is already set" do + dsc_test_resource.code(configuration_code) + expect { dsc_test_resource.command(configuration_path) }.to raise_error(ArgumentError) + end + + it "raises an ArgumentError exception if an attempt is made to set the configuration_name attribute when the code attribute is already set" do + dsc_test_resource.code(configuration_code) + expect { dsc_test_resource.configuration_name(configuration_name) }.to raise_error(ArgumentError) + end - it "raises an ArgumentError exception if an attempt is made to set the configuration_name attribute when the code attribute is already set" do - dsc_test_resource.code(configuration_code) - expect { dsc_test_resource.configuration_name(configuration_name) }.to raise_error(ArgumentError) + it "raises an ArgumentError exception if an attempt is made to set the configuration_data attribute when the configuration_data_script attribute is already set" do + dsc_test_resource.configuration_data_script(configuration_data_script) + expect { dsc_test_resource.configuration_data(configuration_data) }.to raise_error(ArgumentError) + end + + it "raises an ArgumentError exception if an attempt is made to set the configuration_data_script attribute when the configuration_data attribute is already set" do + dsc_test_resource.configuration_data(configuration_data) + expect { dsc_test_resource.configuration_data_script(configuration_data_script) }.to raise_error(ArgumentError) + end end - it "raises an ArgumentError exception if an attempt is made to set the configuration_data attribute when the configuration_data_script attribute is already set" do - dsc_test_resource.configuration_data_script(configuration_data_script) - expect { dsc_test_resource.configuration_data(configuration_data) }.to raise_error(ArgumentError) + context 'when Powershell does not supported Dsc' do + ['1.0', '2.0', '3.0'].each do |version| + it "raises an exception for powershell version '#{version}'" do + node = Chef::Node.new + node.automatic[:languages][:powershell][:version] = version + empty_events = Chef::EventDispatch::Dispatcher.new + dsc_test_run_context = Chef::RunContext.new(node, {}, empty_events) + + expect { + Chef::Resource::DscScript.new(dsc_test_resource_name, dsc_test_run_context) + }.to raise_error(Chef::Exceptions::NoProviderAvailable) + end + end end - it "raises an ArgumentError exception if an attempt is made to set the configuration_data_script attribute when the configuration_data attribute is already set" do - dsc_test_resource.configuration_data(configuration_data) - expect { dsc_test_resource.configuration_data_script(configuration_data_script) }.to raise_error(ArgumentError) + context 'when Powershell is not present' do + let (:dsc_test_run_context) { + node = Chef::Node.new + empty_events = Chef::EventDispatch::Dispatcher.new + dsc_test_run_context = Chef::RunContext.new(node, {}, empty_events) + } + + it 'raises an exception if powershell is not present' do + expect { + Chef::Resource::DscScript.new(dsc_test_resource_name, dsc_test_run_context) + }.to raise_error(Chef::Exceptions::NoProviderAvailable) + end end end -- cgit v1.2.1