Refactor scripts to use common tool invocation

mthalman · Apr 29, 2024 · aee8a79 · aee8a79
1 parent 665f1d2
commit aee8a79
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 44 deletions.
diff --git a/container/check-image.ps1 b/container/check-image.ps1
@@ -14,22 +14,14 @@ $ErrorActionPreference = 'Stop'
 $ProgressPreference = 'SilentlyContinue'
 Set-StrictMode -Version 2.0
 
-function LogMessage ($Message) {
-    Write-Output $Message | Out-File $env:HOME/log.txt -Append
-}
-
-$expr = "dredge image compare layers --output json $BaseImage $TargetImage --os linux --arch $Architecture"
-LogMessage "Invoke: $expr"
-$result = Invoke-Expression $expr
-$dredgeExitCode = $LASTEXITCODE
-LogMessage "Result: $result"
-if ($dredgeExitCode -ne 0) {
-    throw "dredge image compare failed"
-}
-
-$result = $result | ConvertFrom-Json
-
-$imageUpToDate = [bool]$($result.summary.targetIncludesAllBaseLayers)
+Import-Module $PSScriptRoot/common.psm1
+
+$cmd = "dredge image compare layers --output json $BaseImage $TargetImage --os linux --arch $Architecture"
+$layerComparisonStr = $(InvokeTool $cmd "dredge image compare failed")
+
+$layerComparison = $layerComparisonStr | ConvertFrom-Json
+
+$imageUpToDate = [bool]$($layerComparison.summary.targetIncludesAllBaseLayers)
 $sendDispatch = ([string](-not $imageUpToDate)).ToLower()
 
 LogMessage "Send dispatch: $sendDispatch"

diff --git a/container/common.psm1 b/container/common.psm1
@@ -0,0 +1,24 @@
+$ErrorActionPreference = 'Stop'
+$ProgressPreference = 'SilentlyContinue'
+Set-StrictMode -Version 2.0
+
+function LogMessage ([string] $Message) {
+    Write-Output $Message | Out-File $env:HOME/log.txt -Append
+}
+
+function InvokeTool([string]$ToolCommand, [string] $ErrorMessage) {
+    LogMessage "Invoke: $ToolCommand"
+
+    # Reset $LASTEXITCODE in case it was tripped somewhere
+    # See https://github.com/pester/Pester/issues/1616
+    $Global:LASTEXITCODE = 0
+
+    $result = Invoke-Expression $ToolCommand
+    $exitCode = $LASTEXITCODE
+    LogMessage "Result: $result"
+    if ($exitCode -ne 0) {
+        throw $ErrorMessage
+    }
+
+    return $result
+}
diff --git a/container/entrypoint.ps1 b/container/entrypoint.ps1
@@ -21,6 +21,6 @@ if (-not $BaseImage) {
     $BaseImage = $(& $PSScriptRoot/get-base-image.ps1 -DockerfilePath $DockerfilePath -BaseStageName $BaseStageName)
 }
 
-$triggerWorkflow = $(& $PSScriptRoot/check-image.ps1 -TargetImage $targetImage -BaseImage $BaseImage -Architecture $Architecture)
+$result = $(& $PSScriptRoot/check-image.ps1 -TargetImage $targetImage -BaseImage $BaseImage -Architecture $Architecture)
 
-return $triggerWorkflow
+return $result
diff --git a/container/get-base-image.ps1 b/container/get-base-image.ps1
@@ -9,9 +9,7 @@ $ErrorActionPreference = 'Stop'
 $ProgressPreference = 'SilentlyContinue'
 Set-StrictMode -Version 2.0
 
