mirror of
https://gitlab.archlinux.org/archlinux/aurweb.git
synced 2025-02-03 10:43:03 +01:00
Update Testing Guide
parent
d8e1fe6f6d
commit
b1f28a47d9
1 changed files with 67 additions and 21 deletions
|
@ -37,6 +37,26 @@ users can then run commands within the virtualenv:
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
Welcome to the FastAPI testing guide. This article was written to
|
||||||
|
assist developers and testers with spinning up instances of aurweb
|
||||||
|
to perform tests or modify code live. Additionally, it outlines the
|
||||||
|
kind of testing that aurweb is currently looking for.
|
||||||
|
|
||||||
|
At this point in the port, the most important kind of contributions
|
||||||
|
would be testing the user experience of FastAPI aurweb. We aim to,
|
||||||
|
during the port, mirror the existing PHP implementations in terms of
|
||||||
|
UX and API (RPC) access. Details of the implementations may be changed,
|
||||||
|
but the end user experience should either result in an equal and/or
|
||||||
|
improved state.
|
||||||
|
|
||||||
|
A compiled changelog will be produced when the port is released
|
||||||
|
(version 6.0.0); before that, users and developers can take advantage
|
||||||
|
of `git blame` and `git log` to identify commits which ported features
|
||||||
|
or made changes. The involved commits **should** lay out the features,
|
||||||
|
fixes or changes in detail. In some cases this is not done so well; if
|
||||||
|
you experience a case like this, please do report it as an issue
|
||||||
|
in the project repository so we can address it.
|
||||||
|
|
||||||
The aurweb project now maintains a
|
The aurweb project now maintains a
|
||||||
[Dockerfile](https://gitlab.archlinux.org/archlinux/aurweb/-/tree/pu/Dockerfile)
|
[Dockerfile](https://gitlab.archlinux.org/archlinux/aurweb/-/tree/pu/Dockerfile)
|
||||||
and [docker-compose.yml](https://gitlab.archlinux.org/archlinux/aurweb/-/tree/pu/docker-compose.yml).
|
and [docker-compose.yml](https://gitlab.archlinux.org/archlinux/aurweb/-/tree/pu/docker-compose.yml).
|
||||||
|
@ -269,7 +289,7 @@ testing on, and people wishing to contribute with UX testers should
|
||||||
stay up to date with it:
|
stay up to date with it:
|
||||||
|
|
||||||
| Route | Status | Description | Account type |
|
| Route | Status | Description | Account type |
|
||||||
|--------------------------------------------------------------|--------------|----------------------|--------------|
|
|--------------------------------------------------------------|--------------|-------------------------|-------------------|
|
||||||
| https://localhost:8444/ | Incomplete | Homepage | User |
|
| https://localhost:8444/ | Incomplete | Homepage | User |
|
||||||
| https://localhost:8444/register | Incomplete | Account Registration | |
|
| https://localhost:8444/register | Incomplete | Account Registration | |
|
||||||
| https://localhost:8444/login | Incomplete | User Login | User |
|
| https://localhost:8444/login | Incomplete | User Login | User |
|
||||||
|
@ -278,17 +298,43 @@ stay up to date with it:
|
||||||
| https://localhost:8444/account/{username} | Incomplete | Account View | User |
|
| https://localhost:8444/account/{username} | Incomplete | Account View | User |
|
||||||
| https://localhost:8444/account/{username}/edit | Incomplete | Account Edit | User |
|
| https://localhost:8444/account/{username}/edit | Incomplete | Account Edit | User |
|
||||||
| https://localhost:8444/accounts | Incomplete | Account Search | Trusted User |
|
| https://localhost:8444/accounts | Incomplete | Account Search | Trusted User |
|
||||||
|
| https://localhost:8444/packages | Incomplete | Package Search | User |
|
||||||
|
| https://localhost:8444/(pkgbase\|packages)/{name} | Incomplete | Comment testing | User |
|
||||||
| https://localhost:8444/packages/{name} | Incomplete | Package View | User |
|
| https://localhost:8444/packages/{name} | Incomplete | Package View | User |
|
||||||
| https://localhost:8444/pkgbase/{name} | Incomplete | Package Base View | User |
|
| https://localhost:8444/pkgbase/{name} | Incomplete | Package Base View | User |
|
||||||
| https://localhost:8444/pkgbase/{name}/comaintainers | Incomplete | Comaintainer Edit | Maintainer of pkgbase |
|
| https://localhost:8444/pkgbase/{name}/comaintainers | Incomplete | Comaintainer Edit | Maintainer |
|
||||||
|
| https://localhost:8444/pkgbase/{name}/request | Incomplete | Package Request Create | User |
|
||||||
|
| https://localhost:8444/requests | Incomplete | Package Requests | User / TU[D] |
|
||||||
|
| https://localhost:8444/requests/{id}/close | Incomplete | Package Request Closure | Requester / TU[D] |
|
||||||
|
|
||||||
|
**Status Legend:**<br>
|
||||||
|
- Incomplete: Needs testing.
|
||||||
|
- Complete: All done.
|
||||||
|
|
||||||
#### Development Branches
|
#### Development Branches
|
||||||
|
|
||||||
|
The following snippet shows an example workflow of setting up
|
||||||
|
your tree for testing a development branch:
|
||||||
|
|
||||||
|
## Checkout to a devel branch based on pu:
|
||||||
|
$ git checkout -b devel_branch pu
|
||||||
|
|
||||||
|
## Add the Git Fork to a remote:
|
||||||
|
$ git remote add devel_fork https://gitlab.archlinux.org/user/fork
|
||||||
|
|
||||||
|
## Fetch the branch's data and hard reset to its HEAD:
|
||||||
|
$ git fetch devel_fork devel_branch
|
||||||
|
$ git reset --hard devel_fork/devel_branch
|
||||||
|
|
||||||
|
## Or, you can just pull the branch if your local pu is good:
|
||||||
|
$ git pull devel_fork devel_branch
|
||||||
|
|
||||||
|
## (Required when checking out to a different tree)
|
||||||
|
## Once you've got the devel branch tree, restart `fastapi`:
|
||||||
|
$ docker-compose restart fastapi
|
||||||
|
|
||||||
| Branch | Git Fork | Route | Description |
|
| Branch | Git Fork | Route | Description |
|
||||||
|-----------------------|------------------------------------------|---------------------------------|--------------------------------------|
|
|-----------------------|------------------------------------------|-------------|---------------------------|
|
||||||
| `pu_requests` | https://gitlab.archlinux.org/kevr/aurweb | `/requests` | Requests page |
|
|
||||||
| `pu_requests_create` | https://gitlab.archlinux.org/kevr/aurweb | `/pkgbase/{name}/request` | Request creation |
|
|
||||||
| `pu_requests_close` | https://gitlab.archlinux.org/kevr/aurweb | `/requests/{id}/close` | Request closure |
|
|
||||||
| `pu_packages_actions` | https://gitlab.archlinux.org/kevr/aurweb | `/packages` | Package search actions |
|
| `pu_packages_actions` | https://gitlab.archlinux.org/kevr/aurweb | `/packages` | Package search actions |
|
||||||
|
|
||||||
###### passreset Notes
|
###### passreset Notes
|
||||||
|
|
Loading…
Add table
Reference in a new issue