PowerShell/test/powershell/engine/Module/TestModuleManifest.Tests.ps1

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

Import-Module HelpersCommon

Describe "Test-ModuleManifest tests" -tags "CI" {

    BeforeEach {
        $testModulePath = "testdrive:/module/test.psd1"
        New-Item -ItemType Directory -Path testdrive:/module > $null
    }

    AfterEach {
        Remove-Item -Recurse -Force -ErrorAction SilentlyContinue testdrive:/module
    }

    It "module manifest containing paths with backslashes or forwardslashes are resolved correctly" {

        New-Item -ItemType Directory -Path testdrive:/module/foo > $null
        New-Item -ItemType Directory -Path testdrive:/module/bar > $null

        New-Item -ItemType File -Path testdrive:/module/foo/bar.psm1 > $null
        New-Item -ItemType File -Path testdrive:/module/foo/bar.ps1 > $null
        New-Item -ItemType File -Path testdrive:/module/foo/bar.ps1xml > $null

        New-Item -ItemType File -Path testdrive:/module/bar/foo.psm1 > $null
        New-Item -ItemType File -Path testdrive:/module/bar/foo.ps1 > $null
        New-Item -ItemType File -Path testdrive:/module/bar/foo.ps1xml > $null

        $testModulePath = "testdrive:/module/test.psd1"
        $fileList = "foo\bar.psm1","bar/foo.psm1"
        $scripts = "foo\/bar.ps1","bar/\foo.ps1"
        $ps1xml = "foo//bar.ps1xml","bar\\foo.ps1xml"

        New-ModuleManifest -NestedModules $fileList -RootModule foo\bar.psm1 -RequiredAssemblies $fileList -Path $testModulePath -TypesToProcess $ps1xml -FormatsToProcess $ps1xml -ScriptsToProcess $scripts -FileList $fileList -ModuleList $fileList

        Test-Path $testModulePath | Should -BeTrue

        # use -ErrorAction Stop to cause test to fail if Test-ModuleManifest writes to error stream
        Test-ModuleManifest -Path $testModulePath -ErrorAction Stop | Should -BeOfType System.Management.Automation.PSModuleInfo
    }

    It "module manifest containing missing files returns error: <parameter>" -TestCases (
        @{parameter = "RequiredAssemblies"; errorId = "Modules_InvalidRequiredAssembliesInModuleManifest"},
        @{parameter = "NestedModules"; errorId = "Modules_InvalidNestedModuleinModuleManifest"},
        @{parameter = "RequiredModules"; errorId = "Modules_InvalidRequiredModulesinModuleManifest"},
        @{parameter = "FileList"; errorId = "Modules_InvalidFilePathinModuleManifest"},
        @{parameter = "ModuleList"; errorId = "Modules_InvalidModuleListinModuleManifest"},
        @{parameter = "TypesToProcess"; errorId = "Modules_InvalidManifest"},
        @{parameter = "FormatsToProcess"; errorId = "Modules_InvalidManifest"},
        @{parameter = "RootModule"; errorId = "Modules_InvalidRootModuleInModuleManifest"},
        @{parameter = "ScriptsToProcess"; errorId = "Modules_InvalidManifest"}
     ) {

        param ($parameter, $errorId)

        New-Item -ItemType Directory -Path testdrive:/module/foo > $null
        New-Item -ItemType File -Path testdrive:/module/foo/bar.psm1 > $null

        $args = @{$parameter = "doesnotexist.psm1"}
        New-ModuleManifest -Path $testModulePath @args
        $fullyQualifiedErrorId = "$errorId,Microsoft.PowerShell.Commands.TestModuleManifestCommand"

        { Test-ModuleManifest -Path $testModulePath -ErrorAction Stop } | Should -Throw -ErrorId $fullyQualifiedErrorId
    }

    It "module manifest containing valid unprocessed rootmodule file type succeeds: <rootModuleValue>" -TestCases (
        @{rootModuleValue = "foo.psm1"},
        @{rootModuleValue = "foo.dll"},
        @{rootModuleValue = "foo.exe"}
    ) {

        param($rootModuleValue)

        New-Item -ItemType File -Path testdrive:/module/$rootModuleValue > $null
        New-ModuleManifest -Path $testModulePath -RootModule $rootModuleValue
        $moduleManifest = Test-ModuleManifest -Path $testModulePath -ErrorAction Stop
        $moduleManifest | Should -BeOfType System.Management.Automation.PSModuleInfo
        $moduleManifest.RootModule | Should -Be $rootModuleValue
    }

    It "module manifest containing valid rootmodule without specifying .psm1 extension succeeds" {

        $rootModuleFileName = "bar.psm1";
        New-Item -ItemType File -Path testdrive:/module/$rootModuleFileName > $null
        New-ModuleManifest -Path $testModulePath -RootModule "bar"
        $moduleManifest = Test-ModuleManifest -Path $testModulePath -ErrorAction Stop
        $moduleManifest | Should -BeOfType System.Management.Automation.PSModuleInfo
        $moduleManifest.RootModule | Should -Be "bar"
    }

    It "module manifest containing valid processed empty rootmodule file type fails: <rootModuleValue>" -TestCases (
        @{rootModuleValue = "foo.cdxml"; errorId = "System.Xml.XmlException"}  # fails when cmdlet tries to read it as XML
    ) {

        param($rootModuleValue, $errorId)

        New-Item -ItemType File -Path testdrive:/module/$rootModuleValue > $null
        New-ModuleManifest -Path $testModulePath -RootModule $rootModuleValue
        $fullyQualifiedErrorId = "$errorId,Microsoft.PowerShell.Commands.TestModuleManifestCommand"
        { Test-ModuleManifest -Path $testModulePath -ErrorAction Stop } | Should -Throw -ErrorId $fullyQualifiedErrorId
    }

    It "module manifest containing empty rootmodule succeeds: <rootModuleValue>" -TestCases (
        @{rootModuleValue = $null},
        @{rootModuleValue = ""}
    ) {

        param($rootModuleValue)

        New-ModuleManifest -Path $testModulePath -RootModule $rootModuleValue
        $moduleManifest = Test-ModuleManifest -Path $testModulePath -ErrorAction Stop
        $moduleManifest | Should -BeOfType System.Management.Automation.PSModuleInfo
        $moduleManifest.RootModule | Should -BeNullOrEmpty
    }

    It "module manifest containing invalid rootmodule returns error: <rootModuleValue>" -TestCases (
        @{rootModuleValue = "foo.psd1"; errorId = "Modules_InvalidManifest"}
    ) {

        param($rootModuleValue, $errorId)

        New-Item -ItemType File -Path testdrive:/module/$rootModuleValue > $null

        New-ModuleManifest -Path $testModulePath -RootModule $rootModuleValue
        $fullyQualifiedErrorId = "$errorId,Microsoft.PowerShell.Commands.TestModuleManifestCommand"
        { Test-ModuleManifest -Path $testModulePath -ErrorAction Stop } | Should -Throw -ErrorId $fullyQualifiedErrorId
    }

    It "module manifest containing non-existing rootmodule returns error: <rootModuleValue>" -TestCases (
        @{rootModuleValue = "doesnotexist.psm1"; errorId = "Modules_InvalidRootModuleInModuleManifest"}
    ) {

        param($rootModuleValue, $errorId)

        New-ModuleManifest -Path $testModulePath -RootModule $rootModuleValue
        $fullyQualifiedErrorId = "$errorId,Microsoft.PowerShell.Commands.TestModuleManifestCommand"
        { Test-ModuleManifest -Path $testModulePath -ErrorAction Stop } | Should -Throw -ErrorId $fullyQualifiedErrorId
    }

    It "module manifest containing nested module gets returned: <variation>" -TestCases (
        @{variation = "no analysis as all exported with no wildcard"; exportValue = "@()"},
        @{variation = "analysis as exported with wildcard"; exportValue = "*"}
    ) {

        param($exportValue)

        New-Item -ItemType File -Path testdrive:/module/Foo.psm1 > $null
        New-ModuleManifest -Path $testModulePath -NestedModules "Foo.psm1" -FunctionsToExport $exportValue -CmdletsToExport $exportValue -VariablesToExport $exportValue -AliasesToExport $exportValue
        $module = Test-ModuleManifest -Path $testModulePath
        $module.NestedModules | Should -HaveCount 1
        $module.NestedModules.Name | Should -BeExactly "Foo"
    }

    It 'Works for manifest specified as UNC path' -Skip:(!$IsWindows) {
        # chance the testdrive path to a UNC path

        $testModulePath = '\\localhost\' + "$testDrive\test.psd1".Replace(':', '$')
        New-Item -ItemType File -Path testdrive:/foo.psm1 > $null
        New-ModuleManifest -Path $testModulePath -RootModule "foo.psm1"
        $module = Test-ModuleManifest -Path $testModulePath
        $module.RootModule | Should -Be "foo.psm1"
    }
}

