Testy selenium w Pythonie

Cześć,
tym razem coś o testowaniu oprogramowania, a dokładniej testowaniu funkcjonalnym, a jeszcze dokładniej o framework’u Selenium.

Testowanie jest ogromnie ważną częścią dostarczania oprogramowania, gdyż jak wiadomo, programiści, nawet Ci najlepsi, nie są nieomylni i często, a nawet bardzo często zdarza się czegoś nie przewidzieć, szczególnie jeśli system jest skomplikowany / słabo napisany / rzadko rozwijany / szybko rozwijany – no ogólnie powodów są setki – dlatego zawsze warto patrzeć na dział QA (quality assurance – dział zapewnienia jakości) jak na mur który nie pozwala by Twoje błędy spowodowały kuku na produkcji :) A poprawiania na szybko nikt nie lubi, szczególnie jak stoi za Tobą jakiś PM :D Więc dzięki im za każdego reopena :)
Dział QA nie ma łatwego zadania – zazwyczaj muszą ogarniać cały projekt, jego założenia biznesowe jak i część techniczną – co wymaga bycia na bieżąco z wszystkim rzeczami które są dodawane / będą dodawane do głównej gałęzi. Poza zapewnieniem że nowe funkcjonalności nie zawierają błędów, należy sprawdzać jak nowy kod oddziałuje ze starym, czyli czy dodając funkcję A nie zepsuliśmy czegoś w miejscu B, C i Z. Takie błędy gdzie nowa funkcja działa, ale psuje poprzednie, nazywamy regresją.
Aby sprawnie wykrywać błędy regresyjne należało by przeklikiwać cały projekt po każdym kliknięciu merge – co jest nie wykonalne nawet jakby dział QA posiadał po 2-3 testerów na jednego programistę. No może zależy to jeszcze od tempa rozrostu projektu – ale nadal – niemożliwe.
No i przychodzą tutaj nam z pomocą testy automatyczne :)

Frameworkiem który może nam pomóc pisać testy automatyczne jest Selenium – pozwala on pisać testy które są odpowiednio odpalane automatycznie na przeglądarkach takich jak Chrome, Firefox itp Dokładniej to wygląda tak że Selenium odpala przeglądarkę i klika za Was, sprawdzając po drodze zostawione asserty i tak, wizualnie to wygląda świetnie jak np. sam formularz się wypełnia!

Testy Selenium można pisać w różnych językach, ja pokaże jak je uruchomić w Pythonie. Pierw należy pobrać webdriver’a – aplikację która pozwala uruchamiać przeglądarkę pod kontrolą Selenium – każda przeglądarka ma swojego webdriver’a. My przejdziemy przez konfigurację dla Chroma.

Pobrać driver’a należy ze strony – link. I zapisać w miejscu który macie w swoim PATHie, np. /usr/local/bin dla Linuxa. Gdy ten krok jest za nami, należy zainstalować paczkę selenium programem pip:

i koniec! Można pisać testy.

W celu pokazania jak używać Selenium przetestujemy mojego bloga ;)

Stwórzmy klasę bazową dla każdego naszego testu:

metody setUp oraz tearDown wykonują się odpowiednio przed i po wykonaniu testów i również odpowiednio – inicjalizują odpowiedniego driver’a oraz go zamykają.
Poza klasą bazową napiszemy plik uruchamiający testy:

Teraz każdą klasę dziedziczącą po TestCase dodamy tutaj importem a biblioteka unittest odpali nam je automatycznie.
Zacznijmy od pierwszego testu – sprawdźmy czy na stronie „O mnie” jest moje zdjęcie ;)

Stwórzmy plik has_new_photo.py z zawartością:

