Save MSTest Nunit Xunit test results as a JSON file
A Dotnet MSTest Nunit Xunit JSON test reporter to create test reports that follow the CTRF standard.
Common Test Report Format ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.
⭐ If you find this project useful, consider giving it a GitHub star ⭐
It means a lot to us and helps us grow this open source library.
We believe CTRF can save a lot of time for engineers, a single data serialisation report, well structured, community driven and works with any framework. For over 30s years software engineers have used a de facto data serialisation report, you know the one! But we feel it’s time to modernise.
The only way we can grow CTRF is with your help and the support of the software engineering community.
- Join and build with us! We are looking for contributors, get involved in this early stage project. All contributions are welcome.
- Give this repository a star ⭐⭐⭐⭐⭐⭐
- Follow the CTRF GitHub organisation
- Clap for our medium articles (30 times each) 👏
- Share, share share! Discord, Reddit, Twitter, LinkedIn, Slack, Teams, whereever! - please share our libraries, our homepage, our Medium articles
- Maybe even write a blog about us!
- Try our tools
Thank you so much!!
- Generate JSON test reports that are CTRF compliant
- Straightforward integration with MSTest, NUnit and Xunit
- Convert TRX files to JSON
{
"results": {
"tool": {
"name": "mstest"
},
"summary": {
"tests": 1,
"passed": 1,
"failed": 0,
"pending": 0,
"skipped": 0,
"other": 0,
"start": 1706828654274,
"stop": 1706828655782
},
"tests": [
{
"name": "ctrf should generate the same report with any tool",
"status": "passed",
"duration": 100
}
],
"environment": {
"appName": "MyApp",
"buildName": "MyBuild",
"buildNumber": "1"
}
}
}
CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
Consistency Across Tools: Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.
Language and Framework Agnostic: It provides a universal reporting schema that works seamlessly with any programming language and testing framework.
Facilitates Better Analysis: With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.
Create a tool manifest (if not already present):
dotnet new tool-manifest
Install DotnetCtrfJsonReporter as a local tool:
dotnet tool install DotnetCtrfJsonReporter --local
Run your tests and generate a TRX file using the following command:
dotnet test --logger "trx;logfilename=testResults.trx"
After the tests have completed, run DotnetCtrfJsonReporter to convert the TRX file into a CTRF:
dotnet tool run DotnetCtrfJsonReporter -t "TestResults/testResults.trx"
You'll find a JSON file named ctrf-report.json
in the ctrf
directory.
The reporter supports several configuration options:
-p, --trx-path (required): The path to the TRX file generated by dotnet test.
-f, --output-filename (optional): Name of the output JSON file. Default is ctrf-report.json.
-d, --output-directory (optional): Directory where the JSON report will be saved. Default is the ctrf directory.
-t --test-tool (optional): Name of the test tool (nunit, mstest, xunit, etc.). Default is dotnet
dotnet tool run DotnetCtrfJsonReporter \
-p "TestResults/testResults.trx" \
-f "custom-report.json" \
-d "custom-directory" \
-t "mstest"
The test object in the report includes the following CTRF properties:
Name | Type | Required | Details |
---|---|---|---|
name |
String | Required | The name of the test. |
status |
String | Required | The outcome of the test. One of: passed , failed , skipped , pending , other . |
duration |
Number | Required | The time taken for the test execution, in milliseconds. |
If you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.