add-unit-tests

Guide for adding unit tests to AReaL. Use when user wants to add tests for new functionality or increase test coverage.

1. Zidentyfikuj, kiedy potrzebujesz tego skilla: gdy chcesz dodać testy do nowej funkcjonalności, zwiększyć pokrycie testami lub zrozumieć wzorce testowania w AReaL. Skill jest automatycznie wyzwalany, gdy zapytasz "jak dodać testy?" lub sformułujesz podobne pytanie.

2. Zapoznaj się z dwoma typami testów dostępnymi w projekcie. Testy jednostkowe testują poszczególne funkcje i moduły, znajdują się w ścieżce tests/test_<moduł>_<funkcja>.py i uruchamiają się bezpośrednio przez pytest. Testy rozproszone testują zachowanie równoległe, znajdują się w tests/torchrun/run_*.py i są wywoływane przez torchrun, ale wciąż uruchamiane z poziomu pytest.

3. Utwórz plik testowy z prawidłową konwencją nazewnictwa: test_<moduł>_<funkcja>.py. Zaimportuj moduł, który chcesz testować (np. from areal.dataset.gsm8k import get_gsm8k_sft_dataset), oraz opcjonalne narzędzia testowe z tests.utils.

4. Napisz funkcje testowe, stosując wzór Arrange-Act-Assert. W sekcji Arrange przygotuj dane wejściowe i oczekiwany wynik. W sekcji Act wykonaj testowaną funkcję. W sekcji Assert porównaj rzeczywisty wynik z oczekiwanym.

5. Uruchom testy za pomocą pytest, aby sprawdzić, czy działają poprawnie. Dla testów rozproszonych pytest automatycznie wywoła torchrun w tle.