Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung | |||
| modul:m450:learningunits:lu04:fixture [2025/03/27 09:14] – kmaurizi | modul: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, | + | Eine **Fixture** (deutsch: Vorrichtung, |
| - | Sie bieten | + | In PyTest ist eine Fixture eine Funktion mit dem Dekorator '' |
| + | So haben alle Tests die gleiche, wiederholbare | ||
| </ | </ | ||
| - | ===== Was sind Fixtures? | + | ===== Lernziele |
| + | Sie können | ||
| + | * eigene Fixtures definieren und in Tests verwenden, | ||
| + | * Fixtures kombinieren und mit '' | ||
| + | * gemeinsame Fixtures in '' | ||
| + | * die eingebauten Fixtures '' | ||
| - | Bei der Durchführung von Tests müssen wir sicherstellen, | + | ===== Wozu Fixtures? ===== |
| - | Dazu müssen die Tests immer in der gleichen Umgebung mit den gleichen Daten durchgeführt werden. | + | Ein Test läuft |
| - | 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 |
| - | - Vorbereitung: | + | | **Vorbereiten** | Objekte erzeugen, Dateien oder Datenbanken |
| - | | + | | **Ausführen** | Die zu testende Funktion |
| - | * Daten in Datenbanken oder Dateien bereitstellen | + | | **Auswerten** | IST mit SOLL vergleichen |
| - | * Umgebungsvariablen wie URL, Pfade, ... definieren | + | | **Aufräumen** | Alle Änderungen |
| - | - Ausführen: Wir führen die zu testende Funktion | + | |
| - | | + | |
| - | | + | |
| - | Im engeren Sinne des Wortes sind Fixtures Vorbereitungsschritte für die Durchführung eines Tests. | + | Schreiben Sie die Vorbereitung in jede Testfunktion, |
| - | Wir können aber Fixtures auch etwas weiter fassen. | + | |
| - | Es handelt | + | |
| - | Also sowohl Vorbereitung als auch Ausführung und Aufräumarbeiten. | + | |
| - | ===== Fixtures | + | ===== Eigene |
| - | //Siehe auch [[https:// | + | <code python> |
| + | import | ||
| + | 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 '' | + | def customer_max(): |
| - | Mittels '' | + | |
| - | Zum Bereitstellen von Benutzereingaben, | + | |
| - | 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(' | ||
| - | ===== 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 '' | ||
| - | |||
| - | <code python> | ||
| @pytest.fixture | @pytest.fixture | ||
| - | def customer_max(self): | + | def library(): |
| - | return | + | return |
| - | @pytest.fixture | + | |
| - | def customer_moritz(self): | + | def test_add_customers(library, customer_max, |
| - | return Customer(' | + | |
| - | | + | |
| - | def test_add_customers(self, customer_max, | + | |
| - | 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 |
| </ | </ | ||
| - | In der Testfunktion '' | ||
| - | Pytest stellt selber sicher, dass die entsprechenden Fixtures ausgeführt werden. | ||
| - | === Testdaten aus einer Datei lesen === | + | * PyTest sieht die Parameter '' |
| + | * 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, | ||
| + | </WRAP> | ||
| - | def test_add_entries1(monkeypatch, | + | ==== 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, |
| - | | + | |
| - | with open(' | + | |
| - | data = json.load(json_file) | + | |
| - | return data | + | |
| - | | + | |
| - | print(' | + | |
| - | print(' | + | |
| - | print(' | + | |
| - | raise FileNotFoundError | + | |
| - | @pytest.fixture | + | def test_find_customer(library_with_customers): |
| - | def version(): | + | |
| - | | + | |
| - | | + | |
| - | return | + | |
| - | if isinstance(collection, | + | def test_find_unknown_customer(library_with_customers): |
| - | | + | |
| - | if isinstance(collection, dict): | + | |
| - | return ' | + | |
| - | | + | |
| - | | + | |
| </ | </ | ||
| + | ===== Aufräumen mit yield ===== | ||
| + | Muss nach dem Test etwas rückgängig gemacht werden, verwenden Sie '' | ||
| - | ==== Flask-APP als Fixture ==== | ||
| <code python> | <code python> | ||
| - | @pytest.fixture() | + | @pytest.fixture |
| def app(): | def app(): | ||
| + | shutil.copy(' | ||
| app = create_app() | app = create_app() | ||
| - | shutil.copy(' | + | |
| - | yield app | + | yield app # Hier läuft der Test |
| + | | ||
| - | @pytest.fixture() | + | @pytest.fixture |
| def client(app): | def client(app): | ||
| - | app.testing = True | ||
| return app.test_client() | return app.test_client() | ||
| + | </ | ||
| + | Dieses Beispiel stammt aus einer Flask-Applikation: | ||
| - | @pytest.fixture() | + | ===== Gemeinsame Fixtures in conftest.py ===== |
| - | def runner(app): | + | Brauchen mehrere Testdateien dieselbe Fixture, legen Sie sie in die Datei '' |
| - | return | + | |
| - | | + | <code python> |
| + | # conftest.py | ||
| + | import pytest | ||
| + | from library import Library | ||
| + | |||
| + | |||
| + | @pytest.fixture | ||
| + | def library(): | ||
| + | return | ||
| </ | </ | ||
| + | |||
| + | ===== 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(' | ||
| + | return json.load(json_file) | ||
| + | except FileNotFoundError: | ||
| + | pytest.fail(' | ||
| + | </ | ||
| + | |||
| + | Mehr zu Testdaten erfahren Sie in [[modul: | ||
| + | |||
| + | ===== Eingebaute Fixtures ===== | ||
| + | PyTest bringt viele Fixtures mit. Diese kennen Sie bereits aus [[modul: | ||
| + | |||
| + | ^ Fixture | ||
| + | | '' | ||
| + | | '' | ||
| + | | '' | ||
| + | |||
| + | Eine vollständige Liste zeigt der Befehl '' | ||
| + | |||
| + | ===== Kontrollfragen ===== | ||
| + | - Was ist der Unterschied zwischen '' | ||
| + | - Fünf Testdateien brauchen dasselbe '' | ||
| + | - Ein Test meldet '' | ||
| + | - Warum erzeugt eine Fixture für jeden Test ein neues Objekt, statt ein Objekt für alle Tests zu teilen? | ||
| + | |||
| + | ===== Weiterführende Links ===== | ||
| + | * [[https:// | ||
| + | |||
| ---- | ---- | ||
| - | {{tag> | + | {{tag> |
| [[https:// | [[https:// | ||
| + | |||