Tasks/Invoke-WhiskeyNUnit2Task.ps1
|
function Invoke-WhiskeyNUnit2Task { <# .SYNOPSIS Invoke-WhiskeyNUnit2Task runs NUnit tests. .DESCRIPTION The NUnit2 task runs NUnit tests. The latest version of NUnit 2 is downloaded from nuget.org for you (into a `packages` directory in your build root). The task should pass the paths to the assemblies to test within the `TaskParameter.Path` parameter. The build will fail if any of the tests fail (i.e. if the NUnit console returns a non-zero exit code). You *must* include paths to build with the `Path` parameter. .EXAMPLE Invoke-WhiskeyNUnit2Task -TaskContext $TaskContext -TaskParameter $taskParameter Demonstates how to run the NUnit tests in some assemblies and save the result to a specific file. In this example, the assemblies to run are in `$TaskParameter.path` and the test report will be saved in an xml file relative to the indicated `$TaskContext.OutputDirectory` #> [Whiskey.Task("NUnit2",SupportsClean=$true, SupportsInitialize=$true)] [CmdletBinding()] param( [Parameter(Mandatory=$true)] [object] $TaskContext, [Parameter(Mandatory=$true)] [hashtable] $TaskParameter ) Set-StrictMode -version 'latest' Use-CallerPreference -Cmdlet $PSCmdlet -SessionState $ExecutionContext.SessionState $startedAt = Get-Date function Write-Timing { param( $Message ) $now = Get-Date Write-Debug -Message ('[{0}] [{1}] {2}' -f $now,($now - $startedAt),$Message) } $package = 'NUnit.Runners' $version = '2.6.4' if( $TaskParameter['Version'] ) { $version = $TaskParameter['Version'] if( $version -notlike '2.*' ) { Stop-WhiskeyTask -TaskContext $TaskContext -PropertyName 'Version' -Message ('The version ''{0}'' isn''t a valid 2.x version of NUnit.' -f $TaskParameter['Version']) } } $openCoverVersionArg = @{} $reportGeneratorVersionArg = @{} if( $TaskParameter['OpenCoverVersion'] ) { $openCoverVersionArg['Version'] = $TaskParameter['OpenCoverVersion'] } if( $TaskParameter['ReportGeneratorVersion'] ) { $reportGeneratorVersionArg['Version'] = $TaskParameter['ReportGeneratorVersion'] } $openCoverArgs = @() if( $TaskParameter['OpenCoverArgument'] ) { $openCoverArgs += $TaskParameter['OpenCoverArgument'] } $reportGeneratorArgs = @() if( $TaskParameter['ReportGeneratorArgument'] ) { $reportGeneratorArgs += $TaskParameter['ReportGeneratorArgument'] } if( $TaskContext.ShouldClean() ) { Write-Timing -Message ('Uninstalling ReportGenerator.') Uninstall-WhiskeyTool -NuGetPackageName 'ReportGenerator' -BuildRoot $TaskContext.BuildRoot @reportGeneratorVersionArg Write-Timing -Message ('COMPLETE') Write-Timing -Message ('Uninstalling OpenCover.') Uninstall-WhiskeyTool -NuGetPackageName 'OpenCover' -BuildRoot $TaskContext.BuildRoot @openCoverVersionArg Write-Timing -Message ('COMPLETE') Write-Timing -Message ('Uninstalling NUnit.') Uninstall-WhiskeyTool -NuGetPackageName $package -BuildRoot $TaskContext.BuildRoot -Version $version Write-Timing -Message ('COMPLETE') return } $includeParam = $null if( $TaskParameter.ContainsKey('Include') ) { $includeParam = '/include="{0}"' -f ($TaskParameter['Include'] -join ',') } $excludeParam = $null if( $TaskParameter.ContainsKey('Exclude') ) { $excludeParam = '/exclude="{0}"' -f ($TaskParameter['Exclude'] -join ',') } $frameworkParam = '4.0' if( $TaskParameter.ContainsKey('Framework') ) { $frameworkParam = $TaskParameter['Framework'] } $frameworkParam = '/framework={0}' -f $frameworkParam Write-Timing -Message ('Installing NUnit.') $nunitRoot = Install-WhiskeyTool -NuGetPackageName $package -Version $version -DownloadRoot $TaskContext.BuildRoot Write-Timing -Message ('COMPLETE') if( -not (Test-Path -Path $nunitRoot -PathType Container) ) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Package {0} {1} failed to install!' -f $package,$version) } $nunitRoot = Get-Item -Path $nunitRoot | Select-Object -First 1 $nunitRoot = Join-Path -Path $nunitRoot -ChildPath 'tools' $nunitConsolePath = Join-Path -Path $nunitRoot -ChildPath 'nunit-console.exe' -Resolve if( -not ($nunitConsolePath)) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('{0} {1} was installed, but couldn''t find nunit-console.exe at ''{2}''.' -f $package,$version,$nunitConsolePath) } Write-Timing -Message ('Installing OpenCover.') $openCoverRoot = Install-WhiskeyTool -NuGetPackageName 'OpenCover' -DownloadRoot $TaskContext.BuildRoot @openCoverVersionArg Write-Timing -Message ('COMPLETE') if( -not (Test-Path -Path $openCoverRoot -PathType Container)) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Failed to install NuGet package OpenCover {0}.' -f $version) } $openCoverPath = Get-ChildItem -Path $openCoverRoot -Filter 'OpenCover.Console.exe' -Recurse | Select-Object -First 1 | Select-Object -ExpandProperty 'FullName' if( -not (Test-Path -Path $openCoverPath -PathType Leaf) ) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Unable to find OpenCover.Console.exe in OpenCover NuGet package at ''{0}''.' -f $openCoverRoot) } Write-Timing -Message ('Installing ReportGenerator.') $reportGeneratorRoot = Install-WhiskeyTool -NuGetPackageName 'ReportGenerator' -DownloadRoot $TaskContext.BuildRoot @reportGeneratorVersionArg Write-Timing -Message ('COMPLETE') if( -not (Test-Path -Path $reportGeneratorRoot -PathType Container)) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Failed to install NuGet package ReportGenerator.' -f $version) } $reportGeneratorPath = Get-ChildItem -Path $reportGeneratorRoot -Filter 'ReportGenerator.exe' -Recurse | Select-Object -First 1 | Select-Object -ExpandProperty 'FullName' if( -not (Test-Path -Path $reportGeneratorPath -PathType Leaf) ) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Unable to find ReportGenerator.exe in ReportGenerator NuGet package at ''{0}''.' -f $reportGeneratorRoot) } if( $TaskContext.ShouldInitialize() ) { return } # Be sure that the Taskparameter contains a 'Path'. if( -not ($TaskParameter.ContainsKey('Path'))) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('Element ''Path'' is mandatory. It should be one or more paths, which should be a list of assemblies whose tests to run, e.g. BuildTasks: - NUnit2: Path: - Assembly.dll - OtherAssembly.dll') } $path = $TaskParameter['Path'] | Resolve-WhiskeyTaskPath -TaskContext $TaskContext -PropertyName 'Path' $reportPath = Join-Path -Path $TaskContext.OutputDirectory -ChildPath ('nunit2-{0:00}.xml' -f $TaskContext.TaskIndex) $coverageReportDir = Join-Path -Path $TaskContext.outputDirectory -ChildPath "opencover" New-Item -Path $coverageReportDir -ItemType 'Directory' -Force | Out-Null $openCoverReport = Join-Path -Path $coverageReportDir -ChildPath 'openCover.xml' $extraArgs = $TaskParameter['Argument'] | Where-Object { $_ } $separator = '{0}VERBOSE: ' -f [Environment]::NewLine Write-Verbose -Message (' Path {0}' -f ($Path -join $separator)) Write-Verbose -Message (' Framework {0}' -f $frameworkParam) Write-Verbose -Message (' Include {0}' -f $includeParam) Write-Verbose -Message (' Exclude {0}' -f $excludeParam) Write-Verbose -Message (' Argument {0}' -f ($extraArgs -join $separator)) Write-Verbose -Message (' /xml={0}' -f $reportPath) Write-Verbose -Message (' CoverageFilter {0}' -f $TaskParameter['CoverageFilter'] -join ' ') Write-Verbose -Message (' Output {0}' -f $openCoverReport) $disableCodeCoverage = $TaskParameter['DisableCodeCoverage'] | ConvertFrom-WhiskeyYamlScalar Write-Verbose -Message (' DisableCodeCoverage {0}' -f $disableCodeCoverage) Write-Verbose -Message (' OpenCoverArgs {0}' -f ($openCoverArgs -join ' ')) Write-Verbose -Message (' ReportGeneratorArgs {0}' -f ($reportGeneratorArgs -join ' ')) if( -not $disableCodeCoverage ) { $coverageFilterString = ($TaskParameter['CoverageFilter'] -join " ") $extraArgString = ($extraArgs -join " ") $pathsArg = ($path -join '" "') $nunitArgs = '"{0}" /noshadow {1} /xml="{2}" {3} {4} {5}' -f $pathsArg,$frameworkParam,$reportPath,$includeParam,$excludeParam,$extraArgString $nunitArgs = $nunitArgs -replace '"', '\"' Write-Timing -Message ('Running OpenCover') & $openCoverPath "-target:${nunitConsolePath}" "-targetargs:${nunitArgs}" "-filter:${coverageFilterString}" '-register:user' "-output:${openCoverReport}" '-returntargetcode' $openCoverArgs Write-Timing -Message ('COMPLETE') $testsFailed = $LastExitCode; Write-Timing -Message ('Running ReportGenerator') & $reportGeneratorPath "-reports:${openCoverReport}" "-targetdir:$coverageReportDir" $reportGeneratorArgs Write-Timing -Message ('COMPLETE') if( $LastExitCode -or $testsFailed ) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('NUnit2 tests failed. {0} returned exit code {1}.' -f $openCoverPath,$LastExitCode) } } else { Write-Timing -Message ('Running NUnit') & $nunitConsolePath $path $frameworkParam $includeParam $excludeParam $extraArgs ('/xml={0}' -f $reportPath) Write-Timing -Message ('COMPLETE') if( $LastExitCode ) { Stop-WhiskeyTask -TaskContext $TaskContext -Message ('NUnit2 tests failed. {0} returned exit code {1}.' -f $nunitConsolePath,$LastExitCode) } } } |