pcolby/tap-summary

GitHub Action for summarising TAP (Test Anything Protocol) test results

TAP Summary

GitHub Action for summarising TAP (Test Anything Protocol) test results. It summarises a collection of TAP files (such a produced by Qt Tests), and writes the result as a Markdown table to the GitHub step summary by default, or some other destination file if overridden.

Usage

- uses: pcolby/tap-summary@v1

Note, this will use a default path of **/*.tap, which depends on Bash's globstar support, which is not available on macOS's default Bash (which is really old). For macOS, either provide paths that don't depend on globstar, or upgrade Bash (eg via brew). This is not necessary for Linux and Windows.

Inputs

path

One or more paths to TAP files. This will undergo Bash expansion, so things like environment variables can be used, and must be quoted or escaped as appropriate.

Defaults to **/*.tap.

- uses: pcolby/tap-summary@v1
  with:
    path: >-
      path/to/tap-file
      'path/to a file with spaces.tap'
      path/with/globstar/**/*.tap
    summary-file: path/to/output/file.md

summary-file

The file to append the test summary to. Defaults to $GITHUB_STEP_SUMMARY.

- uses: pcolby/tap-summary@v1
  with:
    summary-file: path/to/output/file.md

Outputs

summary-file

The file the test summary was appended to. This is mostly just for automated tests, where it allows the invoking workflow job to check the summary output when the input summary-file is defaulted.

tap-summary's Issues

Does not appear to do anything

I get this output:

Run pcolby/tap-summary@v1
  with:
    path: /tmp/*.tap
  
    summary-file: tap_summary.md
Run set -o errexit -o noclobber -o nounset -o pipefail
  set -o errexit -o noclobber -o nounset -o pipefail
  [[ -z "$(shopt globstar [2](https://github.com/Buzztrax/buzztrax/actions/runs/7856445010/job/21439210478#step:9:2)> /dev/null)" ]] && echo 'Shell does not support globstar' || shopt -s globstar
  : "${SUMMARY_FILE:=$GITHUB_STEP_SUMMARY}"
  gawk --file "$GITHUB_ACTION_PATH/summary.gawk" --sandbox -- /tmp/*.tap
   >> "$SUMMARY_FILE"
  echo "summary-file=$SUMMARY_FILE" >> "$GITHUB_OUTPUT"
  shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
  env:
    SUMMARY_FILE: tap_summary.md
|       Test result       | Passed | Failed | Skipped | Test name |
|:------------------------|-------:|-------:|--------:|:---|
| :heavy_check_mark: pass |      0 |      0 |       0 | 2  |
| :heavy_check_mark: pass |      0 |      0 |       0 | ok |

example tap file from /tmp/*.tap (you can download the artifact.zip from the linked build too):

ok 1 - tests/lib/bml/e-core.c:BmlCoreExamples:test_bml_setup: Passed
ok 2 - tests/lib/bml/e-core.c:BmlCoreExamples:test_bml_finalize: Passed
ok 3 - tests/lib/bml/e-core.c:BmlCoreExamples:test_bmln_master_info: Passed
ok 4 - tests/lib/bml/e-core.c:BmlCoreExamples:test_bmln_open: Passed
ok 5 - tests/lib/bml/e-class.c:BmlClassExamples:test_bmln_get_machine_info: Passed
1..5