Hierdie handleiding is 'n inleiding tot API-toetsing deur Karate-raamwerk te gebruik. Kom meer te wete oor die struktuur van Karate-toetsskrif en stappe om die eerste toetsskrif te bou:
API is 'n akroniem wat staan vir Application Programming Interface. In eenvoudige terme kan ons dit definieer as 'n sagteware-tussenganger wat kommunikasie tussen toepassings toelaat.
Ons het API-toetsing nodig, want:
- Resultate word vinniger gepubliseer, dus nie meer wag om te sien of die API goed werk nie.
- Met die vinniger reaksie word die ontplooiing van hierdie API's ook vinniger, dus maak dit voorsiening vir vinnige omkeertyd.
- Vroeë foutopsporing, selfs voordat die UI van die toepassing geskep word, laat ons toe om risiko's te versag en foute reg te stel.
- Grootskaalse aflewering moontlik in 'n korter tydperk.
Om aan API-toetsing te kan werk, het ons verskeie nutsmiddels in die mark beskikbaar soos Postman, Mocha en Chai. Dit het goeie resultate en effektiewe gebruik vir die toets van API's getoon, maar dit word sterk beïnvloed deur kode. Om dit te kan gebruik, moet 'n mens tegnies goed en vertroud wees met programmeertale.
Die Karate-raamwerk los hierdie kwessie van sy voorafgaande sagteware-nutsmiddels pragtig op.
Wat is karateraamwerk
Karate? Kom ons praat Karate. Is dit die een van Japan? Wat dink jy? Miskien is dit die groot Brucehierdie Karate Basiese Toetsskrip.
Scenario:
Ons sal 'n API met hierdie URL toets.
Pad: api/gebruikers/2
Metode: GET
En ons moet bevestig of die versoek 'n Sukseskode ( 200) of nie.
In eenvoudige terme, ons gaan net 'n voorbeeld-API toets om te sien of dit suksesvol uitgevoer word of nie.
Let wel: Ons neem 'n voorbeeld API wat beskikbaar is vir toetsing. Jy kan enige PAD kies of kan na jou API verwys.
Klik hier vir bron.
#5) Nou sal ons volgende stap wees om 'n te skep .feature -lêer.
Soos bespreek in die inleidingsafdeling, is die .feature-lêer die eienskap wat van Cucumber geërf is. In hierdie lêer sal ons die toetsscenario's uitskryf wat uitgevoer moet word om die API-toetsing uit te voer.
- Gaan na Folder src/test/java in jou projek.
- Regsklik daarop en skep 'n nuwe lêer – userDetails.feature. Klik dan op die Voltooi-knoppie.
Nou sal jy die volgende lêer sien onder die vouer src/test/java
Die Groen gekleurde ikoon lyk soos die .kenmerk fi le in Komkommer wat ons sopas geskep het.
- Sodra die lêer geskep is, sal ons nou ons toetsscenario's skryf wat in die volgende afdeling bespreek sal word.
#6) Aangesien ons die scenario endie leë . funksie -lêer gereed, laat ons nou begin met ons eerste skrif. Kom ons begin kodering
Skryf die volgende reël kode onder userDetails.feature-lêer wat ons in Stap #5 geskep het:
Feature: fetching User Details Scenario: testing the get call for User Details Given url '//reqres.in/api/users/2' When method GET Then status 200
Kom ons probeer verstaan die komponente wat in die bogenoemde lêer geskryf is:
- Kenmerk: Sleutelwoord verduidelik die naam van die kenmerk wat ons toets.
- Agtergrond: Dit is 'n opsionele afdeling wat as 'n Voorvereiste afdeling hanteer word. Dit kan gebruik word om te definieer wat alles nodig is om die API te toets. Dit bevat HOOF, URL & PARAM opsies.
- Scenario: Elke kenmerklêer wat jy sal sien sal ten minste een kenmerk hê (alhoewel dit veelvuldige scenario's kan gee) . Dit is die beskrywing van die toetsgeval.
- Gegee: Dit is die stap wat uitgevoer moet word voordat enige ander toetsstap uitgevoer word. Dit is 'n verpligte aksie wat uitgevoer moet word.
- Wanneer: Dit spesifiseer die voorwaarde waaraan voldoen moet word om die volgende toetsstap uit te voer.
- Dan: Dit sê vir ons wat moet gebeur in geval die toestand genoem in die Wanneer bevredig is.
Let wel: Al die bogenoemde sleutelwoorde is uit die Gherkins-taal. Dit is die standaard manier om die toetsskrifte met Cucumber te skryf.
En nog 'n paar woorde wat in die kenmerklêer gebruik word, is:
- 200: Dit is die status/antwoordkode wat ons isverwag (Klik hier vir die lys van statuskodes)
- KRY: Dit is die API-metode soos POST, PUT, ens.
Ons hoop hierdie verduideliking was vir jou maklik om te verstaan. Nou sal jy in staat wees om verband te hou met wat presies in die bogenoemde lêer geskryf is.
Nou moet ons 'n TestRunner.java-lêer skep
Soos verduidelik in die bogenoemde afdeling, komkommer benodig 'n Runner-lêer wat nodig sal wees om die .feature -lêer wat die toetsscenario's bevat uit te voer.
- Gaan na Folder src/test/java in jou projek
- Regsklik daarop en skep 'n Nuwe Java-lêer: TestRunner.java
- Sodra die lêer geskep is, plaas die volgende reëls kode daaronder:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { }- Toetsloper is die lêer wat nou uitgevoer sal word om die gewenste scenario wat onder Stap #5 geskryf is.
#7) Nou is ons gereed met beide die lêers TestRunner.Java en userDeatils.feature. Die enigste taak wat vir ons oorbly, is om Uitvoer die skrip.
- Gaan na TestRunner.java-lêer en Regskliek op die lêer soos in die onderstaande prent getoon.
- Kies Hardloop as -> Junit Toets
- Nou, sodra dit gekies is, sal jy begin waarneem dat die toetsgeval nou begin het.
- Wag vir die toetsskrip om uit te voer. Sodra jy klaar is, sal jy iets sien soos in die onderstaande prent in jou venster.
- Laastens kan ons sêdat ons ons heel eerste basiese Toetsskrip met die Karate-raamwerk suksesvol geskep het.
#8) Laastens, die Karate raamwerk gee ook 'n HTML-verslagaanbieding vir die uitvoering wat uitgevoer is.
- Gaan na teikengids -> surefire-verslae-> Hier sal jy jou HTML-verslag sien wat jy kan oopmaak.
** Ons stel ook voor dat jy dieselfde oopmaak met die Chrome Blaaier vir 'n beter voorkoms en gevoel.
- Volgende HTML-verslag sal aan jou gewys word wat Scenario's & Toets wat vir die genoemde scenario uitgevoer is:
Gevolgtrekking
In hierdie tutoriaal het ons API-toetsing, verskillende toetse bespreek gereedskap wat in die mark beskikbaar is, en hoe die Karate-raamwerk 'n beter opsie is in vergelyking met sy eweknieë.
Ons het 'n stap-vir-stap benadering gevolg om ons eerste basiese toetsskrif te skep. Ons het begin met die skep van 'n basiese Maven-projek in Eclipse IDE om 'n .feature-lêer te skep, wat al die toetsscenario en 'n Runner-lêer bevat om die toetsgeval uit te voer wat in die .feature-lêer genoem word.
Aan die einde van die veelvuldige stappe kon ons die uitvoeringsverslag van die toetsresultate sien.
Ons hoop dat hierdie tutoriaal nuttig was vir die beginners om te leer hoe om hul eerste toetsskrif te bou deur die Karate-raamwerk te gebruik. en voer API-toetse uit. Hierdie gedetailleerde stap-vir-stapbenadering is 'n wonderlike manier om verskeie toetse op die API uit te voer en uit te voer.
VOLGENDE>>
Lee het dit in sy vrye tyd ontwikkel.Alhoewel ons graag in die interessante wortels van Karate wil delf, kom ons praat vir eers oor die Karate-instrument wat ontwikkel is deur Peter Thomas , een van die wonderlike hulpmiddels wat tot die redding van API-toetsers kom.
Karate-raamwerk volg die Komkommer-styl om die program te skryf wat die BDD-benadering volg. Die sintaksis is maklik om te verstaan deur nie-programmeerders. En hierdie raamwerk is die enigste API-toetsinstrument wat API-outomatisering en prestasietoetsing in 'n enkele selfstandige instrument gekombineer het.
Dit bied die gebruikers die vermoë om die toetsgevalle in Parallel uit te voer en die JSON & XML-kontroles.
Met hierdie inligting kan sekere sleutelpunte afgelei word om die Karate-instrument verder in detail te verstaan:
- Karate is eerder 'n BDD-toetsraamwerk van 'n TDD.
- Dit is ontwerp om maklik te wees vir nie-programmeerders. Hierdie kenmerk is 'n speletjie-wisselaar aangesien dit meer gebruik en toegang deur baie mense moontlik maak, ongeag hul tegniese agtergrond of kapasiteit.
- Dit maak gebruik van die Cucumber-kenmerklêer en die Gherkins-taal om die toets te skryf wat is baie maklik om te verstaan.
Al hierdie kenmerke maak dit een van die gunstigste outomatiseringsnutsmiddels wat vandag beskikbaar is.
History Of Karate Framework
Geskep deur ' Peter Thomas' in 2017, hierdie sagteware het ten doel om toetse te maakfunksies wat geredelik beskikbaar is vir almal. Dit is in Java geskryf en die meeste mense het verwag dat sy lêers ook in dieselfde taal sou wees, maar dit is gelukkig nie die geval nie.
Dit gebruik eerder Gherkins-lêers, wat 'n gevolg is van sy verhouding met die Komkommer raamwerk. Die outomatiseringsagteware is 'n uitbreiding van Cucumber, en erf dus die gebruik van Gherkins-lêer in die werking daarvan. Die groot verskil tussen die twee is dat Karate geen gebruik maak van Java tydens toetsing nie, maar Komkommer wel.
Dit is juis die rede waarom dit vir nieprogrammeerders voorsiening maak aangesien die Gherkins-sintaksis superleesbaar en omvattend is. Dit is die rede waarom Karate die geskikste is en aanbeveel word om toegang tot die wêreld van outomatiese API-toetsing te maak.
Die volgende is 'n paar kenmerke van die Karate-toetsraamwerk:
- Maak gebruik van maklik om te verstaan Gherkins-taal.
- Dit vereis geen tegniese programmeringskennis soos Java nie.
- Dit is gebaseer op die gewilde Komkommer-standaarde.
- Maklik om 'n raamwerk te skep.
- Parallelle toetsing is die kernfunksies wat deur die Karate self verskaf word, daarom hoef ons nie afhanklik te wees van Maven, Gradle , ens.
- UI vir ontfouting van die toets.
- Oproep van 'n kenmerklêer vanaf 'n ander lêer.
- Verskaf ondersteuning vir die databestuurdertoetsing wat in die huis gebou is, dus hoef dit nie van eksterne raamwerke afhanklik te wees nie.
- Ingeboude inheemse rusBerigte. Boonop kan dit met die Komkommer geïntegreer word vir beter UI-verslae en meer duidelikheid.
- Verskaf interne ondersteuning vir die omskakeling van konfigurasie oor verskillende toetsomgewings (QA, Stage, Prod, Pre-Prod).
- Naatlose ondersteuning vir CI/CD-integrasie wat nuttig kan wees.
- In staat om verskeie HTTP-oproepe te hanteer:
- Web Socket-ondersteuning
- SOAP-versoek
- HTTP
- Blaaierkoekiehantering
- HTTPS
- HTML-vormdata
- XML-versoek
Vergelyk Karate vs Rest-Assured
Wees gerus : Dit is 'n Java-gebaseerde biblioteek om die REST-dienste te toets. Dit gebruik Java-taal om die kodereëls te skryf. Dit help met die toets van talle versoekkategorieë, wat verder lei tot die verifikasie van verskillende besigheidslogika-kombinasies.
Karate-raamwerk : 'n Komkommer-/Agurkies-gebaseerde hulpmiddel, wat gebruik word vir toetsing vir SOAP & REST-dienste.
Die volgende tabel bevat 'n paar meer prominente verskille tussen Rest-Assured & Karate-raamwerk:
| S.No | Basis | Karate-raamwerk | RUS-versekerd |
|---|---|---|---|
| 1 | Taal | Dit gebruik 'n kombinasie van komkommer en agurkies | Dit maak gebruik van Java-taal |
| 2 | Kodegrootte | Gewoonlik is die lyn van kode is minder, aangesien dit komkommeragtige struktuur volg | Lyn van kode is meer aangesien dit diegebruik van Java-taal |
| 3 | Tegniese kennis vereis | Nie-programmeerders kan maklik skryf die Gherkins-kode | Tegniese kennis word vereis om Java-kode te skryf |
| 4 | Datagedrewe toetsing | Moet gebruik maak van TestNG of ekwivalent om dieselfde te ondersteun | In-huis-etikette kan gebruik word om datatoetsing te ondersteun |
| 5 | Verskaf dit SOAP-oproepondersteuning | Ja, dit verskaf wel | Dit hou net verband met 'n REST-versoek |
| 6 | Parallelle toetsing | Ja, parallelle toetsing word maklik ondersteun met die generering van parallelle verslag ook | Nie in 'n groot mate nie. Alhoewel mense dit probeer doen het, is die mislukkingskoers meer as die suksessyfer |
| 7 | Rapportering | Dit verskaf interne verslagdoening, en hoef dus nie van eksterne inproppe afhanklik te wees nie. Ons kan dit selfs integreer met Cucumber reporting plugin vir beter UI. | Moet afhanklik wees van eksterne inproppe soos Junit, TestNG |
| 8 | CSV-ondersteuning vir eksterne data | Ja, vanaf Karate 0.9.0 | Nee, moet Java-kode of biblioteek gebruik |
| 9 | Web-UI-outomatisering | Ja, vanaf Karate 0.9.5 is web-UI-outomatisering moontlik | Nee, dit word nie ondersteun nie |
| 10 | Voorbeeld GET | Given param val1 = ‘name1’
| given().
|
Daarom, soos gedemonstreer deur die verskille hierbo, is dit veilig om te sê dat karate een van die maklikste dinge is wat enigiemand kan doen.
Gereedskap wat benodig word om met karateraamwerk te werk
Nou, aangesien ons ons basiese kennis oor het Karate-raamwerk op die punt, kom ons kyk na die prosesse en gereedskap wat nodig is om die Karate-omgewing op te stel.
#1) Eclipse
Eclipse is 'n geïntegreerde ontwikkelingsomgewing wat gebruik word op die gebied van rekenaarprogrammering. Dit word meestal vir Java-programmering gebruik. Soos vroeër genoem, is Karate in Java geskryf, so dit maak meer sin hoekom Eclipse die go-to IDE vir die API-toetssagteware is. Nog 'n rede is dat dit 'n oopbronnutsding is, en dit is 'n redelike sterk rede om vir hierdie hulpmiddel te kies.
Let wel: Ons kan selfs IntelliJ, Visual Studio en ander verskillende redakteurs beskikbaar in die mark.
#2) Maven
Dit is 'n bou-outomatiseringsinstrument wat hoofsaaklik gebruik word vir die bou van Java-projekte. Dit is een manier om 'n Karate-omgewing op te stel en die kode te skryf. Om jou Eclipse met Maven-vereistes op te stel, kan jy hier klik vir Maven-installasie.
Terwyl jy in Maven werk, gebruik Maven-afhanklikhede wat jou sal help om Karate Framework te ondersteun.
Die volgende afhanklikhede sal met Maven in pom.xml gebruik word.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Let wel: Die nuutste weergawes kan dalkbeskikbaar wees in die Maven-bewaarplek.
#3) Gradle
Gradle is 'n alternatief vir Maven en kan in gelyke kapasiteit gebruik word. Hulle het hul ooreenkomste en verskille, maar kan eweneens gebruik word om 'n omgewing vir ons Karate-kodes op te stel.
Dit is makliker om te gebruik, buigsaam en word aanbeveel om te gebruik wanneer ons toepassing sekere modulariserings- en bestuursvereistes het met 'n klomp plug-ins. Die Gradle-opstellingskode sal so iets lyk,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Let wel: Jy kan óf MAVEN óf GRADLE gebruik.
#4) Java-omgewing-opstelling in jou stelsel
Moet die JDK- en JRE-omgewing opstel om met die Karate Framework-skrifte te begin.
Struktuur van Karate-toetsskrip
'n Karate-toetsskrif is bekend vir die besit van die ".feature"-uitbreiding. Hierdie eiendom is geërf van Komkommer. Die organisasie van lêers in Java-konvensie word ook ewe toegelaat. Dit staan jou vry om jou lêers volgens die Java-pakketkonvensies te organiseer.
Die Maven-riglyne gee egter opdrag dat die berging van nie-Java-lêers afsonderlik gedoen word. Hulle word in 'n src/test/resources -struktuur gedoen. En die Java-lêers word onder src/main/java gehou.
Maar volgens die skeppers van die Karate-raamwerk glo hulle sterk dat ons beide Java- en nie-Java-lêers langs mekaar hou kant. Volgens hulle is dit baie makliker om uit te kyk vir die*.java- en *.feature-lêers wanneer hulle bymekaar gehou word, eerder as om die standaard Maven-struktuur te volg.
Dit kan maklik gedoen word deur jou pom.xml soos volg aan te pas (Vir Maven):
src/test/java **/*.java ...
Volgende is die uiteensetting van die algemene struktuur van Karate Framework:
Nou, aangesien hierdie Karate Raamwerk gebruik die Runner-lêer, wat ook in Cucumber nodig is om die kenmerklêers te laat loop, so die meeste van die skryfwerk sal die Cucumber-standaarde volg.
Maar, anders as Cucumber, vereis die stappe nie 'n duidelike definisie in Karate nie en wat , op sy beurt, verbeter buigsaamheid en gemak van bedrywighede. Ons hoef nie die ekstra gom by te voeg wat ons gewoonlik moet byvoeg wanneer ons die Komkommer-raamwerk volg nie.
Die “Runner”-klas word meeste van die tyd TestRunner.java genoem.
Dan sal die TestRunner.java-lêer die vorm aanneem van:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { }En praat van die .feature -lêer, dit bevat al die toetse scenario's wat getoets moet word om seker te maak dat die API werk volgens die verwagte vereistes.
'n Algemene *.feature-lêer lyk iets soos hieronder getoon:
Feature: fetching User Details Scenario: testing the get call for User Details Given url '//reqres.in/api/users/2' When method GET Then status 200
Skep die eerste basiese karate-toetsskrip
Hierdie afdeling sal jou help om te begin met die skepping van jou heel eerste toetsskrip, wat vir jou nuttig sal wees om API's in die vorm van 'n Karate-raamwerk om te skakel.
Voordat ons die basiese Karate-toetsskrifte skryf,installeer asseblief die volgende vereistes op jou masjien:
- Eclipse IDE
- Maven. Stel die toepaslike Maven-pad.
- JDK & JRE. Stel die toepaslike pad.
Kom ons kyk na die stap-vir-stap benadering:
#1) Skep 'n nuwe MAVEN Projek in Eclipse Editor
- Maak Eclipse oop
- Klik op Lêer. Kies nuwe projek.
- Kies Maven-projek
- Kies die Workspace-ligging.
- Kies die Archetype (gewoonlik kies ons " Maven-archetype-quickstart 1.1 " vir eenvoudige Maven-projekte).
- Voorsien die Groep ID & amp; die artefak-ID (ons het die volgende waardes in ons voorbeeld gebruik).
- Groep ID : Karate
- Artefak ID: KarateTestScriptsSample
- Klik op Voltooi om die opstelling.
#2) Sodra jy dit geskep het, sal jy nou die volgende struktuur in die Project Explorer-venster kan sien.
#3) Sluit al jou afhanklikhede in.
Ons heel eerste stap, na die opstelling sal ons al die afhanklikhede insluit wat vereis sal word vir die uitvoering. Ons sal al die merker onder die POM.xml hou (aangeneem dat jy reeds bewus is van die POM.xml-gebruik).
- Maak POM.xml oop en kopieer die onderstaande kode onder die afhanklikheidmerker en stoor die lêer.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Klik hier vir bron.
#4) Kom ons dinkskrum oor die scenario, waarin gaan ons toets