File size: 15,220 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 | # Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
Describe "SSHRemoting Basic Tests" -tags CI {
# SSH remoting is set up to automatically authenticate current user via SSH keys
# All tests connect back to localhost machine
$script:TestConnectingTimeout = 5000 # Milliseconds
function RestartSSHDService
{
if ($IsWindows)
{
Write-Verbose -Verbose "Restarting Windows SSHD service..."
Restart-Service sshd
Write-Verbose -Verbose "SSHD service status: $(Get-Service sshd | Out-String)"
}
else
{
Write-Verbose -Verbose "Restarting Unix SSHD service..."
sudo service ssh restart
$status = sudo service ssh status
Write-Verbose -Verbose "SSHD service status: $status"
}
}
function TryNewPSSession
{
param(
[string[]] $HostName,
[string[]] $Name,
[int] $Port,
[string] $UserName,
[string] $KeyFilePath,
[string] $Subsystem
)
Write-Verbose -Verbose "Starting TryNewPSSession ..."
# Try creating a new SSH connection
$timeout = $script:TestConnectingTimeout
$connectionError = $null
$session = $null
$count = 0
while (($null -eq $session) -and ($count++ -lt 2))
{
$session = New-PSSession @PSBoundParameters -ConnectingTimeout $timeout -ErrorVariable connectionError -ErrorAction SilentlyContinue
if ($null -eq $session)
{
Write-Verbose -Verbose "SSH New-PSSession remoting connect failed."
if ($count -eq 1)
{
# Try restarting sshd service
RestartSSHDService
}
}
}
if ($null -eq $session)
{
$message = "New-PSSession unable to connect to SSH remoting endpoint after two attempts. Error: $($connectionError.Exception.Message)"
throw [System.Management.Automation.PSInvalidOperationException]::new($message)
}
Write-Verbose -Verbose "SSH New-PSSession remoting connect succeeded."
Write-Output $session
}
function TryNewPSSessionHash
{
param (
[hashtable[]] $SSHConnection,
[string[]] $Name
)
Write-Verbose -Verbose "Starting TryNewPSSessionHash ..."
foreach ($connect in $SSHConnection)
{
$connect.Add('ConnectingTimeout', $script:TestConnectingTimeout)
}
# Try creating a new SSH connection
$connectionError = $null
$session = $null
$count = 0
while (($null -eq $session) -and ($count++ -lt 2))
{
$session = New-PSSession @PSBoundParameters -ErrorVariable connectionError -ErrorAction SilentlyContinue
if ($null -eq $session)
{
Write-Verbose -Verbose "SSH New-PSSession remoting connect failed."
if ($count -eq 1)
{
# Try restarting sshd service
RestartSSHDService
}
}
}
if ($null -eq $session)
{
$message = "New-PSSession unable to connect to SSH remoting endpoint after two attempts. Error: $($connectionError.Exception.Message)"
throw [System.Management.Automation.PSInvalidOperationException]::new($message)
}
Write-Verbose -Verbose "SSH New-PSSession remoting connect succeeded."
Write-Output $session
}
function VerifySession {
param (
[System.Management.Automation.Runspaces.PSSession] $session
)
if ($null -eq $session)
{
return
}
Write-Verbose -Verbose "VerifySession called for session: $($session.Id)"
$session.State | Should -BeExactly 'Opened'
$session.ComputerName | Should -BeExactly 'localhost'
$session.Transport | Should -BeExactly 'SSH'
Write-Verbose -Verbose "Invoking whoami"
Invoke-Command -Session $session -ScriptBlock { whoami } | Should -BeExactly $(whoami)
Write-Verbose -Verbose "Invoking PSSenderInfo"
$psRemoteVersion = Invoke-Command -Session $session -ScriptBlock { $PSSenderInfo.ApplicationArguments.PSVersionTable.PSVersion }
$psRemoteVersion.Major | Should -BeExactly $PSVersionTable.PSVersion.Major
$psRemoteVersion.Minor | Should -BeExactly $PSVersionTable.PSVersion.Minor
Write-Verbose -Verbose "VerifySession complete"
}
Context "New-PSSession Tests" {
AfterEach {
Write-Verbose -Verbose "Starting New-PSSession AfterEach"
if ($script:session -ne $null) { Remove-PSSession -Session $script:session }
if ($script:sessions -ne $null) { Remove-PSSession -Session $script:sessions }
Write-Verbose -Verbose "AfterEach complete"
}
It "Verifies new connection with implicit current User" {
Write-Verbose -Verbose "It Starting: Verifies new connection with implicit current User"
$script:session = TryNewPSSession -HostName localhost
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
Write-Verbose -Verbose "It Complete"
}
It "Verifies new connection with explicit User parameter" {
Write-Verbose -Verbose "It Starting: Verifies new connection with explicit User parameter"
$script:session = TryNewPSSession -HostName localhost -UserName (whoami)
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
Write-Verbose -Verbose "It Complete"
}
It "Verifies explicit Name parameter" {
Write-Verbose -Verbose "It Starting: Verifies explicit Name parameter"
$sessionName = 'TestSessionNameA'
$script:session = TryNewPSSession -HostName localhost -Name $sessionName
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
$script:session.Name | Should -BeExactly $sessionName
Write-Verbose -Verbose "It Complete"
}
It "Verifies explicit Port parameter" {
Write-Verbose -Verbose "It Starting: Verifies explicit Port parameter"
$portNum = 22
$script:session = TryNewPSSession -HostName localhost -Port $portNum
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
Write-Verbose -Verbose "It Complete"
}
It "Verifies explicit Options parameter" {
$options = @{"Port"="22"}
$script:session = New-PSSession -HostName localhost -Options $options -ErrorVariable err
$err | Should -HaveCount 0
VerifySession $script:session
}
It "Verifies explicit Subsystem parameter" {
Write-Verbose -Verbose "It Starting: Verifies explicit Subsystem parameter"
$portNum = 22
$subSystem = 'powershell'
$script:session = TryNewPSSession -HostName localhost -Port $portNum -SubSystem $subSystem
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
Write-Verbose -Verbose "It Complete"
}
It "Verifies explicit KeyFilePath parameter" {
Write-Verbose -Verbose "It Starting: Verifies explicit KeyFilePath parameter"
$keyFilePath = "$HOME/.ssh/id_rsa"
$portNum = 22
$subSystem = 'powershell'
$script:session = TryNewPSSession -HostName localhost -Port $portNum -SubSystem $subSystem -KeyFilePath $keyFilePath
$script:session | Should -Not -BeNullOrEmpty
VerifySession $script:session
Write-Verbose -Verbose "It Complete"
}
It "Verifies SSHConnection hash table parameters" {
Write-Verbose -Verbose "It Starting: Verifies SSHConnection hash table parameters"
$sshConnection = @(
@{
HostName = 'localhost'
UserName = whoami
Port = 22
KeyFilePath = "$HOME/.ssh/id_rsa"
Subsystem = 'powershell'
},
@{
HostName = 'localhost'
KeyFilePath = "$HOME/.ssh/id_rsa"
Subsystem = 'powershell'
})
$script:sessions = TryNewPSSessionHash -SSHConnection $sshConnection -Name 'Connection1','Connection2'
$script:sessions | Should -HaveCount 2
$script:sessions[0].Name | Should -BeLike 'Connection*'
$script:sessions[1].Name | Should -BeLike 'Connection*'
VerifySession $script:sessions[0]
VerifySession $script:sessions[1]
Write-Verbose -Verbose "It Complete"
}
It "Verifies the 'pwshconfig' configured endpoint." {
Write-Verbose -Verbose "It Starting: Verifies the 'pwshconfig' configured endpoint."
$script:session = TryNewPSSession -HostName localhost -Subsystem 'pwshconfig'
$script:session | Should -Not -BeNullOrEmpty
# Configured session should be in ConstrainedLanguage mode.
$sessionLangMode = Invoke-Command -Session $script:session -ScriptBlock { "$($ExecutionContext.SessionState.LanguageMode)" }
$sessionLangMode | Should -BeExactly "ConstrainedLanguage"
Write-Verbose -Verbose "It Complete"
}
<#
It "Verifes that 'pwshbroken' throws expected error for missing config file." {
Write-Verbose -Verbose "It Starting: Verifes that 'pwshbroken' throws expected error for missing config file."
{ $script:session = TryNewPSSession -HostName localhost -Subsystem 'pwshbroken' } | Should -Throw
$script:session = $null
Write-Verbose -Verbose "It Complete"
}
#>
}
function TryCreateRunspace
{
param (
[string] $UserName,
[string] $ComputerName,
[string] $KeyFilePath,
[int] $Port,
[string] $Subsystem
)
Write-Verbose -Verbose "Starting TryCreateRunspace ..."
$timeout = $script:TestConnectingTimeout
$connectionError = $null
$count = 0
$rs = $null
$ci = [System.Management.Automation.Runspaces.SSHConnectionInfo]::new($UserName, $ComputerName, $KeyFilePath, $Port, $Subsystem, $timeout)
while (($null -eq $rs) -and ($count++ -lt 2))
{
try
{
$rs = [runspacefactory]::CreateRunspace($host, $ci)
$null = $rs.Open()
}
catch
{
$connectionError = $_
$rs = $null
Write-Verbose -Verbose "SSH Runspace Open remoting connect failed."
if ($count -eq 1)
{
# Try restarting sshd service
RestartSSHDService
}
}
}
if (($null -eq $rs) -or !($rs -is [runspace]))
{
$message = "Runspace open unable to connect to SSH remoting endpoint after two attempts. Error: $($connectionError.Message)"
throw [System.Management.Automation.PSInvalidOperationException]::new($message)
}
Write-Verbose -Verbose "SSH Runspace Open remoting connect succeeded."
Write-Output $rs
}
function VerifyRunspace {
param (
[runspace] $rs
)
if ($null -eq $rs)
{
return
}
Write-Verbose -Verbose "VerifyRunspace called for runspace: $($rs.Id)"
$rs.RunspaceStateInfo.State | Should -BeExactly 'Opened'
$rs.RunspaceAvailability | Should -BeExactly 'Available'
$rs.RunspaceIsRemote | Should -BeTrue
$ps = [powershell]::Create()
try
{
Write-Verbose -Verbose "VerifyRunspace: Invoking PSSenderInfo"
$ps.Runspace = $rs
$psRemoteVersion = $ps.AddScript('$PSSenderInfo.ApplicationArguments.PSVersionTable.PSVersion').Invoke()
$psRemoteVersion.Major | Should -BeExactly $PSVersionTable.PSVersion.Major
$psRemoteVersion.Minor | Should -BeExactly $PSVersionTable.PSVersion.Minor
$ps.Commands.Clear()
Write-Verbose -Verbose "VerifyRunspace: Invoking whoami"
$ps.AddScript('whoami').Invoke() | Should -BeExactly $(whoami)
Write-Verbose -Verbose "VerifyRunspace complete"
}
finally
{
$ps.Dispose()
}
}
Context "SSH Remoting API Tests" {
AfterEach {
Write-Verbose -Verbose "Starting Runspace close AfterEach"
if (($script:rs -ne $null) -and ($script:rs -is [runspace])) { $script:rs.Dispose() }
Write-Verbose -Verbose "AfterEach complete"
}
$testCases = @(
@{
testName = 'Verifies connection with implicit user'
UserName = $null
ComputerName = 'localhost'
KeyFilePath = $null
Port = 0
Subsystem = $null
},
@{
testName = 'Verifies connection with UserName'
UserName = whoami
ComputerName = 'localhost'
KeyFilePath = $null
Port = 0
Subsystem = $null
},
@{
testName = 'Verifies connection with KeyFilePath'
UserName = whoami
ComputerName = 'localhost'
KeyFilePath = "$HOME/.ssh/id_rsa"
Port = 0
Subsystem = $null
},
@{
testName = 'Verifies connection with Port specified'
UserName = whoami
ComputerName = 'localhost'
KeyFilePath = "$HOME/.ssh/id_rsa"
Port = 22
Subsystem = $null
},
@{
testName = 'Verifies connection with Subsystem specified'
UserName = whoami
ComputerName = 'localhost'
KeyFilePath = "$HOME/.ssh/id_rsa"
Port = 22
Subsystem = 'powershell'
}
)
It "<testName>" -TestCases $testCases {
param (
$UserName,
$ComputerName,
$KeyFilePath,
$Port,
$SubSystem,
$TestName
)
Write-Verbose -Verbose "It Starting: $TestName"
$script:rs = TryCreateRunspace -UserName $UserName -ComputerName $ComputerName -KeyFilePath $KeyFilePath -Port $Port -Subsystem $Subsystem
$script:rs | Should -Not -BeNullOrEmpty
VerifyRunspace $script:rs
Write-Verbose -Verbose "It Complete"
}
}
}
|