Tento tutoriál je úvodem do testování API pomocí frameworku Karate. Dozvíte se o struktuře testovacího skriptu Karate a krocích pro sestavení prvního testovacího skriptu:
API je zkratka, která znamená Application Programming Interface (rozhraní pro programování aplikací). Zjednodušeně jej můžeme definovat jako softwarového prostředníka, který umožňuje komunikaci mezi aplikacemi.
Testování API potřebujeme, protože:
- Výsledky jsou zveřejňovány rychleji, a proto již nemusíte čekat, zda rozhraní API funguje správně.
- Díky rychlejší odezvě se zrychluje i nasazení těchto rozhraní API, což umožňuje zrychlit dobu realizace.
- Včasné odhalení chyb, ještě před vytvořením uživatelského rozhraní aplikace, nám umožňuje zmírnit rizika a odstranit chyby.
- Dodávka ve velkém rozsahu je možná v kratší době.
Abychom mohli pracovat na testování API, máme na trhu k dispozici různé nástroje, jako jsou Postman, Mocha a Chai. Ty prokázaly dobré výsledky a efektivní použití pro testování API, nicméně jsou silně ovlivněny kódem. Abyste je mohli používat, musíte být technicky zdatní a znát programovací jazyky.
Karate Framework tento problém svých předchozích softwarových nástrojů skvěle řeší.
Co je karate Framework
Karate? Mluvme o karate. Je to to japonské? Co myslíte? Možná ho ve volném čase vyvinul velký Bruce Lee.
Ačkoli bychom se chtěli ponořit do zajímavých kořenů karate, nyní si povíme něco o tom. Nástroj karate který byl vyvinut společností Peter Thomas , jeden ze skvělých nástrojů, který přichází na pomoc testerům API.
Framework Karate se řídí stylem zápisu programu Cucumber, který se řídí přístupem BDD. Syntaxe je snadno pochopitelná i pro neprogramátory. A tento framework je jediným nástrojem pro testování API, který spojil automatizaci API a testování výkonu do jednoho samostatného nástroje.
Poskytuje uživatelům možnost paralelního provádění testovacích případů a provádění kontrol JSON & amp; XML.
Z těchto informací lze odvodit některé klíčové body, které umožní podrobněji pochopit nástroj karate:
- Karate je testovací framework BDD namísto TDD.
- Je navržen tak, aby byl snadný i pro neprogramátory. Tato funkce mění pravidla hry, protože umožňuje větší využití a přístup mnoha lidem bez ohledu na jejich technické zázemí nebo schopnosti.
- K zápisu testu využívá soubor funkcí Cucumberu a jazyk Gherkins, který je velmi srozumitelný.
Všechny tyto funkce z něj činí jeden z nejvýhodnějších automatizačních nástrojů současnosti.
Historie karate Rámec
Vytvořil Peter Thomas' v roce 2017, si tento software klade za cíl zpřístupnit testovací funkce snadno všem. Byl napsán v Javě a většina lidí očekávala, že i jeho soubory budou ve stejném jazyce, naštěstí tomu tak ale není.
Používá spíše soubory Gherkins, což vyplývá z jeho vztahu s frameworkem Cucumber. Automatizační software je rozšířením Cucumberu, proto dědí používání souborů Gherkins při své činnosti. Velký rozdíl mezi nimi je v tom, že Karate při testování nepoužívá Javu, ale Cucumber ano.
Právě z tohoto důvodu je určen pro neprogramátory, protože syntaxe Gherkins je velmi čitelná a srozumitelná. To je důvod, proč je Karate nejvhodnější a doporučovaný pro vstup do světa automatizovaného testování API.
Následují některé funkce frameworku Karate Testing Framework:
- Používá srozumitelný jazyk Gherkins.
- Nevyžaduje žádné technické znalosti programování jako Java.
- Vychází z oblíbených standardů Cucumber.
- Snadné vytvoření rámce.
- Paralelní testování je základní funkcí, kterou poskytuje samotný Karate, a proto nemusíme být závislí na. Maven, Gradle , atd.
- Uživatelské rozhraní pro ladění testu.
- Volání souboru funkcí z jiného souboru.
- Poskytuje podporu pro testování datových ovladačů, které je vytvořeno přímo v systému, a není tedy nutné záviset na externích frameworcích.
- Vestavěné nativní reporty Rest. Navíc je lze integrovat s Cucumberem pro lepší uživatelské rozhraní Reportů a větší přehlednost.
- Poskytuje interní podporu pro přepínání konfigurace v různých testovacích prostředích (QA, Stage, Prod, Pre-Prod).
- Bezproblémová podpora integrace CI/CD, která může být užitečná.
- Dokáže zpracovávat různá volání HTTP:
- Podpora webových soketů
- Požadavek SOAP
- HTTP
- Zpracování souborů cookie v prohlížeči
- HTTPS
- Data formuláře HTML
- Požadavek XML
Srovnání karate a Rest-Assured
Zaručený klid : Jedná se o knihovnu založenou na jazyce Java pro testování služeb REST. Pro zápis řádků kódu používá jazyk Java. Pomáhá při testování mnoha kategorií požadavků, což dále vede k ověření různých kombinací obchodní logiky.
Rámec karate : Nástroj založený na Cucumberu/Gherkinsu, který slouží k testování služeb SOAP & amp; REST.
V následující tabulce je uvedeno několik výraznějších rozdílů mezi Rest-Assured & Karate Framework:
| S.č. | Základna | Rámec karate | Zajištěno pomocí REST |
|---|---|---|---|
| 1 | Jazyk | Používá kombinaci okurky a okurky. | Využívá jazyk Java |
| 2 | Kód Velikost | Obvykle je řádek kódu menší, protože má strukturu podobnou Cucumberu. | Řádek kódu je větší, protože zahrnuje použití jazyka Java. |
| 3 | Požadované technické znalosti | Ne- Programátoři mohou snadno napsat kód Gherkins | Pro psaní kódu v jazyce Java jsou nutné technické znalosti |
| 4 | Testování založené na datech | Je třeba použít TestNG nebo ekvivalentní nástroj pro podporu téhož. | K podpoře testování dat lze použít interní značky. |
| 5 | Poskytuje podporu volání SOAP | Ano, poskytuje | Týká se pouze požadavku REST |
| 6 | Paralelní testování | Ano, paralelní testování je snadno podporováno i paralelním generováním sestav. | Ačkoli se o to lidé pokoušeli, míra neúspěchu je vyšší než míra úspěchu. |
| 7 | Hlášení | Poskytuje interní reporting, a proto nemusí být závislý na externích pluginech. Můžeme jej dokonce integrovat s pluginem Cucumber pro lepší uživatelské rozhraní. | Potřeba závislosti na externích zásuvných modulech, jako je Junit, TestNG |
| 8 | Podpora CSV pro externí data | Ano, od verze Karate 0.9.0 | Ne, musíte použít kód nebo knihovnu Java |
| 9 | Automatizace webového uživatelského rozhraní | Ano, od verze Karate 0.9.5 je možná automatizace webového rozhraní. | Ne, není podporováno |
| 10 | Ukázka GET | Zadáno param val1 = 'name1' | given(). |
Jak tedy ukazují výše uvedené rozdíly, lze s jistotou říci, že karate je jednou z nejjednodušších věcí, kterou může dělat každý.
Nástroje potřebné pro práci s rámcem karate
Nyní, když jsme si osvojili základní znalosti o frameworku Karate, se podíváme na procesy a nástroje potřebné k nastavení prostředí Karate.
#1) Zatmění
Eclipse je integrované vývojové prostředí používané v oblasti počítačového programování. Nejčastěji se používá pro programování v jazyce Java. Jak již bylo zmíněno, program Karate je napsán v jazyce Java, takže dává větší smysl, proč je Eclipse IDE pro testování softwaru API. Dalším důvodem je, že se jedná o nástroj s otevřeným zdrojovým kódem, a to je docela silný důvod, proč se rozhodnout pro tento nástroj.
Poznámka: Můžeme použít i IntelliJ, Visual Studio a další různé editory dostupné na trhu.
#2) Maven
Jedná se o nástroj pro automatizaci sestavování, který se používá především pro sestavování projektů v jazyce Java. Je to jeden ze způsobů nastavení prostředí Karate a psaní kódu. Chcete-li nastavit Eclipse s požadavky Mavenu, můžete kliknout zde pro instalaci Mavenu.
Při práci v Mavenu používejte závislosti Mavenu, které by vám pomohly podporovat Karate Framework.
Následující závislosti budou použity s Mavenem v souboru pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Poznámka: Nejnovější verze mohou být k dispozici v úložišti Maven.
#3) Gradle
Gradle je alternativou k Mavenu a lze jej použít ve stejné kapacitě. Mají své podobnosti i rozdíly, ale lze je stejně dobře použít při nastavování prostředí pro naše kódy Karate.
Je jednodušší na používání, flexibilní a doporučuje se používat v případě, že naše aplikace má určité požadavky na modularizaci a správu s množstvím zásuvných modulů. Kód nastavení Gradle by vypadal asi takto,
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Poznámka: Můžete použít MAVEN nebo GRADLE.
#4) Nastavení prostředí Java v systému
Abyste mohli začít používat skripty Karate Framework, je třeba nastavit prostředí JDK a JRE.
Struktura skriptu testu karate
Testovací skript Karate je známý tím, že vlastní příponu ".feature". Tuto vlastnost zdědil od Cucumberu. Stejně tak je povoleno uspořádání souborů podle konvencí Javy. Své soubory můžete uspořádat podle konvencí balíčků Javy.
Směrnice Maven však nařizují, aby se soubory, které nejsou soubory Java, ukládaly odděleně. Ukládají se do src/test/resources A soubory Java jsou uloženy pod src/main/java .
Tvůrci frameworku Karate jsou však pevně přesvědčeni, že bychom měli uchovávat javové i nejjavové soubory vedle sebe. Podle nich je mnohem snazší hledat soubory *.java a *.feature, pokud jsou uchovávány společně, než podle standardní struktury Mavenu.
Toho lze snadno dosáhnout úpravou souboru pom.xml následujícím způsobem (pro Maven):
src/test/java **/*.java ...
Následuje přehled obecné struktury Rámce karate:
Protože tento Karate Framework používá soubor Runner, který je v Cucumberu potřebný i pro spouštění feature souborů, bude se většina zápisu řídit standardy Cucumberu.
Na rozdíl od Cucumberu však kroky nevyžadují jasnou definici v Karate, což zase zvyšuje flexibilitu a snadnost operací. Nemusíme přidávat další lepidlo, které obvykle musíme přidávat, když se řídíme rámcem Cucumberu.
Třída "Runner" se většinou jmenuje TestRunner.java.
Pak bude mít soubor TestRunner.java podobu:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { } A když mluvíme o .feature obsahuje všechny testovací scénáře, které je třeba otestovat, aby bylo zajištěno, že rozhraní API funguje podle očekávaných požadavků.
Obecný soubor *.feature vypadá podle následujícího obrázku:
Funkce: načítání údajů o uživateli Scénář: testování volání get pro údaje o uživateli Zadaná url '//reqres.in/api/users/2' Když metoda GET Pak stav 200
Vytvoření prvního základního testovacího skriptu karate
Tato část vám pomůže začít s vytvářením vašeho prvního testovacího skriptu, který vám pomůže převést rozhraní API ve formě rámce Karate.
Než začneme psát základní testovací skripty Karate, nainstalujte si prosím na svůj počítač následující náležitosti:
- IDE Eclipse
- Maven. Nastavte příslušnou cestu Maven.
- JDK & JRE. Nastavte příslušnou cestu.
Podívejme se na postup krok za krokem:
#1) Vytvoření nového MAVEN Projekt v editoru Eclipse
- Otevřít Eclipse
- Klikněte na Soubor. Vyberte Nový projekt.
- Vyberte projekt Maven
- Vyberte umístění pracovního prostoru.
- Zvolte archetyp (obvykle se volí " Maven-archetype-quickstart 1.1 " pro jednoduché projekty Maven).
- Zadejte ID skupiny & ID artefaktu (v našem příkladu jsme použili následující hodnoty).
- ID skupiny : Karate
- ID artefaktu: KarateTestScriptsSample
- Nastavení dokončíte kliknutím na tlačítko Dokončit.
#2) Po vytvoření se v okně Průzkumník projektu zobrazí následující struktura.
#3) Zahrňte všechny závislosti.
Naším úplně prvním krokem po nastavení bude. zahrnout všechny závislosti které budou vyžadovány pro provedení. Všechny značky ponecháme v rámci POM.xml (Za předpokladu, že jste již obeznámeni s použitím POM.xml).
- Otevřete soubor POM.xml, zkopírujte níže uvedený kód pod značku závislosti a soubor uložte.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Klikněte zde pro zdroj.
#4) Proveďme brainstorming scénáře, co budeme testovat v tomto základním testovacím skriptu karate.
Scénář:
Na této adrese URL budeme testovat rozhraní API.
Cesta: api/users/2
Metoda: GET
A my potřebujeme ověřit , zda požadavek vrací Kód úspěchu (200) nebo ne.
Zjednodušeně řečeno, budeme pouze testovat vzorové rozhraní API, abychom zjistili, zda se úspěšně provádí.
Poznámka: Vycházíme z ukázkového API, které je k dispozici pro testování. Můžete si vybrat libovolný PATH nebo se můžete odkázat na své API.
Klikněte zde pro zdroj.
#5) Dalším krokem bude vytvoření .feature soubor.
Jak bylo uvedeno v úvodní části, .feature soubor je vlastnost, která byla zděděna z Cucumberu. V tomto souboru vypíšeme testovací scénáře, které je třeba provést pro provedení testování API.
- Přejít do složky src/test/java ve vašem projektu.
- Klikněte na něj pravým tlačítkem myši a vytvořte nový soubor - userDetails.feature. Poté klikněte na tlačítko Dokončit.
Nyní se ve složce zobrazí následující soubor src/test/java
Na stránkách Zeleně zbarvená ikona se podobá .feature fi le v Cucumberu, který jsme právě vytvořili.
- Po vytvoření souboru nyní napíšeme naše testovací scénáře, které budou popsány v následující části.
#6) Protože máme scénář a prázdný . funkce soubor připraven, nyní začněme s naším prvním skriptem. Začněme kódovat
Do souboru userDetails.feature, který jsme vytvořili v kroku #5, napište následující řádek kódu:
Funkce: načítání údajů o uživateli Scénář: testování volání get pro údaje o uživateli Zadaná url '//reqres.in/api/users/2' Když metoda GET Pak stav 200
Pokusme se porozumět složkám, které jsou zapsány ve výše uvedeném souboru:
- Funkce: Klíčové slovo vysvětluje název testované funkce.
- Souvislosti: Jedná se o nepovinný oddíl, který je považován za oddíl Předpoklady. Lze jej použít k definování toho, co vše je potřeba k testování rozhraní API. Obsahuje HEADER, URL & PARAM možnosti.
- Scénář: Každý soubor s funkcemi, který uvidíte, bude obsahovat alespoň jednu funkci (i když to může dát více Jedná se o popis testovacího případu.
- Vzhledem k tomu, že: Jedná se o krok, který musí být proveden před provedením jakéhokoli jiného kroku testu. Jedná se o povinnou akci, která musí být provedena.
- Kdy: Určuje podmínku, která by měla být splněna, aby bylo možné provést další krok testu.
- Pak: Říká nám, co by se mělo stát v případě, že podmínka uvedená v článku. Když je splněna.
Poznámka: Všechna výše uvedená klíčová slova pocházejí z jazyka Gherkins. Jedná se o standardní způsob zápisu testovacích skriptů pomocí Cucumberu.
Další slova použitá v souboru funkcí jsou:
- 200: Je to kód stavu/odpovědi, který očekáváme (seznam stavových kódů naleznete zde).
- GET: Jedná se o metody API jako POST, PUT atd.
Doufáme, že toto vysvětlení bylo pro vás snadno pochopitelné. Nyní budete schopni se ztotožnit s tím, co přesně je napsáno ve výše uvedeném souboru.
Nyní musíme vytvořit soubor TestRunner.java
Jak bylo vysvětleno v předchozí části, Cucumber potřebuje soubor Runner, který by byl nutný ke spuštění příkazu .feature který obsahuje testovací scénáře.
- Přejít do složky src/test/java ve vašem projektu
- Klikněte na něj pravým tlačítkem myši a vytvořte nový soubor Java: TestRunner.java
- Po vytvoření souboru, umístěte pod něj následující řádky kódu:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { } - Test Runner je soubor, který bude nyní spuštěn pro provedení požadovaného scénáře, který byl zapsán v kroku č. 5.
#7) Nyní máme připraveny oba soubory TestRunner.Java a userDeatils.feature. Jediným úkolem, který nám zbývá, je Spustit scénář.
- Přejděte na soubor TestRunner.java a klikněte na něj pravým tlačítkem myši, jak je znázorněno na obrázku níže.
- Zvolte možnost Spustit jako -> Junit Test
- Po výběru začnete pozorovat, že testovací případ byl spuštěn.
- Počkejte, až se testovací skript spustí. Jakmile se tak stane, uvidíte v okně něco podobného, jako je znázorněno na následujícím obrázku.
- Nakonec můžeme říci, že jsme úspěšně vytvořili náš první základní Testovací skript pomocí Rámec karate.
#8) A konečně, rámec Karate také poskytuje prezentaci HTML zprávy o provedeném provedení.
- Přejděte do cílové složky -> surefire-reports-> Zde uvidíte svou zprávu HTML, kterou můžete otevřít.
** Doporučujeme vám také, abyste si ji otevřeli v prohlížeči Chrome, abyste získali lepší vzhled.
- Zobrazí se vám následující zpráva HTML, která zobrazuje Scénáře & Test který byl proveden pro uvedený scénář:
Závěr
V tomto tutoriálu jsme se věnovali testování API, různým testovacím nástrojům dostupným na trhu a tomu, jak je Karate Framework lepší volbou ve srovnání se svými protějšky.
Při vytváření našeho prvního základního testovacího skriptu jsme postupovali krok za krokem. Projekt Maven v prostředí Eclipse IDE vytvořit soubor .feature, který obsahuje všechny testovací scénáře, a soubor Runner pro spuštění testovacího případu uvedeného v souboru .feature.
Na konci několika kroků jsme si mohli prohlédnout zprávu o provedení výsledků testu.
Doufáme, že tento návod byl užitečný pro začátečníky, kteří se chtějí naučit, jak vytvořit svůj první testovací skript pomocí frameworku Karate a provádět testování API. Tento podrobný postup krok za krokem je skvělým způsobem, jak spouštět a provádět různé testy API.
NEXT>>