modul:m450:learningunits:lu04:fixture

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
modul:m450:learningunits:lu04:fixture [2025/03/27 09:14] – kmaurizimodul:m450:learningunits:lu04:fixture [2026/11/17 08:02] (aktuell) – Neu gefasst: lauffähige Beispiele (ohne self), yield/Aufräumen, conftest.py, Lernziele, Kontrollfragen, Kompetenz-Tags admin
Zeile 1: Zeile 1:
 ====== LU04a - Fixture ====== ====== LU04a - Fixture ======
-/*TODO SuMa: Einfachere Beispiele*/ +<WRAP center round info 80%> 
-<WRAP center round info 60%> +**Auf einen Blick**\\ 
-Eine //Fixture// (deutsch: Vorrichtung, Halterung) dienen zur Initialisierung von Tests. +Eine **Fixture** (deutsch: Vorrichtung, Halterung) bereitet alles vor, was ein Test braucht, und räumt danach wieder auf. 
-Sie bieten eine statische Basis, damit Test zuverlässig ausgeführt werden und konsistente, wiederholbare Resultate erzeugen.+In PyTest ist eine Fixture eine Funktion mit dem Dekorator ''@pytest.fixture''. Ein Test fordert sie an, indem er ihren Namen als Parameter angibt. 
 +So haben alle Tests die gleiche, wiederholbare Ausgangslage, ohne dass der Vorbereitungscode kopiert werden muss.
 </WRAP> </WRAP>
  
-===== Was sind Fixtures? =====+===== Lernziele ===== 
 +Sie können 
 +  * eigene Fixtures definieren und in Tests verwenden, 
 +  * Fixtures kombinieren und mit ''yield'' nach dem Test aufräumen, 
 +  * gemeinsame Fixtures in ''conftest.py'' ablegen, 
 +  * die eingebauten Fixtures ''capsys'', ''monkeypatch'' und ''tmp_path'' gezielt einsetzen.
  
-Bei der Durchführung von Tests müssen wir sicherstellen, dass diese immer wieder die gleichen Resultate erzeugen. +===== Wozu Fixtures? ===== 
-Dazu müssen die Tests immer in der gleichen Umgebung mit den gleichen Daten durchgeführt werden. +Ein Test läuft in vier Schritten ab:
-Fixtures helfen uns diese gleich bleibende Basis für unsere Testfälle sicherzustellen.+
  
-Die Durchführung eines Tests kann in vier Schritte unterteilt werden: +^ Schritt         ^ Was passiert                                                         ^ In PyTest                       ^ 
-  - Vorbereitung: Wir bereiten die Umgebung für die Durchführung des Tests vor. Dazu gehören: +| **Vorbereiten** | Objekte erzeugen, Dateien oder Datenbanken mit Testdaten füllen      | Fixture (vor ''yield'' oder ''return'') | 
-    * Objekte erzeugen +| **Ausführen**   | Die zu testende Funktion aufrufen                                    | Testfunktion (Act)              | 
-    * Daten in Datenbanken oder Dateien bereitstellen +| **Auswerten**   | IST mit SOLL vergleichen                                             | Testfunktion (Assert)           | 
-    * Umgebungsvariablen wie URL, Pfade, ... definieren +| **Aufräumen**   | Alle Änderungen rückgängig machen, damit andere Tests nicht beeinflusst werden | Fixture (nach ''yield'') |
-  - Ausführen: Wir führen die zu testende Funktion aus und nehmen die Resultate entgegen. +
-  - Auswerten: Wir vergleichen die tatsächlichen Resultate mit den erwarteten Resultaten. Anhand dieses Vergleichs können wir bewerten, ob der Test erfolgreich war oder nicht. +
-  - Aufräumen: Zuletzt sollte der Test alle Veränderungen am System rückgängig machen. Dadurch verhindern wir, dass die Resultate anderer Tests beeinflusst werden.+
  
-Im engeren Sinne des Wortes sind Fixtures Vorbereitungsschritte für die Durchführung eines Tests. +Schreiben Sie die Vorbereitung in jede Testfunktion, wiederholt sich derselbe Code dutzende Male. Ändert sich der Konstruktor einer Klasse, müssen Sie alle Tests anpassen. Mit einer Fixture ändern Sie nur eine Stelle.
-Wir können aber Fixtures auch etwas weiter fassen. +
-Es handelt sich um alle nötigen Schritte, rund um den eigentlichen Test. +
-Also sowohl Vorbereitung als auch Ausführung und Aufräumarbeiten. +
  
-===== Fixtures in PyTest ===== +===== Eigene Fixtures definieren ===== 
-//Siehe auch [[https://docs.pytest.org/en/6.2.x/fixture.html|pytest fixtures]]//+<code python> 
 +import pytest 
 +from library import Customer, Library
  
