diff --git a/docs/source/dev/test/daemon.rst b/docs/source/dev/test/daemon.rst new file mode 100644 index 0000000000000000000000000000000000000000..3db31276ce26288efffb0c1b65f04b84f507c91a --- /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 0000000000000000000000000000000000000000..c8b5dca153d9c255465da795f5df753d2e16d72c --- /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 b741865c9cf87101c8e87d1b72d06c97f2c65ce4..8395ff9bdc4b73b922d4b892717b190e328a362f 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