Tere kõigile! Täna tahame esitleda IT kogukonnale meie toodet — IDE API-dega töötamiseks TestMace. Võib-olla te juba teate meis eelnevatest artiklitest. Kuid ulatuslikku ülevaadet tööriistast ei ole olnud, seetõttu parandame selle ebamugavuse.

Motivatsioon

Sooviksime alustada sellest, kuidas me üldse sellisele teele jõudsime ja otsustasime arendada oma tööriista API-dega edasijõudnutele. Alustame funktsioonide loetelust, millel peaks olema toode, mida meie arvates võib pidada "IDE API-dega töötamiseks":

• Päringute ja skriptide (päringute järjekordade) loomine ja täitmine
• Erinevat tüüpi testide kirjutamine
• Testide genereerimine
• Töö API kirjeldusega, sealhulgas importimine sellistest formaatidest nagu Swagger, OpenAPI, WADL jne
• Päringute mooramaine
• Hea toetuse olemasolu ühe või mitme programmeerimiskeele jaoks skriptide kirjutamiseks, sealhulgas populaarsete raamatukogudega integreerimine
• Kui kaua aega kulub väljastamiseks?

Nimekiri on võimalik täiendada vastavalt soovile. Oluline on luua mitte ainult IDE, vaid ka teatud infrastruktuur, näiteks pilvesünkroonimine, käsurea tööriistad, online-jälgimisteenus jne. Lõppude lõpuks dikteerivad viimaste aastate trendid meile mitte ainult rakenduse võimsa funktsionaalsuse, vaid ka selle meeldiva liidese.

Kellele on vajalik selline tööriist? Ilmselgelt on need kõik, kes mingil moel on seotud API arendamise ja testimisega — arendajad ja testerid =). Kui esimestele on sageli piisav üksikute päringute ja lihtsate stsenaariumide täitmine, siis testeritele on see üks peamisi tööriistu, mis peab sisaldama ka võimsat testimise kirjutamise mehhanismi koos CI-s käitamise võimalusega.

Järgides neid suuniseid, hakkasime looma oma toodet. Vaatame, mida oleme sellel etapil saavutanud.

Kiire algus

Alustame rakenduse esmakohtumisest. Selle saab alla laadida meie veebilehel. Praegu toetatakse kõiki kolme põhiplatvormi — Windows, Linux, MacOS. Laadime alla, installime, käivitame. Esmase käivitamise ajal võite näha järgmist akent:

Klõpsake sisuala ülaservas plussikoonust, et luua oma esimene päring. Päringukaart näeb välja selline:

Lugesime sellest veidi lähemalt. Päringu liides sarnaneb väga tuntud REST-kliendi liidesele, mis lihtsustab üleminekut sarnastelt tööriistadelt. Tehkem esimene päring URL-ile https://next.json-generator.com/api/json/get/NJv-NT-U8

Esmapilgul ei paku vastuse paneel samuti mingeid ootamatuid üllatusi. Siiski juhin teie tähelepanu mõnele punktile:

1. Vastuse keha kuvatakse puu kujul, mis lisaks informatiivsusele lubab ka lisada mitmeid huvitavaid funktsioone, millest allpool räägin.
2. On olemas Assertions vahekaart, kus kuvatakse selle päringu testide nimekiri.

Nagu näha, saab meie tööriista kasutada mugava REST-kliendina. Kuid me ei oleks siin, kui selle võimalused piirduksid vaid päringute saatmisega. Edasi tutvustan TestMace põhimõisted ja funktsionaalsused.

Põhimõisted ja võimalused

Sõlm

TestMace'i funktsioonid on jaotatud erinevatesse sõlmedesse. Ülaltoodud näites demonstreerisime RequestStep sõlme toimimist. Praegu on rakenduses saadaval ka järgmised sõlme tüübid:

• RequestStep. See on sõlm, millega saab luua päringu. Lastes on tal ainult üks Assertion sõlm.
• Assertion. Sõlm, mida kasutatakse testide kirjutamiseks. See võib olla ainult RequestStep sõlme alamsõlm.
• Folder. võimaldab grupeerida Folder ja RequestStep sõlmed endas.
• Project. See on juurisõlm, mis luuakse automaatselt projekti loomisel. Ülejäänud osas kordab see Folder sõlme funktsioone.
• Link. Viide Folder või RequestStep sõlmele. See võimaldab taaskasutada päringuid ja stsenaariume.
• Kui kaua aega kulub väljastamiseks?

