summaryrefslogtreecommitdiff
path: root/docs/src/gettingstarted/testing.md
diff options
context:
space:
mode:
authorjwijenbergh <jeroenwijenbergh@protonmail.com>2022-05-05 17:47:36 +0200
committerjwijenbergh <jeroenwijenbergh@protonmail.com>2022-05-05 17:47:36 +0200
commit7bb7885f6eb19547b906513d2664e3730ef5b593 (patch)
treece387ad24da5e3ba3b4d1604d07a5b11d9e68a2e /docs/src/gettingstarted/testing.md
parent657776055cd07c1f9279e982fbfef88dca1ca71b (diff)
Docs: Add API and building improvements
Diffstat (limited to 'docs/src/gettingstarted/testing.md')
-rw-r--r--docs/src/gettingstarted/testing.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/src/gettingstarted/testing.md b/docs/src/gettingstarted/testing.md
index f89757e..7bf4bf2 100644
--- a/docs/src/gettingstarted/testing.md
+++ b/docs/src/gettingstarted/testing.md
@@ -1,7 +1,6 @@
# Testing
To test the Go code, issue the following command in a shell
-## Testing the Go code
```bash
make test-go
```
@@ -13,12 +12,13 @@ SERVER_URI="eduvpn.example.com" PORTAL_USER="example" PORTAL_PASS="example" make
```
If you have [Docker](https://www.docker.com/get-started/) installed and [Docker-compose](https://docs.docker.com/compose/install/) you can use a convenient helper script which starts up two containers
-- An eduvpnserver for testing
+- An EduVPN Server for testing
- A Go container that builds and runs the test-suite
```bash
PORTAL_USER="example" PORTAL_PASS="example" ./ci/startcompose.sh
```
+Note that this helper script also assumes you have the `openssl` command line tool installed. This is used to install the self-signed certificates for testing.
This script is also used in the continuous integration, so we recommend to run this before you submit any changes.
## Testing the wrappers