Hej alla, här är vi TestMace! Många kanske känner oss genom våra de tidigare artiklar. För dem som just har kopplat upp sig: vi utvecklar en IDE för att arbeta med API TestMace. Den vanligaste frågan vid jämförelse av TestMace med konkurrerande produkter är: "Hur skiljer ni er från Postman?" Vi har bestämt oss för att det är dags att ge ett utförligt svar på denna fråga. Nedan har vi punkt för punkt beskrivit våra fördelar gentemot Postman.

Uppdelning i noder

Om du arbetar med Postman vet du att förfrågningsgränssnittet innehåller all nödvändig funktionalitet. Här finns både skript, tester och förfrågningar. Detta förenklar arbetet för nybörjare, men på större scenarier är denna metod inte flexibel. Vad händer om du vill skapa flera förfrågningar och göra en aggregering på dem? Vad händer om du vill köra ett skript utan förfrågan eller flera logiskt separerade skript i följd? I slutändan skulle det vara bra att separera tester från vanliga utilitariska skript. Dessutom är tillvägagångssättet "att lägga till all funktionalitet i en nod" inte skalbart - gränssnittet blir snabbt överbelastat.

TestMace delar från början upp all funktionalitet i olika typer av noder. Vill du göra en förfrågan? Här har du request step nod. Vill du skriva ett skript? Här har du script nod. Behöver du tester? Varsågod - Assertion nod. Åh ja, du kan också slå in allt detta i en folder nod. Och allt detta går lätt att kombinera. Detta tillvägagångssätt är inte bara mycket flexibelt, utan enligt principen om enhetlig ansvarighet tillåter det att använda bara det du verkligen behöver just nu. Varför skulle jag behöva skript och tester om jag bara vill göra en förfrågan?

Mänskligt läsbart projektformat

Det finns en konceptuell skillnad mellan TestMace och Postman i hur de lagrar data. I Postman lagras alla förfrågningar någonstans i det lokala lagret. Om det finns ett behov av att dela förfrågningar mellan flera användare måste man använda den inbyggda synkroniseringen. Detta är faktiskt en allmänt accepterad metod, men den har sina nackdelar. Hur är det med datasäkerheten? Faktum är att vissa företags policyer kanske inte tillåter lagring av data hos tredje part. Men vi anser att TestMace kan erbjuda något bättre! Och namnet på denna förbättring är "mänskligt läsbart projektformat".

Låt oss börja med att säga att det faktiskt finns en entitet "projekt" i TestMace. Applikationen har från början utvecklats med tanke på att lagra projekt i versionshanteringssystem: projektträdet projiceras praktiskt taget rakt av på filstrukturen, lagringsformatet som används är yaml (utan onödiga klamrar och kommatecken), och filpresentationen av varje nod är detaljerat beskriven i dokumentationen med kommentarer. Men i de flesta fall kommer du inte att behöva titta där — alla fältnamn har logiska beteckningar.

Vad ger detta användaren? Det möjliggör en mycket flexibel förändring av teamets arbetsflöde, med hjälp av bekanta metoder. Till exempel kan utvecklare lagra projektet i samma repository som backend. I grenarna, förutom att ändra själva kodbasen, kan utvecklaren justera existerande frågescenarier och tester. Efter att ändringarna har bekräftats i repositoryt (git, svn, mercurial — vad du än föredrar) kör CI (din favorit som ingen har pådyvlat) vårt kommandoradsverktyg testmace-cli, och rapporten som genereras efter körningen (till exempel i junit-format, som också stöds av testmace-cli) skickas till det motsvarande systemet. Och den ovan nämnda säkerhetsfrågan är inte längre ett problem.

Som ni kan se, TestMace inför inte sin egen ekosystem eller paradigm. Istället integreras det lätt i redan etablerade processer.

Dynamiska variabler

TestMace följer konceptet no-code: om problemet kan lösas utan att använda kod, försöker vi ge den möjligheten. Att arbeta med variabler är just den funktionaliteten där man i de flesta fall kan klara sig utan programmering.

Exempel: vi fick ett svar från servern, och vi vill spara en del av svaret i en variabel. I Postman skulle vi i testscripten (vilket i sig är konstigt) skriva något i stil med:

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("data", jsonData.data);

