Pozdrav svima! Danas želimo predstaviti IT zajednici naš proizvod — IDE za rad s API-jem. Možda neki od vas već znaju za nas iz . Međutim, nije bilo sveobuhvatnog pregleda alata, pa otklanjamo ovaj dosadni nedostatak.

Motivacija
Željeli bismo početi s tim kako smo, zapravo, došli do ove ideje i odlučili razviti svoj alat za napredni rad s API-jem. Počnimo s popisom funkcionalnosti koje bi proizvod trebao imati, a za koji smatramo da ga možemo nazvati 'IDE za rad s API-jem':
- Izrada i izvršavanje upita i skripti (sekvenci upita)
- Pisanje raznih vrsta testova
- Generiranje testova
- Rad s opisima API-a, uključujući uvoz iz formata poput Swagger, OpenAPI, WADL itd.
- Mockiranje upita
- Dobra podrška za jedan ili više programskih jezika za pisanje skripti, uključujući integraciju s popularnim knjižnicama
- itd.
Popis se može proširiti prema želji. Važno je ne stvoriti samo IDE, već i određenu infrastrukturu, poput oblačne sinkronizacije, alata naredbenog retka, usluge online nadzora itd. Na kraju krajeva, trendovi posljednjih godina nameću nam ne samo snažne funkcionalnosti aplikacije, već i njezin ugodan sučelje.
Za koga je takav alat potreban? Očigledno, za sve one koji su na bilo koji način povezani s razvojem i testiranjem API-ja — programere i testere =). Dok za prva često dostaju pojedinačni upiti i jednostavni scenariji, za testere je to jedan od glavnih alata koji, osim toga, treba imati moćan mehanizam za pisanje testova s mogućnošću njihovog izvođenja u CI.
Dakle, vodeći se ovim smjernicama, počeli smo razvijati svoj proizvod. Pogledajmo što smo postigli u ovoj fazi.
Brzi početak
Počnimo s prvim susretom s aplikacijom. Možete je preuzeti . Trenutno podržavamo sve 3 glavne platforme — Windows, Linux, MacOS. Preuzmite, instalirajte, pokrenite. Prilikom prvog pokretanja možete vidjeti sljedeći prozor:

Kliknite na plus u gornjem dijelu sadržaja za kreiranje prvog upita. Kartica s upitom izgleda ovako:

Pogledajmo to malo detaljnije. Sučelje zahtjeva vrlo podsjeća na sučelje popularnih REST klijenata, što olakšava migraciju s takvih alata. Izvršimo prvi zahtjev na url