-function LogMessage ($Message) {
-    Write-Output $Message | Out-File $env:HOME/log.txt -Append
-}
+Import-Module $PSScriptRoot/common.psm1
 
 if (-not (Test-Path $DockerfilePath)) {
     throw "Dockerfile path '$DockerfilePath' does not exist."
@@ -36,14 +34,8 @@ if (-not $BaseStageName) {
 
 $dfspyArgsString = $dfspyArgs -join ' '
 
-$expr = "dfspy $dfspyArgsString"
-LogMessage "Invoke: $expr"
-$fromOutput = Invoke-Expression $expr
-$dfspyExitCode = $LASTEXITCODE
-LogMessage "Result: $fromOutput"
-if ($dfspyExitCode -ne 0) {
-    throw "dfspy failed"
-}
+$cmd = "dfspy $dfspyArgsString"
+$fromOutput = $(InvokeTool $cmd "dfspy failed")
 $fromOutput = $fromOutput | ConvertFrom-Json
 
 if ($BaseStageName) {

diff --git a/container/tests/check-image.tests.ps1 b/container/tests/check-image.tests.ps1
@@ -1,7 +1,8 @@
-BeforeAll {
+Import-Module -Force $PSScriptRoot/../common.psm1
+
+BeforeAll {    
     $global:LASTEXITCODE = 0
-    Mock Invoke-Expression { $global:LASTEXITCODE = 0 } -ParameterFilter { $Command -like "dotnet *" }
-    Mock Out-File { }
+    Mock Out-File { } -ModuleName common
 
     $targetImage = "foo"
     $baseImage = "bar"
@@ -19,7 +20,8 @@ Describe 'Get result' {
                 }
             }
             $result | ConvertTo-Json
-        } -ParameterFilter { $Command -eq "dredge image compare layers --output json $baseImage $targetImage --os linux --arch $architecture" }
+        } -ParameterFilter { $Command -eq "dredge image compare layers --output json $baseImage $targetImage --os linux --arch $architecture" } `
+          -ModuleName common
         & $targetScript -TargetImage $targetImage -BaseImage $baseImage -Architecture $architecture | Should -Be "false"
     }
 
@@ -31,13 +33,14 @@ Describe 'Get result' {
                 }
             }
             $result | ConvertTo-Json
-        } -ParameterFilter { $Command -eq "dredge image compare layers --output json $baseImage $targetImage --os linux --arch $architecture" }
+        } -ParameterFilter { $Command -eq "dredge image compare layers --output json $baseImage $targetImage --os linux --arch $architecture" } `
+          -ModuleName common
 
         & $targetScript -TargetImage $targetImage -BaseImage $baseImage -Architecture $architecture | Should -Be "true"
     }
 
     It 'Given a failed dredge command, it throws an error' {
-        Mock Invoke-Expression { $global:LASTEXITCODE = 1 } -ParameterFilter { $Command -like "dredge *" }
+        Mock Invoke-Expression { $global:LASTEXITCODE = 1 } -ParameterFilter { $Command -like "dredge *" } -ModuleName common
 
         { & $targetScript -TargetImage $targetImage -BaseImage $baseImage -Architecture $architecture } | Should -Throw "dredge image compare failed"
     }

diff --git a/container/tests/get-base-image.tests.ps1 b/container/tests/get-base-image.tests.ps1
@@ -1,8 +1,9 @@
+Import-Module -Force $PSScriptRoot/../common.psm1
+
 BeforeAll {
     $global:LASTEXITCODE = 0
-    Mock Invoke-Expression { $global:LASTEXITCODE = 0 } -ParameterFilter { $Command -like "dotnet *" }
     Mock Test-Path { $true }
-    Mock Out-File {}
+    Mock Out-File {} -ModuleName common
 
     $targetScript = "$PSScriptRoot/../get-base-image.ps1"
 }
@@ -19,7 +20,8 @@ Describe 'Get base image' {
                     }
                 )
                 $fromOutput | ConvertTo-Json
-            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" }
+            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" } `
+              -ModuleName common
 
             & $targetScript -DockerfilePath 'Dockerfile' | Should -Be "foo"
         }
@@ -47,7 +49,8 @@ Describe 'Get base image' {
                     }
                 )
                 $fromOutput | ConvertTo-Json -Depth 10
-            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" }
+            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" } `
+              -ModuleName common
 
             & $targetScript -DockerfilePath 'Dockerfile' | Should -Be "foo3"
         }
@@ -81,7 +84,8 @@ Describe 'Get base image' {
                     }
                 )
                 $fromOutput | ConvertTo-Json -Depth 10
-            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" }
+            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile --layout graph" } `
+              -ModuleName common
 
             & $targetScript -DockerfilePath 'Dockerfile' | Should -Be "foo4"
         }
@@ -97,7 +101,8 @@ Describe 'Get base image' {
                     }
                 )
                 $fromOutput | ConvertTo-Json
-            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" }
+            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" } `
+              -ModuleName common
 
             & $targetScript -DockerfilePath 'Dockerfile' -BaseStageName stage1 | Should -Be "foo"
         }
@@ -118,7 +123,8 @@ Describe 'Get base image' {
                     }
                 )
                 $fromOutput | ConvertTo-Json -Depth 10
-            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" }
+            } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" } `
+              -ModuleName common
 
             & $targetScript -DockerfilePath 'Dockerfile' -BaseStageName stage1 | Should -Be "foo3"
         }
@@ -131,7 +137,7 @@ Describe 'Get base image' {
     }
 
     It 'Given a failed dfspy command, it throws an error' {
-        Mock Invoke-Expression { $global:LASTEXITCODE = 1 } -ParameterFilter { $Command -like "dfspy *" }
+        Mock Invoke-Expression { $global:LASTEXITCODE = 1 } -ParameterFilter { $Command -like "dfspy *" } -ModuleName common
 
         { & $targetScript -DockerfilePath 'Dockerfile' } | Should -Throw "dfspy failed"
     }
@@ -146,7 +152,8 @@ Describe 'Get base image' {
                 }
             )
             $fromOutput | ConvertTo-Json
-        } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" }
+        } -ParameterFilter { $Command -eq "dfspy query from -f Dockerfile" } `
+          -ModuleName common
 
         { & $targetScript -DockerfilePath 'Dockerfile' -BaseStageName stage2 } | Should -Throw "Could not find stage with name 'stage2'."
     }