Make reinstall check reusable

TinaMor · TinaMor · commit bbb8f1e04b7c · 2025-02-05T23:15:39.000+03:00
diff --git a/containers-toolkit/Private/CommonToolUtilities.psm1 b/containers-toolkit/Private/CommonToolUtilities.psm1
@@ -72,30 +72,107 @@ $HASH_FUNCTIONS_STR = $HASH_FUNCTIONS -join '|' # SHA1|SHA256|SHA384|SHA512|MD5
 $NERDCTL_CHECKSUM_FILE_PATTERN = "(?<hashfunction>(?:^({0})))" -f ($HASH_FUNCTIONS -join '|')
 $NERDCTL_FILTER_SCRIPTBLOCK_STR = { (("{0}" -match "$NERDCTL_CHECKSUM_FILE_PATTERN") -and "{0}" -notmatch ".*.asc$") }.ToString()
 
-function Get-LatestToolVersion($repository) {
+$CONTAINERD_REPO = "containerd/containerd"
+$BUILDKIT_REPO = "moby/buildkit"
+$NERDCTL_REPO = "containerd/nerdctl"
+$WINCNI_PLUGIN_REPO = "microsoft/Windows-Container-Networking"
+$CLOUDNATIVE_CNI_REPO = "containernetworking/plugins"
+
+
+function Get-LatestToolVersion($tool) {
+    # Get the repository based on the tool
+    $repository = switch ($tool.ToLower()) {
+        "containerd" { $CONTAINERD_REPO }
+        "buildkit" { $BUILDKIT_REPO }
+        "nerdctl" { $NERDCTL_REPO }
+        "wincniplugin" { $WINCNI_PLUGIN_REPO }
+        "cloudnativecni" { $CLOUDNATIVE_CNI_REPO }
+        Default { Throw "Couldn't get latest $tool version. Invalid tool: $tool" }
+    }
+
+    # Get the latest release version URL string
+    $uri = "https://api.github.com/repos/$repository/releases/latest"
+
+    Write-Debug "Getting the latest $tool version from $uri"
+
+    # Get the latest release version
     try {
-        $uri = "https://api.github.com/repos/$repository/releases/latest"
         $response = Invoke-WebRequest -Uri $uri -UseBasicParsing
         $version = ($response.content | ConvertFrom-Json).tag_name
         return $version.TrimStart("v")
     }
     catch {
-        $tool = ($repository -split "/")[1]
-        Throw "Could not get $tool latest version. $($_.Exception.Message)"
+        Throw "Couldn't get latest $tool version from $uri. $($_.Exception.Message)"
     }
 }
 
-function Test-IsLatestVersion($Tool, $Version, $LatestVersion) {
-    $currentVersion = [System.Version]$Version
-    $latestVersion = [System.Version]$latestVersion
+function Test-IsLatestVersion($Tool, $Version) {
+    $targetVersion = [System.Version]$Version
+
+    # Get the latest version of the tool
+    $latestVersion = Get-LatestToolVersion -Tool $Tool
+    Write-Debug "Latest $Tool version: $latestVersion"
+    $latestVersion = [System.Version](Get-LatestToolVersion -Tool $Tool)
 
-    $isLatest = ($currentVersion -eq $latestVersion)
+    $isLatest = ($targetVersion -eq $latestVersion)
     if (-not $isLatest) {
-        Write-Warning "A newer version of $tool is available. { Version: $currentVersion, Latest version: $latestVersion }"
+        Write-Warning "A newer version of $tool is available. { Target Version: $targetVersion, Latest Version: $latestVersion }"
     }
     return $isLatest
 }
 
+function Test-ToolReinstall {
+    param(
+        [string]$tool,
+        [string]$targetVersion,
+        [string]$executable
+    )
+
+    Write-Debug "Tool: $tool, Target Version: $targetVersion, Executable: $executable"
+
+    # Check if the target version is the latest version
+    if ($targetVersion -eq 'latest') {
+        $targetVersion = Get-LatestToolVersion -Tool $tool
+    }
+    else {
+        # Check if a newer version is available
+        Test-IsLatestVersion -Tool "$tool" -Version $targetVersion | Out-Null
+    }
+
+    # Check if the tool is already installed
+    Write-Debug "$tool executable: $executable"
+    $isInstalled = ($executable -and (Test-Path -Path $executable))
+
+    #  If tool is not installed, the tool is a new installation.
+    if (-not $isInstalled) {
+        return $false
+    }
+
+    # Check if the installed version is the same as the target version
+    $cmdOutput = Invoke-ExecutableCommand -Executable "$executable" -Arguments "--version"
+    if ($cmdOutput.ExitCode -ne 0) {
+        Write-Warning "Failed to get nerdctl version: $($cmdOutput.StandardError.ReadToEnd())"
+        return $true
+    }
+
+    # Extract version from the output
+    #     containerd github.com/containerd/containerd/v2 v2.0.2 c507a0257ea6462fbd6f5ba4f5c74facb04021f4
+    #     buildkitd github.com/moby/buildkit v0.19.0 3637d1b15a13fc3cdd0c16fcf3be0845ae68f53d
+    #     nerdctl version v7.9.8
+    $installedVersion = $cmdOutput.StandardOutput.ReadToEnd().Trim()
+    $installedVersion = ($installedVersion.Split(' ')[2]).TrimStart('v')
+    Write-Debug "{ Target Version: $targetVersion, Installed Version: $installedVersion }"
+
+    # Compare the installed version with the target version
+    if ($targetVersion -eq $installedVersion) {
+        Write-Warning "Installed $tool version is the same as the requested version, '$installedVersion'."
+    } else {
+        Write-Warning "$tool version '$installedVersion' is installed."
+    }
+
+    return $true
+}
+
 function Test-EmptyDirectory($path) {
     if (-not (Test-Path -Path $path)) {
         return $true
@@ -524,7 +601,8 @@ function Test-FileChecksum {
                 $isValid = $downloadedChecksum.Hash -eq $checksum
                 $found = $true
                 return
-            } else {
+            }
+            else {
                 Write-Debug "File name does not match. {checksum file: $filename, downloaded file: $downloadedFileName}"
             }
         }
@@ -903,8 +981,10 @@ function Invoke-ExecutableCommand {
 }
 
 
+# Export-ModuleMember -Variable CONTAINERD_REPO, BUILDKIT_REPO, NERDCTL_REPO, WINCNI_PLUGIN_REPO, CLOUDNATIVE_CNI_REPO
 Export-ModuleMember -Function Get-LatestToolVersion
 Export-ModuleMember -Function Test-IsLatestVersion
+Export-ModuleMember -Function Test-ToolReinstall
 Export-ModuleMember -Function Get-DefaultInstallPath
 Export-ModuleMember -Function Test-EmptyDirectory
 Export-ModuleMember -Function Get-InstallationFile
diff --git a/containers-toolkit/Public/BuildkitTools.psm1 b/containers-toolkit/Public/BuildkitTools.psm1
@@ -13,7 +13,7 @@ $ModuleParentPath = Split-Path -Parent $PSScriptRoot
 Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
 
 function Get-BuildkitLatestVersion {
-    $latestVersion = Get-LatestToolVersion -Repository "moby/buildkit"
+    $latestVersion = Get-LatestToolVersion -Tool "buildkit"
     return $latestVersion
 }
 
@@ -56,6 +56,8 @@ function Install-Buildkit {
     )
 
     begin {
+        $tool = 'Buildkit'
+
         # Check if Buildkit is alread installed
         $blktdexe = (Get-ChildItem -Path $InstallPath -Recurse -Filter "buildkitd.exe" | Select-Object -First 1).FullName
         $isInstalled = ($null -ne $blktdexe)
@@ -81,44 +83,23 @@ function Install-Buildkit {
             }
             $Version = $Version.TrimStart('v')
 
-            # Check if a newer version is available
-            $userVersion = $Version
-            if ($Version -ne 'latest') {
-                Test-IsLatestVersion -Tool 'Buildkit' -Version $Version -LatestVersion $latestVersion | Out-Null
-            }
-            else {
-                $userVersion = $latestVersion
-            }
-
-            # Check if tool already exists at specified location
-            if ($isInstalled) {
-                $errMsg = "Buildkit already exists at $InstallPath or the directory is not empty"
+            # Check if we need to reinstall
+            $reinstall = Test-ToolReinstall $tool $Version $blktdexe
+            if ($reinstall) {
+                $errMsg = "$tool already exists at $InstallPath."
                 Write-Warning $errMsg
 
-                # Check if user wants to install an already installed version
-                Write-Debug "Buildkit executable: $blktdexe"
-                $cmdOutput = Invoke-ExecutableCommand -Executable "$blktdexe" -Arguments "--version"
-                if ($cmdOutput.ExitCode -eq 0) {
-                    # buildkitd github.com/moby/buildkit v0.19.0 3637d1b15a13fc3cdd0c16fcf3be0845ae68f53d
-                    $blktVersion = $cmdOutput.StandardOutput.ReadToEnd().Trim()
-
-                    # Extract version from the output
-                    $blktVersion = ($blktVersion.Split(' ')[2]).TrimStart('v')
-                    Write-Debug "{ User Version: $userVersion, Current Version: $blktVersion }"
-                    if ($userVersion -eq $blktVersion) {
-                        Write-Warning "Installed Buildkit version is the same as the requested version. Please uninstall the existing version using 'Uninstall-Containerd' or use -Force to reinstall."
-                        if (!$Force) {
-                            return
-                        }
-                    }
+                if (!$Force) {
+                    Write-Warning "Installation cancelled. $errMsg Please uninstall the existing version using 'Uninstall-Buildkit' or use -Force to reinstall."
+                    return
                 }
 
                 # Uninstall if tool exists at specified location. Requires user consent
                 try {
-                    Uninstall-Buildkit -Path "$InstallPath" -Force:$Force -Confirm:$false | Out-Null
+                    Uninstall-Buildkit -Path "$InstallPath" -Confirm:$false -Force:$Force | Out-Null
                 }
                 catch {
-                    Throw "Buildkit installation failed. $_"
+                    Throw "nerdctl installation failed. $_"
                 }
             }
 
diff --git a/containers-toolkit/Public/ContainerNetworkTools.psm1 b/containers-toolkit/Public/ContainerNetworkTools.psm1
@@ -13,7 +13,7 @@ $ModuleParentPath = Split-Path -Parent $PSScriptRoot
 Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
 
 function Get-WinCNILatestVersion {
-    $latestVersion = Get-LatestToolVersion -Repository "microsoft/windows-container-networking"
+    $latestVersion = Get-LatestToolVersion -Tool "WinCNIPlugin"
     return $latestVersion
 }
 
diff --git a/containers-toolkit/Public/ContainerdTools.psm1 b/containers-toolkit/Public/ContainerdTools.psm1
@@ -13,7 +13,7 @@ Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
 
 
 function Get-ContainerdLatestVersion {
-    $latestVersion = Get-LatestToolVersion -Repository "containerd/containerd"
+    $latestVersion = Get-LatestToolVersion -Tool "containerd"
     return $latestVersion
 }
 
@@ -45,6 +45,8 @@ function Install-Containerd {
     )
 
     begin {
+        $tool = 'Containerd'
+
         # Check if Containerd is alread installed
         $ctrexe = (Get-ChildItem -Path $InstallPath -Recurse -Filter "containerd.exe" | Select-Object -First 1).FullName
         $isInstalled = ($null -ne $ctrexe)
@@ -70,47 +72,26 @@ function Install-Containerd {
             }
             $Version = $Version.TrimStart('v')
 
-            # Check if a newer version is available
-            $userVersion = $Version
-            if ($Version -ne 'latest') {
-                Test-IsLatestVersion -Tool 'Containerd' -Version $Version -LatestVersion $latestVersion | Out-Null
-            }
-            else {
-                $userVersion = $latestVersion
-            }
-
-            # Check if tool already exists at specified location
-            if ($isInstalled) {
-                $errMsg = "Containerd already exists at $InstallPath or the directory is not empty"
+            # Check if we need to reinstall
+            $reinstall = Test-ToolReinstall $tool $Version $ctrexe
+            if ($reinstall) {
+                $errMsg = "$tool already exists at $InstallPath."
                 Write-Warning $errMsg
 
-                # Check if user wants to install an already installed version
-                Write-Debug "Containerd executable: $ctrexe"
-                $cmdOutput = Invoke-ExecutableCommand -Executable "$ctrexe" -Arguments "--version"
-                if ($cmdOutput.ExitCode -eq 0) {
-                    # Sample: containerd github.com/containerd/containerd/v2 v2.0.2 c507a0257ea6462fbd6f5ba4f5c74facb04021f4
-                    $ctrexeVersion = $cmdOutput.StandardOutput.ReadToEnd().Trim()
-
-                    # Extract version from the output
-                    $ctrexeVersion = ($ctrexeVersion.Split(' ')[2]).TrimStart('v')
-                    Write-Debug "{ User Version: $userVersion, Current Version: $ctrexeVersion }"
-
-                    if ($userVersion -eq $ctrexeVersion) {
-                        Write-Warning "Installed Containerd version is the same as the requested version. Please uninstall the existing version using 'Uninstall-Containerd' or use -Force to reinstall."
-                        if (!$Force) {
-                            return
-                        }
-                    }
+                if (!$Force) {
+                    Write-Warning "Installation cancelled. $errMsg Please uninstall the existing version using 'Uninstall-Containerd' or use -Force to reinstall."
+                    return
                 }
 
                 # Uninstall if tool exists at specified location. Requires user consent
                 try {
                     Uninstall-Containerd -Path "$InstallPath" -Confirm:$false -Force:$Force | Out-Null
                 }
                 catch {
-                    Throw "Containerd installation failed. $_"
+                    Throw "nerdctl installation failed. $_"
                 }
             }
+
             Write-Output "Downloading and installing Containerd v$version at $InstallPath"
 
             # Download files
diff --git a/containers-toolkit/Public/NerdctlTools.psm1 b/containers-toolkit/Public/NerdctlTools.psm1
@@ -12,7 +12,7 @@ $ModuleParentPath = Split-Path -Parent $PSScriptRoot
 Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force
 
 function Get-NerdctlLatestVersion {
-    $latestVersion = Get-LatestToolVersion -Repository "containerd/nerdctl"
+    $latestVersion = Get-LatestToolVersion -Tool "nerdctl"
     return $latestVersion
 }
 
@@ -86,6 +86,8 @@ function Install-Nerdctl {
     )
 
     begin {
+        $tool = 'nerdctl'
+
         # Check if Containerd is alread installed
         $nerdctlexe = (Get-ChildItem -Path $InstallPath -Recurse -Filter "nerdctl.exe" | Select-Object -First 1).FullName
         $isInstalled = ($null -ne $nerdctlexe)
@@ -118,36 +120,15 @@ function Install-Nerdctl {
             }
             $Version = $Version.TrimStart('v')
 
-            # Check if a newer version is available
-            $userVersion = $Version
-            if ($Version -ne 'latest') {
-                Test-IsLatestVersion -Tool 'nerdctl' -Version $Version -LatestVersion $latestVersion | Out-Null
-            }
-            else {
-                $userVersion = $latestVersion
-            }
-
-            # Check if tool already exists at specified location
-            if ($isInstalled) {
-                $errMsg = "nerdctl already exists at $InstallPath or the directory is not empty"
+            # Check if we need to reinstall
+            $reinstall = Test-ToolReinstall $tool $Version $nerdctlexe
+            if ($reinstall) {
+                $errMsg = "$tool already exists at $InstallPath."
                 Write-Warning $errMsg
 
-                Write-Debug "nerdctl executable: $nerdctlexe"
-                $cmdOutput = Invoke-ExecutableCommand -Executable "$nerdctlexe" -Arguments "--version"
-                if ($cmdOutput.ExitCode -eq 0) {
-                    # Sample: nerdctl version v7.9.8
-                    $nerdctlVersion = $cmdOutput.StandardOutput.ReadToEnd().Trim()
-
-                    # Extract version from the output
-                    $nerdctlVersion = ($nerdctlVersion.Split(' ')[2]).TrimStart('v')
-                    Write-Debug "{ User Version: $userVersion, Current Version: $nerdctlVersion }"
-
-                    if ($userVersion -eq $nerdctlVersion) {
-                        Write-Warning "Installed nerdctl version is the same as the requested version. Please uninstall the existing version using 'Uninstall-Containerd' or use -Force to reinstall."
-                        if (!$Force) {
-                            return
-                        }
-                    }
+                if (!$Force) {
+                    Write-Warning "Installation cancelled. $errMsg Please uninstall the existing version using 'Uninstall-Nerdctl' or use -Force to reinstall."
+                    return
                 }
 
                 # Uninstall if tool exists at specified location. Requires user consent

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ $ModuleParentPath = Split-Path -Parent $PSScriptRoot`
`13`	`13`	`Import-Module -Name "$ModuleParentPath\Private\CommonToolUtilities.psm1" -Force`
`14`	`14`
`15`	`15`	`function Get-WinCNILatestVersion {`
`16`		`- $latestVersion = Get-LatestToolVersion -Repository "microsoft/windows-container-networking"`
	`16`	`+ $latestVersion = Get-LatestToolVersion -Tool "WinCNIPlugin"`
`17`	`17`	`return $latestVersion`
`18`	`18`	`}`
`19`	`19`