Merge pull request #1796 from PowerShell/bugfix-containerregistry-2digitinstall

anamnavi · web-flow · commit 6915968b4a34 · 2025-02-27T15:44:34.000-05:00
Bugfix for ContainerRegistry repository Install-PSResource with varying digit version
diff --git a/src/code/InstallHelper.cs b/src/code/InstallHelper.cs
@@ -824,6 +824,14 @@ private Hashtable BeginPackageInstall(
                     pkgVersion += $"-{pkgToInstall.Prerelease}";
                 }
             }
+
+            // For most repositories/providers the server will use the normalized version, which pkgVersion originally reflects
+            // However, for container registries the version must exactly match what was in the artifact manifest and then reflected in PSResourceInfo.Version.ToString()
+            if (currentServer.Repository.ApiVersion == PSRepositoryInfo.APIVersion.ContainerRegistry)
+            {
+                pkgVersion = String.IsNullOrEmpty(pkgToInstall.Prerelease) ? pkgToInstall.Version.ToString() : $"{pkgToInstall.Version.ToString()}-{pkgToInstall.Prerelease}";
+            }
+
             // Check to see if the pkg is already installed (ie the pkg is installed and the version satisfies the version range provided via param)
             if (!_reinstall)
             {
diff --git a/src/code/Utils.cs b/src/code/Utils.cs
@@ -316,9 +316,11 @@ public static string GetNormalizedVersionString(
             string versionString,
             string prerelease)
         {
-            // versionString may be like 1.2.0.0 or 1.2.0
+            // versionString may be like 1.2.0.0 or 1.2.0 or 1.2
             // prerelease    may be      null    or "alpha1"
             // possible passed in examples:
+            // versionString: "1.2"                           <- container registry 2 digit version
+            // versionString: "1.2"     prerelease: "alpha1"  <- container registry 2 digit version
             // versionString: "1.2.0"   prerelease: "alpha1"
             // versionString: "1.2.0"   prerelease: ""        <- doubtful though
             // versionString: "1.2.0.0" prerelease: "alpha1"
@@ -331,9 +333,10 @@ public static string GetNormalizedVersionString(
 
             int numVersionDigits = versionString.Split('.').Count();
 
-            if (numVersionDigits == 3)
+            if (numVersionDigits == 2 || numVersionDigits == 3)
             {
-                // versionString: "1.2.0" prerelease: "alpha1"
+                // versionString: "1.2.0" prerelease: "alpha1" -> 1.2.0-alpha1
+                // versionString: "1.2"   prerelease: "alpha1" -> 1.2-alpha1
                 return versionString + "-" + prerelease;
             }
             else if (numVersionDigits == 4)
diff --git a/test/FindPSResourceTests/FindPSResourceContainerRegistryServer.Tests.ps1 b/test/FindPSResourceTests/FindPSResourceContainerRegistryServer.Tests.ps1
@@ -8,6 +8,7 @@ Describe 'Test HTTP Find-PSResource for ACR Server Protocol' -tags 'CI' {
 
     BeforeAll{
         $testModuleName = "test-module"
+        $testModuleWith2DigitVersion = "test-2DigitPkg"
         $testModuleParentName = "test_parent_mod"
         $testModuleDependencyName = "test_dependency_mod"
         $testScriptName = "test-script"
@@ -82,6 +83,25 @@ Describe 'Test HTTP Find-PSResource for ACR Server Protocol' -tags 'CI' {
         $res.Count | Should -BeGreaterOrEqual 1
     }
 
+    It "Find resource when version contains different number of digits than the normalized version" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        $res1DigitVersion = Find-PSResource -Name $testModuleWith2DigitVersion -Version "1" -Repository $ACRRepoName
+        $res1DigitVersion | Should -Not -BeNullOrEmpty
+        $res1DigitVersion.Version | Should -Be "1.0"
+
+        $res2DigitVersion = Find-PSResource -Name $testModuleWith2DigitVersion -Version "1.0" -Repository $ACRRepoName
+        $res2DigitVersion | Should -Not -BeNullOrEmpty
+        $res2DigitVersion.Version | Should -Be "1.0"
+
+        $res3DigitVersion = Find-PSResource -Name $testModuleWith2DigitVersion -Version "1.0.0" -Repository $ACRRepoName
+        $res3DigitVersion | Should -Not -BeNullOrEmpty
+        $res3DigitVersion.Version | Should -Be "1.0"
+
+        $res4DigitVersion = Find-PSResource -Name $testModuleWith2DigitVersion -Version "1.0.0.0" -Repository $ACRRepoName
+        $res4DigitVersion | Should -Not -BeNullOrEmpty
+        $res4DigitVersion.Version | Should -Be "1.0"
+    }
+
     It "Find module and dependencies when -IncludeDependencies is specified" {
         $res = Find-PSResource -Name $testModuleParentName -Repository $ACRRepoName -IncludeDependencies
         $res | Should -Not -BeNullOrEmpty
diff --git a/test/InstallPSResourceTests/InstallPSResourceContainerRegistryServer.Tests.ps1 b/test/InstallPSResourceTests/InstallPSResourceContainerRegistryServer.Tests.ps1
@@ -10,6 +10,7 @@ Describe 'Test Install-PSResource for ACR scenarios' -tags 'CI' {
     BeforeAll {
         $testModuleName = "test-module"
         $testModuleName2 = "test-module2"
+        $testModuleWith2DigitVersion = "test-2DigitPkg"
         $testCamelCaseModuleName = "test-camelCaseModule"
         $testCamelCaseScriptName = "test-camelCaseScript"
         $testModuleParentName = "test_parent_mod"
@@ -33,7 +34,7 @@ Describe 'Test Install-PSResource for ACR scenarios' -tags 'CI' {
     }
 
     AfterEach {
-        Uninstall-PSResource $testModuleName, $testModuleName2, $testCamelCaseModuleName, $testScriptName, $testCamelCaseScriptName -Version "*" -SkipDependencyCheck -ErrorAction SilentlyContinue
+        Uninstall-PSResource $testModuleName, $testModuleName2, $testCamelCaseModuleName, $testScriptName, $testCamelCaseScriptName, $testModuleWith2DigitVersion -Version "*" -SkipDependencyCheck -ErrorAction SilentlyContinue
     }
 
     AfterAll {
@@ -75,6 +76,47 @@ Describe 'Test Install-PSResource for ACR scenarios' -tags 'CI' {
         $pkg.Version | Should -BeExactly "1.0.0"
     }
 
+    It "Install resource when version contains different number of digits than the normalized version- 1 digit specified" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        Install-PSResource -Name $testModuleWith2DigitVersion -Version "1" -Repository $ACRRepoName -TrustRepository
+        $res = Get-InstalledPSResource -Name $testModuleWith2DigitVersion
+        $res | Should -Not -BeNullOrEmpty
+        $res.Version | Should -Be "1.0"
+    }
+
+    It "Install resource when version contains different number of digits than the normalized version- 2 digits specified" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        Install-PSResource -Name $testModuleWith2DigitVersion -Version "1.0" -Repository $ACRRepoName -TrustRepository
+        $res = Get-InstalledPSResource -Name $testModuleWith2DigitVersion
+        $res | Should -Not -BeNullOrEmpty
+        $res.Version | Should -Be "1.0"
+    }
+
+    It "Install resource when version contains different number of digits than the normalized version- 3 digits specified" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        Install-PSResource -Name $testModuleWith2DigitVersion -Version "1.0.0" -Repository $ACRRepoName -TrustRepository
+        $res = Get-InstalledPSResource -Name $testModuleWith2DigitVersion
+        $res | Should -Not -BeNullOrEmpty
+        $res.Version | Should -Be "1.0"
+    }
+
+    It "Install resource when version contains different number of digits than the normalized version- 4 digits specified" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        Install-PSResource -Name $testModuleWith2DigitVersion -Version "1.0.0.0" -Repository $ACRRepoName -TrustRepository
+        $res = Get-InstalledPSResource -Name $testModuleWith2DigitVersion
+        $res | Should -Not -BeNullOrEmpty
+        $res.Version | Should -Be "1.0"
+    }
+
+    It "Install resource where version specified is a prerelease version" {
+        # the resource has version "1.0", but querying with any equivalent version should work
+        Install-PSResource -Name $testModuleWith2DigitVersion -Version "1.5-alpha" -Prerelease -Repository $ACRRepoName -TrustRepository
+        $res = Get-InstalledPSResource -Name $testModuleWith2DigitVersion
+        $res | Should -Not -BeNullOrEmpty
+        $res.Version | Should -Be "1.5"
+        $res.Prerelease | Should -Be "alpha"
+    }
+
     It "Install multiple resources by name" {
         $pkgNames = @($testModuleName, $testModuleName2)
         Install-PSResource -Name $pkgNames -Repository $ACRRepoName -TrustRepository

Original file line number	Diff line number	Diff line change
`@@ -824,6 +824,14 @@ private Hashtable BeginPackageInstall(`
`824`	`824`	`pkgVersion += $"-{pkgToInstall.Prerelease}";`
`825`	`825`	`}`
`826`	`826`	`}`
	`827`	`+`
	`828`	`+ // For most repositories/providers the server will use the normalized version, which pkgVersion originally reflects`
	`829`	`+ // However, for container registries the version must exactly match what was in the artifact manifest and then reflected in PSResourceInfo.Version.ToString()`
	`830`	`+ if (currentServer.Repository.ApiVersion == PSRepositoryInfo.APIVersion.ContainerRegistry)`
	`831`	`+ {`
	`832`	`+ pkgVersion = String.IsNullOrEmpty(pkgToInstall.Prerelease) ? pkgToInstall.Version.ToString() : $"{pkgToInstall.Version.ToString()}-{pkgToInstall.Prerelease}";`
	`833`	`+ }`
	`834`	`+`
`827`	`835`	`// Check to see if the pkg is already installed (ie the pkg is installed and the version satisfies the version range provided via param)`
`828`	`836`	`if (!_reinstall)`
`829`	`837`	`{`