DSC functional tests with configuration data and parameterization

1 files changed, 225 insertions, 4 deletions

diff --git a/spec/functional/resource/dsc_script_spec.rb b/spec/functional/resource/dsc_script_spec.rb
index 488f6aebef..79917c01df 100644
--- a/spec/functional/resource/dsc_script_spec.rb
+++ b/spec/functional/resource/dsc_script_spec.rb
@@ -17,6 +17,7 @@
 #

 

 require 'spec_helper'

+require 'chef/mixin/shell_out'

 require 'chef/mixin/windows_architecture_helper'

 

 describe Chef::Resource::DscScript, :windows_powershell_dsc_only do

@@ -29,15 +30,36 @@ describe Chef::Resource::DscScript, :windows_powershell_dsc_only do
     ::FileUtils.rm_rf(@temp_dir) if ::Dir.exist?(@temp_dir)

   end

 

-  def create_config_script_from_code(code, configuration_name)

-    script_code = "Configuration '#{configuration_name}'\n{\n\t#{code}\n}\n"

-    script_path = "#{@temp_dir}/dsc_functional_test.ps1"

+  include Chef::Mixin::ShellOut

+

+  def create_config_script_from_code(code, configuration_name, data = false)

+    script_code = data ? code : "Configuration '#{configuration_name}'\n{\n\t#{code}\n}\n"

+    data_suffix = data ? '_config_data' : ''

+    extension = data ? 'psd1' : 'ps1'

+    script_path = "#{@temp_dir}/dsc_functional_test#{data_suffix}.#{extension}"

     ::File.open(script_path, 'wt') do | script |

       script.write(script_code)

     end

     script_path

   end

 

+  def user_exists?(target_user)

+    result = false

+    begin

+      shell_out!("net user #{target_user}")

+      result = true

+    rescue Mixlib::ShellOut::ShellCommandFailed

+    end

+    result

+  end

+

+  def delete_user(target_user)

+    begin

+      shell_out!("net user #{target_user} /delete")

+    rescue Mixlib::ShellOut::ShellCommandFailed

+    end

+  end

+

   let(:dsc_env_variable) { 'chefenvtest' }

   let(:dsc_env_value1) { 'value1' }

   let(:env_value2) { 'value2' }

@@ -68,6 +90,92 @@ describe Chef::Resource::DscScript, :windows_powershell_dsc_only do
   }

 EOH

   }

+

+  let(:dsc_user_prefix) { 'dsc' }

+  let(:dsc_user_suffix) { 'chefx' }

+  let(:dsc_user) {"#{dsc_user_prefix}_usr_#{dsc_user_suffix}" }

+  let(:dsc_user_prefix_env_var_name) { 'dsc_user_env_prefix' }

+  let(:dsc_user_suffix_env_var_name) { 'dsc_user_env_suffix' }

+  let(:dsc_user_prefix_env_code) { "$env:#{dsc_user_prefix_env_var_name}"}

+  let(:dsc_user_suffix_env_code) { "$env:#{dsc_user_suffix_env_var_name}"}

+  let(:dsc_user_prefix_param_name) { 'dsc_user_prefix_param' }

+  let(:dsc_user_suffix_param_name) { 'dsc_user_suffix_param' }

+  let(:dsc_user_prefix_param_code) { "$#{dsc_user_prefix_param_name}"}

+  let(:dsc_user_suffix_param_code) { "$#{dsc_user_suffix_param_name}"}

+  let(:dsc_user_env_code) { "\"$(#{dsc_user_prefix_env_code})_usr_$(#{dsc_user_suffix_env_code})\""}

+  let(:dsc_user_param_code) { "\"$(#{dsc_user_prefix_param_code})_usr_$(#{dsc_user_suffix_param_code})\""}

+

+  let(:config_flags) { nil }

+  let(:config_params) { <<-EOH

+

+    [CmdletBinding()]

+    param

+    (

+    $#{dsc_user_prefix_param_name},

+    $#{dsc_user_suffix_param_name}

+    )

+EOH

+  }

+

+  let(:config_param_section) { '' }

