Den här handledningen är en introduktion till API-testning med hjälp av Karate Framework. Lär dig mer om strukturen i Karate Test Script och steg för att bygga det första testskriptet:
API är en akronym som står för Application Programming Interface (API) och kan enkelt uttryckt definieras som en mjukvarumellanhand som möjliggör kommunikation mellan program.
Vi behöver API-testning eftersom:
- Resultaten publiceras snabbare, vilket innebär att du inte längre behöver vänta på att se om API:et fungerar bra.
- Med det snabbare svaret blir också distributionen av dessa API:er snabbare, vilket ger en snabb omställningstid.
- Genom att upptäcka fel i ett tidigt skede, till och med innan appens användargränssnitt har skapats, kan vi minska riskerna och korrigera fel.
- Stora leveranser är möjliga på kortare tid.
För att kunna arbeta med API-testning finns det olika verktyg på marknaden som Postman, Mocha och Chai. Dessa har visat goda resultat och effektiv användning för testning av API:er, men de är starkt kodinfluerade. För att kunna använda dem måste man vara tekniskt kunnig och bekant med programmeringsspråk.
Karate Framework löser detta problem på ett utmärkt sätt i sina tidigare programvaruverktyg.
Vad är Karate Framework
Karate? Låt oss tala om karate. Är det den från Japan? Vad tror du? Det kan vara så att den store Bruce Lee utvecklade den på sin fritid.
Även om vi skulle vilja fördjupa oss i Karates intressanta rötter, låt oss för tillfället prata om Karate. Karate-verktyg som har utvecklats av Peter Thomas , ett av de stora verktygen som kommer API-testare till undsättning.
Karate-ramverket följer Cucumber-stilen för att skriva programmet som följer BDD-metoden. Syntaxen är lätt att förstå för icke-programmerare. Detta ramverk är det enda API-testverktyget som har kombinerat API-automatisering och prestandatestning i ett enda fristående verktyg.
Den ger användarna möjlighet att utföra testfallen parallellt och utföra JSON- och XML-kontroller.
Med hjälp av denna information kan man dra slutsatser om vissa viktiga punkter för att förstå Karate-verktyget i detalj:
- Karate är en BDD-testram istället för TDD.
- Den är utformad för att vara enkel att använda för icke-programmerare, vilket är en viktig förändring eftersom den gör det möjligt för många människor att använda den och få tillgång till den, oavsett deras tekniska bakgrund eller kapacitet.
- Den använder sig av Cucumbers funktionsfil och Gherkins-språket för att skriva testet, vilket är mycket lätt att förstå.
Alla dessa funktioner gör det till ett av de mest fördelaktiga automatiseringsverktygen som finns tillgängliga idag.
Karate ramverkets historia
Skapad av ' Peter Thomas' Den skrevs i Java och de flesta förväntade sig att filerna skulle vara på samma språk, men lyckligtvis är det inte fallet.
Den använder snarare Gherkins-filer, vilket är ett resultat av dess förhållande till Cucumber-ramverket. Automatiseringsprogrammet är en förlängning av Cucumber och ärver därför användningen av Gherkins-filer i sin verksamhet. Den stora skillnaden mellan de två är att Karate inte använder sig av Java vid testning, vilket Cucumber gör.
Detta är anledningen till att Karate passar icke programmerare eftersom Gherkins syntax är mycket lättläst och omfattande. Detta är anledningen till att Karate är mest lämplig och rekommenderas för att komma in i en värld av automatiserad API-testning.
Följande är några av funktionerna i Karate Testing Framework:
- Använder ett lättförståeligt Gherkins-språk.
- Det kräver inga tekniska programmeringskunskaper som Java.
- Den är baserad på den populära Cucumber-standarden.
- Det är lätt att skapa ett ramverk.
- Parallell testning är en kärnfunktionalitet som tillhandahålls av Karate självt, och vi behöver därför inte vara beroende av Maven, Gradle , etc.
- Användargränssnitt för felsökning av testet.
- Kalla en funktionsfil från en annan fil.
- Ger stöd för testning av datadrivrutiner som byggs internt, vilket innebär att man inte behöver vara beroende av externa ramverk.
- Inbyggda Native Rest Reports. Dessutom kan den integreras med Cucumber för bättre UI-rapporter och större tydlighet.
- Ger internt stöd för konfigurering av växlar i olika testmiljöer (QA, Stage, Prod, Pre-Prod).
- Sömlöst stöd för CI/CD-integration som kan vara användbart.
- Kan hantera olika HTTP-samtal:
- Stöd för Web Socket
- SOAP-förfrågan
- HTTP
- Hantering av kakor i webbläsaren
- HTTPS
- Uppgifter i HTML-formulär
- XML-förfrågan
Jämförelse mellan Karate och Rest-Assured
Vila tryggt : Det är ett Java-baserat bibliotek för att testa REST-tjänster. Det använder Java-språket för att skriva kodraderna. Det hjälper till att testa många förfrågningskategorier, vilket vidare resulterar i verifiering av olika kombinationer av affärslogik.
Karate ramverk : Ett Cucumber/Gherkins-baserat verktyg som används för testning av SOAP- och REST-tjänster.
Följande tabell visar några mer framträdande skillnader mellan Rest-Assured & Karate Framework:
| S.nr | Grundläggande | Karate ramverk | REST-säkrad |
|---|---|---|---|
| 1 | Språk | Den använder en kombination av gurka och gurka. | Den använder sig av Java-språket |
| 2 | Kod Storlek | Vanligtvis är kodraden mindre, eftersom den följer en Cucumber-liknande struktur. | Kodraden är större eftersom det handlar om användning av Java-språket. |
| 3 | Tekniska kunskaper krävs | Icke-programmerare kan enkelt skriva gurkkoden. | Tekniska kunskaper krävs för att skriva Java-kod |
| 4 | Datadriven testning | Behöver använda TestNG eller motsvarande för att stödja samma sak. | Interna taggar kan användas för att stödja datatestning. |
| 5 | Har den stöd för SOAP-samtal? | Ja, det ger | Den är endast relaterad till en REST-förfrågan |
| 6 | Parallell testning | Ja, parallell testning stöds enkelt med parallell rapportgenerering. | Inte i någon större utsträckning. Även om människor har försökt göra detta, är misslyckandet större än framgången. |
| 7 | Rapportering | Den tillhandahåller intern rapportering och behöver därför inte vara beroende av externa plugins. Vi kan även integrera den med Cucumber-rapporteringsplugin för bättre användargränssnitt. | Behöver vara beroende av externa plugins som Junit, TestNG |
| 8 | CSV-stöd för externa data | Ja, från Karate 0.9.0 | Nej, du måste använda Java-kod eller bibliotek |
| 9 | Automatisering av användargränssnittet på webben | Ja, från Karate 0.9.5 är det möjligt att automatisera Web-UI Automation. | Nej, det stöds inte |
| 10 | Exempel GET | Givet param val1 = 'name1' | given(). |
Som framgår av skillnaderna ovan kan man säga att karate är en av de enklaste sakerna som vem som helst kan göra.
Verktyg som krävs för att arbeta med Karate Framework
Nu när vi har fått våra grundläggande kunskaper om Karate Framework på plats kan vi titta på de processer och verktyg som krävs för att inrätta Karate-miljön.
#1) Eclipse
Eclipse är en integrerad utvecklingsmiljö som används inom dataprogrammering. Den används främst för Java-programmering. Som tidigare nämnts är Karate skrivet i Java, så det är mer logiskt varför Eclipse är den bästa IDE:n för API-testprogramvaran. Ett annat skäl är att det är ett verktyg med öppen källkod, och det är ett ganska starkt skäl att välja detta verktyg.
Observera: Vi kan även använda IntelliJ, Visual Studio och andra olika redigerare som finns på marknaden.
#2) Maven
Detta är ett verktyg för att automatisera byggandet som främst används för att bygga Java-projekt. Det är ett sätt att skapa en Karate-miljö och skriva koden. För att ställa in Eclipse med Maven-krav kan du klicka här för Maven-installation.
När du arbetar i Maven kan du använda Maven-beroenden som hjälper dig att stödja Karate Framework.
Följande beroenden kommer att användas med Maven i pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate karate-junit4 0.9.5 test
Observera: De senaste versionerna kan finnas tillgängliga i Maven-förrådet.
#3) Gradle
Gradle är ett alternativ till Maven och kan användas på samma sätt som Maven. De har sina likheter och skillnader men kan användas på samma sätt för att skapa en miljö för våra Karate-koder.
Det är lättare att använda, flexibelt och rekommenderas när vår applikation har vissa krav på modularisering och hantering med en massa plug-ins. Koden för Gradle-installationen skulle se ut ungefär så här,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Observera: Du kan antingen använda MAVEN eller . GRADERING.
#4) Java Environment setup i ditt system
Du måste konfigurera JDK- och JRE-miljön för att komma igång med Karate Framework-skripten.
Strukturen för Karate Test Script
Ett Karate-testskript är känt för att det har tillägget ".feature". Denna egenskap ärvs från Cucumber. Det är också tillåtet att organisera filerna enligt Java-konventioner. Du kan organisera dina filer enligt Java-paketkonventionerna.
I Maven-riktlinjerna anges dock att lagring av filer som inte är Java-filer ska ske separat. De lagras i en src/test/resurser struktur. Och Java-filerna finns under src/main/java .
Men enligt skaparna av Karate Framework är de övertygade om att vi bör ha både Java- och icke-Java-filer sida vid sida. Enligt dem är det mycket lättare att leta efter *.java- och *.feature-filer när de hålls tillsammans, än att följa Maven-standardstrukturen.
Detta kan enkelt göras genom att justera din pom.xml på följande sätt (för Maven):
src/test/java **/*.java ...
Nedan följer den allmänna strukturen för Karate Framework:
Eftersom Karate Framework använder Runner-filen, som också behövs i Cucumber för att köra funktionsfilerna, kommer det mesta av skrivandet att följa Cucumber-standarderna.
Men till skillnad från Cucumber kräver inte stegen någon tydlig definition i Karate, vilket i sin tur ökar flexibiliteten och underlättar verksamheten. Vi behöver inte lägga till det extra klister som vi vanligtvis måste lägga till när vi följer Cucumber-ramverket.
Klassen "Runner" heter för det mesta TestRunner.java.
Filen TestRunner.java kommer då att ha följande form:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } Och när man talar om den .funktion filen innehåller alla testscenarier som måste testas för att se till att API:et fungerar enligt de förväntade kraven.
En vanlig *.feature-fil ser ut ungefär som nedan:
Funktion: hämta användaruppgifter Scenario: testa hämta anropet för användaruppgifter Givet url '//reqres.in/api/users/2' När metod GET Då status 200
Skapa det första grundläggande Karate-testskriptet
Det här avsnittet hjälper dig att komma igång med skapandet av ditt allra första testskript, som kommer att hjälpa dig att konvertera API:er i form av ett Karate-ramverk.
Innan vi skriver de grundläggande Karate-testskripten bör du installera följande krav på din dator:
- Eclipse IDE
- Maven. Ange lämplig Maven-sökväg.
- JDK & JRE. Ange lämplig sökväg.
Låt oss ta en titt på hur du går tillväga steg för steg:
#1) Skapa en ny MAVEN Projekt i Eclipse Editor
- Öppna Eclipse
- Klicka på File (fil) och välj New Project (nytt projekt).
- Välj Maven-projekt
- Välj arbetsutrymmets plats.
- Välj arketyp (vanligtvis väljer vi " Maven-archetype-quickstart 1.1 "för enkla Maven-projekt).
- Ange grupp-ID & artefakt-ID (vi har använt följande värden i vårt exempel).
- Gruppens ID : Karate
- Artefakt-ID: KarateTestScriptsExempel
- Klicka på Slutför för att slutföra installationen.
#2) När den har skapats kan du se följande struktur i fönstret Project Explorer.
#3) Ta med alla dina beroenden.
Vårt första steg efter installationen är att inkludera alla beroenden Vi kommer att hålla alla taggar under POM.xml (förutsatt att du redan känner till användningen av POM.xml).
- Öppna POM.xml och kopiera nedanstående kod under beroendemarkeringen och spara filen.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate karate-junit4 0.9.5 test
Klicka här för att komma till källan.
#4) Låt oss brainstorma scenariot, vad ska vi testa i detta Karate Basic Test Script.
Scenario:
Vi kommer att testa ett API med denna URL.
Stigen: api/användare/2
Metod: GET
Och vi måste validera , om begäran returnerar en Kod för framgång (200) eller inte.
Enkelt uttryckt ska vi bara testa ett exempel-API för att se om det utförs framgångsrikt eller inte.
Observera: Vi använder ett exempel API som är tillgängligt för testning. Du kan välja vilken PATH som helst eller hänvisa till ditt API.
Klicka här för att komma till källan.
#5) Nästa steg är att skapa en .funktion fil.
Såsom diskuterades i inledningsavsnittet, är .feature-fil är den egenskap som ärvts från Cucumber. I den här filen skriver vi ut de testscenarier som måste utföras för att utföra API-testningen.
- Gå till mapp src/test/java i ditt projekt.
- Högerklicka på den och skapa en ny fil - userDetails.feature. Klicka sedan på knappen Slutför.
Nu kommer du att se följande fil i mappen src/test/java
Grön ikon liknar den .feature fi le i Cucumber som vi just har skapat.
- När filen har skapats ska vi nu skriva våra testscenarier som kommer att diskuteras i följande avsnitt.
#6) Eftersom vi har scenariot och den tomma blanketten . funktion Filen är klar, låt oss nu börja med vårt första skript. Låt oss börja koda
Skriv följande kodrad i filen userDetails.feature som vi skapade i steg 5:
Funktion: hämta användaruppgifter Scenario: testa hämta anropet för användaruppgifter Givet url '//reqres.in/api/users/2' När metod GET Då status 200
Låt oss försöka förstå de komponenter som finns skrivna i ovanstående fil:
- Funktion: Nyckelordet förklarar namnet på den funktion som vi testar.
- Bakgrund: Detta är ett valfritt avsnitt som behandlas som ett avsnitt om förutsättningar. Det kan användas för att definiera vad som krävs för att testa API:et. Det innehåller följande HEADER, URL & PARAM alternativ.
- Scenario: Varje feature-fil som du kommer att se kommer att innehålla minst en feature (även om den kan ge flera Det är en beskrivning av testfallet.
- Givetvis: Det är det steg som måste utföras innan något annat teststeg utförs. Det är en obligatorisk åtgärd som måste utföras.
- När: Den anger det villkor som ska uppfyllas för att nästa teststeg ska kunna utföras.
- Då: Den talar om vad som ska hända om det villkor som nämns i När är uppfyllt.
Observera: Alla dessa nyckelord kommer från språket Gherkins och är standardmetoder för att skriva testskript med Cucumber.
Några andra ord som används i featurefilen är:
- 200: Det är den status/responskod som vi förväntar oss (klicka här för en lista över statuskoder).
- GET: Det är API-metoden som POST, PUT osv.
Vi hoppas att den här förklaringen var lätt att förstå för dig och att du nu kan förstå vad som står i filen ovan.
Nu måste vi skapa en TestRunner.java-fil.
Som förklarats i avsnittet ovan behöver Cucumber en Runner-fil som krävs för att utföra .funktion filen som innehåller testscenarierna.
- Gå till mapp src/test/java i ditt projekt
- Högerklicka på den och skapa en ny Java-fil: TestRunner.java
- När filen har skapats, placera följande rader kod under den:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner är den fil som nu kommer att exekveras för att utföra det önskade scenariot som har skrivits i steg 5.
#7) Nu är vi redo med båda filerna TestRunner.Java och userDeatils.feature. Den enda uppgift som återstår för oss är att Kör manuskriptet.
- Gå till filen TestRunner.java och högerklicka på filen enligt bilden nedan.
- Välj Kör som -> Junit Test
- När du väl har valt det kommer du att märka att testfallet har startat.
- Vänta på att testskriptet ska köras. När det är gjort kommer du att se något som visas i nedanstående bild i fönstret.
- Slutligen kan vi konstatera att vi har lyckats skapa vår allra första grundläggande Testskript med hjälp av Karate ramverk.
#8) Slutligen ger Karate-ramverket också en HTML-rapport som presenterar den utförda exekveringen.
- Gå till målmappen -> surefire-reports-> Här ser du din HTML-rapport som du kan öppna.
** Vi föreslår också att du öppnar den i webbläsaren Chrome för att få ett bättre utseende och en bättre känsla.
- Följande HTML-rapport kommer att visas för dig med följande information Scenarier & Test som har utförts för det nämnda scenariot:
Slutsats
I den här handledningen har vi diskuterat API-testning, olika testverktyg som finns på marknaden och hur Karate Framework är ett bättre alternativ jämfört med sina motsvarigheter.
Vi följde en steg-för-steg-metod för att skapa vårt första grundläggande testskript. Vi började med att skapa en grundläggande Maven-projekt i Eclipse IDE för att skapa en .feature-fil som innehåller alla testscenarier och en Runner-fil för att utföra de testfall som nämns i .feature-filen.
I slutet av de många stegen kan vi se en rapport om testresultaten.
Vi hoppas att den här handledningen var till hjälp för nybörjare som vill lära sig att bygga sitt första testskript med Karate Framework och utföra API-testning. Denna detaljerade steg-för-steg-metod är ett utmärkt sätt att köra och utföra olika tester på API:et.
NEXT>>