Describe "Tests for circular references in required modules" -tags "CI" {

    function CreateTestModules([string]$RootPath, [string[]]$ModuleNames, [bool]$AddVersion, [bool]$AddGuid, [bool]$AddCircularReference)
    {
        $RequiredModulesSpecs = @();
        foreach($moduleDir in New-Item $ModuleNames -ItemType Directory -Force)
        {
            if ($lastItem)
            {
                if ($AddVersion -or $AddGuid) {$RequiredModulesSpecs += $lastItem}
                else {$RequiredModulesSpecs += $lastItem.ModuleName}
            }

            $ModuleVersion = '3.0'
            $GUID = New-Guid

            New-ModuleManifest ((Join-Path $moduleDir.Name $moduleDir.Name) + ".psd1") -RequiredModules $RequiredModulesSpecs -ModuleVersion $ModuleVersion -Guid $GUID

            $lastItem = @{ ModuleName = $moduleDir.Name}
            if ($AddVersion) {$lastItem += @{ ModuleVersion = $ModuleVersion}}
            if ($AddGuid) {$lastItem += @{ GUID = $GUID}}
        }

        if ($AddCircularReference)
        {
            # rewrite first module's manifest to have a reference to the last module, i.e. making a circular reference
            if ($AddVersion -or $AddGuid)
            {
                $firstModuleName = $RequiredModulesSpecs[0].ModuleName
                $firstModuleVersion = $RequiredModulesSpecs[0].ModuleVersion
                $firstModuleGuid = $RequiredModulesSpecs[0].GUID
                $RequiredModulesSpecs = $lastItem
            }
            else
            {
                $firstModuleName = $RequiredModulesSpecs[0]
                $firstModuleVersion = '3.0' # does not matter - not used in references
                $firstModuleGuid = New-Guid # does not matter - not used in references
                $RequiredModulesSpecs = $lastItem.ModuleName
            }

            New-ModuleManifest ((Join-Path $firstModuleName $firstModuleName) + ".psd1") -RequiredModules $RequiredModulesSpecs -ModuleVersion $firstModuleVersion -Guid $firstModuleGuid
        }
    }

    function TestImportModule([bool]$AddVersion, [bool]$AddGuid, [bool]$AddCircularReference)
    {
        $moduleRootPath = Join-Path $TestDrive 'TestModules'
        New-Item $moduleRootPath -ItemType Directory -Force > $null
        Push-Location $moduleRootPath

        $moduleCount = 6 # this depth was enough to find a bug in cyclic reference detection product code; greater depth will slow tests down
        $ModuleNames = 1..$moduleCount | ForEach-Object {"TestModule$_"}

        CreateTestModules $moduleRootPath $ModuleNames $AddVersion $AddGuid $AddCircularReference

        $newpath = [system.io.path]::PathSeparator + "$moduleRootPath"
        $OriginalPSModulePathLength = $env:PSModulePath.Length
        $env:PSModulePath += $newpath
        $lastModule = $ModuleNames[$moduleCount - 1]

        try
        {
            Import-Module $lastModule -ErrorAction Stop
            Get-Module $lastModule | Should -Not -BeNullOrEmpty
        }
        finally
        {
            #cleanup
            Remove-Module $ModuleNames -Force -ErrorAction SilentlyContinue
            $env:PSModulePath = $env:PSModulePath.Substring(0,$OriginalPSModulePathLength)
            Pop-Location
            Remove-Item $moduleRootPath -Recurse -Force -ErrorAction SilentlyContinue
        }
    }

    It "No circular references and RequiredModules field has only module names" {
        TestImportModule $false $false $false
    }

    It "No circular references and RequiredModules field has module names and versions" {
        TestImportModule $true $false $false
    }

    It "No circular references and RequiredModules field has module names, versions and GUIDs" {
        TestImportModule $true $true $false
    }

    It "Add a circular reference to RequiredModules and verify error" {
        { TestImportModule $false $false $true } | Should -Throw -ErrorId "Modules_InvalidManifest,Microsoft.PowerShell.Commands.ImportModuleCommand"
    }
}

