[Tests] Add setup for API Tests.#100
Merged
Merged
Conversation
bluvulture
approved these changes
May 11, 2026
Contributor
bluvulture
left a comment
bluvulture
left a comment
There was a problem hiding this comment.
Changes on the workflows are looking ok - I think the rest is also okay, but lets see for the copilot review
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an end-to-end, Docker-based API test environment and CI workflow to install Pimcore (with enterprise bundles) and execute Playwright tests from pimcore/studio-tests.
Changes:
- Adds a GitHub Actions workflow to provision a Pimcore instance and run Playwright tests.
- Introduces local helper scripts plus Docker Compose + Nginx/Supervisord config to create/install/reset/teardown the test environment.
- Documents local/CI usage in
.github/API_TESTS.mdand links it from the main README.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Links readers to the new API test documentation. |
| .github/workflows/api-tests.yml | CI workflow to provision Pimcore + run Playwright tests. |
| .github/scripts/00-localsetup.sh | Local orchestrator: setup → registration → install → optional test run. |
| .github/scripts/01-setup-environment.sh | Creates test project, writes env, starts containers, waits for deps. |
| .github/scripts/02-install-pimcore.sh | Requires platform/bundles via Composer and runs Pimcore installer. |
| .github/scripts/03-run-tests.sh | Runs Playwright tests against the local Pimcore instance. |
| .github/scripts/04-shutdown.sh | Stops containers and removes volumes. |
| .github/scripts/05-reset.sh | Fast reset: DB drop/recreate + reinstall + post-install tasks. |
| .github/scripts/06-teardown.sh | Full shutdown; optional removal of the test project directory. |
| .github/scripts/.gitignore | Ignores local secrets file .env.local. |
| .github/files/.env | Base config defaults for the test environment. |
| .github/files/ApiTestProfile.php | Pimcore install profile enabling a broad set of enterprise bundles. |
| .github/files/docker-compose.yaml | Local Compose stack (db, opensearch, php, nginx, etc.). |
| .github/files/docker-compose.ci.yaml | CI-specific Compose overrides. |
| .github/files/messenger.yaml | Messenger transport configuration for the test project. |
| .github/files/nginx.conf | Nginx config for the test project. |
| .github/files/supervisord.conf | Supervisor config to run messenger consume + maintenance. |
| .github/API_TESTS.md | Local + CI setup instructions and operational notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
@martineiber check the copilot does it have something meaningful - otherwise feel free to merge |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add setup for API Tests.