dorie.testtools
****************

.. contents::

What is dorie.testtools?
========================

dorie.testtools provides the following components

- a wrapper script to run automated tests created with dune-testtools
- evaluation scripts to process the run data and determine pass or fail for each test

How to use dorie.testtools
++++++++++++++++++++++++++

The dorie.testtools wrappers are called via the CMake interface provided by dune-testtools
(CMake macro `add_dune_system_test`). The `SCRIPT` parameter allows to specify the script to be called.


The dorie.testtools scripts
===========================

``test_dorie.py``

  This script parses the given parameter file, executes DORiE, and passes the result
  to the corresponding evaluation module.
  The behavior is controlled by special parameter keys to be provided in the ini file.

  **Parameter keys**:

  * ``_evaluation``: Specifies the evaluation script that is to be called. Can be the name of any module in :mod:`dorie.testtools.evaluation`.
  * ``__inifile_optionkey``: The argument that is passed to the DORiE executable before the parameter file. This should be `run`` in most situations.

  All command line arguments are passed through the dune-testtools CMake machinery and parsed by the
  :mod:`dune.testtools` python package.


The dorie.testtools core modules
================================

.. automodule:: dorie.testtools

dorie.testtools consists of two submodules:

- :mod:`dorie.testtools.evaluation`, containing all modules responsible for the evaluation of
   the system tests
- :mod:`dorie.testtools.utilities`, which contains convenience functions that are included by
   the evaluation modules and are too specific to be contained in :mod:`dorie.utilities`


The evaluation module
+++++++++++++++++++++

.. automodule:: dorie.testtools.evaluation
    :members:
    :undoc-members:

Convergence evaluator
----------------------

.. automodule:: dorie.testtools.evaluation.convergence
    :members:
    :undoc-members:

Correlation evaluator
----------------------

.. automodule:: dorie.testtools.evaluation.correlation
    :members:
    :undoc-members:

ODE evaluator
--------------

.. automodule:: dorie.testtools.evaluation.ode
    :members:
    :undoc-members:

The utilities module
++++++++++++++++++++

.. automodule:: dorie.testtools.utilities
    :members:
    :undoc-members:

Richards equation definitions
------------------------------

.. automodule:: dorie.testtools.utilities.richards_equation
    :members:
    :undoc-members:

Statistical tools
-----------------

.. automodule:: dorie.testtools.utilities.statistics
    :members:
    :undoc-members:
    
Decorators
----------

.. automodule:: dorie.testtools.utilities.decorators
    :members:
    :undoc-members: