File size: 40,317 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 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Import-Module HelpersCommon
try
{
# Skip all tests on non-windows and non-PowerShellCore and non-elevated platforms.
$originalWarningPreference = $WarningPreference
$WarningPreference = "SilentlyContinue"
# Skip all tests if can't write to $PSHOME as Register-PSSessionConfiguration writes to $PSHOME
# or if the processor architecture is Arm64
$IsNotSkipped = (
$IsWindows -and
$IsCoreCLR -and
(Test-IsElevated) -and
(Test-CanWriteToPsHome) -and
-not (Test-IsWindowsArm64) -and
-not (Test-IsWinWow64)
)
Push-DefaultParameterValueStack @{ "it:skip" = ! $IsNotSkipped }
#
# TODO: Enable-PSRemoting should be performed at a higher set up for all tests.
# Tests whether PowerShell remoting is enabled for this instance of PowerShell.
# If remoting is not enabled, it will enable it and then clean up after all the tests
# have executed.
#
if ($IsNotSkipped)
{
$endpointName = "PowerShell.$($PSVersionTable.GitCommitId)"
$matchedEndpoint = Get-PSSessionConfiguration $endpointName -ErrorAction SilentlyContinue
if ($matchedEndpoint -eq $null)
{
# An endpoint for this instance of PowerShell does not exist.
#
# -SkipNetworkProfileCheck is used in case Docker or another application
# has created a publich virtual network profile on the system
Enable-PSRemoting -SkipNetworkProfileCheck
$endpointCreated = $true
}
}
try
{
Describe "Validate Register-PSSessionConfiguration" -Tags @("CI", 'RequireAdminOnWindows') {
AfterAll {
if ($IsNotSkipped)
{
Get-PSSessionConfiguration -Name "ITTask*" -ErrorAction SilentlyContinue | Unregister-PSSessionConfiguration
}
}
It "Register-PSSessionConfiguration -TransportOption" {
$ConfigurationName = "ITTask" + (Get-Random -Minimum 10000 -Maximum 99999)
$Transport = New-PSTransportOption -MaxSessions 40 -IdleTimeoutSec 3600
$null = Register-PSSessionConfiguration -Name $ConfigurationName -TransportOption $Transport
$result = Get-PSSessionConfiguration -Name $ConfigurationName
$result.MaxShells | Should -Be 40
$result.IdleTimeoutms | Should -Be 3600000
$result.UseSharedProcess | Should -Be 'False'
}
}
Describe "Validate Get-PSSessionConfiguration, Enable-PSSessionConfiguration, Disable-PSSessionConfiguration, Unregister-PSSessionConfiguration cmdlets" -Tags @("CI", 'RequireAdminOnWindows') {
BeforeAll {
if ($IsNotSkipped)
{
# Register new session configuration
function RegisterNewConfiguration {
param (
[string] $Name,
[string] $ConfigFilePath,
[switch] $Enabled
)
$TestConfig = Get-PSSessionConfiguration -Name $Name -ErrorAction SilentlyContinue
if($TestConfig) {
$null = Unregister-PSSessionConfiguration -Name $Name
}
if($Enabled) {
$null = Register-PSSessionConfiguration -Name $Name -Path $ConfigFilePath
}
else {
$null = Register-PSSessionConfiguration -Name $Name -Path $ConfigFilePath -AccessMode Disabled
}
}
# Unregister session configuration
function UnregisterPSSessionConfiguration{
param (
[string] $Name
)
Unregister-PSSessionConfiguration -Name $Name -Force -NoServiceRestart -ErrorAction SilentlyContinue
}
# Create new Config File
function CreateTestConfigFile {
$TestConfigFileLoc = Join-Path $TestDrive "Remoting"
if(-not (Test-path $TestConfigFileLoc)) {
$null = New-Item -Path $TestConfigFileLoc -ItemType Directory -Force -ErrorAction Stop
}
$TestConfigFile = Join-Path $TestConfigFileLoc "TestConfigFile.pssc"
$null = New-PSSessionConfigurationFile -Path $TestConfigFile -SessionType Default
return $TestConfigFile
}
$LocalConfigFilePath = CreateTestConfigFile
$expectedPSVersion = "$($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
}
}
Context "Validate Get-PSSessionConfiguration cmdlet" {
It "Get-PSSessionConfiguration with no parameter" {
$Result = Get-PSSessionConfiguration
$Result.Name -contains $endpointName | Should -BeTrue
$Result.PSVersion -contains $expectedPSVersion | Should -BeTrue
}
It "Get-PSSessionConfiguration with Name parameter" {
$Result = Get-PSSessionConfiguration -Name $endpointName
$Result.Name | Should -BeExactly $endpointName
$Result.PSVersion | Should -BeExactly $expectedPSVersion
}
It "Get-PSSessionConfiguration -Name with wildcard character" {
$endpointWildcard = "powershell.*"
$Result = Get-PSSessionConfiguration -Name $endpointWildcard
$Result.Name -contains $endpointName | Should -BeTrue
$Result.PSVersion -contains $expectedPSVersion | Should -BeTrue
}
It "Get-PSSessionConfiguration -Name with Non-Existent session configuration" {
{ Get-PSSessionConfiguration -Name "NonExistantSessionConfiguration" -ErrorAction Stop } | Should -Throw -ErrorId "Microsoft.PowerShell.Commands.WriteErrorException"
}
}
Context "Validate Enable-PSSessionConfiguration and Disable-PSSessionConfiguration" {
function VerifyEnableAndDisablePSSessionConfig {
param (
[string] $SessionConfigName,
[string] $ConfigFilePath,
[Bool] $InitialSessionStateEnabled,
[Bool] $FinalSessionStateEnabled,
[string] $TestDescription,
[bool] $EnablePSSessionConfig)
It "$TestDescription" {
RegisterNewConfiguration -Name $SessionConfigName -ConfigFilePath $ConfigFilePath -Enabled:$InitialSessionStateEnabled
$TestConfigStateBeforeChange = (Get-PSSessionConfiguration -Name $SessionConfigName).Enabled
if($EnablePSSessionConfig) {
$isSkipNetworkCheck = $true
# TODO: Get-NetConnectionProfile is not available during typical PS Core deployments. Once it is, this check should be used.
#Get-NetConnectionProfile | Where-Object { $_.NetworkCategory -eq "Public" } | ForEach-Object { $isSkipNetworkCheck = $true }
Enable-PSSessionConfiguration -Name $SessionConfigName -NoServiceRestart -SkipNetworkProfileCheck:$isSkipNetworkCheck
}
else {
Disable-PSSessionConfiguration -Name $SessionConfigName -NoServiceRestart
}
$TestConfigStateAfterChange = (Get-PSSessionConfiguration -Name $SessionConfigName -ErrorAction SilentlyContinue).Enabled
UnregisterPSSessionConfiguration -Name $SessionConfigName
$TestConfigStateBeforeChange | Should -Be "$InitialSessionStateEnabled"
$TestConfigStateAfterChange | Should -Be "$FinalSessionStateEnabled"
}
}
$TestData = @(
@{
SessionConfigName = "TestDisablePSSessionConfig"
ConfigFilePath = $LocalConfigFilePath
InitialSessionStateEnabled = $true
FinalSessionStateEnabled = $false
TestDescription = "Validate Disable-Configuration cmdlet"
EnablePSSessionConfig = $false
}
@{
SessionConfigName = "TestEnablePSSessionConfig"
ConfigFilePath = $LocalConfigFilePath
InitialSessionStateEnabled = $false
FinalSessionStateEnabled = $true
TestDescription = "Validate Enable-Configuration cmdlet"
EnablePSSessionConfig = $true
}
)
foreach ($testcase in $testData) {
VerifyEnableAndDisablePSSessionConfig @testcase
}
}
Context "Validate Unregister-PSSessionConfiguration cmdlet" {
BeforeEach {
if ($IsNotSkipped) {
Register-PSSessionConfiguration -Name "TestUnregisterPSSessionConfig"
}
}
AfterAll {
if ($IsNotSkipped) {
Unregister-PSSessionConfiguration -name "TestUnregisterPSSessionConfig" -ErrorAction SilentlyContinue | Out-Null
}
}
function TestUnRegisterPSSsessionConfiguration {
param ($Description, $SessionConfigName, $ExpectedOutput, $ExpectedError)
It "$Description" {
$Result = [PSObject] @{Output = $true ; Error = $null}
$error.Clear()
try {
$null = Unregister-PSSessionConfiguration -name $SessionConfigName -ErrorAction stop
}
catch {
$Result.Error = $_.Exception
}
if(-not $Result.Error) {
$ValidEndpoints = [PSObject]@(Get-PSSessionConfiguration)
foreach ($endpoint in $ValidEndpoints) {
# Setting it to false means the unregister was unsuccessful
# and there is still an endpoint with name matching the one we wanted to remove.
if($endpoint.name -like $SessionConfigName) {
$Result.Output = $false
break
}
}
}
else {
$Result.Output = $false
}
$Result.Output | Should -Match $ExpectedOutput
$Result.Error | Should -Match $ExpectedError
}
}
$TestData = @(
@{
Description = "Validate Unregister-PSSessionConfiguration with -name parameter"
SessionConfigName = "TestUnregisterPSSessionConfig"
ExpectedOutput = $true
ExpectedError = $null
}
@{
Description = "Validate Unregister-PSSessionConfiguration with name having wildcard character"
SessionConfigName = "TestUnregister*"
ExpectedOutput = $true
ExpectedError = $null
}
@{
Description = "Validate Unregister-PSSessionConfiguration for non-existant endpoint"
SessionConfigName = 'TestInvalidEndPoint'
ExpectedOutput = $false
ExpectedError = "No session configuration matches criteria `"TestInvalidEndPoint`"."
}
)
foreach ($TestCase in $TestData)
{
TestUnRegisterPSSsessionConfiguration @TestCase
}
}
}
Describe "Validate Register-PSSessionConfiguration, Set-PSSessionConfiguration cmdlets" -Tags @("Feature", 'RequireAdminOnWindows') {
BeforeAll {
if ($IsNotSkipped)
{
$expectedPSVersion = "$($PSVersionTable.PSVersion.Major).$($PSVersionTable.PSVersion.Minor)"
function ValidateRemoteEndpoint {
param ($TestSessionConfigName, $ScriptToExecute, $ExpectedOutput)
$Result = [PSObject]@{Output= $null; Error = $null}
try
{
$sn = New-PSSession . -ConfigurationName $TestSessionConfigName -ErrorAction Stop
if($sn)
{
if($ScriptToExecute)
{
$Result.Output = invoke-command -Session $Sn -ScriptBlock { param ($scripttoExecute) Invoke-Expression $scripttoExecute} -ArgumentList $ScriptToExecute
}
else
{
$Result.Output = $true
}
}
else
{
throw "Unable to create session $TestSessionConfigName"
}
}
catch
{
$Result.Error = $_.Error.FullyQualifiedErrorId
}
finally
{
if ($sn)
{
Remove-PSSession $sn -ErrorAction SilentlyContinue | Out-Null
$sn = $null
}
}
$Result.Output | Should -Be $ExpectedOutput
$Result.Error | Should -BeNullOrEmpty
}
# Create Test Startup Script
function CreateStartupScript {
$ScriptContent = @"
`$script:testvariable = "testValue"
"@
$TestScript = Join-Path $script:TestDir "StartupTestScript.ps1"
$null = Set-Content -path $TestScript -Value $ScriptContent
return $TestScript
}
# Create new Config File
function CreateTestConfigFile {
$TestConfigFile = Join-Path $script:TestDir "TestConfigFile.pssc"
$null = New-PSSessionConfigurationFile -Path $TestConfigFile -SessionType Default
return $TestConfigFile
}
function CreateTestModule {
$ScriptContent = @"
function IsTestModuleImported {
return `$true
}
Export-ModuleMember IsTestModuleImported
"@
$TestModuleFileLoc = $script:TestDir
if(-not (Test-path $TestModuleFileLoc))
{
$null = New-Item -Path $TestModuleFileLoc -ItemType Directory -Force -ErrorAction Stop
}
$TestModuleFile = Join-Path $TestModuleFileLoc "TestModule.psm1"
$null = Set-Content -path $TestModuleFile -Value $ScriptContent
return $TestModuleFile
}
function CreateTestAssembly {
$PscConfigDef = @"
using System;
using System.Management.Automation;
using System.Management.Automation.Runspaces;
using System.Management.Automation.Remoting;
namespace PowershellTestConfigNamespace
{
public sealed class PowershellTestConfig : PSSessionConfiguration
{
/// <summary>
///
/// </summary>
/// <param name="senderInfo"></param>
/// <returns></returns>
public override InitialSessionState GetInitialSessionState(PSSenderInfo senderInfo)
{
return InitialSessionState.CreateDefault();
}
}
}
"@
$script:SourceFile = Join-Path $script:TestAssemblyDir "PowershellTestConfig.cs"
$PscConfigDef | out-file $script:SourceFile -Encoding ascii -Force
$TestAssemblyName = "TestAssembly.dll"
$TestAssemblyPath = Join-Path $script:TestAssemblyDir $TestAssemblyName
Add-Type -path $script:SourceFile -OutputAssembly $TestAssemblyPath
return $TestAssemblyName
}
$script:TestDir = Join-Path $TestDrive "Remoting"
if(-not (Test-Path $script:TestDir))
{
$null = New-Item -path $script:TestDir -ItemType Directory
}
$script:TestAssemblyDir = Join-Path $TestDrive "AssemblyDir"
if(-not (Test-Path $script:TestAssemblyDir))
{
$null = New-Item -path $script:TestAssemblyDir -ItemType Directory
}
$LocalConfigFilePath = CreateTestConfigFile
$LocalStartupScriptPath = CreateStartupScript
$LocalTestModulePath = CreateTestModule
$LocalTestAssemblyName = CreateTestAssembly
}
}
Context "Validate Register-PSSessionConfiguration" {
BeforeAll {
if ($IsNotSkipped)
{
$TestSessionConfigName = "TestRegisterPSSesionConfig"
Unregister-PSSessionConfiguration -Name $TestSessionConfigName -Force -NoServiceRestart -ErrorAction SilentlyContinue
}
}
AfterEach {
Unregister-PSSessionConfiguration -Name $TestSessionConfigName -Force -NoServiceRestart -ErrorAction SilentlyContinue
}
It "Validate Register-PSSessionConfiguration -name -path" {
$pssessionthreadoptions = "UseCurrentThread"
$psmaximumreceivedobjectsizemb = 20
$psmaximumreceiveddatasizepercommandmb = 20
$UseSharedProcess = $true
Register-PSSessionConfiguration -Name $TestSessionConfigName -path $LocalConfigFilePath -MaximumReceivedObjectSizeMB $psmaximumreceivedobjectsizemb -MaximumReceivedDataSizePerCommandMB $psmaximumreceiveddatasizepercommandmb -UseSharedProcess:$UseSharedProcess -ThreadOptions $pssessionthreadoptions
$Result = [PSObject]@{Session = Get-PSSessionConfiguration -Name $TestSessionConfigName; Culture = (Get-Item WSMan:\localhost\Plugin\$endpointName\lang -ErrorAction SilentlyContinue).value}
$Result.Session.Name | Should -Be $TestSessionConfigName
$Result.Session.SessionType | Should -Be "Default"
$Result.Session.PSVersion | Should -BeExactly $expectedPSVersion
$Result.Session.Enabled | Should -BeTrue
$Result.Session.lang | Should -Be $Result.Culture
$Result.Session.pssessionthreadoptions | Should -Be $pssessionthreadoptions
$Result.Session.psmaximumreceivedobjectsizemb | Should -Be $psmaximumreceivedobjectsizemb
$Result.Session.psmaximumreceiveddatasizepercommandmb | Should -Be $psmaximumreceiveddatasizepercommandmb
$Result.Session.UseSharedProcess | Should -Be $UseSharedProcess
}
It "Verifies that Register-PSSessionConfiguration -PSVersion parameter is not supported" {
{ Register-PSSessionConfiguration -Name $TestSessionConfigName -PSVersion 5.1 } | Should -Throw -ErrorId 'ParameterBindingFailed,Microsoft.PowerShell.Commands.RegisterPSSessionConfigurationCommand'
}
It "Validate Register-PSSessionConfiguration -startupscript parameter" -Pending {
$null = Register-PSSessionConfiguration -Name $TestSessionConfigName -path $LocalConfigFilePath -StartupScript $LocalStartupScriptPath -Force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute "return `$script:testvariable" -ExpectedOutput "testValue" -ExpectedError $null
}
It "Validate Register-PSSessionConfiguration -AccessMode parameter" {
$null = Register-PSSessionConfiguration -Name $TestSessionConfigName -path $LocalConfigFilePath -AccessMode Disabled -Force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute $null -ExpectedOutput $null -ExpectedError "RemoteConnectionDisallowed,PSSessionOpenFailed"
}
It "Validate Register-PSSessionConfiguration -ModulesToImport parameter" -Pending {
$null = Register-PSSessionConfiguration -Name $TestSessionConfigName -ModulesToImport $LocalTestModulePath -Force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute "return IsTestModuleImported" -ExpectedOutput $true -ExpectedError $null
}
It "Validate Register-PSSessionConfiguration with ApplicationBase, AssemblyName and ConfigurationTypeName parameter" -Pending {
$null = Register-PSSessionConfiguration -Name $TestSessionConfigName -ApplicationBase $script:TestAssemblyDir -AssemblyName $LocalTestAssemblyName -ConfigurationTypeName "PowershellTestConfigNamespace.PowershellTestConfig" -force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute $null -ExpectedOutput $true -ExpectedError $null
}
}
Context "Validate Set-PSSessionConfiguration" {
BeforeAll {
if ($IsNotSkipped)
{
$TestSessionConfigName = "TestSetPSSesionConfig"
Unregister-PSSessionConfiguration -Name $TestSessionConfigName -Force -NoServiceRestart -ErrorAction SilentlyContinue
}
}
AfterEach {
Unregister-PSSessionConfiguration -Name $TestSessionConfigName -Force -NoServiceRestart -ErrorAction SilentlyContinue
}
BeforeEach {
Register-PSSessionConfiguration -Name $TestSessionConfigName
}
It "Validate Set-PSSessionConfiguration -name -path -MaximumReceivedObjectSizeMB -MaximumReceivedDataSizePerCommandMB -UseSharedProcess -ThreadOptions parameters" {
$pssessionthreadoptions = "UseCurrentThread"
$psmaximumreceivedobjectsizemb = 20
$psmaximumreceiveddatasizepercommandmb = 20
$UseSharedProcess = $true
Set-PSSessionConfiguration -Name $TestSessionConfigName -MaximumReceivedObjectSizeMB $psmaximumreceivedobjectsizemb -MaximumReceivedDataSizePerCommandMB $psmaximumreceiveddatasizepercommandmb -UseSharedProcess:$UseSharedProcess -ThreadOptions $pssessionthreadoptions -NoServiceRestart
$Result = [PSObject]@{Session = (Get-PSSessionConfiguration -Name $TestSessionConfigName) ; Culture = (Get-Item WSMan:\localhost\Plugin\microsoft.powershell\lang -ErrorAction SilentlyContinue).value}
$Result.Session.Name | Should -Be $TestSessionConfigName
$Result.Session.PSVersion | Should -BeExactly $expectedPSVersion
$Result.Session.Enabled | Should -BeTrue
$Result.Session.lang | Should -Be $result.Culture
$Result.Session.pssessionthreadoptions | Should -Be $pssessionthreadoptions
$Result.Session.psmaximumreceivedobjectsizemb | Should -Be $psmaximumreceivedobjectsizemb
$Result.Session.psmaximumreceiveddatasizepercommandmb | Should -Be $psmaximumreceiveddatasizepercommandmb
$Result.Session.UseSharedProcess | Should -Be $UseSharedProcess
}
It "Verifies that Set-PSSessionConfiguration -PSVersion parameter is not supported" {
{ Set-PSSessionConfiguration -Name $TestSessionConfigName -PSVersion 5.1 } | Should -Throw -ErrorId 'ParameterBindingFailed,Microsoft.PowerShell.Commands.SetPSSessionConfigurationCommand'
}
It "Validate Set-PSSessionConfiguration -startupscript parameter" -Pending {
$null = Set-PSSessionConfiguration -Name $TestSessionConfigName -StartupScript $LocalStartupScriptPath
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute "return `$script:testvariable" -ExpectedOutput "testValue" -ExpectedError $null
}
It "Validate Set-PSSessionConfiguration -AccessMode parameter" {
$null = Set-PSSessionConfiguration -Name $TestSessionConfigName -AccessMode Disabled
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute $null -ExpectedOutput $null -ExpectedError "RemoteConnectionDisallowed,PSSessionOpenFailed"
}
It "Validate Set-PSSessionConfiguration -ModulesToImport parameter" -Pending {
$null = Set-PSSessionConfiguration -Name $TestSessionConfigName -ModulesToImport $LocalTestModulePath -Force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute "return IsTestModuleImported" -ExpectedOutput $true -ExpectedError $null
}
It "Validate Set-PSSessionConfiguration with ApplicationBase, AssemblyName and ConfigurationTypeName parameter" -Pending {
$null = Set-PSSessionConfiguration -Name $TestSessionConfigName -ApplicationBase $script:TestAssemblyDir -AssemblyName $LocalTestAssemblyName -ConfigurationTypeName "PowershellTestConfigNamespace.PowershellTestConfig" -force
ValidateRemoteEndpoint -TestSessionConfigName $TestSessionConfigName -ScriptToExecute $null -ExpectedOutput $true -ExpectedError $null
}
}
}
}
finally
{
if ($endpointCreated)
{
Get-PSSessionConfiguration $endpointName -ErrorAction SilentlyContinue | Unregister-PSSessionConfiguration
}
}
Describe "Basic tests for New-PSSessionConfigurationFile Cmdlet" -Tags @("CI", 'RequireAdminOnWindows') {
It "Validate New-PSSessionConfigurationFile can successfully create a valid PSSessionConfigurationFile" {
$configFilePath = Join-Path $TestDrive "SamplePSSessionConfigurationFile.pssc"
try
{
New-PSSessionConfigurationFile $configFilePath
$result = Get-Content $configFilePath | Out-String
}
finally
{
if(Test-Path $configFilePath){ Remove-Item $configFilePath -Force }
}
$resultContent = invoke-expression ($result)
$resultContent | Should -BeOfType System.Collections.Hashtable
# The default created hashtable in the session configuration file would have the
# following keys which we are validating below.
$resultContent.ContainsKey("SessionType") -and $resultContent.ContainsKey("SchemaVersion") -and $resultContent.ContainsKey("Guid") -and $resultContent.ContainsKey("Author") | Should -BeTrue
}
}
Describe "Feature tests for New-PSSessionConfigurationFile Cmdlet" -Tags @("Feature", 'RequireAdminOnWindows') {
It "Validate FullyQualifiedErrorId from New-PSSessionConfigurationFile when invalid path is provided as input" {
{ New-PSSessionConfigurationFile "cert:\foo.pssc" } |
Should -Throw -ErrorId "InvalidPSSessionConfigurationFilePath,Microsoft.PowerShell.Commands.NewPSSessionConfigurationFileCommand"
}
}
Describe "Test suite for Test-PSSessionConfigurationFile Cmdlet" -Tags @("CI", 'RequireAdminOnWindows') {
BeforeAll {
if ($IsNotSkipped)
{
$parmMap = @{
# values for PSSessionConfigFile
PowerShellVersion = '3.0'
SessionType = 'Default'
Author = 'User'
CompanyName = 'Microsoft Corporation'
Copyright = 'Copyright (c) Microsoft Corporation.'
Description = 'This is a sample session configuration file.'
GUID = '73cba863-aa49-4cbf-9917-269ddcf2b1e3'
SchemaVersion = '1.0.0.0'
# The scope of the test is to validate that a valid SessionConfigurationFile can be validated
# The test does not register the session configuration from the created session configuration file.
# The SCRATCH location is not validated.
EnvironmentVariables = @{
PSModulePath = '$Env:PSModulePath + ";$env:SystemDrive\ProgramData"';
SCRATCH = "\\SomeValidRemoteShare\SharedLocation"
}
# The scope of the test is to validate that a valid SessionConfigurationFile can be validated
# The test does not register the session configuration from the created session configuration file.
# The AssembliesToLoad are not loaded by this test. The Test only validates that the supplied data
# is used to create a valid Session configuration file.
AssembliesToLoad = 'SomeValidBinary.dll'
# The same explanation as above holds good here.
ModulesToImport = 'SomeValidModule'
AliasDefinitions = @(
@{
Name = "gh";
Value = "Get-Help";
Description = "Gets the help";
Options = "AllScope";
},
@{
Name = "sh";
Value = "Save-Help";
Description = "Saves the help";
Options = "Private";
},
@{
Name = "uh";
Value = "Update-Help";
Description = "Updates the help";
Options = "ReadOnly";
}
)
FunctionDefinitions=@(
@{
Name = "sysmodules";
ScriptBlock = 'pushd $PSHOME\Modules';
Options = "AllScope";
},
@{
Name = "mymodules";
ScriptBlock = 'pushd $HOME\Documents\WindowsPowerShell\Modules';
Options = "ReadOnly";
}
)
VariableDefinitions = @(
@{
Name = "WarningPreference";
Value = "SilentlyContinue";
},
@{
Name = "datahome";
Value = "\\fileserver\share\data";
},
@{
Name = "allusershome";
Value = '$env:ProgramData'
}
)
# The scope of the test is to validate that a valid SessionConfigurationFile can be validated
# The test does not register the session configuration from the created session configuration file.
# The existance of the files supplied as input to TypesToProcess, FormatsToProcess, ScriptsToProcess
# are not validated while creating a valid session configurtation file.
# The Test only validates that the supplied data can be successfully used to create a valid Session configuration file.
TypesToProcess = '$env:SystemDrive\SampleTypesFile.ps1xml'
FormatsToProcess = '$env:SystemDrive\SampleFormatsFile.ps1xml'
ScriptsToProcess = '$env:SystemDrive\SampleScript.ps1'
VisibleAliases = "c*","g*","i*","s*"
VisibleCmdlets = "c*","get*","i*","set*"
VisibleFunctions = "*"
VisibleProviders = 'FileSystem','Function','Registry','Variable'
VisibleVariables = "*"
LanguageMode = "RestrictedLanguage"
ExecutionPolicy = "AllSigned"
}
}
}
It "Validate FullyQualifiedErrorId from Test-PSSessionConfigurationFile when invalid path is provided as input" {
{ Test-PSSessionConfigurationFile "cert:\foo.pssc" -ErrorAction Stop } | Should -Throw -ErrorId "PSSessionConfigurationFileNotFound,Microsoft.PowerShell.Commands.TestPSSessionConfigurationFileCommand"
}
It "Validate FullyQualifiedErrorId from Test-PSSessionConfigurationFile when an invalid pssc file is provided as input and -Verbose parameter is specified" {
$configFilePath = Join-Path $TestDrive "SamplePSSessionConfigurationFile.pssc"
"InvalidData" | Out-File $configFilePath
Test-PSSessionConfigurationFile $configFilePath -Verbose -ErrorAction Stop | Should -BeFalse
}
It "Test case verifies that the generated config file passes validation" {
# Path the config file
$configFilePath = Join-Path $TestDrive "SamplePSSessionConfigurationFile.pssc"
$updatedFunctionDefn = @()
foreach($currentDefination in $parmMap.FunctionDefinitions)
{
$createdFunctionDefn = @{}
foreach($currentDefinationKey in $currentDefination.Keys)
{
if($currentDefinationKey -eq "ScriptBlock")
{
$value = [ScriptBlock]::Create($currentDefination[$currentDefinationKey])
}
else
{
$value = $currentDefination[$currentDefinationKey]
}
$createdFunctionDefn.Add($currentDefinationKey, $value)
}
$updatedFunctionDefn += $createdFunctionDefn
}
$updatedVariableDefn = @()
foreach($currentDefination in $parmMap.VariableDefinitions)
{
$createdVariableDefn = @{}
foreach($currentDefinationKey in $currentDefination.Keys)
{
$createdVariableDefn.Add($currentDefinationKey, $currentDefination[$currentDefinationKey])
}
$updatedVariableDefn += $createdVariableDefn
}
try
{
# Create Config file
New-PSSessionConfigurationFile `
-Path $configFilePath `
-SchemaVersion $parmMap.SchemaVersion `
-Author $parmMap.Author `
-CompanyName $parmMap.CompanyName `
-Copyright $parmMap.Copyright `
-Description $parmMap.Description `
-PowerShellVersion $parmMap.PowerShellVersion `
-SessionType $parmMap.SessionType `
-ModulesToImport $parmMap.ModulesToImport `
-AssembliesToLoad $parmMap.AssembliesToLoad `
-VisibleAliases $parmMap.VisibleAliases `
-VisibleCmdlets $parmMap.VisibleCmdlets `
-VisibleFunctions $parmMap.VisibleFunctions `
-VisibleProviders $parmMap.VisibleProviders `
-AliasDefinitions $parmMap.AliasDefinitions `
-FunctionDefinitions $updatedFunctionDefn `
-VariableDefinitions $updatedVariableDefn `
-EnvironmentVariables $parmMap.EnvironmentVariables `
-TypesToProcess $parmMap.TypesToProcess `
-FormatsToProcess $parmMap.FormatsToProcess `
-LanguageMode $parmMap.LanguageMode `
-ExecutionPolicy $parmMap.ExecutionPolicy `
-ScriptsToProcess $parmMap.ScriptsToProcess `
-GUID $parmMap.GUID
# Verify the generated config file using the Test-PSSessionConfigurationFile
$result = Test-PSSessionConfigurationFile -Path $configFilePath -Verbose
}
finally
{
if(Test-Path $configFilePath)
{
Remove-Item $configFilePath -Force
}
}
$result | Should -BeTrue
}
}
Describe "Validate Enable-PSSession Cmdlet" -Tags @("Feature", 'RequireAdminOnWindows') {
BeforeAll {
if (Test-IsWindowsArm64) {
Write-Verbose "remoting is not setup on ARM64, skipping tests" -Verbose
Push-DefaultParameterValueStack @{ "it:skip" = $true }
return
}
if ($IsNotSkipped) {
Enable-PSRemoting -SkipNetworkProfileCheck -Force
}
}
AfterAll {
if (Test-IsWindowsArm64) {
Pop-DefaultParameterValueStack
}
}
It "Enable-PSSession Cmdlet creates a PSSession configuration with a name tied to PowerShell version." {
$endpointName = "PowerShell." + $PSVersionTable.GitCommitId.ToString()
$matchedEndpoint = Get-PSSessionConfiguration $endpointName -ErrorAction SilentlyContinue
$matchedEndpoint | Should -Not -BeNullOrEmpty
}
It "Enable-PSSession Cmdlet creates a default PSSession configuration untied to a specific PowerShell version." {
$dotPos = $PSVersionTable.PSVersion.ToString().IndexOf(".")
$endpointName = "PowerShell." + $PSVersionTable.PSVersion.ToString().Substring(0, $dotPos)
# any pre-release (a version with a dash) is a preview release
if ($PSVersionTable.GitCommitId.Contains("-"))
{
$endpointName += "-preview"
}
$matchedEndpoint = Get-PSSessionConfiguration $endpointName -ErrorAction SilentlyContinue
$matchedEndpoint | Should -Not -BeNullOrEmpty
}
}
}
finally
{
Pop-DefaultParameterValueStack
$WarningPreference = $originalWarningPreference
}
|