Skip to content

Fix 1823 - MAR fails to parse RequiredVersion for dependencies #1876

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

Merged
merged 10 commits into from
Oct 2, 2025
Merged

Fix 1823 - MAR fails to parse RequiredVersion for dependencies #1876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b57349c
Apply VSCode quick fixes
o-l-a-v Sep 20, 2025
02868c0
More VSCode quick fixes
o-l-a-v Sep 21, 2025
def8809
Use explicit type
o-l-a-v Sep 21, 2025
ea945d2
Make sample JSON more readable
o-l-a-v Sep 21, 2025
e6ad7ff
Found the bug, a typo
o-l-a-v Sep 21, 2025
f115e07
Make code more readable IMO
o-l-a-v Sep 21, 2025
1b34f8f
Added test
o-l-a-v Sep 21, 2025
5ee941f
Add what I believe to be what the comment should say
o-l-a-v Sep 21, 2025
8059130
Check expected output instead of nott null or empty
o-l-a-v Sep 21, 2025
75c5c86
Fix test goof
o-l-a-v Oct 1, 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
66 changes: 34 additions & 32 deletions src/code/ContainerRegistryServerAPICalls.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,37 +698,38 @@ internal JObject FindAllRepositories(string containerRegistryAccessToken, out Er
internal Hashtable GetContainerRegistryMetadata(string packageName, string exactTagVersion, string containerRegistryAccessToken, out ErrorRecord errRecord)
{
_cmdletPassedIn.WriteDebug("In ContainerRegistryServerAPICalls::GetContainerRegistryMetadata()");
Hashtable requiredVersionResponse = new Hashtable();
Hashtable requiredVersionResponse = new();

var foundTags = FindContainerRegistryManifest(packageName, exactTagVersion, containerRegistryAccessToken, out errRecord);
JObject foundTags = FindContainerRegistryManifest(packageName, exactTagVersion, containerRegistryAccessToken, out errRecord);
if (errRecord != null)
{
return requiredVersionResponse;
}

/* Response returned looks something like:
* {
* "schemaVersion": 2,
* "config": {
* "mediaType": "application/vnd.unknown.config.v1+json",
* "digest": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
* "size": 0
* },
* "layers": [
* {
* "mediaType": "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip'",
* "digest": "sha256:7c55c7b66cb075628660d8249cc4866f16e34741c246a42ed97fb23ccd4ea956",
* "size": 3533,
* "annotations": {
* "org.opencontainers.image.title": "test_module.1.0.0.nupkg",
* "metadata": "{\"GUID\":\"45219bf4-10a4-4242-92d6-9bfcf79878fd\",\"FunctionsToExport\":[],\"CompanyName\":\"Anam\",\"CmdletsToExport\":[],\"VariablesToExport\":\"*\",\"Author\":\"Anam Navied\",\"ModuleVersion\":\"1.0.0\",\"Copyright\":\"(c) Anam Navied. All rights reserved.\",\"PrivateData\":{\"PSData\":{\"Tags\":[\"Test\",\"CommandsAndResource\",\"Tag2\"]}},\"RequiredModules\":[],\"Description\":\"This is a test module, for PSGallery team internal testing. Do not take a dependency on this package. This version contains tags for the package.\",\"AliasesToExport\":[]}"
* }
* }
* ]
* }
*/

var serverPkgInfo = GetMetadataProperty(foundTags, packageName, out errRecord);
/*
Response returned looks something like:
{
"schemaVersion": 2,
"config": {
"mediaType": "application/vnd.unknown.config.v1+json",
"digest": "sha256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
"size": 0
},
"layers": [
{
"mediaType": "application/vnd.oci.image.layer.nondistributable.v1.tar+gzip'",
"digest": "sha256:7c55c7b66cb075628660d8249cc4866f16e34741c246a42ed97fb23ccd4ea956",
"size": 3533,
"annotations": {
"org.opencontainers.image.title": "test_module.1.0.0.nupkg",
"metadata": "{\"GUID\":\"45219bf4-10a4-4242-92d6-9bfcf79878fd\",\"FunctionsToExport\":[],\"CompanyName\":\"Anam\",\"CmdletsToExport\":[],\"VariablesToExport\":\"*\",\"Author\":\"Anam Navied\",\"ModuleVersion\":\"1.0.0\",\"Copyright\":\"(c) Anam Navied. All rights reserved.\",\"PrivateData\":{\"PSData\":{\"Tags\":[\"Test\",\"CommandsAndResource\",\"Tag2\"]}},\"RequiredModules\":[],\"Description\":\"This is a test module, for PSGallery team internal testing. Do not take a dependency on this package. This version contains tags for the package.\",\"AliasesToExport\":[]}"
}
}
]
}
*/

ContainerRegistryInfo serverPkgInfo = GetMetadataProperty(foundTags, packageName, out errRecord);
if (errRecord != null)
{
return requiredVersionResponse;
Expand All @@ -738,8 +739,9 @@ internal Hashtable GetContainerRegistryMetadata(string packageName, string exact
{
using (JsonDocument metadataJSONDoc = JsonDocument.Parse(serverPkgInfo.Metadata))
{
string pkgVersionString = String.Empty;
string pkgVersionString = String.Empty;
JsonElement rootDom = metadataJSONDoc.RootElement;

if (rootDom.TryGetProperty("ModuleVersion", out JsonElement pkgVersionElement))
{
// module metadata will have "ModuleVersion" property
Expand Down Expand Up @@ -831,7 +833,7 @@ internal ContainerRegistryInfo GetMetadataProperty(JObject foundTags, string pac
errRecord = null;
ContainerRegistryInfo serverPkgInfo = null;

var layers = foundTags["layers"];
JToken layers = foundTags["layers"];
if (layers == null || layers[0] == null)
{
errRecord = new ErrorRecord(
Expand All @@ -843,7 +845,7 @@ internal ContainerRegistryInfo GetMetadataProperty(JObject foundTags, string pac
return serverPkgInfo;
}

var annotations = layers[0]["annotations"];
JToken annotations = layers[0]["annotations"];
if (annotations == null)
{
errRecord = new ErrorRecord(
Expand All @@ -856,7 +858,7 @@ internal ContainerRegistryInfo GetMetadataProperty(JObject foundTags, string pac
}

// Check for package name
var pkgTitleJToken = annotations["org.opencontainers.image.title"];
JToken pkgTitleJToken = annotations["org.opencontainers.image.title"];
if (pkgTitleJToken == null)
{
errRecord = new ErrorRecord(
Expand All @@ -881,7 +883,7 @@ internal ContainerRegistryInfo GetMetadataProperty(JObject foundTags, string pac
}

// Check for package metadata
var pkgMetadataJToken = annotations["metadata"];
JToken pkgMetadataJToken = annotations["metadata"];
if (pkgMetadataJToken == null)
{
errRecord = new ErrorRecord(
Expand All @@ -893,10 +895,10 @@ internal ContainerRegistryInfo GetMetadataProperty(JObject foundTags, string pac
return serverPkgInfo;
}

var metadata = pkgMetadataJToken.ToString();
string metadata = pkgMetadataJToken.ToString();

// Check for package artifact type
var resourceTypeJToken = annotations["resourceType"];
JToken resourceTypeJToken = annotations["resourceType"];
var resourceType = resourceTypeJToken != null ? resourceTypeJToken.ToString() : "None";

return new ContainerRegistryInfo(metadataPkgName, metadata, resourceType);
Expand Down
20 changes: 11 additions & 9 deletions src/code/PSResourceInfo.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1639,10 +1639,10 @@ internal static Dependency[] ParseHttpDependencies(string dependencyString)
internal static List<Dependency> ParseContainerRegistryDependencies(JsonElement requiredModulesElement, out string errorMsg)
{
errorMsg = string.Empty;
List<Dependency> pkgDeps = new List<Dependency>();
List<Dependency> pkgDeps = new();
if (requiredModulesElement.ValueKind == JsonValueKind.Array)
{
foreach (var dependency in requiredModulesElement.EnumerateArray())
foreach (JsonElement dependency in requiredModulesElement.EnumerateArray())
{
if (dependency.ValueKind == JsonValueKind.String)
{
Expand All @@ -1669,15 +1669,16 @@ internal static List<Dependency> ParseContainerRegistryDependencies(JsonElement
}

depVersionRange = new VersionRange(
minVersion: depNuGetVersion,
includeMinVersion: true);
minVersion: depNuGetVersion,
includeMinVersion: true
);
}
else if (dependency.TryGetProperty("RequiredVersion", out JsonElement depRequiredVersionElement))
{
// New-ScriptFileInfo will add "RequiredVersion" value as "null" if nothing is explicitly passed in,
// Which gets translated to an empty string.
// In this case, we just want the VersionRange to be VersionRange.All
if (!string.Equals(depModuleVersionElement.ToString(), string.Empty))
if (!string.Equals(depRequiredVersionElement.ToString(), string.Empty))
{
if (!NuGetVersion.TryParse(depRequiredVersionElement.ToString(), out NuGetVersion depNuGetVersion))
{
Expand All @@ -1686,10 +1687,11 @@ internal static List<Dependency> ParseContainerRegistryDependencies(JsonElement
}

depVersionRange = new VersionRange(
minVersion: depNuGetVersion,
includeMinVersion: true,
maxVersion: depNuGetVersion,
includeMaxVersion: true);
minVersion: depNuGetVersion,
includeMinVersion: true,
maxVersion: depNuGetVersion,
includeMaxVersion: true
);
}
}

Expand Down
45 changes: 27 additions & 18 deletions test/FindPSResourceTests/FindPSResourceContainerRegistryServer.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Import-Module $modPath -Force -Verbose

Describe 'Test HTTP Find-PSResource for ACR Server Protocol' -tags 'CI' {

BeforeAll{
BeforeAll {
$testModuleName = "test-module"
$testModuleWith2DigitVersion = "test-2DigitPkg"
$testModuleParentName = "test_parent_mod"
Expand All @@ -19,13 +19,11 @@ Describe 'Test HTTP Find-PSResource for ACR Server Protocol' -tags 'CI' {

$usingAzAuth = $env:USINGAZAUTH -eq 'true'

if ($usingAzAuth)
{
if ($usingAzAuth) {
Write-Verbose -Verbose "Using Az module for authentication"
Register-PSResourceRepository -Name $ACRRepoName -ApiVersion 'ContainerRegistry' -Uri $ACRRepoUri -Verbose
}
else
{
else {
$psCredInfo = New-Object Microsoft.PowerShell.PSResourceGet.UtilClasses.PSCredentialInfo ("SecretStore", "$env:TENANTID")
Register-PSResourceRepository -Name $ACRRepoName -ApiVersion 'ContainerRegistry' -Uri $ACRRepoUri -CredentialInfo $psCredInfo -Verbose
}
Expand All @@ -51,18 +49,18 @@ Describe 'Test HTTP Find-PSResource for ACR Server Protocol' -tags 'CI' {
$res | Should -BeNullOrEmpty
}

$testCases2 = @{Version="[5.0.0.0]"; ExpectedVersions=@("5.0.0"); Reason="validate version, exact match"},
@{Version="5.0.0.0"; ExpectedVersions=@("5.0.0"); Reason="validate version, exact match without bracket syntax"},
@{Version="[1.0.0.0, 5.0.0.0]"; ExpectedVersions=@("1.0.0", "3.0.0", "5.0.0"); Reason="validate version, exact range inclusive"},
@{Version="(1.0.0.0, 5.0.0.0)"; ExpectedVersions=@("3.0.0"); Reason="validate version, exact range exclusive"},
@{Version="(1.0.0.0,)"; ExpectedVersions=@("3.0.0", "5.0.0"); Reason="validate version, minimum version exclusive"},
@{Version="[1.0.0.0,)"; ExpectedVersions=@("1.0.0", "3.0.0", "5.0.0"); Reason="validate version, minimum version inclusive"},
@{Version="(,3.0.0.0)"; ExpectedVersions=@("1.0.0"); Reason="validate version, maximum version exclusive"},
@{Version="(,3.0.0.0]"; ExpectedVersions=@("1.0.0", "3.0.0"); Reason="validate version, maximum version inclusive"},
@{Version="[1.0.0.0, 5.0.0.0)"; ExpectedVersions=@("1.0.0", "3.0.0"); Reason="validate version, mixed inclusive minimum and exclusive maximum version"}
@{Version="(1.0.0.0, 5.0.0.0]"; ExpectedVersions=@("3.0.0", "5.0.0"); Reason="validate version, mixed exclusive minimum and inclusive maximum version"}
$testCases2 = @{Version = "[5.0.0.0]"; ExpectedVersions = @("5.0.0"); Reason = "validate version, exact match" },
@{Version = "5.0.0.0"; ExpectedVersions = @("5.0.0"); Reason = "validate version, exact match without bracket syntax" },
@{Version = "[1.0.0.0, 5.0.0.0]"; ExpectedVersions = @("1.0.0", "3.0.0", "5.0.0"); Reason = "validate version, exact range inclusive" },
@{Version = "(1.0.0.0, 5.0.0.0)"; ExpectedVersions = @("3.0.0"); Reason = "validate version, exact range exclusive" },
@{Version = "(1.0.0.0,)"; ExpectedVersions = @("3.0.0", "5.0.0"); Reason = "validate version, minimum version exclusive" },
@{Version = "[1.0.0.0,)"; ExpectedVersions = @("1.0.0", "3.0.0", "5.0.0"); Reason = "validate version, minimum version inclusive" },
@{Version = "(,3.0.0.0)"; ExpectedVersions = @("1.0.0"); Reason = "validate version, maximum version exclusive" },
@{Version = "(,3.0.0.0]"; ExpectedVersions = @("1.0.0", "3.0.0"); Reason = "validate version, maximum version inclusive" },
@{Version = "[1.0.0.0, 5.0.0.0)"; ExpectedVersions = @("1.0.0", "3.0.0"); Reason = "validate version, mixed inclusive minimum and exclusive maximum version" }
@{Version = "(1.0.0.0, 5.0.0.0]"; ExpectedVersions = @("3.0.0", "5.0.0"); Reason = "validate version, mixed exclusive minimum and inclusive maximum version" }

It "Find resource when given Name to <Reason> <Version>" -TestCases $testCases2{
It "Find resource when given Name to <Reason> <Version>" -TestCases $testCases2 {
# FindVersionGlobbing()
param($Version, $ExpectedVersions)
$res = Find-PSResource -Name $testModuleName -Version $Version -Repository $ACRRepoName
Expand Down Expand Up @@ -311,12 +309,23 @@ Describe 'Test Find-PSResource for MAR Repository' -tags 'CI' {
$res | Should -Not -BeNullOrEmpty
$res.Count | Should -BeGreaterThan 1
}

It "Should find version range for Az dependencies" {
# Target known version to know the output from the API won't change
$res = Find-PSResource -Repository 'MAR' -Name 'Az' -Version '14.4.0'

# Version defined by "ModuleVersion"
$res.Dependencies.Where{$_.'Name' -eq 'Az.Accounts'}.'VersionRange'.ToString() | Should -Be '[5.3.0, )'

# Version defined by "RequiredVersion"
$res.Dependencies.Where{$_.'Name' -eq 'Az.Resources'}.'VersionRange'.ToString() | Should -Be '[8.1.0, 8.1.0]'
}
}

# Skip this test fo
# Skip this test for Windows PowerShell
Describe 'Test Find-PSResource for unauthenticated ACR repository' -tags 'CI' {
BeforeAll {
$skipOnWinPS = $PSVersionTable.PSVersion.Major -eq 5
$skipOnWinPS = $PSVersionTable.PSVersion.Major -eq 5

if (-not $skipOnWinPS) {
Register-PSResourceRepository -Name "Unauthenticated" -Uri "https://psresourcegetnoauth.azurecr.io/" -ApiVersion "ContainerRegistry"
Expand Down
Loading