trep

trep — Test Report Generator

trep converts test result files into a self-contained, searchable HTML report with no external runtime dependencies. Drop it into any CI pipeline and get a clean, filterable view of your test run in one portable file.

Features

• Multi-format input — JUnit XML, Google Test XML, go test -json, TAP 12/13
• Auto-detection — extension + content sniffing; no --format needed in most cases
• Multi-file merge — combine N result files into one unified report (or keep them separate with --no-merge)
• Self-contained HTML — zero external dependencies; one file you can attach to a PR or email
• Grouped + flat views — collapsible suite groups; click any header to sort flat
• Live search & filter — debounced search across suite/test name; pass/fail/skip filter buttons
• Pagination — 200 tests / 50 suites per page; smart page-range widget
• File/line links — Google Test XML file and line attrs are preserved and shown inline
• Slow test highlighting — tests in the top 10% of duration are highlighted
• CI integration — --fail exits 1 when any test failed; --quiet suppresses noise
• Browser launch — --open opens the report immediately after writing
• Shell completions — bash, zsh, fish, and PowerShell via trep completion <shell>
• Per-file coverage delta — when using --baseline, each file row in the coverage report shows its individual Δ% badge

Installation

Homebrew (macOS and Linux)

brew tap Yanujz/trep https://github.com/Yanujz/trep
brew install trep

Note: The Homebrew formula is updated automatically on each tagged release. If no release has been published yet, install via go install below.

Scoop (Windows)

scoop bucket add trep https://github.com/Yanujz/scoop-bucket
scoop install trep

go install

go install github.com/Yanujz/trep/cmd/trep@latest

Build from source

git clone https://github.com/Yanujz/trep
cd trep
go build -o trep ./cmd/trep/
# Optional: put on PATH
mv trep /usr/local/bin/

Requires Go 1.21+.

Pre-built binaries

Binaries for Linux, macOS (Intel and Apple Silicon), and Windows are published as GitHub Release assets on each tagged release. Download the archive for your platform from the Releases page and place the trep binary on your PATH.

Usage

trep <command> [flags] [args]

Commands:
  test        Parse test results → HTML report
  cov         Parse coverage data → HTML report
  report      Parse both → two linked HTML pages
  completion  Generate shell completion script

Shell completions

# bash
trep completion bash > /etc/bash_completion.d/trep

# zsh
trep completion zsh > "${fpath[1]}/_trep"

# fish
trep completion fish > ~/.config/fish/completions/trep.fish

# PowerShell
trep completion powershell | Out-String | Invoke-Expression

trep test flags

trep cov flags

trep report flags

Format values

Examples

Test results only:

trep test results.xml
trep test -o report.html -t "PR #42" a.xml b.xml c.xml
go test -json ./... | trep test - -t "Unit Tests"
trep test --fail -q results.xml                         # CI: exit 1 on failure
trep test --no-merge suite1.xml suite2.xml              # → suite1.html + suite2_02.html

Coverage only:

trep cov coverage.out                                   # Go coverprofile
trep cov coverage.info                                  # LCOV (gcov / Istanbul)
trep cov coverage.xml                                   # Cobertura / JaCoCo
trep cov --threshold 80 --fail coverage.out             # CI: enforce 80% line coverage
trep cov --strip-prefix /home/runner/work/repo/ cov.info

Delta badges (compare two runs):

# Run 1 — save snapshot
trep test --save-snapshot snap.json results.xml

# Run 2 — compare against saved snapshot
trep test --baseline snap.json --baseline-label "main" results_new.xml
# → delta badges show +3 pass / -1 fail / +2.1% coverage etc.

Combined linked report (two pages, shared nav):

trep report --tests results.xml --cov coverage.out
# → report_tests.html + report_cov.html (cross-linked via nav bar)

trep report \
  --tests unit.xml integration.xml \
  --cov coverage.info \
  --threshold 80 --fail-tests --fail-cov \
  --output-dir dist/ --prefix nightly \
  --title "Nightly CI" \
  --save-snapshot snap.json

Input Format Details

JUnit XML / Google Test XML

The standard <testsuites> / <testsuite> / <testcase> schema. Both formats share the same parser — Google Test XML is a superset that adds file and line attributes to <testcase> elements, which trep preserves and renders.

CTest's synthetic SKIP_REGULAR_EXPRESSION_MATCHED skip messages are automatically replaced with the human-readable reason extracted from <system-out>.

Compatible with: CTest, Maven Surefire, pytest-junit, JUnit 4/5, NUnit, xUnit.

go test -json

Produced by go test -json ./.... The parser processes the streaming event log, accumulates per-test output, and extracts meaningful failure messages while stripping boilerplate === RUN / --- FAIL header lines.

TAP (Test Anything Protocol) v12/13

Line-oriented ok / not ok records. Supports:

• Optional # time=N.NNN annotations (accumulated into report duration)
• # SKIP <reason> pragmas
• TAP 13 embedded YAML diagnostic blocks (skipped cleanly)

Project Structure

