Expand test suite (#787)

* add -T/-t pester tests

* configure default shell for scp and sftp

* fix syntax

* fix scp test

* refactor default shell tests

* fix typos

* fix ssh tests

* fix sftp tests

* fix ssh test

* move force pty test to separate pester test file

* fix initialization

* Update SSH.Tests.ps1

* fix skip parameter

* move duplicated function to common module file

* Update CommonUtils.psm1

* fix typo

* revert spacing for clearer diff

* fix spacing

Author: tgauth

contrib/win32/openssh/AzDOBuildTools/AzDOBuildTools.psm1

@@ -218,31 +218,9 @@ function Invoke-OpenSSHTests
     # Run all E2E tests.
     Write-Verbose -Verbose -Message "Running E2E Tests..."
     Set-OpenSSHTestEnvironment -Confirm:$false
-    Invoke-OpenSSHE2ETest
-    if (($OpenSSHTestInfo -eq $null) -or (-not (Test-Path $OpenSSHTestInfo["E2ETestResultsFile"])))
-    {
-        Write-BuildMessage -Message "Test result file $OpenSSHTestInfo["E2ETestResultsFile"] not found after tests." -Category Error
-        $AllTestsPassed =  $false
-    }
-    else
-    {
-        $xml = [xml](Get-Content $OpenSSHTestInfo["E2ETestResultsFile"] | out-string)
-        if ([int]$xml.'test-results'.failures -gt 0)
-        {
-            $errorMessage = "$($xml.'test-results'.failures) E2E tests in regress\pesterTests failed. Detail test log is at $($OpenSSHTestInfo["E2ETestResultsFile"])."
-            Write-BuildMessage -Message $errorMessage -Category Error
-            $AllTestsPassed = $false
-        }
-        else
-        {
-            Write-BuildMessage -Message "All E2E tests passed!" -Category Information
-        }
-    }
-
-    # Bash tests.
-    Write-Verbose -Verbose -Message "Running Bash Tests..."
 
     # Ensure CygWin is installed, and install from Chocolatey if needed.
+    # used for bash tests and default shell pester tests
     $cygwinInstalled = $true
     $cygwinInstallLocation = "$env:SystemDrive/cygwin"
     if (! (Test-Path -Path "$cygwinInstallLocation/bin/sh.exe"))
@@ -269,9 +247,33 @@ function Invoke-OpenSSHTests
         }
     }
 