Sõlmed asuvad scratches (paneel vasakus alanurgas, teenib kiirete „ühekordsete” päringute loomiseks) ja project (paneel vasakus ülanurgas), millele peatume lähemalt.

Projekt

Rakenduse käivitamisel võisite märgata ühte Project rida vasakus ülanurgas. See on projekti puu juur. Projekti käivitamisel luuakse ajutine projekt, mille asukoht sõltub teie operatsioonisüsteemist. Iga hetke jooksul saate projekti viia teise sobivasse kohta.

Projekti peamine eesmärk on võimaldada teie arenduste salvestamine failisüsteemi ja edasine sünkroniseerimine versioonihaldussüsteemide kaudu, stsenaariumite käitamine CI-s, muudatuste ülevaatamine jne.

Muutujad

Muutujad on üks rakenduse võtmekohti. Need, kes töötavad sarnaste tööriistadega nagu TestMace, on tõenäoliselt juba aru saanud, millest jutt käib. Seega, muutujad on viis ühiste andmete salvestamiseks ja suhtlemiseks sõlmede vahel. Näiteks on sarnaseks analoogiks keskkonnamuutujad Postmanis või Insomnias. Kuid me oleme läinud kaugemale ja arendanud seda teemat edasi. TestMace'is saab muutujaid seadistada sõlme tasemel. Igaüht. Samuti on olemas mehhanism muutujate pärimiseks eelkäijatest ja muutujate ülekirjutamiseks järeltulijates. Lisaks on olemas hulk sisseehitatud muutujaid, mille nimed algavad $. Siin on mõned neist:

• $prevStep — viit link varasemate sõlmede muutujatele
• $nextStep — viit link järgnevate sõlmede muutujatele
• $parent — sama, kuid ainult eelkäija jaoks
• $response — serveri vastus
• $env — praegused keskkonnamuutujad
• $dynamicVar — dünaamilised muutujad, mis luuakse skripti või päringu täitmisel

$env — need on sisuliselt tavalised Project taseme muutujad, kuid muutujate kogum sõltub valitud keskkonnast.

Muutujasse pöördumine toimub läbi ${variable_name}
Muutuja väärtuseks võib olla teine muutuja või isegi täisavaldis. Näiteks võib url-i muutujaks olla avaldis vormis
http://${host}:${port}/${endpoint}.

Eraldi tasub välja tuua muutujate määramise võimalus skripti käivitamisel. Näiteks tekib sageli vajadus salvestada autentimisteave (token või kogu päis), mis tuli serverilt pärast edukat sisselogimist. TestMace võimaldab salvestada taolised andmed dünaamilistesse muutujatesse, mis on üks vanematest. Kollisioonide vältimiseks juba olemasolevate "staatiliste" muutujatega on dünaamilised muutuja eraldi objekti viidud. $dynamicVar.

Stsenaariumid

Kasutades kõiki ülaltoodud võimalusi, saate sooritada terveid päringute stsenaariume. Näiteks: üksuse loomine -> üksuse pärimine -> üksuse kustutamine. Antud juhul saate näiteks kasutada Folder sõlme, et grupeerida mitut RequestStep sõlme.

Autotäiendamine ja väljendi väärtuse esiletõstmine

Mugavaks tööks muutujate (ja mitte ainult) puhul on vajalik autotäiendamine. Ja muidugi väljendi väärtuse esiletõstmine, et oleks lihtsam ja mugavam täpsustada, millele see või teine muutuja vastab. Siin on tõepoolest juhtum, kus on parem ühel korral näha, kui sada korda kuulda:

Tuleb märkida, et automaatne täitmine on rakendatud mitte ainult muutujate, vaid ka näiteks pealkirjade, teatud pealkirjade väärtuste (näiteks Content-Type pealkirja automaatne täitmine), protokollide ja paljude muude jaoks. Loend täieneb pidevalt rakenduse kasvades.

Võta tagasi/korda

