Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop execution if tool version already installed #49

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Stop execution if tool version already installed #49

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38108f6
Stop execution if tool version already installed unless `-Force` is s…
TinaMor Jan 30, 2025
bbb8f1e
Make reinstall check reusable
TinaMor Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 44 additions & 1 deletion Tests/BuildkitTools.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ Describe "BuildkitTools.psm1" {
Mock Test-EmptyDirectory -ModuleName 'BuildkitTools' -MockWith { return $true }
Mock Install-Buildkit -ModuleName 'BuildkitTools'
Mock Remove-Item -ModuleName 'BuildkitTools'

# Mock for Invoke-ExecutableCommand- "nerdctl --version"
$mockExecutablePath = "$TestDrive\Program Files\Buildkit\bin\buildkitd.exe"
$mockConfigStdOut = New-MockObject -Type 'System.IO.StreamReader' -Methods @{ ReadToEnd = { return "buildkitd github.com/moby/buildkit v1.0.0 c949t3ti0484" } }
$mockProcess = New-MockObject -Type 'System.Diagnostics.Process' -Properties @{
StandardOutput = $mockConfigStdOut
ExitCode = 0
}
Mock Invoke-ExecutableCommand -ModuleName "BuildkitTools" -MockWith { return $mockProcess } -ParameterFilter {
$Executable -eq "$mockExecutablePath" -and
$Arguments -eq "--version" }
}

