aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorClément Bénier <clement.benier@iot.bzh>2018-08-30 13:21:25 +0200
committerClément Bénier <clement.benier@iot.bzh>2018-08-30 14:00:52 +0200
commitaf184b48d00d7b764583518576ddc96fd79511ed (patch)
tree45bc2cc7a5fc18c0da984d0193357e6e058664dc /docs
parentd2197e0999b3437faa33acc5643f688e35fa0e84 (diff)
quickly explain the test architecture explain how to launch xds-server test and its options Change-Id: Ia94aef611dbb2295ea4fb31d13e22e758ad30827 Signed-off-by: Clément Bénier <clement.benier@iot.bzh>
Diffstat (limited to 'docs')
-rw-r--r--docs/SUMMARY.md1
-rw-r--r--docs/part-2/1_xds-server/5_test.md42
2 files changed, 43 insertions, 0 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 9b40ce3..ffa286f 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -26,6 +26,7 @@
* [How to run](part-2/1_xds-server/2_how-to-run.md)
* [Build from scratch](part-2/1_xds-server/3_build.md)
* [Debugging](part-2/1_xds-server/4_debug.md)
+ * [Test](part-2/1_xds-server/5_test.md)
* [XDS-agent](part-2/2_xds-agent/0_abstract.md)
* [Configuration](part-2/2_xds-agent/1_config.md)
* [Start](part-2/2_xds-agent/2_start.md)
diff --git a/docs/part-2/1_xds-server/5_test.md b/docs/part-2/1_xds-server/5_test.md
new file mode 100644
index 0000000..ddcac4d
--- /dev/null
+++ b/docs/part-2/1_xds-server/5_test.md
@@ -0,0 +1,42 @@
+# XDS Server Test
+
+## XDS Server test architecture
+
+The test part is written in go and source code is available in test directory.
+
+```bash
+|
++-- test/ # where xds-server test source files
+|
++-- test/main_test.go # main entry point of xds-server test
+|
++-- test/fixtures # fixtures for running test
+```
+
+The test execution will locally launch xds-server and access the api through REST and test results, events, ...
+
+## Dependencies
+
+* sshd
+
+Make sure sshd is in your user PATH.
+
+## Launch test
+
+Use the following command to launch test in xds-server root directory:
+
+```bash
+make test
+```
+
+Launch only one test, for example launch TestSdks:
+
+```bash
+make test name=TestSdks
+```
+
+Increase test verbosity:
+
+```bash
+make test VERBOSE=1
+``` \ No newline at end of file