Men enligt vår mening verkar det överflödigt att skriva ett skript för ett så enkelt och ofta använt scenario. Därför finns det i TestMace en möjlighet att tilldela variabeln en del av svaret, med hjälp av det grafiska gränssnittet. Se hur enkelt det är:

Och nu kommer denna dynamiska variabel att uppdateras vid varje förfrågan. Men du kan invända och hävda att Postman-metoden är mer flexibel och tillåter inte bara att göra en tilldelning, utan också att utföra viss förbehandling. Här är hur du kan modifiera det tidigare exemplet:

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("data", CryptoJS.MD5(jsonData.data));

Nåväl, för detta finns det script en nod i TestMace som täcker detta scenario. För att återskapa det tidigare fallet, men nu i TestMace, krävs att du efter förfrågan skapar en script-nod och använder följande kod som script:

const data = tm.currentNode.prev.response.body.data;
tm.currentNode.parent.setDynamicVar('data', crypto.MD5(data));

Som du kan se har kompositionen av noder gjort stor nytta här. Och för ett så enkelt fall, som det ovan beskrivna, kan du faktiskt bara tilldela ett uttryck ${crypto.MD5($response.data)} till den variabel som skapas via det grafiska gränssnittet!

Skapande av tester via GUI

Postman möjliggör skapande av tester genom att skriva skript (i Postman är det JavaScript). Denna metod har en mängd fördelar — nästan obegränsad flexibilitet, tillgång till färdiga lösningar, etc.

Men verkligheten är ofta sådan (inte vi, utan livet), att testaren saknar programmeringsfärdigheter, och man vill gärna bidra till teamet redan nu. För sådana fall, i enlighet med no-code-konceptet, låter TestMace dig skapa enkla tester via det grafiska gränssnittet, utan att skriva skript. Här är exempel på hur processen för att skapa ett test som jämför värden ser ut:

Men att skapa tester i den grafiska redaktören utesluter inte möjligheten att skriva tester i kod. Här finns alla samma bibliotek som i script-noden, och chai för att skriva tester.

Möjligheten att köra ett redan existerande scenario via länk (Link nod)

Uppstår ofta situationer där en viss förfrågan eller till och med ett helt scenario måste utföras flera gånger på olika delar av projektet. Exempel på sådana förfrågningar kan vara anpassad flerstegsautentisering, att sätta miljön i rätt tillstånd, etc. Om vi pratar i termer av programmeringsspråk skulle man vilja ha funktioner som kan återanvändas på olika ställen i applikationen. I TestMace utför denna funktion link Knut. Det är mycket enkelt att använda:
1) Skapa en begäran eller ett skript
2) Skapa en nod av typen Länk
3) Ange länken till skriptet som skapades i steg ett i parametrarna

I en mer avancerad variant kan du ange vilka dynamiska variabler från skriptet som ska föras vidare till överliggande nivåer relativt länken. Låter det förvirrat? Anta att vi har skapat en mapp med namnet create-post, där en dynamisk variabel tilldelas denna nod postId. Nu i Länk-noden create-post-link kan du uttryckligen ange att variabeln postId tilldelas föräldern create-post-link. Denna mekanism (återigen, uttryckt i programmeringstermer) kan användas för att returnera resultat från "funktionen". Allt som allt är det fantastiskt, DRY i full skala och återigen har ingen kodlinje skadats.

När det gäller Postman har funktionen för återanvändning av begärningar hängt sedan 2015, och det verkar till och med finnas några ledtrådar, på att det arbetas på detta problem. I sitt nuvarande skick har Postman naturligtvis möjlighet till flödesändring, vilket i teorin troligen skulle kunna möjliggöra ett sådant beteende, men det är snarare en smutsig hack än en verkligt fungerande metod.

Övriga skillnader

• Större kontroll över variablers synlighet. Den minsta omfattningen inom vilken en variabel kan definieras i Postman är samlingen. TestMace gör det möjligt att definiera variabler för vilken begäran eller mapp som helst. I Postman tillåter delning av samlingar att exportera endast samlingar, medan i TestMace fungerar delning för varje nod
• TestMace stöder ärvda rubriker, som som standard kan inkluderas i underliggande begärningar. När det gäller Postman finns det uppgift, och det är till och med stängt, men som lösning föreslås… att använda skript. I TestMace konfigureras allt detta genom GUI och det finns möjlighet att valfritt stänga av ärvda rubriker i specifika underordnade
• Ångra/Gör om. Fungerar inte bara vid redigering av noder, utan också vid flyttning, radering, omdöpning och andra operationer som ändrar projektstrukturen
• Filer som bifogas till begärningar blir en del av projektet och lagras tillsammans med det, och synkroniseras perfekt, till skillnad från Postman. (Ja, du behöver inte längre manuellt välja filer varje gång och överföra till kollegor i arkiv)

