action.yml

name: 'fish-shop/run-fishtape-tests'
description: 'A GitHub action for running fishtape tests'
branding:
  icon: 'check-square'
  color: 'green'
inputs:
  title:
    description: 'Title to display in job summary'
    required: false
    default: 'Test results'
  patterns:
    description: 'File patterns to match against when running tests'
    required: false
    default: '**.fish'
  raw-output:
    description: 'Produce raw TAP output'
    required: false
    default: 'false'
outputs:
  total:
    description: "Total number of tests run"
    value: ${{ steps.run-fishtape-tests.outputs.total }}
  passed:
    description: "Number of tests passed"
    value: ${{ steps.run-fishtape-tests.outputs.passed }}
  failed:
    description: "Number of tests failed"
    value: ${{ steps.run-fishtape-tests.outputs.failed }}
runs:
  using: 'composite'
  steps:
    - name: Install fisher
      uses: fish-shop/install-plugin@e3c44aa8a5f9ada23260ae77277de124efb29242 # v2.3.28
      with:
        plugin-manager: fisher
        plugins: jorgebucaran/fishtape
    - name: Install tap-diff
      run: npm install -g tap-diff
      shell: fish {0}
    - name: Run fishtape tests
      id: run-fishtape-tests
      env:
        TITLE: ${{ inputs.title }}
        PATTERNS: ${{ inputs.patterns }}
        RAW_OUTPUT: ${{ inputs.raw-output }}
      run: |
        set -gx TERM xterm-256color
        set -gx FORCE_COLOR 2

        set title "$TITLE"
        set raw_output (string escape --no-quoted -- $RAW_OUTPUT)

        for pattern in (string split --no-empty -- " " $PATTERNS)
            set -l escaped (string escape --style=script --no-quoted -- $pattern)
            set -l escaped (string replace -r -a -- '\\\([?*{}])' '$1' $escaped)
            eval set -a files $escaped
        end

        switch $raw_output
            case true
                fishtape $files | tee output
            case false
                fishtape $files | tee output | tap-diff
            case '*'
                echo "Unrecognised raw output option: '$raw_output'" >&2
                exit 1
        end

        set total (tail -n 4 output | sed -rn 's/^[[:digit:]]\.\.([[:digit:]]+)$/\1/p')
        set passed (tail -n 4 output | sed -rn 's/^# pass ([[:digit:]]+)$/\1/p')
        set failed (tail -n 4 output | sed -rn 's/^# fail ([[:digit:]]+)$/\1/p')

        for param in total passed failed
            if test -z "$$param"
                set $param 0
            end
        end

        if test "$failed" = "0"
            set result ":white_check_mark: Pass"
        else
            set result ":x: Fail"
        end

        echo "### $title" >> $GITHUB_STEP_SUMMARY
        echo "" >> $GITHUB_STEP_SUMMARY
        echo "| Test result :microscope: | Passed :white_check_mark: | Failed :x: |" >> $GITHUB_STEP_SUMMARY
        echo "|--------------------------|---------------------------|------------|" >> $GITHUB_STEP_SUMMARY
        echo "| $result                  | $passed                   | $failed    |" >> $GITHUB_STEP_SUMMARY

        echo "total=$total" >> "$GITHUB_OUTPUT"
        echo "passed=$passed" >> "$GITHUB_OUTPUT"
        echo "failed=$failed" >> "$GITHUB_OUTPUT"

        if test "$failed" != "0"
            exit 1
        end
      shell: fish {0}