mirror of
https://github.com/PowerShell/openssh-portable.git
synced 2025-08-25 19:58:33 +02:00
ec3eb7a088
1. Fix issue install-sshd.ps1 failed on Nano 2. Update settings of services in install-sshd.ps1 to match windows inbox 3. added setup tests and update the test helper scripts to run setup tests before changing configurations on the machine 4. added uninstallation tests
422 lines
14 KiB
PowerShell
422 lines
14 KiB
PowerShell
$ErrorActionPreference = 'Stop'
|
|
Set-StrictMode -Version 2.0
|
|
If ($PSVersiontable.PSVersion.Major -le 2) {$PSScriptRoot = Split-Path -Parent $MyInvocation.MyCommand.Path}
|
|
Import-Module $PSScriptRoot\OpenSSHCommonUtils.psm1 -Force
|
|
Import-Module $PSScriptRoot\OpenSSHBuildHelper.psm1 -Force
|
|
Import-Module $PSScriptRoot\OpenSSHTestHelper.psm1 -Force
|
|
|
|
$repoRoot = Get-RepositoryRoot
|
|
$script:messageFile = join-path $repoRoot.FullName "BuildMessage.log"
|
|
|
|
# Write the build message
|
|
Function Write-BuildMessage
|
|
{
|
|
param(
|
|
[Parameter(Mandatory=$true)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[string] $Message,
|
|
$Category,
|
|
[string] $Details)
|
|
|
|
if($env:AppVeyor)
|
|
{
|
|
Add-AppveyorMessage @PSBoundParameters
|
|
}
|
|
|
|
# write it to the log file, if present.
|
|
if (-not ([string]::IsNullOrEmpty($script:messageFile)))
|
|
{
|
|
Add-Content -Path $script:messageFile -Value "$Category--$Message"
|
|
}
|
|
}
|
|
|
|
# Sets a build variable
|
|
Function Set-BuildVariable
|
|
{
|
|
param(
|
|
[Parameter(Mandatory=$true)]
|
|
[string]
|
|
$Name,
|
|
|
|
[Parameter(Mandatory=$true)]
|
|
[string]
|
|
$Value
|
|
)
|
|
|
|
if($env:AppVeyor -and (Get-Command Set-AppveyorBuildVariable -ErrorAction Ignore) -ne $null)
|
|
{
|
|
Set-AppveyorBuildVariable @PSBoundParameters
|
|
}
|
|
elseif($env:AppVeyor)
|
|
{
|
|
appveyor SetVariable -Name $Name -Value $Value
|
|
}
|
|
else
|
|
{
|
|
Set-Item env:$Name -Value $Value
|
|
}
|
|
}
|
|
|
|
# Emulates running all of AppVeyor but locally
|
|
# should not be used on AppVeyor
|
|
function Invoke-AppVeyorFull
|
|
{
|
|
param(
|
|
[switch] $APPVEYOR_SCHEDULED_BUILD,
|
|
[switch] $CleanRepo
|
|
)
|
|
if($CleanRepo)
|
|
{
|
|
Clear-PSRepo
|
|
}
|
|
|
|
if($env:APPVEYOR)
|
|
{
|
|
throw "This function is to simulate appveyor, but not to be run from appveyor!"
|
|
}
|
|
|
|
if($APPVEYOR_SCHEDULED_BUILD)
|
|
{
|
|
$env:APPVEYOR_SCHEDULED_BUILD = 'True'
|
|
}
|
|
try {
|
|
Invoke-AppVeyorBuild
|
|
Install-OpenSSH
|
|
Set-OpenSSHTestEnvironment -confirm:$false
|
|
Invoke-OpenSSHTests
|
|
Publish-Artifact
|
|
}
|
|
finally {
|
|
if($APPVEYOR_SCHEDULED_BUILD -and $env:APPVEYOR_SCHEDULED_BUILD)
|
|
{
|
|
Remove-Item env:APPVEYOR_SCHEDULED_BUILD
|
|
}
|
|
}
|
|
}
|
|
|
|
# Implements the AppVeyor 'build_script' step
|
|
function Invoke-AppVeyorBuild
|
|
{
|
|
Set-BuildVariable TestPassed True
|
|
Start-OpenSSHBuild -Configuration Release -NativeHostArch x64
|
|
Start-OpenSSHBuild -Configuration Release -NativeHostArch x86
|
|
Write-BuildMessage -Message "OpenSSH binaries build success!" -Category Information
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
Adds a build log to the list of published artifacts.
|
|
.Description
|
|
If a build log exists, it is renamed to reflect the associated CLR runtime then added to the list of
|
|
artifacts to publish. If it doesn't exist, a warning is written and the file is skipped.
|
|
The rename is needed since publishing overwrites the artifact if it already exists.
|
|
.Parameter artifacts
|
|
An array list to add the fully qualified build log path
|
|
.Parameter buildLog
|
|
The build log file produced by the build.
|
|
#>
|
|
function Add-BuildLog
|
|
{
|
|
param
|
|
(
|
|
[ValidateNotNull()]
|
|
[System.Collections.ArrayList] $artifacts,
|
|
|
|
[Parameter(Mandatory=$true)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[string] $buildLog
|
|
)
|
|
|
|
if (Test-Path -Path $buildLog)
|
|
{
|
|
$null = $artifacts.Add($buildLog)
|
|
}
|
|
else
|
|
{
|
|
Write-Warning "Skip publishing build log. $buildLog does not exist"
|
|
}
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
Deploy all required files to a location and install the binaries
|
|
#>
|
|
function Install-OpenSSH
|
|
{
|
|
[CmdletBinding()]
|
|
param
|
|
(
|
|
[ValidateSet('Debug', 'Release')]
|
|
[string]$Configuration = "Release",
|
|
|
|
[ValidateSet('x86', 'x64', '')]
|
|
[string]$NativeHostArch = "",
|
|
|
|
[string]$OpenSSHDir = "$env:SystemDrive\OpenSSH"
|
|
)
|
|
|
|
if ($NativeHostArch -eq "")
|
|
{
|
|
$NativeHostArch = 'x64'
|
|
if ($env:PROCESSOR_ARCHITECTURE -eq 'x86') {
|
|
$NativeHostArch = 'x86'
|
|
}
|
|
}
|
|
UnInstall-OpenSSH -OpenSSHDir $OpenSSHDir
|
|
|
|
Start-OpenSSHPackage -NativeHostArch $NativeHostArch -Configuration $Configuration -DestinationPath $OpenSSHDir
|
|
|
|
Push-Location $OpenSSHDir
|
|
& "$OpenSSHDir\install-sshd.ps1"
|
|
|
|
$machinePath = [Environment]::GetEnvironmentVariable('Path', 'MACHINE')
|
|
$newMachineEnvironmentPath = $machinePath
|
|
if (-not ($machinePath.ToLower().Contains($OpenSSHDir.ToLower())))
|
|
{
|
|
$newMachineEnvironmentPath = "$OpenSSHDir;$newMachineEnvironmentPath"
|
|
$env:Path = "$OpenSSHDir;$env:Path"
|
|
}
|
|
# Update machine environment path
|
|
if ($newMachineEnvironmentPath -ne $machinePath)
|
|
{
|
|
[Environment]::SetEnvironmentVariable('Path', $newMachineEnvironmentPath, 'MACHINE')
|
|
}
|
|
|
|
Start-Service -Name sshd
|
|
Start-Service -Name ssh-agent
|
|
|
|
Pop-Location
|
|
Write-BuildMessage -Message "OpenSSH installed!" -Category Information
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
uninstalled sshd
|
|
#>
|
|
function UnInstall-OpenSSH
|
|
{
|
|
[CmdletBinding()]
|
|
param
|
|
(
|
|
[string]$OpenSSHDir = "$env:SystemDrive\OpenSSH"
|
|
)
|
|
|
|
if (-not (Test-Path $OpenSSHDir -PathType Container))
|
|
{
|
|
return
|
|
}
|
|
|
|
Push-Location $OpenSSHDir
|
|
if((Get-Service ssh-agent -ErrorAction SilentlyContinue) -ne $null) {
|
|
Stop-Service ssh-agent -Force
|
|
}
|
|
& "$OpenSSHDir\uninstall-sshd.ps1"
|
|
|
|
$machinePath = [Environment]::GetEnvironmentVariable('Path', 'MACHINE')
|
|
$newMachineEnvironmentPath = $machinePath
|
|
if ($machinePath.ToLower().Contains($OpenSSHDir.ToLower()))
|
|
{
|
|
$newMachineEnvironmentPath = $newMachineEnvironmentPath.Replace("$OpenSSHDir;", '')
|
|
$env:Path = $env:Path.Replace("$OpenSSHDir;", '')
|
|
}
|
|
|
|
if ($newMachineEnvironmentPath -ne $machinePath)
|
|
{
|
|
[Environment]::SetEnvironmentVariable('Path', $newMachineEnvironmentPath, 'MACHINE')
|
|
}
|
|
|
|
Pop-Location
|
|
Remove-Item -Path $OpenSSHDir -Recurse -Force -ErrorAction SilentlyContinue
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
Publishes package build artifacts.
|
|
.Parameter artifacts
|
|
An array list to add the fully qualified build log path
|
|
.Parameter FileToAdd
|
|
Path to the file
|
|
#>
|
|
function Add-Artifact
|
|
{
|
|
param
|
|
(
|
|
[ValidateNotNull()]
|
|
[System.Collections.ArrayList] $artifacts,
|
|
[string] $FileToAdd
|
|
)
|
|
|
|
if ([string]::IsNullOrEmpty($FileToAdd) -or (-not (Test-Path $FileToAdd -PathType Leaf)) )
|
|
{
|
|
Write-Host "Skip publishing package artifacts. $FileToAdd does not exist"
|
|
}
|
|
else
|
|
{
|
|
$null = $artifacts.Add($FileToAdd)
|
|
}
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
After build and test run completes, upload all artifacts from the build machine.
|
|
#>
|
|
function Publish-Artifact
|
|
{
|
|
Write-Host -ForegroundColor Yellow "Publishing project artifacts"
|
|
[System.Collections.ArrayList] $artifacts = new-object System.Collections.ArrayList
|
|
|
|
# Get the build.log file for each build configuration
|
|
Add-BuildLog -artifacts $artifacts -buildLog (Get-BuildLogFile -root $repoRoot.FullName -Configuration Release -NativeHostArch x64)
|
|
Add-BuildLog -artifacts $artifacts -buildLog (Get-BuildLogFile -root $repoRoot.FullName -Configuration Release -NativeHostArch x86)
|
|
|
|
if($Global:OpenSSHTestInfo)
|
|
{
|
|
Add-Artifact -artifacts $artifacts -FileToAdd $Global:OpenSSHTestInfo["SetupTestResultsFile"]
|
|
Add-Artifact -artifacts $artifacts -FileToAdd $Global:OpenSSHTestInfo["UnitTestResultsFile"]
|
|
Add-Artifact -artifacts $artifacts -FileToAdd $Global:OpenSSHTestInfo["E2ETestResultsFile"]
|
|
Add-Artifact -artifacts $artifacts -FileToAdd $Global:OpenSSHTestInfo["UninstallTestResultsFile"]
|
|
Add-Artifact -artifacts $artifacts -FileToAdd $Global:OpenSSHTestInfo["TestSetupLogFile"]
|
|
}
|
|
|
|
foreach ($artifact in $artifacts)
|
|
{
|
|
Write-Host "Publishing $artifact as Appveyor artifact"
|
|
Push-AppveyorArtifact $artifact -ErrorAction Continue
|
|
}
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
Runs the tests for this repo
|
|
#>
|
|
function Invoke-OpenSSHTests
|
|
{
|
|
Set-BasicTestInfo -Confirm:$false
|
|
Invoke-OpenSSHSetupTest
|
|
if (($OpenSSHTestInfo -eq $null) -or (-not (Test-Path $OpenSSHTestInfo["SetupTestResultsFile"])))
|
|
{
|
|
Write-Warning "Test result file $OpenSSHTestInfo["SetupTestResultsFile"] not found after tests."
|
|
Write-BuildMessage -Message "Test result file $OpenSSHTestInfo["SetupTestResultsFile"] not found after tests." -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
Write-Warning "Stop running further tests!"
|
|
return
|
|
}
|
|
$xml = [xml](Get-Content $OpenSSHTestInfo["SetupTestResultsFile"] | out-string)
|
|
if ([int]$xml.'test-results'.failures -gt 0)
|
|
{
|
|
$errorMessage = "$($xml.'test-results'.failures) setup tests in regress\pesterTests failed. Detail test log is at $($OpenSSHTestInfo["SetupTestResultsFile"])."
|
|
Write-Warning $errorMessage
|
|
Write-BuildMessage -Message $errorMessage -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
Write-Warning "Stop running further tests!"
|
|
return
|
|
}
|
|
|
|
Write-Host "Start running unit tests"
|
|
$unitTestFailed = Invoke-OpenSSHUnitTest
|
|
|
|
if($unitTestFailed)
|
|
{
|
|
Write-Host "At least one of the unit tests failed!" -ForegroundColor Yellow
|
|
Write-BuildMessage "At least one of the unit tests failed!" -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
}
|
|
else
|
|
{
|
|
Write-Host "All Unit tests passed!"
|
|
Write-BuildMessage -Message "All Unit tests passed!" -Category Information
|
|
}
|
|
|
|
# Run all E2E tests.
|
|
Set-OpenSSHTestEnvironment -Confirm:$false
|
|
Invoke-OpenSSHE2ETest
|
|
if (($OpenSSHTestInfo -eq $null) -or (-not (Test-Path $OpenSSHTestInfo["E2ETestResultsFile"])))
|
|
{
|
|
Write-Warning "Test result file $OpenSSHTestInfo["E2ETestResultsFile"] not found after tests."
|
|
Write-BuildMessage -Message "Test result file $OpenSSHTestInfo["E2ETestResultsFile"] not found after tests." -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
Write-Warning "Stop running further tests!"
|
|
return
|
|
}
|
|
$xml = [xml](Get-Content $OpenSSHTestInfo["E2ETestResultsFile"] | out-string)
|
|
if ([int]$xml.'test-results'.failures -gt 0)
|
|
{
|
|
$errorMessage = "$($xml.'test-results'.failures) tests in regress\pesterTests failed. Detail test log is at $($OpenSSHTestInfo["E2ETestResultsFile"])."
|
|
Write-Warning $errorMessage
|
|
Write-BuildMessage -Message $errorMessage -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
Write-Warning "Stop running further tests!"
|
|
return
|
|
}
|
|
|
|
Invoke-OpenSSHUninstallTest
|
|
if (($OpenSSHTestInfo -eq $null) -or (-not (Test-Path $OpenSSHTestInfo["UninstallTestResultsFile"])))
|
|
{
|
|
Write-Warning "Test result file $OpenSSHTestInfo["UninstallTestResultsFile"] not found after tests."
|
|
Write-BuildMessage -Message "Test result file $OpenSSHTestInfo["UninstallTestResultsFile"] not found after tests." -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
}
|
|
else {
|
|
$xml = [xml](Get-Content $OpenSSHTestInfo["UninstallTestResultsFile"] | out-string)
|
|
if ([int]$xml.'test-results'.failures -gt 0)
|
|
{
|
|
$errorMessage = "$($xml.'test-results'.failures) uninstall tests in regress\pesterTests failed. Detail test log is at $($OpenSSHTestInfo["UninstallTestResultsFile"])."
|
|
Write-Warning $errorMessage
|
|
Write-BuildMessage -Message $errorMessage -Category Error
|
|
Set-BuildVariable TestPassed False
|
|
}
|
|
}
|
|
|
|
# Writing out warning when the $Error.Count is non-zero. Tests Should clean $Error after success.
|
|
if ($Error.Count -gt 0)
|
|
{
|
|
Write-BuildMessage -Message "Tests Should clean $Error after success." -Category Warning
|
|
}
|
|
}
|
|
|
|
<#
|
|
.Synopsis
|
|
upload OpenSSH pester test results.
|
|
#>
|
|
function Publish-OpenSSHTestResults
|
|
{
|
|
if ($env:APPVEYOR_JOB_ID)
|
|
{
|
|
$setupresultFile = Resolve-Path $Global:OpenSSHTestInfo["SetupTestResultsFile"] -ErrorAction Ignore
|
|
if( (Test-Path $Global:OpenSSHTestInfo["SetupTestResultsFile"]) -and $setupresultFile)
|
|
{
|
|
(New-Object 'System.Net.WebClient').UploadFile("https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)", $setupresultFile)
|
|
Write-BuildMessage -Message "Setup test results uploaded!" -Category Information
|
|
}
|
|
|
|
$E2EresultFile = Resolve-Path $Global:OpenSSHTestInfo["E2ETestResultsFile"] -ErrorAction Ignore
|
|
if( (Test-Path $Global:OpenSSHTestInfo["E2ETestResultsFile"]) -and $E2EresultFile)
|
|
{
|
|
(New-Object 'System.Net.WebClient').UploadFile("https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)", $E2EresultFile)
|
|
Write-BuildMessage -Message "E2E test results uploaded!" -Category Information
|
|
}
|
|
|
|
$uninstallResultFile = Resolve-Path $Global:OpenSSHTestInfo["UninstallTestResultsFile"] -ErrorAction Ignore
|
|
if( (Test-Path $Global:OpenSSHTestInfo["UninstallTestResultsFile"]) -and $uninstallResultFile)
|
|
{
|
|
(New-Object 'System.Net.WebClient').UploadFile("https://ci.appveyor.com/api/testresults/nunit/$($env:APPVEYOR_JOB_ID)", $uninstallResultFile)
|
|
Write-BuildMessage -Message "Uninstall test results uploaded!" -Category Information
|
|
}
|
|
}
|
|
|
|
if ($env:DebugMode)
|
|
{
|
|
Remove-Item $env:DebugMode
|
|
}
|
|
|
|
if($env:TestPassed -ieq 'True')
|
|
{
|
|
Write-BuildMessage -Message "The checkin validation success!" -Category Information
|
|
}
|
|
else
|
|
{
|
|
Write-BuildMessage -Message "The checkin validation failed!" -Category Error
|
|
throw "The checkin validation failed!"
|
|
}
|
|
}
|