[ubuntu] Rename build scripts (#8866)

* [ubuntu] Rename build scripts * [ubuntu] Change reboot to inline shell * [ubuntu] Move disk space validation to pester tests * [ubuntu] Rename helper and tests files * [ubuntu] Changes to cleanup, post-deployment and r scripts
2026-01-04 09:00:55 +08:00 · 2023-11-22 21:49:23 +01:00
parent 410fd620be
commit 1bd9214f41
101 changed files with 422 additions and 483 deletions
--- a/images/ubuntu/scripts/tests/Helpers.psm1
+++ b/images/ubuntu/scripts/tests/Helpers.psm1
@@ -0,0 +1,104 @@
+Import-Module "$PSScriptRoot/../helpers/Common.Helpers.psm1" -DisableNameChecking
+
+# Validates that tool is installed and in PATH
+function Validate-ToolExist($tool) {
+    Get-Command $tool -ErrorAction SilentlyContinue | Should -BeTrue
+}
+
+function Invoke-PesterTests {
+    Param(
+        [Parameter(Mandatory)][string] $TestFile,
+        [string] $TestName
+    )
+
+    $testPath = "/imagegeneration/tests/${TestFile}.Tests.ps1"
+    if (-not (Test-Path $testPath)) {
+        throw "Unable to find test file '$TestFile' on '$testPath'."
+    }
+
+    # Check that Pester module is imported
+    if (!(Get-Module "Pester")) {
+        Import-Module Pester
+    }
+
+    $configuration = [PesterConfiguration] @{
+        Run = @{ Path = $testPath; PassThru = $true }
+        Output = @{ Verbosity = "Detailed"; RenderMode = "Plaintext" }
+    }
+    if ($TestName) {
+        $configuration.Filter.FullName = $TestName
+    }
+
+    # Switch ErrorActionPreference to Stop temporary to make sure that tests will fail on silent errors too
+    $backupErrorActionPreference = $ErrorActionPreference
+    $ErrorActionPreference = "Stop"
+    $results = Invoke-Pester -Configuration $configuration
+    $ErrorActionPreference = $backupErrorActionPreference
+
+    # Fail in case if no tests are run
+    if (-not ($results -and ($results.FailedCount -eq 0) -and (($results.PassedCount + $results.SkippedCount) -gt 0))) {
+        $results
+        throw "Test run has failed"
+    }
+}
+
+function ShouldReturnZeroExitCode {
+    Param(
+        [string] $ActualValue,
+        [switch] $Negate,
+        [string] $Because # This parameter is unused but we need it to match Pester asserts signature
+    )
+
+    $result = Get-CommandResult $ActualValue -ValidateExitCode $false
+
+    [bool]$succeeded = $result.ExitCode -eq 0
+    if ($Negate) { $succeeded = -not $succeeded }
+
+    if (-not $succeeded)
+    {
+        $commandOutputIndent = " " * 4
+        $commandOutput = ($result.Output | ForEach-Object { "${commandOutputIndent}${_}" }) -join "`n"
+        $failureMessage = "Command '${ActualValue}' has finished with exit code`n${commandOutput}"
+    }
+
+    return [PSCustomObject] @{
+        Succeeded      = $succeeded
+        FailureMessage = $failureMessage
+    }
+}
+
+function ShouldMatchCommandOutput {
+    Param(
+        [string] $ActualValue,
+        [string] $RegularExpression,
+        [switch] $Negate
+    )
+
+    $output = (Get-CommandResult $ActualValue -ValidateExitCode $false).Output | Out-String
+    [bool] $succeeded = $output -cmatch $RegularExpression
+
+    if ($Negate) {
+        $succeeded = -not $succeeded
+    }
+
+    $failureMessage = ''
+
+    if (-not $succeeded) {
+        if ($Negate) {
+            $failureMessage = "Expected regular expression '$RegularExpression' for '$ActualValue' command to not match '$output', but it did match."
+        }
+        else {
+            $failureMessage = "Expected regular expression '$RegularExpression' for '$ActualValue' command to match '$output', but it did not match."
+        }
+    }
+
+    return [PSCustomObject] @{
+        Succeeded      = $succeeded
+        FailureMessage = $failureMessage
+    }
+}
+
+If (Get-Command -Name Add-ShouldOperator -ErrorAction SilentlyContinue) {
+    Add-ShouldOperator -Name ReturnZeroExitCode -InternalName ShouldReturnZeroExitCode -Test ${function:ShouldReturnZeroExitCode}
+    Add-ShouldOperator -Name MatchCommandOutput -InternalName ShouldMatchCommandOutput -Test ${function:ShouldMatchCommandOutput}
+}