Doc: Add documentation on how to test with Autobahn|Testsuite

Change-Id: Ia18acdc3c54e2bb48209406d2a6f9e156b67324c
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>

3 files changed, 79 insertions, 2 deletions

diff --git a/src/websockets/doc/qtwebsockets.qdocconf b/src/websockets/doc/qtwebsockets.qdocconf
index 2e1e15b..8ce18ec 100644
--- a/src/websockets/doc/qtwebsockets.qdocconf
+++ b/src/websockets/doc/qtwebsockets.qdocconf
@@ -44,7 +44,8 @@ headerdirs                                          += .. \
 
 sourcedirs                                          += .. \
                                                        src \
-                                                       ../../imports
+                                                       ../../imports \
+                                                       ../../../tests/doc
 
 
 exampledirs                                         += ../../../examples/websockets \
diff --git a/src/websockets/doc/src/index.qdoc b/src/websockets/doc/src/index.qdoc
index 0d28036..344a859 100644
--- a/src/websockets/doc/src/index.qdoc
+++ b/src/websockets/doc/src/index.qdoc
@@ -57,7 +57,7 @@
     QT += websockets
     \endcode
 
-    \section1 Reference documentation
+    \section1 Reference Documentation
     \list
     \li \l{Qt WebSockets C++ Classes}{C++ Classes}
     \li \l{Qt WebSockets QML Types}{QML Types}
@@ -67,4 +67,22 @@
 
     The module provides the following \l{Qt WebSockets Examples}{Examples} as a guide to using
     the API.
+
+    \section1 Conformance
+    \list
+    \li \l {Testing Qt WebSockets}
+    \endlist
+*/
+
+/*!
+    \page qtwebsockets-testing.html
+    \title Testing Qt WebSockets
+
+    \l {http://autobahn.ws/testsuite/}{Autobahn|Testsuite}, a standard test
+    suite for WebSocket Protocol (RFC 6455), can be used for testing the
+    conformance of Qt WebSockets. Refer to Autobahn|Testsuite
+    \l {http://autobahn.ws/testsuite/installation.html}{installation documentation}
+    to set up the test suite.
+
+    \include README testsuite
 */
diff --git a/tests/doc/README b/tests/doc/README
new file mode 100644
index 0000000..da9b2b5
--- /dev/null
+++ b/tests/doc/README
@@ -0,0 +1,58 @@
+This directory contains autotests and manual tests for the Qt WebSockets
+module.
+
+In addition, Autobahn|Testsuite, a standard test suite for WebSocket
+Protocol (RFC 6455), can be used for testing the conformance of Qt
+WebSockets.
+
+http://autobahn.ws/testsuite/
+
+Refer to Autobahn|Testsuite installation documentation at
+http://autobahn.ws/testsuite/installation.html
+
+//! [testsuite]
+\section1 Testing Qt WebSockets with Autobahn|Testsuite
+
+
+\section2 wstest - fuzzingserver mode
+
+\code
+    cd your_build_dir/tests/manual/compliance
+    qmake your_src_dir/tests/manual/compliance/compliance.pro
+    make
+
+    cd ~
+    wstest -m fuzzingserver
+\endcode
+
+Then, in another terminal:
+
+\code
+    cd your_build_dir/tests/manual/compliance
+    ./tst_compliance
+\endcode
+
+Test results will be generated under ~/reports/clients directory.
+Point your browser to ~/reports/clients/index.html.
+
+
+\section2 wstest - fuzzingclient mode
+
+\code
+    cd your_build_dir/examples/websockets/echoserver
+    qmake your_src_dir/examples/websockets/echoserver/echoserver.pro
+    make
+
+    ./echoserver -p 9001
+\endcode
+
+Then, in another terminal:
+
+\code
+    cd ~
+    wstest -m fuzzingclient
+\endcode
+
+Test results will be generated under ~/reports/servers directory.
+Point your browser to ~/reports/servers/index.html.
+//! [testsuite]