Ten samouczek jest wprowadzeniem do testowania API przy użyciu Karate Framework. Dowiedz się o strukturze skryptu testowego Karate i krokach tworzenia pierwszego skryptu testowego:
API to akronim oznaczający Application Programming Interface (interfejs programowania aplikacji), który w uproszczeniu można zdefiniować jako oprogramowanie pośredniczące umożliwiające komunikację między aplikacjami.
Potrzebujemy testów API, ponieważ:
- Wyniki są publikowane szybciej, dzięki czemu nie trzeba już czekać, aby sprawdzić, czy interfejs API działa prawidłowo.
- Dzięki szybszej reakcji, wdrażanie tych interfejsów API również staje się szybsze, co pozwala na szybki czas realizacji.
- Wczesne wykrywanie awarii, jeszcze przed utworzeniem interfejsu użytkownika aplikacji, pozwala nam ograniczyć ryzyko i naprawić błędy.
- Dostawa na dużą skalę możliwa w krótszym czasie.
Aby móc pracować nad testowaniem API, mamy różne narzędzia dostępne na rynku, takie jak Postman, Mocha i Chai. Wykazały one dobre wyniki i skuteczne wykorzystanie do testowania interfejsów API, jednak są one w dużym stopniu zależne od kodu. Aby móc z nich korzystać, trzeba być technicznie sprawnym i znać języki programowania.
Karate Framework pięknie rozwiązuje ten problem swoich poprzednich narzędzi programistycznych.
Czym jest Karate Framework
Karate? Porozmawiajmy o Karate. Czy to ten z Japonii? Jak myślisz? Możliwe, że wielki Bruce Lee opracował to w wolnym czasie.
Chociaż chcielibyśmy zagłębić się w interesujące korzenie Karate, na razie porozmawiajmy o Narzędzie karate który został opracowany przez Peter Thomas jedno z najlepszych narzędzi, które przychodzi na ratunek testerom API.
Framework Karate wykorzystuje styl pisania programu Cucumber, który jest zgodny z podejściem BDD. Składnia jest łatwa do zrozumienia dla nie-programistów. Framework ten jest jedynym narzędziem do testowania API, które połączyło automatyzację API i testowanie wydajności w jednym samodzielnym narzędziu.
Zapewnia użytkownikom możliwość wykonywania przypadków testowych równolegle i przeprowadzania kontroli JSON & XML.
Dzięki tym informacjom można wydedukować pewne kluczowe punkty, aby lepiej zrozumieć narzędzie Karate:
- Karate to framework do testowania BDD zamiast TDD.
- Została ona zaprojektowana z myślą o osobach niebędących programistami. Ta funkcja zmienia zasady gry, ponieważ umożliwia korzystanie z niej i dostęp do niej wielu osobom, niezależnie od ich zaplecza technicznego lub możliwości.
- Wykorzystuje on plik funkcji Cucumber i język Gherkins do napisania testu, który jest bardzo łatwy do zrozumienia.
Wszystkie te funkcje sprawiają, że jest to jedno z najbardziej korzystnych narzędzi do automatyzacji dostępnych obecnie na rynku.
Historia ram karate
Utworzony przez ' Peter Thomas' Oprogramowanie to zostało napisane w języku Java i większość ludzi spodziewała się, że jego pliki również będą w tym samym języku, jednak na szczęście tak nie jest.
Raczej używa plików Gherkins, co jest wynikiem jego związku z frameworkiem Cucumber. Oprogramowanie do automatyzacji jest rozszerzeniem Cucumber, dlatego dziedziczy użycie pliku Gherkins w swoim działaniu. Duża różnica między nimi polega na tym, że Karate nie używa Javy podczas testowania, ale Cucumber to robi.
Z tego właśnie powodu jest on przeznaczony dla osób niebędących programistami, ponieważ składnia Gherkins jest bardzo czytelna i wszechstronna. Z tego właśnie powodu Karate jest najbardziej odpowiedni i zalecany do wejścia w świat zautomatyzowanych testów API.
Poniżej przedstawiono niektóre funkcje Karate Testing Framework:
- Wykorzystuje łatwy do zrozumienia język Gherkins.
- Nie wymaga technicznej wiedzy programistycznej, takiej jak Java.
- Jest on oparty na popularnych standardach Cucumber.
- Łatwe tworzenie ram.
- Testowanie równoległe jest podstawową funkcjonalnością dostarczaną przez samo Karate, dlatego nie musimy polegać na Maven, Gradle itd.
- Interfejs użytkownika do debugowania testu.
- Wywołanie pliku funkcji z innego pliku.
- Zapewnia wsparcie dla testowania sterowników danych, które są tworzone wewnętrznie, dzięki czemu nie trzeba polegać na zewnętrznych frameworkach.
- Wbudowane natywne raporty Rest. Dodatkowo można je zintegrować z Cucumber, aby uzyskać lepsze raporty UI i większą przejrzystość.
- Zapewnia wewnętrzne wsparcie w zakresie przełączania konfiguracji w różnych środowiskach testowych (QA, Stage, Prod, Pre-Prod).
- Płynna obsługa integracji CI/CD, która może być przydatna.
- Zdolny do obsługi różnych połączeń HTTP:
- Obsługa Web Socket
- Żądanie SOAP
- HTTP
- Obsługa plików cookie przeglądarki
- HTTPS
- Dane formularza HTML
- Żądanie XML
Porównanie Karate i Rest-Assured
Rest Assured Jest to biblioteka oparta na Javie do testowania usług REST. Wykorzystuje język Java do pisania linii kodu. Pomaga w testowaniu wielu kategorii żądań, co dodatkowo skutkuje weryfikacją różnych kombinacji logiki biznesowej.
Karate Framework Narzędzie oparte na Cucumber/Gherkins, używane do testowania usług SOAP i REST.
Poniższa tabela zawiera kilka bardziej znaczących różnic między Rest-Assured & Karate Framework:
| S.No | Podstawa | Karate Framework | REST-Assured |
|---|---|---|---|
| 1 | Język | Wykorzystuje połączenie ogórka i korniszonów | Wykorzystuje on język Java |
| 2 | Kod Rozmiar | Zwykle linia kodu jest mniejsza, ponieważ ma strukturę podobną do Cucumbera | Linia kodu jest większa, ponieważ wymaga użycia języka Java |
| 3 | Wymagana wiedza techniczna | Osoby niebędące programistami mogą z łatwością napisać kod Gherkins | Do pisania kodu Java wymagana jest wiedza techniczna |
| 4 | Testowanie oparte na danych | Konieczność korzystania z TestNG lub jego odpowiednika do obsługi tego samego | Wewnętrzne znaczniki mogą być używane do testowania danych |
| 5 | Czy zapewnia obsługę połączeń SOAP? | Tak, zapewnia | Jest to związane tylko z żądaniem REST |
| 6 | Testowanie równoległe | Tak, równoległe testowanie jest również łatwo obsługiwane dzięki równoległemu generowaniu raportów | Chociaż ludzie próbowali to robić, odsetek niepowodzeń jest wyższy niż odsetek sukcesów |
| 7 | Raportowanie | Zapewnia wewnętrzne raportowanie, dlatego nie musi być zależny od zewnętrznych wtyczek. Możemy nawet zintegrować go z wtyczką raportowania Cucumber, aby uzyskać lepszy interfejs użytkownika. | Muszą być zależne od zewnętrznych wtyczek, takich jak Junit, TestNG. |
| 8 | Obsługa CSV dla danych zewnętrznych | Tak, od wersji Karate 0.9.0 | Nie, należy użyć kodu Java lub biblioteki |
| 9 | Automatyzacja interfejsu użytkownika | Tak, od wersji Karate 0.9.5 automatyzacja Web-UI jest możliwa | Nie, nie jest obsługiwany |
| 10 | Przykładowy GET | Given param val1 = 'name1' | given(). |
Dlatego, jak pokazują powyższe różnice, można śmiało powiedzieć, że Karate jest jedną z najłatwiejszych rzeczy, które każdy może zrobić.
Narzędzia wymagane do pracy z Karate Framework
Teraz, skoro mamy już podstawową wiedzę na temat Karate Framework, przyjrzyjmy się procesom i narzędziom wymaganym do skonfigurowania środowiska Karate.
#1) Zaćmienie
Eclipse to zintegrowane środowisko programistyczne używane w dziedzinie programowania komputerowego. Jest ono najczęściej używane do programowania w języku Java. Jak wspomniano wcześniej, Karate jest napisane w Javie, więc ma to większy sens, dlaczego Eclipse jest IDE dla oprogramowania do testowania API. Innym powodem jest to, że jest to narzędzie typu open source, a to jest dość mocny powód, aby zdecydować się na to narzędzie.
Uwaga: Możemy nawet użyć IntelliJ, Visual Studio i innych edytorów dostępnych na rynku.
#2) Maven
Jest to narzędzie do automatyzacji kompilacji używane głównie do budowania projektów Java. Jest to jeden ze sposobów konfigurowania środowiska Karate i pisania kodu. Aby skonfigurować Eclipse z wymaganiami Maven, możesz kliknąć tutaj, aby zainstalować Maven.
Pracując w Maven, używaj zależności Maven, które pomogą ci wspierać Karate Framework.
Następujące zależności będą używane z Mavenem w pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Uwaga: Najnowsze wersje mogą być dostępne w repozytorium Maven.
#3) Gradle
Gradle jest alternatywą dla Mavena i może być używany w równym stopniu. Mają swoje podobieństwa i różnice, ale mogą być równie dobrze wykorzystywane do konfigurowania środowiska dla naszych kodów Karate.
Jest łatwiejszy w użyciu, elastyczny i zalecany do użycia, gdy nasza aplikacja ma pewne wymagania dotyczące modularyzacji i zarządzania z wieloma wtyczkami. Kod konfiguracji Gradle wyglądałby mniej więcej tak,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Uwaga: Można użyć MAVEN lub GRADLE.
#4) Konfiguracja środowiska Java w systemie
Aby rozpocząć pracę ze skryptami Karate Framework, należy skonfigurować środowisko JDK i JRE.
Struktura skryptu testu karate
Skrypt testowy Karate jest znany z posiadania rozszerzenia ".feature". Ta właściwość jest dziedziczona z Cucumber. Organizacja plików w konwencji Java jest również dozwolona. Możesz dowolnie organizować swoje pliki zgodnie z konwencjami pakietów Java.
Jednakże, wytyczne Maven nakazują, aby pliki nie-Java były przechowywane oddzielnie. Są one przechowywane w folderze src/test/resources A pliki Java są przechowywane pod src/main/java .
Jednak według twórców Karate Framework, zdecydowanie uważają oni, że powinniśmy przechowywać obok siebie zarówno pliki Java, jak i nie-Java. Według nich, znacznie łatwiej jest szukać plików *.java i *.feature, gdy są one przechowywane razem, zamiast podążać za standardową strukturą Maven.
Można to łatwo zrobić, modyfikując plik pom.xml w następujący sposób (dla Maven):
src/test/java **/*.java ...
Poniżej znajduje się zarys ogólnej struktury Karate Framework:
Teraz, ponieważ ten Karate Framework używa pliku Runner, który jest również potrzebny w Cucumber do uruchamiania plików funkcji, więc większość pisania będzie zgodna ze standardami Cucumber.
Ale w przeciwieństwie do Cucumbera, kroki nie wymagają jasnej definicji w Karate, co z kolei zwiększa elastyczność i łatwość operacji. Nie musimy dodawać dodatkowego kleju, który zwykle musimy dodawać, gdy podążamy za frameworkiem Cucumber.
Klasa "Runner" przez większość czasu nosi nazwę TestRunner.java.
Następnie plik TestRunner.java przyjmie postać:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } I mówienie o .feature zawiera wszystkie scenariusze testowe, które należy przetestować, aby upewnić się, że interfejs API działa zgodnie z oczekiwanymi wymaganiami.
Ogólny plik *.feature wygląda tak, jak pokazano poniżej:
Funkcja: pobieranie danych użytkownika Scenariusz: testowanie wywołania get dla danych użytkownika Podany adres url '//reqres.in/api/users/2' Gdy metoda GET Następnie status 200
Tworzenie pierwszego podstawowego skryptu testowego Karate
Ta sekcja pomoże ci rozpocząć tworzenie pierwszego skryptu testowego, który będzie pomocny przy konwersji API w formie frameworka Karate.
Zanim napiszemy podstawowe skrypty testowe Karate, zainstaluj na swoim komputerze następujące wymagania:
- Eclipse IDE
- Maven Ustaw odpowiednią ścieżkę Maven.
- JDK & JRE. Ustaw odpowiednią ścieżkę.
Przyjrzyjmy się podejściu krok po kroku:
#1) Utwórz nowy MAVEN Projekt w edytorze Eclipse
- Open Eclipse
- Kliknij File (Plik) i wybierz New Project (Nowy projekt).
- Wybierz projekt Maven
- Wybierz lokalizację obszaru roboczego.
- Wybierz Archetyp (zazwyczaj wybieramy " Maven-archetype-quickstart 1.1 " dla prostych projektów Maven).
- Podaj identyfikator grupy & identyfikator artefaktu (w naszym przykładzie użyliśmy następujących wartości).
- Identyfikator grupy Karate
- Identyfikator artefaktu: KarateTestScriptsSample
- Kliknij przycisk Zakończ, aby zakończyć konfigurację.
#2) Po utworzeniu, w oknie Project Explorer widoczna będzie następująca struktura.
#3) Uwzględnij wszystkie zależności.
Naszym pierwszym krokiem, po zakończeniu konfiguracji, będzie zawiera wszystkie zależności Będziemy przechowywać wszystkie znaczniki w POM.xml (zakładając, że jesteś już świadomy użycia POM.xml).
- Otwórz POM.xml i skopiuj poniższy kod pod tagiem zależności i zapisz plik.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Kliknij tutaj, aby zobaczyć źródło.
#4) Przeprowadźmy burzę mózgów, co będziemy testować w tym podstawowym skrypcie testowym Karate.
Scenariusz:
Będziemy testować API z tym adresem URL.
Ścieżka: api/users/2
Metoda: GET
I musimy to zweryfikować czy żądanie zwraca wartość Kod sukcesu (200) czy nie.
Mówiąc prościej, zamierzamy po prostu przetestować przykładowy interfejs API, aby sprawdzić, czy jest on pomyślnie wykonywany.
Uwaga: Bierzemy przykładowe API, które jest dostępne do testowania. Możesz wybrać dowolną PATH lub odnieść się do swojego API.
Kliknij tutaj, aby zobaczyć źródło.
#5) Następnym krokiem będzie utworzenie pliku .feature plik.
Jak omówiono w sekcji wprowadzającej, plik .feature to właściwość, która została odziedziczona po Cucumber. W tym pliku wypiszemy scenariusze testowe, które należy wykonać w celu przeprowadzenia testów API.
- Przejdź do folderu src/test/java w projekcie.
- Kliknij go prawym przyciskiem myszy i utwórz nowy plik - userDetails.feature. Następnie kliknij przycisk Zakończ.
Teraz w folderze pojawi się następujący plik src/test/java
The Ikona w kolorze zielonym przypomina .feature fi le w Cucumber, który właśnie stworzyliśmy.
- Po utworzeniu pliku napiszemy nasze scenariusze testowe, które zostaną omówione w następnej sekcji.
#6) Ponieważ mamy scenariusz i puste miejsce. cecha plik gotowy, teraz zacznijmy nasz pierwszy skrypt. Zacznijmy kodować
Napisz następującą linię kodu w pliku userDetails.feature, który utworzyliśmy w kroku #5:
Funkcja: pobieranie danych użytkownika Scenariusz: testowanie wywołania get dla danych użytkownika Podany adres url '//reqres.in/api/users/2' Gdy metoda GET Następnie status 200
Spróbujmy zrozumieć komponenty zapisane w powyższym pliku:
- Funkcja: Słowo kluczowe wyjaśnia nazwę funkcji, którą testujemy.
- Kontekst: Jest to opcjonalna sekcja, która jest traktowana jako sekcja wymagań wstępnych. Można jej użyć do zdefiniowania wszystkiego, co jest potrzebne do przetestowania interfejsu API. Zawiera ona HEADER, URL & PARAM opcje.
- Scenariusz: Każdy plik funkcji, który zobaczysz, będzie zawierał co najmniej jedną funkcję (chociaż może to dać wielokrotność Jest to opis przypadku testowego.
- Biorąc pod uwagę: Jest to krok, który musi zostać wykonany przed wykonaniem jakiegokolwiek innego kroku testowego. Jest to obowiązkowa czynność do wykonania.
- Kiedy: Określa warunek, który powinien być spełniony, aby wykonać następny krok testu.
- Następnie: Mówi nam, co powinno się stać w przypadku, gdy warunek wymieniony w Kiedy jest spełniony.
Uwaga: Wszystkie wyżej wymienione słowa kluczowe pochodzą z języka Gherkins i są standardowym sposobem pisania skryptów testowych przy użyciu Cucumbera.
Inne słowa użyte w pliku funkcji to:
- 200: Jest to kod statusu/odpowiedzi, którego oczekujemy (kliknij tutaj, aby zobaczyć listę kodów statusu).
- GET: Jest to metoda API, taka jak POST, PUT itp.
Mamy nadzieję, że to wyjaśnienie było dla Ciebie łatwe do zrozumienia. Teraz będziesz w stanie odnieść się do tego, co dokładnie jest napisane w powyższym pliku.
Teraz musimy utworzyć plik TestRunner.java
Jak wyjaśniono w powyższej sekcji, Cucumber potrzebuje pliku Runner, który byłby wymagany do wykonania .feature który zawiera scenariusze testowe.
- Przejdź do folderu src/test/java w projekcie
- Kliknij go prawym przyciskiem myszy i utwórz nowy plik Java: TestRunner.java
- Po utworzeniu pliku, umieść pod nim następujące linie kodu:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner to plik, który zostanie teraz uruchomiony w celu wykonania żądanego scenariusza zapisanego w kroku #5.
#7) Teraz jesteśmy gotowi z obydwoma plikami TestRunner.Java oraz userDeatils.feature. Jedyne zadanie, jakie nam pozostało, to Bieg scenariusz.
- Przejdź do pliku TestRunner.java i kliknij go prawym przyciskiem myszy, jak pokazano na poniższym obrazku.
- Wybierz Run As -> Junit Test
- Teraz, po wybraniu, zaczniesz obserwować, że przypadek testowy został uruchomiony.
- Poczekaj na wykonanie skryptu testowego, a w oknie zobaczysz coś takiego, jak pokazano na poniższym obrazku.
- Wreszcie możemy powiedzieć, że z powodzeniem stworzyliśmy naszą pierwszą podstawową aplikację Skrypt testowy przy użyciu Karate Framework.
#8) Wreszcie, framework Karate zapewnia również prezentację raportu HTML dla wykonanej egzekucji.
- Przejdź do folderu docelowego -> surefire-reports-> Tutaj zobaczysz raport HTML, który możesz otworzyć.
** Sugerujemy również otwarcie tego samego za pomocą przeglądarki Chrome, aby uzyskać lepszy wygląd i działanie.
- Zostanie wyświetlony następujący raport HTML przedstawiający Scenariusze i testy który został wykonany dla wspomnianego scenariusza:
Wnioski
W tym poradniku omówiliśmy testowanie API, różne narzędzia testowe dostępne na rynku oraz to, w jaki sposób Karate Framework jest lepszą opcją w porównaniu do swoich odpowiedników.
Aby stworzyć nasz pierwszy podstawowy skrypt testowy, zastosowaliśmy podejście krok po kroku. Zaczęliśmy od stworzenia podstawowego skryptu testowego. Projekt Maven w Eclipse IDE aby utworzyć plik .feature, który zawiera cały scenariusz testowy i plik Runner do wykonania przypadku testowego wymienionego w pliku .feature.
Pod koniec wielu kroków mogliśmy zobaczyć raport z wykonania wyników testu.
Mamy nadzieję, że ten samouczek był pomocny dla początkujących w nauce tworzenia pierwszego skryptu testowego przy użyciu Karate Framework i przeprowadzania testów API. To szczegółowe podejście krok po kroku jest doskonałym sposobem na uruchamianie i wykonywanie różnych testów API.
NEXT>>