[images.CI] Delete macOS VMs on build canceling (#1742)

* destroy vm

* destroy vm

* check clone status

* fix vm state

* remove exit 1

* fix params

* suppress stop-vm output

* replace or -> Or

* rename doc terms

images.CI/macos/azure-pipelines/image-generation.yml

@@ -105,3 +105,14 @@ jobs:
       failTaskOnFailedTests: true
     displayName: Publish test results
     condition: always()
+
+  - task: PowerShell@2
+    displayName: 'Destroy VM (if build canceled only)'
+    condition: eq(variables['Agent.JobStatus'], 'Canceled')
+    inputs:
+      targetType: 'filePath'
+      filePath: ./images.CI/macos/destroy-vm.ps1
+      arguments: -VMName "${{ variables.VirtualMachineName }}" `
+                 -VIServer "$(vcenter-server-v2)" `
+                 -VIUserName "$(vcenter-username-v2)" `
+                 -VIPassword "$(vcenter-password-v2)"

images.CI/macos/destroy-vm.ps1

@@ -0,0 +1,89 @@
+[CmdletBinding()]
+param(
+    [Parameter(Mandatory)]
+    [ValidateNotNullOrEmpty()]
+    [string]$VMName,
+
+    [Parameter(Mandatory)]
+    [ValidateNotNullOrEmpty()]
+    [string]$VIServer,
+
+    [Parameter(Mandatory)]
+    [ValidateNotNullOrEmpty()]
+    [string]$VIUserName,
+
+    [Parameter(Mandatory)]
+    [ValidateNotNullOrEmpty()]
+    [string]$VIPassword
+)
+
+$ProgressPreference = "SilentlyContinue"
+$WarningPreference = "SilentlyContinue"
+
+# connection to a vCenter Server system
+try
+{
+    $null = Set-PowerCLIConfiguration -Scope Session -InvalidCertificateAction Ignore -ParticipateInCEIP $false -Confirm:$false -WebOperationTimeoutSeconds 600
+    $securePassword = ConvertTo-SecureString -String $VIPassword -AsPlainText -Force
+    $cred = New-Object System.Management.Automation.PSCredential($VIUserName, $securePassword)
+    $null = Connect-VIServer -Server $VIServer -Credential $cred -ErrorAction Stop
+    Write-Host "Connection to the vSphere server has been established"
+}
+catch
+{
+    Write-Host "##vso[task.LogIssue type=error;]Failed to connect to the vSphere server"
+    exit 1
+}
+
+# check vm clone status
+$chainId = (Get-VIEvent -Entity $VMName).ChainId
+if ($chainId)
+{
+    $task = Get-Task -Status Running | Where-Object { ($_.Name -eq 'CloneVM_Task') -and ($_.ExtensionData.Info.EventChainId -in $chainId) }
+    if ($task)
+    {
+        try
+        {
+            Stop-Task -Task $task -Confirm:$false -ErrorAction Stop
+            Write-Host "The vm '$VMName' clone task has been cancelled"
+        }
+        catch
+        {
+            Write-Host "##vso[task.LogIssue type=error;]Failed to cancel the task"
+        }
+    }
+}
+
+# remove a vm
+$vm = Get-VM -Name $VMName -ErrorAction SilentlyContinue
+
+if ($vm)
+{
+    $vmState = $vm.PowerState
+    if ($vmState -ne "PoweredOff")
+    {
+        try
+        {
+            $null = Stop-VM -VM $vm -Confirm:$false -ErrorAction Stop
+            Write-Host "The vm '$VMName' has been powered off"
+        }
+        catch
+        {
+            Write-Host "##vso[task.LogIssue type=error;]Failed to shutdown '$VMName'"
+        }
+    }
+
+    try
+    {
+        Remove-VM -VM $vm -DeletePermanently -Confirm:$false -ErrorAction Stop
+        Write-Host "The vm '$VMName' has been removed"
+    }
+    catch
+    {
+        Write-Host "##vso[task.LogIssue type=error;]Failed to remove '$VMName'"
+    }
+}
+else
+{
+    Write-Host "VM '$VMName' not found"
+}