444 lines
16 KiB
YAML
444 lines
16 KiB
YAML
name: Playwright Tests
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
- ryanrosello-og/playwright-test-coverage
|
|
pull_request:
|
|
branches: [ main ]
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: write
|
|
pull-requests: write
|
|
actions: read
|
|
|
|
|
|
jobs:
|
|
|
|
check-rust-changes:
|
|
runs-on: ubuntu-latest
|
|
outputs:
|
|
rust-changed: ${{ steps.filter.outputs.rust }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- id: filter
|
|
name: Check for Rust changes
|
|
uses: dorny/paths-filter@v3
|
|
with:
|
|
filters: |
|
|
rust:
|
|
- 'src/wasm-lib/**'
|
|
|
|
playwright-ubuntu:
|
|
timeout-minutes: 30
|
|
runs-on: ubuntu-latest
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
shardIndex: [1, 2, 3, 4]
|
|
shardTotal: [4]
|
|
needs: check-rust-changes
|
|
steps:
|
|
- name: Tune GitHub-hosted runner network
|
|
uses: smorimoto/tune-github-hosted-runner-network@v1
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
cache: 'yarn'
|
|
- uses: KittyCAD/action-install-cli@main
|
|
- name: Install dependencies
|
|
run: yarn
|
|
- name: Cache Playwright Browsers
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cache/ms-playwright/
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('yarn.lock') }}
|
|
- name: Install Playwright Browsers
|
|
run: yarn playwright install --with-deps
|
|
- name: Download Wasm Cache
|
|
id: download-wasm
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'false'
|
|
uses: dawidd6/action-download-artifact@v6
|
|
continue-on-error: true
|
|
with:
|
|
github_token: ${{secrets.GITHUB_TOKEN}}
|
|
name: wasm-bundle
|
|
workflow: build-and-store-wasm.yml
|
|
branch: main
|
|
path: src/wasm-lib/pkg
|
|
- name: copy wasm blob
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'false'
|
|
run: cp src/wasm-lib/pkg/wasm_lib_bg.wasm public
|
|
continue-on-error: true
|
|
- name: Setup Rust
|
|
uses: dtolnay/rust-toolchain@stable
|
|
- name: Cache Wasm (because rust diff)
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'true'
|
|
uses: Swatinem/rust-cache@v2
|
|
with:
|
|
workspaces: './src/wasm-lib'
|
|
- name: OR Cache Wasm (because wasm cache failed)
|
|
if: steps.download-wasm.outcome == 'failure'
|
|
uses: Swatinem/rust-cache@v2
|
|
with:
|
|
workspaces: './src/wasm-lib'
|
|
- name: Install vector
|
|
run: |
|
|
curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
|
|
chmod +x /tmp/vector.sh
|
|
/tmp/vector.sh -y -no-modify-path
|
|
mkdir -p /tmp/vector
|
|
cp .github/workflows/vector.toml /tmp/vector.toml
|
|
sed -i "s#GITHUB_WORKFLOW#${GITHUB_WORKFLOW}#g" /tmp/vector.toml
|
|
sed -i "s#GITHUB_REPOSITORY#${GITHUB_REPOSITORY}#g" /tmp/vector.toml
|
|
sed -i "s#GITHUB_SHA#${GITHUB_SHA}#g" /tmp/vector.toml
|
|
sed -i "s#GITHUB_REF_NAME#${GITHUB_REF_NAME}#g" /tmp/vector.toml
|
|
sed -i "s#GH_ACTIONS_AXIOM_TOKEN#${{secrets.GH_ACTIONS_AXIOM_TOKEN}}#g" /tmp/vector.toml
|
|
cat /tmp/vector.toml
|
|
${HOME}/.vector/bin/vector --config /tmp/vector.toml &
|
|
- name: Build Wasm (because rust diff)
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'true'
|
|
run: yarn build:wasm
|
|
- name: OR Build Wasm (because wasm cache failed)
|
|
if: steps.download-wasm.outcome == 'failure'
|
|
run: yarn build:wasm
|
|
- name: build web
|
|
run: yarn build:local
|
|
- name: Run ubuntu/chrome snapshots
|
|
run: |
|
|
yarn playwright test --project="Google Chrome" --retries="3" --update-snapshots --grep=@snapshot --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
|
|
env:
|
|
CI: true
|
|
token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
|
|
snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
|
|
- uses: actions/upload-artifact@v4
|
|
if: always()
|
|
with:
|
|
name: playwright-report-ubuntu-snapshot-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: playwright-report/
|
|
retention-days: 30
|
|
overwrite: true
|
|
- name: Clean up test-results
|
|
if: always()
|
|
continue-on-error: true
|
|
run: rm -r test-results
|
|
- name: check for changes
|
|
id: git-check
|
|
run: |
|
|
git add .
|
|
if git status | grep -q "Changes to be committed"
|
|
then echo "modified=true" >> $GITHUB_OUTPUT
|
|
else echo "modified=false" >> $GITHUB_OUTPUT
|
|
fi
|
|
- name: Commit changes, if any
|
|
if: steps.git-check.outputs.modified == 'true'
|
|
run: |
|
|
git add .
|
|
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config --local user.name "github-actions[bot]"
|
|
git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
|
|
git fetch origin
|
|
echo ${{ github.head_ref }}
|
|
git checkout ${{ github.head_ref }}
|
|
# TODO when webkit works on ubuntu remove the os part of the commit message
|
|
git commit -am "A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)" || true
|
|
git push
|
|
git push origin ${{ github.head_ref }}
|
|
# only upload artifacts if there's actually changes
|
|
- uses: actions/upload-artifact@v4
|
|
if: steps.git-check.outputs.modified == 'true'
|
|
with:
|
|
name: playwright-report-ubuntu-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: playwright-report/
|
|
retention-days: 30
|
|
# if have previous run results, use them
|
|
- uses: actions/download-artifact@v4
|
|
if: always()
|
|
continue-on-error: true
|
|
with:
|
|
name: test-results-ubuntu-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: test-results/
|
|
- name: Run ubuntu/chrome flow (with retries)
|
|
id: retry
|
|
if: always()
|
|
run: |
|
|
if [[ ! -f "test-results/.last-run.json" ]]; then
|
|
# if no last run artifact, than run plawright normally
|
|
echo "run playwright normally"
|
|
yarn playwright test --project="Google Chrome" --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
|
|
# # send to axiom
|
|
node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
|
|
fi
|
|
|
|
retry=1
|
|
max_retrys=4
|
|
|
|
# retry failed tests, doing our own retries because using inbuilt playwright retries causes connection issues
|
|
while [[ $retry -le $max_retrys ]]; do
|
|
if [[ -f "test-results/.last-run.json" ]]; then
|
|
failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
|
|
if [[ $failed_tests -gt 0 ]]; then
|
|
echo "retried=true" >>$GITHUB_OUTPUT
|
|
echo "run playwright with last failed tests and retry $retry"
|
|
yarn playwright test --project="Google Chrome" --last-failed --grep-invert=@snapshot || true
|
|
# send to axiom
|
|
node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
|
|
retry=$((retry + 1))
|
|
else
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
exit 0
|
|
fi
|
|
else
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
exit 0
|
|
fi
|
|
done
|
|
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
|
|
if [[ -f "test-results/.last-run.json" ]]; then
|
|
failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
|
|
if [[ $failed_tests -gt 0 ]]; then
|
|
# if it still fails after 3 retrys, then fail the job
|
|
exit 1
|
|
fi
|
|
fi
|
|
exit 0
|
|
env:
|
|
CI: true
|
|
token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
|
|
GENERATE_PLAYWRIGHT_COVERAGE: true
|
|
- name: send to axiom
|
|
if: always()
|
|
shell: bash
|
|
run: |
|
|
node playwrightProcess.mjs | tee /tmp/github-actions.log
|
|
- uses: actions/upload-artifact@v4
|
|
if: always()
|
|
with:
|
|
name: test-results-ubuntu-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: test-results/
|
|
retention-days: 30
|
|
overwrite: true
|
|
- uses: actions/upload-artifact@v4
|
|
if: always()
|
|
with:
|
|
name: playwright-report-ubuntu-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: playwright-report/
|
|
retention-days: 30
|
|
overwrite: true
|
|
- uses: actions/upload-artifact@v4
|
|
if: always()
|
|
with:
|
|
name: playwright-coverage-ubuntu-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: .nyc_output/
|
|
retention-days: 30
|
|
overwrite: true
|
|
|
|
playwright-macos:
|
|
timeout-minutes: 30
|
|
runs-on: macos-14
|
|
strategy:
|
|
fail-fast: false
|
|
matrix:
|
|
shardIndex: [1, 2, 3, 4]
|
|
shardTotal: [4]
|
|
needs: check-rust-changes
|
|
steps:
|
|
- name: Tune GitHub-hosted runner network
|
|
uses: smorimoto/tune-github-hosted-runner-network@v1
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
cache: 'yarn'
|
|
- name: Install dependencies
|
|
run: yarn
|
|
- name: Cache Playwright Browsers
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: |
|
|
~/.cache/ms-playwright
|
|
key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-playwright-
|
|
- name: Install Playwright Browsers
|
|
run: yarn playwright install --with-deps
|
|
- name: Download Wasm Cache
|
|
id: download-wasm
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'false'
|
|
uses: dawidd6/action-download-artifact@v6
|
|
continue-on-error: true
|
|
with:
|
|
github_token: ${{secrets.GITHUB_TOKEN}}
|
|
name: wasm-bundle
|
|
workflow: build-and-store-wasm.yml
|
|
branch: main
|
|
path: src/wasm-lib/pkg
|
|
- name: copy wasm blob
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'false'
|
|
run: cp src/wasm-lib/pkg/wasm_lib_bg.wasm public
|
|
continue-on-error: true
|
|
- name: Setup Rust
|
|
uses: dtolnay/rust-toolchain@stable
|
|
- name: Cache Wasm (because rust diff)
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'true'
|
|
uses: Swatinem/rust-cache@v2
|
|
with:
|
|
workspaces: './src/wasm-lib'
|
|
- name: OR Cache Wasm (because wasm cache failed)
|
|
if: steps.download-wasm.outcome == 'failure'
|
|
uses: Swatinem/rust-cache@v2
|
|
with:
|
|
workspaces: './src/wasm-lib'
|
|
- name: Install vector
|
|
run: |
|
|
curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
|
|
chmod +x /tmp/vector.sh
|
|
/tmp/vector.sh -y -no-modify-path
|
|
mkdir -p /tmp/vector
|
|
cp .github/workflows/vector.toml /tmp/vector.toml
|
|
sed -i "" "s#GITHUB_WORKFLOW#${GITHUB_WORKFLOW}#g" /tmp/vector.toml
|
|
sed -i "" "s#GITHUB_REPOSITORY#${GITHUB_REPOSITORY}#g" /tmp/vector.toml
|
|
sed -i "" "s#GITHUB_SHA#${GITHUB_SHA}#g" /tmp/vector.toml
|
|
sed -i "" "s#GITHUB_REF_NAME#${GITHUB_REF_NAME}#g" /tmp/vector.toml
|
|
sed -i "" "s#GH_ACTIONS_AXIOM_TOKEN#${{secrets.GH_ACTIONS_AXIOM_TOKEN}}#g" /tmp/vector.toml
|
|
cat /tmp/vector.toml
|
|
${HOME}/.vector/bin/vector --config /tmp/vector.toml &
|
|
- name: Build Wasm (because rust diff)
|
|
if: needs.check-rust-changes.outputs.rust-changed == 'true'
|
|
run: yarn build:wasm
|
|
- name: OR Build Wasm (because wasm cache failed)
|
|
if: steps.download-wasm.outcome == 'failure'
|
|
run: yarn build:wasm
|
|
- name: build web
|
|
run: yarn build:local
|
|
# if have previous run results, use them
|
|
- uses: actions/download-artifact@v4
|
|
if: ${{ always() }}
|
|
continue-on-error: true
|
|
with:
|
|
name: test-results-macos-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: test-results/
|
|
- name: Run macos/safari flow (with retries)
|
|
id: retry
|
|
if: always()
|
|
run: |
|
|
if [[ ! -f "test-results/.last-run.json" ]]; then
|
|
# if no last run artifact, than run plawright normally
|
|
echo "run playwright normally"
|
|
yarn playwright test --project="webkit" --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --grep-invert=@snapshot || true
|
|
# # send to axiom
|
|
node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
|
|
fi
|
|
|
|
retry=1
|
|
max_retrys=4
|
|
|
|
# retry failed tests, doing our own retries because using inbuilt playwright retries causes connection issues
|
|
while [[ $retry -le $max_retrys ]]; do
|
|
if [[ -f "test-results/.last-run.json" ]]; then
|
|
failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
|
|
if [[ $failed_tests -gt 0 ]]; then
|
|
echo "retried=true" >>$GITHUB_OUTPUT
|
|
echo "run playwright with last failed tests and retry $retry"
|
|
yarn playwright test --project="webkit" --last-failed --grep-invert=@snapshot || true
|
|
# send to axiom
|
|
node playwrightProcess.mjs | tee /tmp/github-actions.log > /dev/null 2>&1
|
|
retry=$((retry + 1))
|
|
else
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
exit 0
|
|
fi
|
|
else
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
exit 0
|
|
fi
|
|
done
|
|
|
|
echo "retried=false" >>$GITHUB_OUTPUT
|
|
|
|
if [[ -f "test-results/.last-run.json" ]]; then
|
|
failed_tests=$(jq '.failedTests | length' test-results/.last-run.json)
|
|
if [[ $failed_tests -gt 0 ]]; then
|
|
# if it still fails after 3 retrys, then fail the job
|
|
exit 1
|
|
fi
|
|
fi
|
|
exit 0
|
|
env:
|
|
CI: true
|
|
token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
|
|
GENERATE_PLAYWRIGHT_COVERAGE: true
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ always() }}
|
|
with:
|
|
name: test-results-macos-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: test-results/
|
|
retention-days: 30
|
|
overwrite: true
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ always() }}
|
|
with:
|
|
name: playwright-report-macos-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: playwright-report/
|
|
retention-days: 30
|
|
overwrite: true
|
|
- uses: actions/upload-artifact@v4
|
|
if: ${{ always() }}
|
|
with:
|
|
name: playwright-coverage-macos-${{ matrix.shardIndex }}-${{ github.sha }}
|
|
path: .nyc_output/
|
|
retention-days: 30
|
|
overwrite: true
|
|
|
|
|
|
# only run this job after all shards above have completed
|
|
# TBC: do we want to separate coverage reports by OS?
|
|
# the Job below combines both chrome and webkit coverage reports
|
|
merge-coverage-reports:
|
|
# Merge reports after playwright-tests, even if some shards have failed
|
|
if: ${{ !cancelled() }}
|
|
needs: [playwright-ubuntu]
|
|
# only report on ubuntu (Google chrome) for now
|
|
# needs: [playwright-ubuntu, playwright-macos]
|
|
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version-file: '.nvmrc'
|
|
cache: 'yarn'
|
|
- uses: KittyCAD/action-install-cli@main
|
|
- name: Install dependencies
|
|
run: yarn
|
|
|
|
- name: Download coverage reports from GitHub Actions Artifacts
|
|
uses: actions/download-artifact@v4
|
|
with:
|
|
path: .all_coverage_reports
|
|
pattern: playwright-coverage*
|
|
merge-multiple: true
|
|
|
|
- name: Merge all coverage reports from all shards into a single json report
|
|
run: npx nyc merge .all_coverage_reports ./.nyc_output/coverage.json
|
|
|
|
- name: Generate HTML coverage report
|
|
run: npx nyc report --reporter=html || true
|
|
|
|
- name: Upload Convertage HTML report
|
|
uses: actions/upload-artifact@v4
|
|
with:
|
|
name: coverage-report-${{ github.sha }}
|
|
path: coverage
|
|
retention-days: 14
|