W klasie tej mamy jeden test – klasę traktujemy jako worek dla testów z tej samej kategorii a każda metoda zaczynająca się od przedrostka test_ jest traktowana jako test i będzie odpala przez bibliotekę unittest. Pierwsza linia tej metody to przejście na tego bloga, następnie szukamy linku który wygląda jak „KIM JESTEM?” – szukanie to obwarowujemy blokiem try-except, gdyż nieznalezienie elementu powoduje wyrzucenie wyjątku – i jeśli taki zostanie wyrzucony – oznaczamy test jako FAILED. Jeśli natomiast znajdziemy element „KIM JESTEM?” to klikamy w niego metodą click(). To spowoduje przejście na ową podstronę. Następnie szukamy elementu który ma klasę „wp-image-2215” (taką mojemu zdjęciu nadał WordPress) i również oblewamy ten kawałek blokiem try-except. Jeśli test nie spowoduje wykonania się metody fail(msg) lub nie przejdzie asercji (o czym za chwilkę) lub rzuci inny wyjątek – jest uznawany za zakończony sukcesem.

Uzupełnijmy nasz plik tests.py:

i odpalmy

w konsoli.
Spowoduje to uruchomienie przeglądarki Chrome i wykonanie testu oraz jej zamknięcie. Rezultat będzie w konsoli:

Napiszmy coś więcej, sprawdźmy czy tekst witający pojawia się na stronach statycznych tego bloga jak i na stronach wpisów, stwórzmy plik welcome_message.py z zawartością:

Tutaj mamy dwa testy – i te same myki z blokami try-except. Doszło nowe wyrażenie assertTrue() która sprawdza czy argument przekazany do niego jest wartości True. Mamy tu też metodę prywatną
_convert_into_comparing_format która wycina białe znaki z tekstów – tak zdecydowanie łatwiej się porównuje teksty.

Kolejny plik jaki stworzymy to będzie main_page.py z zawartością:

Te dwa testy sprawdzą czy liczba elementów menu = 4 oraz czy liczba wpisów na stronie głównej jest równa 9. Użyliśmy tutaj find_elements_by_class_name / find_elements_by_tag_name – nie było ich wcześniej a od swoich kolegów (find_element_by_class_name / find_element_by_tag_name) różnią się tym że zwracają listę wszystkich znalezionych elementów a nie pierwszy, szukając od głowy. Natomiast metoda assertEqual sprawdza czy elementy przekazane jako argumenty są sobie równe. Co idealnie pasuje do tej sytuacji. W obu testach porównujemy po prostu długość tablicy zwróconej jako rezultat szukania elementów na stronie z zadaną z góry wartością.

Mała dygresja – asercje w kodzie sprawdzają czy metoda ma sens być wywołana z zadanymi parametrami. W testach natomiast sprawdzają poszczególne kroki testów. Biblioteka unittest dostarcza nam zestaw metod typu właśnie assertEqual.

Kolejny plik jaki stworzymy to będzie contact_form.py:

Test ten sprawdza czy na stronie „KONTAKT” formularz kontakty wyświetli błąd przy próbie podania wadliwego adresu email. Co My mamy tutaj ciekawego… Ah, tak, jeśli chcemy wysłać formularz to mamy do tego metodę submit. Asercję sprawdzamy poprzez sprawdzenie czy do pola gdzie wpisujemy adres email, dodawana jest klasa określająca element jako podany błędnie – takie informacje można wywnioskować analizując zmieniający się kod strony – thanks to google chrome debugger :)

Nasz plik tests.py rozrósł się:

ale nasz wynik się nie zmienił

Jak widać napisanie własnych testów wysoko poziomowych nie musi być zadaniem dla seniora :) w Pythonie można to fajnie i łatwo osiągnąć. Selenium ma ogromne możliwości – po więcej informacji odsyłam do dokumentacji. Pobaw się tym, warto :)

A już całkowicie odchodząc od tematyki wpisu – zapraszam na bloga mojego serdecznego przyjaciela – link. Blog ten jest pisany w języku angielskim, ale przystępnym, nie skomplikowanym językiem, sam target natomiast, troszkę inny, ale odwiedzić na pewno warto :)