Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gfoidl/trx2junit
Transforms XML from trx-Testresults to JUnit-Testresults / trx to JUnit XML and the other way round
https://github.com/gfoidl/trx2junit
ci-scenarios dotnet-global-tool junit junit-xml junit2trx trx trx-testresults trx2junit unit-testing xml
Last synced: about 5 hours ago
JSON representation
Transforms XML from trx-Testresults to JUnit-Testresults / trx to JUnit XML and the other way round
- Host: GitHub
- URL: https://github.com/gfoidl/trx2junit
- Owner: gfoidl
- License: mit
- Created: 2017-11-06T09:26:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-20T11:30:46.000Z (9 months ago)
- Last Synced: 2024-09-26T02:40:52.706Z (about 1 month ago)
- Topics: ci-scenarios, dotnet-global-tool, junit, junit-xml, junit2trx, trx, trx-testresults, trx2junit, unit-testing, xml
- Language: C#
- Homepage:
- Size: 395 KB
- Stars: 69
- Watchers: 6
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: ReadMe.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
| CI | NuGet |
| -- | -- |
| [](https://dev.azure.com/gh-gfoidl/github-Projects/_build/latest?definitionId=35&branchName=master) | [](https://www.nuget.org/packages/trx2junit/) |
# trx2junit (.NET Core global tool)
Helper for converting trx-Testresults (`dotnet test --logger "trx"`) to a JUnit-based XML file.
Can be used for CI-scenarios, like [CircleCi](https://circleci.com/) or [GitLab](https://docs.gitlab.com/ee/ci/junit_test_reports.html), where as test results JUnit is expected.
## Usage
### trx to junit
When installed as [.NET Core Global Tool](https://natemcmaster.com/blog/2018/05/12/dotnet-global-tools/):
`trx2junit {trxFile}` where _trxFile_ is the path to the trx-file.
You can pass more than one trx file, each will create it's own junit xml file.
```console
# handle two files
$ trx2junit a.trx b.trx
Converting 2 trx file(s) to JUnit-xml...
Converting 'a.trx' to 'a.xml'
Converting 'b.trx' to 'b.xml'
done in 0.1234567 seconds. bye.
# for shells that handle wildcard expansion:
$ trx2junit results/*.trx
Converting 1 trx file(s) to JUnit-xml...
Converting 'example.trx' to 'example.xml'
done in 0.1234567 seconds. bye.
```
If the shell won't handle wildcard expansion, `trx2junit` handles the expansion of files in the same directory.
A different location for the JUnit-output can be specified:
```console
# specify different output location
$ trx2junit a.trx --output ../results
# or
$ trx2junit --output results a.trx ../tests/b.trx
```
#### Jenkins JUnit
For Jenkins JUnit on the testcase the status-attribute is set. By default `1` is set for success, and `0` for failure.
This can be configured via environment varialbes (note: if omitted, the default values will be used):
| Status | Variable | default value |
|---------|---------------------------------------------|---------------|
| success | `TRX2JUNIT_JENKINS_TESTCASE_STATUS_SUCCESS` | `1` |
| failure | `TRX2JUNIT_JENKINS_TESTCASE_STATUS_FAILURE` | `0` |
| skipped | `TRX2JUNIT_JENKINS_TESTCASE_STATUS_SKIPPED` | not set |
With environment variable `TRX2JUNIT_JUNIT_ERROR_MESSAGE_IN_CDATA` set, the error message from a failing test will be repeated in the _CDATA_-content of the `` element.
See [this comment](https://github.com/gfoidl/trx2junit/issues/104#issuecomment-1178852241) for further info.
### junit to trx
With option `--junit2trx` a conversion from _junit_ to _trx_ can be performed.
If a given _xml_-file is not a junit-file, a message will be logged to _stderr_ and the exit-code is set to `1`.
A junit-file is considered valid if it either conforms to [junit.xsd](./schemas/junit.xsd) or [jenkins-junit.xsd](./schemas/jenkins-junit.xsd).
## Installation
```sh
dotnet tool install -g trx2junit
```
For CI-scenarios execute before usage:
```sh
export PATH="$PATH:/root/.dotnet/tools"
```
Check also the documentation of your CI-system on how to persist the `PATH` between steps, etc.
E.g. in CircleCI you need to run
```sh
echo 'export PATH="$PATH:/root/.dotnet/tools"' >> "$BASH_ENV"
```
### Prequisites / Supported SDKs
In order to install this tool a [.NET SDK](https://dotnet.microsoft.com/download/dotnet) must be present. Supported SDKs are:
* .NET 8.0
* .NET 7.0
* .NET 6.0
# Core functionality as standalone package trx2junit.Core
Starting with v2.0.0 it's possible to use the core functionality as standalone package `trx2junit.Core`.
The tool (see above) itself is a consumer of that package.
After adding a reference to `trx2junit.Core` one can use it in "commandline-mode" like
```c#
Worker worker = new();
WorkerOptions options = WorkerOptions.Parse(args);
await worker.RunAsync(options);
```
or create the `WorkerOptions` via the constructor, and pass that instance into `RunAsync` of the worker.
## Development channel
To get packages from the development channel use a `nuget.config` similar to this one:
```xml
```