Describe "Test-ModuleManifest Performance bug followup" -tags "CI" {
    BeforeAll {
        $TestModulesPath = [System.IO.Path]::Combine($PSScriptRoot, 'assets', 'testmodulerunspace')
        $PSHomeModulesPath = "$PSHOME\Modules"

        # Install the Test Module
        if (Test-CanWriteToPsHome) {
            Copy-Item $TestModulesPath\* $PSHomeModulesPath -Recurse -Force -ErrorAction Stop
        }
    }

    It "Test-ModuleManifest should not load unnessary modules" -Skip:(!(Test-CanWriteToPsHome)) {

        $job = Start-Job -Name "job1" -ScriptBlock {Test-ModuleManifest "$using:PSHomeModulesPath\ModuleWithDependencies2\2.0\ModuleWithDependencies2.psd1" -Verbose} | Wait-Job

        $verbose = $job.ChildJobs[0].Verbose.ReadAll()
        # Before the fix, all modules under $PSHOME will be imported and will be far more than 15 verbose messages. However, we cannot fix the number in case verbose message may vary.
        $verbose.Count | Should -BeLessThan 15
    }

    AfterAll {
        #clean up the test modules
        if (Test-CanWriteToPsHome) {
            Remove-Item $PSHomeModulesPath\ModuleWithDependencies2 -Recurse -Force -ErrorAction SilentlyContinue
            Remove-Item $PSHomeModulesPath\NestedRequiredModule1 -Recurse -Force -ErrorAction SilentlyContinue
        }
    }
}