Marco Blessing
2422afbd8f
- fix pester test execution order in vscode test task. - fix coveralls.io link in bagde. - skip coverage report creation for PR triggered builds - update docs - Connection type SCP added for `Connect-To` and `Disconnect-From`. ## Internal Changes - pester tests now don't need to dotsource other public functions from the same module (fixes #17 ) - helper and private functions stilll needs to be dotsourced. - basic module tests added - pester tests for `Resolve-Dependency` added - Wrapper function `Get-ModuleBase` added. This enables mocking in tests.
209 lines
7.8 KiB
PowerShell
209 lines
7.8 KiB
PowerShell
<#
|
|
Define the callsign of you PowerShell Module.
|
|
Callsign is used to identity:
|
|
- Module Manifest file name
|
|
- Artifact File
|
|
- Git repository name
|
|
- Module name
|
|
#>
|
|
$CALLSIGN = 'PSCredentialStore'
|
|
Write-Host ("Callsign is: {0}" -f $CALLSIGN) -ForegroundColor Yellow
|
|
|
|
|
|
Function Invoke-InstallDependencies() {
|
|
[CmdletBinding()]
|
|
Param()
|
|
|
|
Process {
|
|
Try {
|
|
Install-PackageProvider -Name NuGet -RequiredVersion '2.8.5.208' -Force -Verbose
|
|
Import-PackageProvider -Name NuGet -RequiredVersion '2.8.5.208' -Force
|
|
Install-Module -Name 'Pester' -Scope CurrentUser -RequiredVersion '4.0.8' -Force -SkipPublisherCheck -AllowClobber
|
|
Install-Module -Name 'posh-git' -Scope CurrentUser -RequiredVersion '0.7.1' -Force -SkipPublisherCheck -AllowClobber
|
|
Install-Module -Name 'PSCoverage' -Scope CurrentUser -Force -SkipPublisherCheck -AllowClobber
|
|
Import-Module -Name 'Pester', 'posh-git', 'PSCoverage'
|
|
}
|
|
Catch {
|
|
$MsgParams = @{
|
|
Message = 'Could not install the required dependencies!'
|
|
Category = 'Error'
|
|
Details = $_.Exception.Message
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
Throw $MsgParams.Message
|
|
}
|
|
|
|
}
|
|
}
|
|
Function Invoke-AppVeyorBumpVersion() {
|
|
[CmdletBinding()]
|
|
Param()
|
|
|
|
Write-Host "Listing Env Vars for debugging:" -ForegroundColor Yellow
|
|
# Filter Results to prevent exposing secure vars.
|
|
Get-ChildItem -Path "Env:*" | Where-Object { $_.name -notmatch "(NuGetToken|CoverallsToken)"} | Sort-Object -Property Name | Format-Table
|
|
|
|
Try {
|
|
$ModManifest = Get-Content -Path (".\src\{0}.psd1" -f $CALLSIGN)
|
|
$BumpedManifest = $ModManifest -replace '0.0.0.9999', $Env:APPVEYOR_BUILD_VERSION
|
|
Remove-Item -Path (".\src\{0}.psd1" -f $CALLSIGN)
|
|
Out-File -FilePath (".\src\{0}.psd1" -f $CALLSIGN) -InputObject $BumpedManifest -NoClobber -Encoding utf8 -Force
|
|
}
|
|
Catch {
|
|
$MsgParams = @{
|
|
Message = 'Could not bump current version into module manifest.'
|
|
Category = 'Error'
|
|
Details = $_.Exception.Message
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
Throw $MsgParams.Message
|
|
}
|
|
}
|
|
|
|
Function Invoke-AppVeyorBuild() {
|
|
[CmdletBinding()]
|
|
Param()
|
|
$MsgParams = @{
|
|
Message = 'Creating build artifacts'
|
|
Category = 'Information'
|
|
Details = 'Extracting source files and compressing them into zip file.'
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
$CompParams = @{
|
|
Path = "{0}\src\*" -f $env:APPVEYOR_BUILD_FOLDER
|
|
DestinationPath = "{0}\bin\{1}.zip" -f $env:APPVEYOR_BUILD_FOLDER, $CALLSIGN
|
|
Update = $True
|
|
Verbose = $True
|
|
}
|
|
Compress-Archive @CompParams
|
|
$MsgParams = @{
|
|
Message = 'Pushing artifacts'
|
|
Category = 'Information'
|
|
Details = 'Pushing artifacts to AppVeyor store.'
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
Push-AppveyorArtifact (".\bin\{0}.zip" -f $CALLSIGN)
|
|
}
|
|
|
|
Function Invoke-AppVeyorTests() {
|
|
[CmdletBinding()]
|
|
Param()
|
|
|
|
$MsgParams = @{
|
|
Message = 'Starting Pester tests'
|
|
Category = 'Information'
|
|
Details = 'Now running all test found in .\tests\ dir.'
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
$testresults = Invoke-Pester -Path ( Get-ChildItem -Path ".\tests\*.Tests.ps1" -Recurse | Sort-Object -Property Name ) -ExcludeTag 'Disabled' -PassThru
|
|
ForEach ($Item in $testresults.TestResult) {
|
|
Switch ($Item.Result) {
|
|
"Passed" {
|
|
$TestParams = @{
|
|
Name = "{0}: {1}" -f $Item.Context, $Item.Name
|
|
Framework = "NUnit"
|
|
Filename = $Item.Describe
|
|
Outcome = "Passed"
|
|
Duration = $Item.Time.Milliseconds
|
|
}
|
|
Add-AppveyorTest @TestParams
|
|
}
|
|
"Failed" {
|
|
$TestParams = @{
|
|
Name = "{0}: {1}" -f $Item.Context, $Item.Name
|
|
Framework = "NUnit"
|
|
Filename = $Item.Describe
|
|
Outcome = "Failed"
|
|
Duration = $Item.Time.Milliseconds
|
|
ErrorMessage = $Item.FailureMessage
|
|
ErrorStackTrace = $Item.StackTrace
|
|
}
|
|
Add-AppveyorTest @TestParams
|
|
}
|
|
Default {
|
|
$TestParams = @{
|
|
Name = "{0}: {1}" -f $Item.Context, $Item.Name
|
|
Framework = "NUnit"
|
|
Filename = $Item.Describe
|
|
Outcome = "None"
|
|
Duration = $Item.Time.Milliseconds
|
|
ErrorMessage = $Item.FailureMessage
|
|
ErrorStackTrace = $Item.StackTrace
|
|
}
|
|
Add-AppveyorTest @TestParams
|
|
}
|
|
}
|
|
}
|
|
If ($testresults.FailedCount -gt 0) {
|
|
$MsgParams = @{
|
|
Message = 'Pester Tests failed.'
|
|
Category = 'Error'
|
|
Details = "$($testresults.FailedCount) tests failed."
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
Throw $MsgParams.Message
|
|
}
|
|
|
|
}
|
|
|
|
Function Invoke-CoverageReport() {
|
|
[CmdletBinding()]
|
|
Param(
|
|
[Parameter(Mandatory = $False)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[String]$RepoToken = $Env:CoverallsToken
|
|
)
|
|
|
|
Import-Module ('.\src\{0}.psm1' -f $CALLSIGN) -Verbose -Force
|
|
$FileMap = New-PesterFileMap -SourceRoot '.\src' -PesterRoot '.\tests'
|
|
$CoverageReport = New-CoverageReport -PesterFileMap $FileMap -RepoToken $RepoToken
|
|
Write-Host "CoverageReport JSON:" -ForegroundColor Yellow
|
|
$CoverageReport | Out-String | Write-Host
|
|
Publish-CoverageReport -CoverageReport $CoverageReport
|
|
}
|
|
|
|
Function Invoke-AppVeyorPSGallery() {
|
|
[CmdletBinding()]
|
|
Param(
|
|
[Parameter(Mandatory = $true)]
|
|
[ValidateNotNullOrEmpty()]
|
|
[String]$OnBranch
|
|
)
|
|
Expand-Archive -Path (".\bin\{0}.zip" -f $CALLSIGN) -DestinationPath ("C:\Users\appveyor\Documents\WindowsPowerShell\Modules\{0}\" -f $CALLSIGN) -Verbose
|
|
Import-Module -Name $CALLSIGN -Verbose -Force
|
|
Write-Host "Available Package Provider:" -ForegroundColor Yellow
|
|
Get-PackageProvider -ListAvailable
|
|
Write-Host "Available Package Sources:" -ForegroundColor Yellow
|
|
Get-PackageSource
|
|
Try {
|
|
Write-Host "Try to get NuGet Provider:" -ForegroundColor Yellow
|
|
Get-PackageProvider -Name NuGet -ErrorAction Stop
|
|
}
|
|
Catch {
|
|
Write-Host "Installing NuGet..." -ForegroundColor Yellow
|
|
Install-PackageProvider -Name NuGet -MinimumVersion '2.8.5.201' -Force -Verbose
|
|
Import-PackageProvider NuGet -MinimumVersion '2.8.5.201' -Force
|
|
}
|
|
Try {
|
|
If ($env:APPVEYOR_REPO_BRANCH -eq 'master') {
|
|
Write-Host "try to publish module" -ForegroundColor Yellow
|
|
Write-Host ("Callsign is: {0}" -f $CALLSIGN) -ForegroundColor Yellow
|
|
Publish-Module -Name $CALLSIGN -NuGetApiKey $env:NuGetToken -Verbose -Force
|
|
}
|
|
Else {
|
|
Write-Host "Skip publishing to PS Gallery because we are on $($env:APPVEYOR_REPO_BRANCH) branch." -ForegroundColor Yellow
|
|
# had to remove the publish-Module statement because it would publish although the -WhatIf is given.
|
|
# Publish-Module -Name $CALLSIGN -NuGetApiKey $env:NuGetToken -Verbose -WhatIf
|
|
}
|
|
}
|
|
Catch {
|
|
$MsgParams = @{
|
|
Message = 'Could not deploy module to PSGallery.'
|
|
Category = 'Error'
|
|
Details = $_.Exception.Message
|
|
}
|
|
Add-AppveyorMessage @MsgParams
|
|
Throw $MsgParams.Message
|
|
}
|
|
}
|