= Unit Tests =

[[TOC(heading=Inhoudsopgave)]]
[[TOC(heading=Hoofdstukken, sectionindex, compact, depth=2, Documentatie/Ontwikkelhandleiding/*)]]

OpenAC heeft een grote verzameling ''unit tests'' om de functionaliteit van het programma te testen. Hierbij wordt vooral de algoritmische- en data-kant van het programma getest. Er wordt niet stilgestaan bij de user interface (op enkele puntjes na).

== Unit Tests Uitvoeren ==

In de {{{development/}}} branch en releases vanaf versie 2.000 staat er in de bovenste directory van OpenAC een file {{{unittests.py}}}. Dit is het "aandrijf" script van de unittests voor het gehele programma. Het kan worden opgestart vanaf de command-line als ieder ander Python programma:
{{{
  Python25\python.exe unittests.py
}}}

Zonder argumenten, of wanneer je {{{--help}}} toevoegt, legt het script uit welke argumenten het accepteert.

Meestal ben je geinteresseerd in alle unittests voor OpenAC, toegepast op je eigen adaptatie. Dan gebruik je
{{{
  Python25\python.exe unittests.py --enable-all -a <adaptatie>
}}}
Vul voor {{{<adaptatie>}}} de naam van je adaptatie in, zoals "amsterdam" of "drenthe" ("ac_amsterdam" mag ook).

De unit tests produceren heel veel uitvoer met aan het eind een overzicht van hoeveel tests er zijn uitgevoerd, hoeveel er mis zijn gegaan. Dat ziet er zo uit:
{{{
Ran 352 tests in 55.550s
FAILED (failures=15, errors=3)
}}}
Er zit een handvol verwachte failures in de unittests, waar OpenAC dingen niet doet zoals we het verwachten (in bijzondere randgevallen). Errors geven aan dat er een probleem is in de OpenAC code die niet goed wordt afgevangen. Errors in de unittests kunnen direct als defect worden gerapporteerd in het [/newticket tickets systeem]. 

=== Tests Selecteren ===

De tests van de adaptaties, desktop-laag, includes, kern en logica zijn allemaal afzonderlijk te selecteren met de opties `--with-*` (bijvoorbeeld `--with-include`). Hiermee zijn de grote groepen tests aan of uit te zetten. Met `--enable-all` worden alle tests aangezet.

Als `--with-adaptaties` aan staat, dan kan de test worden beperkt tot de tests van specifieke adaptaties met de optie `-a` (of `--adaptaties`). Geef een lijst van adaptatie-namen op, gescheiden door komma's. Als voorbeeld met de tests van drie verschillende AC's:

{{{
  Python25\python.exe unittests.py --with-adaptaties -a amc,amsterdam,vumc
}}}

Als `--with-kern` aanstaat, dan kan de test worden beperkt ror specifieke kern-modules. De optie `-m` (of `--modules`) kan een komma-gescheiden lijst van module-namen gebruiken. Alleen die kern-modules met een naam die lijkt op de opgegeven lijst worden gebruikt.
De namen worden gezocht in alle kernmodules, dus "grouper" selecteert de unit tests van alle kernmodules waar het woord "grouper" in de naam voorkomt (dat is er maar een, ''e080_grouper''), maar als je {{{-m hl7,dos}}} gebruikt krijg je de tests van zeven modules).

{{{
  Python25\python.exe unittests.py --with-kern -m grouper,easidata
}}}

Om de tests uit ''een enkele test-klasse'' te draaien, gebruik de optie `it` (of `--tests`). Dit is vooral interessant bij het maken van tests voor een module, als je niet de hele tijd alle tests wilt draaien maar je wilt concentreren op de nieuwe tests. Geef een komma-gescheiden lijst van test-klassen op. Alleen die klassen die voorkomen in de lijst worden uitgevoerd (de andere selecties blijven van kracht, dus om alleen de test-klasse ''!TestPermissies'' van de kern-module ''systeem'' uit te voeren, moet je zowel `-m` als `-t` opgeven, anders krijg je de ''!TestPermissies'' test-klasse van alle modles).

{{{
  Python25\python.exe unittests.py --with-kern -m systeem -t TestPermissies
}}}

== Unit Tests Schrijven ==

Unit tests worden traditioneel opgeslagen in een bestand {{{unittests.py}}} in de desbetreffende directory. We streven ernaar om alle kernmodules een pakket unit tests te geven. Daarnaast hebben de directories {{{include/}}} en {{{logica/}}} tests '''en''' de adaptaties kunnen hun eigen unit tests hebben om lokale functionaliteit te testen.

De makkelijkste manier om een test te schijven is om een bestaand voorbeeld te volgen. Elk unit test bestand heeft de volgende structuur:

{{{
  import unittest
  from include import testhelpers

  class MijnTest(testhelpers.TestCaseMetLogin):
    def test_iets(self):
       <de test>

  def suite():
    return testhelpers.create_suite(globals())
}}}

Een test is een functie in een test-klasse. Een unit test kan meerdere test-klassen bevatten, en een klasse kan meerdere tests bevatten. De klassen en functies zijn vooral een manier om de tests te organiseren en te structureren. De tests worden uiteindelijk in alfabetische volgorde binnen elke klasse uitgevoerd.

In elke `unittests.py` module verwachten we een functie `suite()` die de tests van de module teruggeeft. Zie de documentatie van `include.testhelpers.create_suite()` voor uitleg hoe die de tests aanmaakt.

Voor volledige documentatie zie [http://docs.python.org/library/unittest.html de Python documentatie voor de unittest module]. '''NB.''' OpenAC gebruikt Python 2.5 en de huidige versie van de documentatie is voor Python 2.7, dus let op de "''Since 2.6''" en dergelijke compatibiliteits-informatie.