Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spekt/junit.testlogger
JUnit test logger for vstest platform
https://github.com/spekt/junit.testlogger
dotnet dotnet-test junit logger nuget test-reporting vstest
Last synced: about 2 months ago
JSON representation
JUnit test logger for vstest platform
- Host: GitHub
- URL: https://github.com/spekt/junit.testlogger
- Owner: spekt
- License: mit
- Created: 2019-08-21T00:55:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-10T01:46:16.000Z (12 months ago)
- Last Synced: 2024-05-22T21:11:08.850Z (9 months ago)
- Topics: dotnet, dotnet-test, junit, logger, nuget, test-reporting, vstest
- Language: C#
- Homepage:
- Size: 383 KB
- Stars: 71
- Watchers: 4
- Forks: 14
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
> [!IMPORTANT]
> Development of v4.x and subsequent versions of the Junit logger is moved to the [testlogger](https://github.com/spekt/testlogger) repository.
> Kindly report any new issues or contribute your patches in that repo.
# JUnit Test Logger
JUnit xml report extension for [Visual Studio Test Platform](https://github.com/microsoft/vstest).
[](https://travis-ci.com/spekt/junit.testlogger)
[](https://ci.appveyor.com/project/spekt/junit-testlogger)
[](https://www.nuget.org/packages/JunitXml.TestLogger/)
## Packages
| Logger | Stable Package | Pre-release Package |
| ------ | -------------- | ------------------- |
| JUnit | [](https://www.nuget.org/packages/JUnitXml.TestLogger/) | [](https://www.myget.org/feed/spekt/package/nuget/JunitXml.TestLogger) |
If you're looking for `Nunit`, `Xunit` or `appveyor` loggers, visit following repositories:
-
-
-
## Usage
The JUnit Test Logger generates xml reports in the [Ant Junit Format](https://github.com/windyroad/JUnit-Schema), which the JUnit 5 repository refers to as the de-facto standard. While the generated xml complies with that schema, it does not contain values in every case. For example, the logger currently does not log any `properties`. Please [refer to a sample file](docs/assets/TestResults.xml) to see an example. If you find that the format is missing data required by your CI/CD system, please open an issue or PR.
To use the logger, follow these steps:
1. Add a reference to the [JUnit Logger](https://www.nuget.org/packages/JUnitXml.TestLogger) nuget package in test project
2. Use the following command line in tests
```none
> dotnet test --logger:junit
```
3. Test results are generated in the `TestResults` directory relative to the `test.csproj`
A path for the report file can be specified as follows:
```none
> dotnet test --logger:"junit;LogFilePath=test-result.xml"
```
`test-result.xml` will be generated in the same directory as `test.csproj`.
**Note:** the arguments to `--logger` should be in quotes since `;` is treated as a command delimiter in shell.
All common options to the logger are documented [in the wiki][config-wiki]. E.g.
token expansion for `{assembly}` or `{framework}` in result file. If you are writing multiple
files to the same directory or testing multiple frameworks, these options can prevent
test logs from over-writing each other.
[config-wiki]: https://github.com/spekt/testlogger/wiki/Logger-Configuration
### Customizing Junit XML Contents
There are several options to customize how the junit xml is populated. These options exist to
provide additional control over the xml file so that the logged test results can be optimized for different CI/CD systems.
Platform Specific Recommendations:
- [GitLab CI/CD Recommendation](/docs/gitlab-recommendation.md)
- [Jenkins Recommendation](/docs/jenkins-recommendation.md)
- [CircleCI Recommendation](/docs/circleci-recommendation.md)
After the logger name, command line arguments are provided as key/value pairs with the following general format. **Note** the quotes are required and key names are case sensitive.
```none
> dotnet test --test-adapter-path:. --logger:"junit;key1=value1;key2=value2"
```
#### MethodFormat
This option alters the `testcase name` attribute. By default, this contains only the method. Class, will add the class to the name. Full, will add the assembly/namespace/class to the method.
We recommend this option for [GitLab](/docs/gitlab-recommendation.md) users.
##### Allowed Values
- MethodFormat=Default
- MethodFormat=Class
- MethodFormat=Full
#### FailureBodyFormat
When set to default, the body of a `failure` element will contain only the exception which is captured by vstest. Verbose will prepend the body with 'Expected X, Actual Y' similar to how it is displayed in the standard test output. 'Expected X, Actual Y' are normally only contained in the failure message. Additionally, Verbose will include standard output from the test in the failure message.
We recommend this option for [GitLab](/docs/gitlab-recommendation.md) and [CircleCI](/docs/circleci-recommendation.md) users.
##### Allowed Values
- FailureBodyFormat=Default
- FailureBodyFormat=Verbose
## License
MIT