kitchen-dsc 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2306c243f65cad6f2d2080a500d65fe71a875e53
-  data.tar.gz: b6d307e16a48a0c85d5500816d5c4c14e82077d6
+  metadata.gz: 15912b49fe3ff3144d49f605434b15e05fb155bf
+  data.tar.gz: 7cc40f3a658927a59ca6d6f1241392943244677e
 SHA512:
-  metadata.gz: d6d4e0db90b1476db78803a3641b2a650d52ae9baab67ef01356cc5cab114bc2af2f4f79e5ddc94a6f22b7d39b136b42b74c59a27ba79ecab062dc7fe79d2c2d
-  data.tar.gz: dcce1e8063ea43ecfea9ac0f50d2d82e40158dc2d12150d66b8c4c63e8d3cf9d9205a2e955d1d75377e2963050a43bc9afd393a54002c1d6b63dfcca327e93bc
+  metadata.gz: e26cd1fccd5af9d09ffef4dc1a0ca1075d3f25d48155525a5f2fbaeef5fa978818f818377b42e86679acb8bc3d91e210521a5f7903e0de5931a644195714611b
+  data.tar.gz: 14e5db6f434eb11ef8dcadf47ee70fbcdbc06c30e54fc7636036c5cefe48d04b49003dc86e4279a65f7d6372c4f6433d87b0a93ea122a2756f9b8f9ea7d84fde

data/README.md

