rust-tests-guidelines

Zbiór wytycznych ułatwiających pisanie testów dla kodu Rust. Dowiesz się, jak testować publiczne API, kiedy sięgać po prywatne interfejsy, oraz jak organizować testy w strukturze projektu. Skill zawiera rekomendacje dotyczące użycia narzędzi takich jak insta do testowania trudno przewidywalnych wyników oraz proptest do testów opartych na właściwościach. Poznasz też zasady pisania kodu testowego na tym samym poziomie staranności co kod produkcyjny.

1. Zapoznaj się z podstawową zasadą: testuj publiczne API kodu, który testujesz. Prywatne interfejsy testuj tylko wtedy, gdy komponent jest złożony i trudny do przetestowania przez publiczne API.
2. Wybierz odpowiednie narzędzie — użyj insta gdy testujesz wyniki trudne do przewidzenia lub porównania, a proptest do testów opartych na właściwościach dla kluczowych niezmienników.
3. Organizuj testy w katalogu tests odpowiedniej skrzyni (crate), jeśli nie polegają na prywatnych API. Struktura powinna być skrzynią z plikiem main.rs i testami w modułach.
4. Jeśli test musi odwoływać się do prywatnych API, umieść go obok testowanego kodu, używając modułu #[cfg(test)].
5. Pisz kod testowy z taką samą starannością co kod produkcyjny — unikaj niepotrzebnego powielania, wprowadzaj helpery do redukcji boilerplate'u i zapewniaj czytelność.
6. Nie odwołuj się do dokładnych numerów linii w komentarzach, ponieważ mogą się zmieniać w czasie.