====== LU04c - Test überspringen ======
**Auf einen Blick**\\
Manchmal soll ein Test bewusst nicht laufen: weil die Funktion noch nicht fertig ist oder weil der Test nur auf einem bestimmten Betriebssystem Sinn ergibt.
Mit ''skip'' und ''skipif'' überspringt PyTest solche Tests und meldet sie in der Zusammenfassung mit ''s''.
===== Lernziele =====
Sie können
* einen Test mit ''@pytest.mark.skip'' immer überspringen,
* einen Test mit ''@pytest.mark.skipif'' abhängig von einer Bedingung überspringen,
* ''pytest.skip()'' innerhalb eines Tests einsetzen,
* begründen, wann ''skip'' und wann ''xfail'' ([[.:xfail|LU04d]]) die bessere Wahl ist.
===== Warum Tests überspringen? =====
Mit ''pytest'' werden alle Tests eines Projekts ausgeführt. Es gibt aber gute Gründe, einzelne Tests auszulassen:
* Die Funktion ist noch nicht programmiert. Der Test würde ständig fehlschlagen, obwohl wir das schon wissen.
* Der Test ist nur unter Windows sinnvoll und kann unter macOS oder Linux gar nicht laufen.
* Der Test braucht ein Paket oder eine Python-Version, die nicht überall vorhanden ist.
===== @pytest.mark.skip =====
Dieser Dekorator überspringt den Test in jedem Fall. Mit ''reason'' geben Sie eine Begründung an.
import pytest
@pytest.mark.skip
def test_foo():
...
@pytest.mark.skip(reason='Funktion noch nicht fertig')
def test_bar():
...
===== @pytest.mark.skipif =====
Hier geben Sie eine Bedingung an. Ist sie erfüllt, wird der Test übersprungen.
import sys
import pytest
@pytest.mark.skipif(sys.version_info < (3, 10), reason='benötigt Python 3.10 oder neuer')
def test_match_statement():
...
@pytest.mark.skipif(sys.platform == 'win32', reason='nur unter macOS und Linux')
def test_file_permissions():
...
===== pytest.skip() innerhalb des Tests =====
Manchmal zeigt sich erst während der Vorbereitung, dass ein Test nicht sinnvoll laufen kann, zum Beispiel weil Testdaten fehlen. Dann rufen Sie ''pytest.skip()'' im Test auf. Die weiteren Anweisungen werden nicht mehr ausgeführt.
import pytest
def test_energy_price(test_values):
if 'energy_price' not in test_values:
pytest.skip('In "testdata.json" fehlt der Wert "energy_price".')
assert float(test_values['energy_price']) > 0
Diese Variante eignet sich auch für Bedingungen, die zu kompliziert für ''skipif'' sind.
===== Übersprungene Tests in der Ausgabe =====
Übersprungene Tests erscheinen als ''s''. Mit der Option ''-rs'' zeigt PyTest am Schluss auch die Begründung:
$ pytest -rs
test_main.py s.. [100%]
=========================== short test summary info ============================
SKIPPED [1] test_main.py:4: Funktion noch nicht fertig
========================= 2 passed, 1 skipped in 0.02s =========================
Ein übersprungener Test prüft nichts. Vergessen Sie ''skip'' nicht in einem fertigen Projekt. Für Tests von Code, der noch nicht fertig ist, ist ''xfail'' meist die bessere Wahl: PyTest meldet dann, sobald der Code funktioniert (siehe [[.:xfail|LU04d]]).
===== Kontrollfragen =====
- Was ist der Unterschied zwischen ''@pytest.mark.skip'' und ''@pytest.mark.skipif''?
- Schreiben Sie den Dekorator für einen Test, der nur unter Windows laufen soll.
- Wann verwenden Sie ''pytest.skip()'' innerhalb der Testfunktion statt eines Dekorators?
- Warum ist ein übersprungener Test in einem abgeschlossenen Projekt ein Warnsignal?
===== Weiterführende Links =====
* [[https://docs.pytest.org/en/stable/how-to/skipping.html|PyTest: How to use skip and xfail]]
----
{{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