-PyTest bietet uns ein umfangreiches System zum Einsatz solcher Fixtures an, die wir in den verschiedenen Schritten einsetzen können. 
  
-==== capsys und monkeypatch ==== +@pytest.fixture 
-In der letzten Learning Unit haben wir bereits mit ''capsys'' und ''monkeypatch'' gearbeitet, um die Ein- und Ausgaben zu kontrollieren. +def customer_max(): 
-Mittels ''capysys'' haben wir die Ausgaben einer Funktion gelesen. +    return Customer('Max')
-Zum Bereitstellen von Benutzereingaben, haben wir ''monkeypatch'' genutzt.+
  
-Monkeypatch kann mehr als nur Benutzereingaben bereitstellen. 
-Mit Hilfe dieser Fixture können wir 
-  * Attribute von Objekten verändern 
-  * Elemente von Dictionaries ändern und löschen 
-  * Umgebungsvariablen setzen und löschen 
  
-Dadurch können wir zum Beispiel Situationen erzeugen, die beim normalen Ablauf des Programms nicht auftreten können oder sollten.+@pytest.fixture 
 +def customer_moritz(): 
 +    return Customer('Moritz')
  
-===== Eigene Fixtures definieren ===== 
-Neben den von PyTest vorgegebenen Fixtures, können wir auch eigene Funktionen schreiben und als Fixtures nutzen. 
-Ein typischer Einsatz solcher Funktionen ist das Bereitstellen von Objekten und Daten für die Tests. 
-Dadurch stellen wir beliebig vielen Testfunktionen eine einheitliche Datenbasis bereit. 
  
-==== Beispiele ==== 
-=== Objekte bereitstellen === 
-Für die Tests in einer Applikation sollen zwei Objekte der Klasse ''Customer'' bereitgestellt werden. 
- 
-<code python> 
 @pytest.fixture @pytest.fixture
-def customer_max(self): +def library(): 
-    return Customer('Max', None)+    return Library()
  
-@pytest.fixture + 
-def customer_moritz(self): +def test_add_customers(library, customer_max, customer_moritz):
-    return Customer('Moritz', None) +
-     +
-def test_add_customers(self, customer_max, customer_moritz): +
-    library = Library()+
     library.add_customer(customer_max)     library.add_customer(customer_max)
     library.add_customer(customer_moritz)     library.add_customer(customer_moritz)
-    assert len(library.customers) == 2   # Checks the number of entries in the list +    assert len(library.customers) == 2
 </code> </code>
-In der Testfunktion ''test_add_customers'' werden die beiden Fixtures als Parameter angegeben. 
-Pytest stellt selber sicher, dass die entsprechenden Fixtures ausgeführt werden. 
  
-=== Testdaten aus einer Datei lesen ===+  * PyTest sieht die Parameter ''library'', ''customer_max'' und ''customer_moritz'', ruft die gleichnamigen Fixtures auf und übergibt deren Rückgabewerte. 
 +  * Jeder Test erhält **neue** Objekte. Ändert ein Test die Bibliothek, merkt der nächste Test nichts davon.
  
-<code python>+<WRAP center round important 80%> 
 +Fixtures und Testfunktionen, die **nicht** in einer Klasse stehen, haben **keinen** Parameter ''self''. Sonst meldet PyTest den Fehler ''fixture 'self' not found''. 
 +</WRAP>
  
-def test_add_entries1(monkeypatch, capsys, version, test_values): +==== Fixtures kombinieren ==== 
-    .... +Eine Fixture kann selbst andere Fixtures anfordern. So bauen Sie komplexere Ausgangslagen schrittweise auf: 
-     + 
-    +<code python>
 @pytest.fixture @pytest.fixture
-def test_values(): +def library_with_customers(library, customer_max, customer_moritz): 
-    try: +    library.add_customer(customer_max) 
-        with open('./testdata.json') as json_file: +    library.add_customer(customer_moritz) 
-            data = json.load(json_file) +    return library
-            return data +
-    except FileNotFoundError as ex: +
-        print('\n==========================================================================') +
-        print('WICHTIG: Keine Testdaten gefunden. Kontaktieren Sie SOFORT Ihre Lehrperson') +
-        print('==========================================================================\n\n') +
-        raise FileNotFoundError+
  
  
-@pytest.fixture +def test_find_customer(library_with_customers): 
-def version(): +    customer = library_with_customers.find_customer('Moritz') 
-    collection = echarge.init_accounts() +    assert customer.name == 'Moritz' 
-    if collection is None: + 
-        return 'UNBEKANNT' + 
-    if isinstance(collection, list): +def test_find_unknown_customer(library_with_customers): 
-        return 'BASIS' +    assert library_with_customers.find_customer('Lempel') is None
-    if isinstance(collection, dict): +
-        return 'ERWEITERT' +
-    return 'UNBEKANNT' +
-    +
 </code> </code>
  
 +===== Aufräumen mit yield =====
 +Muss nach dem Test etwas rückgängig gemacht werden, verwenden Sie ''yield'' statt ''return''. Der Code nach ''yield'' läuft nach dem Test, auch wenn der Test fehlgeschlagen ist.
  
