Streamline local test environment setup #916

schlessera · 2024-12-11T11:01:41Z

Refactored the test environment setup to make it more robust and user-friendly. This consolidates multiple test commands and improves process management for local development.

Fixes #819

What Changed

Added shell scripts to manage test environment lifecycle
Consolidated PHPUnit commands to auto-detect version and config
Improved process management with proper PID tracking
Added mitmproxy version verification (≥11.0.2 required)
Adapted CONTRIBUTING.md to explain the new setup

The main improvement is the simplified test workflow. Instead of juggling different commands for PHPUnit versions and remembering to start/stop test servers, everything is now handled through clear, single-purpose commands.

New Scripts

scripts/start-test-environment.sh - Boots test and proxy servers - should be sourced to set environment vairables
scripts/stop-test-environment.sh - Clean shutdown of all processes
scripts/run-phpunit.sh - Version-agnostic PHPUnit runner

Usage

Basic testing is now simpler:

composer test # Run tests (auto-detects PHPUnit version)
composer coverage # Same, but with coverage

For development with local test servers:

# Direct usage (sets env vars in your shell)
source scripts/start-test-environment.sh
scripts/run-phpunit.sh
scripts/stop-test-environment.sh

# Or through composer (automated start/stop)
composer test:withserver
composer coverage:withserver

jrfnl

Looking good.

Will still need a note in CONTRIBUTING that this will not work on Windows for now.

As discussed, not merging yet until a shellcheck check has been added in CI to safeguard the scripts.

jrfnl · 2024-12-11T12:04:21Z

Future scope: add a Docker config file to get up & running with even less effort (and which would work on Windows too).

jrfnl · 2024-12-11T12:17:56Z