Na prvi pogled, odgovor ploča također ne donosi nikakva iznenađenja. Međutim, skrenut ću vam pažnju na nekoliko točaka:
- Tijelo odgovora ima strukturu u obliku stabla, što prije svega dodaje informativnost, a drugo dopušta dodavanje nekih zanimljivih karakteristika o kojima ćemo kasnije govoriti
- Postoji kartica Assertions, na kojoj se prikazuje popis testova za ovaj zahtjev
Kao što možete primijetiti, naš alat može se koristiti kao prikladan REST klijent. Međutim, ne bismo se ovdje okupili da su njegove mogućnosti ograničene samo na slanje zahtjeva. Sljedeće ću izložiti osnovne pojmove i funkcionalnosti TestMace.
Osnovni pojmovi i mogućnosti
Čvor
Funkcionalnost TestMace podijeljena je prema različitim vrstama čvorova. Na primjeru iznad prikazali smo rad RequestStep čvora. Međutim, trenutno su u aplikaciji dostupni i sljedeći tipovi čvorova:
- RequestStep. Ovo je čvor koji omogućava stvaranje zahtjeva. Kao podčvor može imati samo jedan Assertion čvor.
- Assertion. Čvor se koristi za pisanje testova. Može biti podčvor samo za RequestStep čvor.
- Folder. Omogućava grupiranje Folder i RequestStep čvorova unutar sebe.
- Project. Ovo je korijenski čvor koji se automatski stvara pri izradi projekta. U ostalom ponavlja funkcionalnosti Folder čvora.
- Link. Veza na Folder ili RequestStep čvor. Omogućava ponovno korištenje zahtjeva i scenarija.
- itd.
Čvorovi se nalaze u scratches (panel u donjem lijevom kutu koji služi za brzo stvaranje 'jednokratnih' zahtjeva) i u project (panel u gornjem lijevom kutu) na kojem ćemo se zadržati malo detaljnije.
Projekt
Prilikom pokretanja aplikacije mogli ste primijetiti jednu liniju Project u gornjem lijevom kutu. To je korijen stabla projekta. Prilikom pokretanja projekta stvara se privremeni projekt, čiji put ovisi o vašem operativnom sustavu. U bilo kojem trenutku možete premjestiti projekt na mjesto koje vam odgovara.
Osnovna svrha projekta je mogućnost spremanja rada u datotečnom sustavu i daljnja sinkronizacija putem sustava za kontrolu verzija, pokretanja scenarija u CI, pregleda promjena itd.
Varijable
Varijable su jedan od ključnih mehanizama aplikacije. Oni od vas koji rade s alatima poput TestMace već su mogli shvatiti o čemu se radi. Dakle, varijable su način za pohranu zajedničkih podataka i komunikaciju između nodova. Analogno, na primjer, postoje varijable okruženja u Postmanu ili Insomnii. Međutim, otišli smo dalje i razvili temu. U TestMace varijable se mogu postavljati na razini nodova. Bilo kojeg. Također postoji mehanizam nasljeđivanja varijabli od predaka i preklapanja varijabli u potomcima. Osim toga, postoji niz ugrađenih varijabli, a imena ugrađenih varijabli počinju s $. Evo neki od njih:
$prevStep— referenca na varijable prethodnog noda$nextStep— referenca na varijable sljedećeg noda$parent— isto, ali za predka$response— odgovor od servera$env— trenutne varijable okruženja$dynamicVar— dinamičke varijable koje se kreiraju tijekom izvođenja scenarija ili zahtjeva
$env — ovo su u suštini obične varijable razine Project noda, međutim, skup varijabli okruženja mijenja se ovisno o odabranom okruženju.
Pristup varijabli se vrši putem ${variable_name}
Kao vrijednost varijable može biti druga varijabla, ili čak cijeli izraz. Na primjer, kao varijabla url može biti izraz poput
http://${host}:${port}/${endpoint}.
posebno valja napomenuti mogućnost dodjeljivanja varijabli tijekom izvođenja skripte. Na primjer, često se javlja potreba za pohranjivanjem podataka za autorizaciju (token ili cijela zaglavlja), koji dolaze s servera nakon uspješne prijave. TestMace omogućava pohranu takvih podataka u dinamičke varijable jednog od predaka. Kako bismo izbjegli kolizije s već postojećim 'kritičnim' varijablama, dinamičke varijable su izdvojene u zaseban objekt $dynamicVar.
Skripte
Korištenjem svih gore navedenih mogućnosti, možete izvoditi cijele skripte zahtjeva. Na primjer, stvaranje entiteta -> zahtjev za entitet -> brisanje entiteta. U ovom scenariju, možete koristiti Folder nodu za grupiranje nekoliko RequestStep nodova.
Autocomplite i isticanje vrijednosti izraza
Za jednostavniji rad s varijablama (i ne samo to) potrebno je automatsko dovršavanje. Naravno, i isticanje vrijednosti izraza, kako bi se lakše i preciznije utvrdilo koja je vrijednost određene varijable. Ovo je upravo taj slučaj kada je bolje jednom vidjeti nego stotinu puta čuti:

