Skip to content

Add smoke-test workflow #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 19 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 15 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 116 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,121 @@ jobs:
with:
coverage: none
php-version: '8.2'
- run: composer validate --strict --no-check-lock
- run: composer validate --strict --no-check-lock --ansi

static_analysis:
name: Static analysis
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
coverage: none
php-version: '8.2'
- name: Install dependencies
run: composer update --ansi --no-progress --prefer-dist --no-interaction
- run: vendor/bin/phpstan analyze
name: Static analysis
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: shivammathur/setup-php@v2
with:
coverage: none
php-version: '8.2'
- run: composer update --ansi --no-progress --prefer-dist --no-interaction
- run: vendor/bin/phpstan analyze --ansi --no-progress

Official:
name: "🛡️ ${{ matrix.name }}"
uses: "./.github/workflows/test.yml"
with:
name: ${{ matrix.name }}
driverRepoUrl: ${{ matrix.driverRepoUrl }}
driverRepoBranch: ${{ matrix.driverRepoBranch }}
php: ${{ matrix.php }}
setUpCmd: ${{ matrix.setUpCmd }}
testCmd: ${{ matrix.testCmd }}
tearDownCmd: ${{ matrix.tearDownCmd }}
strategy:
fail-fast: false
matrix:
include:
- name: "BrowserKit (http client)"
driverRepoUrl: "https://github.com/minkphp/MinkBrowserKitDriver.git"
driverRepoBranch: "master"
php: "7.2"
# language=bash
testCmd: ./vendor/bin/phpunit --colors=always --testdox --configuration ./phpunit.http_client.xml

- name: "BrowserKit (http kernel)"
driverRepoUrl: "https://github.com/minkphp/MinkBrowserKitDriver.git"
driverRepoBranch: "master"
php: "7.2"
# language=bash
testCmd: ./vendor/bin/phpunit --colors=always --testdox

- name: "Selenium2"
driverRepoUrl: "https://github.com/minkphp/MinkSelenium2Driver.git"
driverRepoBranch: "master"
php: "7.2"
# language=bash
setUpCmd: |
export SELENIUM_IMAGE=selenium/standalone-firefox:2.53.1
docker compose up --wait --quiet-pull
curl --retry 5 --retry-all-errors --retry-delay 1 --max-time 10 --head -X GET http://localhost:4444/wd/hub/status
# language=bash
testCmd: |
export WEB_FIXTURES_BROWSER=firefox
export SELENIUM_VERSION=2.53.1
export DRIVER_MACHINE_BASE_PATH=/fixtures/
export WEB_FIXTURES_HOST=http://host.docker.internal:8002
./vendor/bin/phpunit --colors=always --testdox
# language=bash
tearDownCmd: |
docker compose logs --no-color --no-log-prefix --timestamps selenium > ./logs/selenium.docker.log

- name: "WebDriver-Classic"
driverRepoUrl: "https://github.com/minkphp/webdriver-classic-driver.git"
driverRepoBranch: "main"
php: "7.4"
# language=bash
setUpCmd: |
export SELENIUM_IMAGE=selenium/standalone-firefox:4
docker compose up --wait --quiet-pull
curl --retry 5 --retry-all-errors --retry-delay 1 --max-time 10 --head -X GET http://localhost:4444/wd/hub/status
# language=bash
testCmd: |
export WEB_FIXTURES_BROWSER=firefox
export DRIVER_MACHINE_BASE_PATH=/fixtures/
export WEB_FIXTURES_HOST=http://host.docker.internal:8002
./vendor/bin/phpunit --colors=always --testdox
# language=bash
tearDownCmd: |
docker compose logs --no-color --no-log-prefix --timestamps selenium > ./logs/selenium.docker.log

Unofficial:
name: "✨️ ${{ matrix.name }}"
Copy link
Member Author

@uuf6429 uuf6429 Jan 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just pushed a major update; it should work much better now and should be relatively easy to follow.

There's one major annoyance (on GitHub's side): they do not evaluate expressions in job.name, (that line above), when the job is skipped.

This causes some ugly UI:
image

But the impact is just that, so I think we can live with it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A way to solve that would be to put those jobs in a separate workflow instead (that can be dispatched manually) instead of putting them in the CI workflow but skipping them anytime it is not dispatched manually. This would not cause duplication, as the common logic is already in the reusable workflow anyway.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea, I'll try implementing it so.

