Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/equelin/format-pester
Powershell module for documenting Pester's results
https://github.com/equelin/format-pester
nunit pester powershell
Last synced: 2 months ago
JSON representation
Powershell module for documenting Pester's results
- Host: GitHub
- URL: https://github.com/equelin/format-pester
- Owner: equelin
- License: mit
- Created: 2016-06-16T15:33:51.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-09T10:40:18.000Z (almost 6 years ago)
- Last Synced: 2024-09-29T04:22:15.508Z (3 months ago)
- Topics: nunit, pester, powershell
- Language: PowerShell
- Size: 741 KB
- Stars: 84
- Watchers: 14
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/equelin/format-pester/branch/master)
# Format-Pester
Powershell module for documenting Pester's results.
All the formatting work is done by the module [PScribo](https://github.com/iainbrighton/PScribo).
Reports are generated based on a custom PowerShell object returned by Invoke-Pester. You have to provide the parameter `PassThru` to Pester. Currently, NUnit style files generated by Pester are not supported.
If you can't generate report on a computer where tests are executed please save tests results piping them to `Export-Clixml`.
You can be interested also in the
- [ReportUnit](https://github.com/reportunit/reportunit) tool. It's a report generator for the test-runner family. It uses stock reports from NUnit, MsTest, xUnit, TestNG and Gallio and converts them into HTML reports with dashboards.
- [PSTestReport](https://github.com/Xainey/PSTestReport) - it's an early example to generate a static PowerShell test report. You can read about it in the blog post ["Hitchhikers Guide to the PowerShell Module Pipeline"](https://xainey.github.io/2017/powershell-module-pipeline) by Michael Willis.
## Report example
Partial screenshot for a HTML report generated by Format-Pester v. 1.6.0, PScribo v. 0.7.19, [the full screenshot](./img/Format-Pester-1.6.0-full.png).
You can find more examples [here](/examples/).
## Supported languages
Since version 1.3.0 internationalization of generated reports is supported. It means that reports parts e.g. section names, columns headers, etc. can be wrote in a different language than English.
Currently available languages are:
- en-US - English United States - main language
- pl-PL - Polish
If you would like to add support for your language please read the section [Information for translators](https://github.com/equelin/Format-Pester/wiki/Information-for-translators) in the project's wiki.
# Requirements
- Powershell v.4.x, v.5.x
- [Pester](https://github.com/pester/Pester) v.4.x
- [PScribo](https://github.com/iainbrighton/PScribo)
# Usage
Format-Pester is a PowerShell module so it has to be imported before using it - you can find more instructions in the [wiki](https://github.com/equelin/Format-Pester/wiki/Importing-Format-Pester).
## Example 1
```PowerShell
Invoke-Pester -PassThru | Format-Pester -Path . -Format HTML,Word,Text
```
This command will document the results of the Pester's tests. Documents will be stored in the current path and they will be available in 3 formats (.html,.docx and .txt).
## Example 2
```PowerShell
Invoke-Pester -PassThru | Export-Clixml -Path .\Test-Result.xml
Import-Clixml -Path .\Test-Result.xml | Format-Pester -Format .\ -BaseFileName Test-Result -Format HTML -FailedOnly
```
You can run the first command on a server where PScribo and Format-Pester are not installed. The tests results object will be stored in a xmf file.
After copying the file to the computer where PScribo and Format-Pester are available you can generate a report. In this example, the HTML file will be generated with results of failed tests only.
## Online help
You can read [online version of help](/doc/Format-Pester.md) - online help generated by [platyPS module](https://github.com/powershell/platyps).
# Initial author
- Erwan Quélin - [GitHub](https://github.com/equelin) - [Twitter](https://twitter.com/erwanquelin)
# Contributors
- Travis Plunk - [GitHub](https://github.com/TravisEz13) - [Twitter](https://twitter.com/TravisPlunk)
- Wojciech Sciesinski - [GitHub](https://github.com/it-praktyk) - [Twitter](https://twitter.com/ITpraktyk)
# [Version history](VERSIONS.md)
# [TODO and development plans](TODO.md)
# License
Copyright 2016-17 Erwan Quelin and the community.
Licensed under [the MIT License](LICENSE)