Tento tutoriál je úvodom do testovania API pomocou Karate Frameworku. Zoznámte sa so štruktúrou Karate Test Scriptu a krokmi na vytvorenie prvého testovacieho skriptu:
API je skratka, ktorá znamená Application Programming Interface (rozhranie pre programovanie aplikácií). Zjednodušene ho môžeme definovať ako softvérového sprostredkovateľa, ktorý umožňuje komunikáciu medzi aplikáciami.
Testovanie API potrebujeme, pretože:
- Výsledky sa zverejňujú rýchlejšie, takže už nemusíte čakať, či API funguje správne.
- Vďaka rýchlejšej odozve sa zrýchľuje aj nasadenie týchto rozhraní API, čo umožňuje rýchlu realizáciu.
- Včasné odhalenie porúch ešte pred vytvorením používateľského rozhrania aplikácie nám umožňuje zmierniť riziká a odstrániť chyby.
- Možnosť veľkoobjemovej dodávky v kratšom čase.
Na to, aby sme mohli pracovať na testovaní API, máme na trhu k dispozícii rôzne nástroje, ako napríklad Postman, Mocha a Chai. Tieto nástroje preukázali dobré výsledky a efektívne využitie na testovanie API, sú však silne ovplyvnené kódom. Aby ich človek mohol používať, musí byť technicky zdatný a poznať programovacie jazyky.
Karate Framework krásne rieši tento problém svojich predchádzajúcich softvérových nástrojov.
Čo je karate rámec
Karate? Poďme sa baviť o karate. Je to to japonské? Čo myslíte? Možno ho vo voľnom čase vyvinul veľký Bruce Lee.
Aj keď by sme sa chceli venovať zaujímavým koreňom karate, teraz sa poďme venovať Nástroj karate ktorý vyvinula spoločnosť Peter Thomas , jeden zo skvelých nástrojov, ktoré prichádzajú na pomoc testerom API.
Framework Karate sa riadi štýlom písania programu Cucumber, ktorý sa riadi prístupom BDD. Syntax je ľahko pochopiteľná aj pre neprogramátorov. A tento framework je jediným nástrojom na testovanie API, ktorý spojil automatizáciu API a testovanie výkonnosti do jedného samostatného nástroja.
Poskytuje používateľom možnosť vykonávať testovacie prípady paralelne a vykonávať kontroly JSON & XML.
Na základe týchto informácií možno vyvodiť určité kľúčové body, ktoré pomôžu podrobnejšie pochopiť nástroj karate:
- Karate je testovací rámec BDD namiesto TDD.
- Je navrhnutý tak, aby bol jednoduchý aj pre neprogramátorov. Táto funkcia mení pravidlá hry, pretože umožňuje širšie využitie a prístup mnohým ľuďom bez ohľadu na ich technické zázemie alebo schopnosti.
- Na zápis testu využíva súbor funkcií Cucumber a jazyk Gherkins, ktorý je veľmi zrozumiteľný.
Všetky tieto funkcie z neho robia jeden z najvýhodnejších automatizačných nástrojov, ktoré sú dnes k dispozícii.
História karate Rámec
Vytvoril Peter Thomas' v roku 2017, je tento softvér zameraný na to, aby boli testovacie funkcie ľahko dostupné pre každého. Bol napísaný v jazyku Java a väčšina ľudí očakávala, že aj jeho súbory budú v rovnakom jazyku, našťastie to však nie je pravda.
Skôr používa súbory Gherkins, čo vyplýva z jeho vzťahu s frameworkom Cucumber. Automatizačný softvér je rozšírením Cucumberu, preto zdedil používanie súborov Gherkins pri svojej činnosti. Veľký rozdiel medzi nimi je v tom, že Karate pri testovaní nepoužíva Javu, ale Cucumber áno.
Práve preto je určený pre neprogramátorov, pretože syntax Gherkins je veľmi čitateľná a komplexná. To je dôvod, prečo je Karate najvhodnejší a odporúčaný na vstup do sveta automatizovaného testovania API.
Nasledujú niektoré funkcie testovacieho rámca Karate:
- Používa zrozumiteľný jazyk Gherkins.
- Nevyžaduje si žiadne technické znalosti programovania ako Java.
- Je založený na populárnych štandardoch Cucumber.
- Jednoduché vytvorenie rámca.
- Paralelné testovanie je základná funkcia, ktorú poskytuje samotný Karate, preto nemusíme byť závislí od Maven, Gradle , atď.
- Používateľské rozhranie na ladenie testu.
- Volanie súboru funkcií z iného súboru.
- Poskytuje podporu pre testovanie ovládača údajov, ktorý je vytvorený vo vlastnej réžii, a preto nie je potrebné závisieť od externých rámcov.
- Zabudované natívne zostavy Rest Reports. Navyše sa dá integrovať s Cucumberom pre lepšie UI Reports a väčšiu prehľadnosť.
- Poskytuje internú podporu pri prepínaní konfigurácie v rôznych testovacích prostrediach (QA, Stage, Prod, Pre-Prod).
- Bezproblémová podpora integrácie CI/CD, ktorá môže byť užitočná.
- Dokáže spracovať rôzne volania HTTP:
- Podpora webových soketov
- Požiadavka SOAP
- HTTP
- Spracovanie súborov cookie v prehliadači
- HTTPS
- Údaje vo formulári HTML
- Požiadavka XML
Porovnanie karate a zaisteného odpočinku
Zaistený odpočinok : Je to knižnica založená na jazyku Java na testovanie služieb REST. Na písanie riadkov kódu používa jazyk Java. Pomáha pri testovaní mnohých kategórií požiadaviek, čo ďalej vedie k overovaniu rôznych kombinácií obchodnej logiky.
Rámec karate : Nástroj založený na Cucumber/Gherkins, ktorý sa používa na testovanie služieb SOAP a REST.
V nasledujúcej tabuľke je uvedených niekoľko výraznejších rozdielov medzi Rest-Assured & Karate Framework:
| S.č. | Základňa | Rámec karate | Zabezpečený REST |
|---|---|---|---|
| 1 | Jazyk | Používa kombináciu uhoriek a uhoriek | Využíva jazyk Java |
| 2 | Kód Veľkosť | Zvyčajne je to menej riadkov kódu, pretože sa riadi štruktúrou podobnou Cucumberu | Počet riadkov kódu je vyšší, pretože zahŕňa použitie jazyka Java |
| 3 | Požadované technické znalosti | Non- Programátori môžu ľahko napísať kód Gherkins | Na písanie kódu v jazyku Java sú potrebné technické znalosti |
| 4 | Testovanie založené na údajoch | Je potrebné použiť TestNG alebo ekvivalent na podporu toho istého | Na podporu testovania údajov možno použiť interné značky |
| 5 | Poskytuje podporu volaní SOAP | Áno, poskytuje | Súvisí len s požiadavkou REST |
| 6 | Paralelné testovanie | Áno, paralelné testovanie je ľahko podporované aj paralelným generovaním správ | Hoci sa o to ľudia pokúšali, miera neúspechu je vyššia ako miera úspechu. |
| 7 | Nahlasovanie | Poskytuje interný reporting, preto nemusí byť závislý od externých pluginov. Dokonca ho môžeme integrovať s pluginom Cucumber pre lepší reporting pre používateľské rozhranie. | Potreba závislosti od externých zásuvných modulov ako Junit, TestNG |
| 8 | Podpora CSV pre externé údaje | Áno, od verzie Karate 0.9.0 | Nie, musíte použiť kód Java alebo knižnicu |
| 9 | Automatizácia webového používateľského rozhrania | Áno, od verzie Karate 0.9.5 je možná automatizácia Web-UI | Nie, nie je podporovaná |
| 10 | Ukážka GET | Dané param val1 = 'name1' | given(). |
Preto, ako ukazujú vyššie uvedené rozdiely, môžeme s istotou povedať, že karate je jednou z najjednoduchších vecí, ktoré môže robiť každý.
Nástroje potrebné na prácu s rámcom karate
Keďže máme základné vedomosti o systéme Karate Framework, pozrime sa teraz na procesy a nástroje potrebné na nastavenie prostredia Karate.
#1) Zatmenie
Eclipse je integrované vývojové prostredie používané v oblasti počítačového programovania. Väčšinou sa používa na programovanie v jazyku Java. Ako už bolo spomenuté, Karate je napísané v jazyku Java, takže je logickejšie, prečo je Eclipse IDE na testovanie softvéru API. Ďalším dôvodom je, že ide o nástroj s otvoreným zdrojovým kódom, a to je dosť silný dôvod, prečo sa rozhodnúť pre tento nástroj.
Poznámka: Mohli by sme použiť aj IntelliJ, Visual Studio a ďalšie rôzne editory dostupné na trhu.
#2) Maven
Ide o nástroj na automatizáciu zostavovania, ktorý sa používa predovšetkým na zostavovanie projektov Java. Je to jeden zo spôsobov nastavenia prostredia Karate a písania kódu. Ak chcete nastaviť Eclipse s požiadavkami Maven, môžete kliknúť sem pre inštaláciu Maven.
Pri práci v Mavene používajte závislosti Mavenu, ktoré vám pomôžu podporovať Karate Framework.
V súbore pom.xml sa budú používať nasledujúce závislosti.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Poznámka: Najnovšie verzie môžu byť k dispozícii v úložisku Maven.
#3) Gradle
Gradle je alternatívou k Maven a môže byť použitý v rovnakej kapacite. Majú svoje podobnosti a rozdiely, ale môžu byť rovnako použité pri nastavovaní prostredia pre naše kódy Karate.
Je jednoduchší na používanie, flexibilný a odporúča sa ho používať, keď má naša aplikácia určité požiadavky na modularizáciu a správu s množstvom zásuvných modulov. Kód nastavenia Gradle by vyzeral približne takto,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Poznámka: Môžete použiť MAVEN alebo GRADLE.
#4) Nastavenie prostredia Java v systéme
Na spustenie skriptov Karate Framework je potrebné nastaviť prostredie JDK a JRE.
Štruktúra testovacieho skriptu karate
Testovací skript Karate je známy vlastníctvom prípony ".feature". Táto vlastnosť je zdedená z Cucumberu. Rovnako je povolená aj organizácia súborov v konvencii Javy. Svoje súbory môžete organizovať podľa konvencií balíkov Javy.
Usmernenia Maven však prikazujú, aby sa ukladanie súborov, ktoré nie sú v jazyku Java, vykonávalo oddelene. Ukladajú sa do src/test/resources A súbory Java sú uložené v adresári src/main/java .
Podľa tvorcov Karate Frameworku sú však pevne presvedčení, že súbory v jazyku Java aj súbory, ktoré nie sú v jazyku Java, by sme mali uchovávať vedľa seba. Podľa nich je oveľa jednoduchšie hľadať súbory *.java a *.feature, ak sú uchovávané spolu, než podľa štandardnej štruktúry Mavenu.
To sa dá ľahko dosiahnuť úpravou súboru pom.xml nasledovne (pre Maven):
src/test/java **/*.java ...
Nižšie je uvedená všeobecná štruktúra rámca karate:
Keďže tento Karate Framework používa súbor Runner, ktorý je potrebný aj v Cucumberi na spúšťanie súborov funkcií, väčšina písania sa bude riadiť štandardmi Cucumbera.
Na rozdiel od Cucumberu si však kroky v Karate nevyžadujú jasnú definíciu, čo zase zvyšuje flexibilitu a jednoduchosť operácií. Nemusíme pridávať ďalšie lepidlo, ktoré zvyčajne musíme pridávať, keď sa riadime rámcom Cucumber.
Trieda "Runner" je väčšinou pomenovaná TestRunner.java.
Potom bude mať súbor TestRunner.java podobu:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } A keď hovoríme o .feature obsahuje všetky testovacie scenáre, ktoré je potrebné otestovať, aby sa zabezpečilo, že API funguje podľa očakávaných požiadaviek.
Všeobecný súbor *.feature vyzerá ako na obrázku nižšie:
Funkcia: načítanie údajov o používateľovi Scenár: testovanie volania get pre údaje o používateľovi Zadaná url '//reqres.in/api/users/2' Keď metóda GET Potom stav 200
Vytvorenie prvého základného testovacieho skriptu karate
Táto časť vám pomôže začať s vytváraním vášho prvého testovacieho skriptu, ktorý vám bude nápomocný pri konverzii rozhraní API vo forme rámca Karate.
Predtým, ako začneme písať základné testovacie skripty Karate, nainštalujte si na svoj počítač nasledujúce požiadavky:
- IDE Eclipse
- Maven. Nastavte príslušnú cestu Maven.
- JDK & JRE. Nastavte príslušnú cestu.
Pozrime sa na postup krok za krokom:
#1) Vytvorenie nového MAVEN Projekt v editore Eclipse
- Otvoriť Eclipse
- Kliknite na položku Súbor. Vyberte položku Nový projekt.
- Vyberte projekt Maven
- Vyberte umiestnenie pracovného priestoru.
- Vyberte archetyp (zvyčajne vyberieme " Maven-archetype-quickstart 1.1 " pre jednoduché projekty Maven).
- Zadajte ID skupiny & ID artefaktu (v našom príklade sme použili tieto hodnoty).
- ID skupiny : Karate
- ID artefaktu: KarateTestScriptsSample
- Kliknutím na tlačidlo Dokončiť dokončite nastavenie.
#2) Po vytvorení sa v okne Prieskumník projektu zobrazí nasledujúca štruktúra.
#3) Zahrňte všetky závislosti.
Naším prvým krokom po nastavení bude zahrnúť všetky závislosti ktoré budú potrebné na vykonanie. Všetky značky budeme uchovávať v rámci POM.xml (Za predpokladu, že už viete o používaní POM.xml).
- Otvorte súbor POM.xml, skopírujte nasledujúci kód pod značku závislosti a súbor uložte.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Kliknite sem pre zdroj.
#4) Poďme si prebrať scenár, čo budeme testovať v tomto základnom testovacom skripte karate.
Scenár:
Pomocou tejto adresy URL budeme testovať rozhranie API.
Cesta: api/users/2
Metóda: GET
A my musíme potvrdiť , či žiadosť vracia Kód úspešnosti (200) alebo nie.
Zjednodušene povedané, budeme len testovať vzorku API, aby sme zistili, či sa úspešne vykoná.
Poznámka: Vychádzame zo vzorky API, ktorá je k dispozícii na testovanie. Môžete si vybrať ľubovoľný PATH alebo sa môžete odvolať na svoje API.
Kliknite sem pre zdroj.
#5) Naším ďalším krokom bude vytvorenie .feature súbor.
Ako sa uvádza v úvodnej časti, .feature súbor je vlastnosť, ktorá bola zdedená z Cucumberu. V tomto súbore vypíšeme testovacie scenáre, ktoré je potrebné vykonať na vykonanie testovania API.
- Prejsť do priečinka src/test/java vo vašom projekte.
- Kliknite naň pravým tlačidlom myši a vytvorte nový súbor - userDetails.feature. Potom kliknite na tlačidlo Dokončiť.
Teraz sa v priečinku zobrazí nasledujúci súbor src/test/java
Stránka Ikona zelenej farby sa podobá na .feature fi le v jazyku Cucumber, ktorý sme práve vytvorili.
- Po vytvorení súboru teraz napíšeme naše testovacie scenáre, o ktorých bude reč v nasledujúcej časti.
#6) Keďže máme scenár a prázdny . funkcia súbor pripravený, teraz začnime s naším prvým skriptom. Začnime kódovať
Napíšte nasledujúci riadok kódu do súboru userDetails.feature, ktorý sme vytvorili v kroku č. 5:
Funkcia: načítanie údajov o používateľovi Scenár: testovanie volania get pre údaje o používateľovi Zadaná url '//reqres.in/api/users/2' Keď metóda GET Potom stav 200
Pokúsme sa pochopiť komponenty, ktoré sú zapísané vo vyššie uvedenom súbore:
- Funkcia: Kľúčové slovo vysvetľuje názov testovanej funkcie.
- Pozadie: Toto je nepovinná časť, ktorá sa považuje za časť Pre-requisite (Predpoklady). Môže sa použiť na definovanie toho, čo všetko je potrebné na testovanie API. Obsahuje HEADER, URL & PARAM možnosti.
- Scenár: Každý súbor funkcií, ktorý uvidíte, bude obsahovať aspoň jednu funkciu (hoci môže poskytnúť viacnásobné Je to opis testovacieho prípadu.
- Vzhľadom na to, že: Je to krok, ktorý sa musí vykonať pred vykonaním akéhokoľvek iného kroku testu. Je to povinná činnosť, ktorá sa musí vykonať.
- Kedy: Určuje podmienku, ktorá by mala byť splnená, aby sa vykonal ďalší krok testu.
- Potom: To nám hovorí, že to, čo by sa malo stať v prípade, že podmienka uvedená v Keď je splnená.
Poznámka: Všetky uvedené kľúčové slová pochádzajú z jazyka Gherkins. Ide o štandardný spôsob písania testovacích skriptov pomocou jazyka Cucumber.
A niektoré ďalšie slová použité v súbore funkcií sú:
- 200: Je to kód stavu/odpovede, ktorý očakávame (zoznam stavových kódov nájdete tu).
- GET: Je to metóda API ako POST, PUT atď.
Dúfame, že toto vysvetlenie bolo pre vás ľahko pochopiteľné. Teraz budete môcť súvisieť s tým, čo presne je napísané vo vyššie uvedenom súbore.
Teraz musíme vytvoriť súbor TestRunner.java
Ako je vysvetlené v predchádzajúcej časti, Cucumber potrebuje súbor Runner, ktorý by bol potrebný na vykonanie .feature súbor, ktorý obsahuje testovacie scenáre.
- Prejsť do priečinka src/test/java vo vašom projekte
- Kliknite naň pravým tlačidlom myši a vytvorte nový súbor Java: TestRunner.java
- Po vytvorení súboru, umiestnite pod ňu nasledujúce riadky kódu:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner je súbor, ktorý sa teraz spustí na vykonanie požadovaného scenára, ktorý bol napísaný v kroku č. 5.
#7) Teraz máme pripravené oba súbory TestRunner.Java a userDeatils.feature. Jedinou úlohou, ktorá nám zostáva, je Spustiť scenár.
- Prejdite na súbor TestRunner.java a kliknite naň pravým tlačidlom myši, ako je znázornené na nasledujúcom obrázku.
- Vyberte Spustiť ako -> Junit Test
- Po výbere teraz začnete sledovať, že testovací prípad sa spustil.
- Počkajte, kým sa spustí testovací skript. Po dokončení budete v okne pozorovať niečo podobné, ako je zobrazené na nasledujúcom obrázku.
- Nakoniec môžeme povedať, že sme úspešne vytvorili náš prvý základný Testovací skript pomocou Rámec karate.
#8) Nakoniec, rámec Karate poskytuje aj prezentáciu HTML správy o vykonanej exekúcii.
- Prejdite do cieľového priečinka -> surefire-reports-> Tu uvidíte svoju správu HTML, ktorú môžete otvoriť.
** Odporúčame vám tiež, aby ste si ho otvorili pomocou prehliadača Chrome, aby ste získali lepší vzhľad a pocit.
- Zobrazí sa vám nasledujúca správa HTML zobrazujúca Scenáre & Test ktorý bol vykonaný pre uvedený scenár:
Záver
V tomto návode sme sa venovali testovaniu API, rôznym testovacím nástrojom dostupným na trhu a tomu, ako je Karate Framework lepšou voľbou v porovnaní s inými nástrojmi.
Pri vytváraní nášho prvého základného testovacieho skriptu sme postupovali krok za krokom. Projekt Maven v prostredí Eclipse IDE vytvoriť súbor .feature, ktorý obsahuje všetky scenáre testovania a súbor Runner na vykonanie testovacieho prípadu uvedeného v súbore .feature.
Na konci viacerých krokov sme mohli vidieť správu o vykonaní výsledkov testu.
Dúfame, že tento návod bol pre začiatočníkov užitočný pri učení sa, ako vytvoriť svoj prvý testovací skript pomocou Karate Framework a vykonávať testovanie API. Tento podrobný postup krok za krokom je skvelým spôsobom, ako spustiť a vykonať rôzne testy API.
NEXT>>