Copy link
Member Author

@uuf6429 uuf6429 Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stof I tried it out on my personal branch and it looked like it works really nicely. Can't see any downsides so far, in fact (except that the current "CI" entry will become obsolete, but I think that's really minor).

It can be removed if we manually remove the past workflow logs, it's a bit cumbersome but I can do that if you want (just let me know). Or we can leave it there for now (maybe github even removes it eventually, when it's old enough).

uses: "./.github/workflows/test.yml"
if: ${{ github.event_name == 'workflow_dispatch' }}
with:
name: ${{ matrix.name }}
driverRepoUrl: ${{ matrix.driverRepoUrl }}
driverRepoBranch: ${{ matrix.driverRepoBranch }}
php: ${{ matrix.php }}
setUpCmd: ${{ matrix.setUpCmd }}
testCmd: ${{ matrix.testCmd }}
tearDownCmd: ${{ matrix.tearDownCmd }}
strategy:
fail-fast: false
matrix:
include:
- name: "Chrome"
driverRepoUrl: "https://gitlab.com/behat-chrome/chrome-mink-driver.git"
driverRepoBranch: "main"
php: "7.4"
# language=bash
setUpCmd: |
docker run --detach --quiet --net host --volume /dev/shm:/dev/shm --shm-size 2g --volume ./vendor/mink/driver-testsuite/web-fixtures:/fixtures \
--name chrome zenika/alpine-chrome:latest \
"--remote-debugging-address=0.0.0.0 --remote-debugging-port=9222 --disable-gpu --headless=new --disable-extensions --no-sandbox --use-gl=swiftshader --disable-software-rasterizer --disable-dev-shm-usage"
sed "s#http://localhost/#http://localhost:8002/#" phpunit.xml.dist > phpunit.xml
while ! nc -z localhost 9222 </dev/null; do echo Waiting for chrome to start...; sleep 1; done
# language=bash
testCmd: |
export WEB_FIXTURES_BROWSER=chrome
export DRIVER_MACHINE_BASE_PATH=/fixtures/
./vendor/bin/phpunit --colors=always --testdox
# language=bash
tearDownCmd: |
docker logs chrome > ./logs/chrome.docker.log

78 changes: 78 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
on:
workflow_call:
inputs:
name:
description: Name of the driver test
required: true
type: string
driverRepoUrl:
description: Git URL of the driver repository
required: true
type: string
driverRepoBranch:
description: Driver repository branch to check out
required: true
type: string
php:
description: PHP version for running tests
required: true
type: string
setUpCmd:
description: Command to run before test
required: false
type: string
testCmd:
description: Command that runs the test
required: true
type: string
tearDownCmd:
description: Command to run after test
required: false
type: string

jobs:
Test:
runs-on: ubuntu-latest
steps:
- name: Set up workspace for driver repo
# language=bash
run: git clone --single-branch --branch "${{ inputs.driverRepoBranch }}" "${{ inputs.driverRepoUrl }}" .

- uses: shivammathur/setup-php@v2
with:
coverage: none
php-version: ${{ inputs.php }}

- name: Install driver dependencies
# language=bash
run: composer install --no-interaction --ansi --no-progress

- name: Set up driver test suite as composer dependency
# This is instead of `composer require "mink/driver-testsuite:dev-master#${{ github.sha }}"`, which works with forks
uses: actions/checkout@v4
with:
path: ./vendor/mink/driver-testsuite

- name: Set up
# language=bash
run: |
mkdir ./logs
MINK_HOST=0.0.0.0:8002 ./vendor/bin/mink-test-server &> ./logs/mink-test-server.log &
eval "${{ inputs.setUpCmd }}"
curl --retry 5 --retry-all-errors --retry-delay 1 --max-time 10 --head -X GET http://localhost:8002/

- name: Run tests
# language=bash
run: eval "${{ inputs.testCmd }}"

- name: Tear down
# language=bash
run: |
eval "${{ inputs.tearDownCmd }}"

- name: Upload logs as artifact
uses: actions/upload-artifact@v4
if: always()
with:
name: ${{ inputs.name }}-logs
path: ./logs
Loading