From e8ec2882d22af017f51b674be6b0606afadbf61b Mon Sep 17 00:00:00 2001
From: Gregoire Olivier <olivier.gregoire@savoirfairelinux.com>
Date: Thu, 24 Aug 2017 15:55:48 +0200
Subject: [PATCH] doc: How to do test in the daemon

Change-Id: Ide4fec4e69da5d8916af94631520f1f4ce4f9f21
Reviewed-by: Guillaume Roguez <guillaume.roguez@savoirfairelinux.com>
---
 docs/source/dev/test/daemon.rst | 20 ++++++++++++++++++++
 docs/source/dev/test/index.rst  | 11 +++++++++++
 docs/source/index.rst           |  1 +
 3 files changed, 32 insertions(+)
 create mode 100644 docs/source/dev/test/daemon.rst
 create mode 100644 docs/source/dev/test/index.rst

diff --git a/docs/source/dev/test/daemon.rst b/docs/source/dev/test/daemon.rst
new file mode 100644
index 00000000..3db31276
--- /dev/null
+++ b/docs/source/dev/test/daemon.rst
@@ -0,0 +1,20 @@
+Test the daemon
+===============
+
+The unit testing framework
+##########################
+We use CppUnit on GNU ring project. You can find a simple tutorial with code exemple on the  `official website <http://cppunit.sourceforge.net/doc/cvs/cppunit_cookbook.html>`_.
+
+Tests
+#####
+How to use them?
+----------------
+Write "make check" instead of "make".
+
+
+Localisation
+------------
+All the tests are locate on the test folder:
+
+- Black box test are locate at the root of the folder
+- Unit tests are locate in the unitTest folder with the same path as the class you test on the src folder (`simple example <https://gerrit-ring.savoirfairelinux.com/#/c/7677/>`_)
diff --git a/docs/source/dev/test/index.rst b/docs/source/dev/test/index.rst
new file mode 100644
index 00000000..c8b5dca1
--- /dev/null
+++ b/docs/source/dev/test/index.rst
@@ -0,0 +1,11 @@
+.. _building:
+
+Tests
+=====
+
+This section show how to launch and create a test in the different components of Ring.
+
+.. toctree::
+   :maxdepth: 1
+
+   daemon
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b741865c..8395ff9b 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -31,6 +31,7 @@ As a developer looking to get started with a contribution, see
    dev/contributing
    dev/compiling_and_installing/index
    dev/releasing
+   dev/test/index
 
 .. toctree::
    :caption: Ring Daemon
-- 
GitLab