kitchen-dsc 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f56f2af0cfeec590f12172b55f424593b2eeefa9
-  data.tar.gz: 4ce34552f09fc64a8f27a61f341f6be7e3ac0360
+  metadata.gz: 3d4befbf6fdfec388662bfbc319ffac10e2dae3b
+  data.tar.gz: 088d558c6f4f46b0352906dbae8681da726794ed
 SHA512:
-  metadata.gz: c3aaf48b5c09b0d0801e5ef5fcee9c3962fa4600ea08b2d4de164eb8abaa5691ec4c5dc2be7c233c9310604ab8289e24bc292d2f81f8185765069bc5de33f56d
-  data.tar.gz: fc2de1fe451d96aa6d6680f957be61eb77dcc3527c40e77ee9d08e25f24868d3e1bb0ed37df228b7022820ede299decc9ea31826e4e792eac4bc9b6dd58e3372
+  metadata.gz: e9e84ab1f3b2738eaefd28e4d1c0328d09f25b5e48df8d7bf0c2f8aba86a91e1fd4d8ede3af46e2067e7234b1656e61895f1eb7b3593a34c20f34fc334b21573
+  data.tar.gz: b7e5d9f1c0934af9c9f8a7856a85efb0ea0593245b1fa1c4e94d8a650e80e1beebbb39ae2b075efa6f363d2c180017bbcd1e23cfe447e2ffc9efa9e4b333d4dc

data/README.md

@@ -8,4 +8,38 @@ You'll need a driver box with WMF4 or greater (ONLY WINDOWS SYSTEMS)
 ## Installation & Setup
 You'll need the test-kitchen & kitchen-dsc gems installed in your system, along with kitchen-vagrant or some ther suitable driver for test-kitchen. 
 
