File size: 19,409 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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe 'Argument transformation attribute on optional argument with explicit $null' -Tags "CI" {
$tdefinition = @'
using System;
using System.Management.Automation;
using System.Reflection;
namespace MSFT_1407291
{
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class AddressTransformationAttribute : ArgumentTransformationAttribute
{
public override object Transform(EngineIntrinsics engineIntrinsics, object inputData)
{
return (ulong) 42;
}
}
[Cmdlet(VerbsLifecycle.Invoke, "CSharpCmdletTakesUInt64")]
[OutputType(typeof(System.String))]
public class Cmdlet1 : PSCmdlet
{
[Parameter(Mandatory = false)]
[AddressTransformation]
public ulong Address { get; set; }
protected override void ProcessRecord()
{
WriteObject(Address);
}
}
[Cmdlet(VerbsLifecycle.Invoke, "CSharpCmdletTakesObject")]
[OutputType(typeof(System.String))]
public class Cmdlet2 : PSCmdlet
{
[Parameter(Mandatory = false)]
[AddressTransformation]
public object Address { get; set; }
protected override void ProcessRecord()
{
WriteObject(Address ?? "passed in null");
}
}
}
'@
$mod = Add-Type -PassThru -TypeDefinition $tdefinition
Import-Module $mod[0].Assembly -ErrorVariable ErrorImportingModule
function Invoke-ScriptFunctionTakesObject
{
param([MSFT_1407291.AddressTransformation()]
[Parameter(Mandatory = $false)]
[object]$Address = "passed in null")
return $Address
}
function Invoke-ScriptFunctionTakesUInt64
{
param([MSFT_1407291.AddressTransformation()]
[Parameter(Mandatory = $false)]
[Uint64]$Address = 11)
return $Address
}
It "There was no error importing the in-memory module" {
$ErrorImportingModule | Should -BeNullOrEmpty
}
It "Script function takes object" {
Invoke-ScriptFunctionTakesObject | Should -Be 42
}
It "Script function takes uint64" {
Invoke-ScriptFunctionTakesUInt64 | Should -Be 42
}
It "csharp cmdlet takes object" {
Invoke-CSharpCmdletTakesObject | Should -Be "passed in null"
}
It "csharp cmdlet takes uint64" {
Invoke-CSharpCmdletTakesUInt64 | Should -Be 0
}
It "script function takes object when parameter is null" {
Invoke-ScriptFunctionTakesObject -Address $null | Should -Be 42
}
It "script function takes unit64 when parameter is null" {
Invoke-ScriptFunctionTakesUInt64 -Address $null | Should -Be 42
}
It "script csharp cmdlet takes object when parameter is null" {
Invoke-CSharpCmdletTakesObject -Address $null | Should -Be 42
}
It "script csharp cmdlet takes uint64 when parameter is null" {
Invoke-CSharpCmdletTakesUInt64 -Address $null | Should -Be 42
}
}
Describe "Custom type conversion in parameter binding" -Tags 'Feature' {
BeforeAll {
## Prepare the script module
$content = @'
function Test-ScriptCmdlet {
[CmdletBinding(DefaultParameterSetName = "File")]
param(
[Parameter(Mandatory, ParameterSetName = "File")]
[System.IO.FileInfo] $File,
[Parameter(Mandatory, ParameterSetName = "StartInfo")]
[System.Diagnostics.ProcessStartInfo] $StartInfo
)
if ($PSCmdlet.ParameterSetName -eq "File") {
$File.Name
} else {
$StartInfo.FileName
}
}
function Test-ScriptFunction {
param(
[System.IO.FileInfo] $File,
[System.Diagnostics.ProcessStartInfo] $StartInfo
)
if ($null -ne $File) {
$File.Name
}
if ($null -ne $StartInfo) {
$StartInfo.FileName
}
}
'@
Set-Content -Path $TestDrive\module.psm1 -Value $content -Force
## Prepare the C# module
$code = @'
using System.IO;
using System.Diagnostics;
using System.Management.Automation;
namespace Test
{
[Cmdlet("Test", "BinaryCmdlet", DefaultParameterSetName = "File")]
public class TestCmdletCommand : PSCmdlet
{
[Parameter(Mandatory = true, ParameterSetName = "File")]
public FileInfo File { get; set; }
[Parameter(Mandatory = true, ParameterSetName = "StartInfo")]
public ProcessStartInfo StartInfo { get; set; }
protected override void ProcessRecord()
{
if (this.ParameterSetName == "File")
{
WriteObject(File.Name);
}
else
{
WriteObject(StartInfo.FileName);
}
}
}
}
'@
if ($IsWindows) {
$asmFile = [System.IO.Path]::GetTempFileName() + ".dll"
}
else {
$asmFile = (Join-Path $env:HOME $([System.IO.Path]::GetRandomFileName() + ".dll"))
}
Add-Type -TypeDefinition $code -OutputAssembly $asmFile
## Helper function to execute script
function Execute-Script {
[CmdletBinding(DefaultParameterSetName = "Script")]
param(
[Parameter(Mandatory)]
[powershell]$ps,
[Parameter(Mandatory, ParameterSetName = "Script")]
[string]$Script,
[Parameter(Mandatory, ParameterSetName = "Command")]
[string]$Command,
[Parameter(Mandatory, ParameterSetName = "Command")]
[string]$ParameterName,
[Parameter(Mandatory, ParameterSetName = "Command")]
[object]$Argument
)
$ps.Commands.Clear()
$ps.Streams.ClearStreams()
if ($PSCmdlet.ParameterSetName -eq "Script") {
$ps.AddScript($Script).Invoke()
} else {
$ps.AddCommand($Command).AddParameter($ParameterName, $Argument).Invoke()
}
}
## Helper command strings
$changeToConstrainedLanguage = '$ExecutionContext.SessionState.LanguageMode = "ConstrainedLanguage"'
$getLanguageMode = '$ExecutionContext.SessionState.LanguageMode'
$importScriptModule = "Import-Module $TestDrive\module.psm1"
$importCSharpModule = "Import-Module $asmFile"
}
AfterAll {
## Set the LanguageMode to force rebuilding the type conversion cache.
## This is needed because type conversions happen in the new powershell runspace with 'ConstrainedLanguage' mode
## will be put in the type conversion cache, and that may affect the default session.
$ExecutionContext.SessionState.LanguageMode = "FullLanguage"
}
It "Custom type conversion in parameter binding is allowed in FullLanguage" {
## Create a powershell instance for the test
$ps = [powershell]::Create()
try {
## Import the modules in FullLanguage mode
Execute-Script -ps $ps -Script $importScriptModule
Execute-Script -ps $ps -Script $importCSharpModule
$languageMode = Execute-Script -ps $ps -Script $getLanguageMode
$languageMode | Should -Be 'FullLanguage'
$result1 = Execute-Script -ps $ps -Script "Test-ScriptCmdlet -File fileToUse"
$result1 | Should -Be "fileToUse"
$result2 = Execute-Script -ps $ps -Script "Test-ScriptFunction -File fileToUse"
$result2 | Should -Be "fileToUse"
$result3 = Execute-Script -ps $ps -Script "Test-BinaryCmdlet -File fileToUse"
$result3 | Should -Be "fileToUse"
## Conversion involves setting properties of an instance of the target type is allowed in FullLanguage mode
$hashValue = @{ FileName = "filename"; Arguments = "args" }
$psobjValue = [PSCustomObject] $hashValue
## Test 'Test-ScriptCmdlet -StartInfo' with IDictionary and PSObject with properties
$result4 = Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $hashValue
$result4 | Should -Be "filename"
$result5 = Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
$result5 | Should -Be "filename"
## Test 'Test-ScriptFunction -StartInfo' with IDictionary and PSObject with properties
$result6 = Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $hashValue
$result6 | Should -Be "filename"
$result7 = Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $psobjValue
$result7 | Should -Be "filename"
## Test 'Test-BinaryCmdlet -StartInfo' with IDictionary and PSObject with properties
$result8 = Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $hashValue
$result8 | Should -Be "filename"
$result9 = Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
$result9 | Should -Be "filename"
}
finally {
$ps.Dispose()
}
}
It "Some custom type conversion in parameter binding is allowed for trusted cmdlets in ConstrainedLanguage" {
## Create a powershell instance for the test
$ps = [powershell]::Create()
try {
## Import the modules in FullLanguage mode
Execute-Script -ps $ps -Script $importScriptModule
Execute-Script -ps $ps -Script $importCSharpModule
$languageMode = Execute-Script -ps $ps -Script $getLanguageMode
$languageMode | Should -Be 'FullLanguage'
## Change to ConstrainedLanguage mode
Execute-Script -ps $ps -Script $changeToConstrainedLanguage
$languageMode = Execute-Script -ps $ps -Script $getLanguageMode
$languageMode | Should -Be 'ConstrainedLanguage'
$result1 = Execute-Script -ps $ps -Script "Test-ScriptCmdlet -File fileToUse"
$result1 | Should -Be "fileToUse"
$result2 = Execute-Script -ps $ps -Script "Test-ScriptFunction -File fileToUse"
$result2 | Should -Be "fileToUse"
$result3 = Execute-Script -ps $ps -Script "Test-BinaryCmdlet -File fileToUse"
$result3 | Should -Be "fileToUse"
## If the conversion involves setting properties of an instance of the target type,
## then it's disallowed even for trusted cmdlets.
$hashValue = @{ FileName = "filename"; Arguments = "args" }
$psobjValue = [PSCustomObject] $hashValue
## Test 'Test-ScriptCmdlet -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
## Test 'Test-ScriptFunction -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
## Test 'Test-BinaryCmdlet -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingException,Execute-Script"
}
}
finally {
$ps.Dispose()
}
}
It "Custom type conversion in parameter binding is NOT allowed for untrusted cmdlets in ConstrainedLanguage" {
## Create a powershell instance for the test
$ps = [powershell]::Create()
try {
$languageMode = Execute-Script -ps $ps -Script $getLanguageMode
$languageMode | Should -Be 'FullLanguage'
## Change to ConstrainedLanguage mode
Execute-Script -ps $ps -Script $changeToConstrainedLanguage
$languageMode = Execute-Script -ps $ps -Script $getLanguageMode
$languageMode | Should -Be 'ConstrainedLanguage'
## Import the modules in ConstrainedLanguage mode
Execute-Script -ps $ps -Script $importScriptModule
Execute-Script -ps $ps -Script $importCSharpModule
$result1 = Execute-Script -ps $ps -Script "Test-ScriptCmdlet -File fileToUse"
$result1 | Should -Be $null
$ps.Streams.Error.Count | Should -Be 1
$ps.Streams.Error[0].FullyQualifiedErrorId | Should -Be "ParameterArgumentTransformationError,Test-ScriptCmdlet"
$result2 = Execute-Script -ps $ps -Script "Test-ScriptFunction -File fileToUse"
$result2 | Should -Be $null
$ps.Streams.Error.Count | Should -Be 1
$ps.Streams.Error[0].FullyQualifiedErrorId | Should -Be "ParameterArgumentTransformationError,Test-ScriptFunction"
## Binary cmdlets are always marked as trusted because only trusted assemblies can be loaded on DeviceGuard machine.
$result3 = Execute-Script -ps $ps -Script "Test-BinaryCmdlet -File fileToUse"
$result3 | Should -Be "fileToUse"
## Conversion that involves setting properties of an instance of the target type is disallowed.
$hashValue = @{ FileName = "filename"; Arguments = "args" }
$psobjValue = [PSCustomObject] $hashValue
## Test 'Test-ScriptCmdlet -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-ScriptCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
## Test 'Test-ScriptFunction -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-ScriptFunction" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingArgumentTransformationException,Execute-Script"
}
## Test 'Test-BinaryCmdlet -StartInfo' with IDictionary and PSObject with properties
try {
Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $hashValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingException,Execute-Script"
}
try {
Execute-Script -ps $ps -Command "Test-BinaryCmdlet" -ParameterName "StartInfo" -Argument $psobjValue
throw "Expected exception was not thrown!"
} catch {
$_.FullyQualifiedErrorId | Should -Be "ParameterBindingException,Execute-Script"
}
}
finally {
$ps.Dispose()
}
}
}
Describe 'Roundtrippable Conversions for Bare-string Numeric Literals passed to [string] Parameters' -Tags CI {
BeforeAll {
$TestValues = @(
@{ Argument = "34uy" }
@{ Argument = "48y" }
@{ Argument = "8s" }
@{ Argument = "49us" }
@{ Argument = "26" }
@{ Argument = "28u" }
@{ Argument = "24l" }
@{ Argument = "32ul" }
@{ Argument = "20d" }
@{ Argument = "6n" }
)
function Test-SimpleStringValue([string] $Value) { $Value }
function Test-AdvancedStringValue {
[CmdletBinding()]
param(
[string]
$Value
)
$Value
}
}
It 'should correctly convert <Argument> back to string in simple functions' -TestCases $TestValues {
param($Argument)
Invoke-Expression "Test-SimpleStringValue -Value $Argument" | Should -BeExactly $Argument
}
It 'should correctly convert <Argument> back to string in advanced functions' -TestCases $TestValues {
param($Argument)
Invoke-Expression "Test-AdvancedStringValue -Value $Argument" | Should -BeExactly $Argument
}
}
|