diff --git a/Testing-Guide.md b/Testing-Guide.md index fad8540..299de78 100644 --- a/Testing-Guide.md +++ b/Testing-Guide.md @@ -73,6 +73,10 @@ At this point, we have two choices: ## Development Servers +**Note** it is important to read each service section linked in the list +to get a fluent understanding of what each component offers us for +testability. + When a user runs `docker-compose up -d nginx`, a few things happen (some services are omitted): @@ -84,7 +88,6 @@ When a user runs `docker-compose up -d nginx`, a few things happen 6. The [fastapi](#fastapi) service starts 7. The [php-fpm](#php-fpm) service starts 8. The [nginx](#nginx) service starts - - This last service depends on various other services. ###### Notes @@ -96,6 +99,9 @@ currently; however, if you load up and rely on hot reload, you can do work and restart specific services if need be without concern (at least, until you add a dependency). +* During checkouts to completely different branches, it is sometimes + necessary to restart the fastapi service: `docker-compose restart fastapi`. + #### Certificate Authority The `ca` service will produce a `cache/ca.root.pem` file, which is used to @@ -143,6 +149,11 @@ environment variable: `uvicorn` or `hypercorn`. It enables hot reloading of the server for changes in all directories in your tree, which automatically reflects on the [nginx](#nginx) service. +###### Add Users + +You can create a user account in the database using the +[util/adduser.py](https://gitlab.archlinux.org/archlinux/aurweb/-/tree/pu/util/adduser.py) script. + This service is exposed on `localhost:18000`. #### php-fpm @@ -186,10 +197,10 @@ its username (i.e. username: `kevin`, password: `kevin`). The `nginx` service will host two web servers (denoted below), both signed by the Root CA certificate `ca.root.pem`. -| Backend | URL | -|---------|------------------------| -| PHP | https://localhost:8443 | -| FastAPI | https://localhost:8444 | +| Backend | URL | +|---------------------|------------------------| +| [php-fpm](#php-fpm) | https://localhost:8443 | +| [fastapi](#fastapi) | https://localhost:8444 | ## User Experience