From 8eedfe5c4ebc366be773a590b6f5fa2314c402ce Mon Sep 17 00:00:00 2001 From: Dewi Roberts Date: Fri, 18 Jul 2025 19:07:45 +0100 Subject: [PATCH] website/docs: add e2e testing steps (#15656) * Add e2e testing steps. * Apply suggestion --- .../setup/full-dev-environment.mdx | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/website/docs/developer-docs/setup/full-dev-environment.mdx b/website/docs/developer-docs/setup/full-dev-environment.mdx index 6c88e75e66..fb949e3fe7 100644 --- a/website/docs/developer-docs/setup/full-dev-environment.mdx +++ b/website/docs/developer-docs/setup/full-dev-environment.mdx @@ -26,8 +26,8 @@ import Tabs from "@theme/Tabs"; ## Services Setup -For PostgreSQL and Redis, you can use the `docker-compose.yml` file in `/scripts`.To use these pre-configured database instances, navigate to the `/scripts` directory in your local copy of the authentik git repo, and run `docker compose up -d`. -You can also use a native install, if you prefer. +For PostgreSQL and Redis, you can use the `docker-compose.yml` file in `/scripts`. To use these pre-configured database instances, navigate to the `/scripts` directory in your local copy of the authentik git repo, and start the services by running `docker compose up -d`. +Alternatively, you can also use a native install, if you prefer. :::info If you use locally installed databases, the PostgreSQL credentials given to authentik should have permissions for `CREATE DATABASE` and `DROP DATABASE`, because authentik creates a temporary database for tests. @@ -147,6 +147,18 @@ To define a password for the default admin (called **akadmin**), you can manuall In case of issues in this process, feel free to use `make dev-reset` which drops and restores the authentik PostgreSQL instance to a "fresh install" state. ::: +## End-to-End (E2E) Setup + +To run E2E tests, navigate to the `/tests/e2e` directory in your local copy of the authentik git repo, and start the services by running `docker compose up -d`. + +You can then view the Selenium Chrome browser via [http://localhost:7900/](http://localhost:7900) using the password: `secret`. + +Alternatively, you can connect directly via VNC on port `5900` using the password: `secret`. + +:::note +When using Docker Desktop, host networking needs to be enabled via **Docker Settings** > **Resources** > **Network** > **Enable host networking**. +::: + ## Submitting Pull Requests Before submitting a pull request, run the following commands in the same directory as your local authentik git repository: