trx-tools

Reporting and merging tool for TRX files.
Demo Report · Explore the docs

Table of Contents

1. About The Project
   • Example
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

trx-tools is a project that aims to provide a set of tools to interact with TRX test files. For example, converting a TRX file to a HTML report, PDF report, Json file, etc. This also includes merging multiple TRX files into one. See an example report here.

The goals of this project is to provide a tool that can be used to generate test reports after using the dotnet test command. This command does not return a single report. Meaning, the trx files have to be merged manually after which they can be converted into a readable report.

Example

Built With

• .NET
• Scrutor

Getting Started

To get a local copy up and running follow these simple steps.

1. Go to the latest release.
2. Download the correct runtime for your system from the assets of the release.
3. And you are ready to go!

Usage

Github Actions

The report tool can be used in a Github action to generate a report after running dotnet tests with the 'trx' logger.

- name: Run tests
  run: dotnet test --logger "trx" --results-directory ./TestResults

- name: Generate report
  uses: BrammyS/[email protected]
  with:
    report-type: html
    trx-directory: TestResults
    report-file: report.html

- name: Upload Test Report
  uses: actions/upload-artifact@v4
  with:
    name: test-report
    path: ./report.html

CLI

The report tool has a help command that can be used to see all the available commands and options.

trx-tools.Reporting help

To generate a report from a TRX file, use the following command:

trx-tools.Reporting html "path/to/trxFolder" "path/to/output/file.html"

Roadmap

• Merging multiple TRX files
• Generating a HTML report
• Automatic release pipeline from tags
• Generating a PDF report

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

(back to top)