vagrant-windows-update 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e248d30d6a3fc4f3ba91cf9170c96d7ac45ae6
-  data.tar.gz: 5d7a309419c7a4b8065de1eda991c10303b26192
+  metadata.gz: 9f351ccfce6734c91491ac81b4048ab62396aefa
+  data.tar.gz: 7a1789990f433bf461e670d4083d5507369276da
 SHA512:
-  metadata.gz: 51292d0b6e50429280cfb57397fd93ba719e7440a069ee5c936ac617354d958785f13ea18cd8aa0b830037acf7bcfc7e91926e52ee13ecb0bc019109242a1632
-  data.tar.gz: acf3aef2ef012f164abb9c8bddf2d374b4a1270d844a46722457079ce5719571c2642a09e08ecc0645c63ae7b529015263a126a73a25d16b24f8650203ddba83
+  metadata.gz: 0125aade3e921cb9815c92ebf7b5742ce4c3345c79e51ce4f3ee370954b61499a13e0a47a7845ad9ed7c56be02d95cbee8a545b40ac3378579b7a2be0fdde44b
+  data.tar.gz: f6795a0861c8083c45593fe1cd582e967d9478eb1751af2e3bbf5e791afc012fb3cfbded9f5dec73f7d536e3466aa1f38ca3d5664dff58efda93a2e3b4a9766b

data/lib/vagrant-windows-update.rb

@@ -4,25 +4,50 @@ rescue LoadError
   raise "The Vagrant Windows Update plugin must be run within Vagrant."
 end
 
-if Vagrant::VERSION < "1.9.0"
-  raise "The Vagrant Windows Update plugin is only compatible with Vagrant 1.9+"
+if Vagrant::VERSION < "2.0.3"
+  raise "The Vagrant Windows Update plugin is only compatible with Vagrant 2.0.3+"
 end
 
+require "base64"
+
 module VagrantPlugins
   module WindowsUpdate
     class Plugin < Vagrant.plugin("2")
       name "Windows Update"
       description "Vagrant plugin to update a Windows VM as a provisioning step."
 
-      provisioner "windows-update" do
-        class Provisioner < Vagrant.plugin("2", :provisioner)
-          def initialize(machine, config)
-            super
+      config("windows-update", :provisioner) do
+        class Config < Vagrant.plugin("2", :config)
+          attr_accessor :filters
+
+          def initialize
+            @filters = UNSET_VALUE
+          end
+
+          def finalize!
+            @filters = ['include:$_.AutoSelectOnWebSites'] if @filters == UNSET_VALUE
           end
 
-          def configure(root_config)
+          def validate(machine)
+            errors = _detected_errors
+            errors << 'filters must be a string array' unless filters_valid?
+            return { "windows-update provisioner" => errors }
           end
 
+          def filters_valid?
+            return false if !filters.is_a?(Array)
+            filters.each do |a|
+              return false if !a.kind_of?(String)
+            end
+            return true
+          end
+        end
+
+        Config
+      end
+
+      provisioner("windows-update") do
+        class Provisioner < Vagrant.plugin("2", :provisioner)
           # see https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/ui.rb
           # see https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/plugin/v2/provisioner.rb
           # see https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/plugin/v2/communicator.rb
@@ -32,7 +57,7 @@ module VagrantPlugins
             @machine.communicate.upload(
               File.join(File.dirname(__FILE__), "vagrant-windows-update", "windows-update.ps1"),
               remote_path)
-            command = "PowerShell -ExecutionPolicy Bypass -OutputFormat Text -File #{remote_path}"
+            command = "PowerShell -ExecutionPolicy Bypass -OutputFormat Text -EncodedCommand #{windows_update_encoded_command(remote_path, config.filters)}"
             loop do
               begin
                 until @machine.communicate.ready?
@@ -85,6 +110,22 @@ module VagrantPlugins
               @machine.ui.info(data.chomp, options)
             end
           end
+
+          def windows_update_encoded_command(remote_path, filters)
+            # NB you can get the string back with:
+            #     Base64.decode64(encoded).force_encoding("utf-16le")
+            return Base64.strict_encode64("#{remote_path}#{windows_update_filters_argument(filters)}".encode("utf-16le"))
+          end
+
+          def windows_update_filters_argument(filters)
+            return "" if !filters
+            arg = " -Filters "
+            filters.each_with_index do |filter, i|
+              arg += "," if i > 0
+              arg += "'#{filter.gsub("'", "''")}'" # escape single quotes with another single quote.
+            end
+            return arg
+          end
         end
 
         Provisioner

data/lib/vagrant-windows-update/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module WindowsUpdate
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/vagrant-windows-update/windows-update.ps1

@@ -13,6 +13,18 @@
 # see IUpdate interface
 #     at https://msdn.microsoft.com/en-us/library/windows/desktop/aa386099(v=vs.85).aspx
 
+param(
+    [string[]]$Filters = @('include:$_.AutoSelectOnWebSites'),
+    [int]$UpdateLimit = 100
+)
+
+$mock = $false
+
+function ExitWithCode($exitCode) {
+    $host.SetShouldExit($exitCode)
+    Exit
+}
+
 Set-StrictMode -Version Latest
 
 $ErrorActionPreference = 'Stop'
