Heleonix.Testing.Reporting 1.0.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet tool install --global Heleonix.Testing.Reporting --version 1.0.2
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local Heleonix.Testing.Reporting --version 1.0.2
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Heleonix.Testing.Reporting&version=1.0.2                

                    
                

            
nuke :add-package Heleonix.Testing.Reporting --version 1.0.2

Heleonix.Testing.Reporting

Release: .NET / NuGet

The .NET CLI tool to generate customisable human-friendly reports from technical test results.

Install

https://www.nuget.org/packages/Heleonix.Testing.Reporting

Documentation

See Heleonix.Testing.Reporting

Command-line interface

Option Description
-i, --input <path> (REQUIRED) Input files to generate reports from
-o, --output <path> (REQUIRED) Path of the output file to store the generated merged report in (see the --merge option) or path of the folder to store multiple generated reports
-f, --format <Html> (REQUIRED) Format of the output report
-m, --merge Determines whether the input files should be merged into a single output report, or every input file should have a separate generated output report
-s, --style <variable-name=value> The key=value pairs to specify custom styling via CSS variables, i.e. colors, for the output reports
-c, --content <property.path=value> The key=value pairs to specify custom content replacements i.e. header or footer, in the output reports.
-v, --verbosity <Critical/Debug/Error/Information/None/Trace/Warning> Sets the verbosity level for logging [default: Information]
--version Show version information
-?, -h, --help Show help and usage information

Styles

Possible values for the --style option:

Format Values
Html See CSS 3 variables in the Css.css without -- prefixes, i.e.: color-primary, color-secondary etc.

Styling approaches the M2 Material Design with set of color, typography, shaping and spacing variables.

To simplify your custom styling, you can use Material Design palette tool.

Content

Possible values of the --content option are dotted paths to properties in the Report.cs.
For example: Footer.Text, Footer.Url, Result.Summary.Title, Result.Summary.Owner etc.

Examples

hxreport -i ./TestResult1.trx ./TestResult2.trx -o ./TestResult.html -f Html -m
Converts two TRX test results into a single merged Html output file.

hxreport -i ./TestResult1.trx ./TestResult2.trx -o ./TestResultFolder -f Html
Converts two TRX test results into two Html output files placed in the ./TestResultFolder folder.

Having the Sample.trx, the following Html report is generated:
hxreport -i ./Sample.trx -o ./Sample.html -f Html

DefaultTemplateReport

Having the Sample.trx, the following Html report is generated, using the Material Design palette tool and the primary #C51162 color:
hxreport -i ./Sample.trx -o ./Sample.html -f Html -s color-primary=#c51162 color-on-primary=#ffffff color-secondary=#c511bc color-background=#fce4ed color-on-background=#c51162 color-on-surface=#000000 color-start=#f48fb6 color-end=#8eddae color-duration=#df87d7 color-passed=lightgreen color-failed=red color-error=darkred color-warning=orange color-skipped=lightblue color-other=lightpink color-undefined=lightgray -c Footer.Text="(c) My Company" Footer.Url="https://my.company.com"

OverridenTemplateReport

Contribution Guideline

  1. Create a fork from the main repository
  2. Implement whatever is needed
  3. Create a Pull Request. Make sure the assigned Checks pass successfully. You can watch the progress in the PR: .NET GitHub workflows
  4. Request review from the code owner
  5. Once approved, merge your Pull Request via Squash and merge

    IMPORTANT
    While merging, enter a Conventional Commits commit message. This commit message will be used in automatically generated Github Release Notes and NuGet Release Notes

  6. Monitor the Release: .NET / NuGet GitHub workflow to make sure your changes are delivered successfully
  7. In case of any issues, please contact heleonix.sln@gmail.com
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
1.0.2 147 6/23/2024

"1.0.2 (6/23/2024)



Bug Fixes
   
- Fixed application crashes when the --merge flag is specified.        
- Fixed new-line breaks using / instead of <br> in the Readme file."