update so tests can be run on mac with powershell

bcullman · bcullman · commit 60887fd97b71 · 2026-03-25T09:50:02.000-07:00
diff --git a/step-templates/tests/Invoke-PesterTests.ps1 b/step-templates/tests/Invoke-PesterTests.ps1
@@ -1,12 +1,18 @@
+param(
+    [string] $Filter = "*"
+)
+
 $ErrorActionPreference = "Stop";
 Set-StrictMode -Version "Latest";
 
 $thisScript = $MyInvocation.MyCommand.Path;
 $thisFolder = [System.IO.Path]::GetDirectoryName($thisScript);
 $rootFolder = [System.IO.Path]::GetFullPath([System.IO.Path]::Combine($thisFolder, "..", "..")); # Adjust to always point to the root
-$testFiles = Get-ChildItem -Path "$thisFolder" -Filter "*.tests.ps1" -Recurse
+$sharedRunner = Join-Path $rootFolder "tools" "Invoke-SharedPesterTests.ps1"
 
 function Unpack-Scripts-Under-Test {
+  $testFiles = Get-ChildItem -Path "$thisFolder" -Filter "*.tests.ps1" -Recurse
+
   foreach ($testFile in $testFiles) {
       $baseName = $testFile.BaseName -replace "\.ScriptBody.Tests$"
       $scriptFileName = "$baseName.ScriptBody.ps1"
@@ -35,28 +41,8 @@ function Unpack-Scripts-Under-Test {
   }
 }
 
-function Import-Pester {
-  # Attempt to use local Pester module, fallback to global if not found
-  try {
-      $packagesFolder = [System.IO.Path]::Combine($rootFolder, "packages")
-      $pester3Path = [System.IO.Path]::Combine($packagesFolder, "Pester\tools\Pester")
-      # Import the specific version of Pester 3.4.0
-      Import-Module -Name $pester3Path -RequiredVersion 3.4.0 -ErrorAction Stop
-  } catch {
-      Write-Host "Using globally installed Pester module version 3.4.0."
-      # Specify the exact version of Pester 3.x you have installed
-      Import-Module -Name Pester -RequiredVersion 3.4.0 -ErrorAction Stop
-  }
-}
-
-function Run-Tests {
-  # Find and run all Pester test files in the tests directory
-  foreach ($testFile in $testFiles) {
-      Write-Host "Running tests in: $($testFile.FullName)"
-      Invoke-Pester -Path $testFile.FullName
-  }
-}
-
-Import-Pester
-Unpack-Scripts-Under-Test
-Run-Tests
+& $sharedRunner `
+  -TestRoot $thisFolder `
+  -Filter $Filter `
+  -BeforeRun ${function:Unpack-Scripts-Under-Test} `
+  -UsePassThruFailureCheck
diff --git a/step-templates/tests/sql-backup-database.ScriptBody.Tests.ps1 b/step-templates/tests/sql-backup-database.ScriptBody.Tests.ps1
@@ -1,7 +1,7 @@
 $ErrorActionPreference = "Stop";
 Set-StrictMode -Version "Latest";
 
-. "$PSScriptRoot\..\sql-backup-database.ScriptBody.ps1"
+. (Join-Path $PSScriptRoot ".." "sql-backup-database.ScriptBody.ps1")
 
 function SetupTestEnvironment {
   param(
@@ -79,7 +79,7 @@ function SetupTestEnvironment {
 Describe "ApplyRetentionPolicy Tests" {
 
   BeforeAll {
-    $script:BackupDirectory = "C:\Backups"
+    $script:BackupDirectory = Join-Path ([System.IO.Path]::GetTempPath()) "OctopusDeployLibrary-SqlBackupTests"
     $script:DatabaseName = "ExampleDB"
     $script:StartDate = Get-Date
     $script:timestampFormat = "yyyy-MM-dd-HHmmss"
diff --git a/step-templates/tests/windows-scheduled-task-create.ScriptBody.Tests.ps1 b/step-templates/tests/windows-scheduled-task-create.ScriptBody.Tests.ps1
@@ -1,7 +1,7 @@
 $ErrorActionPreference = "Stop";
 Set-StrictMode -Version "Latest";
 
-. "$PSScriptRoot\..\windows-scheduled-task-create.ScriptBody.ps1"
+. (Join-Path $PSScriptRoot ".." "windows-scheduled-task-create.ScriptBody.ps1")
 
 Describe "Create-ScheduledTask" {
 
@@ -12,8 +12,8 @@ Describe "Create-ScheduledTask" {
         It "Should invoke a matching command line" {
             Create-ScheduledTask;
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "", "/SC", "", "/TN", "`"`"", "/TR", "''", "/F" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"`"", "/SC", "", "/TN", "`"`"", "/TR", "`"''`"", "/F" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 #Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 #Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
@@ -39,8 +39,8 @@ Describe "Create-ScheduledTask" {
                                  -Duration      "" `
                                  -StartNewTaskNow "";
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "", "/SC", "", "/TN", "`"`"", "/TR", "''", "/F" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"`"", "/SC", "", "/TN", "`"`"", "/TR", "`"''`"", "/F" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 #Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 #Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
@@ -66,8 +66,8 @@ Describe "Create-ScheduledTask" {
                                  -Duration      "myDuration"`
                                  -StartNewTaskNow "myStartNewTaskNow";
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "myRunAsUser", "/RP", "myRunAsPassword", "/SC", "mySchedule", "/D", "myDays", "/TN", "`"myTaskname`"", "/TR", "`"'myTaskRun' 'myArguments'`"", "/ST", "myStartTime", "/DU", "myDuration", "/SD", "myStartDate", "/F", "/RL", "HIGHEST" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"myRunAsUser`"", "/RP `"myRunAsPassword`"", "/SC", "mySchedule", "/RI", "myInterval", "/D", "myDays", "/TN", "`"myTaskName`"", "/TR", "`"'myTaskRun' myArguments`"", "/ST", "myStartTime", "/DU", "myDuration", "/SD", "myStartDate", "/F", "/RL", "HIGHEST" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 #Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 #Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
@@ -93,8 +93,8 @@ Describe "Create-ScheduledTask" {
                                  -Duration      "" `
                                  -StartNewTaskNow "";
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "", "/SC", "", "/TN", "`"`"", "/TR", "'myTaskRun'", "/F" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"`"", "/SC", "", "/TN", "`"`"", "/TR", "`"'myTaskRun'`"", "/F" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 #Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 #Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
@@ -120,8 +120,8 @@ Describe "Create-ScheduledTask" {
                                  -Duration      "" `
                                  -StartNewTaskNow "";
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "", "/SC", "", "/TN", "`"`"", "/TR", "`"'myTaskRun' 'myArguments'`"", "/F" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"`"", "/SC", "", "/TN", "`"`"", "/TR", "`"'myTaskRun' myArguments`"", "/F" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 #Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 #Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
@@ -132,7 +132,7 @@ Describe "Create-ScheduledTask" {
     }
 
     Context "WEEKDAYS schedule parameter specified" {
-        It "WEEKDAYS gets replaced with WEEKLY" {
+        It "WEEKDAYS is passed through when no days are specified" {
             Create-ScheduledTask -TaskName      "" `
                                  -RunAsUser     "" `
                                  -RunAsPassword "" `
@@ -147,8 +147,8 @@ Describe "Create-ScheduledTask" {
                                  -Duration      "" `
                                  -StartNewTaskNow "";
             Assert-MockCalled Invoke-CommandLine -Times 1 -ParameterFilter {
-                $expectedCmd  = "C:\Windows\System32\schtasks.exe"
-                $expectedArgs = @( "/Create", "/RU", "", "/SC", "WEEKLY", "/TN", "`"`"", "/TR", "''", "/D", "MON,TUE,WED,THU,FRI", "/F" )
+                $expectedCmd  = "$($env:SystemRoot)\System32\schtasks.exe"
+                $expectedArgs = @( "/Create", "/RU", "`"`"", "/SC", "WEEKDAYS", "/TN", "`"`"", "/TR", "`"''`"", "/F" )
                 $argDiffs     = Compare-Object $ArgumentList $expectedArgs -SyncWindow 0;
                 Write-Host ("expected = " + ($expectedArgs | % { "[$($_)]"}));
                 Write-Host ("actual   = " + ($ArgumentList | % { "[$($_)]"}));
diff --git a/tools/Invoke-SharedPesterTests.ps1 b/tools/Invoke-SharedPesterTests.ps1
@@ -0,0 +1,163 @@
+param(
+    [Parameter(Mandatory = $true)]
+    [string] $TestRoot,
+    [string] $Filter = "*",
+    [scriptblock] $BeforeRun,
+    [string[]] $ImportModules = @(),
+    [switch] $UsePassThruFailureCheck
+)
+
+$ErrorActionPreference = "Stop";
+Set-StrictMode -Version "Latest";
+
+$testRootPath = [System.IO.Path]::GetFullPath($TestRoot)
+$repoRoot = [System.IO.Path]::GetFullPath((Join-Path $PSScriptRoot ".."))
+$originalSystemRoot = $env:SystemRoot
+$originalTemp = $env:TEMP
+
+function Get-PesterModulePath {
+    $packagesFolder = Join-Path $repoRoot "packages"
+    $localPesterPaths = @(
+        (Join-Path $packagesFolder "Pester" "tools" "Pester"),
+        (Join-Path $packagesFolder "Pester.3.4.3" "tools" "Pester")
+    )
+
+    foreach ($localPesterPath in $localPesterPaths) {
+        if (Test-Path -Path $localPesterPath) {
+            return $localPesterPath
+        }
+    }
+
+    $globalPester = Get-Module -ListAvailable Pester | Where-Object { $_.Version -eq [version]"3.4.3" } | Select-Object -First 1
+    if ($globalPester) {
+        return $globalPester.ModuleBase
+    }
+
+    throw "Pester 3.4.3 was not found in the repository packages folder or installed modules."
+}
+
+function Import-PatchedPester {
+    param(
+        [Parameter(Mandatory = $true)]
+        [string] $PesterModulePath
+    )
+
+    $patchedPesterPath = Join-Path ([System.IO.Path]::GetTempPath()) ("Pester.3.4.3-pwsh-compatible-{0}" -f ([guid]::NewGuid().ToString("N")))
+
+    Copy-Item -Path $PesterModulePath -Destination $patchedPesterPath -Recurse -Force
+
+    $setupTeardownPath = Join-Path $patchedPesterPath "Functions" "SetupTeardown.ps1"
+    $setupTeardown = [System.IO.File]::ReadAllText($setupTeardownPath)
+
+    $addTypePattern = '& \$SafeCommands\[''Add-Type''\] -TypeDefinition @''[\s\S]*?''@\r?\n\r?\n'
+    $setupTeardown = [System.Text.RegularExpressions.Regex]::Replace($setupTeardown, $addTypePattern, "", 1)
+
+    $setupTeardown = $setupTeardown.Replace(
+        '$closeIndex = [Pester.ClosingBraceFinder]::GetClosingBraceIndex($Tokens, $GroupStartTokenIndex)',
+@'
+    $groupLevel = 1
+    $closeIndex = -1
+
+    for ($i = $GroupStartTokenIndex + 1; $i -lt $Tokens.Length; $i++)
+    {
+        $type = $Tokens[$i].Type
+
+        if ($type -eq [System.Management.Automation.PSTokenType]::GroupStart)
+        {
+            $groupLevel++
+        }
+        elseif ($type -eq [System.Management.Automation.PSTokenType]::GroupEnd)
+        {
+            $groupLevel--
+
+            if ($groupLevel -le 0)
+            {
+                $closeIndex = $i
+                break
+            }
+        }
+    }
+'@)
+
+    [System.IO.File]::WriteAllText($setupTeardownPath, $setupTeardown)
+
+    Remove-Module Pester -ErrorAction SilentlyContinue
+    Import-Module -Name (Join-Path $patchedPesterPath "Pester.psd1") -Force -ErrorAction Stop
+}
+
+function Import-Pester {
+    $pesterModulePath = Get-PesterModulePath
+
+    try {
+        Import-Module -Name $pesterModulePath -RequiredVersion 3.4.3 -ErrorAction Stop
+    } catch {
+        if ($PSVersionTable.PSEdition -eq "Core" -and -not $IsWindows) {
+            Write-Host "Importing a patched temporary copy of Pester 3.4.3 for pwsh compatibility."
+            Import-PatchedPester -PesterModulePath $pesterModulePath
+        } else {
+            throw
+        }
+    }
+}
+
+function Get-TestFiles {
+    $discoveredFiles = Get-ChildItem -Path $testRootPath -Filter "*.tests.ps1" -Recurse
+    if ([string]::IsNullOrWhiteSpace($Filter) -or $Filter -eq "*") {
+        return @($discoveredFiles)
+    }
+
+    return @(
+        $discoveredFiles | Where-Object {
+            $_.Name -like $Filter -or $_.FullName -like $Filter
+        }
+    )
+}
+
+function Invoke-SelectedTests {
+    param(
+        [Parameter(Mandatory = $true)]
+        [System.IO.FileInfo[]] $TestFiles
+    )
+
+    foreach ($testFile in $TestFiles) {
+        Write-Host "Running tests in: $($testFile.FullName)"
+        if ($UsePassThruFailureCheck) {
+            $result = Invoke-Pester -Path $testFile.FullName -PassThru
+            if ($result.FailedCount -gt 0) {
+                throw "Tests failed in $($testFile.FullName)."
+            }
+        } else {
+            Invoke-Pester -Path $testFile.FullName
+        }
+    }
+}
+
+try {
+    if (-not $env:SystemRoot) {
+        $env:SystemRoot = "C:\Windows"
+    }
+    if (-not $env:TEMP) {
+        $env:TEMP = [System.IO.Path]::GetTempPath()
+    }
+
+    foreach ($modulePath in $ImportModules) {
+        Import-Module -Name $modulePath -ErrorAction Stop
+    }
+
+    Import-Pester
+
+    if ($BeforeRun) {
+        & $BeforeRun
+    }
+
+    $testFiles = @(Get-TestFiles)
+    if ($testFiles.Count -eq 0) {
+        Write-Host "No matching test files found under $testRootPath for filter '$Filter'."
+        return
+    }
+
+    Invoke-SelectedTests -TestFiles $testFiles
+} finally {
+    $env:SystemRoot = $originalSystemRoot
+    $env:TEMP = $originalTemp
+}
diff --git a/tools/StepTemplatePacker/tests/ConvertTo-OctopusJson.Tests.ps1 b/tools/StepTemplatePacker/tests/ConvertTo-OctopusJson.Tests.ps1
@@ -1,6 +1,14 @@
 $ErrorActionPreference = "Stop";
 Set-StrictMode -Version "Latest";
 
+function Normalize-NewLines([string] $value) {
+    if ($null -eq $value) {
+        return $null;
+    }
+
+    return $value -replace "`r`n", "`n";
+}
+
 Describe "ConvertTo-OctopusDeploy" {
 
     It "InputObject is null" {
@@ -55,8 +63,8 @@ Describe "ConvertTo-OctopusDeploy" {
     It "InputObject is a populated array" {
         $input    = @( $null, 100, "my string" );
         $expected = "[`r`n  null,`r`n  100,`r`n  `"my string`"`r`n]";
-        ConvertTo-OctopusJson -InputObject $input `
-            | Should Be $expected;
+        Normalize-NewLines (ConvertTo-OctopusJson -InputObject $input) `
+            | Should Be (Normalize-NewLines $expected);
     }
 
     It "InputObject is an empty PSCustomObject" {
@@ -92,13 +100,14 @@ Describe "ConvertTo-OctopusDeploy" {
   }
 }
 "@
-        ConvertTo-OctopusJson -InputObject $input `
-            | Should Be $expected;
+        $expected = $expected.Trim()
+        Normalize-NewLines (ConvertTo-OctopusJson -InputObject $input) `
+            | Should Be (Normalize-NewLines $expected);
     }
 
     It "InputObject is an unhandled type" {
         { ConvertTo-OctopusJson -InputObject ([System.Guid]::NewGuid()) } `
             | Should Throw "Unhandled input object type 'System.Guid'.";
     }
 
-}
+}
diff --git a/tools/StepTemplatePacker/tests/Invoke-PesterTests.ps1 b/tools/StepTemplatePacker/tests/Invoke-PesterTests.ps1
@@ -1,18 +1,17 @@
+param(
+    [string] $Filter = "*"
+)
+
 $ErrorActionPreference = "Stop";
 Set-StrictMode -Version "Latest";
 
 $thisScript = $MyInvocation.MyCommand.Path;
 $thisFolder = [System.IO.Path]::GetDirectoryName($thisScript);
-
-$packagesFolder = $thisFolder;
-$packagesFolder = [System.IO.Path]::GetDirectoryName($packagesFolder);
-$packagesFolder = [System.IO.Path]::GetDirectoryName($packagesFolder);
-$packagesFolder = [System.IO.Path]::GetDirectoryName($packagesFolder);
-$packagesFolder = [System.IO.Path]::Combine($packagesFolder, "packages");
-
+$repoRoot = [System.IO.Path]::GetFullPath((Join-Path $thisFolder ".." ".." ".."));
 $packer = [System.IO.Path]::GetDirectoryName($thisFolder);
+$sharedRunner = Join-Path $repoRoot "tools" "Invoke-SharedPesterTests.ps1";
 
-Import-Module -Name $packer;
-Import-Module -Name ([System.IO.Path]::Combine($packagesFolder, "Pester.3.4.3\tools\Pester"));
-
-Invoke-Pester;
+& $sharedRunner `
+    -TestRoot $thisFolder `
+    -Filter $Filter `
+    -ImportModules @($packer);
diff --git a/tools/StepTemplatePacker/tests/Set-OctopusStepTemplateProperty.Tests.ps1 b/tools/StepTemplatePacker/tests/Set-OctopusStepTemplateProperty.Tests.ps1
