mirror of
https://github.com/PowerShell/PowerShell
synced 2026-06-08 12:12:50 +00:00
Enforce the 'CompatiblePSEditions' check for modules from the legacy 'System32' module path (#7183)
- Add `%WINDIR%\System32\WindowsPowerShell\v1.0\Modules` (Windows PowerShell $PSHOME) to the end of the default PSCore 6 module path (i.e. the module path as initially set at startup). - Cause an error to be thrown by `Import-Module` when a module with `CompatiblePSEditions` not containing `"Core"` is being loaded from the 'System32' module path. - Suppress output of modules listed by `Get-Module -ListAvailable` from Windows PowerShell $PSHOME when `CompatiblePSEditions` does not contain `"Core"`. - Introduce the `-SkipCompatibilityCheck` switch parameter on both `Import-Module` and `Get-Module` to respectively allow importing incompatible modules and listing incompatible modules. - Adds a `PSEdition` column to the `PSModuleInfo` table view format. - Ensures that completions are not given for incompatible modules on the System32 module path.
This commit is contained in:
Robert Holt
+862
@@ -0,0 +1,862 @@
|
||||
# Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
# Licensed under the MIT License.
|
||||
|
||||
$script:oldModulePath = $env:PSModulePath
|
||||
|
||||
function Add-ModulePath
|
||||
{
|
||||
param([string]$Path, [switch]$Prepend)
|
||||
|
||||
$script:oldModulePath = $env:PSModulePath
|
||||
|
||||
if ($Prepend)
|
||||
{
|
||||
$env:PSModulePAth = $Path + [System.IO.Path]::PathSeparator + $env:PSModulePath
|
||||
}
|
||||
else
|
||||
{
|
||||
$env:PSModulePath = $env:PSModulePath + [System.IO.Path]::PathSeparator + $Path
|
||||
}
|
||||
}
|
||||
|
||||
function Restore-ModulePath
|
||||
{
|
||||
$env:PSModulePath = $script:oldModulePath
|
||||
}
|
||||
|
||||
# Creates a new dummy module compatible with the given PSEditions
|
||||
function New-EditionCompatibleModule
|
||||
{
|
||||
param(
|
||||
[Parameter(Mandatory = $true)][string]$ModuleName,
|
||||
[string]$DirPath,
|
||||
[string[]]$CompatiblePSEditions)
|
||||
|
||||
$modulePath = Join-Path $DirPath $ModuleName
|
||||
|
||||
$manifestPath = Join-Path $modulePath "$ModuleName.psd1"
|
||||
|
||||
$psm1Name = "$ModuleName.psm1"
|
||||
$psm1Path = Join-Path $modulePath $psm1Name
|
||||
|
||||
New-Item -Path $modulePath -ItemType Directory
|
||||
|
||||
New-Item -Path $psm1Path -Value "function Test-$ModuleName { `$true }"
|
||||
|
||||
if ($CompatiblePSEditions)
|
||||
{
|
||||
New-ModuleManifest -Path $manifestPath -CompatiblePSEditions $CompatiblePSEditions -RootModule $psm1Name
|
||||
}
|
||||
else
|
||||
{
|
||||
New-ModuleManifest -Path $manifestPath -RootModule $psm1Name
|
||||
}
|
||||
|
||||
return $modulePath
|
||||
}
|
||||
|
||||
function New-TestModules
|
||||
{
|
||||
param([hashtable[]]$TestCases, [string]$BaseDir)
|
||||
|
||||
for ($i = 0; $i -lt $TestCases.Count; $i++)
|
||||
{
|
||||
$path = New-EditionCompatibleModule -ModuleName $TestCases[$i].ModuleName -CompatiblePSEditions $TestCases[$i].Editions -Dir $BaseDir
|
||||
|
||||
$TestCases[$i].Path = $path
|
||||
$TestCases[$i].Name = $TestCases[$i].Editions -join ","
|
||||
}
|
||||
}
|
||||
|
||||
function New-TestNestedModule
|
||||
{
|
||||
param(
|
||||
[string]$ModuleBase,
|
||||
[string]$ScriptModuleFilename,
|
||||
[string]$ScriptModuleContent,
|
||||
[string]$BinaryModuleFilename,
|
||||
[string]$BinaryModuleDllPath,
|
||||
[string]$RootModuleFilename,
|
||||
[string]$RootModuleContent,
|
||||
[string[]]$CompatiblePSEditions,
|
||||
[bool]$UseRootModule,
|
||||
[bool]$UseAbsolutePath
|
||||
)
|
||||
|
||||
$nestedModules = [System.Collections.ArrayList]::new()
|
||||
|
||||
# Create script module
|
||||
New-Item -Path (Join-Path $ModuleBase $ScriptModuleFileName) -Value $ScriptModuleContent
|
||||
$nestedModules.Add($ScriptModuleFilename)
|
||||
|
||||
if ($BinaryModuleFilename -and $BinaryModuleDllPath)
|
||||
{
|
||||
# Create binary module
|
||||
Copy-Item -Path $BinaryModuleDllPath -Destination (Join-Path $ModuleBase $BinaryModuleFilename)
|
||||
$nestedModules.Add($BinaryModuleFilename)
|
||||
}
|
||||
|
||||
# Create the root module if there is one
|
||||
if ($UseRootModule)
|
||||
{
|
||||
New-Item -Path (Join-Path $ModuleBase $RootModuleFilename) -Value $RootModuleContent
|
||||
}
|
||||
|
||||
# Create the manifest command
|
||||
$moduleName = Split-Path -Leaf $ModuleBase
|
||||
$manifestPath = Join-Path $ModuleBase "$moduleName.psd1"
|
||||
|
||||
$nestedModules = $nestedModules -join ','
|
||||
|
||||
$newManifestCmd = "New-ModuleManifest -Path $manifestPath -NestedModules $nestedModules "
|
||||
if ($CompatiblePSEditions)
|
||||
{
|
||||
$compatibleModules = $CompatiblePSEditions -join ','
|
||||
$newManifestCmd += "-CompatiblePSEditions $compatibleModules "
|
||||
}
|
||||
if ($UseRootModule)
|
||||
{
|
||||
$newManifestCmd += "-RootModule $RootModuleFilename "
|
||||
$newManifestCmd += "-FunctionsToExport @('Test-RootModule') "
|
||||
}
|
||||
else
|
||||
{
|
||||
$newManifestCmd += "-FunctionsToExport @('Test-ScriptModule') "
|
||||
}
|
||||
|
||||
$newManifestCmd += "-CmdletsToExport @() -VariablesToExport @() -AliasesToExport @() "
|
||||
|
||||
# Create the manifest
|
||||
[scriptblock]::Create($newManifestCmd).Invoke()
|
||||
}
|
||||
|
||||
|
||||
Describe "Get-Module with CompatiblePSEditions-checked paths" -Tag "CI" {
|
||||
|
||||
BeforeAll {
|
||||
if (-not $IsWindows)
|
||||
{
|
||||
return
|
||||
}
|
||||
|
||||
$successCases = @(
|
||||
@{ Editions = "Core","Desktop"; ModuleName = "BothModule" },
|
||||
@{ Editions = "Core"; ModuleName = "CoreModule" }
|
||||
)
|
||||
|
||||
$failCases = @(
|
||||
@{ Editions = "Desktop"; ModuleName = "DesktopModule" },
|
||||
@{ Editions = $null; ModuleName = "NeitherModule" }
|
||||
)
|
||||
|
||||
$basePath = Join-Path $TestDrive "EditionCompatibleModules"
|
||||
New-TestModules -TestCases $successCases -BaseDir $basePath
|
||||
New-TestModules -TestCases $failCases -BaseDir $basePath
|
||||
|
||||
# Emulate the System32 module path for tests
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $basePath)
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $null)
|
||||
}
|
||||
|
||||
Context "Loading from checked paths on the module path with no flags" {
|
||||
BeforeAll {
|
||||
Add-ModulePath $basePath
|
||||
$modules = Get-Module -ListAvailable
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Lists compatible modules from the module path with -ListAvailable for PSEdition <Editions>" -TestCases $successCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules.Name | Should -Contain $ModuleName
|
||||
}
|
||||
|
||||
It "Does not list incompatible modules with -ListAvailable for PSEdition <Editions>" -TestCases $failCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules.Name | Should -Not -Contain $ModuleName
|
||||
}
|
||||
}
|
||||
|
||||
Context "Loading from checked paths by absolute path with no flags" {
|
||||
It "Lists compatible modules with -ListAvailable for PSEdition <Editions>" -TestCases $successCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules = Get-Module -ListAvailable (Join-Path -Path $basePath -ChildPath $ModuleName)
|
||||
|
||||
$modules.Name | Should -Contain $ModuleName
|
||||
}
|
||||
|
||||
It "Does not list incompatible modules with -ListAvailable for PSEdition <Editions>" -TestCases $failCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules = Get-Module -ListAvailable (Join-Path -Path $basePath -ChildPath $ModuleName)
|
||||
|
||||
$modules.Name | Should -Not -Contain $ModuleName
|
||||
}
|
||||
}
|
||||
|
||||
Context "Loading from checked paths on the module path with -SkipEditionCheck" {
|
||||
BeforeAll {
|
||||
Add-ModulePath $basePath
|
||||
$modules = Get-Module -ListAvailable -SkipEditionCheck
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Lists all modules from the module path with -ListAvailable for PSEdition <Editions>" -TestCases ($successCases + $failCases) -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules.Name | Should -Contain $ModuleName
|
||||
}
|
||||
}
|
||||
|
||||
Context "Loading from checked paths by absolute path with -SkipEditionCheck" {
|
||||
It "Lists compatible modules with -ListAvailable for PSEdition <Editions>" -TestCases ($successCases + $failCases) -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName)
|
||||
|
||||
$modules = Get-Module -ListAvailable -SkipEditionCheck (Join-Path -Path $basePath -ChildPath $ModuleName)
|
||||
|
||||
$modules.Name | Should -Contain $ModuleName
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Describe "Import-Module from CompatiblePSEditions-checked paths" -Tag "CI" {
|
||||
BeforeAll {
|
||||
$successCases = @(
|
||||
@{ Editions = "Core","Desktop"; ModuleName = "BothModule"; Result = $true },
|
||||
@{ Editions = "Core"; ModuleName = "CoreModule"; Result = $true }
|
||||
)
|
||||
|
||||
$failCases = @(
|
||||
@{ Editions = "Desktop"; ModuleName = "DesktopModule"; Result = $true },
|
||||
@{ Editions = $null; ModuleName = "NeitherModule"; Result = $true }
|
||||
)
|
||||
|
||||
$basePath = Join-Path $TestDrive "EditionCompatibleModules"
|
||||
New-TestModules -TestCases $successCases -BaseDir $basePath
|
||||
New-TestModules -TestCases $failCases -BaseDir $basePath
|
||||
|
||||
$allModules = ($successCases + $failCases).ModuleName
|
||||
|
||||
# Emulate the System32 module path for tests
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $basePath)
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $null)
|
||||
}
|
||||
|
||||
AfterEach {
|
||||
Get-Module $allModules | Remove-Module -Force
|
||||
}
|
||||
|
||||
Context "Imports from module path" {
|
||||
BeforeAll {
|
||||
Add-ModulePath $basePath
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Successfully imports compatible modules from the module path with PSEdition <Editions>" -TestCases $successCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
Import-Module $ModuleName -Force
|
||||
& "Test-$ModuleName" | Should -Be $Result
|
||||
}
|
||||
|
||||
It "Fails to import incompatible modules from the module path with PSEdition <Editions>" -TestCases $failCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
{
|
||||
Import-Module $ModuleName -Force -ErrorAction 'Stop'; & "Test-$ModuleName"
|
||||
} | Should -Throw -ErrorId "Modules_PSEditionNotSupported,Microsoft.PowerShell.Commands.ImportModuleCommand"
|
||||
}
|
||||
|
||||
It "Imports an incompatible module from the module path with -SkipEditionCheck with PSEdition <Editions>" -TestCases ($successCases + $failCases) -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
Import-Module $ModuleName -SkipEditionCheck -Force
|
||||
& "Test-$ModuleName" | Should -Be $Result
|
||||
}
|
||||
}
|
||||
|
||||
Context "Imports from absolute path" {
|
||||
It "Successfully imports compatible modules from an absolute path with PSEdition <Editions>" -TestCases $successCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
$path = Join-Path -Path $basePath -ChildPath $ModuleName
|
||||
|
||||
Import-Module $path -Force
|
||||
& "Test-$ModuleName" | Should -Be $Result
|
||||
}
|
||||
|
||||
It "Fails to import incompatible modules from an absolute path with PSEdition <Editions>" -TestCases $failCases -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
$path = Join-Path -Path $basePath -ChildPath $ModuleName
|
||||
|
||||
{
|
||||
Import-Module $path -Force -ErrorAction 'Stop'; & "Test-$ModuleName"
|
||||
} | Should -Throw -ErrorId "Modules_PSEditionNotSupported,Microsoft.PowerShell.Commands.ImportModuleCommand"
|
||||
}
|
||||
|
||||
It "Imports an incompatible module from an absolute path with -SkipEditionCheck with PSEdition <Editions>" -TestCases ($successCases + $failCases) -Skip:(-not $IsWindows) {
|
||||
param($Editions, $ModuleName, $Result)
|
||||
|
||||
$path = Join-Path -Path $basePath -ChildPath $ModuleName
|
||||
|
||||
Import-Module $path -SkipEditionCheck -Force
|
||||
& "Test-$ModuleName" | Should -Be $Result
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Describe "PSModulePath changes interacting with other PowerShell processes" -Tag "Feature" {
|
||||
BeforeAll {
|
||||
if (-not $IsWindows)
|
||||
{
|
||||
return
|
||||
}
|
||||
Add-ModulePath (Join-Path $env:windir "System32\WindowsPowerShell\v1.0\Modules") -Prepend
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
if (-not $IsWindows)
|
||||
{
|
||||
return
|
||||
}
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Allows Windows PowerShell subprocesses to call `$PSHome modules still" -Skip:(-not $IsWindows) {
|
||||
$errors = powershell.exe -Command "Get-ChildItem" 2>&1 | Where-Object { $_ -is [System.Management.Automation.ErrorRecord] }
|
||||
$errors | Should -Be $null
|
||||
}
|
||||
|
||||
It "Allows PowerShell Core 6 subprocesses to call core modules" -Skip:(-not $IsWindows) {
|
||||
$errors = pwsh.exe -Command "Get-ChildItem" 2>&1 | Where-Object { $_ -is [System.Management.Automation.ErrorRecord] }
|
||||
$errors | Should -Be $null
|
||||
}
|
||||
}
|
||||
|
||||
Describe "Get-Module nested module behaviour with Edition checking" -Tag "Feature" {
|
||||
BeforeAll {
|
||||
$testConditions = @{
|
||||
SkipEditionCheck = @($true, $false)
|
||||
UseRootModule = @($true, $false)
|
||||
UseAbsolutePath = @($true, $false)
|
||||
MarkedEdition = @($null, "Desktop", "Core", @("Desktop","Core"))
|
||||
}
|
||||
|
||||
# Combine all the test conditions into a list of test cases
|
||||
$testCases = @(@{})
|
||||
foreach ($condition in $testConditions.Keys)
|
||||
{
|
||||
$list = [System.Collections.Generic.List[hashtable]]::new()
|
||||
foreach ($obj in $testCases)
|
||||
{
|
||||
foreach ($value in $testConditions[$condition])
|
||||
{
|
||||
$list.Add($obj + @{ $condition = $value })
|
||||
}
|
||||
}
|
||||
$testCases = $list
|
||||
}
|
||||
|
||||
# Define nested script module
|
||||
$scriptModuleName = "NestedScriptModule"
|
||||
$scriptModuleFile = "$scriptModuleName.psm1"
|
||||
$scriptModuleContent = 'function Test-ScriptModule { return $true }'
|
||||
|
||||
# Define nested binary module
|
||||
$binaryModuleName = "NestedBinaryModule"
|
||||
$binaryModuleFile = "$binaryModuleName.dll"
|
||||
$binaryModuleContent = 'public static class TestBinaryModuleClass { public static bool Test() { return true; } }'
|
||||
$binaryModuleSourcePath = Join-Path $TestDrive $binaryModuleFile
|
||||
Add-Type -OutputAssembly $binaryModuleSourcePath -TypeDefinition $binaryModuleContent
|
||||
|
||||
# Define root module definition
|
||||
$rootModuleName = "RootModule"
|
||||
$rootModuleFile = "$rootModuleName.psm1"
|
||||
$rootModuleContent = 'function Test-RootModule { Test-ScriptModule }'
|
||||
|
||||
# Module directory structure: $TestDrive/$compatibility/$guid/$moduleName/{module parts}
|
||||
$compatibleDir = "Compatible"
|
||||
$incompatibleDir = "Incompatible"
|
||||
$compatiblePath = Join-Path $TestDrive $compatibleDir
|
||||
$incompatiblePath = Join-Path $TestDrive $incompatibleDir
|
||||
|
||||
foreach ($basePath in $compatiblePath,$incompatiblePath)
|
||||
{
|
||||
New-Item -Path $basePath -ItemType Directory
|
||||
}
|
||||
}
|
||||
|
||||
Context "Modules ON the System32 test path" {
|
||||
BeforeAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $incompatiblePath)
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $null)
|
||||
}
|
||||
|
||||
BeforeEach {
|
||||
# Create the module directory
|
||||
$guid = New-Guid
|
||||
$compatibilityDir = $incompatibleDir
|
||||
$containingDir = Join-Path $TestDrive $compatibilityDir $guid
|
||||
$moduleName = "CpseTestModule"
|
||||
$moduleBase = Join-Path $containingDir $moduleName
|
||||
New-Item -Path $moduleBase -ItemType Directory
|
||||
Add-ModulePath $containingDir
|
||||
}
|
||||
|
||||
AfterEach {
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Get-Module -ListAvailable gets all compatible modules when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases -Skip:(-not $IsWindows) {
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-BinaryModuleFilename $binaryModuleFile `
|
||||
-BinaryModuleDllPath $binaryModuleSourcePath `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
if ($UseAbsolutePath)
|
||||
{
|
||||
if ((-not $SkipEditionCheck) -and (-not ($MarkedEdition -contains "Core")))
|
||||
{
|
||||
Get-Module -ListAvailable $moduleBase -ErrorAction Stop | Should -Be $null
|
||||
return
|
||||
}
|
||||
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable $moduleBase -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable $moduleBase
|
||||
}
|
||||
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -Be $moduleName
|
||||
return
|
||||
}
|
||||
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable
|
||||
}
|
||||
|
||||
$modules = $modules | Where-Object { $_.Path.Contains($guid) }
|
||||
|
||||
if ((-not $SkipEditionCheck) -and (-not ($MarkedEdition -contains "Core")))
|
||||
{
|
||||
$modules.Count | Should -Be 0
|
||||
return
|
||||
}
|
||||
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -Be $moduleName
|
||||
}
|
||||
|
||||
It "Get-Module -ListAvailable -All gets all compatible modules when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases -Skip:(-not $IsWindows){
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-BinaryModuleFilename $binaryModuleFile `
|
||||
-BinaryModuleDllPath $binaryModuleSourcePath `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
# Modules specified with an absolute path should only return themselves
|
||||
if ($UseAbsolutePath) {
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable -All -SkipEditionCheck $moduleBase
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable -All $moduleBase
|
||||
}
|
||||
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -BeExactly $moduleName
|
||||
return
|
||||
}
|
||||
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable -All -SkipEditionCheck | Where-Object { $_.Path.Contains($guid) }
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable -All | Where-Object { $_.Path.Contains($guid) }
|
||||
}
|
||||
|
||||
if ($UseRootModule)
|
||||
{
|
||||
$modules.Count | Should -Be 4
|
||||
}
|
||||
else
|
||||
{
|
||||
$modules.Count | Should -Be 3
|
||||
}
|
||||
|
||||
$names = $modules.Name
|
||||
$names | Should -Contain $moduleName
|
||||
$names | Should -Contain $scriptModuleName
|
||||
$names | Should -Contain $binaryModuleName
|
||||
}
|
||||
}
|
||||
|
||||
Context "Modules OFF the System32 module path" {
|
||||
BeforeEach {
|
||||
# Create the module directory
|
||||
$guid = New-Guid
|
||||
$compatibilityDir = $compatibleDir
|
||||
$containingDir = Join-Path $TestDrive $compatibilityDir $guid
|
||||
$moduleName = "CpseTestModule"
|
||||
$moduleBase = Join-Path $containingDir $moduleName
|
||||
New-Item -Path $moduleBase -ItemType Directory
|
||||
Add-ModulePath $containingDir
|
||||
}
|
||||
|
||||
AfterEach {
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Get-Module -ListAvailable gets all compatible modules when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases {
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-BinaryModuleFilename $binaryModuleFile `
|
||||
-BinaryModuleDllPath $binaryModuleSourcePath `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
if ($UseAbsolutePath)
|
||||
{
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable $moduleBase -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable $moduleBase
|
||||
}
|
||||
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -Be $moduleName
|
||||
return
|
||||
}
|
||||
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable
|
||||
}
|
||||
|
||||
$modules = $modules | Where-Object { $_.Path.Contains($guid) }
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -Be $moduleName
|
||||
}
|
||||
|
||||
It "Get-Module -ListAvailable -All gets all compatible modules when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases {
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-BinaryModuleFilename $binaryModuleFile `
|
||||
-BinaryModuleDllPath $binaryModuleSourcePath `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
# Modules specified with an absolute path should only return themselves
|
||||
if ($UseAbsolutePath)
|
||||
{
|
||||
$modules = Get-Module -ListAvailable -All $moduleBase
|
||||
|
||||
$modules.Count | Should -Be 1
|
||||
$modules[0].Name | Should -BeExactly $moduleName
|
||||
return
|
||||
}
|
||||
|
||||
$modules = if ($SkipEditionCheck)
|
||||
{
|
||||
Get-Module -ListAvailable -All -SkipEditionCheck | Where-Object { $_.Path.Contains($guid) }
|
||||
}
|
||||
else
|
||||
{
|
||||
Get-Module -ListAvailable -All | Where-Object { $_.Path.Contains($guid) }
|
||||
}
|
||||
|
||||
if ($UseRootModule)
|
||||
{
|
||||
$modules.Count | Should -Be 4
|
||||
}
|
||||
else
|
||||
{
|
||||
$modules.Count | Should -Be 3
|
||||
}
|
||||
|
||||
$names = $modules.Name
|
||||
$names | Should -Contain $moduleName
|
||||
$names | Should -Contain $scriptModuleName
|
||||
$names | Should -Contain $binaryModuleName
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Describe "Import-Module nested module behaviour with Edition checking" -Tag "Feature" {
|
||||
BeforeAll {
|
||||
$testConditions = @{
|
||||
SkipEditionCheck = @($true, $false)
|
||||
UseRootModule = @($true, $false)
|
||||
UseAbsolutePath = @($true, $false)
|
||||
MarkedEdition = @($null, "Desktop", "Core", @("Desktop","Core"))
|
||||
}
|
||||
|
||||
# Combine all the test conditions into a list of test cases
|
||||
$testCases = @(@{})
|
||||
foreach ($condition in $testConditions.Keys)
|
||||
{
|
||||
$list = [System.Collections.Generic.List[hashtable]]::new()
|
||||
foreach ($obj in $testCases)
|
||||
{
|
||||
foreach ($value in $testConditions[$condition])
|
||||
{
|
||||
$list.Add($obj + @{ $condition = $value })
|
||||
}
|
||||
}
|
||||
$testCases = $list
|
||||
}
|
||||
|
||||
# Define nested script module
|
||||
$scriptModuleName = "NestedScriptModule"
|
||||
$scriptModuleFile = "$scriptModuleName.psm1"
|
||||
$scriptModuleContent = 'function Test-ScriptModule { return $true }'
|
||||
|
||||
# Define root module definition
|
||||
$rootModuleName = "RootModule"
|
||||
$rootModuleFile = "$rootModuleName.psm1"
|
||||
$rootModuleContent = 'function Test-RootModule { Test-ScriptModule }'
|
||||
|
||||
# Module directory structure: $TestDrive/$compatibility/$guid/$moduleName/{module parts}
|
||||
$compatibleDir = "Compatible"
|
||||
$incompatibleDir = "Incompatible"
|
||||
$compatiblePath = Join-Path $TestDrive $compatibleDir
|
||||
$incompatiblePath = Join-Path $TestDrive $incompatibleDir
|
||||
|
||||
foreach ($basePath in $compatiblePath,$incompatiblePath)
|
||||
{
|
||||
New-Item -Path $basePath -ItemType Directory
|
||||
}
|
||||
}
|
||||
|
||||
Context "Modules ON the System32 test path" {
|
||||
BeforeAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $incompatiblePath)
|
||||
}
|
||||
|
||||
AfterAll {
|
||||
[System.Management.Automation.Internal.InternalTestHooks]::SetTestHook("TestWindowsPowerShellPSHomeLocation", $null)
|
||||
}
|
||||
|
||||
BeforeEach {
|
||||
# Create the module directory
|
||||
$guid = New-Guid
|
||||
$compatibilityDir = $incompatibleDir
|
||||
$containingDir = Join-Path $TestDrive $compatibilityDir $guid
|
||||
$moduleName = "CpseTestModule"
|
||||
$moduleBase = Join-Path $containingDir $moduleName
|
||||
New-Item -Path $moduleBase -ItemType Directory
|
||||
Add-ModulePath $containingDir
|
||||
}
|
||||
|
||||
AfterEach {
|
||||
Get-Module $moduleName | Remove-Module -Force
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Import-Module when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases -Skip:(-not $IsWindows) {
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
if ($UseAbsolutePath)
|
||||
{
|
||||
if ((-not $SkipEditionCheck) -and (-not ($MarkedEdition -contains "Core")))
|
||||
{
|
||||
{
|
||||
Import-Module $moduleBase -ErrorAction Stop
|
||||
} | Should -Throw -ErrorId "Modules_PSEditionNotSupported,Microsoft.PowerShell.Commands.ImportModuleCommand"
|
||||
return
|
||||
}
|
||||
|
||||
if ($SkipEditionCheck)
|
||||
{
|
||||
Import-Module $moduleBase -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Import-Module $moduleBase
|
||||
}
|
||||
|
||||
if ($UseRootModule)
|
||||
{
|
||||
Test-RootModule | Should -BeTrue
|
||||
{ Test-ScriptModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
return
|
||||
}
|
||||
|
||||
Test-ScriptModule | Should -BeTrue
|
||||
{ Test-RootModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
return
|
||||
}
|
||||
|
||||
if ((-not $SkipEditionCheck) -and (-not ($MarkedEdition -contains "Core")))
|
||||
{
|
||||
{
|
||||
Import-Module $moduleName -ErrorAction Stop
|
||||
} | Should -Throw -ErrorId "Modules_PSEditionNotSupported,Microsoft.PowerShell.Commands.ImportModuleCommand"
|
||||
return
|
||||
}
|
||||
|
||||
if ($SkipEditionCheck)
|
||||
{
|
||||
Import-Module $moduleName -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Import-Module $moduleName
|
||||
}
|
||||
|
||||
if ($UseRootModule)
|
||||
{
|
||||
Test-RootModule | Should -BeTrue
|
||||
{ Test-ScriptModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
return
|
||||
}
|
||||
|
||||
Test-ScriptModule | Should -BeTrue
|
||||
{ Test-RootModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
}
|
||||
}
|
||||
|
||||
Context "Modules OFF the System32 module path" {
|
||||
BeforeEach {
|
||||
# Create the module directory
|
||||
$guid = New-Guid
|
||||
$compatibilityDir = $compatibleDir
|
||||
$containingDir = Join-Path $TestDrive $compatibilityDir $guid
|
||||
$moduleName = "CpseTestModule"
|
||||
$moduleBase = Join-Path $containingDir $moduleName
|
||||
New-Item -Path $moduleBase -ItemType Directory
|
||||
Add-ModulePath $containingDir
|
||||
}
|
||||
|
||||
AfterEach {
|
||||
Get-Module $moduleName | Remove-Module -Force
|
||||
Restore-ModulePath
|
||||
}
|
||||
|
||||
It "Import-Module when SkipEditionCheck: <SkipEditionCheck>, using root module: <UseRootModule>, using absolute path: <UseAbsolutePath>, CompatiblePSEditions: <MarkedEdition>" -TestCases $testCases {
|
||||
param([bool]$SkipEditionCheck, [bool]$UseRootModule, [bool]$UseAbsolutePath, [string[]]$MarkedEdition)
|
||||
|
||||
New-TestNestedModule `
|
||||
-ModuleBase $moduleBase `
|
||||
-ScriptModuleFilename $scriptModuleFile `
|
||||
-ScriptModuleContent $scriptModuleContent `
|
||||
-RootModuleFilename $rootModuleFile `
|
||||
-RootModuleContent $rootModuleContent `
|
||||
-CompatiblePSEditions $MarkedEdition `
|
||||
-UseRootModule $UseRootModule `
|
||||
-UseAbsolutePath $UseAbsolutePath
|
||||
|
||||
if ($UseAbsolutePath)
|
||||
{
|
||||
if ($SkipEditionCheck)
|
||||
{
|
||||
Import-Module $moduleBase -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Import-Module $moduleBase
|
||||
}
|
||||
}
|
||||
elseif ($SkipEditionCheck)
|
||||
{
|
||||
Import-Module $moduleName -SkipEditionCheck
|
||||
}
|
||||
else
|
||||
{
|
||||
Import-Module $moduleName
|
||||
}
|
||||
|
||||
if ($UseRootModule)
|
||||
{
|
||||
Test-RootModule | Should -BeTrue
|
||||
{ Test-ScriptModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
return
|
||||
}
|
||||
|
||||
Test-ScriptModule | Should -BeTrue
|
||||
{ Test-RootModule } | Should -Throw -ErrorId "CommandNotFoundException"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user