Treba napomenuti da je automatsko dovršavanje implementirano ne samo za varijable, već i, na primjer, za naslove, vrijednosti određenih naslova (kao što je automatsko dovršavanje za Content-Type naslov), protokole i mnoga druga. Popis se neprestano širi s rastom aplikacije.
Poništi/ponavljaj
Poništavanje/ponavljanje promjena vrlo je korisna značajka, no iz nekog razloga ne provodi se svugdje (a alati za rad s API-jem nisu iznimka). No, mi nismo takvi!) Poništavanje/ponavljanje kod nas je implementirano unutar cijelog projekta, omogućujući poništavanje ne samo uređivanja određene čvora, već i njezina stvaranja, brisanja, premještanja itd. Najkritičnije operacije zahtijevaju potvrdu.
Izrada testova
Za izradu testova odgovoran je Assertion čvor. Jedna od glavnih značajki je mogućnost izrade testova bez programiranja, koristeći ugrađene urednike.
Assertion čvor sastoji se od niza assertion-a (tvrdnji). Svaki assertion ima svoj tip, trenutno postoji nekoliko tipova assertion-a.
Usporedi vrijednosti — jednostavno uspoređuje 2 vrijednosti. Postoji nekoliko operatora usporedbe: 'jednako', 'nije jednako', 'veće', 'veće ili jednako', 'manje', 'manje ili jednako'.
Sadrži vrijednost — provjerava uključivanje podstringa u string.
XPath — provjerava da određena vrijednost leži po selektoru u XML-u.
JavaScript assertion — proizvoljni skript na jeziku JavaScript koji vraća true u slučaju uspjeha i false u slučaju neuspjeha.
Napominjem da samo posljednji zahtijeva od korisnika vještine programiranja, ostalih 3 assertion-a mogu se stvoriti pomoću grafičkog sučelja. Evo, na primjer, kako izgleda dijalog za izradu 'compare values' assertion-a:

Cherry on top je brzo stvaranje assertion-a iz odgovora, samo pogledajte ovo!

Međutim, takvi assertion-i imaju očite ograničenosti, a u slučaju s kojima se susrećete možete koristiti javascript assertion. I ovdje TestMace također pruža udobno okruženje s automatskim dovršavanjem, isticanjem sintakse i čak statičkim analizatorom.
Opis API
TestMace ne samo da omogućuje korištenje API-ja, već ga i dokumentira. Opis ima hijerarhijsku strukturu koja se prirodno uklapa u ostatak projekta. Osim toga, trenutno postoji mogućnost uvoza opisa API-ja iz Swagger 2.0 / OpenAPI 3.0 formata. Taj opis nije samo mrtvo opterećenje, već se usko integrira s ostatkom projekta; na primjer, dostupno je automatsko dovršavanje URL-ova, HTTP zaglavlja, query parametara i drugo. U budućnosti planiramo dodati testove za usklađenost odgovora s opisom API-ja.
Dijeljenje nodova
Situacija: želite podijeliti problematičan zahtjev ili čak cijeli scenarij s kolegom ili ga jednostavno pridružiti bug-u. TestMace pokriva i ovaj slučaj: aplikacija omogućuje serijalizaciju bilo kojeg nod-a, pa čak i podstabla u URL. Kopirajte i zalijepite, i već ste jednostavno prenijeli zahtjev na drugi stroj ili projekt.
Čitljiv format pohranjivanja projekta
Trenutno se svaki čvor pohranjuje u zasebnoj datoteci s ekstenzijom yml (kao u slučaju s Assertion nod-om), ili u mapi s nazivom nod-a i datotekom index.yml unutar nje.
Evo kako primjerice izgleda datoteka s zahtjevom koju smo napravili u prethodnom pregledu:
index.yml
children: []
variables: {}
type: RequestStep
assignVariables: []
requestData:
request:
method: GET
url: 'https://next.json-generator.com/api/json/get/NJv-NT-U8'
headers: []
disabledInheritedHeaders: []
params: []
body:
type: Json
jsonBody: ''
xmlBody: ''
textBody: ''
formData: []
file: ''
formURLEncoded: []
strictSSL: Inherit
authData:
type: inherit
name: Scratch 1Kao što vidite, sve je vrlo jasno. Ako želite, ovaj format se može prilično udobno uređivati i ručno.
Hijerarhija mapa u datotečnom sustavu potpuno ponavlja hijerarhiju nodova u projektu. Na primjer, scenarij poput:

Mapira se u datotečnom sustavu na sljedeću strukturu (prikazana je samo hijerarhija mapa, ali suština je jasna)

Što olakšava proces pregleda projekta.
Uvoz iz Postmana
Nakon što ste pročitali sve navedeno, neki korisnici možda će htjeti isprobati (zar ne?) novi proizvod ili (tko zna?) potpuno ga koristiti u svom projektu. Međutim, migraciju može zaustaviti velika količina rada u istom Postmanu. Za takve slučajeve, TestMace podržava uvoz kolekcija iz Postmana. Trenutno se podržava uvoz bez testova, no u budućnosti ne isključujemo njihovu podršku.
Planovi
Nadam se da je naš proizvod ljekovit mnogim onima koji su dočekali do ovog trenutka. Međutim, to još nije sve! Rad na proizvodu se intenzivno nastavlja i evo nekih značajki koje planiramo dodati uskoro.
Oblačno sinkroniziranje
Jedna od najtraženijih značajki. Trenutno nudimo korištenje sustava kontroli verzijama za sinkronizaciju, zbog čega format činimo prijateljskim za ovaj način pohrane. Međutim, ne odgovara svima takav radni tok, stoga planiramo dodati uobičajeni mehanizam sinkronizacije putem naših poslužitelja.
CLI
Kao što je već rečeno, IDE proizvodi ne mogu proći bez raznih integracija s postojećim aplikacijama ili radnim tokovima. CLI je upravo potreban za integraciju testova napisanih u TestMace-u u proces kontinuirane integracije. Rad na CLI-ju se intenzivno nastavlja, u ranim verzijama bit će moguće pokretanje projekta uz jednostavno konzolno izvješće. U budućnosti planiramo dodati izlaz izvješća u JUnit formatu.
Sustav dodataka
Unatoč svem snagama našeg alata, skup slučajeva kojima se treba baviti je neograničen. U konačnici postoje zadaci specifični za određeni projekt. Iz tog razloga planiramo dodati SDK za razvoj dodataka, a svaki programer moći će dodati funkcionalnost po svom ukusu.
Proširenje asortimana tipova čvorova
Ova skupina čvorova ne pokriva sve slučajeve potrebne korisniku. Čvorovi koje planiramo dodati:
- Script čvor — pretvara i smješta podatke koristeći js i odgovarajući API. Koristeći ovaj tip čvora, možete napraviti stvari slične pre-request i post-request skriptama u Postmanu.
- GraphQL čvor — podrška za graphql
- Custom assertion čvor — omogućit će proširenje postojećih assertion-a u projektu
Naravno, ovo nije konačni popis, on će se stalno dopunjavati, uključujući i vaš feedback.
FAQ
Čime se razlikujete od Postmana?
- Koncept čvorova koji omogućuje gotovo beskonačno skaliranje funkcionalnosti projekta
- Čitljiv format projekta uz pohranu u datotečni sustav, što pojednostavljuje rad s korištenjem sustava kontrole verzija
- Mogućnost stvaranja testova bez programiranja i naprednija podrška za js u uređivaču testova (autocomplet, statička analiza)
- Napredno automatsko dovršavanje i isticanje trenutne vrijednosti varijabli
Je li ovo open-source proizvod?
Ne, trenutno su izvori zatvoreni, no u budućnosti razmatramo mogućnost otvaranja izvora
Kako zarađujete?)
Uz besplatnu verziju planiramo izdati plaćenu verziju proizvoda. Ona će u prvo vrijeme sadržavati funkcionalnosti koje zahtijevaju serversku infrastrukturu, poput sinkronizacije.
Zaključak
Naš projekt brzim koracima napreduje prema stabilnom izdanju. Međutim, već sada se proizvod može koristiti, a pozitivne povratne informacije naših ranih korisnika to potvrđuju. Aktivno prikupljamo povratne informacije, jer bez bliske suradnje s zajednicom nije moguće izgraditi dobar alat. Možete nas pronaći ovdje:
Veselimo se vašim željama i prijedlozima!
Izvor: habr.com
