feature(wakeup): add basic connectivity test

- add parameters to control or skip connectivity test
- basic connectivity test logic and execution
- simple connectivity error handling and reporting

.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

@@ -6,14 +6,25 @@ param
 # Computer to wake up
     [Alias("Computer")]
     [String]
-    $targetComputer = "",
-# Skip RDP connectivity readiness check
-    [Alias("Check", "Readiness")]
+    $TargetComputer = "",
+# XML database file containing computer details
+    [Alias("List", "database", "db")]
+    [String]
+    $WolDatabase = "WOLDatabase.xml",
+# Skip connectivity readiness check
+    [Alias("NoCheck", "NoReadiness")]
     [Switch]
-    $ConnectivityCheck = $false,
-# RDP connectivity readiness check timeout
+    $NoConnectivityCheck = $false,
+# Initial wait period in seconds before first connectivity check
     [Int]
-    $Timeout = 300
+    $WaitBeforeConnectivityCheck = 10,
+# connectivity readiness check total timeout
+    [Int]
+    $Timeout = 300,
+# connectivity readiness port to check
+    [Alias("CheckPort")]
+    [Int]
+    $ConnectivityPort = 3389
 )
 
 function exitError($errMessage, $PSItem, $exitCode = 1)
@@ -32,8 +43,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 +67,38 @@ 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
+[xml]$db = Get-Content -Path $WolDatabase
 $broadcastIP = $db.WOLDatabase.Configuration.BroadcastAddress
 $port = $db.WOLDatabase.Configuration.Port
 $dnsSuffix = $db.WOLDatabase.Configuration.DnsSuffix
 $targetComputers = [System.Collections.Generic.List[PSObject]]::new()
-$db.WOLDatabase.Computers.Computer | Where-Object { $_.name -match "$targetComputer" } | ForEach-Object { $targetComputers.Add($_) }
+$db.WOLDatabase.Computers.Computer | Where-Object { $_.name -match "$TargetComputer" } | 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 = @()
@@ -108,7 +132,49 @@ $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 successful wake-up packets sent" -exitCode 5
+}
 
-Exit 0
+# wait for initialWaitTime seconds to let computer(s) wake up
+for ($i = $WaitBeforeConnectivityCheck; $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
+$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 $ConnectivityPort -InformationLevel Quiet -WarningAction SilentlyContinue -ErrorAction SilentlyContinue -ErrorVariable connectionError))
+    {
+        Write-Host -ForegroundColor Red "[ERROR]"
+        Write-Host -ForegroundColor Red "`tAdditional information:", $connectionError[-1].ToString()
+    }
+    else
+    {
+        Write-Host -ForegroundColor Green "[OK]"
+    }
+}
+
+# exit gracefully
+exitGracefully