-## Example Configuration
+## Example Configurations
+[Repository Style Testing](https://github.com/smurawski/dsc-kitchen-project)
+[Module Style Testing](https://github.com/powershellorg/cwebadministration/tree/smurawski/adding_tests)
+
+## Configuration Settings
+* configuration_script_folder
+  * Defaults to 'examples'.
+  * The location of a PowerShell script(s) containing the DSC configuration command(s).
+* configuration_script
+  * Defaults to 'dsc_configuration.ps1'
+  * The name of the PowerShell script containing the DSC configuration command(s).
+  * The configuration command name used defaults to the suite name (and can be overridden by the run_list parameter in the suite).
+* dsc_local_configuration_manager_version
+  * Defaults to 'wmf4' ()
+  * Identifies what version of the LCM is in place
+  * Other valid values are 'wmf4_with_update' and 'wmf5'
+    * Currently the only difference between wmf4 and wmf4_with_update/wmf5 is the action_after_reboot and the debug_mode settings.  Eventually, I'd like to add support for partial configurations, pull servers, etc..
+  * In this context, wmf4_with_update refers to wmf4 with KB3000850 applied (to add support for WMF 5 generated configurations, plus some fixes).
+* dsc_local_configuration_manager
+  * Settings for the LCM
+  * Defaults are:
+    * action_after_reboot = 'StopConfiguration' # wmf4_with_update or wmf5
+    * allow_module_overwrite = false
+    * certificate_id = nil
+    * configuration_mode = 'ApplyAndAutoCorrect'
+    * configuration_mode_frequency_mins = 30
+    * debug_mode = 'All'                        # wmf4_with_update or wmf5
+    * refresh_frequency_mins = 15
+    * refresh_mode = 'PUSH'
+
+### Specific to repository style testing
+* modules_path
+  * Defaults to 'modules'.
+  * Points to the location of modules containing DSC resources to upload
+  * This path is relative to the root of the repository (the location of the .kitchen.yml).

data/lib/kitchen-dsc/version.rb

@@ -2,6 +2,6 @@
 
 module Kitchen
   module Dsc
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/lib/kitchen/provisioner/dsc.rb

@@ -16,46 +16,92 @@ module Kitchen
 
   module Provisioner
     class Dsc < Base
-
       kitchen_provisioner_api_version 2
 
       attr_accessor :tmp_dir
 
       default_config :modules_path, 'modules'
+      default_config :configuration_script_folder, 'examples'
       default_config :configuration_script, 'dsc_configuration.ps1'
 
-
+      default_config :dsc_local_configuration_manager_version, 'wmf4'
       default_config :dsc_local_configuration_manager, {
-        :wmf4 => {
-          :reboot_if_needed => false
-        },
-        :wmf5 => {
-          :reboot_if_needed => false,
-          :debug_mode => false
-        }
+        action_after_reboot: 'StopConfiguration',
+        allow_module_overwrite: false,
+        certificate_id: nil,
+        configuration_mode: 'ApplyAndAutoCorrect',
+        configuration_mode_frequency_mins: 30,
+        debug_mode: 'All',
+        reboot_if_needed: false,
+        refresh_frequency_mins: 15,
+        refresh_mode: 'PUSH'
       }
 
+      # Disable line length check, it is all embedded script.
+      # rubocop:disable Metrics/LineLength
       def install_command
+        lcm_config = config[:dsc_local_configuration_manager]
+        case config[:dsc_local_configuration_manager_version]
+        when 'wmf4_legacy'
+          lcm_configuration_script = <<-LCMSETUP
+            configuration SetupLCM
+            {
+              LocalConfigurationManager
+              {
+                AllowModuleOverwrite = [bool]::Parse('#{lcm_config[:allow_module_overwrite]}')
+                CertificateID = '#{lcm_config[:certificate_id].nil? ? '$null' : lcm_config[:certificate_id]}'
+                ConfigurationMode = '#{lcm_config[:configuration_mode]}'
+                ConfigurationModeFrequencyMins = #{lcm_config[:configuration_mode_frequency_mins]}
+                RebootNodeIfNeeded = [bool]::Parse('#{lcm_config[:reboot_if_needed]}')
+                RefreshFrequencyMins = #{lcm_config[:refresh_frequency_mins]}
+                RefreshMode = '#{lcm_config[:refresh_mode]}'
+              }
+            }
+            SetupLCM
+            Set-DscLocalConfigurationManager -Path ./SetupLCM
+          LCMSETUP
+        when 'wmf4_with_update', 'wmf5'
+          lcm_configuration_script = <<-LCMSETUP
+            configuration SetupLCM
+            {
+              LocalConfigurationManager
+              {
+                ActionAfterReboot = '#{lcm_config[:action_after_reboot]}'
+                AllowModuleOverwrite = [bool]::Parse('#{lcm_config[:allow_module_overwrite]}')
+                CertificateID = '#{lcm_config[:certificate_id].nil? ? '$null' : lcm_config[:certificate_id]}'
+                ConfigurationMode = '#{lcm_config[:configuration_mode]}'
+                ConfigurationModeFrequencyMins = #{lcm_config[:configuration_mode_frequency_mins]}
+                DebugMode = '#{lcm_config[:debug_mode]}'
+                RebootNodeIfNeeded = [bool]::Parse('#{lcm_config[:reboot_if_needed]}')
+                RefreshFrequencyMins = #{lcm_config[:refresh_frequency_mins]}
+                RefreshMode = '#{lcm_config[:refresh_mode]}'
+              }
+            }
+            SetupLCM
+            Set-DscLocalConfigurationManager -Path ./SetupLCM
+          LCMSETUP
+        end
+        wrap_shell_code(lcm_configuration_script)
       end
+      # rubocop:enable Metrics/LineLength
 
       def init_command
       end
 
       def create_sandbox
         super
-        module_path = File.join(config[:kitchen_root], config[:modules_path])
-        sandbox_module_path = File.join(sandbox_path, 'modules')
-        configuration_script_path = File.join(config[:kitchen_root], config[:configuration_script])
-        sandbox_configuration_script_path = File.join(sandbox_path, config[:configuration_script])
-
         info('Staging DSC Resource Modules for copy to the SUT')
-        debug("Moving #{module_path} to #{sandbox_module_path}")
-        FileUtils.cp_r(module_path, sandbox_module_path)
-
-        debug("Moving #{configuration_script_path} to #{sandbox_configuration_script_path}")
-        FileUtils.cp(configuration_script_path, sandbox_configuration_script_path)
+        if resource_module?
+          prepare_resource_style_directory
+        else
+          prepare_repo_style_directory
+        end
+        info('Staging DSC configuration script for copy to the SUT')
+        prepare_configuration_script
       end
 
+      # Disable line length check, it is all logging and embedded script.
+      # rubocop:disable Metrics/LineLength
       def prepare_command
         info('Moving DSC Resources onto PSModulePath')
         info("Generating the MOF script for the configuration #{current_configuration}")
@@ -63,7 +109,10 @@ module Kitchen
           dir ( join-path #{config[:root_path]} 'modules/*') -directory |
             copy-item -destination $env:programfiles/windowspowershell/modules/ -recurse -force
 
-          mkdir 'c:/configurations' | out-null
+          if (-not (test-path 'c:/configurations'))
+          {
+            mkdir 'c:/configurations' | out-null
+          }
           $ConfigurationScriptPath = Join-path #{config[:root_path]} #{config[:configuration_script]}
           if (-not (test-path $ConfigurationScriptPath))
           {
@@ -75,11 +124,12 @@ module Kitchen
         debug("Shelling out: #{stage_resources_and_generate_mof_script}")
         wrap_shell_code(stage_resources_and_generate_mof_script)
       end
+      # rubocop:enable Metrics/LineLength
 
       def run_command
         info("Running the configuration #{current_configuration}")
         run_configuration_script = <<-EOH
-          $job = start-dscconfiguration -Path c:/configurations/
+          $job = start-dscconfiguration -Path c:/configurations/ -force
           $job | wait-job
           $job.childjobs[0].verbose
         EOH
@@ -94,10 +144,58 @@ module Kitchen
         config.keys.include?(:run_list) ? config[:run_list][0] : @instance.suite.name
       end
 
-      def is_resource_module?
-        #TODO
+      def resource_module?
+        module_metadata_file = File.join(config[:kitchen_root], "#{module_name}.psd1")
+        module_dsc_resource_folder = File.join(config[:kitchen_root], 'DSCResources')
+        File.exist?(module_metadata_file) &&
+          File.exist?(module_dsc_resource_folder)
+      end
+
+      def list_files(path)
+        base_directory_content = Dir.glob(File.join(path, '*'))
+        nested_directory_content = Dir.glob(File.join(path, '*/**/*'))
+        all_directory_content =([base_directory_content, nested_directory_content]).flatten
+
+        ignore_files = ['Gemfile', 'Gemfile.lock', 'README.md', 'LICENSE.txt']
+        all_directory_content.reject do |f|
+          debug("Enumerating #{f}")
+          ignore_files.include?(File.basename(f)) || File.directory?(f)
+        end
+      end
+
+      def module_name
+        File.basename(config[:kitchen_root])
+      end
+
+      def prepare_resource_style_directory
+        sandbox_base_module_path = File.join(sandbox_path, "modules/#{module_name}")
+
+        base = config[:kitchen_root]
+        list_files(base).each do |src|
+          dest = File.join(sandbox_base_module_path, src.sub("#{base}/", ''))
+          FileUtils.mkdir_p(File.dirname(dest))
+          debug("Staging #{src} ")
+          debug("  at #{dest}")
+          FileUtils.cp(src, dest, preserve: true)
+        end
+      end
+
+      def prepare_repo_style_directory
+        module_path = File.join(config[:kitchen_root], config[:modules_path])
+        sandbox_module_path = File.join(sandbox_path, 'modules')
+
+        debug("Moving #{module_path} to #{sandbox_module_path}")
+        FileUtils.cp_r(module_path, sandbox_module_path)
       end
 
+      def prepare_configuration_script
+        configuration_script_file = File.join(config[:configuration_script_folder], config[:configuration_script])
+        configuration_script_path = File.join(config[:kitchen_root], configuration_script_file)
+        sandbox_configuration_script_path = File.join(sandbox_path, config[:configuration_script])
+
+        debug("Moving #{configuration_script_path} to #{sandbox_configuration_script_path}")
+        FileUtils.cp(configuration_script_path, sandbox_configuration_script_path)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dsc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-09 00:00:00.000000000 Z
 dependencies: []
 description: |+
   == DESCRIPTION: