Skip to content

yurvon-screamo/utsukushii

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

96 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒธ Utsukushii - Beautify Your Test Reports

Utsukushii is a small tool designed to transform your test reports into beautiful, easily understandable formats.

Whether your test outputs format, Utsukushii helps you present your results with clarity and style.

๐Ÿšง In Development - Contributions and feedback are welcome!

Example Report

๐Ÿš€ Features

  • Dev mode: Run test from UI !
  • JUnit Format Support: Convert JUnit outputs into a unified, beautiful report.
  • Dotnet trx logger Support: Convert dotnet trx logger report into a unified, beautiful report.
  • Go-Test Format Support: Convert Go test outputs into a unified, beautiful report.
  • Merge reports: Union multiple reports into single.

๐Ÿ“ฅ Installation

Install the latest version using Go:

go install github.com/yurvon-screamo/utsukushii@latest

๐Ÿ“š Usage

Dev mode

dev_mode

  1. Create config file utsukushii-dev.yaml:

    # Required part
    # The command to run the tests 
    cmd: go test -v --json ./...
    # Your solution language, oneof - 'go', '.net' 
    lang: go
    
    # Optional part
    # title: my report title
    # coverage: 46
    # addr: ':8080'
    # ignore_open: true
  2. Start it:

    utsukushii dev

Generate and Serve Reports

gen_serve

  1. Generate Content:

    utsukushii gen --junit ./my-junit1.xml --go-json-test my-go-json-test-1.log --dotnet-trx myTrx.trx
  2. Serve the Report:

    utsukushii serve --content my-utsukushii.json

Support:

  • go test json
  • dotnet test trx
  • junit reports

By default, the report is served at http://localhost:8080.

๐Ÿ› ๏ธ Development and Design Goals

Our main goal is to convert test results into visually appealing reports. Utsukushii supports merging multiple reports, handling various formats, and presenting historical data.

๐Ÿค Contributing

Contributions are welcome! Please check out the issues or create a new one if you have any ideas or bugs to report.

๐Ÿ“ License

This project is licensed under the MIT License.