Tühistamine/kordamine on väga mugav funktsioon, kuid mingil põhjusel ei ole see kaugel igal pool rakendatud (nii ka API tööriistades). Kuid meie ei ole sellised!) Undo/redo on meil rakendatud kogu projekti ulatuses, mis võimaldab tühistada mitte ainult teatud sõlme redigeerimist, vaid ka selle loomist, kustutamist, liigutamist jne. Kõige kriitilisemad toimingud nõuavad kinnitust.

Testide loomine

Testide loomise eest vastutab Assertion sõlm. Üks peamisi omadusi on võimalus testide loomine ilma programmeerimist teadmata, kasutades sisseehitatud redigeerijaid.

Assertion sõlm koosneb hulgast assertion'itest (väidetest). Igal assertion'il on oma tüüp, praegu on olemas mitu erinevat assertion'i tüüpi.

1. Väärtuste võrdlemine — lihtsalt võrdleb kahte väärtust. On mitu võrdlusoperaatorit: 'võrdne', 'mitte võrdne', 'suurem', 'suurem või võrdne', 'väiksem', 'väiksem või võrdne'.

2. Sisaldab väärtust — kontrollib, kas alamstring esineb stringis.

3. XPath — kontrollib, kas XML-is selektoriga on seatud kindel väärtus.

4. JavaScripti väide — vabalt valitud JavaScripti skript, mis tagastab true edukuse korral ja false ebaühtluse korral.

Märgin, et ainult viimane nõuab kasutajalt programmeerimisoskusi, ülejäänud 3 väidet luuakse graafilise liidese abil. Näiteks, kuidas näeb välja compare values väite loomise dialoog:

Kirsiks tordil on väidete kiire loomine vastusest, lihtsalt vaata seda!

Kuid sellistel väidetel on ilmne piirang, millega kokku puutudes võite kasutada JavaScripti väidet. Siinkohal pakub TestMace ka mugava keskkonna automaatse täiendamise, süntaksivärvi ja isegi staatilise analüsaatori abil.

API kirjeldus

TestMace mitte ei võimalda mitte ainult API-d kasutada, vaid ka selle dokumenteerimist. Kirjeldus endal on samuti hierarhiline struktuur ja sulandub orgaaniliselt ülejäänud projekti. Peale selle on praeguseks olemas võimalus importida API kirjeldust Swagger 2.0 / OpenAPI 3.0 formaatidest. Kirjeldus ei jää lihtsalt staatiliseks, vaid integreerub tihedalt ülejäänud projekti osadega, sealhulgas on saadaval URL-ide, HTTP-pealkirjade, päringu parameetrite automaatne täiendamine ja muu, ning tulevikus plaanime lisada ka teste API vastuse vastavuse kontrollimiseks.

Klahvid

Tõuge: soovite jagada probleemset päringut või isegi tervet stsenaariumi kolleegiga või lihtsalt lisada selle veale. TestMace katab ka selle juhtumi: rakendus võimaldab serializeerida mis tahes sõlme ja isegi alamsõlme URL-is. Kopeeri-kleebi ja olete juba mugavalt viinud päringu teisele masinale või projekti.

Inimesele arusaadav projekti salvestamise formaat

Hetkel salvestatakse iga sõlm eraldi failis, millel on laiend yml (nagu Assertion sõlme puhul), või kaustas, mille nimi on sõlm ja seal on fail index.yml.
Näexample, siin on fail päringu kohta, mille me tegime ülaltoodud ülevaates:

index.yml

lapsed: []
muutujad: {}
tüüp: RequestStep
määraMuutujad: []
päringuAndmed:
  päring:
    meetod: GET
    url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
  pealkirjad: []
  keelatudPärandPealkirjad: []
  parameetrid: []
  keha:
    tüüp: Json
    jsonKeha: ''
    xmlKeha: ''
    tekstKeha: ''
    vormAndmed: []
    fail: ''
    vormURLEncoded: []
  rangeSSL: Pärand
auditoAndmed:
  tüüp: pärand
nimi: Scratch 1

Kuidas näha, kõik on absoluutselt arusaadav. Soovi korral on sellist formaati täiesti mugav ka käsitsi redigeerida.

Kaustade hierarhiat failisüsteemis jälgib täielikult sõlmede hierarchiat projektis. Näiteks selline stsenaarium:

