Dieses Tutorial ist eine Einführung in das Testen von APIs mit dem Karate Framework. Lernen Sie die Struktur des Karate Testskripts und die Schritte zur Erstellung des ersten Testskripts kennen:
API ist ein Akronym, das für Application Programming Interface (Anwendungsprogrammierschnittstelle) steht. Einfach ausgedrückt, kann man es als einen Softwarevermittler definieren, der die Kommunikation zwischen Anwendungen ermöglicht.
Wir brauchen API-Tests, weil:
- Die Ergebnisse werden schneller veröffentlicht, so dass nicht mehr gewartet werden muss, ob die API einwandfrei funktioniert.
- Durch die schnellere Reaktion wird auch die Bereitstellung dieser APIs beschleunigt, so dass eine kurze Durchlaufzeit möglich ist.
- Eine frühzeitige Fehlererkennung, noch bevor die Benutzeroberfläche der App erstellt ist, ermöglicht es uns, Risiken zu mindern und Fehler zu korrigieren.
- Lieferung in großem Umfang in kürzerer Zeit möglich.
Für das Testen von APIs stehen auf dem Markt verschiedene Tools wie Postman, Mocha und Chai zur Verfügung. Diese haben gute Ergebnisse und einen effektiven Einsatz für das Testen von APIs gezeigt, sind jedoch stark vom Code abhängig. Um sie zu nutzen, muss man technisch versiert und mit Programmiersprachen vertraut sein.
Das Karate-Framework löst dieses Problem der vorangegangenen Software-Tools auf wunderbare Weise.
Was ist Karate Framework
Karate? Reden wir über Karate. Ist es das aus Japan? Was denkst du? Vielleicht hat der große Bruce Lee das in seiner Freizeit entwickelt.
Obwohl wir uns gerne mit den interessanten Wurzeln des Karate befassen würden, wollen wir zunächst über die Karate-Werkzeug die entwickelt wurde von Peter Thomas eines der großartigen Werkzeuge, die API-Testern zur Hilfe kommen.
Das Karate-Framework folgt dem Cucumber-Stil beim Schreiben des Programms, der dem BDD-Ansatz folgt. Die Syntax ist auch für Nicht-Programmierer leicht zu verstehen. Und dieses Framework ist das einzige API-Testing-Tool, das API-Automatisierung und Performance-Tests in einem einzigen, eigenständigen Tool kombiniert.
Es bietet den Benutzern die Möglichkeit, die Testfälle parallel auszuführen und die JSON & XML-Prüfungen durchzuführen.
Anhand dieser Informationen lassen sich einige wichtige Punkte ableiten, um das Karatewerkzeug im Detail zu verstehen:
- Karate ist ein BDD-Testframework und kein TDD.
- Diese Funktion ist von entscheidender Bedeutung, da sie die Nutzung und den Zugang für viele Menschen unabhängig von ihrem technischen Hintergrund oder ihren Fähigkeiten erleichtert.
- Es nutzt die Cucumber-Feature-Datei und die Gherkins-Sprache, um den Test zu schreiben, der sehr einfach zu verstehen ist.
All diese Funktionen machen es zu einem der günstigsten Automatisierungswerkzeuge auf dem Markt.
Geschichte des Karate-Rahmens
Erstellt von ' Peter Thomas' Diese Software wurde 2017 entwickelt, um Testfunktionen für jedermann verfügbar zu machen. Sie wurde in Java geschrieben und die meisten Leute erwarteten, dass auch die Dateien in der gleichen Sprache sind.
Die Automatisierungssoftware ist eine Erweiterung von Cucumber und erbt daher die Verwendung von Gherkins-Dateien. Der große Unterschied zwischen den beiden ist, dass Karate beim Testen keine Java-Dateien verwendet, Cucumber hingegen schon.
Genau aus diesem Grund ist Karate auch für Nicht-Programmierer geeignet, da die Gherkins-Syntax sehr gut lesbar und umfassend ist. Aus diesem Grund ist Karate für den Einstieg in die Welt der automatisierten API-Tests bestens geeignet und empfehlenswert.
Im Folgenden finden Sie einige Merkmale des Karate Testing Framework:
- Verwendet die leicht verständliche Gherkins-Sprache.
- Es erfordert keine technischen Programmierkenntnisse wie Java.
- Es basiert auf den beliebten Cucumber-Standards.
- Es ist leicht, einen Rahmen zu schaffen.
- Paralleles Testen ist die Kernfunktionalität, die von Karate selbst bereitgestellt wird, daher brauchen wir nicht auf Maven, Gradle , usw.
- UI für die Fehlersuche im Test.
- Aufrufen einer Feature-Datei aus einer anderen Datei.
- Bietet Unterstützung für die Datentreiberprüfung, die intern entwickelt wird, sodass keine Abhängigkeit von externen Frameworks erforderlich ist.
- Eingebaute Native Rest Reports und die Möglichkeit der Integration mit Cucumber für bessere UI Reports und mehr Übersichtlichkeit.
- Bietet interne Unterstützung für die Umschaltung der Konfiguration in verschiedenen Testumgebungen (QA, Stage, Prod, Pre-Prod).
- Nahtlose Unterstützung für CI/CD-Integration, die nützlich sein kann.
- Kann verschiedene HTTP-Aufrufe verarbeiten:
- Web-Socket-Unterstützung
- SOAP-Anfrage
- HTTP
- Handhabung von Browser-Cookies
- HTTPS
- HTML-Formulardaten
- XML-Anfrage
Vergleich zwischen Karate und Rest-Assured
Garantierte Ruhe Es handelt sich um eine Java-basierte Bibliothek zum Testen von REST-Diensten. Sie verwendet die Java-Sprache zum Schreiben der Codezeilen. Sie hilft beim Testen zahlreicher Anforderungskategorien, was wiederum zur Überprüfung verschiedener Geschäftslogik-Kombinationen führt.
Karate Rahmen Ein auf Cucumber/Gherkins basierendes Tool, das für das Testen von SOAP & REST-Diensten verwendet wird.
In der folgenden Tabelle sind einige weitere wichtige Unterschiede zwischen Rest-Assured & Karate Framework aufgeführt:
| S.Nr. | Basis | Karate Rahmen | REST-gesichert |
|---|---|---|---|
| 1 | Sprache | Es wird eine Kombination aus Gurken und Gewürzgurken verwendet | Es nutzt die Java-Sprache |
| 2 | Code Größe | Normalerweise ist die Anzahl der Codezeilen geringer, da sie einer Cucumber-ähnlichen Struktur folgen | Die Anzahl der Codezeilen ist höher, da die Sprache Java verwendet wird. |
| 3 | Erforderliche technische Kenntnisse | Nicht-Programmierer können den Gherkins-Code leicht schreiben | Technische Kenntnisse sind erforderlich, um Java-Code zu schreiben |
| 4 | Datengesteuertes Testen | Verwendung von TestNG oder einer gleichwertigen Lösung zur Unterstützung desselben | Interne Tags können zur Unterstützung von Datentests verwendet werden |
| 5 | Bietet es Unterstützung für SOAP-Aufrufe | Ja, sie bietet | Sie bezieht sich nur auf eine REST-Anfrage |
| 6 | Parallele Prüfung | Ja, parallele Tests werden durch die parallele Berichterstellung ebenfalls problemlos unterstützt. | Das haben zwar schon viele versucht, aber die Misserfolgsquote ist höher als die Erfolgsquote. |
| 7 | Berichterstattung | Es bietet internes Reporting und ist daher nicht von externen Plugins abhängig. Wir können es sogar mit dem Cucumber Reporting Plugin für eine bessere Benutzeroberfläche integrieren. | Muss von externen Plugins wie Junit, TestNG abhängig sein |
| 8 | CSV-Unterstützung für externe Daten | Ja, ab Karate 0.9.0 | Nein, Sie müssen Java Code oder eine Bibliothek verwenden. |
| 9 | Web-UI-Automatisierung | Ja, ab Karate 0.9.5 ist Web-UI Automation möglich | Nein, es wird nicht unterstützt |
| 10 | Beispiel GET | Gegebener Parameter val1 = 'name1' | gegeben(). |
Wie die oben genannten Unterschiede zeigen, kann man also mit Sicherheit sagen, dass Karate eines der einfachsten Dinge ist, die jeder machen kann.
Für die Arbeit mit Karate Framework erforderliche Werkzeuge
Nachdem wir nun unser Grundwissen über das Karate-Framework auf den Punkt gebracht haben, wollen wir uns die Prozesse und Werkzeuge ansehen, die für die Einrichtung der Karate-Umgebung erforderlich sind.
#Nr. 1) Eklipse
Eclipse ist eine integrierte Entwicklungsumgebung, die im Bereich der Computerprogrammierung eingesetzt wird. Sie wird vor allem für die Java-Programmierung verwendet. Wie bereits erwähnt, ist Karate in Java geschrieben, so dass es mehr Sinn macht, warum Eclipse die bevorzugte IDE für die API-Test-Software ist. Ein weiterer Grund ist, dass es ein Open-Source-Tool ist, und das ist ein ziemlich starker Grund, sich für dieses Tool zu entscheiden.
Anmerkung: Wir könnten sogar IntelliJ, Visual Studio und andere auf dem Markt erhältliche Editoren verwenden.
#2) Maven
Dies ist ein Build-Automatisierungstool, das hauptsächlich für die Erstellung von Java-Projekten verwendet wird. Es ist eine Möglichkeit, eine Karate-Umgebung einzurichten und den Code zu schreiben. Um Ihr Eclipse mit den Maven-Anforderungen einzurichten, können Sie hier für die Maven-Installation klicken.
Wenn Sie in Maven arbeiten, verwenden Sie Maven-Abhängigkeiten, die Ihnen helfen, Karate Framework zu unterstützen.
Die folgenden Abhängigkeiten werden mit Maven in der pom.xml verwendet.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Anmerkung: Die neuesten Versionen sind möglicherweise im Maven-Repository verfügbar.
#3) Gradle
Gradle ist eine Alternative zu Maven und kann in gleicher Weise verwendet werden. Sie haben ihre Ähnlichkeiten und Unterschiede, können aber gleichermaßen für die Einrichtung einer Umgebung für unsere Karate-Codes verwendet werden.
Es ist einfacher zu bedienen, flexibel und wird empfohlen, wenn unsere Anwendung einige Modularisierungs- und Verwaltungsanforderungen mit einer Reihe von Plug-ins hat. Der Gradle-Setup-Code würde etwa so aussehen,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Anmerkung: Sie können entweder MAVEN oder GRADLE.
#4) Einrichtung der Java-Umgebung in Ihrem System
Sie müssen die JDK- und JRE-Umgebung einrichten, um mit den Karate-Framework-Skripten beginnen zu können.
Aufbau des Karate-Test-Skripts
Ein Karate-Testskript zeichnet sich dadurch aus, dass es die Endung ".feature" besitzt. Diese Eigenschaft wird von Cucumber geerbt. Die Organisation von Dateien nach Java-Konventionen ist ebenfalls erlaubt. Es steht Ihnen frei, Ihre Dateien nach den Konventionen der Java-Pakete zu organisieren.
Die Maven-Richtlinien sehen jedoch vor, dass die Speicherung von Nicht-Java-Dateien separat erfolgt. Sie werden in einem src/test/resources Und die Java-Dateien werden unter src/main/java .
Die Schöpfer des Karate Frameworks sind jedoch der Meinung, dass es viel einfacher ist, nach *.java und *.feature Dateien zu suchen, wenn sie zusammen aufbewahrt werden, anstatt der Standard-Maven-Struktur zu folgen, und dass wir Java- und Nicht-Java-Dateien nebeneinander aufbewahren sollten.
Dies kann ganz einfach geschehen, indem Sie Ihre pom.xml wie folgt anpassen (für Maven):
src/test/java **/*.java ...
Im Folgenden wird die allgemeine Struktur des Karate-Rahmenprogramms beschrieben:
Da dieses Karate-Framework die Runner-Datei verwendet, die auch in Cucumber benötigt wird, um die Feature-Dateien auszuführen, wird der größte Teil des Schreibens den Cucumber-Standards folgen.
Aber im Gegensatz zu Cucumber müssen die Schritte in Karate nicht klar definiert werden, was wiederum die Flexibilität und die Einfachheit der Operationen erhöht. Wir müssen nicht den zusätzlichen Klebstoff hinzufügen, den wir normalerweise hinzufügen müssen, wenn wir dem Cucumber-Framework folgen.
Die "Runner"-Klasse heißt in den meisten Fällen TestRunner.java.
Die Datei TestRunner.java hat dann die folgende Form:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } Und das Gespräch über die .feature Datei enthält alle Testszenarien, die getestet werden müssen, um sicherzustellen, dass die API gemäß den erwarteten Anforderungen funktioniert.
Eine allgemeine *.feature-Datei sieht etwa so aus wie unten dargestellt:
Funktion: Abrufen von Benutzerdetails Szenario: Testen des Abrufs von Benutzerdetails Gegebene Url '//reqres.in/api/users/2' Wenn Methode GET Dann Status 200
Das erste grundlegende Karate-Test-Skript erstellen
Dieser Abschnitt hilft Ihnen bei der Erstellung Ihres allerersten Testskripts, das Ihnen bei der Konvertierung von APIs in Form eines Karate-Frameworks behilflich sein wird.
Bevor wir die grundlegenden Karate-Testskripte schreiben, installieren Sie bitte die folgenden Voraussetzungen auf Ihrem Rechner:
- Eclipse-IDE
- Maven: Stellen Sie den entsprechenden Maven-Pfad ein.
- JDK & JRE: Stellen Sie den entsprechenden Pfad ein.
Schauen wir uns das schrittweise Vorgehen an:
#1) Erstellen Sie eine neue MAVEN Projekt im Eclipse-Editor
- Eclipse öffnen
- Klicken Sie auf Datei und wählen Sie Neues Projekt.
- Maven-Projekt auswählen
- Wählen Sie den Ort des Arbeitsbereichs.
- Wählen Sie den Archetyp (normalerweise wählen wir " Maven-archetype-quickstart 1.1 " für einfache Maven-Projekte).
- Geben Sie die Gruppen-ID & die Artefakt-ID an (wir haben in unserem Beispiel die folgenden Werte verwendet).
- Gruppen-ID Karate
- Artefakt-ID: KarateTestScriptsSample
- Klicken Sie auf Fertig stellen, um die Einrichtung abzuschließen.
#2) Nach der Erstellung sehen Sie nun im Projekt-Explorer-Fenster die folgende Struktur.
#3) Schließen Sie alle Ihre Abhängigkeiten ein.
Unser allererster Schritt nach der Einrichtung wird sein alle Abhängigkeiten einbeziehen Wir werden alle Tags in der POM.xml unterbringen (vorausgesetzt, Sie sind mit der Verwendung der POM.xml vertraut).
- Öffnen Sie die Datei POM.xml und kopieren Sie den folgenden Code unter das Abhängigkeitstag und speichern Sie die Datei.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Klicken Sie hier für die Quelle.
#4) Lassen Sie uns ein Brainstorming über das Szenario machen, was wir in diesem Karate Basic Test Script testen wollen.
Szenario:
Wir werden eine API mit dieser URL testen.
Pfad: api/users/2
Methode: GET
Und wir müssen validieren ob die Anfrage ein Erfolgscode (200) oder nicht.
Vereinfacht ausgedrückt, testen wir einfach eine Beispiel-API, um zu sehen, ob sie erfolgreich ausgeführt wird.
Anmerkung: Wir nehmen eine Beispiel-API, die zum Testen zur Verfügung steht. Sie können einen beliebigen PATH wählen oder auf Ihre API verweisen.
Klicken Sie hier für die Quelle.
#5) Unser nächster Schritt wäre nun die Erstellung einer .feature Datei.
Wie im Abschnitt "Einleitung" erläutert, ist die .feature Datei ist die Eigenschaft, die von Cucumber geerbt wurde. In dieser Datei werden wir die Testszenarien aufschreiben, die für die Durchführung der API-Tests ausgeführt werden müssen.
- Gehe zu Ordner src/test/java in Ihrem Projekt.
- Klicken Sie mit der rechten Maustaste darauf und erstellen Sie eine neue Datei - userDetails.feature. Klicken Sie dann auf die Schaltfläche Fertig stellen.
Jetzt sehen Sie die folgende Datei unter dem Ordner src/test/java
Die Grünes Symbol ähnelt dem .feature fi le in Cucumber, die wir gerade erstellt haben.
- Nachdem die Datei erstellt wurde, werden wir nun unsere Testszenarien schreiben, die im folgenden Abschnitt besprochen werden.
#6) Da wir das Szenario und den Rohling haben. Funktion Datei fertig, fangen wir mit unserem ersten Skript an. Beginnen wir mit der Codierung
Schreiben Sie die folgende Code-Zeile in die Datei userDetails.feature, die wir in Schritt 5 erstellt haben:
Funktion: Abrufen von Benutzerdetails Szenario: Testen des Abrufs von Benutzerdetails Gegebene Url '//reqres.in/api/users/2' Wenn Methode GET Dann Status 200
Versuchen wir, die Komponenten zu verstehen, die in der obigen Datei enthalten sind:
- Merkmal: Schlüsselwort erklärt den Namen der Funktion, die wir testen.
- Hintergrund: Dies ist ein optionaler Abschnitt, der wie ein Abschnitt "Voraussetzungen" behandelt wird. Hier kann festgelegt werden, was alles zum Testen der API erforderlich ist. Er enthält HEADER, URL & PARAM Optionen.
- Szenario: Jede Feature-Datei, die Sie sehen werden, enthält mindestens ein Feature (auch wenn es mehrere Es ist die Beschreibung des Testfalls.
- Gegeben: Es handelt sich um den Schritt, der vor jedem anderen Testschritt ausgeführt werden muss. Er ist eine zwingend auszuführende Aktion.
- Wann: Sie gibt die Bedingung an, die erfüllt sein muss, um den nächsten Prüfschritt durchzuführen.
- Dann: Sie sagt uns, was geschehen soll, wenn die in der Verordnung genannte Bedingung Wenn erfüllt ist.
Anmerkung: Alle oben genannten Schlüsselwörter stammen aus der Gherkins-Sprache und sind die Standardmethode zum Schreiben von Testskripten mit Cucumber.
Einige weitere Wörter, die in der Feature-Datei verwendet werden, sind:
- 200: Es ist der Status-/Antwortcode, den wir erwarten (Klicken Sie hier für die Liste der Statuscodes)
- GET: Es ist die API-Methode wie POST, PUT, etc.
Wir hoffen, dass diese Erklärung für Sie leicht verständlich war und Sie nun nachvollziehen können, was genau in der obigen Datei steht.
Nun müssen wir eine Datei TestRunner.java erstellen
Wie im obigen Abschnitt erläutert, benötigt Cucumber eine Runner-Datei, die zur Ausführung der .feature Datei, die die Testszenarien enthält.
- Gehe zu Ordner src/test/java in Ihrem Projekt
- Klicken Sie mit der rechten Maustaste darauf und erstellen Sie eine neue Java-Datei: TestRunner.java
- Sobald die Datei erstellt ist, fügen Sie die folgenden Codezeilen darunter ein:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner ist die Datei, die nun ausgeführt wird, um das gewünschte Szenario, das unter Schritt 5 geschrieben wurde, durchzuführen.
#7) Jetzt sind wir mit den beiden Dateien fertig TestRunner.Java und userDeatils.feature. Die einzige Aufgabe, die uns bleibt, ist Laufen lassen das Drehbuch.
- Gehen Sie zur Datei TestRunner.java und klicken Sie mit der rechten Maustaste auf die Datei, wie in der folgenden Abbildung gezeigt.
- Wählen Sie Ausführen als -> Junit Test
- Sobald Sie die Option ausgewählt haben, werden Sie feststellen, dass der Testfall nun gestartet wurde.
- Warten Sie, bis das Testskript ausgeführt wird. Sobald dies geschehen ist, sehen Sie in Ihrem Fenster etwas wie in der folgenden Abbildung dargestellt.
- Abschließend können wir sagen, dass wir unser erstes Basisprogramm erfolgreich erstellt haben Test-Skript unter Verwendung der Karate Framework.
#8) Schließlich bietet das Karate-Framework auch eine HTML-Berichtsdarstellung für die durchgeführte Ausführung.
- Gehen Sie zu Zielordner -> surefire-reports-> Hier sehen Sie Ihren HTML-Bericht, den Sie öffnen können.
** Wir empfehlen Ihnen auch, die Seite mit dem Chrome-Browser zu öffnen, um eine bessere Übersicht zu erhalten.
- Der folgende HTML-Bericht wird Ihnen angezeigt, der Folgendes zeigt Szenarien & Test die für das genannte Szenario ausgeführt wurde:
Schlussfolgerung
In diesem Tutorial haben wir das Testen von APIs, verschiedene auf dem Markt erhältliche Testtools und die Vorteile des Karate Frameworks im Vergleich zu seinen Pendants besprochen.
Wir sind Schritt für Schritt vorgegangen, um unser erstes grundlegendes Testskript zu erstellen. Wir begannen mit der Erstellung eines einfachen Maven-Projekt in der Eclipse IDE um eine .feature-Datei zu erstellen, die das gesamte Testszenario und eine Runner-Datei zur Ausführung des in der .feature-Datei genannten Testfalls enthält.
Am Ende der verschiedenen Schritte konnten wir den Ausführungsbericht der Testergebnisse sehen.
Wir hoffen, dass dieses Tutorial für Anfänger hilfreich war, um zu lernen, wie man sein erstes Testskript mit dem Karate Framework erstellt und API-Tests durchführt. Dieser detaillierte Schritt-für-Schritt-Ansatz ist ein wunderbarer Weg, um verschiedene Tests für die API auszuführen.
NEXT>>