GitHub Action
TestVox - Turn test results into human readable reports
Testvox is tiny Rust library with a very simple objective: turning test reports into human readable summaries, to be shared on common messaging apps. The project simply deals with reports generation, it does not care about sending those reports.
At the minute, it only helps turning test results in Junit format into Slack messages, but I'd like add more parsers and reporters in future.
Its primary use case is probably within CI pipelines, although it can be used as CLI and as library as well.
Currently, only Github Actions are supported.
To use this as Github action it is enough to place the following step after your tests are generated and right before sending the message:
steps:
# ... Steps that generate test results ...
- uses: dili91/testvox@v0.1.0
name: Generate Slack report from Junit results
# if: always() // might be needed, depending on your pipeline
id: generate_slack_report
with:
include_skipped: true
reports_pattern: "./test-results/**/*.xml"
# ... Step that sends the report ...Below, and in the acceptance-test.yml file you can find a full example:
on: [push]
jobs:
tests:
name: Acceptance Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dili91/testvox@v0.1.0
name: Generate Slack report from Junit results
# if: always() // might be needed, depending on your pipeline
id: generate_slack_report
with:
include_skipped: true
reports_pattern: "./test-results/**/*.xml"
- name: Send Slack report
uses: slackapi/slack-github-action@v1.26.0
with:
payload: ${{steps.generate_slack_report.outputs.report}}
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
The Github action has the following requirements and defaults values:
| Name | Required | Default |
|---|---|---|
| title | ✅ | ${{ github.repository }} test report |
| reports_pattern | ✅ | ./build/test-results/*.xml |
| include_skipped | ❌ | false |
| include_passed | ❌ | false |
| link | ❌ | ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} |
Install the library locally:
cargo install testvoxthen, invoke it from your terminal:
testvox --help
Turns test reports into human readable summaries, to be shared on common messaging apps
Usage: testvox [OPTIONS] --title <TITLE>
Options:
-t, --title <TITLE>
The title of the test report
-s, --include-skipped
Whether to include skipped tests in the report
-p, --include-passed
Whether to include passed tests in the report
-r, --reports-pattern <REPORTS_PATTERN>...
The test report pattern to look for [default: ./build/test-results/**/*.xml,./app/build/test-results/**/*.xml]
-h, --help
Print helpOptionally, you can get the same use the Docker image:
docker run --platform=linux/amd64 -v $(PWD):/tmp adilisio/testvox:0.2.0 -p -t "Hello!" -r "/tmp/**/*.xml"
{
"blocks": [
{
"type": "header",
"text": {
"type": "plain_text",
"text": "Hello!",
"emoji": true
}
},
{
"type": "divider"
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "✅ _/observe/health endpoint should return 200 and health information_ *passed* (`0.049s`)"
}
},
{
"type": "divider"
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "✅ _/posts endpoint should return 200 with a list of posts_ *passed* (`0.06s`)"
}
},
{
"type": "divider"
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "✅ _It should yield a Post mapper_ *passed* (`0.01s`)"
}
},
{
"type": "divider"
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "✅ _It should convert a raw DbRow object to a Post object_ *passed* (`0.616s`)"
}
}
]
}Testvox can be also used as library when needed. You can install it by adding the crate to your project:
cargo add testvoxYou can then refer to its create_test_report function to start using it.