diff --git a/README.md b/README.md index d5a2ea6..c6945b7 100644 --- a/README.md +++ b/README.md @@ -76,10 +76,10 @@ hs.yourdomain.com.au { ``` ## Development -see [development](/documentation/Development.md) for details +see [development](/documentation/development.md) for details ### Style Guide -see [style](/documentation/Style.md) for details +see [style](/documentation/style.md) for details ## Architecture -See [architecture](/documentation/Architecture.md) for details +See [architecture](/documentation/architecture.md) for details diff --git a/documentation/Docker.md b/documentation/Docker.md deleted file mode 100644 index e69de29..0000000 diff --git a/documentation/Architecture.md b/documentation/architecture.md similarity index 100% rename from documentation/Architecture.md rename to documentation/architecture.md diff --git a/documentation/Development.md b/documentation/development.md similarity index 90% rename from documentation/Development.md rename to documentation/development.md index 38ff6e8..1d114c0 100644 --- a/documentation/Development.md +++ b/documentation/development.md @@ -2,6 +2,10 @@ Development can be done either by using the official development docker image, or via a normal nodejs installation. +## Testing + +All branches should undergo manual testing as specified in the [System Integration Testing](./system-integration-testing.md) document. If someone is well versed in unit automation tests for browser front ends, please educate me! For now do it manually before making a pull request. + ### Quick Start (Docker) * `docker run -p 443:443 -p 3000:3000 -v "$(pwd)"/data:/data ghcr.io/gurucomputing/headscale-ui-dev:latest` diff --git a/documentation/Style.md b/documentation/style.md similarity index 100% rename from documentation/Style.md rename to documentation/style.md diff --git a/documentation/system-integration-testing.md b/documentation/system-integration-testing.md new file mode 100644 index 0000000..3cbbaac --- /dev/null +++ b/documentation/system-integration-testing.md @@ -0,0 +1,30 @@ +## Tests Before Release +Eventually it would be nice to automate this, but I've found a front end is difficult to fully automate testing. Prove me wrong other users! + +## User Testing +* Create a User +* Delete a User +* Rename a User +* Create a PreAuth Key +* Try all Sort Categories + +## Device Testing +* Add a Device with a Preauth Key +* Add a Device with a machine key +* Add a Device with OIDC (if set up to do so) +* Rename a Device +* Try all sort categories +* Create a Tag +* Delete a Tag +* Delete a Device +* Add and approve a route (if set up to do so) +* Change the assigned user for a device + +## Failure Test +* Test messages (both console and alerts) with failed apikey +* Test recovery once apikey is back +* Test messages (both console and alerts) with failed URL +* Test recovery once URL is back + +## Settings Test +* Verify version comes across once released \ No newline at end of file