Skip to content

Commit

Permalink
query dir operations
Browse files Browse the repository at this point in the history
  • Loading branch information
yurvon-screamo committed Aug 27, 2024
1 parent 2855fa0 commit 073213d
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 11 deletions.
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Whether your test outputs format, Utsukushii helps you present your results with

## 🚀 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.
- **Dev modes**: Run tests and look at their result in 1 command
- **Merge reports**: Union multiple reports into single.

## 📥 Installation
Expand All @@ -26,24 +26,36 @@ go install github.com/yurvon-screamo/utsukushii@latest

## 📚 Usage

### Golang dev
### Dev mode

Run test, gen content and serve:
![dev_mode](dev_mode.png)

```bash
go test -v --json ./... | utsukushii go-dev
```
1) Create config file `utsukushii-dev.yaml`:

### Dotnet dev
```yaml
# Required part
# The command to run the tests
cmd: go test -v --json ./...
# Your solution language, oneof - 'go', '.net'
lang: go

Run test, gen content and serve:
# Optional part
# title: my report title
# coverage: 46
# addr: ':8080'
# ignore_open: true
```

```bash
dotnet test --logger trx | utsukushii dotnet-dev
```
2) Start it:

```bash
utsukushii dev
```

### Generate and Serve Reports

![gen_serve](gen_serve.png)

1. **Generate Content**:

```bash
Expand All @@ -56,6 +68,12 @@ dotnet test --logger trx | utsukushii dotnet-dev
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
Expand Down
Binary file added dev_mode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gen_serve.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions utsukushii-dev.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
# 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

0 comments on commit 073213d

Please sign in to comment.