feature(wakeup): only display connection err on last iteration

- move connection check error details to verbose stream

.gitignore

@@ -71,3 +71,5 @@ fabric.properties
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
 
+# ignore text XML WOL database files
+*.test.xml

WOLDatabase.xml

@@ -3,7 +3,7 @@
     <Configuration>
         <BroadcastAddress>127.0.0.1</BroadcastAddress>
         <Port>7</Port>
-        <DnsSuffix>.internal.mydomain.net</DnsSuffix>
+        <DnsSuffix>.internal.mydomain.tld</DnsSuffix>
     </Configuration>
     <Computers>
         <Computer name="reception01" friendlyName="Front-desk computer" mac="aa:00:00:00:00:01"/>

wakeup.ps1

@@ -1,19 +1,37 @@
 <#
 #>
 
+[CmdletBinding()]
 param
 (
-# Computer to wake up
+# Array of strings listing computer name(s) to wake up. Names will be matched using RegEx
     [Alias("Computer")]
+    [String[]]
+    $TargetComputer = "",
+# XML database file containing computer details (Default: WOLDatabase.xml)
+    [Alias("List", "Database")]
     [String]
-    $targetComputer = "",
-# Skip RDP connectivity readiness check
-    [Alias("Check", "Readiness")]
+    $WolDatabase = "WOLDatabase.xml",
+# Skip connectivity check
+    [Alias("NoCheck", "NoReadiness")]
     [Switch]
-    $ConnectivityCheck = $false,
-# RDP connectivity readiness check timeout
+    $NoConnectivityCheck,
+# Delay before running first connectivity check (Default: 10)
+    [Alias("Delay")]
     [Int]
-    $Timeout = 300
+    $ConnectivityCheckDelay = 10,
+# Seconds before aborting connectivity check (Default: 300)
+    [Alias("Timeout")]
+    [Int]
+    $ConnectivityCheckTimeout = 300,
+# Seconds between connectivity checks (Default: 30)
+    [Alias("Interval")]
+    [Int]
+    $ConnectivityCheckInterval = 30,
+# Port to use for connectivity check (Default: 3389-RDP)
+    [Alias("CheckPort")]
+    [Int]
+    $ConnectivityCheckPort = 3389
 )
 
 function exitError($errMessage, $PSItem, $exitCode = 1)
@@ -32,8 +50,14 @@ function exitError($errMessage, $PSItem, $exitCode = 1)
     Exit $exitCode
 }
 
-$wolModuleName = "wol-magicPacket"
-$wolDatabase = "WOLDatabase.xml"
+function exitGracefully()
+{
+    Write-Host -ForegroundColor Green "`r`nFinished.`r`n"
+    Exit 0
+}
+
+# constants
+Set-Variable -Name wolModuleName -Value "wol-magicPacket" -Option Constant
 
 # exit on error if Send-MagicPacket module is not loaded
 if (!(Get-Module -Name $wolModuleName))
@@ -50,31 +74,41 @@ if (!(Get-Module -Name $wolModuleName))
 }
 
 # exit if database cannot be found/read
-if (!(Test-Path -Path $wolDatabase -PathType Leaf))
+if (!(Test-Path -Path $WolDatabase -PathType Leaf))
 {
-    $errMessage = "Unable to find or read Wake-On-LAN database file ($wolDatabase)"
+    $errMessage = "Unable to find or read Wake-On-LAN database file ($WolDatabase)"
     exitError $errMessage
 }
 
 # get target computer name if not already specified
-if ( [String]::IsNullOrWhiteSpace($targetComputer))
+if ( [String]::IsNullOrWhiteSpace($TargetComputer))
 {
     do
     {
-        $targetComputer = Read-Host -Prompt 'Computer to wake-up'
-    } while ( [String]::IsNullOrWhiteSpace($targetComputer))
+        $TargetComputer = Read-Host -Prompt 'Computer to wake-up'
+    } while ( [String]::IsNullOrWhiteSpace($TargetComputer))
 }
 Write-Host
 
 # read database and assemble list of target computers
-[xml]$db = Get-Content -Path $wolDatabase
-$broadcastIP = $db.WOLDatabase.Configuration.BroadcastAddress
-$port = $db.WOLDatabase.Configuration.Port
-$dnsSuffix = $db.WOLDatabase.Configuration.DnsSuffix
+[xml]$wolDb = Get-Content -Path $WolDatabase
+$broadcastIP = $wolDb.WOLDatabase.Configuration.BroadcastAddress
+$port = $wolDb.WOLDatabase.Configuration.Port
+$dnsSuffix = $wolDb.WOLDatabase.Configuration.DnsSuffix
 $targetComputers = [System.Collections.Generic.List[PSObject]]::new()