@@ -21,7 +33,23 @@ trap {
     Write-Output "ERROR: $_"
     Write-Output (($_.ScriptStackTrace -split '\r?\n') -replace '^(.*)$','ERROR: $1')
     Write-Output (($_.Exception.ToString() -split '\r?\n') -replace '^(.*)$','ERROR EXCEPTION: $1')
-    Exit 1
+    ExitWithCode 1
+}
+
+if ($mock) {
+    $mockWindowsUpdatePath = 'C:\Windows\Temp\windows-update-count-mock.txt'
+    if (!(Test-Path $mockWindowsUpdatePath)) {
+        Set-Content $mockWindowsUpdatePath 10
+    }
+    $count = [int]::Parse((Get-Content $mockWindowsUpdatePath).Trim())
+    if ($count) {
+        Write-Output "Synthetic reboot countdown counter is at $count"
+        Set-Content $mockWindowsUpdatePath (--$count)
+        Write-Output 'Rebooting...'
+        ExitWithCode 101
+    }
+    Write-Output 'No Windows updates found'
+    ExitWithCode 0
 }
 
 Add-Type @'
@@ -62,34 +90,47 @@ function Wait-Condition {
     }
 }
 
-function ExitWhenRebootRequired([bool]$forceReboot=$false) {
-    $rebootRequired = $forceReboot
-
+function ExitWhenRebootRequired($rebootRequired = $false) {
     # check for pending Windows Updates.
     if (!$rebootRequired) {
         $systemInformation = New-Object -ComObject 'Microsoft.Update.SystemInfo'
-        $rebootRequired = $rebootRequired -or $systemInformation.RebootRequired
+        $rebootRequired = $systemInformation.RebootRequired
     }
 
     # check for pending Windows Features.
     if (!$rebootRequired) {
         $pendingPackagesKey = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Component Based Servicing\PackagesPending'
         $pendingPackagesCount = (Get-ChildItem -ErrorAction SilentlyContinue $pendingPackagesKey | Measure-Object).Count
-        $rebootRequired = $rebootRequired -or $pendingPackagesCount -gt 0
+        $rebootRequired = $pendingPackagesCount -gt 0
     }
 
     if ($rebootRequired) {
-        if (!$forceReboot) {
-            Write-Output 'Pending Reboot detected. Waiting for the Windows Modules Installer to exit...'
-            Wait-Condition {(Get-Process -ErrorAction SilentlyContinue TiWorker,TrustedInstaller | Measure-Object).Count -eq 0}
-        }
+        Write-Output 'Pending Reboot detected. Waiting for the Windows Modules Installer to exit...'
+        Wait-Condition {(Get-Process -ErrorAction SilentlyContinue TiWorker | Measure-Object).Count -eq 0}
         Write-Output 'Rebooting...'
-        Exit 0
+        ExitWithCode 101
     }
 }
 
 ExitWhenRebootRequired
 
+$updateFilters = $Filters | ForEach-Object {
+    $action, $expression = $_ -split ':',2
+    New-Object PSObject -Property @{
+        Action = $action
+        Expression = [ScriptBlock]::Create($expression)
+    }
+}
+
+function Test-IncludeUpdate($filters, $update) {
+    foreach ($filter in $filters) {
+        if (Where-Object -InputObject $update $filter.Expression) {
+            return $filter.Action -eq 'include'
+        }
+    }
+    return $false
+}
+
 $updateSession = New-Object -ComObject 'Microsoft.Update.Session'
 $updateSession.ClientApplicationID = 'vagrant-windows-update'
 
@@ -98,20 +139,24 @@ $updatesToDownload = New-Object -ComObject 'Microsoft.Update.UpdateColl'
 $updatesToInstall = New-Object -ComObject 'Microsoft.Update.UpdateColl'
 $updateSearcher = $updateSession.CreateUpdateSearcher()
 $searchResult = $updateSearcher.Search("IsInstalled=0 and Type='Software' and IsHidden=0")
+$rebootRequired = $false
 for ($i = 0; $i -lt $searchResult.Updates.Count; ++$i) {
     $update = $searchResult.Updates.Item($i)
+    $updateDate = $update.LastDeploymentChangeTime.ToString('yyyy-MM-dd')
+    $updateSize = ($update.MaxDownloadSize/1024/1024).ToString('0.##')
+    $updateSummary = "Windows update ($updateDate; $updateSize MB): $($update.Title)"
 
     if ($update.InstallationBehavior.CanRequestUserInput) {
+        Write-Output "Skipped (CanRequestUserInput) $updateSummary"
         continue
     }
 
-    if (!$update.AutoSelectOnWebSites) {
+    if (!(Test-IncludeUpdate $updateFilters $update)) {
+        Write-Output "Skipped (filter) $updateSummary"
         continue
     }
 
-    $updateDate = $update.LastDeploymentChangeTime.ToString('yyyy-MM-dd')
-    $updateSize = ($update.MaxDownloadSize/1024/1024).ToString('0.##')
-    Write-Output "Found Windows update ($updateDate; $updateSize MB): $($update.Title)"
+    Write-Output "Found $updateSummary"
 
     $update.AcceptEula() | Out-Null
 
@@ -120,6 +165,10 @@ for ($i = 0; $i -lt $searchResult.Updates.Count; ++$i) {
     }
 
     $updatesToInstall.Add($update) | Out-Null
+    if ($updatesToInstall.Count -ge $UpdateLimit) {
+        $rebootRequired = $true
+        break
+    }
 }
 
 if ($updatesToDownload.Count) {
@@ -134,8 +183,7 @@ if ($updatesToInstall.Count) {
     $updateInstaller = $updateSession.CreateUpdateInstaller()
     $updateInstaller.Updates = $updatesToInstall
     $installResult = $updateInstaller.Install()
-    ExitWhenRebootRequired $true
-    Exit 0
+    ExitWhenRebootRequired ($installResult.RebootRequired -or $rebootRequired)
+} else {
+    Write-Output 'No Windows updates found'
 }
-
-Write-Output 'No Windows updates found'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-windows-update
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Rui Lopes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2018-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Vagrant plugin for installing Windows updates.