Just noticed, just running the script on my machine created some .test-pids/*.pid files. You may want to add those to the .gitignore file ?

schlessera · 2024-12-11T14:04:02Z

I changed the folder where PIDs are stored and added that location to .gitignore: tests/utils/pids

jrfnl · 2025-01-22T10:29:26Z

Just checking - this PR relates to #819 (and closes it ?)

jrfnl

@schlessera I've had a good look at this PR, with the caveat of limited knowledge of bash scripting...

Left a number of questions in-line.

Additionally:

The scripts re-introduce a problem we previously solved: the system default PHP version being used instead of the Composer PHP version being used. This is a regression, which I'm not happy with.
/scripts/ directory needs to be added to .gitattributes
composer.json: script descriptions should mention that this doesn't work on Windows, only on *nix
CONTRIBUTING: should mention that this doesn't work on Windows, only on *nix.
CONTRIBUTING: "The environment scripts must be sourced"... what does that mean ?
Note: the source command is not available on Windows.

Other remarks:

The minimum versions for Python and mitmproxy will now need to be maintained in quite a few places (CONTRIBUTING, quicktest.yml, test.yml, the new scripts). This feels pretty error prone...
Just as a test, I've ran the scripts on Windows:
- run-tests-with-server.sh doesn't appears to do anything (other than flash open a new shell window & close it) and exits without giving the user information about why it's not working.
- start-test-environment.sh doesn't appears to do anything (other than flash open a new shell window & close it) and exits without giving the user information about why it's not working.
- stop-test-environment.sh doesn't appears to do anything (other than flash open a new shell window & close it) and exits without giving the user information about why it's not working.
- run-phpunit.sh runs, but opens a new shell window and closes it immediately once the test run has finished, meaning you can't read the results.
  The new window is also really annoying for other reasons, like usability issues, no scrolling, window size being tiny etc

.github/CONTRIBUTING.md

.github/workflows/quicktest.yml

.github/CONTRIBUTING.md

.github/workflows/test.yml

scripts/run-phpunit.sh

jrfnl · 2025-01-22T11:00:35Z

scripts/run-tests-with-server.sh

+TEST_EXIT_CODE=$?
+
+# Stop the test environment
+. "${SCRIPT_DIR}/stop-test-environment.sh"


Shouldn't there be an error as well if the test environment couldn't be stopped cleanly ?

I'll have to think how best to do that, let me figure something out...

scripts/start-test-environment.sh

.github/CONTRIBUTING.md

Co-authored-by: Juliette <[email protected]>

…s well

jrfnl · 2025-02-03T11:30:34Z

scripts/start-test-environment.sh

+# Set environment variables
+REQUESTS_HTTP_PROXY="localhost:9002"
+REQUESTS_HTTP_PROXY_AUTH="localhost:9003"
+REQUESTS_HTTP_PROXY_AUTH_USER="test"
+REQUESTS_HTTP_PROXY_AUTH_PASS="pass"


Considering the changes to the Composer script to use @putenv (in commit fb62d2b), so this be read out from env if available ?

jrfnl · 2025-02-03T11:31:10Z

scripts/start-test-environment.sh

+echo "REQUESTS_TEST_HOST_HTTP=localhost:8080"
+echo "REQUESTS_HTTP_PROXY=localhost:9002"
+echo "REQUESTS_HTTP_PROXY_AUTH=localhost:9003"
+echo "REQUESTS_HTTP_PROXY_AUTH_USER=test"
+echo "REQUESTS_HTTP_PROXY_AUTH_PASS=pass"


Should this be using the variables instead of having the values hard-coded in the echo ?

jrfnl · 2025-02-03T11:34:05Z

composer.json

+      "@putenv REQUESTS_HTTP_PROXY=localhost:9002",
+      "@putenv REQUESTS_HTTP_PROXY_AUTH=localhost:9003",
+      "@putenv REQUESTS_HTTP_PROXY_AUTH_USER=test",
+      "@putenv REQUESTS_HTTP_PROXY_AUTH_PASS=pass",


Could these be moved to a separate Composer script which is @ referenced here ? (to avoid the duplication in the coverage:withserver script)

jrfnl reviewed Dec 11, 2024

View reviewed changes

schlessera force-pushed the add/simplified-local-testserver branch from 60f07ce to f09ca3e Compare January 21, 2025 11:01

jrfnl mentioned this pull request Jan 22, 2025

Add a Docker config #917

Open

jrfnl requested changes Jan 22, 2025

View reviewed changes

schlessera and others added 14 commits February 3, 2025 12:06

Add scripts to simplify local testing

e52a682

Adapt the CONTRIBUTING.md file with the testing flow

8308e63

Improve POSIX compatibility

1c076c9

Use different folder for storing pids and gitignore as needed

057f31c

Remove conditional PHPUnit paths from GHA workflows

0efd79c

Adapt argument support in PHPUnit script

360d9e2

Support multiple arguments in PHPUnit helper script

16a71f8

Apply phrasing suggestions

dd37db5

Co-authored-by: Juliette <[email protected]>

Use PHP version that Composer locked into, instead of system one

9e79ec0

Add script/ to .gitattributes

eaf993c

Remove unnecessary PHPUnit version check in GHA workflows

f365f33

Avoid dedicated script for all-in-one commands and support coverage a…

fb62d2b

…s well

Improve quoting

132517a

Add version requirements to CONTRIBUTING.md

e6c455d

schlessera force-pushed the add/simplified-local-testserver branch from d347cb7 to e6c455d Compare February 3, 2025 11:07

jrfnl reviewed Feb 3, 2025

View reviewed changes

jrfnl mentioned this pull request Feb 11, 2025

Move shell scripts into dedicated directory #928

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Streamline local test environment setup #916

Streamline local test environment setup #916

schlessera commented Dec 11, 2024 •

edited

Loading

jrfnl left a comment

jrfnl commented Dec 11, 2024

jrfnl commented Dec 11, 2024

schlessera commented Dec 11, 2024

jrfnl commented Jan 22, 2025 •

edited

Loading

jrfnl left a comment

jrfnl Jan 22, 2025

schlessera Feb 3, 2025

jrfnl Feb 3, 2025

jrfnl Feb 3, 2025

jrfnl Feb 3, 2025

Streamline local test environment setup #916

Are you sure you want to change the base?

Streamline local test environment setup #916

Conversation

schlessera commented Dec 11, 2024 • edited Loading

What Changed

New Scripts

Usage

jrfnl left a comment

Choose a reason for hiding this comment

jrfnl commented Dec 11, 2024

jrfnl commented Dec 11, 2024

schlessera commented Dec 11, 2024

jrfnl commented Jan 22, 2025 • edited Loading

jrfnl left a comment

Choose a reason for hiding this comment

jrfnl Jan 22, 2025

Choose a reason for hiding this comment

schlessera Feb 3, 2025

Choose a reason for hiding this comment

jrfnl Feb 3, 2025

Choose a reason for hiding this comment

jrfnl Feb 3, 2025

Choose a reason for hiding this comment

jrfnl Feb 3, 2025

Choose a reason for hiding this comment

schlessera commented Dec 11, 2024 •

edited

Loading

jrfnl commented Jan 22, 2025 •

edited

Loading