diff options
Diffstat (limited to 'netcon/docker-test')
| -rw-r--r-- | netcon/docker-test/README.md | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/netcon/docker-test/README.md b/netcon/docker-test/README.md index f3708e4d..a3b21e1d 100644 --- a/netcon/docker-test/README.md +++ b/netcon/docker-test/README.md @@ -1,25 +1,30 @@ +### Unit Tests + To run unit tests: -1) Place a blank network config file in this directory (e.g. "e5cd7a9e1c5311ab.conf") - - This will be used to inform test-specific scripts what network to use for testing (create your own, or use the given at your own risk) +1) Set up your own network, use its network id as follows: + +2) Place a blank network config file in this directory (e.g. "e5cd7a9e1c5311ab.conf") + - This will be used to inform test-specific scripts what network to use for testing -2) run build.sh - - Builds ZeroTier with Network Containers enabled +3) run build.sh + - Builds ZeroTier-One with Network Containers enabled - Builds LWIP library - - Builds library harness + - Builds intercept library - Copies all aformentioned files into unit test directory to be used for building docker files -3) run test.sh - - Will (for now, one at a time), execute each unit test's (test.sh) +4) run test.sh + - Will execute each unit test's (test.sh) one at a time and populate _results/ +### Anatomy of a unit test A) Each unit test's test.sh will: - temporarily copy all built files into local directory - build test container - build monitor container - remove temporary files - - run each container and perform test + - run each container and perform test and monitoring specified in netcon_entrypoint.sh and monitor_entrypoint.sh B) Results will be written to the 'zerotierone/docker-test/_result' directory - Results will be a combination of raw and formatted dumps to files whose names reflect the test performed |