File size: 12,397 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe "Requires tests" -Tags "CI" {
Context "Parser error" {
$testcases = @(
@{command = "#requiresappID`r`n`$foo = 1; `$foo" ; testname = "appId with newline"}
@{command = "#requires -version A `r`n`$foo = 1; `$foo" ; testname = "version as character"}
@{command = "#requires -version 2b `r`n`$foo = 1; `$foo" ; testname = "alphanumeric version"}
@{command = "#requires -version 1. `r`n`$foo = 1; `$foo" ; testname = "version with dot"}
@{command = "#requires -version '' `r`n`$foo = 1; `$foo" ; testname = "empty version"}
@{command = "#requires -version 1.0. `r`n`$foo = 1; `$foo" ; testname = "version with two dots"}
@{command = "#requires -version 1.A `r`n`$foo = 1; `$foo" ; testname = "alphanumeric version with dots"}
)
It "throws ParserException - <testname>" -TestCases $testcases {
param($command)
{ [scriptblock]::Create($command) } | Should -Throw -ErrorId "ParseException"
}
}
Context "Interactive requires" {
BeforeAll {
$ps = [powershell]::Create()
}
AfterAll {
$ps.Dispose()
}
It "Successfully does nothing when given '#requires' interactively" {
$settings = [System.Management.Automation.PSInvocationSettings]::new()
$settings.AddToHistory = $true
{ $ps.AddScript("#requires").Invoke(@(), $settings) } | Should -Not -Throw
}
}
Context "Version checks" {
BeforeAll {
$currentVersion = $PSVersionTable.PSVersion
$powerShellVersions = "1.0", "2.0", "3.0", "4.0", "5.0", "5.1", "6.0", "6.1", "6.2", "7.0", "7.1", "7.2", "7.3", "7.4", "7.5", "7.6", "7.7"
$latestVersion = [version]($powerShellVersions | Sort-Object -Descending -Top 1)
$nonExistingMinor = "$($latestVersion.Major).$($latestVersion.Minor + 1)"
$nonExistingMajor = "$($latestVersion.Major + 1).0"
foreach ($version in ($powerShellVersions + $nonExistingMinor + $nonExistingMajor)) {
$filePath = Join-Path -Path $TestDrive -ChildPath "$version.ps1"
$null = New-Item -Path $filePath -Value "#requires -version $version"
}
$filesSuccessTestCase = foreach ($version in $powerShellVersions) {
@{
Name = "Check for version $version"
File = Join-Path -Path $TestDrive -ChildPath "$version.ps1"
Version = $version
}
}
$filesFailTestCase = foreach ($version in @($nonExistingMinor) + @($nonExistingMajor)) {
@{
Name = "Check for version $version"
File = Join-Path -Path $TestDrive -ChildPath "$version.ps1"
}
}
}
It "<Name>" -TestCase $filesSuccessTestCase {
param(
$Name,
$File,
$Version
)
if ($currentVersion -notmatch '^7' -and $Version -match '^7') {
Set-ItResult -Skipped -Because "Test not valid for current version - $currentVersion and test version = $Version"
}
{ . $File } | Should -Not -Throw
}
It "<Name>" -TestCase $filesFailTestCase {
param(
$Name,
$File
)
{ . $File } | Should -Throw -ExceptionType ([System.Management.Automation.ScriptRequiresException])
}
}
}
Describe "#requires -Modules" -Tags "CI" {
BeforeAll {
$success = 'SUCCESS'
$sep = [System.IO.Path]::DirectorySeparatorChar
$altSep = [System.IO.Path]::AltDirectorySeparatorChar
$scriptPath = Join-Path $TestDrive 'script.ps1'
$moduleName = 'Banana'
$moduleVersion = '0.12.1'
$moduleDirPath = Join-Path $TestDrive 'modules'
New-Item -Path $moduleDirPath -ItemType Directory
$modulePath = "$moduleDirPath${sep}$moduleName"
New-Item -Path $modulePath -ItemType Directory
$manifestPath = "$modulePath${altSep}$moduleName.psd1"
$psm1Path = Join-Path $modulePath "$moduleName.psm1"
New-Item -Path $psm1Path -Value "function Test-RequiredModule { '$success' }"
New-ModuleManifest -Path $manifestPath -ModuleVersion $moduleVersion -RootModule "$moduleName.psm1"
}
Context "Requiring non-existent modules" {
BeforeAll {
$badName = 'ModuleThatDoesNotExist'
$badPath = Join-Path $TestDrive 'ModuleThatDoesNotExist'
$version = '1.0'
$requiredVersion = '1.1'
$maximumVersion = '1.2'
$testCases = @(
@{
ModuleRequirement = $badName
Scenario = 'fully qualified with module name'
ExpectedMessageStrings = @($badName)
}
@{
ModuleRequirement = $badPath
Scenario = 'fully qualified with module path'
ExpectedMessageStrings = @($badPath)
}
@{
ModuleRequirement = "@{ ModuleName = '$badName'; ModuleVersion = '$version' }"
Scenario = 'fully qualified with module name and version'
ExpectedMessageStrings = @($badName, $version)
}
@{
ModuleRequirement = "@{ ModuleName = '$badPath'; ModuleVersion = '$version' }"
Scenario = 'fully qualified with module name and version'
ExpectedMessageStrings = @($badPath, $version)
}
@{
ModuleRequirement = "@{ ModuleName = '$badName'; RequiredVersion = '$requiredVersion' }"
Scenario = 'fully qualified with module name and required version'
ExpectedMessageStrings = @($badName, $requiredVersion)
}
@{
ModuleRequirement = "@{ ModuleName = '$badPath'; RequiredVersion = '$requiredVersion' }"
Scenario = 'fully qualified with module path and required version'
ExpectedMessageStrings = @($badPath, $requiredVersion)
}
@{
ModuleRequirement = "@{ ModuleName = '$badName'; MaximumVersion = '$maximumVersion' }"
Scenario = 'fully qualified with module name and maximum version'
ExpectedMessageStrings = @($badName, $maximumVersion)
}
@{
ModuleRequirement = "@{ ModuleName = '$badPath'; MaximumVersion = '$maximumVersion' }"
Scenario = 'fully qualified with module path and maximum version'
ExpectedMessageStrings = @($badPath, $maximumVersion)
}
@{
ModuleRequirement = "@{ ModuleName = '$badName'; ModuleVersion = '$version'; MaximumVersion = '$maximumVersion' }"
Scenario = 'fully qualified with module name and version and maximum version'
ExpectedMessageStrings = @($badName, $version, $maximumVersion)
}
@{
ModuleRequirement = "@{ ModuleName = '$badPath'; ModuleVersion = '$version'; MaximumVersion = '$maximumVersion' }"
Scenario = 'fully qualified with module path and version and maximum version'
ExpectedMessageStrings = @($badPath, $version, $maximumVersion)
}
)
}
It "Fails parsing a script that requires module by <Scenario>" -TestCases $testCases {
param([string]$ModuleRequirement, [string]$Scenario, [string[]]$ExpectedMessageStrings)
$script = "#requires -Modules $ModuleRequirement`n`nWrite-Output 'failed'"
$null = New-Item -Path $scriptPath -Value $script -Force
$ex = { & $scriptPath } | Should -Throw -ErrorId 'ScriptRequiresMissingModules' -PassThru
$expectedPattern = $ExpectedMessageStrings.ForEach{ [regex]::Escape($_) } -join '|'
$stringMatches = [regex]::Matches($ex.Exception.Message, $expectedPattern)
$stringMatches | Should -HaveCount $ExpectedMessageStrings.Count
}
}
Context "Already loaded module" {
BeforeAll {
Import-Module $modulePath -ErrorAction Stop
$testCases = @(
@{ ModuleRequirement = "'$moduleName'"; Scenario = 'name' }
@{ ModuleRequirement = "'$modulePath'"; Scenario = 'path' }
@{ ModuleRequirement = "'$manifestPath'"; Scenario = 'manifest path' }
@{ ModuleRequirement = "@{ ModuleName='$moduleName'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with name' }
@{ ModuleRequirement = "@{ ModuleName='$modulePath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with path' }
@{ ModuleRequirement = "@{ ModuleName='$manifestPath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with manifest path' }
)
}
AfterAll {
Remove-Module $moduleName -ErrorAction SilentlyContinue
}
It "Successfully runs a script requiring a loaded module by <Scenario>" -TestCases $testCases {
param([string]$ModuleRequirement, [string]$Scenario)
$script = "#requires -Modules $ModuleRequirement`n`nTest-RequiredModule"
[scriptblock]::Create($script).Invoke() | Should -BeExactly $success
}
}
Context "Loading by name" {
BeforeAll {
$oldModulePath = $env:PSModulePath
$env:PSModulePath = $moduleDirPath + [System.IO.Path]::PathSeparator + $env:PSModulePath
$testCases = @(
@{ ModuleRequirement = "'$moduleName'"; Scenario = 'name' }
@{ ModuleRequirement = "'$modulePath'"; Scenario = 'path' }
@{ ModuleRequirement = "'$manifestPath'"; Scenario = 'manifest path' }
@{ ModuleRequirement = "@{ ModuleName='$moduleName'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with name' }
@{ ModuleRequirement = "@{ ModuleName='$modulePath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with path' }
@{ ModuleRequirement = "@{ ModuleName='$manifestPath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with manifest path' }
)
}
AfterAll {
$env:PSModulePath = $oldModulePath
}
It "Successfully runs a script requiring a module on the module path by <Scenario>" -TestCases $testCases {
param([string]$ModuleRequirement, [string]$Scenario)
$script = "#requires -Modules $ModuleRequirement`n`nTest-RequiredModule"
$null = New-Item -Path $scriptPath -Value $script -Force
& $scriptPath | Should -BeExactly $success
}
}
Context "Loading by absolute path" {
BeforeAll {
$testCases = @(
@{ ModuleRequirement = "'$modulePath'"; Scenario = 'path' }
@{ ModuleRequirement = "'$manifestPath'"; Scenario = 'manifest path' }
@{ ModuleRequirement = "@{ ModuleName='$modulePath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with path' }
@{ ModuleRequirement = "@{ ModuleName='$manifestPath'; ModuleVersion='$moduleVersion' }"; Scenario = 'fully qualified name with manifest path' }
)
}
It "Successfully runs a script requiring a module by absolute path by <Scenario>" -TestCases $testCases {
param([string]$ModuleRequirement, [string]$Scenario)
$script = "#requires -Modules $ModuleRequirement`n`nTest-RequiredModule"
$null = New-Item -Path $scriptPath -Value $script -Force
& $scriptPath | Should -BeExactly $success
}
}
}
|