AfterEach {
Expand All @@ -77,6 +88,7 @@ Describe "BuildkitTools.psm1" {
It "Should use defaults" {
Install-Buildkit -Force -Confirm:$false

Should -Invoke Get-BuildkitLatestVersion -ModuleName 'BuildkitTools' -Times 1 -Exactly -Scope It
Should -Invoke Uninstall-Buildkit -ModuleName 'BuildkitTools' -Times 0 -Exactly -Scope It
Should -Invoke Get-InstallationFile -ModuleName 'BuildkitTools' -ParameterFilter {
$fileParameters[0].Feature -eq "Buildkit" -and
Expand Down Expand Up @@ -127,11 +139,35 @@ Describe "BuildkitTools.psm1" {
-ParameterFilter { $BuildKitPath -eq "$Env:ProgramFiles\Buildkit" -and $WinCNIPath -eq "" }
}

It "Should not reinstall tool if version already exists and force is not specified" {
Mock Test-EmptyDirectory -ModuleName 'BuildkitTools' -MockWith { return $false }

# Mock for Get-ChildItem - "buildkitd.exe"
Mock Get-ChildItem -ModuleName 'BuildkitTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Buildkit" -and
$Recurse -eq $true
$Filter -eq "buildkitd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Buildkit -Confirm:$false
Should -Invoke Uninstall-Buildkit -ModuleName 'BuildkitTools' -Times 0
Should -Invoke Install-RequiredFeature -ModuleName 'BuildkitTools' -Times 0
}

It "Should uninstall tool if it is already installed" {
Mock Test-EmptyDirectory -ModuleName 'BuildkitTools' -MockWith { return $false }

# Mock for Get-ChildItem - "buildkitd.exe"
Mock Get-ChildItem -ModuleName 'BuildkitTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Buildkit" -and
$Recurse -eq $true
$Filter -eq "buildkitd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Buildkit -Force -Confirm:$false

Should -Invoke Invoke-ExecutableCommand -ModuleName "BuildkitTools" `
-ParameterFilter { ($Executable -eq $mockExecutablePath ) -and ($Arguments -eq "--version") }
Should -Invoke Uninstall-Buildkit -ModuleName 'BuildkitTools' -Times 1 -Exactly -Scope It `
-ParameterFilter { $Path -eq "$Env:ProgramFiles\Buildkit" -and $force -eq $true }
}
Expand All @@ -140,7 +176,14 @@ Describe "BuildkitTools.psm1" {
Mock Test-EmptyDirectory -ModuleName 'BuildkitTools' -MockWith { return $false }
Mock Uninstall-Buildkit -ModuleName 'BuildkitTools' -MockWith { throw 'Error' }

{ Install-Buildkit -Confirm:$false } | Should -Throw "Buildkit installation failed. Error"
# Mock for Get-ChildItem - "buildkitd.exe"
Mock Get-ChildItem -ModuleName 'BuildkitTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Buildkit" -and
$Recurse -eq $true
$Filter -eq "buildkitd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

{ Install-Buildkit -Confirm:$false -Force } | Should -Throw "Buildkit installation failed. Error"
}
}

Expand Down
45 changes: 44 additions & 1 deletion Tests/ContainerdTools.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,17 @@ Describe "ContainerdTools.psm1" {
Mock Test-EmptyDirectory -ModuleName 'ContainerdTools' -MockWith { return $true }
Mock Install-Containerd -ModuleName 'ContainerdTools'
Mock Remove-Item -ModuleName 'ContainerdTools'

# Mock for Invoke-ExecutableCommand- "nerdctl --version"
$mockExecutablePath = "$TestDrive\Program Files\Containerd\bin\containerd.exe"
$mockConfigStdOut = New-MockObject -Type 'System.IO.StreamReader' -Methods @{ ReadToEnd = { return "containerd github.com/containerd/containerd/v1 v1.0.0 c949t3ti0484" } }
$mockProcess = New-MockObject -Type 'System.Diagnostics.Process' -Properties @{
StandardOutput = $mockConfigStdOut
ExitCode = 0
}
Mock Invoke-ExecutableCommand -ModuleName "ContainerdTools" -MockWith { return $mockProcess } -ParameterFilter {
$Executable -eq "$mockExecutablePath" -and
$Arguments -eq "--version" }
}

It 'Should not process on implicit request for validation (WhatIfPreference)' {
Expand All @@ -73,6 +84,7 @@ Describe "ContainerdTools.psm1" {
It "Should use defaults" {
Install-Containerd -Force -Confirm:$false

Should -Invoke Get-ContainerdLatestVersion -ModuleName 'ContainerdTools' -Times 1 -Exactly -Scope It
Should -Invoke Uninstall-Containerd -ModuleName 'ContainerdTools' -Times 0 -Exactly -Scope It
Should -Invoke Get-InstallationFile -ModuleName 'ContainerdTools' -ParameterFilter {
($fileParameters[0].Feature -eq "Containerd") -and
Expand Down Expand Up @@ -119,11 +131,35 @@ Describe "ContainerdTools.psm1" {
-ParameterFilter { $ContainerdPath -eq "$Env:ProgramFiles\Containerd" }
}

It "Should not reinstall tool if version already exists and force is not specified" {
Mock Test-EmptyDirectory -ModuleName 'ContainerdTools' -MockWith { return $false }

# Mock for Get-ChildItem - "containerd.exe"
Mock Get-ChildItem -ModuleName 'ContainerdTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Containerd" -and
$Recurse -eq $true
$Filter -eq "containerd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Containerd -Confirm:$false
Should -Invoke Uninstall-Containerd -ModuleName 'ContainerdTools' -Times 0
Should -Invoke Install-RequiredFeature -ModuleName 'ContainerdTools' -Times 0
}

It "Should uninstall tool if it is already installed" {
Mock Test-EmptyDirectory -ModuleName 'ContainerdTools' -MockWith { return $false }

# Mock for Get-ChildItem - "containerd.exe"
Mock Get-ChildItem -ModuleName 'ContainerdTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Containerd" -and
$Recurse -eq $true
$Filter -eq "containerd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Containerd -Force -Confirm:$false

Should -Invoke Invoke-ExecutableCommand -ModuleName "ContainerdTools" `
-ParameterFilter { ($Executable -eq $mockExecutablePath ) -and ($Arguments -eq "--version") }
Should -Invoke Uninstall-Containerd -ModuleName 'ContainerdTools' -Times 1 -Exactly -Scope It `
-ParameterFilter { $Path -eq "$Env:ProgramFiles\Containerd" -and $force -eq $true }
}
Expand All @@ -132,7 +168,14 @@ Describe "ContainerdTools.psm1" {
Mock Test-EmptyDirectory -ModuleName 'ContainerdTools' -MockWith { return $false }
Mock Uninstall-Containerd -ModuleName 'ContainerdTools' -MockWith { throw 'Error' }

{ Install-Containerd -Confirm:$false } | Should -Throw "Containerd installation failed. Error"
# Mock for Get-ChildItem - "containerd.exe"
Mock Get-ChildItem -ModuleName 'ContainerdTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\Containerd" -and
$Recurse -eq $true
$Filter -eq "containerd.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

{ Install-Containerd -Confirm:$false -Force } | Should -Throw "Containerd installation failed. Error"
}
}

Expand Down
53 changes: 48 additions & 5 deletions Tests/NerdctlTools.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ Describe "NerdctlTools.psm1" {
$RootPath = Split-Path -Parent $PSScriptRoot
$ModuleParentPath = Join-Path -Path $RootPath -ChildPath 'Containers-Toolkit'
Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
Import-Module -Name "$ModuleParentPath\Public\NerdctlTools.psm1"
Import-Module -Name "$ModuleParentPath\Public\ContainerdTools.psm1"
Import-Module -Name "$ModuleParentPath\Public\BuildkitTools.psm1"
Import-Module -Name "$ModuleParentPath\Public\ContainerNetworkTools.psm1"
Import-Module -Name "$ModuleParentPath\Public\NerdctlTools.psm1" -Force
}
Expand All @@ -26,8 +26,8 @@ Describe "NerdctlTools.psm1" {

AfterAll {
Remove-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force -ErrorAction Ignore
Remove-Module -Name "$ModuleParentPath\Public\BuildkitTools.psm1" -Force -ErrorAction Ignore
Remove-Module -Name "$ModuleParentPath\Public\ContainerdTools.psm1" -Force -ErrorAction Ignore
Remove-Module -Name "$ModuleParentPath\Public\BuildkitTools.psm1" -Force -ErrorAction Ignore
Remove-Module -Name "$ModuleParentPath\Public\ContainerNetworkTools.psm1" -Force -ErrorAction Ignore
Remove-Module -Name "$ModuleParentPath\Public\NerdctlTools.psm1" -Force -ErrorAction Ignore
}
Expand All @@ -49,6 +49,17 @@ Describe "NerdctlTools.psm1" {
Mock Install-WinCNIPlugin -ModuleName 'NerdctlTools'
Mock Install-Nerdctl -ModuleName 'NerdctlTools'
Mock Remove-Item -ModuleName 'NerdctlTools'

# Mock for Invoke-ExecutableCommand- "nerdctl --version"
$mockExecutablePath = "$TestDrive\Program Files\nerdctl\nerdctl.exe"
$mockConfigStdOut = New-MockObject -Type 'System.IO.StreamReader' -Methods @{ ReadToEnd = { return "nerdctl version v7.9.8" } }
$mockProcess = New-MockObject -Type 'System.Diagnostics.Process' -Properties @{
StandardOutput = $mockConfigStdOut
ExitCode = 0
}
Mock Invoke-ExecutableCommand -ModuleName "NerdctlTools" -MockWith { return $mockProcess } -ParameterFilter {
$Executable -eq "$mockExecutablePath" -and
$Arguments -eq "--version" }
}

It 'Should not process on implicit request for validation (WhatIfPreference)' {
Expand All @@ -67,6 +78,7 @@ Describe "NerdctlTools.psm1" {
It "Should use defaults" {
Install-Nerdctl -Force -Confirm:$false

Should -Invoke Get-NerdctlLatestVersion -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It
Should -Invoke Uninstall-Nerdctl -ModuleName 'NerdctlTools' -Times 0 -Exactly -Scope It
Should -Invoke Get-InstallationFile -ModuleName 'NerdctlTools' -ParameterFilter {
$fileParameters[0].Feature -eq "nerdctl" -and
Expand Down Expand Up @@ -117,11 +129,35 @@ Describe "NerdctlTools.psm1" {
Should -Invoke Install-WinCNIPlugin -ModuleName 'NerdctlTools' -Times 0 -Exactly -Scope It
}

It "Should not reinstall tool if version already exists and force is not specified" {
Mock Test-EmptyDirectory -ModuleName 'ContainerdTools' -MockWith { return $false }

# Mock for Get-ChildItem - "nerdctl.exe"
Mock Get-ChildItem -ModuleName 'NerdctlTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\nerdctl" -and
$Recurse -eq $true
$Filter -eq "nerdctl.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Nerdctl -Confirm:$false
Should -Invoke Uninstall-Nerdctl -ModuleName 'NerdctlTools' -Times 0
Should -Invoke Install-RequiredFeature -ModuleName 'NerdctlTools' -Times 0
}

It "Should uninstall tool if it is already installed" {
Mock Test-EmptyDirectory -ModuleName 'NerdctlTools' -MockWith { return $false }

# Mock for Get-ChildItem - "nerdctl.exe"
Mock Get-ChildItem -ModuleName 'NerdctlTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\nerdctl" -and
$Recurse -eq $true
$Filter -eq "nerdctl.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

Install-Nerdctl -Force -Confirm:$false

Should -Invoke Invoke-ExecutableCommand -ModuleName "NerdctlTools" `
-ParameterFilter { ($Executable -eq $mockExecutablePath ) -and ($Arguments -eq "--version") }
Should -Invoke Uninstall-Nerdctl -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It `
-ParameterFilter { $Path -eq "$Env:ProgramFiles\nerdctl" }
}
Expand All @@ -130,19 +166,26 @@ Describe "NerdctlTools.psm1" {
Mock Test-EmptyDirectory -ModuleName 'NerdctlTools' -MockWith { return $false }
Mock Uninstall-Nerdctl -ModuleName 'NerdctlTools' -MockWith { throw 'Error' }

{ Install-Nerdctl -Confirm:$false } | Should -Throw "nerdctl installation failed. Error"
# Mock for Get-ChildItem - "nerdctl.exe"
Mock Get-ChildItem -ModuleName 'NerdctlTools' -ParameterFilter {
$Path -eq "$Env:ProgramFiles\nerdctl" -and
$Recurse -eq $true
$Filter -eq "nerdctl.exe"
} -MockWith { return @{FullName = "$mockExecutablePath" } }

{ Install-Nerdctl -Confirm:$false -Force } | Should -Throw "nerdctl installation failed. Error"
}

It "Should install all dependencies if 'All' is specified" {
Install-Nerdctl -Dependencies 'All' -Confirm:$false
Install-Nerdctl -Dependencies 'All' -Confirm:$false -Force

Should -Invoke Install-Containerd -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It
Should -Invoke Install-Buildkit -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It
Should -Invoke Install-WinCNIPlugin -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It
}

It "Should install specified dependencies" {
Install-Nerdctl -Dependencies 'containerd' -Confirm:$false
Install-Nerdctl -Dependencies 'containerd' -Confirm:$false -Force

Should -Invoke Install-Containerd -ModuleName 'NerdctlTools' -Times 1 -Exactly -Scope It
Should -Invoke Install-Buildkit -ModuleName 'NerdctlTools' -Times 0 -Exactly -Scope It
Expand Down
14 changes: 14 additions & 0 deletions containers-toolkit/Private/CommonToolUtilities.psm1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ function Get-LatestToolVersion($repository) {
}
}

function Test-IsLatestVersion($Tool, $Version, $LatestVersion) {
$currentVersion = [System.Version]$Version
$latestVersion = [System.Version]$latestVersion

$isLatest = ($currentVersion -eq $latestVersion)
if (-not $isLatest) {
Write-Warning "A newer version of $tool is available. { Version: $currentVersion, Latest version: $latestVersion }"
}
return $isLatest
}

function Test-EmptyDirectory($path) {
if (-not (Test-Path -Path $path)) {
return $true
Expand Down Expand Up @@ -513,6 +524,8 @@ function Test-FileChecksum {
$isValid = $downloadedChecksum.Hash -eq $checksum
$found = $true
return
} else {
Write-Debug "File name does not match. {checksum file: $filename, downloaded file: $downloadedFileName}"
}
}

Expand Down Expand Up @@ -891,6 +904,7 @@ function Invoke-ExecutableCommand {


Export-ModuleMember -Function Get-LatestToolVersion
Export-ModuleMember -Function Test-IsLatestVersion
Export-ModuleMember -Function Get-DefaultInstallPath
Export-ModuleMember -Function Test-EmptyDirectory
Export-ModuleMember -Function Get-InstallationFile
Expand Down
Loading
Loading