Ta vadnica je uvod v testiranje API z uporabo ogrodja Karate. Spoznajte strukturo testne skripte Karate in korake za izdelavo prve testne skripte:
API je kratica, ki pomeni vmesnik za programiranje aplikacij. Poenostavljeno ga lahko opredelimo kot posrednika programske opreme, ki omogoča komunikacijo med aplikacijami.
Testiranje API potrebujemo, ker:
- Rezultati so objavljeni hitreje, zato ni več treba čakati, da bi preverili, ali API deluje pravilno.
- S hitrejšim odzivom je hitrejša tudi uvedba teh vmesnikov API, kar omogoča hitrejši čas obdelave.
- Z zgodnjim odkrivanjem napak, še preden je uporabniški vmesnik aplikacije ustvarjen, lahko zmanjšamo tveganja in odpravimo napake.
- Velika dobava je mogoča v krajšem času.
Za testiranje API so na trgu na voljo različna orodja, kot so Postman, Mocha in Chai. Ta so pokazala dobre rezultate in učinkovito uporabo za testiranje API, vendar so močno odvisna od kode. Za njihovo uporabo je treba biti tehnično podkovan in poznati programske jezike.
Okvir Karate lepo rešuje to težavo predhodnih programskih orodij.
Kaj je karate okvir
Karate? Pogovorimo se o karateju. Je to tisti z Japonske? Kaj menite? Morda ga je v prostem času razvil veliki Bruce Lee.
Čeprav bi se radi poglobili v zanimive korenine karateja, se za zdaj pogovorimo o Karate orodje ki ga je razvil Peter Thomas , ki je eno od odličnih orodij, ki pomagajo preizkuševalcem API.
Okvir Karate sledi slogu pisanja programa Cucumber, ki sledi pristopu BDD. Sintaksa je enostavna za razumevanje tudi za neprogramerje. In ta okvir je edino orodje za testiranje API, ki je združilo avtomatizacijo API in testiranje zmogljivosti v eno samo samostojno orodje.
Uporabnikom omogoča vzporedno izvajanje testnih primerov in izvajanje preverjanj JSON & amp; XML.
Na podlagi teh informacij je mogoče sklepati o nekaterih ključnih točkah, ki omogočajo podrobnejše razumevanje orodja karate:
- Karate je ogrodje za testiranje BDD in ne TDD.
- Zasnovan je tako, da je enostaven tudi za neprogramerje. Ta funkcija spreminja pravila igre, saj omogoča večjo uporabo in dostop številnim ljudem ne glede na njihovo tehnično predznanje ali zmogljivosti.
- Za pisanje testa, ki je zelo enostaven za razumevanje, uporablja datoteko funkcij Cucumber in jezik Gherkins.
Zaradi vseh teh funkcij je to eno najugodnejših orodij za avtomatizacijo, ki so danes na voljo.
Zgodovina karate okvirja
Ustvaril ga je ' Peter Thomas' leta 2017, je namen te programske opreme omogočiti, da so funkcije testiranja na voljo vsem. Napisana je bila v Javi in večina ljudi je pričakovala, da bodo tudi njene datoteke v istem jeziku, vendar na srečo temu ni tako.
Namesto tega uporablja datoteke Gherkins, kar je posledica njegove povezave z ogrodjem Cucumber. Programska oprema za avtomatizacijo je razširitev ogrodja Cucumber, zato pri svojem delovanju podeduje uporabo datotek Gherkins. Velika razlika med njima je, da Karate pri testiranju ne uporablja Jave, Cucumber pa jo.
Prav zato je namenjen tudi neprogramerjem, saj je Gherkinsova sintaksa zelo berljiva in izčrpna. Zato je Karate najbolj primeren in priporočljiv za vstop v svet avtomatiziranega testiranja API.
V nadaljevanju so predstavljene nekatere značilnosti ogrodja za testiranje Karate:
- Uporablja lahko razumljiv jezik Gherkins.
- Ne zahteva tehničnega programerskega znanja kot Java.
- Temelji na priljubljenih standardih Cucumber.
- Enostavno ustvarjanje okvira.
- Vzporedno testiranje je osnovna funkcionalnost, ki jo zagotavlja Karate sam, zato nam ni treba biti odvisni od Maven, Gradle , itd.
- Uporabniški vmesnik za odpravljanje napak v testu.
- Klicanje datoteke funkcij iz druge datoteke.
- Zagotavlja podporo za testiranje podatkovnega gonilnika, ki je zgrajen v podjetju, zato ni treba biti odvisen od zunanjih ogrodij.
- Vgrajena so nativna poročila o počitku. Poleg tega ga je mogoče integrirati s programom Cucumber za boljša poročila o uporabniškem vmesniku in večjo jasnost.
- Zagotavlja notranjo podporo za konfiguracijo preklapljanja v različnih okoljih testiranja (QA, Stage, Prod, Pre-Prod).
- Brezhibna podpora za integracijo CI/CD, ki je lahko koristna.
- Sposoben je upravljati različne klice HTTP:
- Podpora za spletno vtičnico
- Zahteva SOAP
- HTTP
- Ravnanje s piškotki brskalnika
- HTTPS
- Podatki v obliki HTML
- Zahteva XML
Primerjava Karate Vs Rest-Assured
Zagotovljen počitek : To je knjižnica za testiranje storitev REST, ki temelji na jeziku Java. Za pisanje vrstic kode uporablja jezik Java. Pomaga pri testiranju številnih kategorij zahtevkov, kar omogoča preverjanje različnih kombinacij poslovne logike.
Karate okvir : Orodje, ki temelji na Cucumber/Gherkins in se uporablja za testiranje storitev SOAP & amp; REST.
V spodnji tabeli je navedenih nekaj vidnejših razlik med Rest-Assured & amp; Karate Framework:
| S.št. | Osnova | Karate okvir | Zagotovljeno za REST |
|---|---|---|---|
| 1 | Jezik | Uporablja kombinacijo kumar in kumaric | Uporablja jezik Java |
| 2 | Koda Velikost | Običajno je vrstica kode manjša, saj sledi strukturi, ki je podobna strukturi Cucumberja. | Število vrstic kode je večje, ker vključuje uporabo jezika Java. |
| 3 | Potrebno tehnično znanje | Ne- Programerji lahko preprosto napišejo kodo Gherkins | Tehnično znanje je potrebno za pisanje kode Java |
| 4 | Testiranje na podlagi podatkov | Uporabiti je treba TestNG ali enakovredno orodje, ki podpira isto. | Notranje oznake se lahko uporabljajo za podporo testiranju podatkov. |
| 5 | Ali zagotavlja podporo za klice SOAP | Da, zagotavlja | Povezan je le z zahtevo REST. |
| 6 | Vzporedno testiranje | Da, vzporedno testiranje je zlahka podprto tudi z vzporednim ustvarjanjem poročil | Čeprav so ljudje poskušali to storiti, je stopnja neuspeha večja od stopnje uspeha. |
| 7 | Poročanje | Zagotavlja notranje poročanje, zato ni treba biti odvisen od zunanjih vtičnikov. Za boljši uporabniški vmesnik ga lahko celo integriramo z vtičnikom za poročanje Cucumber. | Potrebna je odvisnost od zunanjih vtičnikov, kot so Junit, TestNG |
| 8 | Podpora CSV za zunanje podatke | Da, iz različice Karate 0.9.0 | Ne, uporabiti morate kodo ali knjižnico Java. |
| 9 | Avtomatizacija spletnega uporabniškega vmesnika | Da, od Karate 0.9.5 je mogoča avtomatizacija spletnega uporabniškega vmesnika | Ne, ni podprta |
| 10 | Vzorec GET | Dani param val1 = 'name1' | given(). |
Kot kažejo zgornje razlike, lahko rečemo, da je karate ena najlažjih stvari, ki jih lahko počne vsakdo.
Orodja, potrebna za delo s karate okvirjem
Ker smo pridobili osnovno znanje o ogrodju Karate, si zdaj oglejmo postopke in orodja, ki so potrebna za vzpostavitev okolja Karate.
#1) Eclipse
Eclipse je integrirano razvojno okolje, ki se uporablja na področju računalniškega programiranja. Večinoma se uporablja za programiranje v Javi. Kot smo že omenili, je program Karate napisan v Javi, zato je bolj smiselno, zakaj je Eclipse najprimernejši IDE za programsko opremo za testiranje API. Drugi razlog je, da gre za odprtokodno orodje, kar je precej močan razlog za izbiro tega orodja.
Opomba: Uporabimo lahko tudi IntelliJ, Visual Studio in druge različne urejevalnike, ki so na voljo na trgu.
#2) Maven
To je orodje za avtomatizacijo gradnje, ki se uporablja predvsem za gradnjo projektov Java. Je eden od načinov za vzpostavitev okolja Karate in pisanje kode. Če želite nastaviti Eclipse z zahtevami Maven, lahko za namestitev Maven kliknete tukaj.
Pri delu v programu Maven uporabite odvisnosti Maven, ki vam bodo pomagale pri podpori ogrodja Karate.
V pom.xml bodo uporabljene naslednje odvisnosti z Mavenom.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Opomba: Najnovejše različice so lahko na voljo v skladišču Maven.
#3) Gradle
Gradle je alternativa Mavenu in se lahko uporablja v enaki meri. Imata svoje podobnosti in razlike, vendar se lahko enako uporabljata pri vzpostavljanju okolja za naše kode Karate.
Lažje ga je uporabljati, je prilagodljiv in ga je priporočljivo uporabiti, kadar ima naša aplikacija nekaj zahtev po modularizaciji in upravljanju s številnimi vtičniki. Koda za nastavitev Gradle bi bila videti nekako takole,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Opomba: Uporabite lahko MAVEN ali GRADLE.
#4) Nastavitev okolja Java v vašem sistemu
Za začetek dela s skriptami Karate Framework morate nastaviti okolje JDK in JRE.
Struktura Karate Test Script
Testna skripta Karate je znana po tem, da ima končnico ".feature". Ta lastnost je podedovana od Cucumberja. Enako dovoljena je tudi organizacija datotek po konvenciji Java. Svoje datoteke lahko organizirate v skladu s konvencijami paketov Java.
Vendar smernice Maven določajo, da je treba datoteke, ki niso datoteke Jave, shranjevati ločeno. src/test/resources strukturo. Datoteke Java pa so shranjene pod src/main/java .
Ustvarjalci ogrodja Karate pa so trdno prepričani, da je treba datoteke v jeziku Java in datoteke, ki niso v jeziku Java, hraniti drugo ob drugi. Po njihovem mnenju je veliko lažje iskati datoteke *.java in *.feature, če jih hranimo skupaj, namesto da bi sledili standardni strukturi Maven.
To lahko preprosto storite tako, da spremenite pom.xml, kot sledi (za Maven):
src/test/java **/*.java ...
V nadaljevanju je opisana splošna struktura okvirnega karateja:
Ker to ogrodje Karate Framework uporablja datoteko Runner, ki je potrebna tudi v Cucumberju za zagon datotek funkcij, bo večina pisanja sledila standardom Cucumberja.
Toda za razliko od Cucumberja koraki v Karateju ne zahtevajo jasne opredelitve, kar posledično poveča prilagodljivost in enostavnost delovanja. Ni nam treba dodajati dodatnega lepila, ki ga moramo običajno dodajati, ko sledimo ogrodju Cucumber.
Razred "Runner" je največkrat poimenovan TestRunner.java.
Nato bo datoteka TestRunner.java imela obliko:
uvoz com.intuit.karate.junit4.Karate; uvoz org.junit.runner.RunWith; @RunWith(Karate.class) javni razred TestRunner { } In ko govorimo o .feature vsebuje vse testne scenarije, ki jih je treba preizkusiti, da bi se prepričali, da API deluje v skladu s pričakovanimi zahtevami.
Splošna datoteka *.feature je videti tako, kot je prikazano spodaj:
Funkcija: pridobivanje podatkov o uporabniku Scenarij: testiranje klica za pridobitev podatkov o uporabniku Podan url '//reqres.in/api/users/2' Ko metoda GET Potem status 200
Ustvarjanje prvega osnovnega scenarija za testiranje karateja
Ta razdelek vam bo pomagal začeti z ustvarjanjem prvega testnega scenarija, ki vam bo v pomoč pri pretvorbi API-jev v obliki ogrodja Karate.
Preden napišemo osnovne testne skripte Karate, v svoj računalnik namestite naslednje zahteve:
- IDE Eclipse
- Maven. Nastavite ustrezno pot Maven.
- JDK & JRE. Nastavite ustrezno pot.
Oglejmo si pristop po korakih:
#1) Ustvarite novo MAVEN Projekt v urejevalniku Eclipse
- Odprite program Eclipse
- Kliknite Datoteka. Izberite Nov projekt.
- Izberite projekt Maven
- Izberite lokacijo delovnega prostora.
- Izberite arhetip (običajno izberemo " Maven-archetype-quickstart 1.1 " za preproste projekte Maven).
- Navedite ID skupine & ID artefakta (v našem primeru smo uporabili naslednje vrednosti).
- ID skupine : karate
- ID artefakta: KarateTestScriptsSample
- S klikom na Dokončaj dokončajte nastavitev.
#2) Po ustvarjanju bo v oknu Raziskovalec projekta prikazana naslednja struktura.
#3) Vključite vse svoje odvisnosti.
Naš prvi korak po namestitvi je, da vključite vse odvisnosti ki bodo potrebni za izvajanje. Vse oznake bomo shranili v POM.xml (predpostavljamo, da že poznate uporabo POM.xml).
- Odprite POM.xml in kopirajte spodnjo kodo pod oznako odvisnosti ter shranite datoteko.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Kliknite tukaj za vir.
#4) Premislimo o scenariju, kaj bomo preizkusili v tem osnovnem testnem scenariju za karate.
Scenarij:
S tem naslovom URL bomo testirali API.
Pot: api/users/2
Metoda: GET
Potrditi moramo , ali zahteva vrača Koda uspeha (200) ali ne.
Preprosto povedano, preizkusili bomo vzorec API in preverili, ali se uspešno izvede ali ne.
Opomba: Vzamemo vzorec API, ki je na voljo za testiranje. Izberete lahko kateri koli PATH ali se sklicujete na svoj API.
Kliknite tukaj za vir.
#5) Naš naslednji korak je, da ustvarimo .feature datoteko.
Kot je navedeno v uvodnem delu, je .feature datoteka je lastnost, podedovana od Cucumberja. V tej datoteki bomo zapisali testne scenarije, ki jih je treba izvesti za izvedbo testiranja API.
- Pojdi v mapo src/test/java v vašem projektu.
- Z desno tipko miške kliknite nanj in ustvarite novo datoteko - userDetails.feature. Nato kliknite gumb Dokončaj.
Zdaj boste v mapi videli naslednjo datoteko src/test/java
Spletna stran Zeleno obarvana ikona je podoben .feature fi le v programu Cucumber, ki smo ga pravkar ustvarili.
- Ko je datoteka ustvarjena, bomo zdaj napisali testne scenarije, ki jih bomo obravnavali v naslednjem razdelku.
#6) Ker imamo scenarij in prazen . funkcija datoteka pripravljena, zdaj pa začnimo z našo prvo skripto. Začnimo s kodiranjem
V datoteko userDetails.feature, ki smo jo ustvarili v koraku #5, napišite naslednjo vrstico kode:
Funkcija: pridobivanje podatkov o uporabniku Scenarij: testiranje klica za pridobitev podatkov o uporabniku Podan url '//reqres.in/api/users/2' Ko metoda GET Potem status 200
Poskusimo razumeti komponente, ki so zapisane v zgornji datoteki:
- Funkcija: Ključna beseda pojasnjuje ime funkcije, ki jo testiramo.
- Ozadje: To je neobvezen razdelek, ki se obravnava kot razdelek Predpogoji. V njem lahko določite, kaj vse je potrebno za testiranje API-ja. Vsebuje HEADER, URL & amp; PARAM možnosti.
- Scenarij: Vsaka datoteka z značilnostmi, ki jo boste videli, bo vsebovala vsaj eno značilnost (čeprav lahko več To je opis testnega primera.
- Dano: To je korak, ki ga je treba izvesti, preden se izvede kateri koli drug korak preskusa. Gre za obvezno dejanje, ki ga je treba izvesti.
- Kdaj: Določa pogoj, ki mora biti izpolnjen, da se izvede naslednji korak preskusa.
- Nato: V njem je navedeno, kaj se mora zgoditi v primeru, da je izpolnjen pogoj, naveden v Ko je izpolnjen.
Opomba: Vse zgoraj navedene ključne besede so iz jezika Gherkins. Gre za standardni način pisanja testnih skript z uporabo Cucumberja.
V datoteki funkcij je uporabljenih še nekaj besed:
- 200: To je koda stanja/odgovora, ki jo pričakujemo (za seznam kod stanja kliknite tukaj).
- GET: To je metoda API, kot so POST, PUT itd.
Upamo, da vam je bila ta razlaga razumljiva. Zdaj se boste lahko povezali s tem, kaj točno je zapisano v zgornji datoteki.
Zdaj moramo ustvariti datoteko TestRunner.java
Kot je razloženo v zgornjem razdelku, Cucumber potrebuje datoteko Runner, ki bi bila potrebna za izvajanje .feature datoteko, ki vsebuje scenarije testiranja.
- Pojdi v mapo src/test/java v vašem projektu
- Z desno tipko miške kliknite nanj in ustvarite novo datoteko Java: TestRunner.java
- Ko je datoteka ustvarjena, pod njo vstavite naslednje vrstice kode:
uvoz org.junit.runner.RunWith; uvoz com.intuit.karate.junit4.Karate; @RunWith(Karate.class) javni razred TestRunner { } - Test Runner je datoteka, ki se bo zdaj izvedla za izvedbo želenega scenarija, zapisanega v koraku #5.
#7) Zdaj smo pripravljeni z obema datotekama TestRunner.Java in . userDeatils.feature. Edina naloga, ki nam je ostala, je, da Spustite scenarij.
- Pojdite v datoteko TestRunner.java in z desno tipko miške kliknite na datoteko, kot je prikazano na spodnji sliki.
- Izberite Zaženi kot -> Test Junit
- Ko bo izbran, boste opazili, da se je testni primer začel.
- Počakajte, da se testna skripta izvede. Ko se bo to zgodilo, boste v oknu opazili nekaj podobnega, kot je prikazano na spodnji sliki.
- Končno lahko rečemo, da smo uspešno ustvarili našo prvo osnovno Testni skript z uporabo Okvir karateja.
#8) Okvir Karate omogoča tudi predstavitev poročila HTML o izvedeni izvršitvi.
- Pojdite v ciljno mapo -> surefire-reports-> Tu boste videli poročilo HTML, ki ga lahko odprete.
** Priporočamo vam tudi, da ga odprete v brskalniku Chrome za boljši videz in občutek.
- Prikazano bo naslednje poročilo HTML, ki prikazuje Scenariji & amp; Test ki je bil izveden za omenjeni scenarij:
Zaključek
V tem vodniku smo obravnavali testiranje API, različna orodja za testiranje, ki so na voljo na trgu, in kako je Karate Framework boljša možnost v primerjavi s podobnimi orodji.
Pri ustvarjanju naše prve osnovne testne skripte smo se ravnali po korakih. Projekt Maven v okolju Eclipse IDE ustvarite datoteko .feature, ki vsebuje vse scenarije preskušanja, in datoteko Runner za izvedbo preskusnega primera, navedenega v datoteki .feature.
Na koncu več korakov lahko vidimo poročilo o izvedbi rezultatov preskusa.
Upamo, da je bilo to vodilo v pomoč začetnikom pri učenju, kako zgraditi prvo testno skripto z uporabo ogrodja Karate in izvajati testiranje API. Ta podroben pristop korak za korakom je čudovit način za zagon in izvajanje različnih testov API.
NAPREJ>>