Mappitakse failisüsteemis järgmise struktuuriga (näidatud on vaid kaustade hierarhia, kuid mõte on selge)

Mis lihtsustab projekti ülevaatamise protsessi.

Postman'ist importimine

Lugedes kõike eelnevat, soovivad mõned kasutajad proovida (nii tõesti?) uut toodet või (miks mitte!) teha seda oma projektis. Siiski võib migratsiooni takistada suur hulk arendusi just Postman'is. Selliste olukordade jaoks toetab TestMace Postman'i kogude importimist. Praegu toetatakse testideta importi, kuid tulevikus ei välista me nende toetust.

Tunniplaanid

Loodan, et paljusid teist, kes on siiani lugenud, on meie toode paelunud. Kuid see pole veel kõik! Toote arendamine käib täie hooga ja siin on mõned omadused, mida me plaanime peagi lisada.

Pilvesüncroniseerimine

Üks kõige nõutavamaid funktsioone. Hetkel pakume süncroniseerimiseks kasutada versioonihaldussüsteeme, mille jaoks teeme formaadi inimestele mugavamaks selliseks säilitamiseks. Kuid mitte kõik ei sobi sellise töövooga, seetõttu plaanime lisada paljudele tuttava süncroniseerimise mehhanismi läbi meie serverite.

CLI

Nagu juba eelnevalt mainitud, ei saa IDE tasemel tooted hakkama ilma erinevate integreerimiste olemasolevate rakenduste või töövoogudega. CLI on vajalik TestMace'is kirjutatud testide integreerimiseks pidevasse integreerimise protsessi. CLI arendamine käib täie hooga, varasemates versioonides on kavas luua projekt koos lihtsa konsooli aruandlusega. Edasi plaanitakse lisada aruande väljund JUnit formaadis.

Pluginasüsteem

Vaatamata meie tööriista jõule on lahendamisvajaduste hulk piiramatud. Lõppude lõpuks on olemas ülesandeid, mis on spetsiifilised igale projektile. Seetõttu plaanime tulevikus lisada SDK pluginate arendamiseks, et iga arendaja saaks lisada soovitud funktsionaalsuse.

Node tüüpide valiku laiendamine

See node komplekt ei kata kõiki kasutajat vajalikke juhtumeid. Planeeritavad node'id on:

• Script node — teisendab ja paigutab andmeid, kasutades js ja vastavat API-d. Selle node tüübi abil on võimalik teha asju, nagu pre-request ja post-request skriptid Postmanis.
• GraphQL node — GraphQL toe pakkumine
• Custom assertion node — lubab laiendada olemasolevaid assertion'e projektis
  Loomulikult ei ole see lõplik nimekiri, see täienev pidevalt, sealhulgas teie tagasiside kaudu.

KKK

Kuidas te Postmanist erinevate?

1. Node'i kontseptsioon, mis võimaldab praktiliselt piiramatu funktsionaalsuse skaala projekti
2. Inimesele loetav projekti formaat faili süsteemi salvestamine, mis lihtsustab versioonihaldussüsteemide kasutamist
3. Testide loomise võimalus ilma programmeerimiseta ja täiustatud js-tugi testiredaktoris (automaatne täiendamine, staatiline analüüsitööriist)
4. Täiustatud automaatne täiendamine ja muutujate praeguse väärtuse esiletõstmine

Kas see on avatud lähtekoodiga toode?

Ei, hetkel on lähtekood suletud, kuid tulevikus kaalume võimalust avada lähtekood.

Kuidas te elate?)

Lisaks tasuta versioonile plaanime välja anda ka tasulise versiooni. Sellesse kuuluvad eelkõige funktsioonid, mis vajavad serveripoolset tuge, näiteks sünkroniseerimine.

Kokkuvõte

Meie projekt liikleb kiires tempos stabiilse väljaande suunas. Siiski on toode juba praegu kasutamiseks saadaval ja meie varajaste kasutajate positiivne tagasiside räägib enda eest. Kogume aktiivselt tagasisidet, kuna ilma tiheda koostööta kogukonnaga ei ole võimalik head tööriista luua. Meid võib leida siit:

Ametlik veebisait

Telegram

Slack

Facebook

Issues-treileri

Ootame huviga teie soove ja ettepanekuid!

Allikas: habr.com