vagrant-dsc 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4b6efc99d9b93981b271840132718d939117be3
-  data.tar.gz: 3696ac715f5a013f3b8b4ffba17a2974423ca0ab
+  metadata.gz: f7a7b684574c26b5bcf147def321de8149691c22
+  data.tar.gz: 74830fc81b58b8b334a6023d6354580f29b995eb
 SHA512:
-  metadata.gz: b49654d807da8cfa54dc7c4f727f3cc6d1fd2bc2b9b5f9e4e3cc006581a8df57214486e459f9207a75b97e9ff71b031dd19d5e4356fc2863bb7134cc62c68352
-  data.tar.gz: b481a266b8541979cf98275a07bb7be67cc16e8b205f89af7d984b29250330bc7d0d22b245cfc492aea3dd1be7cf629f74f357f76f2be416420105e4cdb5ec13
+  metadata.gz: b13745414a9573bcb4d18f2175a17fecd952d4e8359d0b370d2b1e0c6af580a6697cb3c5a54692d109123954e8f1119b2aa46f7ea7ff5a3dcd258df4edc73172
+  data.tar.gz: 7eb8afd365a96f8932ef9d00979a264972eeb22124a60cf01a98da23cab8725d6848cf9b4077f63e8ead2706abc4e5e6e97de4f1475e48b83fe86537b16b16a8

data/README.md

@@ -85,8 +85,9 @@ Vagrant DSC will create and manage it for you automatically.
 
 ## Example
 