+  let(:dsc_user_code) { "'#{dsc_user}'" }

+  let(:dsc_user_prefix_code) { dsc_user_prefix }

+  let(:dsc_user_suffix_code) { dsc_user_suffix }

+  let(:dsc_script_environment_attribute) { nil }

+  let(:dsc_user_resources_code) { <<-EOH

+  #{config_param_section}

+node localhost

+{

+$testuser = #{dsc_user_code}

+$testpassword = ConvertTo-SecureString -String "jf9a8m49jrajf4#" -AsPlainText -Force

+$testcred = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $testuser, $testpassword

+

+User dsctestusercreate

+{

+    UserName = $testuser

+    Password = $testcred

+    Description = "DSC test user"

+    Ensure = "Present"

+    Disabled = $false

+    PasswordNeverExpires = $true

+    PasswordChangeRequired = $false

+}

+}

+EOH

+  }

+

+  let(:dsc_user_config_data) {

+<<-EOH

+@{

+    AllNodes = @(

+        @{

+            NodeName = "localhost";

+            PSDscAllowPlainTextPassword = $true

+        }

+    )

+}

+

+EOH

+  }

+

+  let(:dsc_environment_env_var_name) { 'dsc_test_cwd' }

+  let(:dsc_environment_no_fail_not_etc_directory) { "#{ENV['systemroot']}\\system32" }

+  let(:dsc_environment_fail_etc_directory) { "#{ENV['systemroot']}\\system32\\drivers\\etc" }

+  let(:exception_message_signature) { 'LL927-LL928' }

+  let(:dsc_environment_config) {<<-EOH

+if (($pwd.path -eq '#{dsc_environment_fail_etc_directory}') -and (test-path('#{dsc_environment_fail_etc_directory}')))

+{

+    throw 'Signature #{exception_message_signature}: Purposefully failing because cwd == #{dsc_environment_fail_etc_directory}'

+}

+environment "whatsmydir"

+{

+    Name = '#{dsc_environment_env_var_name}'

+    Value = $pwd.path

+    Ensure = 'Present'

+}

+EOH

+  }

+

   let(:dsc_config_name) {

     dsc_test_resource_base.name

   }

@@ -75,8 +183,10 @@ EOH
     dsc_test_resource_base.code(dsc_code)

     dsc_test_resource_base

   }

+  let(:config_name_value) { dsc_test_resource_base.name }

+

   let(:dsc_resource_from_path) {

-    dsc_test_resource_base.command(create_config_script_from_code(dsc_code, dsc_test_resource_base.name))

+    dsc_test_resource_base.command(create_config_script_from_code(dsc_code, config_name_value))

     dsc_test_resource_base

   }

 

@@ -100,6 +210,104 @@ EOH
       expect(dsc_test_resource.registry_key_exists?(test_registry_key)).to eq(true)

       expect(dsc_test_resource.registry_value_exists?(test_registry_key, {:name => test_registry_value, :type => :string, :data => test_registry_data})).to eq(true)

     end

+

+    it_should_behave_like 'a dsc_script resource with configuration affected by cwd'

+  end

+

+  shared_examples_for 'a dsc_script resource with configuration affected by cwd' do

+    after(:each) do

+      removal_resource = Chef::Resource::DscScript.new(dsc_test_resource_name, dsc_test_run_context)

+      removal_resource.code <<-EOH

+environment 'removethis'

+{

+   Name = '#{dsc_environment_env_var_name}'

+   Ensure = 'Absent'

+}

+EOH

+      removal_resource.run_action(:run)

+    end

+    let(:dsc_code) { dsc_environment_config }

+    it 'should not raise an exception if the cwd is not etc' do

+      dsc_test_resource.cwd(dsc_environment_no_fail_not_etc_directory)

+      expect {dsc_test_resource.run_action(:run)}.not_to raise_error

+    end

+

+    it 'should raise an exception if the cwd is etc' do

+      dsc_test_resource.cwd(dsc_environment_fail_etc_directory)

+      expect {dsc_test_resource.run_action(:run)}.to raise_error(Chef::Exceptions::PowershellCmdletException)

