{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Unit Testing\n",
    "\n",
    "Unit testing is essential to ensure software quality. Given our software is heavily data based.\n",
    "We developed a minimal testing module to create unit tests. The idea behind the module is similar to some existing Python unit testing modules.\n",
    "For better compatibility, the new version of the `unit_test` class will simply be a wrapper of the existing Python `unittest` module, so that it can be easily detected by existing Python unit testing modules. \n",
    "This wrapper will ensure easier creation of tests and minimize redundant codes."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Creating a test\n",
    "\n",
    "Below is an example of a unit test case. \n",
    "If `pre_test` method is defined, the unit test engine will execute the `pre_test` method to prepare the tests.\n",
    "Then if will find all the methods begins with `test_` and execute them.\n",
    "To compare the test results, the engine will compare all the non-callable attributes that do not start with `_`, with a provided data source (A dictionary, a yaml file or another instance of a test). Assertion errors will be raised if the comparison failed."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
    "from unit_test import unit_test\n",
    "\n",
    "class this_is_a_test(unit_test):\n",
    "    \n",
    "    def pre_test(self):\n",
    "        # Pre-testing set up\n",
    "        pass\n",
    "\n",
    "    def test_1(self):\n",
    "        # Testing actions\n",
    "        pass"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Running tests\n",
    "\n",
    "* One can run tests by instantiating a class and do comparison\n",
    "    ``` python\n",
    "    atest = this_is_a_test()\n",
    "    ```\n",
    "    By default, the option in the constructor `check_after_run` is `True`, \n",
    "    and the code will try to open data source located at `output/<class name>.yaml`, \n",
    "    and compare the results. \n",
    "    Or the method `assert_compare_with` can be called manually providing the data source.\n",
    "    \n",
    "* Or, one can execute the code `unit_test.py` directly, \n",
    "    and use the provided daemon to search all tests in the current directory recursively and execute them.\n",
    "    Any tests with the name starting with `_` will be ignored. \n",
    "    One can utilize this to write secondary wrappers."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 2",
   "language": "python",
   "name": "python2"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 2
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython2",
   "version": "2.7.17"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}