@@ -1,108 +1,108 @@
-[![Gem Version](https://badge.fury.io/rb/kitchen-dsc.svg)](http://badge.fury.io/rb/kitchen-dsc)
-
-# kitchen-dsc
-A Test Kitchen Provisioner for PowerShell DSC
-
-
-## Requirements
-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. 
-
-### Note:
-You will see a delay in the return of the run details due to an difference in how the verbose stream is returned for DSC runs between WMF versions, so I return the verbose stream after the job completes.  I'd love to live stream the results, but that'll take a bit more experimentation. (PR's welcome!)
-
-## 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) (and possibly configuration data)
-
-* configuration_name
-  * Name of the configuration to run, defaults to the suite name.
-
-* configuration_data
-  * A YAML representation of what should be passed to the configuration.
-  * Overrides any configurationdata variable assigned in the configuration script.
-
-* configuration_data_variable
-  * Defaults to 'ConfigurationData'
-  * Name of the variable that contains the ConfigurationData hashtable
-  * Can be defined in the configuration script or via the `configuration_data` configuration setting.
-
-* 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
-    * reboot_if_needed = false
-    * allow_module_overwrite = false
-    * certificate_id = nil
-    * configuration_mode = 'ApplyAndAutoCorrect'
-    * configuration_mode_frequency_mins = 30    # 15 on wmf5
-    * debug_mode = 'All'                        # wmf4_with_update
-    * refresh_frequency_mins = 15               # 30 on wmf5
-    * refresh_mode = 'PUSH'
-
-* modules_from_gallery
-  * Requires WMF 5
-  * Takes a string (for one module) or an array (for multiple) to install from the gallery
-  * Or takes a hash with keys matching the parameters for install-module.  
-    * Name is required.  
-    * Force is automatically used and not required as part of the hash table.
-    * Repository defaults to either PSGallery or any custom feed defined, but can be overriden here.
-
-* gallery_name
-  * Custom PowerShell gallery name to install modules from.
-  * If there is no package source with this name registered on the machine, then gallery_uri must be configured as well.
-
-* gallery_uri
-  * URI for a custom PowerShell gallery feed.
-
-### 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).
-
-## Example 
-
-```yaml
-provisioner:
-  - name: dsc
-    dsc_local_configuration_manager_version: wmf5
-    dsc_local_configuration_manager:
-      reboot_if_needed: true
-      debug_mode: none
-    configuration_script_folder: .
-    configuration_script: SampleConfig.ps1
-    gallery_uri: https://ci.appveyor.com/nuget/xWebAdministration
-    gallery_name: xWebDevFeed
-    modules_from_gallery:
-      - xWebAdministration
-      - name: xComputerManagement
-        requiredversion: 1.4.0.0
-        repository: PSGallery
-
-suite:
-  - name: test
-    provisioner:
-      configuration_data:
-        AllNodes:
-          - nodename: localhost
-            role: webserver
+[![Gem Version](https://badge.fury.io/rb/kitchen-dsc.svg)](http://badge.fury.io/rb/kitchen-dsc)
+
+# kitchen-dsc
+A Test Kitchen Provisioner for PowerShell DSC
+
+
+## Requirements
+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. 
+
+### Note:
+You will see a delay in the return of the run details due to an difference in how the verbose stream is returned for DSC runs between WMF versions, so I return the verbose stream after the job completes.  I'd love to live stream the results, but that'll take a bit more experimentation. (PR's welcome!)
+
+## 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) (and possibly configuration data)
+
+* configuration_name
+  * Name of the configuration to run, defaults to the suite name.
+
+* configuration_data
+  * A YAML representation of what should be passed to the configuration.
+  * Overrides any configurationdata variable assigned in the configuration script.
+
+* configuration_data_variable
+  * Defaults to 'ConfigurationData'
+  * Name of the variable that contains the ConfigurationData hashtable
+  * Can be defined in the configuration script or via the `configuration_data` configuration setting.
+
+* 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
+    * reboot_if_needed = false
+    * allow_module_overwrite = false
+    * certificate_id = nil
+    * configuration_mode = 'ApplyAndAutoCorrect'
+    * configuration_mode_frequency_mins = 30    # 15 on wmf5
+    * debug_mode = 'All'                        # wmf4_with_update
+    * refresh_frequency_mins = 15               # 30 on wmf5
+    * refresh_mode = 'PUSH'
+
+* modules_from_gallery
+  * Requires WMF 5
+  * Takes a string (for one module) or an array (for multiple) to install from the gallery
+  * Or takes a hash with keys matching the parameters for install-module.  
+    * Name is required.  
+    * Force is automatically used and not required as part of the hash table.
+    * Repository defaults to either PSGallery or any custom feed defined, but can be overriden here.
+
+* gallery_name
+  * Custom PowerShell gallery name to install modules from.
+  * If there is no package source with this name registered on the machine, then gallery_uri must be configured as well.
+
+* gallery_uri
+  * URI for a custom PowerShell gallery feed.
+
+### 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).
+
+## Example 
+
+```yaml
+provisioner:
+  - name: dsc
+    dsc_local_configuration_manager_version: wmf5
+    dsc_local_configuration_manager:
+      reboot_if_needed: true
+      debug_mode: none
+    configuration_script_folder: .
+    configuration_script: SampleConfig.ps1
+    gallery_uri: https://ci.appveyor.com/nuget/xWebAdministration
+    gallery_name: xWebDevFeed
+    modules_from_gallery:
+      - xWebAdministration
+      - name: xComputerManagement
+        requiredversion: 1.4.0.0
+        repository: PSGallery
+
+suite:
+  - name: test
+    provisioner:
+      configuration_data:
+        AllNodes:
+          - nodename: localhost
+            role: webserver
 ```

data/kitchen-dsc.gemspec

@@ -1,48 +1,48 @@
-# encoding: utf-8
-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "kitchen-dsc/version"
-
-Gem::Specification.new do |s|
-  s.name              = "kitchen-dsc"
-  s.version           = Kitchen::Dsc::VERSION
-  s.authors           = ["Steven Murawski"]
-  s.email             = ["smurawski@chef.io"]
-  s.homepage          = "https://github.com/test-kitchen/kitchen-dsc"
-  s.summary           = "PowerShell DSC provisioner for test-kitchen"
-  candidates          = Dir.glob("lib/**/*") + ["README.md", "kitchen-dsc.gemspec"]
-  s.files             = candidates.sort
-  s.platform          = Gem::Platform::RUBY
-  s.require_paths     = ["lib"]
-  s.rubyforge_project = "[none]"
-  s.license           = "Apache 2"
-  s.description       = <<-EOF
-== DESCRIPTION:
-
-DSC Provisioner for Test Kitchen
-
-== FEATURES:
-
-TBD
-
-EOF
-  s.add_dependency "test-kitchen", ">= 1.9"
-  s.add_dependency "dsc_lcm_configuration"
-
-  s.add_development_dependency "countloc", "~> 0.4"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec",     "~> 3.2"
-  s.add_development_dependency "simplecov", "~> 0.9"
-  s.add_development_dependency "minitest",  "~> 5.3"
-  s.add_development_dependency "yard",      "~> 0.8"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "pry-stack_explorer"
-  s.add_development_dependency "pry-byebug"
-  s.add_development_dependency "rb-readline"
-
-  # style and complexity libraries are tightly version pinned as newer releases
-  # may introduce new and undesireable style choices which would be immediately
-  # enforced in CI
-  s.add_development_dependency "finstyle",  "1.4.0"
-  s.add_development_dependency "cane",      "2.6.2"
-end
+# encoding: utf-8
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "kitchen-dsc/version"
+
+Gem::Specification.new do |s|
+  s.name              = "kitchen-dsc"
+  s.version           = Kitchen::Dsc::VERSION
+  s.authors           = ["Steven Murawski"]
+  s.email             = ["smurawski@chef.io"]
+  s.homepage          = "https://github.com/test-kitchen/kitchen-dsc"
+  s.summary           = "PowerShell DSC provisioner for test-kitchen"
+  candidates          = Dir.glob("lib/**/*") + ["README.md", "kitchen-dsc.gemspec"]
+  s.files             = candidates.sort
+  s.platform          = Gem::Platform::RUBY
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = "[none]"
+  s.license           = "Apache 2"
+  s.description       = <<-EOF
+== DESCRIPTION:
+
+DSC Provisioner for Test Kitchen
+
+== FEATURES:
+
+TBD
+
+EOF
+  s.add_dependency "test-kitchen", ">= 1.9"
+  s.add_dependency "dsc_lcm_configuration"
+
+  s.add_development_dependency "countloc", "~> 0.4"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec",     "~> 3.2"
+  s.add_development_dependency "simplecov", "~> 0.9"
+  s.add_development_dependency "minitest",  "~> 5.3"
+  s.add_development_dependency "yard",      "~> 0.8"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-stack_explorer"
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "rb-readline"
+
+  # style and complexity libraries are tightly version pinned as newer releases
+  # may introduce new and undesireable style choices which would be immediately
+  # enforced in CI
+  s.add_development_dependency "finstyle",  "1.4.0"
+  s.add_development_dependency "cane",      "2.6.2"
+end

data/lib/kitchen-dsc/version.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
-
-module Kitchen
-  module Dsc
-    VERSION = '0.10.0'.freeze
-  end
-end
+# encoding: utf-8
+
+module Kitchen
+  module Dsc
+    VERSION = '0.10.1'.freeze
+  end
+end

data/lib/kitchen/provisioner/dsc.rb

@@ -1,291 +1,311 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Steven Murawski (<steven.murawski@gmail.com>)
-#
-# Copyright (C) 2014 Steven Murawski
-#
-# Licensed under the Apache 2 License.
-# See LICENSE for more details
-
-require "fileutils"
-require "pathname"
-require "kitchen/provisioner/base"
-require "kitchen/util"
-require "dsc_lcm_configuration"
-
-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 :configuration_name do |provisioner|
-        provisioner.instance.suite.name
-      end
-
-      default_config :configuration_data_variable, "ConfigurationData"
-      default_config :configuration_data
-
-      default_config :nuget_force_bootstrap, true
-      default_config :gallery_uri
-      default_config :gallery_name
-      default_config :modules_from_gallery
-
-      default_config :dsc_local_configuration_manager_version, "wmf4"
-      default_config :dsc_local_configuration_manager, {}
-
-      def finalize_config!(instance)
-        config[:dsc_local_configuration_manager] = lcm.lcm_config
-        super(instance)
-      end
-
-      def install_command
-        full_lcm_configuration_script = <<-EOH
-        #{lcm.lcm_configuration_script}
-
-        $null = SetupLCM
-        Set-DscLocalConfigurationManager -Path ./SetupLCM | out-null
-        EOH
-
-        wrap_powershell_code(full_lcm_configuration_script)
-      end
-
-      def init_command
-        script = <<-EOH
-#{setup_config_directory_script}
-#{install_module_script if install_modules?}
-        EOH
-        wrap_powershell_code(script)
-      end
-
-      def create_sandbox
-        super
-        info("Staging DSC Resource Modules for copy to the SUT")
-        if powershell_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
-
-      def prepare_command
-        info("Moving DSC Resources onto PSModulePath")
-        info("Generating the MOF script for the configuration #{config[:configuration_name]}")
-        stage_resources_and_generate_mof_script = <<-EOH
-          if (Test-Path (join-path #{config[:root_path]} 'modules'))
-          {
-            dir ( join-path #{config[:root_path]} 'modules/*') -directory |
-              copy-item -destination $env:programfiles/windowspowershell/modules/ -recurse -force
-          }
-          if (-not (test-path 'c:/configurations'))
-          {
-            mkdir 'c:/configurations' | out-null
-          }
-          $ConfigurationScriptPath = Join-path #{config[:root_path]} #{sandboxed_configuration_script}
-          if (-not (test-path $ConfigurationScriptPath))
-          {
-            throw "Failed to find $ConfigurationScriptPath"
-          }
-          invoke-expression (get-content $ConfigurationScriptPath -raw)
-          if (-not (get-command #{config[:configuration_name]}))
-          {
-            throw "Failed to create a configuration command #{config[:configuration_name]}"
-          }
-
-          #{configuration_data_assignment unless config[:configuration_data].nil?}
-
-          $null = #{config[:configuration_name]} -outputpath c:/configurations #{"-configurationdata $" + configuration_data_variable}
-        EOH
-        debug("Shelling out: #{stage_resources_and_generate_mof_script}")
-        wrap_powershell_code(stage_resources_and_generate_mof_script)
-      end
-
-      def run_command
-        config[:retry_on_exit_code] = [35] if config[:retry_on_exit_code].empty?
-        config[:max_retries] = 3 if config[:max_retries] == 1
-
-        info("Running the configuration #{config[:configuration_name]}")
-        run_configuration_script = <<-EOH
-          $job = start-dscconfiguration -Path c:/configurations/ -force
-          $job | wait-job
-          $verbose_output = $job.childjobs[0].verbose
-          $verbose_output
-          if ($verbose_output -match 'A reboot is required to progress further. Please reboot the system.') {
-            "A reboot is required to continue."
-            shutdown /r /t 15
-            exit 35
-          }
-          $dsc_errors = $job.childjobs[0].Error
-          if ($dsc_errors -ne $null) {
-            $dsc_errors
-            exit 1
-          }
-        EOH
-
-        debug("Shelling out: #{run_configuration_script}")
-        wrap_powershell_code(run_configuration_script)
-      end
-
-      private
-
-      def lcm
-        @lcm ||= begin
-          lcm_version = config[:dsc_local_configuration_manager_version]
-          lcm_config = config[:dsc_local_configuration_manager]
-          DscLcmConfiguration::Factory.create(lcm_version, lcm_config)
-        end
-      end
-
-      def setup_config_directory_script
-        "mkdir (split-path (join-path #{config[:root_path]} #{sandboxed_configuration_script})) -force | out-null"
-      end
-
-      def powershell_module_params(module_specification_hash)
-        keys = module_specification_hash.keys.reject { |k| k.to_s.casecmp('force') == 0 }
-        unless keys.any? { |k| k.to_s.downcase == 'repository' }
-          keys.push(:repository)
-          module_specification_hash[:repository] = psmodule_repository_name
-        end
-        keys.map { |key| "-#{key} #{module_specification_hash[key]}" }.join(' ')
-      end
-
-      def powershell_modules
-        Array(config[:modules_from_gallery]).map do |powershell_module|
-          params = if powershell_module.is_a? Hash
-                     powershell_module_params(powershell_module)
-                   else
-                     "-name '#{powershell_module}' -Repository #{psmodule_repository_name}"
-                   end
-          "install-module #{params} -force | out-null"
-        end
-      end
-
-      def nuget_force_bootstrap
-        return unless config[:nuget_force_bootstrap]
-        info("Bootstrapping the nuget package provider for PowerShell PackageManagement.")
-        "install-packageprovider nuget -force -forcebootstrap | out-null"
-      end
-
-      def psmodule_repository_name
-        return "PSGallery" if config[:gallery_name].nil? && config[:gallery_uri].nil?
-        return "testing"   if config[:gallery_name].nil?
-        config[:gallery_name]
-      end
-
-      def register_psmodule_repository
-        return if config[:gallery_uri].nil?
-        info("Registering a new PowerShellGet Repository - #{psmodule_repository_name}")
-        "register-packagesource -providername PowerShellGet -name '#{psmodule_repository_name}' -location '#{config[:gallery_uri]}' -force -trusted"
-      end
-
-      def install_module_script
-        return if config[:modules_from_gallery].nil?
-        <<-EOH
-  #{nuget_force_bootstrap}
-  #{register_psmodule_repository}
-  #{powershell_modules.join("\n")}
-        EOH
-      end
-
-      def install_modules?
-        config[:dsc_local_configuration_manager_version] == "wmf5" &&
-          !config[:modules_from_gallery].nil?
-      end
-
-      def configuration_data_variable
-        config[:configuration_data_variable].nil? ? "ConfigurationData" : config[:configuration_data_variable]
-      end
-
-      def configuration_data_assignment
-        "$" + configuration_data_variable + " = " + ps_hash(config[:configuration_data])
-      end
-
-      def wrap_powershell_code(code)
-        wrap_shell_code(["$ProgressPreference = 'SilentlyContinue';", code].join("\n"))
-      end
-
-      def powershell_module?
-        module_metadata_file = File.join(config[:kitchen_root], "#{module_name}.psd1")
-        File.exist?(module_metadata_file)
-      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")
-
-        if Dir.exist?(module_path)
-          debug("Moving #{module_path} to #{sandbox_module_path}")
-          FileUtils.cp_r(module_path, sandbox_module_path)
-        else
-          debug("The modules path #{module_path} was not found. Not moving to #{sandbox_module_path}.")
-        end
-      end
-
-      def sandboxed_configuration_script
-        File.join("configuration", config[:configuration_script])
-      end
-
-      def pad(depth = 0)
-        " " * depth
-      end
-
-      def ps_hash(obj, depth = 0)
-        if obj.is_a?(Hash)
-          obj.map do |k, v|
-            %{#{pad(depth + 2)}#{ps_hash(k)} = #{ps_hash(v, depth + 2)}}
-          end.join(";\n").insert(0, "@{\n").insert(-1, "\n#{pad(depth)}}")
-        elsif obj.is_a?(Array)
-          array_string = obj.map { |v| ps_hash(v, depth + 4) }.join(",")
-          "#{pad(depth)}@(\n#{array_string}\n)"
-        else
-          %{"#{obj}"}
-        end
-      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, sandboxed_configuration_script)
-        FileUtils.mkdir_p(File.dirname(sandbox_configuration_script_path))
-        debug("Moving #{configuration_script_path} to #{sandbox_configuration_script_path}")
-        FileUtils.cp(configuration_script_path, sandbox_configuration_script_path)
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Steven Murawski (<steven.murawski@gmail.com>)
+#
+# Copyright (C) 2014 Steven Murawski
+#
+# Licensed under the Apache 2 License.
+# See LICENSE for more details
+
+require "fileutils"
+require "pathname"
+require "kitchen/provisioner/base"
+require "kitchen/util"
+require "dsc_lcm_configuration"
+
+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 :configuration_name do |provisioner|
+        provisioner.instance.suite.name
+      end
+
+      default_config :configuration_data_variable, "ConfigurationData"
+      default_config :configuration_data
+
+      default_config :nuget_force_bootstrap, true
+      default_config :gallery_uri
+      default_config :gallery_name
+      default_config :modules_from_gallery
+
+      default_config :dsc_local_configuration_manager_version, "wmf4"
+      default_config :dsc_local_configuration_manager, {}
+
+      def finalize_config!(instance)
+        config[:dsc_local_configuration_manager] = lcm.lcm_config
+        super(instance)
+      end
+
+      def install_command
+        full_lcm_configuration_script = <<-EOH
+        #{lcm.lcm_configuration_script}
+
+        $null = SetupLCM
+        Set-DscLocalConfigurationManager -Path ./SetupLCM | out-null
+        EOH
+
+        wrap_powershell_code(full_lcm_configuration_script)
+      end
+
+      def init_command
+        script = <<-EOH
+#{setup_config_directory_script}
+#{install_module_script if install_modules?}
+        EOH
+        wrap_powershell_code(script)
+      end
+
+      def create_sandbox
+        super
+        info("Staging DSC Resource Modules for copy to the SUT")
+        if powershell_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
+
+      def prepare_command
+        info("Moving DSC Resources onto PSModulePath")
+        info("Generating the MOF script for the configuration #{config[:configuration_name]}")
+        stage_resources_and_generate_mof_script = <<-EOH
+
+          if(Test-Path c:/configurations)
+          {
+              Remove-Item -Recurse -Force c:/configurations
+          }
+
+          $Error.clear()
+
+          if (Test-Path (join-path #{config[:root_path]} 'modules'))
+          {
+            dir ( join-path #{config[:root_path]} 'modules/*') -directory |
+              copy-item -destination $env:programfiles/windowspowershell/modules/ -recurse -force
+          }
+          if (-not (test-path 'c:/configurations'))
+          {
+            mkdir 'c:/configurations' | out-null
+          }
+          $ConfigurationScriptPath = Join-path #{config[:root_path]} #{sandboxed_configuration_script}
+          if (-not (test-path $ConfigurationScriptPath))
+          {
+            throw "Failed to find $ConfigurationScriptPath"
+          }
+          invoke-expression (get-content $ConfigurationScriptPath -raw)
+
+          if (-not (get-command #{config[:configuration_name]}))
+          {
+            throw "Failed to create a configuration command #{config[:configuration_name]}"
+          }
+
+          #{configuration_data_assignment unless config[:configuration_data].nil?}
+
+          try{
+            $null = #{config[:configuration_name]} -outputpath c:/configurations #{"-configurationdata $" + configuration_data_variable}
+          }
+          catch{
+          }
+
+          if($Error -ne $null)
+          {
+            $Error[-1]
+            exit 1
+          }
+
+        EOH
+        debug("Shelling out: #{stage_resources_and_generate_mof_script}")
+        wrap_powershell_code(stage_resources_and_generate_mof_script)
+      end
+
+      def run_command
+        config[:retry_on_exit_code] = [35] if config[:retry_on_exit_code].empty?
+        config[:max_retries] = 3 if config[:max_retries] == 1
+
+        info("Running the configuration #{config[:configuration_name]}")
+        run_configuration_script = <<-EOH
+          $job = start-dscconfiguration -Path c:/configurations/ -force
+          $job | wait-job
+          $verbose_output = $job.childjobs[0].verbose
+          $verbose_output
+          if ($verbose_output -match 'A reboot is required to progress further. Please reboot the system.') {
+            "A reboot is required to continue."
+            shutdown /r /t 15
+            exit 35
+          }
+          $dsc_errors = $job.childjobs[0].Error
+          if ($dsc_errors -ne $null) {
+            $dsc_errors
+            exit 1
+          }
+        EOH
+
+        debug("Shelling out: #{run_configuration_script}")
+        wrap_powershell_code(run_configuration_script)
+      end
+
+      private
+
+      def lcm
+        @lcm ||= begin
+          lcm_version = config[:dsc_local_configuration_manager_version]
+          lcm_config = config[:dsc_local_configuration_manager]
+          DscLcmConfiguration::Factory.create(lcm_version, lcm_config)
+        end
+      end
+
+      def setup_config_directory_script
+        "mkdir (split-path (join-path #{config[:root_path]} #{sandboxed_configuration_script})) -force | out-null"
+      end
+
+      def powershell_module_params(module_specification_hash)
+        keys = module_specification_hash.keys.reject { |k| k.to_s.casecmp('force') == 0 }
+        unless keys.any? { |k| k.to_s.downcase == 'repository' }
+          keys.push(:repository)
+          module_specification_hash[:repository] = psmodule_repository_name
+        end
+        keys.map { |key| "-#{key} #{module_specification_hash[key]}" }.join(' ')
+      end
+
+      def powershell_modules
+        Array(config[:modules_from_gallery]).map do |powershell_module|
+          params = if powershell_module.is_a? Hash
+                     powershell_module_params(powershell_module)
+                   else
+                     "-name '#{powershell_module}' -Repository #{psmodule_repository_name}"
+                   end
+          "install-module #{params} -force | out-null"
+        end
+      end
+
+      def nuget_force_bootstrap
+        return unless config[:nuget_force_bootstrap]
+        info("Bootstrapping the nuget package provider for PowerShell PackageManagement.")
+        "install-packageprovider nuget -force -forcebootstrap | out-null"
+      end
+
+      def psmodule_repository_name
+        return "PSGallery" if config[:gallery_name].nil? && config[:gallery_uri].nil?
+        return "testing"   if config[:gallery_name].nil?
+        config[:gallery_name]
+      end
+
+      def register_psmodule_repository
+        return if config[:gallery_uri].nil?
+        info("Registering a new PowerShellGet Repository - #{psmodule_repository_name}")
+        "register-packagesource -providername PowerShellGet -name '#{psmodule_repository_name}' -location '#{config[:gallery_uri]}' -force -trusted"
+      end
+
+      def install_module_script
+        return if config[:modules_from_gallery].nil?
+        <<-EOH
+  #{nuget_force_bootstrap}
+  #{register_psmodule_repository}
+  #{powershell_modules.join("\n")}
+        EOH
+      end
+
+      def install_modules?
+        config[:dsc_local_configuration_manager_version] == "wmf5" &&
+          !config[:modules_from_gallery].nil?
+      end
+
+      def configuration_data_variable
+        config[:configuration_data_variable].nil? ? "ConfigurationData" : config[:configuration_data_variable]
+      end
+
+      def configuration_data_assignment
+        "$" + configuration_data_variable + " = " + ps_hash(config[:configuration_data])
+      end
+
+      def wrap_powershell_code(code)
+        wrap_shell_code(["$ProgressPreference = 'SilentlyContinue';", code].join("\n"))
+      end
+
+      def powershell_module?
+        module_metadata_file = File.join(config[:kitchen_root], "#{module_name}.psd1")
+        File.exist?(module_metadata_file)
+      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")
+
+        if Dir.exist?(module_path)
+          debug("Moving #{module_path} to #{sandbox_module_path}")
+          FileUtils.cp_r(module_path, sandbox_module_path)
+        else
+          debug("The modules path #{module_path} was not found. Not moving to #{sandbox_module_path}.")
+        end
+      end
+
+      def sandboxed_configuration_script
+        File.join("configuration", config[:configuration_script])
+      end
+
+      def pad(depth = 0)
+        " " * depth
+      end
+
+      def ps_hash(obj, depth = 0)
+        if obj.is_a?(Hash)
+          obj.map do |k, v|
+            %{#{pad(depth + 2)}#{ps_hash(k)} = #{ps_hash(v, depth + 2)}}
+          end.join(";\n").insert(0, "@{\n").insert(-1, "\n#{pad(depth)}}")
+        elsif obj.is_a?(Array)
+          array_string = obj.map { |v| ps_hash(v, depth + 4) }.join(",")
+          "#{pad(depth)}@(\n#{array_string}\n)"
+        else
+          %{"#{obj}"}
+        end
+      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, sandboxed_configuration_script)
+        FileUtils.mkdir_p(File.dirname(sandbox_configuration_script_path))
+        debug("Moving #{configuration_script_path} to #{sandbox_configuration_script_path}")
+        FileUtils.cp(configuration_script_path, sandbox_configuration_script_path)
+      end
+    end
+  end
+end