-$db.WOLDatabase.Computers.Computer | Where-Object { $_.name -match "$targetComputer" } | ForEach-Object { $targetComputers.Add($_) }
+$TargetComputer | ForEach-Object {
+    $tgt = $_
+    $wolDb.WOLDatabase.Computers.Computer | Where-Object { $_.name -match $tgt } | ForEach-Object { $targetComputers.Add($_) }
+}
 $removeFromTargetComputers = [System.Collections.Generic.List[String]]::new()
 
+# exit if nothing to do (i.e. empty targetComputers list)
+if ($targetComputers.Count -eq 0)
+{
+    Write-Host -ForegroundColor Yellow "No computers found matching '$TargetComputer'. Nothing to do.`r`n"
+    exit 0
+}
+
 # send WOL magic packets
 $targetComputers | ForEach-Object {
     $wolError = @()
@@ -98,6 +132,7 @@ $targetComputers | ForEach-Object {
     else
     {
         Write-Host -ForegroundColor Red "[ERROR]"
+        # queue for removal from computers on which to run a connectivity check
         $removeFromTargetComputers.Add($name)
     }
 }
@@ -108,7 +143,86 @@ $removeFromTargetComputers | ForEach-Object {
     $targetComputers.Remove(($targetComputers | Where-Object { $_.name -eq $removeName })) | Out-Null
 }
 
-# process RDP readiness check
-$targetComputers
+# exit if connectivity check skipped or if no computers to test
+if ($NoConnectivityCheck)
+{
+    Write-Host "`r`nSkipping connectivity checks."
+    exitGracefully
+}
+elseif ($targetComputers.Count -eq 0)
+{
+    exitError "No wake-up packets sent successfully" -exitCode 5
+}
 
-Exit 0
+# wait for initial delay seconds to let computer(s) wake up
+for ($i = $ConnectivityCheckDelay; $i -gt 0; $i--) {
+    Write-Progress -Activity "Waiting for computer(s) to wake-up..." -SecondsRemaining $i
+    Start-Sleep 1
+}
+Write-Progress -Activity "Waiting for computer(s) to wake-up..." -Completed
+
+# iterate computers and test connectivity
+# TODO: run connectivity test as background job
+$connCheckTotalTime = 0
+$removeFromTargetComputers.Clear()
+do
+{
+    $targetComputers | ForEach-Object {
+        $name = $_.name
+        $friendlyName = $_.friendlyName
+        $fqdn = -join ($name, $dnsSuffix)
+        $connectionError = @()
+
+        if ( [String]::IsNullOrWhiteSpace($friendlyName))
+        {
+            Write-Host "Testing connection readiness of '$name'... " -NoNewline
+        }
+        else
+        {
+            Write-Host "Testing connection readiness of '$friendlyName'... " -NoNewline
+        }
+        if (!(Test-NetConnection -ComputerName $fqdn -Port $ConnectivityCheckPort -InformationLevel Quiet -WarningAction SilentlyContinue -ErrorAction SilentlyContinue -ErrorVariable +connectionError))
+        {
+            if (($connCheckTotalTime + $ConnectivityCheckInterval) -gt $ConnectivityCheckTimeout)
+            {
+                # last iteration, display 'error'
+                Write-Host -ForegroundColor Red "[ERROR]"
+                $connectionError | ForEach-Object {
+                    $errMsg = $_.ToString()
+                    Write-Verbose "`t(Additional information: $errMsg)"
+                }
+            }
+            else
+            {
+                # more iterations pending, display 'retrying'
+                Write-Host -ForegroundColor Yellow "[RETRYING]"
+            }
+        }
+        else
+        {
+            Write-Host -ForegroundColor Green "[OK]"
+            # queue for removal from computers to check next round
+            $removeFromTargetComputers.Add($name)
+        }
+    }
+
+    # remove computers from targetComputers if connectivity check already successful
+    $removeFromTargetComputers | ForEach-Object {
+        $removeName = $_
+        $targetComputers.Remove(($targetComputers | Where-Object { $_.name -eq $removeName })) | Out-Null
+    }
+
+    # sleep until next test interval and increase time counter
+    $connCheckTotalTime += $ConnectivityCheckInterval
+    if ($connCheckTotalTime -le $ConnectivityCheckTimeout -and $targetComputers.Count -gt 0)
+    {
+        for ($i = $ConnectivityCheckInterval; $i -gt 0; $i--) {
+            Write-Progress -Activity "Waiting for next connectivity check..." -SecondsRemaining $i
+            Start-Sleep 1
+        }
+        Write-Progress -Activity "Waiting for next connectivity check..." -Completed
+    }
+} while ($connCheckTotalTime -le $ConnectivityCheckTimeout -and $targetComputers.Count -gt 0)
+
+# exit gracefully
+exitGracefully