refactor: move test utils package into isolation to avoid every user to import test stuff #685
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| on: pull_request | |
| name: pull_request | |
| jobs: | |
| staticcheck: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: install Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: 1.21.x | |
| - name: install deps | |
| run: go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest | |
| - name: gofmt | |
| run: if [[ -n $(gofmt -l .) ]]; then echo "please run gofmt"; exit 1; fi | |
| - name: generated files should not be modified | |
| run: | | |
| go generate ./... | |
| git update-index --assume-unchanged go.mod | |
| git update-index --assume-unchanged go.sum | |
| if [[ -n $(git status --porcelain) ]]; then echo "git repo is dirty after running go generate -- please don't modify generated files"; echo $(git diff);echo $(git status --porcelain); exit 1; fi | |
| # hack to ensure golanglint process generated files | |
| - name: remove "generated by" comments from generated files | |
| run: | | |
| find . -type f -name '*.go' -exec sed -i 's/Code generated by .* DO NOT EDIT/FOO/g' {} \; | |
| # on macos: find . -type f -name '*.go' -exec sed -i '' -E 's/Code generated by .* DO NOT EDIT/FOO/g' {} \; | |
| - name: golangci-lint | |
| uses: golangci/golangci-lint-action@v3 | |
| with: | |
| version: v1.54 | |
| args: -v --timeout=5m | |
| skip-pkg-cache: true | |
| test: | |
| runs-on: ubuntu-22.04-16core | |
| permissions: | |
| pull-requests: write | |
| outputs: | |
| failures: ${{ steps.generate-job-summary.outputs.failures }} | |
| steps: | |
| - name: checkout code | |
| uses: actions/checkout@v4 | |
| - name: install Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: 1.21.x | |
| - name: install deps | |
| run: | | |
| go install golang.org/x/tools/cmd/goimports@latest && go install github.com/klauspost/asmfmt/cmd/asmfmt@latest | |
| # Install gotestfmt on the VM running the action. | |
| - name: Set up gotestfmt | |
| uses: gotesttools/gotestfmt-action@v2 | |
| with: | |
| # Optional: pass GITHUB_TOKEN to avoid rate limiting. | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| # Run tests with nice formatting. Save the original log in /tmp/gotest.log | |
| - name: Run tests | |
| run: | | |
| set -euo pipefail | |
| go test -json -v -short -timeout=30m ./... 2>&1 | gotestfmt -hide=all | tee /tmp/gotest.log | |
| go test -json -v -tags=purego -timeout=30m ./... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log | |
| go test -json -v -race -timeout=30m ./ecc/bn254/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log | |
| GOARCH=386 go test -json -short -v -timeout=30m ./ecc/bn254/... 2>&1 | gotestfmt -hide=all | tee -a /tmp/gotest.log | |
| - name: Generate job summary | |
| id: generate-job-summary | |
| if: ${{ always() }} | |
| run: | | |
| if [ -s /tmp/gotest.log ]; then | |
| cat /tmp/gotest.log > $GITHUB_STEP_SUMMARY | |
| echo "failures=$(cat /tmp/gotest.log | node .github/parse-tests.js)" > $GITHUB_OUTPUT | |
| else | |
| echo "## Success ✅" > $GITHUB_STEP_SUMMARY | |
| echo "failures=" > $GITHUB_OUTPUT | |
| fi | |
| # if we failed a test, we want to comment on the PR with the log | |
| - name: PR comment with file | |
| if: ${{ failure() }} | |
| uses: thollander/actions-comment-pull-request@v2 | |
| with: | |
| filePath: /tmp/gotest.log | |
| slack-workflow-status-failed: | |
| if: failure() | |
| name: post workflow status to slack | |
| needs: | |
| - staticcheck | |
| - test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Notify slack -- workflow failed | |
| id: slack | |
| uses: slackapi/slack-github-action@v1.24.0 | |
| with: | |
| payload: | | |
| { | |
| "actor": "${{ github.actor }}", | |
| "repo": "${{ github.repository }}", | |
| "status": "FAIL", | |
| "title": "${{ github.event.pull_request.title }}", | |
| "pr": "${{ github.event.pull_request.head.ref }}", | |
| "failed_step_url": "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/", | |
| "message": "${{ needs.test.outputs.failures }}" | |
| } | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} | |
| slack-workflow-status-success: | |
| if: success() | |
| name: post workflow status to slack | |
| needs: | |
| - staticcheck | |
| - test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Notify slack -- workflow succeeded | |
| id: slack | |
| uses: slackapi/slack-github-action@v1.24.0 | |
| with: | |
| payload: | | |
| { | |
| "actor": "${{ github.actor }}", | |
| "repo": "${{ github.repository }}", | |
| "status": "SUCCESS", | |
| "title": "${{ github.event.pull_request.title }}", | |
| "pr": "${{ github.event.pull_request.head.ref }}" | |
| } | |
| env: | |
| SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_SUCCESS }} |