From b1f28a47d9f07b8b58fd2bd6a42f109fc53cea13 Mon Sep 17 00:00:00 2001 From: Kevin Morris Date: Sun, 3 Oct 2021 15:41:25 +0000 Subject: [PATCH] Update Testing Guide --- Testing-Guide.md | 88 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 67 insertions(+), 21 deletions(-) diff --git a/Testing-Guide.md b/Testing-Guide.md index 2bb865b..8f54d2b 100644 --- a/Testing-Guide.md +++ b/Testing-Guide.md @@ -26,8 +26,8 @@ If poetry is configured to create virtualenvs with `poetry config virtualenvs.create true --local` (recommended), users can install aurweb dependencies and the aurweb project into their poetry virtualenv: - $ poetry lock # Ensure that poetry dep resolution is up to date. - $ poetry update # Update/fetch all dependencies in the virtualenv. + $ poetry lock # Ensure that poetry dep resolution is up to date. + $ poetry update # Update/fetch all dependencies in the virtualenv. $ poetry install # Install project-specific package and scripts. After installing dependencies (via `update`) and the project (via `install`), @@ -37,6 +37,26 @@ users can then run commands within the virtualenv: ## 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 [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). @@ -268,28 +288,54 @@ Below, we provide a table of routes that we are really looking for UX testing on, and people wishing to contribute with UX testers should stay up to date with it: -| Route | Status | Description | Account type | -|--------------------------------------------------------------|--------------|----------------------|--------------| -| https://localhost:8444/ | Incomplete | Homepage | User | -| https://localhost:8444/register | Incomplete | Account Registration | | -| https://localhost:8444/login | Incomplete | User Login | User | -| https://localhost:8444/logout | Incomplete | User Logout | User | -| https://localhost:8444/passreset ([Notes](#passreset-notes)) | Incomplete | User Password Reset | Logged out User | -| https://localhost:8444/account/{username} | Incomplete | Account View | User | -| https://localhost:8444/account/{username}/edit | Incomplete | Account Edit | User | -| https://localhost:8444/accounts | Incomplete | Account Search | Trusted 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}/comaintainers | Incomplete | Comaintainer Edit | Maintainer of pkgbase | +| Route | Status | Description | Account type | +|--------------------------------------------------------------|--------------|-------------------------|-------------------| +| https://localhost:8444/ | Incomplete | Homepage | User | +| https://localhost:8444/register | Incomplete | Account Registration | | +| https://localhost:8444/login | Incomplete | User Login | User | +| https://localhost:8444/logout | Incomplete | User Logout | User | +| https://localhost:8444/passreset ([Notes](#passreset-notes)) | Incomplete | User Password Reset | Logged out User | +| https://localhost:8444/account/{username} | Incomplete | Account View | User | +| https://localhost:8444/account/{username}/edit | Incomplete | Account Edit | 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/pkgbase/{name} | Incomplete | Package Base View | User | +| 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:**
+- Incomplete: Needs testing. +- Complete: All done. #### Development Branches -| 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 | +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 | +|-----------------------|------------------------------------------|-------------|---------------------------| +| `pu_packages_actions` | https://gitlab.archlinux.org/kevr/aurweb | `/packages` | Package search actions | ###### passreset Notes