Unittest
========

:doc:`unittest <python3:library/unittest>` unterstützt euch bei der
Testautomatisierung mit gemeinsam genutztem Setup- und TearDown-Code sowie der
Aggregation und Unabhängigkeit von Tests.

Hierfür liefert es die folgenden Testkonzepte:

.. glossary::

   Test Case (Testfall)
       testet eine einzelnes Szenario.

   Test Fixture (Prüfvorrichtung)
       ist eine konsistente Testumgebung.

       .. seealso::
          * `pytest fixtures <https://docs.pytest.org/en/latest/explanation/fixtures.html>`_
          * `About fixtures
            <https://docs.pytest.org/en/latest/explanation/fixtures.html#about-fixtures>`_
          * `Fixtures reference
            <https://docs.pytest.org/en/latest/reference/fixtures.html>`_
          * `How to use fixtures
            <https://docs.pytest.org/en/latest/how-to/fixtures.html#how-to-fixtures>`_

   Test Suite
       ist eine Sammlung mehrerer :term:`Test Cases <Test Case (Testfall)>`.

   Test Runner
       durchläuft eine :term:`Test Suite` und stellt die Ergebnisse dar.

Beispiel
--------

Angenommen, ihr habt im Modul :download:`test_arithmetic.py` die folgende
Methode zum Hinzufügen implementiert:

.. literalinclude:: /document/arithmetic.py
   :language: python
   :lines: 1-6
   :lineno-start: 1

… dann könnt ihr diese Methode mit einem Unittest testen.

#. Dazu müsst ihr zunächst euer Modul und das Unittest-Modul importieren:

   .. literalinclude:: test_arithmetic.py
      :language: python
      :lines: 1, 6
      :lineno-start: 1

#. Anschließend könnt ihr eine Testmethode schreiben, die eure Additionsmethode
   veranschaulicht:

   .. literalinclude:: test_arithmetic.py
      :language: python
      :lines: 6-9
      :lineno-start: 6

#. Damit die Unittests auch in andere Module importiert werden können, solltet
   ihr die folgenden Zeilen hinzufügen:

   .. literalinclude:: test_arithmetic.py
      :language: python
      :lines: 23-24
      :lineno-start: 23

#. Schließlich können alle Tests in :download:`test_arithmetic.py` ausgeführt
   werden:

   .. tab:: Linux/macOS

      .. code-block:: console

         $ python test_arithmetic.py
         ....
         ----------------------------------------------------------------------
         Ran 4 tests in 0.000s

         OK

   .. tab:: Windows

      .. code-block:: ps1con

         C:> python test_arithmetic.py
         ....
         ----------------------------------------------------------------------
         Ran 4 tests in 0.000s

         OK

   … oder etwas ausführlicher:

   .. tab:: Linux/macOS

      .. code-block:: ps1con

         $ python test_arithmetic.py -v
         test_addition (__main__.TestArithmetic) ... ok
         test_division (__main__.TestArithmetic) ... ok
         test_multiplication (__main__.TestArithmetic) ... ok
         test_subtraction (__main__.TestArithmetic) ... ok

         ----------------------------------------------------------------------
         Ran 4 tests in 0.000s

         OK

   .. tab:: Windows

      .. code-block:: ps1con

         C:> python test_arithmetic.py -v
         test_addition (__main__.TestArithmetic) ... ok
         test_division (__main__.TestArithmetic) ... ok
         test_multiplication (__main__.TestArithmetic) ... ok
         test_subtraction (__main__.TestArithmetic) ... ok

         ----------------------------------------------------------------------
         Ran 4 tests in 0.000s

         OK

.. seealso::
   * :doc:`python3:library/unittest`

Beispiel: SQLite-Datenbank testen
---------------------------------

#. Zum Testen, ob die Datenbank ``library.db`` mit :download:`create_db.py
   <../save-data/sqlite/create_db.py>` angelegt wurde, importieren wir neben
   :doc:`sqlite3 <python3:library/sqlite3>` und :doc:`unittest
   <python3:library/unittest>` auch noch :download:`create_db.py
   <../save-data/sqlite/create_db.py>` und :doc:`os <python3:library/os>`:

   .. literalinclude:: ../save-data/sqlite/test_sqlite.py
      :language: python
      :lines: 1-5
      :lineno-start: 1

#. Anschließend definieren wir zunächst eine Testklasse ``TestCreateDB``:

   .. literalinclude:: ../save-data/sqlite/test_sqlite.py
      :language: python
      :lines: 8
      :lineno-start: 8

#. In ihr definieren wir dann die Testmethode ``test_db_exists``, in der wir mit
   ``assert`` die Annahme treffen, dass die Datei in :doc:`os.path
   <python3:library/os.path>` existiert:

   .. literalinclude:: ../save-data/sqlite/test_sqlite.py
      :language: python
      :lines: 9-10
      :lineno-start: 9

#. Nun überprüfen wir auch noch, ob die Tabelle ``books`` angelegt wurde.
   Hierfür versuchen wir, die Tabelle erneut anzulegen und erwarten mit
   ``assertRaises``, dass ``sqlite`` mit einem ``OperationalError`` beendet
   wird:

   .. literalinclude:: ../save-data/sqlite/test_sqlite.py
      :language: python
      :lines: 12-14
      :lineno-start: 12

#. Weitere Tests wollen wir nicht an einer Datenbank im Dateisystem
   durchführen sondern in einer SQLite-Datenbank im Arbeitsspeicher:

   .. literalinclude:: ../save-data/sqlite/test_sqlite.py
      :language: python
      :lines: 17-20
      :lineno-start: 17

.. seealso::
   Weitere Beispiele zum Testen eurer SQLite-Datenbankfunktionen findet ihr in
   der SQLite Testsuite `test_sqlite3
   <https://github.com/python/cpython/tree/main/Lib/test/test_sqlite3>`_.