-==== Flask-APP als Fixture ==== 
 <code python> <code python>
-@pytest.fixture()+@pytest.fixture
 def app(): def app():
 +    shutil.copy('./files/books.bak.json', './files/books.json')   # Vorbereiten: Testdaten herstellen
     app = create_app()     app = create_app()
-    shutil.copy('./files/books.bak.json', './files/books.json') +    app.testing = True 
-    yield app+    yield app                                                     # Hier läuft der Test 
 +    shutil.copy('./files/books.bak.json', './files/books.json')   # Aufräumen: Originaldaten zurück
  
  
-@pytest.fixture()+@pytest.fixture
 def client(app): def client(app):
-    app.testing = True 
     return app.test_client()     return app.test_client()
 +</code>
  
 +Dieses Beispiel stammt aus einer Flask-Applikation: Vor jedem Test wird die Datei ''books.json'' aus einer Sicherung wiederhergestellt, damit jeder Test mit denselben Büchern beginnt.
  
-@pytest.fixture() +===== Gemeinsame Fixtures in conftest.py ===== 
-def runner(app): +Brauchen mehrere Testdateien dieselbe Fixture, legen Sie sie in die Datei ''conftest.py'' im Projektordner. PyTest lädt diese Datei automatisch. Ein ''import'' ist nicht nötig. 
-    return app.test_cli_runner() + 
-    +<code python> 
 +# conftest.py 
 +import pytest 
 +from library import Library 
 + 
 + 
 +@pytest.fixture 
 +def library(): 
 +    return Library()
 </code> </code>
 +
 +===== Testdaten aus einer Datei lesen =====
 +Eine Fixture kann Testdaten aus einer Datei laden. Fehlt die Datei, soll der Test mit einer verständlichen Meldung abbrechen:
 +
 +<code python>
 +import json
 +import pytest
 +
 +
 +@pytest.fixture
 +def test_values():
 +    try:
 +        with open('./testdata.json', encoding='utf-8') as json_file:
 +            return json.load(json_file)
 +    except FileNotFoundError:
 +        pytest.fail('Die Datei "testdata.json" fehlt. Kontaktieren Sie Ihre Lehrperson.')
 +</code>
 +
 +Mehr zu Testdaten erfahren Sie in [[modul:m450:learningunits:lu12:start|LU12]].
 +
 +===== Eingebaute Fixtures =====
 +PyTest bringt viele Fixtures mit. Diese kennen Sie bereits aus [[modul:m450:learningunits:lu03:inputoutput|LU03c]]:
 +
 +^ Fixture        ^ Zweck                                                                   ^
 +| ''capsys''     | Ausgaben im Terminal (''print'') abfangen und prüfen                    |
 +| ''monkeypatch''| Funktionen, Attribute, Dictionary-Einträge und Umgebungsvariablen während des Tests ersetzen ([[.:monkeypatch|LU04b]]) |
 +| ''tmp_path''   | Einen leeren, temporären Ordner für Dateien bereitstellen               |
 +
 +Eine vollständige Liste zeigt der Befehl ''pytest --fixtures''.
 +
 +===== Kontrollfragen =====
 +  - Was ist der Unterschied zwischen ''return'' und ''yield'' in einer Fixture?
 +  - Fünf Testdateien brauchen dasselbe ''Library''-Objekt. Wo definieren Sie die Fixture?
 +  - Ein Test meldet ''fixture 'self' not found''. Was ist falsch?
 +  - Warum erzeugt eine Fixture für jeden Test ein neues Objekt, statt ein Objekt für alle Tests zu teilen?
 +
 +===== Weiterführende Links =====
 +  * [[https://docs.pytest.org/en/stable/how-to/fixtures.html|PyTest: How to use fixtures]]
 +
 ---- ----
-{{tag>M450-LU04}}+{{tag>M450-LU04 M450-C1A}}
 [[https://creativecommons.org/licenses/by-nc-sa/4.0/|{{https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png}}]] Marcel Suter [[https://creativecommons.org/licenses/by-nc-sa/4.0/|{{https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png}}]] Marcel Suter
 +
  • modul/m450/learningunits/lu04/fixture.txt
  • Zuletzt geändert: 2026/11/17 08:02
  • von admin