Гэты падручнік з'яўляецца ўвядзеннем у тэсціраванне API з дапамогай Karate Framework. Даведайцеся пра структуру тэставага сцэнарыя каратэ і этапы стварэння першага тэставага сцэнарыя:
API - гэта абрэвіятура, якая расшыфроўваецца як інтэрфейс прыкладнога праграмавання. Прасцей кажучы, мы можам вызначыць гэта як праграмнае забеспячэнне-пасярэднік, якое дазваляе ўзаемадзейнічаць паміж праграмамі.
Нам патрэбна тэставанне API, таму што:
- Вынікі публікуюцца хутчэй, такім чынам, больш не трэба чакаць, каб убачыць, ці добра працуе API.
- З больш хуткім адказам разгортванне гэтых API таксама становіцца больш хуткім, што забяспечвае хуткі час выканання.
- Ранняе выяўленне збояў, яшчэ да таго, як будзе створаны карыстальніцкі інтэрфейс прыкладання, дазваляе нам знізіць рызыкі і выправіць памылкі.
- Магчымасць шырокамаштабнай пастаўкі ў больш кароткія тэрміны.
Каб мець магчымасць працаваць над тэставаннем API, у нас ёсць розныя інструменты, даступныя на рынку, такія як Postman, Mocha і Chai. Яны прадэманстравалі добрыя вынікі і эфектыўнае выкарыстанне для тэсціравання API, аднак на іх моцна паўплываў код. Каб мець магчымасць карыстацца імі, трэба быць тэхнічна абгрунтаваным і знаёмым з мовамі праграмавання.
Каратэ Фрэймворк выдатна вырашае гэтую праблему сваіх папярэдніх праграмных інструментаў.
Што такое структура каратэ
Каратэ? Давайце пагаворым аб каратэ. Гэта той, што з Японіі? Што думаеш? Магчыма, гэта вялікі Брусгэты базавы тэставы скрыпт каратэ.
Сцэнар:
Мы будзем тэставаць API з гэтым URL.
Шлях: api/users/2
Метад: GET
І нам трэба праверыць , ці вяртае запыт код поспеху ( 200) ці не.
Прасцей кажучы, мы проста збіраемся праверыць узор API, каб убачыць, ці паспяхова ён выконваецца.
Заўвага: Мы бярэм узор API, які даступны для тэставання. Вы можаце выбраць любы ШЛЯХ або спасылацца на свой API.
Націсніце тут для зыходнага кода.
#5) Цяпер нашым наступным крокам будзе стварэнне Файл .feature .
Як гаварылася ва ўводным раздзеле, файл .feature з'яўляецца ўласцівасцю, якая была ўспадкавана ад Cucumber. У гэтым файле мы запішам тэставыя сцэнарыі, якія неабходна выканаць для правядзення тэсціравання API.
- Перайдзіце ў тэчку src/test/java у вашым праекце.
- Пстрыкніце па ім правай кнопкай мышы і стварыце новы файл – userDetails.feature. Затым націсніце кнопку "Завяршыць".
Цяпер вы ўбачыце наступны файл у папцы src/test/java
Зялёны значок нагадвае .feature fi файл у Cucumber, які мы толькі што стварылі.
- Пасля таго, як файл будзе створаны, зараз мы напішам нашы тэставыя сцэнарыі, якія будуць абмяркоўвацца ў наступным раздзеле.
#6) Паколькі ў нас ёсць сцэнар іпусты файл . feature гатовы, цяпер давайце пачнем з нашым першым сцэнарыем. Давайце пачнем кадзіраваць
Напішыце наступны радок кода ў файле userDetails.feature, які мы стварылі на этапе №5:
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
Давайце паспрабуем зразумець кампаненты, якія запісаны ў прыведзеным вышэй файле:
- Функцыя: Ключавое слова тлумачыць назву функцыі, якую мы тэстуем.
- Даведка: Гэта неабавязковы раздзел, які разглядаецца як раздзел перад умовамі. Гэта можна выкарыстоўваць, каб вызначыць, што ўсё неабходна для тэставання API. Ён змяшчае HEADER, URL & Параметры PARAM .
- Сцэнарый: Кожны файл функцый, які вы ўбачыце, будзе мець прынамсі адну функцыю (хоць ён можа даць некалькі сцэнарыяў) . Гэта апісанне тэставага выпадку.
- Дадзена: Гэта крок, які неабходна выканаць перад выкананнем любога іншага тэставага кроку. Гэта абавязковае дзеянне, якое неабходна выканаць.
- Калі: Указвае ўмову, якая павінна быць выканана для выканання наступнага этапу тэставання.
- Тады: Яно паведамляе нам, што павінна адбыцца, калі ўмова, згаданая ў Калі , выконваецца.
Заўвага: Усе вышэйзгаданыя ключавыя словы з'яўляюцца з мовы Карнішоны. Гэта стандартны спосаб напісання тэставых сцэнарыяў з выкарыстаннем Cucumber.
І яшчэ некалькі слоў, якія выкарыстоўваюцца ў файле функцый:
- 200: Гэта код стану/адказу, якім мы з'яўляемсячакаючы (Націсніце тут, каб убачыць спіс кодаў стану)
- GET: Гэта метад API, напрыклад POST, PUT і г.д.
Мы спадзяемся, што гэта тлумачэнне вам было лёгка зразумець. Цяпер вы зможаце мець зносіны з тым, што менавіта напісана ў файле вышэй.
Цяпер нам трэба стварыць файл TestRunner.java
Як тлумачылася вышэй у раздзеле Cucumber патрэбны файл Runner, які спатрэбіцца для выканання файла .feature , які змяшчае сцэнарыі тэсціравання.
- Перайсці ў тэчку src/test/java у вашым праекце
- Пстрыкніце яго правай кнопкай мышы і стварыце новы файл Java: TestRunner.java
- Пасля таго, як файл будзе створаны, змесціце пад ім наступныя радкі кода:
import org.junit.runner.RunWith; import com.intuit.karate.junit4.Karate; @RunWith(Karate.class) public class TestRunner { }- Test Runner - гэта файл, які зараз будзе выкананы для выканання жаданы сцэнар, які быў напісаны на этапе №5.
#7) Цяпер мы гатовыя з абодвума файламі TestRunner.Java і userDeatils.feature. Адзінае заданне, якое нам засталося, гэта запусціць скрыпт.
- Перайдзіце да файла TestRunner.java і пстрыкніце файл правай кнопкай мышы, як паказана на малюнку ніжэй.
- Выберыце "Запусціць як" -> Тэст Junit
- Цяпер, пасля выбару, вы пачнеце назіраць, што тэставы прыклад пачаўся.
- Пачакайце, пакуль выканаецца тэставы сцэнар. Пасля завяршэння вы ўбачыце ў сваім акне нешта падобнае на малюнак ніжэй.
- Нарэшце, мы можам сказацьшто мы паспяхова стварылі наш самы першы базавы Тэставы скрыпт з дапамогай Каратэ Фрэймворк.
#8) Нарэшце, каратэ фрэймворк таксама дае прадстаўленне справаздачы ў фармаце HTML для выканання, якое было выканана.
- Перайсці ў мэтавую тэчку -> верныя-справаздачы-> Тут вы ўбачыце сваю HTML-справаздачу, якую можна адкрыць.
** Мы таксама рэкамендуем вам адкрыць яе з дапамогай Chrome Браўзер для лепшага выгляду і адчуванняў.
- Вам будзе паказаны наступны HTML-справаздачу з выявай Сцэнарыі & Тэст , які быў выкананы для згаданага сцэнарыя:
Выснова
У гэтым уроку мы абмяркоўвалі тэставанне API, розныя тэсты інструменты, даступныя на рынку, і тое, што Karate Framework з'яўляецца лепшым варыянтам у параўнанні з аналагамі.
Мы прытрымліваліся пакрокавага падыходу, каб стварыць наш першы базавы тэставы сцэнар. Мы пачалі са стварэння базавага праекта Maven у Eclipse IDE для стварэння файла .feature, які змяшчае ўвесь сцэнарый тэсціравання, і файл Runner для выканання тэсту, згаданага ў файле .feature.
У канцы некалькіх этапаў мы маглі ўбачыць справаздачу аб выкананні вынікаў тэсту.
Мы спадзяемся, што гэты падручнік быў карысным для пачаткоўцаў у вывучэнні таго, як стварыць свой першы тэставы сцэнар з дапамогай Karate Framework і правесці тэставанне API. Гэта падрабязны крок за крокампадыход з'яўляецца цудоўным спосабам запуску і выканання розных тэстаў на API.
ДАЛЕЕ>>
Лі распрацаваў гэта ў свой вольны час.Хоць мы хацелі б паглыбіцца ў цікавыя карані каратэ, пакуль давайце пагаворым пра інструмент каратэ , які быў распрацаваны ад Пітэра Томаса , аднаго з выдатных інструментаў, якія прыходзяць на дапамогу тэстарам API.
Каратэ прытрымліваецца стылю напісання праграмы Cucumber, які прытрымліваецца падыходу BDD. Сінтаксіс просты для разумення непраграмістам. І гэты фрэймворк з'яўляецца адзіным інструментам тэсціравання API, які аб'яднаў аўтаматызацыю API і тэсціраванне прадукцыйнасці ў адзіны аўтаномны інструмент.
Ён дае карыстальнікам магчымасць паралельна выконваць тэсты і выконваць JSON & Праверкі XML.
З дапамогай гэтай інфармацыі можна вывесці пэўныя ключавыя моманты для больш падрабязнага разумення інструмента Каратэ:
- Замест гэтага Karate з'яўляецца сістэмай тэставання BDD TDD.
- Ён распрацаваны, каб быць простым для непраграмістаў. Гэтая функцыя змяніла гульню, паколькі яна дазваляе больш шырока выкарыстоўваць і атрымліваць доступ многім людзям, незалежна ад іх тэхнічнага вопыту або здольнасці.
- Яна выкарыстоўвае файл функцый Cucumber і мову Gherkins для напісання тэсту, які вельмі лёгка зразумець.
Усе гэтыя асаблівасці робяць яго адным з самых спрыяльных інструментаў аўтаматызацыі, даступных сёння.
Гісторыя фрэймворка каратэ
Створана ' Пітэр Томас' у 2017 годзе, гэта праграмнае забеспячэнне накіравана на тэставаннефункцыі, даступныя кожнаму. Ён быў напісаны на Java, і большасць людзей чакалі, што яго файлы таксама будуць на той жа мове, аднак, на шчасце, гэта не так.
Хутчэй, ён выкарыстоўвае файлы Gherkins, што з'яўляецца вынікам яго сувязі з Каркас агурка. Праграмнае забеспячэнне аўтаматызацыі з'яўляецца пашырэннем Cucumber, таму ў сваёй працы ўспадкоўвае выкарыстанне файла Gherkins. Вялікая розніца паміж імі заключаецца ў тым, што Karate не выкарыстоўвае Java падчас тэсціравання, але Cucumber выкарыстоўвае.
Гэта тая самая прычына, чаму ён абслугоўвае непраграмістаў, бо сінтаксіс Gherkins надзвычай чытэльны і поўны. Гэта прычына, па якой каратэ з'яўляецца найбольш прыдатным і рэкамендаваным для ўваходжання ў свет аўтаматызаванага тэсціравання API.
Ніжэй прыведзены некаторыя функцыі сістэмы тэсціравання каратэ:
- Выкарыстоўвае простую для разумення мову Gherkins.
- Яно не патрабуе тэхнічных ведаў праграмавання, як Java.
- Яно заснавана на папулярных стандартах Cucumber.
- Лёгка стварыць фрэймворк.
- Паралельнае тэсціраванне - гэта асноўная функцыя, якая забяспечваецца самой Каратэ, таму нам не трэба залежаць ад Maven, Gradle і г.д.
- Інтэрфейсны інтэрфейс для адладкі тэсту.
- Выклік файла функцыі з іншага файла.
- Забяспечвае падтрымку тэставання драйвера даных, убудаванага ўнутр, таму не трэба залежаць ад знешніх фрэймворкаў.
- Убудаваны Native RestДаклады. Акрамя таго, яго можна інтэграваць з Cucumber для паляпшэння справаздач карыстацкага інтэрфейсу і большай яснасці.
- Забяспечвае ўнутраную падтрымку для пераключэння канфігурацыі ў розных асяроддзях тэсціравання (QA, Stage, Prod, Pre-Prod).
- Бясшвовая падтрымка інтэграцыі CI/CD, якая можа быць карыснай.
- Здольнасць апрацоўваць розныя HTTP-выклікі:
- Падтрымка вэб-сокетаў
- Запыт SOAP
- HTTP
- Апрацоўка файлаў cookie браўзера
- HTTPS
- Даныя HTML-формы
- Запыт XML
Параўнанне каратэ і Rest-Assured
Будзьце ўпэўненыя : гэта бібліятэка на аснове Java для тэставання службаў REST. Ён выкарыстоўвае мову Java для напісання радкоў кода. Гэта дапамагае ў тэсціраванні шматлікіх катэгорый запытаў, што ў далейшым прыводзіць да праверкі розных камбінацый бізнес-логікі.
Каратэ Фрэймворк : Інструмент на аснове Cucumber/Gherkins, які выкарыстоўваецца для тэсціравання SOAP & Паслугі REST.
У наступнай табліцы прыведзены яшчэ некалькі прыкметных адрозненняў паміж Rest-Assured & Рамкі каратэ:
| S.No | Аснова | Структуры каратэ | Упэўненасць REST |
|---|---|---|---|
| 1 | Мова | Выкарыстоўваецца спалучэнне агуркоў і карнішонаў | Ён выкарыстоўвае мову Java |
| 2 | Памер кода | Звычайна радок код менш, паколькі ён прытрымліваецца структуры, падобнай да агурка | Радок кода больш, паколькі ён уключаевыкарыстанне мовы Java |
| 3 | Патрабуюцца тэхнічныя веды | Непраграмісты могуць лёгка пісаць код Gherkins | Для напісання кода Java неабходныя тэхнічныя веды |
| 4 | Тэставанне на аснове дадзеных | Неабходна выкарыстоўваць TestNG або эквівалент для падтрымкі таго ж | Унутраныя тэгі можна выкарыстоўваць для падтрымкі тэсціравання даных |
| 5 | Ці забяспечвае падтрымку выклікаў SOAP | Так, забяспечвае | Гэта звязана толькі з запытам REST |
| 6 | Паралельнае тэсціраванне | Так, паралельнае тэсціраванне лёгка падтрымліваецца з дапамогай паралельнага стварэння справаздач таксама | Не ў вялікай ступені. Нягледзячы на тое, што людзі спрабавалі зрабіць гэта, узровень няўдач перавышае ўзровень поспеху |
| 7 | Справаздачы | Ён забяспечвае ўнутраную справаздачнасць, таму не павінен залежаць ад знешніх убудоў. Мы нават можам інтэграваць яго з убудовай для справаздач Cucumber для лепшага карыстальніцкага інтэрфейсу. | Трэба залежаць ад знешніх убудоў, такіх як Junit, TestNG |
| 8 | Падтрымка CSV для знешніх даных | Так, з Karate 0.9.0 | Не, трэба выкарыстоўваць код Java або бібліятэку |
| 9 | Аўтаматызацыя вэб-інтэрфейсу | Так, з Karate 0.9.5 магчыма аўтаматызацыя вэб-інтэрфейсу | Не, не падтрымліваецца |
| 10 | Узор GET | Given param val1 = ‘name1’
| given().
|
Такім чынам, як паказвае адрозненняў вышэй, можна з упэўненасцю сказаць, што каратэ - адна з самых простых рэчаў, якія можа зрабіць кожны.
Інструменты, неабходныя для працы з каратэ фрэймворкам
Цяпер, калі мы атрымалі базавыя веды аб Каратэ Фрэймворк, давайце паглядзім на працэсы і інструменты, неабходныя для наладжвання асяроддзя каратэ.
#1) Eclipse
Eclipse - гэта інтэграванае асяроддзе распрацоўкі, якое выкарыстоўваецца у галіне камп'ютарнага праграмавання. Ён у асноўным выкарыстоўваецца для праграмавання на Java. Як згадвалася раней, Karate напісана на Java, таму больш разумна, чаму Eclipse з'яўляецца IDE для тэставага праграмнага забеспячэння API. Іншая прычына ў тым, што гэта інструмент з адкрытым зыходным кодам, і гэта даволі важкая прычына, каб выбраць гэты інструмент.
Заўвага: Мы можам нават выкарыстоўваць IntelliJ, Visual Studio і іншыя розныя рэдактары, даступныя на рынку.
#2) Maven
Гэта інструмент аўтаматызацыі зборкі, які выкарыстоўваецца ў асноўным для стварэння праектаў Java. Гэта адзін са спосабаў наладзіць асяроддзе каратэ і напісаць код. Каб наладзіць патрабаванні Eclipse з Maven, вы можаце націснуць тут для ўстаноўкі Maven.
Працуючы ў Maven, выкарыстоўвайце залежнасці Maven, якія дапамогуць вам падтрымліваць Karate Framework.
Наступнае залежнасці будуць выкарыстоўвацца з Maven у pom.xml.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Заўвага: Апошнія версіі могуцьбыць даступны ў сховішчы Maven.
#3) Gradle
Gradle з'яўляецца альтэрнатывай Maven і можа выкарыстоўвацца ў роўнай колькасці. Яны маюць свае падабенствы і адрозненні, але могуць быць аднолькава выкарыстаны для стварэння асяроддзя для нашых кодаў каратэ.
Яны больш простыя ў выкарыстанні, гнуткія і рэкамендуюцца для выкарыстання, калі ў нашага прыкладання ёсць патрабаванні да модульнасці і кіравання з куча убудоў. Код усталёўкі Gradle будзе выглядаць прыкладна так:
testCompile 'com.intuit.karate:karate-junit4:0.6.0' testCompile 'com.intuit.karate:karate-apache:0.6.0'
Заўвага: Вы можаце выкарыстоўваць MAVEN або GRADLE.
#4) Настройка асяроддзя Java у вашай сістэме
Неабходна наладзіць асяроддзе JDK і JRE, каб пачаць працу са сцэнарыямі Karate Framework.
Структура тэставага сцэнарыя Karate
Тэставы сцэнар па каратэ вядомы тым, што мае пашырэнне «.feature». Гэта ўласцівасць дасталася ад Агурка. Таксама дапускаецца арганізацыя файлаў у канвенцыі Java. Вы можаце арганізаваць свае файлы ў адпаведнасці з пагадненнямі аб пакетах Java.
Аднак інструкцыі Maven загадваюць захоўваць файлы, якія не належаць да Java, асобна. Яны выконваюцца ў структуры src/test/resources . А файлы Java захоўваюцца ў src/main/java .
Але, паводле стваральнікаў Karate Framework, яны цвёрда вераць, што мы захоўваем файлы Java і не-Java побач бок. На іх думку, нашмат прасцей даглядаць заФайлы *.java і *.feature, калі яны захоўваюцца разам, а не прытрымліваюцца стандартнай структуры Maven.
Гэта можна лёгка зрабіць, наладзіўшы ваш pom.xml наступным чынам (для Maven):
src/test/java **/*.java ...
Ніжэй прыводзіцца схема агульнай структуры Каратэ Фрэймворк:
Цяпер, паколькі гэты Каратэ Фрэймворк выкарыстоўвае файл Runner, які таксама неабходны ў Cucumber для запуску файлаў функцый, так што большая частка запісу будзе адпавядаць стандартам Cucumber.
Але, у адрозненне ад Cucumber, крокі не патрабуюць дакладнага вызначэння ў каратэ і якія , у сваю чаргу, павышаюць гнуткасць і прастату працы. Нам не трэба дадаваць дадатковы клей, які мы звычайна дадаем, калі мы прытрымліваемся структуры Cucumber.
Клас “Runner” часцей за ўсё называецца TestRunner.java.
Тады файл TestRunner.java прыме форму:
import com.intuit.karate.junit4.Karate; import org.junit.runner.RunWith; @RunWith(Karate.class) public class TestRunner { }А калі казаць пра файл .feature , то ён утрымлівае ўсе тэсты сцэнарыі, якія неабходна праверыць, каб пераканацца, што API працуе ў адпаведнасці з чаканымі патрабаваннямі.
Агульны файл *.feature выглядае прыкладна так, як паказана ніжэй:
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
Стварэнне першага базавага тэставага сцэнарыя каратэ
Гэты раздзел дапаможа вам пачаць стварэнне вашага першага тэставага сцэнарыя, які дапаможа вам пераўтварыць API у форму каратэ.
Перш чым мы напішам асноўныя тэставыя сцэнарыі каратэ,калі ласка, усталюйце наступныя рэквізіты на вашай машыне:
- Eclipse IDE
- Maven. Усталюйце адпаведны шлях Maven.
- JDK & JRE. Усталюйце адпаведны шлях.
Давайце паглядзім на пакрокавы падыход:
#1) Стварыце новы праект MAVEN у рэдактары Eclipse
- Адкрыць Eclipse
- Націсніце на файл. Абярыце "Новы праект".
- Абярыце "Праект Maven"
- Абярыце месцазнаходжанне Workspace.
- Абярыце Архетып (звычайна мы выбіраем « Maven-archetype-quickstart 1.1 » для простых праектаў Maven).
- Прадастаўленне ідэнтыфікатар групы & ідэнтыфікатар артэфакта (у нашым прыкладзе мы выкарыстоўвалі наступныя значэнні).
- ID групы : Karate
- ID Artefact: KarateTestScriptsSample
- Націсніце Finish, каб завяршыць налада.
#2) Пасля стварэння вы зможаце ўбачыць наступную структуру ў акне Правадыра праекта.
#3) Уключыце ўсе вашы залежнасці.
Нашым самым першым крокам, пасля ўстаноўкі, мы будзем уключыць усе залежнасці , якія спатрэбяцца для выканання. Мы захаваем увесь тэг у POM.xml (пры ўмове, што вы ўжо ведаеце пра выкарыстанне POM.xml).
- Адкрыйце POM.xml і скапіруйце прыведзены ніжэй код пад тэгам залежнасці і захавайце файл.
com.intuit.karate karate-apache 0.9.5 test com.intuit.karate karate-junit4 0.9.5 test
Націсніце тут для зыходнага кода.
#4) Давайце абмяркуем сцэнар, што мы будзем тэставаць у