kitchen-dsc 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15912b49fe3ff3144d49f605434b15e05fb155bf
-  data.tar.gz: 7cc40f3a658927a59ca6d6f1241392943244677e
+  metadata.gz: e624fe030f3b2b0b22bc97d9225668a67c55045e
+  data.tar.gz: f9c7ce4985d3115dc6ee61f10dd57d76f96b17b4
 SHA512:
-  metadata.gz: e26cd1fccd5af9d09ffef4dc1a0ca1075d3f25d48155525a5f2fbaeef5fa978818f818377b42e86679acb8bc3d91e210521a5f7903e0de5931a644195714611b
-  data.tar.gz: 14e5db6f434eb11ef8dcadf47ee70fbcdbc06c30e54fc7636036c5cefe48d04b49003dc86e4279a65f7d6372c4f6433d87b0a93ea122a2756f9b8f9ea7d84fde
+  metadata.gz: 6c6bdec9163a77a027f07101c4806305528b8b3aa6b7d2694c7ea000d56ba3b25d62a8c922f3f410adc3c81383056ceafccf14d0b8683c7cceb14709b0e7823e
+  data.tar.gz: '0686ca5ffd4a6b58115220aab4d157ef11a34a588e2b76d50326d880012a2d5f073a6a7d3db7e6ccec16aa7f49a356d1d37567ae159f648b43847b614cd3058f'

data/lib/kitchen-dsc/version.rb

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

data/lib/kitchen/provisioner/dsc.rb

@@ -1,311 +1,328 @@
-# -*- 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
+# -*- 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 :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")
+        scripts = <<-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
+        }
+
+        $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)
+
+        EOH
+        ensure_array(config[:configuration_name]).each do |configuration|
+          info("Generating the MOF script for the configuration #{configuration}")
+          stage_resources_and_generate_mof_script = <<-EOH
+  
+            if(Test-Path c:/configurations/#{configuration})
+            {
+                Remove-Item -Recurse -Force c:/configurations/#{configuration}
+            }
+  
+            $Error.clear()
+  
+            if (-not (test-path 'c:/configurations'))
+            {
+              mkdir 'c:/configurations' | out-null
+            }
+  
+            if (-not (get-command #{configuration}))
+            {
+              throw "Failed to create a configuration command #{configuration}"
+            }
+  
+            #{configuration_data_assignment unless config[:configuration_data].nil?}
+  
+            try{
+              $null = #{configuration} -outputpath c:/configurations/#{configuration} #{"-configurationdata $" + configuration_data_variable}
+            }
+            catch{
+            }
+  
+            if($Error -ne $null)
+            {
+              $Error[-1]
+              exit 1
+            }
+  
+          EOH
+          scripts << stage_resources_and_generate_mof_script
+        end
+        debug("Shelling out: #{scripts}")
+        wrap_powershell_code(scripts)
+      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
+        scripts = ''
+        ensure_array(config[:configuration_name]).each do |configuration|
+          info("Running the configuration #{configuration}")
+          run_configuration_script = <<-EOH
+            $job = start-dscconfiguration -Path c:/configurations/#{configuration} -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
+          scripts << run_configuration_script
+        end
+        debug("Shelling out: #{scripts}")
+        wrap_powershell_code(scripts)
+      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
+
+      def ensure_array(thing)
+        if thing.is_a?(Array)
+          return thing
+        else
+          return [thing]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-dsc
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Steven Murawski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen