uutils / coreutils

Cross-platform Rust rewrite of the GNU coreutils
https://uutils.github.io/
MIT License
17.7k stars 1.27k forks source link

CI: add report for tests results (Markdown format) #5879

Open lcheylus opened 9 months ago

lcheylus commented 9 months ago

GitHub workflow allows to add a Job summary with Markdown format:

In GH workflows, tests are runned with cargo-nextest tool (instead of cargo test). With version 0.9.66 and above, it adds an experimental support for producing machine-readable output for test runs, in a format similar to cargo test's libtest JSON output => https://nexte.st/book/run-machine-readable.html

I tried to use this feature to generate file results for tests (JSON format) and to use them to generate summaries after end of the tests in FreeBSD workflow (could also be added in other workflows including tests).

NEXTEST_EXPERIMENTAL_LIBTEST_JSON=1 cargo nextest run --hide-progress-bar --profile ci --all-features -p uucore --message-format libtest-json-plus 1> "${WORKSPACE}/tests-uucore.json"



- JSON files are copied back from VM to runner/host (`copyback: true` parameter for the FreeBSD VM action).

- Add a new step at the end of "Tests" job to parse JSON files and generate summaries (Markdown format)

You could see an example of these summaries in my own repository ("ugly" main branch with a modified FreeBSD workflow, issue #5797 for details) => https://github.com/lcheylus/rust-coreutils/actions/runs/7653519450

I need to do **additional tests when some tests are NOK/FAILED** and include them in the summary.
lcheylus commented 9 months ago

I added case in FreeBSD CI/workflow when tests failed : the summary (Markdown format) displays a specific status for tests failure and the list of failed tests.

You can see an example of such a case with my OpenBSD workflow (WIP) : https://github.com/lcheylus/rust-coreutils/actions/runs/7669296982