diff --git a/src/code/PSResourceInfo.cs b/src/code/PSResourceInfo.cs index aecb7adec..9057fb554 100644 --- a/src/code/PSResourceInfo.cs +++ b/src/code/PSResourceInfo.cs @@ -1145,7 +1145,9 @@ public static bool TryConvertFromHashtableForPsd1( List requiredModulesHashList = new List(); if (pkgMetadata.ContainsKey("RequiredModules")) { - var requiredModules = pkgMetadata["RequiredModules"] as Object[]; + // A manifest can specify a single module name or hashtable instead of an array. + var requiredModules = LanguagePrimitives.ConvertTo(pkgMetadata["RequiredModules"]) + ?? Array.Empty(); foreach (Object obj in requiredModules) { if (obj != null) diff --git a/test/PSResourceInfo.Tests.ps1 b/test/PSResourceInfo.Tests.ps1 index 033bd82d8..4c3ae3b80 100644 --- a/test/PSResourceInfo.Tests.ps1 +++ b/test/PSResourceInfo.Tests.ps1 @@ -45,3 +45,109 @@ Describe "Write PSGetModuleInfo xml file" -tags 'CI' { CheckForExpectedPSGetInfo $newGetInfo } } + +Describe "Convert local module manifest dependencies" -tags 'CI' { + $testCases = @( + @{ + Shape = 'a single hashtable with ModuleVersion' + RequiredModules = @{ ModuleName = 'Test.Dependency'; ModuleVersion = '2.0.0' } + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('[2.0.0, )') + }, + @{ + Shape = 'a single hashtable with RequiredVersion' + RequiredModules = @{ ModuleName = 'Test.Dependency'; RequiredVersion = '2.0.0' } + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('[2.0.0, 2.0.0]') + }, + @{ + Shape = 'a single hashtable with MaximumVersion' + RequiredModules = @{ ModuleName = 'Test.Dependency'; MaximumVersion = '2.0.0' } + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('(, 2.0.0]') + }, + @{ + Shape = 'a single hashtable with a version range' + RequiredModules = @{ ModuleName = 'Test.Dependency'; ModuleVersion = '1.0.0'; MaximumVersion = '2.0.0' } + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('[1.0.0, 2.0.0]') + }, + @{ + Shape = 'a single module name' + RequiredModules = 'Test.Dependency' + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('(, )') + }, + @{ + Shape = 'an array containing a hashtable' + RequiredModules = @(@{ ModuleName = 'Test.Dependency'; ModuleVersion = '2.0.0' }) + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('[2.0.0, )') + }, + @{ + Shape = 'an array of module names' + RequiredModules = @('Test.Dependency', 'Test.OtherDependency') + ExpectedNames = @('Test.Dependency', 'Test.OtherDependency') + ExpectedRanges = @('(, )', '(, )') + }, + @{ + Shape = 'an array mixing module names and hashtables' + RequiredModules = @('Test.Dependency', @{ ModuleName = 'Test.OtherDependency'; ModuleVersion = '2.0.0' }) + ExpectedNames = @('Test.Dependency', 'Test.OtherDependency') + ExpectedRanges = @('(, )', '[2.0.0, )') + }, + @{ + Shape = 'an empty array' + RequiredModules = @() + ExpectedNames = @() + ExpectedRanges = @() + }, + @{ + Shape = 'null' + RequiredModules = $null + ExpectedNames = @() + ExpectedRanges = @() + }, + @{ + Shape = 'an array containing null' + RequiredModules = @($null, 'Test.Dependency') + ExpectedNames = @('Test.Dependency') + ExpectedRanges = @('(, )') + }, + @{ + Shape = 'an omitted RequiredModules entry' + OmitRequiredModules = $true + ExpectedNames = @() + ExpectedRanges = @() + } + ) + + It "converts RequiredModules specified as " -TestCases $testCases { + param($Shape, $RequiredModules, $ExpectedNames, $ExpectedRanges, $OmitRequiredModules) + + $repository = [Microsoft.PowerShell.PSResourceGet.UtilClasses.PSRepositoryInfo]::new( + 'TestRepository', [uri][string]$TestDrive, 50, $true, $null, 'None', 'Local', $true) + $metadata = @{ + Id = 'Test.Module' + ModuleVersion = '1.0.0' + Tags = [string[]]@() + } + if (-not $OmitRequiredModules) { + $metadata['RequiredModules'] = $RequiredModules + } + + $resource = $null + $errorMessage = $null + $success = [Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo]::TryConvertFromHashtableForPsd1( + $metadata, [ref]$resource, [ref]$errorMessage, $repository) + + $success | Should -BeTrue -Because "$Shape is a supported manifest form. $errorMessage" + $errorMessage | Should -BeNullOrEmpty + $resource.Name | Should -BeExactly 'Test.Module' + $resource.Dependencies | Should -HaveCount $ExpectedNames.Count + for ($i = 0; $i -lt $ExpectedNames.Count; $i++) { + $resource.Dependencies[$i].Name | Should -BeExactly $ExpectedNames[$i] + $resource.Dependencies[$i].VersionRange.ToString() | Should -BeExactly $ExpectedRanges[$i] + } + } +}