trep/
├── cmd/trep/
│   ├── main.go          # CLI entry point, Cobra root, browser launch helpers
│   ├── cmd_tests.go     # trep test subcommand
│   ├── cmd_cov.go       # trep cov subcommand
│   └── cmd_report.go    # trep report subcommand
└── pkg/
    ├── model/
    │   └── report.go    # Format-agnostic Report / Suite / TestCase types
    ├── parser/
    │   ├── parser.go    # Parser interface, registry, auto-detection
    │   ├── junit/       # JUnit XML + Google Test XML (streaming)
    │   ├── gotest/      # go test -json
    │   └── tap/         # TAP v12/13
    ├── coverage/
    │   ├── model/       # CovReport / FileCov types
    │   ├── parser/      # CovParser interface + lcov / gocover / cobertura / clover
    │   └── render/html/ # Coverage HTML renderer
    ├── delta/           # Snapshot save/load and run-over-run delta computation
    └── render/
        ├── html/        # Test HTML renderer
        ├── json/        # Structured JSON output
        ├── sarif/       # SARIF 2.1.0 output
        └── annotations/ # GitHub / GitLab CI annotation lines

Adding a new test format is two steps:

1. Create pkg/parser/<name>/parser.go implementing parser.Parser
2. Add a blank import in cmd/trep/main.go — the init() self-registers it

HTML Report Features

The generated report is fully self-contained — a single .html file with no external scripts, fonts, or stylesheets.

• Grouped view (default): suites collapse/expand on click; each suite shows a pass/fail badge
• Flat view: switch with the toggle button; supports click-to-sort on all columns
• Search: debounced 200 ms; matches suite name and test name simultaneously
• Filter buttons: All / Passed / Failed / Skipped
• Slow test detection: tests exceeding 10% of the max duration in the current view are highlighted
• Console output: failures with captured stdout show a "Show Console Output" toggle revealing a dark-themed pre block
• File/line: Google Test source locations rendered under the test name

CI Integration

GitHub Actions

- name: Generate test + coverage report
  run: |
    trep report \
      --tests build/test-results.xml \
      --cov build/coverage.out \
      --threshold 80 \
      --fail-tests --fail-cov \
      --annotate \
      --output-dir dist/ \
      --prefix ci \
      --baseline .trep/baseline.json \
      --baseline-label ${{ github.base_ref }}

- name: Upload report
  uses: actions/upload-artifact@v4
  with:
    name: test-report
    path: dist/

GitLab CI

test:
  script:
    - go test -json ./... > results.json
    - go test -coverprofile=coverage.out ./...
    - trep report
        --tests results.json
        --cov coverage.out
        --threshold 80
        --fail-tests --fail-cov
        --annotate --annotate-platform gitlab
        --output-dir public/
  artifacts:
    paths: [public/]
    expose_as: "Test Report"

Snapshot workflow (delta badges)

# On main branch after merge: save the baseline
trep report --tests results.xml --cov cov.out \
  --save-snapshot .trep/baseline.json

# On PR branches: compare against baseline
trep report --tests results.xml --cov cov.out \
  --baseline .trep/baseline.json \
  --baseline-label "main"
# → delta badges appear: "+2 pass / -1 fail / +3.2% cov"

Output Formats

SARIF output (GitHub Advanced Security)

SARIF files can be uploaded to GitHub Advanced Security and displayed as code scanning alerts directly in pull requests.

# Produce SARIF for failed tests
trep test --output-format sarif -o results.sarif junit.xml

# Produce SARIF for coverage — flags files below 80% as warnings
trep cov --output-format sarif --threshold 80 -o cov.sarif coverage.out

Upload in a workflow step:

- uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: results.sarif
    category: test-results

Behaviour:

• Test SARIF: each failing test case becomes a SARIF result with level error. File and line info are included when the input format provides them (e.g. GTest XML). Passing and skipped tests are omitted.
• Coverage SARIF: when --threshold is set, every file below the threshold becomes a result with level warning. When no threshold is set, an empty results array is produced (which clears any previous GHAS alerts).

JSON schema (test)

{
  "generated_at": "2024-03-15T10:00:00Z",
  "summary": { "total": 42, "passed": 40, "failed": 1, "skipped": 1, "pass_pct": 95.2 },
  "suites": [
    { "name": "CoreTests", "cases": [
      { "name": "TestAdd", "status": "pass", "duration_ms": 12 },
      { "name": "TestDiv", "status": "fail", "duration_ms": 5,
        "message": "expected 5, got 4", "file": "core_test.go", "line": 30 }
    ]}
  ]
}

JSON schema (coverage)

{
  "generated_at": "2024-03-15T10:00:00Z",
  "summary": {
    "lines_pct": 84.2, "lines_covered": 320, "lines_total": 380,
    "branch_pct": 71.0, "branch_covered": 142, "branch_total": 200,
    "func_pct": 91.3, "func_covered": 63, "func_total": 69,
    "file_count": 12
  },
  "files": [
    { "path": "src/parser.go",
      "lines_pct": 68.4, "lines_covered": 13, "lines_total": 19,
      "branch_pct": 75.0, "branch_covered": 3, "branch_total": 4 }
  ]
}

License

MIT