ShopHelper – Unit testy

Poprzedni wpis na temat projektu ShopHelper: lokalna lista zakupów

No i przyszedł czas na testy jednostkowe. Być może trochę późno powiedzą fani TDD 🙂 Ogólnie dodając pierwsze komponenty starałem się mieć gdzieś z tyłu głowy, że będę testy pisał ale jak to bywa nie wszystko się odrazu wie… Ten wpis będzie tak naprawdę o dostosowaniu projektu do testów jednostowych i małym refactorze, który musiałem zrobić aby móc testować 🙂

Pierwszy być może mały błąd popełniłem decydując się na SharedProject zamiast Portable class library. Dlaczego?

Rozwiązaniu typu SharedProject kompiluje się razem z binarką, do której został dołączony, oznacza to, że tak naprawdę nasz kod nie kompiluje się do samodzielnej biblioteki. Wyjścia są dwa, a może i nawet trzy. Pierwsze dodać po projekcie do każdej platformy czyli Android.Tests, UWP.Tests, iOS .Tests – masakra. Drugie dodać sztuczną bibliotekę typu portable, do której dołączymy nasz SharedProject, następnie tą bibliotekę podłączymy do naszego projektu z testami. Trochę sztuka dla sztuki ale powinno się udać. Zdecydowałem się na trzecie rozwiązanie – zwykłe klasyczne windowsowe class library (oczywiście jeśli ktoś programuje na Mac-u to rozwiązanie odpada). Problem jaki wynika z tego rozwiązanio to tak naprawdę to, że nasz kod musi obsługiwać tak naprawdę platformę Windows Desktop…  Spowodowało to konieczność wydzielenia poszczególnych implementacji komponentów specyficznych dla danej platformy, jak np. ścieżki do plików. Zaimplementowałem to tak, że we wspólnym kodzie dodałem interfejs IFileService (wcześniej korzystałem ze statycznego Utils-a). W natywnych projektach dla każdej z platform dodałem po klasie implementującej ten interfejs (również do projektu z testami).

Przykład dla Androida:

Kolejny typowy problem, który się pojawił to, że nie wstrzykiwałem zależności do komponentów oraz nie korzystałem z interfejsów co utrudnia Mockowie. Jak napisać test sprawdzający czy wywołano metodę Show, która ma pokazać komponent listy?

Raczej się nie da, pomijając już, że metoda jest prywatna ale taka miała być ponieważ jest podpięta to Command, więc test planowałem wykonać porzez Command.Execute(null). Jednak to się też nie uda ponieważ nie wstrzykuję ani Command ani ViewModel-u, który trzyma Command… Zrobiłem refactor tego komponentu no i udało się osiągnąć zamierzony efekt 🙂

Kod jest prosty, a zarazem napisanie testu sprawdzającego czy komenda ShowShoppingListCommand otwiera komponent ShoppingList to formalność.

Do obsługi testów skorzystałem z Framework-a NUnit oraz Moq. Natomiast sam test jest napisany zgodnie ze wzorcem Arrange-Act-Assert co pozwola na czytelne formatowanie kodu testów. W sekcji arrange umieściłem kod odpowiedzialny za stworzenie obiektów potrzebnych do przeprowadzenia testu. Sekcja Act to tylko wywołanie testowanego polecenia. Assert sprawdza czy na Mock-u wykonano dokładnie raz metodę Show. Jak pewnie zauważyłeś testy wymusiły na mnie dodanie interfejsów również dla widoków, dzięki czemu w testach nie korzystam z prawdziwych widoków tylko mockuje interfejs, dzięki czemu testy są zupełnie odseparowane od warstwy prezentacji.

Na koniec tego wpisu jeszcze inny przykład testu:

Test ma za zadanie sprawdzić czy polecenie AddShoppingListItem wykonuje dodanie elementu do usługi przechowującej dane oraz czy element jest dodawany do listy bindowanej do widoku. Na koniec czy wartość NewShoppingListItemValue jest czyszczona. Przy okazji zacząłem się zastanawiać czy nie zacząć utrzymywać kolekcji ObservableCollection, która jest bindowana do widoku tylko w serwisie.

Właśnie na tym polega magia testów jednostkowych, testy nie tylko pomagają znaleźć błędy ale jeśli zastosujemy technikę TDD to pomagają pisać lepszy kod! Warto już na początku projektu zacząć pisać testy, dzięki temu unikniemy późniejszych bolesnych zmian. Oczywiście refator to powinna być nieodłączna czynność w TDD ale warto już na starcie przygotować nasz projekt tak aby był łatwo testowalny:

  • zapewnić odpowiednią abstrakcję poprzez interfejsy tam gdzie będziemy chcieli skorzystać z Mocków
  • generalnie nie twórzmy samodzielnie zależności tylko wstrzykujmy je z zewnątrz, np. poprzez konstruktor jako abstrakcję
  • jak najmniej starajmy się korzystać ze statycznych Utilsów, Helpersów itp. ponieważ zmockowanie takiej metody jest bardzo trudne, nawet zamiast DateTime.Now zalecałbym jakiś interfejs albo własny obiekt, który na potrzeby testu można podmienić

To chyba na dziś wszystko, zapraszam do komentowania 🙂 Pełny kod znajdziesz na GitHubie.

Dodaj komentarz