-There is a [sample](https://github.com/mefellows/vagrant-dsc/tree/master/development) Vagrant setup used for development of this plugin.
-This is a great real-life example to get you on your way.
+There is a [sample](https://github.com/mefellows/vagrant-dsc/tree/master/development/web) 
+Vagrant setup used for development of this plugin. This is a great real-life example 
+to get you on your way.
 
 ## Creating Windows Vagrant boxes
 
@@ -120,7 +121,7 @@ We may consider automatically installing and configuring DSC in a future release
 
 ## Development
 
-Before getting started, read the Vagrant plugin [development basics](https://docs.vagrantup.com/v2/plugins/development-basics.html) and [packaging](https://docs.vagrantup.com/v2/plugins/packaging.html] documentation.
+Before getting started, read the Vagrant plugin [development basics](https://docs.vagrantup.com/v2/plugins/development-basics.html) and [packaging](https://docs.vagrantup.com/v2/plugins/packaging.html) documentation.
 
 You will need Ruby 1.9.3+ and Bundler installed before proceeding.
 

data/appveyor.yml

@@ -0,0 +1,13 @@
+install:
+  - set PATH=C:\Ruby22\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake spec

data/development/reboot/Vagrantfile

@@ -0,0 +1,35 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+$shell_script = <<SCRIPT
+  # config desired state
+  . C:\\vagrant\\manifests\\LCMConfig.ps1
+  LCMConfig
+  Set-DscLocalConfigurationManager -Path ".\\LCMConfig"
+SCRIPT
+
+VAGRANTFILE_API_VERSION = "2"
+
+# linked clone feature requires 1.8
+Vagrant.require_version ">= 1.8" 
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "mwrock/Windows2016"
+  config.vm.guest = :windows
+  config.vm.communicator = "winrm"
+
+  # we do not need, the following config, but gives some convenience
+  config.vm.provider "virtualbox" do |v|
+    # Link clone, get a faster up after destroy
+    v.linked_clone = true
+    # Get the clipboard to interact with host
+    v.customize ["modifyvm", :id, "--clipboard", "bidirectional"]
+  end
+
+  config.vm.provision "shell", inline: $shell_script
+
+  config.vm.provision "dsc" do |dsc|
+    dsc.configuration_file  = "Reboot.ps1"
+    dsc.configuration_name = "Reboot"
+    dsc.manifests_path = "manifests"      
+  end
+end

data/development/reboot/manifests/LCMConfig.ps1

@@ -0,0 +1,12 @@
+[DSCLocalConfigurationManager()]
+configuration LCMConfig
+{
+    Node localhost
+    {
+        Settings
+        {
+            RebootNodeIfNeeded = $true
+            ActionAfterReboot = "ContinueConfiguration"
+        }
+    }
+}

data/development/reboot/manifests/Reboot.ps1

@@ -0,0 +1,30 @@
+Configuration Reboot
+{
+    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'
+    
+    Script Reboot
+    {
+        TestScript = {
+            return (Test-Path HKLM:\SOFTWARE\MyMainKey\RebootKey)
+        }
+        SetScript = {
+            New-Item -Path HKLM:\SOFTWARE\MyMainKey\RebootKey -Force
+                $global:DSCMachineStatus = 1 
+
+        }
+        GetScript = { return @{result = 'result'}}
+    }
+
+    Script Error
+    {
+        TestScript = {
+            throw "This did not work"
+            return $true
+        }
+        SetScript = { 
+
+        }
+        GetScript = { return @{result = 'result'}}
+        DependsOn = "[Script]Reboot"
+    }
+}

data/lib/vagrant-dsc/locales/en.yml

@@ -38,3 +38,5 @@ en:
         "Operation unsupported / not-yet implemented: %{operation}"
       absolute_module_path: |-
         "Absolute 'module_path' not allowed. Please provide a path relative to your Vagrantfile."
+      failure_status: |-
+        "DSC Status is \"Failure\"."

data/lib/vagrant-dsc/provisioner.rb

@@ -1,5 +1,6 @@
 require "log4r"
 require 'erb'
+require "vagrant/util/powershell"
 
 module VagrantPlugins
   module DSC
@@ -99,6 +100,51 @@ module VagrantPlugins
         write_dsc_runner_script(generate_dsc_runner_script)
 
         run_dsc_apply
+
+        wait_for_dsc_completion
+      end
+
+      # Waits for the completion of the dsc configuration if dsc needs reboots. This currntly only works for WMF5 and needs wait_for_reboot
+      def wait_for_dsc_completion
+        return if Vagrant::Util::PowerShell.version.to_i < 5 || !@machine.guest.capability?(:wait_for_reboot)
+
+        dsc_running = true
+
+        while dsc_running
+          case get_lcm_state
+            when "PendingReboot"
+              @machine.ui.info("DSC needs reboot. Wait for the completion of DSC.")
+              @machine.guest.capability(:wait_for_reboot)
+
+            # Do not Know a way to reattch to dsc job, therefore check periodically the state
+            when "Busy"
+              sleep 10
+            else
+              dsc_running = false
+          end
+        end
+
+        if (get_configuration_status == "Failure")
+          @machine.ui.error(I18n.t("failure_status"))
+          show_dsc_failure_message
+        end
+      end
+
+      def get_lcm_state
+        state = @machine.communicate.shell.powershell("(Get-DscLocalConfigurationManager).LCMState")
+        return state[:data][0][:stdout]
+      end
+
+      def get_configuration_status
+        status = @machine.communicate.shell.powershell("(Get-DscConfigurationStatus).Status")
+        return status[:data][0][:stdout]
+      end
+
+      def show_dsc_failure_message
+        dsc_error_ps = "Get-WinEvent \"Microsoft-Windows-Dsc/Operational\" | Where-Object {$_.LevelDisplayName -eq \"Error\" -and $_.Message.StartsWith(\"Job $((Get-DscConfigurationStatus).JobId)\" )} | foreach { $_.Message }"
+        @machine.communicate.shell.powershell(dsc_error_ps) do |type,data|
+          @machine.ui.error(data, prefix: false)
+        end
       end
 
       # Cleanup after a destroy action.

data/lib/vagrant-dsc/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module Dsc
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
   end
 end

data/spec/base.rb

@@ -40,7 +40,7 @@ shared_context "unit" do
   # Asserts that the current (config) validation should fail with a specific message.
   def assert_error(error)
     errors = subject.validate(machine)
-    raise "Error #{error} was not raised" if !errors["dsc provisioner"].include? error
+    raise "Error #{error} was not raised" if !errors["dsc provisioner"].any? { |val| error =~ val }
   end
 
   # Asserts that no failures should occur in the current (config) validation run.

data/spec/provisioner/config_spec.rb

@@ -73,7 +73,7 @@ describe VagrantPlugins::DSC::Config do
       subject.finalize!
       subject.validate(machine)
 
-      expect(subject.expanded_configuration_file.to_s).to eq("#{subject.temp_dir}/manifests/MyWebsite.ps1")
+      expect(subject.expanded_configuration_file.to_s).to match(/(C:)?#{subject.temp_dir}\/manifests\/MyWebsite.ps1$/)
     end
   end
 
@@ -98,37 +98,41 @@ describe VagrantPlugins::DSC::Config do
 
     it "should generate a module path on the host machine relative to the Vagrantfile" do
       subject.module_path = "foo/modules"
-      expect(subject.expanded_module_paths('/path/to/vagrant/')).to eq(["/path/to/vagrant/foo/modules"])
+      expect(subject.expanded_module_paths('/path/to/vagrant/').length).to eq(1)
+      expect(subject.expanded_module_paths('/path/to/vagrant/')[0]).to match(/([Cc]:)?\/path\/to\/vagrant\/foo\/modules/)
     end
 
     it "should generate a module path on the host machine relative to the Vagrantfile with relative paths" do
       subject.module_path = "../modules"
-      expect(subject.expanded_module_paths('/path/to/vagrant/')).to eq(["/path/to/modules"])
+      expect(subject.expanded_module_paths('/path/to/vagrant/').length).to eq(1)
+      expect(subject.expanded_module_paths('/path/to/vagrant/')[0]).to match(/([Cc]:)?\/path\/to\/modules/)
     end
 
     it "should generate module paths on the host machine relative to the Vagrantfile" do
       subject.module_path = ["dont/exist", "also/dont/exist"]
-      expect(subject.expanded_module_paths('/path/to/vagrant/')).to eq(["/path/to/vagrant/dont/exist", "/path/to/vagrant/also/dont/exist"])
+      expect(subject.expanded_module_paths('/path/to/vagrant/').length).to eq(2)
+      expect(subject.expanded_module_paths('/path/to/vagrant/')[0]).to match(/([Cc]:)?\/path\/to\/vagrant\/dont\/exist/)
+      expect(subject.expanded_module_paths('/path/to/vagrant/')[1]).to match(/([Cc]:)?\/path\/to\/vagrant\/also\/dont\/exist/)
     end
 
     it "should be invalid if 'manifests_path' is not a real directory" do
       subject.manifests_path = "/i/do/not/exist"
       assert_invalid
-      assert_error("\"Path to DSC Manifest folder does not exist: /i/do/not/exist\"")
+      assert_error(/\"Path to DSC Manifest folder does not exist: ([Cc]:)?\/i\/do\/not\/exist\"/)
     end
 
     it "should be invalid if 'configuration_file' is not a real file" do
       subject.manifests_path = "/"
       subject.configuration_file = "notexist.ps1"
       assert_invalid
-      assert_error("\"Path to DSC Manifest does not exist: /notexist.ps1\"")
+      assert_error(/\"Path to DSC Manifest does not exist: ([Cc]:)?\/notexist.ps1\"/)
     end
 
     it "should be invalid if 'configuration_data_file' is not a real file" do
       subject.manifests_path = "/"
       subject.configuration_data_file = "/oeu/aoeu/notexist.psd1"
       assert_invalid
-      assert_error("\"Path to DSC Configuration Data file does not exist: /oeu/aoeu/notexist.psd1\"")
+      assert_error(/\"Path to DSC Configuration Data file does not exist: ([Cc]:)?\/oeu\/aoeu\/notexist.psd1\"/)
     end
 
     it "should detect the fully qualified path to the configuration data file automatically" do
@@ -142,13 +146,13 @@ describe VagrantPlugins::DSC::Config do
       subject.finalize!
       subject.validate(machine)
 
-      expect(subject.expanded_configuration_data_file.to_s).to eq("#{subject.temp_dir}/manifests/foo.psd1")
+      expect(subject.expanded_configuration_data_file.to_s).to match(/([Cc]:)?#{subject.temp_dir}\/manifests\/foo.psd1/)
     end
 
     it "should be invalid if 'module_path' is not a real directory" do
       subject.module_path = "/i/dont/exist"
       assert_invalid
-      assert_error("\"Path to DSC Modules does not exist: /i/dont/exist\"")
+      assert_error(/\"Path to DSC Modules does not exist: ([Cc]:)?\/i\/dont\/exist\"/)
     end
 
     it "should be invalid if 'configuration_file' and 'mof_path' provided" do

data/spec/provisioner/provisioner_spec.rb

@@ -133,6 +133,7 @@ describe VagrantPlugins::DSC::Provisioner do
       allow(subject).to receive(:verify_shared_folders).and_return(true)
       allow(subject).to receive(:verify_dsc).and_return(true)
       allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(subject).to receive(:wait_for_dsc_completion)
       allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(true)
       expect(guest).to receive(:capability).with(:wait_for_reboot)
 
@@ -146,6 +147,7 @@ describe VagrantPlugins::DSC::Provisioner do
       allow(subject).to receive(:verify_shared_folders).and_return(true)
       allow(subject).to receive(:verify_dsc).and_return(true)
       allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(subject).to receive(:wait_for_dsc_completion) 
       allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(false)
       expect(guest).to_not receive(:capability).with(:wait_for_reboot)
 
@@ -158,6 +160,7 @@ describe VagrantPlugins::DSC::Provisioner do
       allow(subject).to receive(:verify_shared_folders).and_return(true)
       allow(subject).to receive(:verify_dsc).and_return(true)
       allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(subject).to receive(:wait_for_dsc_completion)
       allow(guest).to receive(:capability?)
       allow(guest).to receive(:capability)
 
@@ -173,6 +176,7 @@ describe VagrantPlugins::DSC::Provisioner do
       allow(subject).to receive(:verify_shared_folders).and_return(true)
       allow(subject).to receive(:verify_dsc).and_return(true)
       allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(subject).to receive(:wait_for_dsc_completion)
       allow(guest).to receive(:capability?)
       allow(guest).to receive(:capability)
 
@@ -191,6 +195,7 @@ describe VagrantPlugins::DSC::Provisioner do
       allow(communicator).to receive(:upload)
       allow(subject).to receive(:verify_dsc).and_return(true)
       allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(subject).to receive(:wait_for_dsc_completion)
       allow(guest).to receive(:capability?)
       allow(guest).to receive(:capability)
 
@@ -200,6 +205,84 @@ describe VagrantPlugins::DSC::Provisioner do
       subject.provision
     end
 
+    it "should provision wait for dsc" do
+      allow(communicator).to receive(:sudo)
+      allow(communicator).to receive(:test)
+      allow(communicator).to receive(:upload)
+      allow(subject).to receive(:verify_shared_folders).and_return(true)
+      allow(subject).to receive(:verify_dsc).and_return(true)
+      allow(subject).to receive(:run_dsc_apply).and_return(true)
+      allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(true)
+      allow(guest).to receive(:capability).with(:wait_for_reboot)
+      expect(subject).to receive(:wait_for_dsc_completion)
+
+      subject.provision
+    end
+
+    it "should wait for pending reboot" do
+      allow_any_instance_of(Object).to receive(:sleep)
+      allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(true)
+      allow(communicator).to receive(:shell).and_return(shell)
+      allow(subject).to receive(:get_lcm_state).and_return("PendingReboot", "Busy", "Sucess")
+      allow(subject).to receive(:get_configuration_status).and_return("Sucess")
+      allow(Vagrant::Util::PowerShell).to receive(:version).and_return("5")
+      expect(guest).to receive(:capability).with(:wait_for_reboot)
+
+      subject.wait_for_dsc_completion
+    end
+
+    it "should wait for multi pending reboots" do
+      allow_any_instance_of(Object).to receive(:sleep)
+      allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(true)
+      allow(communicator).to receive(:shell).and_return(shell)
+      allow(subject).to receive(:get_lcm_state).and_return("PendingReboot", "Busy", "PendingReboot", "Busy", "Idle")
+      allow(subject).to receive(:get_configuration_status).and_return("Success")
+      allow(Vagrant::Util::PowerShell).to receive(:version).and_return("5")
+      expect(guest).to receive(:capability).twice.with(:wait_for_reboot)
+
+      subject.wait_for_dsc_completion
+    end
+
+    it "should show error message on failure" do
+      allow_any_instance_of(Object).to receive(:sleep)
+      allow(guest).to receive(:capability?).with(:wait_for_reboot).and_return(true)
+      allow(communicator).to receive(:shell).and_return(shell)
+      allow(guest).to receive(:capability).with(:wait_for_reboot)
+      allow(subject).to receive(:get_lcm_state).and_return("PendingReboot", "Busy", "PendingConfiguration")
+      allow(subject).to receive(:get_configuration_status).and_return("Failure")
+      allow(Vagrant::Util::PowerShell).to receive(:version).and_return("5")
+      expect(subject).to receive(:show_dsc_failure_message)
+
+      subject.wait_for_dsc_completion
+    end
+
+    it "should get the lcm state" do
+      allow(communicator).to receive(:shell).and_return(shell)
+      expect(shell).to receive(:powershell).with("(Get-DscLocalConfigurationManager).LCMState").and_return({:data => [{:stdout => "LCMState"}]})
+      
+      expect(subject.get_lcm_state).to eq("LCMState")
+    end
+
+    it "should get the configuration status" do
+      allow(communicator).to receive(:shell).and_return(shell)
+      expect(shell).to receive(:powershell).with("(Get-DscConfigurationStatus).Status").and_return({:data => [{:stdout => "Status"}]})
+
+      expect(subject.get_configuration_status).to eq("Status")
+    end
+
+    it "should get the dsc error message" do
+      allow(communicator).to receive(:shell).and_return(shell)
+      expect(shell).to receive(:powershell)
+        .with("Get-WinEvent \"Microsoft-Windows-Dsc/Operational\" | Where-Object {$_.LevelDisplayName -eq \"Error\" -and $_.Message.StartsWith(\"Job $((Get-DscConfigurationStatus).JobId)\" )} | foreach { $_.Message }")
+        .and_yield(:stdout, "\r\n")
+        .and_yield(:stdout, "\r\n")
+        .and_yield(:stdout, "Job AE9233FD-8491-11E6-9810-080027F3ADE1} : \r\n          MIResult: 1\r\n")
+      expect(ui).to receive(:error).with("\r\n", :prefix=>false).twice
+      expect(ui).to receive(:error).with("Job AE9233FD-8491-11E6-9810-080027F3ADE1} : \r\n          MIResult: 1\r\n", :prefix=>false)
+
+      subject.show_dsc_failure_message
+    end
+
     it "should verify DSC binary exists" do
       expect(communicator).to receive(:sudo).with("which Start-DscConfiguration", {:error_class=>VagrantPlugins::DSC::DSCError, :error_key=>:dsc_not_detected, :binary=>"Start-DscConfiguration"})
       subject.verify_binary("Start-DscConfiguration")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-dsc
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Matt Fellows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-30 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -108,13 +108,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- development/Vagrantfile
-- development/manifests/MyConfig.psd1
-- development/manifests/MyWebsite.ps1
-- development/modules/MyWebapp/DSCResources/SimpleWebsite/SimpleWebsite.psd1
-- development/modules/MyWebapp/DSCResources/SimpleWebsite/SimpleWebsite.schema.psm1
-- development/modules/MyWebapp/MyWebapp.psd1
-- development/website/index.html
+- appveyor.yml
+- development/reboot/Vagrantfile
+- development/reboot/manifests/LCMConfig.ps1
+- development/reboot/manifests/Reboot.ps1
+- development/web/Vagrantfile
+- development/web/manifests/MyConfig.psd1
+- development/web/manifests/MyWebsite.ps1
+- development/web/modules/MyWebapp/DSCResources/SimpleWebsite/SimpleWebsite.psd1
+- development/web/modules/MyWebapp/DSCResources/SimpleWebsite/SimpleWebsite.schema.psm1
+- development/web/modules/MyWebapp/MyWebapp.psd1
+- development/web/website/index.html
 - lib/vagrant-dsc.rb
 - lib/vagrant-dsc/config.rb
 - lib/vagrant-dsc/locales/en.yml
@@ -148,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: DSC Provisioner for Vagrant