external/aurweb
0
0
Fork 0
mirror of https://gitlab.archlinux.org/archlinux/aurweb.git synced 2025-02-03 10:43:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Testing Guide

Kevin Morris 2021-10-24 06:16:46 +00:00
parent 37c6936055
commit 5128a87d95
1 changed files with 32 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
Testing-Guide.md

@ -18,7 +18,31 @@ Branches containing FastAPI are located in the pipeline/coverage status table be
|--------------|
| ![pipeline](https://gitlab.archlinux.org/archlinux/aurweb/badges/pu/pipeline.svg?key_text=build) ![coverage](https://gitlab.archlinux.org/archlinux/aurweb/badges/pu/coverage.svg) |
## Requirements
## Locations
Testers should choose one of the following methods:
- [aur-dev.archlinux.org Testing](#aur-devarchlinuxorg-testing)
- [Docker Testing](#docker-testing)
**Too long, didn't read?** Running a local Docker instance is much more flexible
in terms of testing -- testers have complete access to the MariaDB database
used by both the `php-fpm` and `fastapi` services. For users who do not wish
to interact with Docker, the `aur-dev.archlinux.org` instance can be used
to perform any testing.
See [Accounts](#accounts) for an explanation on obtaining accounts
in either system.
### aur-dev.archlinux.org Testing
A Docker instance of the `pu` branch is hosted at https://aur-dev.archlinux.org
and can be used by anybody to test the code-base.
### Docker Testing
The following table lists out requirements needed to run our `docker-compose`
services:
| Package | Distribution | Method |
|------------------|--------------|-----------------------------------------|
@ -312,14 +336,16 @@ described below.
###### Add User
<small>**Note**: To use the script, you'll need a valid AUR_CONFIG to the
target database and aurweb Python dependencies (see [poetry](#poetry-python-dependencies)).
Users can also `docker exec python /aurweb/util/adduser.py ...` from a
Docker host if you wish to avoid installing poetry dependencies.</small>
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.
Users can run `adduser.py` from the Docker host without installing any
host dependencies:
`docker exec -it <fastapi_container> python /aurweb/util/adduser.py ...`.
See `docker exec -it <fastapi_container> python /aurweb/util/adduser.py --help`
for details on command line arguments.
## User Experience
Some of the most important testing we could do for aurweb at this