-    # Run UNIX bash tests.
     if ($cygwinInstalled)
     {
+        Invoke-OpenSSHE2ETest
+        if (($OpenSSHTestInfo -eq $null) -or (-not (Test-Path $OpenSSHTestInfo["E2ETestResultsFile"])))
+        {
+            Write-BuildMessage -Message "Test result file $OpenSSHTestInfo["E2ETestResultsFile"] not found after tests." -Category Error
+            $AllTestsPassed =  $false
+        }
+        else
+        {
+            $xml = [xml](Get-Content $OpenSSHTestInfo["E2ETestResultsFile"] | out-string)
+            if ([int]$xml.'test-results'.failures -gt 0)
+            {
+                $errorMessage = "$($xml.'test-results'.failures) E2E tests in regress\pesterTests failed. Detail test log is at $($OpenSSHTestInfo["E2ETestResultsFile"])."
+                Write-BuildMessage -Message $errorMessage -Category Error
+                $AllTestsPassed = $false
+            }
+            else
+            {
+                Write-BuildMessage -Message "All E2E tests passed!" -Category Information
+            }
+        }
+
+        # Bash tests.
+        Write-Verbose -Verbose -Message "Running Bash Tests..."
+
+        # Run UNIX bash tests.
         Write-Verbose -Verbose -Message "Starting Bash Tests..."
         Invoke-OpenSSHBashTests
         if (-not $Global:bash_tests_summary)

regress/pesterTests/CommonUtils.psm1

@@ -10,7 +10,7 @@ Add-Type -TypeDefinition @"
 "@
 
 function Set-FilePermission
-{    
+{
     param(
         [parameter(Mandatory=$true)]
         [string]$FilePath,
@@ -20,7 +20,7 @@ function Set-FilePermission
         [System.Security.AccessControl.AccessControlType] $AccessType = "Allow",
         [ValidateSet("Add", "Delete")]
         [string]$Action = "Add"
-    )    
+    )
 
     $myACL = Get-ACL $FilePath
     $account = Get-UserAccount -UserSid $UserSid
@@ -30,9 +30,9 @@ function Set-FilePermission
         Enable-Privilege SeRestorePrivilege | out-null
         Set-Acl -Path $FilePath -AclObject $myACL
         $myACL = Get-ACL $FilePath
-        
-        if($myACL.Access) 
-        {        
+
+        if($myACL.Access)
+        {
             $myACL.Access | % {
                 if($_.IdentityReference.Equals($account))
                 {
@@ -43,18 +43,18 @@ function Set-FilePermission
                         Set-Acl -Path $FilePath -AclObject $myACL
                         $myACL = Get-ACL $FilePath
                     }
-                    
+
                     if(-not ($myACL.RemoveAccessRule($_)))
                     {
                         throw "failed to remove access of $($_.IdentityReference) rule in setup "
                     }
                 }
             }
-        } 
+        }
     }
     elseif($Perms)
     {
-        $Perms | % { 
+        $Perms | % {
             $userACE = New-Object System.Security.AccessControl.FileSystemAccessRule `
                 ($UserSid, $_, "None", "None", $AccessType)
             $myACL.AddAccessRule($userACE)
@@ -64,7 +64,7 @@ function Set-FilePermission
     Set-Acl -Path $FilePath -AclObject $myACL -confirm:$false
 }
 
-function Add-PasswordSetting 
+function Add-PasswordSetting
 {
     param([string] $pass)
     if ($IsWindows) {
@@ -86,17 +86,17 @@ function Remove-PasswordSetting
 
 $Taskfolder = "\OpenSSHTestTasks\"
 $Taskname = "StartTestDaemon"
-        
+
 function Start-SSHDTestDaemon
 {
     param(
     [string] $Arguments,
     [string] $Workdir,
-    [string] $Port)    
+    [string] $Port)
 
     $Arguments += " -p $Port"
     $ac = New-ScheduledTaskAction -Execute (join-path $workdir "sshd") -WorkingDirectory $workdir -Argument $Arguments
-    $task = Register-ScheduledTask -TaskName $Taskname -User system -Action $ac -TaskPath $Taskfolder -Force    
+    $task = Register-ScheduledTask -TaskName $Taskname -User system -Action $ac -TaskPath $Taskfolder -Force
     Start-ScheduledTask -TaskPath $Taskfolder -TaskName $Taskname
     #sleep for 1 seconds for process to ready to listener
     $num = 0
@@ -111,25 +111,25 @@ function Start-SSHDTestDaemon
 function Stop-SSHDTestDaemon
 {
     param(
-    [string] $Port) 
+    [string] $Port)
 
     $task = Get-ScheduledTask -TaskPath $Taskfolder -TaskName $Taskname -ErrorAction SilentlyContinue
     if($task)
     {
         if($task.State -eq "Running")
         {
             Stop-ScheduledTask -TaskPath $Taskfolder -TaskName $Taskname
-        }        
+        }
         Unregister-ScheduledTask -TaskPath $Taskfolder -TaskName $Taskname -Confirm:$false
     }
 
     #kill process listening on $Port
     $p = netstat -anop TCP | select-string -Pattern "0.0.0.0:$Port"
-    if (-not($p -eq $null)) 
+    if (-not($p -eq $null))
     {
         foreach ($ps in $p) {
-            $pss =$ps.ToString() -split "\s+"; 
-            $processid = $pss[$pss.length -1] 
+            $pss =$ps.ToString() -split "\s+";
+            $processid = $pss[$pss.length -1]
             Stop-Process -Id $processid -Force -ErrorAction SilentlyContinue
         }
         #if still running, wait a little while for task to complete
@@ -142,4 +142,22 @@ function Stop-SSHDTestDaemon
         }
     }
 
-}
+}
+
+function ConfigureDefaultShell {
+    param
+    (
+          [string] $default_shell_path,
+          [string] $dfltShellRegPath = "HKLM:\Software\OpenSSH",
+          [string] $dfltShellRegKeyName = "DefaultShell",
+          [string] $dfltShellCmdOptionRegKeyName = "DefaultShellCommandOption",
+          [string] $default_shell_cmd_option_val = $null
+    )
+    if (!(Test-Path $dfltShellRegPath)) {
+        New-Item -Path $dfltShellRegPath -Force | Out-Null
+    }
+    New-ItemProperty -Path $dfltShellRegPath -Name $dfltShellRegKeyName -Value $default_shell_path -PropertyType String -Force
+    if ($default_shell_cmd_option_val -ne $null) {
+        New-ItemProperty -Path $dfltShellRegPath -Name $dfltShellCmdOptionRegKeyName -Value $default_shell_cmd_option_val -PropertyType String -Force
+    }
+}