ljmotta commented on code in PR #3382: URL: https://github.com/apache/incubator-kie-tools/pull/3382#discussion_r2635076122
########## packages/playwright-base/README.md: ########## @@ -79,6 +59,76 @@ pnpm test-e2e:container:shell pnpm test-e2e:run --update-snapshots ``` +## Playwright-base CLI + +A CLI tool to assist running containerized Playwright tests. It loads environment variables and passes them through the docker-compose file, and helps with starting the test suite, opening an interactive shell inside the container, and cleaning up. + +```sh +pnpm pw-e2e-container --help +pw-e2e-container <command> + +Commands: + pw-e2e-container run Run the Playwright test suite inside Docker containers. This command will start the required containers using docker-compose + and execute the Playwright tests in the specified container workdir. + pw-e2e-container shell Open an interactive shell inside the Playwright test container. This command starts the required container using + docker-compose and launches a shell in the specified workdir inside the container. + pw-e2e-container clean Stop and remove all Playwright-related containers created by docker-compose. This command runs 'docker compose down' using + the base Playwright compose file. + +Examples: + containerized-playwright run --container-name my_playwright_container Run the Playwright test suite locally (no CI override) using the + --container-workdir incubator-kie-tools/packages/my-package specified container and workdir. + + containerized-playwright run --ci --container-name my_playwright_container Run the Playwright test suite in CI mode (applies CI docker-compose + --container-workdir incubator-kie-tools/packages/my-package override). + + containerized-playwright run --container-name e2e --container-workdir Run with extra environment variables forwarded to docker-compose + incubator-kie-tools/packages/foo --additional-env (comma-separated KEY=VALUE pairs). + BUILD_ID=123,REPORT_DIR=/tmp/reports + + containerized-playwright run --container-name e2e --container-workdir Pass multiple --additional-env options; later pairs override earlier + incubator-kie-tools/packages/foo --additional-env FOO=bar --additional-env keys if duplicated. + COMMIT_SHA=deadbeef + + CI=true containerized-playwright run --container-name e2e Leverage CI environment variable to auto-enable CI mode (equivalent to + --container-workdir incubator-kie-tools/packages/foo --ci when CI=true or CI=1). + + containerized-playwright shell --container-name my_playwright_container Start the container (if needed) and open an interactive bash shell in + --container-workdir incubator-kie-tools/packages/my-package the package workdir. + + containerized-playwright shell --container-name e2e --container-workdir Open an interactive shell with extra environment variables forwarded to + incubator-kie-tools/packages/foo --additional-env DEBUG=true docker-compose. + + containerized-playwright shell --container-name e2e --container-workdir Forward multiple env variables in a single --additional-env option + incubator-kie-tools/packages/foo --additional-env FOO=bar,BAZ=qux using comma-separated pairs. + + containerized-playwright clean Stop and remove Playwright-related containers using the base Review Comment: I changed the cli name, and I forgot to update the readme :face_with_peeking_eye: -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
