Small re-work for test instructions

This commit is contained in:
Luke Bakken 2020-04-08 18:48:36 +00:00
parent 8f541a0675
commit d174147f94
1 changed files with 16 additions and 13 deletions

View File

@ -1,10 +1,20 @@
## Running Common Test Suites
```shell
gmake tests
```
When running tests via `gmake tests`, there is no need to run the
`init-etcd.sh` script as the test suite will do it for you.
## etcd Node Management
The test suite of this plugin ships with a [script](./test/system_SUITE_data/init-etcd.sh)
that starts an `etcd` node in the background. It can also be used to start
a node for experimenting with this plugin.
that starts an `etcd` node in the background.
To run it:
This script can also be used to start a node for experimenting with this
plugin. To run it:
```shell
./test/system_SUITE_data/init-etcd.sh [etcd data dir] [etcd client port]
@ -12,19 +22,12 @@ To run it:
where `[etcd data dir]` is the desired `etcd` node data directory path.
The script depends on the [`daemonize` tool](https://software.clapper.org/daemonize/) for running the process in the background
and pid file creation.
The script depends on the [`daemonize`
tool](https://software.clapper.org/daemonize/) for running the process in the
background and pid file creation.
To stop a node started this way use the pid file created by `daemonize`:
```shell
pkill -INT $(cat [etcd data dir]/etcd.pid)
```
## Running Tests
```shell
gmake tests
```
to run all test suites.