woocommerce/.github/workflows/pr-build-and-e2e-tests.yml

309 lines
12 KiB
YAML
Raw Normal View History

2022-04-27 14:29:33 +00:00
name: Run tests against PR
2022-05-17 13:20:23 +00:00
on:
pull_request:
workflow_dispatch:
2022-05-17 13:20:23 +00:00
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
2022-04-21 16:45:12 +00:00
2022-05-24 05:27:53 +00:00
env:
E2E_PLAYWRIGHT: true
2022-05-24 05:11:12 +00:00
2022-05-24 05:27:53 +00:00
jobs:
e2e-tests-run:
name: Runs E2E tests.
runs-on: ubuntu-20.04
steps:
2022-05-17 13:20:23 +00:00
- uses: actions/checkout@v3
2022-05-17 16:26:08 +00:00
- uses: ./.github/actions/cache-deps
with:
workflow_name: pr-build-and-e2e-tests
workflow_cache: ${{ secrets.WORKFLOW_CACHE }}
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
2022-05-17 16:26:08 +00:00
- name: Install and Build
uses: ./.github/actions/install-build
2022-03-31 22:08:52 +00:00
- name: Load docker images and start containers.
working-directory: plugins/woocommerce
2022-04-21 16:45:12 +00:00
run: pnpm exec wc-e2e docker:up
2022-03-31 22:08:52 +00:00
- name: Run Puppeteer E2E tests.
if: fromJSON(env.E2E_PLAYWRIGHT) != true
id: run-puppeteer-e2e-tests
working-directory: plugins/woocommerce
env:
WC_E2E_SCREENSHOTS: 1
E2E_SLACK_TOKEN: ${{ secrets.E2E_SLACK_TOKEN }}
E2E_SLACK_CHANNEL: ${{ secrets.E2E_SLACK_CHANNEL }}
2022-04-21 16:45:12 +00:00
run: pnpm exec wc-e2e test:e2e
- name: Archive Puppeteer E2E test results
if: |
always() &&
fromJSON(env.E2E_PLAYWRIGHT) != true &&
(
steps.run-puppeteer-e2e-tests.conclusion != 'cancelled' ||
steps.run-puppeteer-e2e-tests.conclusion != 'skipped'
)
uses: actions/upload-artifact@v3
with:
name: pptr-e2e-test-results
path: plugins/woocommerce/tests/e2e/test-results.json
if-no-files-found: ignore
retention-days: 5
2022-05-24 06:44:10 +00:00
- name: Download and install Chromium browser.
if: fromJSON(env.E2E_PLAYWRIGHT)
working-directory: plugins/woocommerce
2022-05-24 06:06:23 +00:00
run: pnpx playwright install chromium
- name: Run Playwright E2E tests.
2022-07-19 17:28:15 +00:00
timeout-minutes: 60
2022-05-24 04:36:57 +00:00
id: run_playwright_e2e_tests
if: fromJSON(env.E2E_PLAYWRIGHT)
working-directory: plugins/woocommerce
run: pnpx playwright test --config=e2e/playwright.config.js
- name: Generate Playwright E2E Test report.
id: generate_e2e_report
2022-05-24 04:36:57 +00:00
if: |
always() &&
fromJSON(env.E2E_PLAYWRIGHT) &&
2022-05-24 04:36:57 +00:00
(
steps.run_playwright_e2e_tests.conclusion != 'cancelled' ||
steps.run_playwright_e2e_tests.conclusion != 'skipped'
)
2022-05-20 08:08:49 +00:00
working-directory: plugins/woocommerce
2022-05-24 03:19:52 +00:00
run: pnpx allure generate --clean e2e/allure-results --output e2e/allure-report
2022-05-20 08:08:49 +00:00
- name: Archive Playwright E2E test report
if: |
always() &&
fromJSON(env.E2E_PLAYWRIGHT) &&
steps.generate_e2e_report.conclusion == 'success'
uses: actions/upload-artifact@v3
with:
name: e2e-test-report---pr-${{ github.event.number }}
path: |
plugins/woocommerce/e2e/allure-results
plugins/woocommerce/e2e/allure-report
if-no-files-found: ignore
retention-days: 5
- name: Archive Puppeteer E2E test screenshots
2022-04-21 16:45:12 +00:00
uses: actions/upload-artifact@v3
if: |
always() &&
(
fromJSON(env.E2E_PLAYWRIGHT) != true
)
with:
name: E2E Screenshots
path: plugins/woocommerce/tests/e2e/screenshots
if-no-files-found: ignore
retention-days: 5
2021-11-16 15:45:12 +00:00
api-tests-run:
name: Runs API tests.
runs-on: ubuntu-20.04
env:
API_TEST_REPORT_DIR: ${{ github.workspace }}/api-test-report
2021-11-16 15:45:12 +00:00
steps:
2022-05-17 13:24:49 +00:00
- uses: actions/checkout@v3
2022-05-17 16:26:08 +00:00
- uses: ./.github/actions/cache-deps
with:
workflow_name: pr-build-and-e2e-tests
workflow_cache: ${{ secrets.WORKFLOW_CACHE }}
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
2022-05-17 16:26:08 +00:00
- name: Install and Build
uses: ./.github/actions/install-build
2022-03-31 21:53:27 +00:00
- name: Load docker images and start containers.
working-directory: plugins/woocommerce
2022-04-21 16:45:12 +00:00
run: pnpm exec wc-e2e docker:up
2022-03-31 21:53:27 +00:00
2021-11-16 15:45:12 +00:00
- name: Run tests command.
2022-04-27 14:29:33 +00:00
working-directory: plugins/woocommerce
2021-11-16 15:45:12 +00:00
env:
2022-04-27 14:45:10 +00:00
BASE_URL: http://localhost:8086
2022-01-14 16:54:32 +00:00
USER_KEY: admin
USER_SECRET: password
2022-04-21 16:45:12 +00:00
run: pnpm exec wc-api-tests test api
- name: Archive API test report
if: always()
2022-04-21 16:45:12 +00:00
uses: actions/upload-artifact@v3
with:
name: api-test-report---pr-${{ github.event.number }}
path: |
${{ env.API_TEST_REPORT_DIR }}/allure-results
${{ env.API_TEST_REPORT_DIR }}/allure-report
retention-days: 5
k6-tests-run:
name: Runs k6 Performance tests
runs-on: ubuntu-20.04
steps:
2022-05-17 13:24:49 +00:00
- uses: actions/checkout@v3
2022-05-17 16:26:08 +00:00
- uses: ./.github/actions/cache-deps
with:
workflow_name: pr-build-and-e2e-tests
workflow_cache: ${{ secrets.WORKFLOW_CACHE }}
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '7.4'
2022-05-17 16:26:08 +00:00
- name: Install and Build
uses: ./.github/actions/install-build
2022-03-31 22:55:14 +00:00
- name: Workaround to use initialization file with prepopulated data.
working-directory: plugins/woocommerce/tests/e2e/docker
2022-03-31 22:55:14 +00:00
run: |
cp init-sample-products.sh initialize.sh
2022-03-31 22:08:52 +00:00
- name: Load docker images and start containers.
working-directory: plugins/woocommerce
2022-04-21 16:45:12 +00:00
run: pnpm exec wc-e2e docker:up
- name: Install k6
run: |
curl https://github.com/grafana/k6/releases/download/v0.33.0/k6-v0.33.0-linux-amd64.tar.gz -L | tar xvz --strip-components 1
- name: Run k6 tests
run: |
./k6 run plugins/woocommerce/tests/performance/tests/gh-action-pr-requests.js
test-summary:
name: Post test results
if: |
always() &&
! github.event.pull_request.head.repo.fork &&
(
contains( needs.*.result, 'success' ) ||
contains( needs.*.result, 'failure' )
)
runs-on: ubuntu-20.04
needs: [api-tests-run, e2e-tests-run]
steps:
- name: Create dirs
run: |
mkdir -p repo
mkdir -p artifacts/api
mkdir -p artifacts/e2e
mkdir -p output
- name: Checkout code
uses: actions/checkout@v3
with:
path: repo
- name: Download API test report artifact
uses: actions/download-artifact@v3
with:
name: api-test-report---pr-${{ github.event.number }}
path: artifacts/api
- name: Download Playwright E2E test report artifact
if: fromJSON(env.E2E_PLAYWRIGHT)
uses: actions/download-artifact@v3
with:
name: e2e-test-report---pr-${{ github.event.number }}
path: artifacts/e2e
- name: Download Puppeteer E2E test report artifact
if: fromJSON(env.E2E_PLAYWRIGHT) != true
uses: actions/download-artifact@v3
with:
name: pptr-e2e-test-results
path: artifacts/e2e
- name: Prepare test summary
id: prepare-test-summary
uses: actions/github-script@v6
env:
API_SUMMARY_PATH: ${{ github.workspace }}/artifacts/api/allure-report/widgets/summary.json
E2E_PW_SUMMARY_PATH: ${{ github.workspace }}/artifacts/e2e/allure-report/widgets/summary.json
E2E_PPTR_SUMMARY_PATH: ${{ github.workspace }}/artifacts/e2e/test-results.json
PR_NUMBER: ${{ github.event.number }}
SHA: ${{ github.event.pull_request.head.sha }}
with:
result-encoding: string
script: |
const script = require( './repo/.github/workflows/scripts/prepare-test-summary.js' )
return await script( { core } )
- name: Find PR comment by github-actions[bot]
uses: peter-evans/find-comment@v2
id: find-comment
with:
issue-number: ${{ github.event.pull_request.number }}
comment-author: 'github-actions[bot]'
body-includes: Test Results Summary
- name: Create or update PR comment
uses: peter-evans/create-or-update-comment@v2
with:
comment-id: ${{ steps.find-comment.outputs.comment-id }}
issue-number: ${{ github.event.pull_request.number }}
body: ${{ steps.prepare-test-summary.outputs.result }}
edit-mode: replace
publish-test-reports:
name: Publish test reports
2022-05-24 04:47:00 +00:00
if: |
always() &&
! github.event.pull_request.head.repo.fork &&
2022-05-24 04:47:00 +00:00
(
contains( needs.*.result, 'success' ) ||
contains( needs.*.result, 'failure' )
)
2022-05-20 06:41:49 +00:00
runs-on: ubuntu-20.04
needs: [api-tests-run, e2e-tests-run, k6-tests-run]
env:
GITHUB_TOKEN: ${{ secrets.REPORTS_TOKEN }}
PR_NUMBER: ${{ github.event.number }}
RUN_ID: ${{ github.run_id }}
COMMIT_SHA: ${{ github.event.pull_request.head.sha }}
steps:
- name: Publish API test report
if: fromJSON(env.E2E_PLAYWRIGHT) != true
env:
ARTIFACT_NAME: api-test-report---pr-${{ github.event.number }}
run: |
gh workflow run publish-report.yml \
-f test_workflow=pr \
-f test_type=api \
-f run_id=$RUN_ID \
-f artifact_name=$ARTIFACT_NAME \
-f pr_number=$PR_NUMBER \
-f commit_sha=$COMMIT_SHA \
--repo woocommerce/woocommerce-test-reports
- name: Publish test reports
if: fromJSON(env.E2E_PLAYWRIGHT)
env:
API_ARTIFACT: api-test-report---pr-${{ github.event.number }}
E2E_ARTIFACT: e2e-test-report---pr-${{ github.event.number }}
run: |
gh workflow run publish-test-reports-pr.yml \
-f run_id=$RUN_ID \
-f api_artifact=$API_ARTIFACT \
-f e2e_artifact=$E2E_ARTIFACT \
-f pr_number=$PR_NUMBER \
-f commit_sha=$COMMIT_SHA \
-f s3_root=public \
--repo woocommerce/woocommerce-test-reports