Funktioner som redan är på väg

Vi kunde inte motstå frestelsen att öppna en liten del av hemligheten kring kommande releaser, särskilt inte när funktionerna är så attraktiva och redan genomgår en förrelease-finslipning. Låt oss välkomna dem.

Funktioner

Som bekant används så kallade dynamiska variabler för att generera värden i Postman. Listan är imponerande och den överväldigande majoriteten av funktionerna syftar till att generera falska värden. Till exempel, för att generera en slumpmässig e-postadress behöver man skriva:

{{ $randomEmail }}

Men eftersom detta är variabler (även om de är dynamiska) kan de inte användas som funktioner: de är inte parameteriserade, och därmed går det inte att ta en hash av en sträng.

På TestMace planerar vi att lägga till "ärliga" funktioner. Direkt inom ${} kan du inte bara referera till en variabel utan även anropa en funktion. Det vill säga, om vi behöver generera den beryktade falska e-postadressen skriver vi helt enkelt

${faker.internet.email()}

Förutom att det är en funktion, kan man också se att det finns möjlighet att anropa metod från ett objekt. Och istället för en stor platt lista av dynamiska variabler har vi en uppsättning logiskt grupperade objekt.

Vad händer om vi vill räkna ut en hash från en sträng? Inga problem!

${crypto.MD5($dynamicVar.data)}

Man kan se att man till och med kan skicka variabler som parametrar! Vid detta tillfälle kan den nyfikna läsaren misstänka att något är fel...

Användning av JavaScript i uttryck

... och med rätta! När kraven på funktionerna formulerades kom vi plötsligt fram till att uttryck måste tillåta giltig JavaScript. Så nu är det fritt fram att skriva uttryck i stil med:

${1 + '' + crypto.MD5('asdf')}

Och allt detta utan skript direkt i inmatningsfälten!

När det gäller Postman kan man bara använda variabler, och vid försök att skriva ens ett litet uttryck klagar validatorn och vägrar att beräkna det.

Avancerad autocompletion

För närvarande har TestMace standardautocompletion som ser ut på följande sätt:

Här, förutom den autocompleta strängen, anges även vad denna sträng tillhör. Denna mekanism fungerar endast i uttryck som är inneslutna i klamrar ${}.

Som du kan märka har vi lagt till visuella markörer som indikerar typ av variabel (t.ex. sträng, tal, array osv.). Du kan också växla mellan autocompletion-lägen (t.ex. välja autocompletion med variabler eller rubriker). Men även det är inte det viktigaste!

För det första fungerar autocompletion även i uttryck (där det är möjligt). Så här ser det ut:

Och för det andra är autocompletion nu också tillgängligt i skripten. Titta på hur det fungerar!

Det är inte meningsfullt att jämföra denna funktionalitet med Postman - där begränsas autocompletion endast till statiska listor av variabler, rubriker och deras värden (korrigera mig om jag missat något). Skripten autocompletas inte 🙁

Slutsats

I oktober firade vi ett år sedan vi började utveckla vår produkt. Under denna tid har vi gjort mycket och i vissa avseenden hunnit ikapp våra konkurrenter. Men hur som helst, vårt mål är att skapa ett riktigt användarvänligt verktyg för att arbeta med API. Vi har fortfarande mycket arbete kvar, här är en ungefärlig utvecklingsplan för vårt projekt under det kommande året: https://testmace.com/roadmap.

Din feedback kommer att hjälpa oss att bättre navigera i mängden funktioner, och ditt stöd ger oss kraft och förtroende i att det vi gör är viktigt. Det råkade bli så att idag är en betydelsefull dag för vårt projekt - dagen för publiceringen av TestMace på ProductHunt. Vänligen stöd vårt projekt, det är väldigt viktigt för oss. Speciellt eftersom vi har ett lockande erbjudande på vår PH-sida idag, och det är begränsat

Källa: habr.com