Deze tutorial is een inleiding tot API Testing met behulp van Karate Framework. Leer over de structuur van Karate Test Script en stappen om het eerste testscript te bouwen:
API is een acroniem dat staat voor Application Programming Interface. Eenvoudig gezegd kunnen we het definiëren als een software-intermediair die communicatie tussen toepassingen mogelijk maakt.
We hebben API testen nodig omdat:
- Resultaten worden sneller gepubliceerd, dus niet meer wachten of de API goed werkt.
- Met de snellere respons wordt de inzet van deze API's ook sneller, waardoor een snelle doorlooptijd mogelijk wordt.
- Door vroege detectie van storingen, nog voordat de UI van de app is gemaakt, kunnen we risico's beperken en fouten corrigeren.
- Grootschalige levering mogelijk in een kortere periode.
Om aan API-tests te kunnen werken, zijn er verschillende tools op de markt, zoals Postman, Mocha en Chai. Deze hebben goede resultaten en effectief gebruik aangetoond voor het testen van API's, maar deze zijn sterk code-beïnvloed. Om deze te kunnen gebruiken, moet men technisch goed onderlegd zijn en vertrouwd met programmeertalen.
Het Karate Framework lost dit probleem van zijn voorgaande softwaretools prachtig op.
Wat is Karate Framework
Karate? Laten we het over karate hebben. Komt het uit Japan? Wat denk je? Misschien heeft de grote Bruce Lee dit in zijn vrije tijd ontwikkeld.
Hoewel we ons graag zouden verdiepen in de interessante wortels van Karate, laten we het nu hebben over de Karate gereedschap dat is ontwikkeld door Peter Thomas , een van de grote hulpmiddelen die API-testers te hulp schieten.
Karate framework volgt de Cucumber stijl voor het schrijven van het programma dat de BDD aanpak volgt. De syntax is gemakkelijk te begrijpen voor niet-programmeurs. En dit framework is de enige API test tool die API Automation en performance testing heeft gecombineerd in één standalone tool.
Het biedt de gebruikers de mogelijkheid om de testgevallen parallel uit te voeren en de JSON & XML controles uit te voeren.
Uit deze informatie kunnen bepaalde kernpunten worden afgeleid om het Karate-instrument verder in detail te begrijpen:
- Karate is een BDD-testraamwerk in plaats van een TDD.
- Het is ontworpen om gemakkelijk te zijn voor niet-programmeurs. Deze functie is een game-changer omdat het meer gebruik en toegang mogelijk maakt voor veel mensen, ongeacht hun technische achtergrond of capaciteit.
- Het maakt gebruik van de Cucumber feature file en de Gherkins taal om de test te schrijven die zeer eenvoudig te begrijpen is.
Al deze kenmerken maken het tot een van de meest gunstige automatiseringshulpmiddelen die vandaag beschikbaar zijn.
Geschiedenis van Karate Framework
Gemaakt door ' Peter Thomas' in 2017, heeft deze software tot doel testfunctionaliteiten gemakkelijk beschikbaar te maken voor iedereen. Het is geschreven in Java en de meeste mensen verwachtten dat de bestanden ook in dezelfde taal zouden zijn, maar dat is gelukkig niet het geval.
De automatiseringssoftware is een uitbreiding van Cucumber en erft daarom het gebruik van Gherkins-bestanden in zijn werking. Het grote verschil tussen de twee is dat Karate geen gebruik maakt van Java tijdens het testen, maar Cucumber wel.
Dit is precies de reden waarom het geschikt is voor niet-programmeurs, omdat de Gherkins syntaxis super leesbaar en uitgebreid is. Dit is de reden waarom Karate het meest geschikt en aanbevolen is voor het maken van een entree in de wereld van geautomatiseerd API testen.
Hieronder volgen enkele kenmerken van het Karate Testing Framework:
- Maakt gebruik van makkelijk te begrijpen Gherkins taal.
- Het vereist geen technische programmeerkennis zoals Java.
- Het is gebaseerd op de populaire komkommerstandaard.
- Makkelijk om een kader te creëren.
- Parallel testen is de kernfunctionaliteit die door Karate zelf wordt geleverd, dus we hoeven niet afhankelijk te zijn van Maven, Gradle enz.
- UI voor het debuggen van de Test.
- Een functiebestand aanroepen vanuit een ander bestand.
- Biedt ondersteuning voor de Data Driver Testing die intern wordt gebouwd, waardoor het niet nodig is afhankelijk te zijn van externe frameworks.
- Ingebouwde Native Rest Reports. Bovendien kan het worden geïntegreerd met Cucumber voor betere UI Reports en meer duidelijkheid.
- Biedt interne ondersteuning voor het omschakelen van de configuratie naar verschillende testomgevingen (QA, Stage, Prod, Pre-Prod).
- Naadloze ondersteuning voor CI/CD-integratie die nuttig kan zijn.
- In staat om verschillende HTTP-oproepen te behandelen:
- Web Socket ondersteuning
- SOAP verzoek
- HTTP
- Browser cookieverwerking
- HTTPS
- HTML-formuliergegevens
- XML verzoek
Karate vergelijken met Rest-Assured
Rust verzekerd : Het is een op Java gebaseerde bibliotheek om REST diensten te testen. Het gebruikt Java taal voor het schrijven van de regels code. Het helpt bij het testen van talrijke verzoek categorieën, die verder resulteert in de verificatie van verschillende business logica combinaties.
Karate kader : Een op Cucumber/Gherkins gebaseerde tool, gebruikt voor het testen van SOAP & REST diensten.
De volgende tabel geeft een overzicht van enkele meer prominente verschillen tussen Rest-Assured & Karate Framework:
| Nr. | Basis | Karate kader | REST verzekerd |
|---|---|---|---|
| 1 | Taal | Het gebruikt een combinatie van komkommer en augurken | Het maakt gebruik van Java-taal |
| 2 | Code Grootte | Meestal is de regel code minder, omdat het de Cucumber-achtige structuur volgt | Het aantal regels code is groter omdat er gebruik wordt gemaakt van Java. |
| 3 | Vereiste technische kennis | Niet-programmeurs kunnen gemakkelijk de code van Gherkins schrijven | Technische kennis is vereist om Java-code te schrijven |
| 4 | Datagestuurd testen | Moet gebruik maken van TestNG of gelijkwaardig om hetzelfde te ondersteunen | In-house tags kunnen worden gebruikt ter ondersteuning van het testen van gegevens |
| 5 | Biedt het ondersteuning voor SOAP-oproepen | Ja, het biedt | Het heeft alleen betrekking op een REST-verzoek |
| 6 | Parallel testen | Ja, parallel testen wordt ook gemakkelijk ondersteund door het parallel genereren van rapporten. | Niet in grote mate. Hoewel mensen dit hebben geprobeerd, is het mislukkingspercentage groter dan het succespercentage. |
| 7 | Rapportage | Het biedt in-house rapportage, dus hoeft niet afhankelijk te zijn van externe plugins. We kunnen het zelfs integreren met Cucumber rapportage plugin voor een betere UI. | Moet afhankelijk zijn van Externe Plugins zoals Junit, TestNG |
| 8 | CSV-ondersteuning voor externe gegevens | Ja, van Karate 0.9.0. | Nee, moet Java-code of bibliotheek gebruiken |
| 9 | Web UI Automatisering | Ja, vanaf Karate 0.9.5 is Web-UI Automation mogelijk. | Nee, het wordt niet ondersteund |
| 10 | Voorbeeld GET | Gegeven parameter val1 = "naam1 | gegeven(). |
Dus, zoals blijkt uit de bovenstaande verschillen, is het veilig om te zeggen dat Karate een van de gemakkelijkste dingen is die iedereen kan doen.
Hulpmiddelen die nodig zijn voor het werken met Karate Framework
Nu we onze basiskennis over Karate Framework op punt hebben staan, laten we eens kijken naar de processen en hulpmiddelen die nodig zijn voor het opzetten van de Karate-omgeving.
#1) Eclips
Eclipse is een Integrated Development Environment die gebruikt wordt op het gebied van computerprogrammering. Het wordt meestal gebruikt voor Java Programming. Zoals eerder vermeld, is Karate geschreven in Java, dus het is logisch dat Eclipse de go-to IDE is voor de API test software. Een andere reden is dat het een open-source tool is, en dit is een vrij sterke reden om voor deze tool te kiezen.
Let op: We zouden zelfs IntelliJ, Visual Studio en andere op de markt verkrijgbare editors kunnen gebruiken.
#2) Maven
Dit is een build automation tool die vooral gebruikt wordt voor het bouwen van Java projecten. Het is een manier om een Maven omgeving op te zetten en de code te schrijven. Om je Eclipse in te stellen met Maven vereisten, kan je hier klikken voor Maven installatie.
Als je in Maven werkt, gebruik dan Maven afhankelijkheden die je helpen om Karate Framework te ondersteunen.
De volgende afhankelijkheden worden gebruikt met Maven in pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Let op: De laatste versies kunnen beschikbaar zijn in de Maven repository.
#3) Gradle
Gradle is een alternatief voor Maven en kan in gelijke mate worden gebruikt. Ze hebben hun overeenkomsten en verschillen, maar kunnen in gelijke mate worden gebruikt bij het opzetten van een omgeving voor onze Karate codes.
Het is gemakkelijker te gebruiken, flexibel, en wordt aanbevolen om te gebruiken wanneer onze toepassing wat modularisatie en beheer vereisten heeft met een hoop plug-ins. De Gradle setup code zou er ongeveer zo uitzien,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Let op: U kunt ofwel MAVEN of GRADLE.
#4) Java-omgeving instellen in uw systeem
Moet de JDK en JRE omgeving instellen om aan de slag te gaan met de Karate Framework scripts.
Structuur van Karate Test Script
Een Karate test script is bekend om het bezit van de ".feature" extensie. Deze eigenschap is geërfd van Cucumber. De organisatie van bestanden in Java conventie is ook toegestaan. U bent vrij om uw bestanden te organiseren volgens de Java package conventies.
De Maven richtlijnen geven echter de opdracht om de opslag van niet-Java bestanden apart te doen. Ze worden gedaan in een src/test/bronnen structuur. En de Java-bestanden worden bewaard onder src/main/java .
Maar volgens de makers van het Karate Framework, geloven ze sterk dat we zowel Java als niet-Java bestanden naast elkaar moeten houden. Volgens hen is het veel gemakkelijker om uit te kijken naar de *.java en *.feature bestanden als ze samen worden gehouden, in plaats van de standaard Maven structuur te volgen.
Dit kan gemakkelijk gedaan worden door je pom.xml als volgt aan te passen (voor Maven):
src/test/java **/*.java ...
Hieronder volgt een overzicht van de algemene structuur van Karate Framework:
Nu, aangezien dit Karate Framework het Runner-bestand gebruikt, dat ook nodig is in Cucumber om de feature-bestanden uit te voeren, zal het meeste schrijfwerk de Cucumber-standaarden volgen.
Maar, in tegenstelling tot Cucumber, vereisen de stappen geen duidelijke definitie in Karate en dat verhoogt dan weer de flexibiliteit en het gebruiksgemak. We hoeven niet de extra lijm toe te voegen die we gewoonlijk moeten toevoegen wanneer we het Cucumber raamwerk volgen.
De "Runner"-klasse heet meestal TestRunner.java.
Dan krijgt het bestand TestRunner.java de vorm van:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } En praten over de .feature bestand, bevat alle testscenario's die moeten worden getest om er zeker van te zijn dat de API werkt volgens de verwachte vereisten.
Een algemeen *.feature bestand ziet er ongeveer zo uit als hieronder:
Kenmerk: ophalen van gebruikersdetails Scenario: testen van de get call voor gebruikersdetails Gegeven url '//reqres.in/api/users/2' Wanneer methode GET Dan status 200
De eerste basis Karate Test Script maken
Dit gedeelte helpt je op weg met het maken van je allereerste Test Script.
Voordat we de basis Karate-testscripts schrijven, moet u de volgende benodigdheden op uw machine installeren:
- Eclipse IDE
- Maven. Stel het juiste Maven pad in.
- JDK & JRE. Stel het juiste pad in.
Laten we eens kijken naar de stapsgewijze aanpak:
#1) Maak een nieuwe MAVEN Project in Eclipse-editor
- Open Eclipse
- Klik op Bestand. Selecteer Nieuw Project.
- Selecteer Maven Project
- Kies de locatie van de werkruimte.
- Selecteer het Archetype (meestal kiezen we " Maven-archetype-quickstart 1.1 " voor eenvoudige Maven projecten).
- Geef de Groep ID & de Artifact ID (wij hebben de volgende waarden gebruikt in ons voorbeeld).
- Groep ID : Karate
- Artefact ID: KarateTestScriptsSample
- Klik op Voltooien om de installatie te voltooien.
#2) Eenmaal gecreëerd, ziet u nu de volgende structuur in het Project Explorer-venster.
#3) Neem al uw afhankelijkheden op.
Onze allereerste stap, na de instelling, is om omvat alle afhankelijkheden die nodig zijn voor de uitvoering. We houden alle tags onder de POM.xml (aangenomen dat u al op de hoogte bent van het gebruik van POM.xml).
- Open POM.xml en kopieer onderstaande code onder de afhankelijkheidstag en sla het bestand op.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Klik hier voor de bron.
#4) Laten we het scenario brainstormen, wat gaan we testen in dit Karate Basis Test Script.
Scenario:
We gaan een API testen met deze URL.
Pad: api/gebruikers/2
Methode: GET
En we moeten valideren , of het verzoek een Succescode (200) of niet.
Eenvoudig gezegd gaan we gewoon een voorbeeld-API testen om te zien of hij al dan niet met succes wordt uitgevoerd.
Let op: We nemen een voorbeeld-API die beschikbaar is om te testen. U zou een willekeurig PATH kunnen kiezen of kunnen verwijzen naar uw API.
Klik hier voor de bron.
#5) Nu zou onze volgende stap zijn om een .feature bestand.
Zoals besproken in de inleiding, is de .feature bestand is de eigenschap die is geërfd van Cucumber. In dit bestand schrijven we de testscenario's uit die moeten worden uitgevoerd voor het uitvoeren van de API-test.
- Ga naar de map src/test/java in uw project.
- Rechtsklik erop en maak een nieuw bestand aan - userDetails.feature. Klik dan op de knop Voltooien.
Nu ziet u het volgende bestand onder de map src/test/java
De Groen gekleurd pictogram lijkt op de .feature fi le in Cucumber die we net gemaakt hebben.
- Zodra het bestand is aangemaakt, gaan we nu onze testscenario's schrijven die in het volgende hoofdstuk worden besproken.
#6) Aangezien we het scenario en de lege . functie bestand klaar, laten we nu beginnen met ons eerste script. Laten we beginnen met coderen
Schrijf de volgende regel code onder userDetails.feature bestand dat we in stap #5 hebben gemaakt:
Kenmerk: ophalen van gebruikersdetails Scenario: testen van de get call voor gebruikersdetails Gegeven url '//reqres.in/api/users/2' Wanneer methode GET Dan status 200
Laten we proberen de onderdelen die in het bovenstaande bestand staan te begrijpen:
- Eigenschap: Sleutelwoord verklaart de naam van de functie die we testen.
- Achtergrond: Dit is een optionele sectie die wordt behandeld als een Pre-requisite sectie. Deze kan worden gebruikt om te definiëren wat er allemaal nodig is om de API te testen. Het bevat HEADER, URL & PARAM opties.
- Scenario: Elk bestand met kenmerken dat u zult zien, bevat ten minste één kenmerk (hoewel het kan geven meerdere scenario's). Het is de beschrijving van het testgeval.
- Gegeven: Het is de stap die moet worden uitgevoerd voordat een andere teststap wordt uitgevoerd. Het is een verplichte actie die moet worden uitgevoerd.
- Wanneer: Het specificeert de voorwaarde waaraan moet worden voldaan om de volgende teststap uit te voeren.
- Dan: Het vertelt ons dat wat er moet gebeuren als de voorwaarde genoemd in de Wanneer is voldaan.
Let op: Alle bovengenoemde sleutelwoorden komen uit de Gherkins taal. Dit is de standaard manier om testscripts te schrijven met Cucumber.
En enkele andere woorden die in het functiebestand worden gebruikt zijn:
- 200: Het is de status/antwoordcode die we verwachten (Klik hier voor de lijst van statuscodes)
- GET: Het is de API-methode zoals POST, PUT, enz.
Wij hopen dat deze uitleg voor u gemakkelijk te begrijpen was. Nu zult u in staat zijn te begrijpen wat er precies in het bovenstaande bestand staat.
Nu moeten we een bestand TestRunner.java maken
Zoals uitgelegd in de bovenstaande sectie, heeft Cucumber een Runner-bestand nodig dat de .feature bestand dat de testscenario's bevat.
- Ga naar de map src/test/java in uw project
- Rechtsklik erop en maak een Nieuw Java bestand: TestRunner.java
- Zodra het bestand is aangemaakt, plaats de volgende regels code eronder:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner is het bestand dat nu zal worden uitgevoerd om het gewenste scenario uit te voeren dat is geschreven onder Stap #5.
#7) Nu zijn we klaar met beide bestanden TestRunner.Java en userDeatils.feature. De enige taak die ons nog rest is Ren het script.
- Ga naar het bestand TestRunner.java en klik met de rechtermuisknop op het bestand zoals in de onderstaande afbeelding.
- Kies Uitvoeren als -> Junit Test
- Zodra u dit hebt geselecteerd, zult u zien dat het testgeval nu is gestart.
- Wacht tot het testscript is uitgevoerd. Als dat is gebeurd, ziet u iets als in de onderstaande afbeelding in uw venster.
- Eindelijk kunnen we zeggen dat we met succes onze eerste basis Test Script met behulp van de Karate Framework.
#8) Ten slotte geeft het Karate-kader ook een HTML-rapport over de uitgevoerde uitvoering.
- Ga naar Doelmap -> surefire-reports-> Hier ziet u uw HTML-rapport dat u kunt openen.
** We raden u ook aan dezelfde te openen met de Chrome-browser voor een betere weergave.
- Het volgende HTML-rapport wordt u getoond met de volgende afbeeldingen Scenario's & Test die is uitgevoerd voor het genoemde scenario:
Conclusie
In deze tutorial hebben we het testen van API's besproken, verschillende testtools die op de markt beschikbaar zijn, en hoe het Karate Framework een betere optie is dan zijn tegenhangers.
We hebben een stapsgewijze aanpak gevolgd om ons eerste basistestscript te maken. We begonnen met het maken van een basis Maven project in Eclipse IDE om een .feature-bestand te maken, dat al het testscenario bevat en een Runner-bestand om de in het .feature-bestand genoemde testcase uit te voeren.
Aan het eind van de verschillende stappen konden we het uitvoeringsrapport van de testresultaten zien.
We hopen dat deze tutorial nuttig was voor de beginners om te leren hoe ze hun eerste testscript met het Karate Framework kunnen bouwen en API-tests kunnen uitvoeren. Deze gedetailleerde stap-voor-stap aanpak is een prachtige manier om verschillende tests op de API uit te voeren.
Volgende;