+      begin

+        dsc_test_resource.run_action(:run)

+      rescue Chef::Exceptions::PowershellCmdletException => e

+        expect(e.message).to match(exception_message_signature)

+      end

+    end

+  end

+

+  shared_examples_for 'a parameterized DSC configuration script' do

+    context 'when specifying environment variables in the environment attribute' do

+      let(:dsc_user_prefix_code) { dsc_user_prefix_env_code }

+      let(:dsc_user_suffix_code) { dsc_user_suffix_env_code }

+      it_behaves_like 'a dsc_script with configuration that uses environment variables'

+    end

+  end

+

+  shared_examples_for 'a dsc_script with configuration data' do

+    context 'when using the configuration_data attribute' do

+      let(:configuration_data_attribute) { 'configuration_data' }

+      it_behaves_like 'a dsc_script with configuration data set via an attribute'

+    end

+

+    context 'when using the configuration_data_script attribute' do

+      let(:configuration_data_attribute) { 'configuration_data_script' }

+      it_behaves_like 'a dsc_script with configuration data set via an attribute'

+    end

+  end

+

+  shared_examples_for 'a dsc_script with configuration data set via an attribute' do

+    it 'should run a configuration script that creates a user' do

+      config_data_value = dsc_user_config_data

+      dsc_test_resource.configuration_name(config_name_value)

+      if configuration_data_attribute == 'configuration_data_script'

+        config_data_value = create_config_script_from_code(dsc_user_config_data, '', true)

+      end

+      dsc_test_resource.environment({dsc_user_prefix_env_var_name => dsc_user_prefix,

+                                      dsc_user_suffix_env_var_name => dsc_user_suffix})

+      dsc_test_resource.send(configuration_data_attribute, config_data_value)

+      dsc_test_resource.flags(config_flags)

+      expect(user_exists?(dsc_user)).to eq(false)

+      expect {dsc_test_resource.run_action(:run)}.not_to raise_error

+      expect(user_exists?(dsc_user)).to eq(true)

+    end

+  end

+

+  shared_examples_for 'a dsc_script with configuration data that takes parameters' do

+    context 'when script code takes parameters for configuration' do

+      let(:dsc_user_code) { dsc_user_param_code }

+      let(:config_param_section) { config_params }

+      let(:config_flags) {{:"#{dsc_user_prefix_param_name}" => "#{dsc_user_prefix}", :"#{dsc_user_suffix_param_name}" => "#{dsc_user_suffix}"}}

+      it 'does not directly contain the user name' do

+        configuration_script_content = ::File.open(dsc_test_resource.command) do | file |

+          file.read

+        end

+        expect(configuration_script_content.include?(dsc_user)).to be(false)

+      end

+      it_behaves_like 'a dsc_script with configuration data'

+    end

+

+  end

+

+  shared_examples_for 'a dsc_script with configuration data that uses environment variables' do

+    context 'when script code uses environment variables' do

+      let(:dsc_user_code) { dsc_user_env_code }

+

+      it 'does not directly contain the user name' do

+        configuration_script_content = ::File.open(dsc_test_resource.command) do | file |

+          file.read

+        end

+        expect(configuration_script_content.include?(dsc_user)).to be(false)

+      end

+      it_behaves_like 'a dsc_script with configuration data'

+    end

   end

 

   context 'when supplying configuration through the configuration attribute' do

@@ -112,4 +320,17 @@ EOH
     it_behaves_like 'a dsc_script resource with specified PowerShell configuration code'

   end

 

+  context 'when running a configuration that manages users' do

+    before(:each) do

+      delete_user(dsc_user)

+    end

+

+    let(:dsc_code) { dsc_user_resources_code }

+    let(:config_name_value) { 'DSCTestConfig' }

+    let(:dsc_test_resource) { dsc_resource_from_path }

+

+    it_behaves_like 'a dsc_script with configuration data'

+    it_behaves_like 'a dsc_script with configuration data that uses environment variables'

+    it_behaves_like 'a dsc_script with configuration data that takes parameters'

+  end

 end