Cum se utilizează integrarea liniei de comandă cu Newman în Postman?

how use command line integration with newman postman

Aflați cum să executați colecții de poștași folosind Newman:

În acest tutorial, vom vedea cum putem integra sau executa colecții Postman prin linia de comandă folosind Newman, care este un instrument de integrare a liniei de comandă pentru Postman.

Newman este un instrument gratuit și open-source. Oferă capabilități puternice pentru a rula colecțiile Postman, valorificând capabilitățile super-utile ale Postman, cum ar fi teste, afirmații, scripturi de pre-solicitare, etc. și rularea colecției prin linia de comandă.

=> Verificați aici pentru a vedea A-Z a tutorialelor de formare a poștașilor aici.

Ce veți învăța:

• Ce este Newman?
  • Se instalează Newman
  • Rularea colecțiilor folosind Newman
  • Integrare Newman cu variabile de mediu
  • Rezultate de afirmare folosind Newman
  • Generarea de rapoarte folosind Newman
  • Integrare cu instrumente CI
  • Mai multe opțiuni cu Newman
• Concluzie
  • Lectură recomandată

Ce este Newman?

Newman este un alergător de linie de comandă pentru colecțiile Postman. Cu alte cuvinte, permite utilizatorului să ruleze o colecție Postman existentă prin linia de comandă.

Se așteaptă sau consumă versiunea JSON a colecției care poate fi obținută prin simpla exportare a colecției în format de colecție JSON sau URL-ul colecției care nu este altceva decât același JSON obținut prin exportul colecției.

Iată un tutorial video:

Se instalează Newman

Newman este un modul NodeJS și, prin urmare, depinde de sistemul care are nodul instalat. Pentru a verifica dacă nodul este instalat sau nu, pur și simplu verificați versiunea nodului pe sistem utilizând comanda de mai jos.

Dacă comanda returnează o ieșire ca mai sus, atunci înseamnă că nodul este instalat și suntem bine să mergem cu instalarea Newman. Dacă nu, puteți instala nodul consultând instrucțiunile de instalare Aici

Odată ce instalarea nodului este reușită, puteți instala pur și simplu Newman ca orice alt pachet de noduri utilizând comanda de mai jos.

Aici ‘-g’ indică instalarea globală, ceea ce înseamnă că pachetul Newman va fi accesibil din orice folder / locație din sistemul de fișiere. Pentru a efectua o instalare locală, puteți elimina semnalizatorul ‘-g’ din cele de mai sus, unde pachetul Newman va fi accesibil doar din locația sau folderul instalat.

Pentru a valida instalarea cu succes a Newman, puteți verifica pur și simplu versiunea sa folosind comanda de mai jos.

Rularea colecțiilor folosind Newman

Pentru a rula colecții folosind Newman, ar trebui să aveți oricare dintre cele 2.

1. Colecția în format JSON.
2. Adresa URL a colecției găzduite.

Comanda folosită pentru a rula colecția Postman folosind Newman este:

de ce gateway-ul meu implicit continuă să meargă offline

Să încercăm să rulăm o colecție de eșantioane folosind Postman.

1. Accesați aplicația Postman, utilizați orice colecție Postman existentă și exportați-o în formularul JSON. (Vom crea o nouă colecție cu 3 solicitări, adică Înregistrați utilizator, Conectați-vă utilizator și Obțineți utilizator utilizând formularul de puncte finale API Aici ).
2. Acum exportați colecția în format JSON.
3. După obținerea colecției JSON, deschideți un prompt de comandă și rulați colecția folosind comanda Newman run (să presupunem că colecția a fost exportată cu nume - Postman_Newman_IntegrationCollection .json) și utilizatorul a navigat în directorul de export al colecției, atunci colecția poate fi executată pur și simplu utilizând comanda de mai jos.

Odată executată comanda de mai sus, se produce următoarea ieșire.

Integrare Newman cu variabile de mediu

Acum să vedem utilizări mai avansate ale lui Newman. Pentru o colecție care nu se bazează pe nicio variabilă de mediu, colecția ar putea fi pur și simplu executată utilizând comanda Newman run. Dar pentru colecții, folosind variabilele de mediu, trebuie să furnizăm și variabila de mediu JSON împreună cu colecția JSON.

Exemplu: Vom folosi aceeași colecție și vom folosi o variabilă de mediu pentru GET User endpoint, adică pentru cerere cu punctul final .

Vom folosi userId din colecția de variabile de mediu. Deci solicitarea rezultată va deveni https://reqres.in/api/users/{{userId}}

Acum, odată creat fișierul de mediu, exportați-l ca JSON, utilizând pașii de mai jos.

1. Creați un mediu, cu o variabilă numită userId și valoarea trebuie setată la „4”.
2. Acum, faceți clic pe butonul Setări, pentru a deschide fereastra „Gestionați mediile”.
3. Faceți clic pe pictograma „Descărcați” împotriva mediului creat pentru a descărca mediul ca fișier JSON (salvați fișierul cu numele ca „testEnv.json).

Să exportăm din nou colecția cu solicitarea modificată și să încercăm să rulăm aceeași colecție împreună cu fișierul de mediu cu comanda de mai jos:

Odată ce comanda de mai sus este executată, ieșirea rămâne aceeași cu executarea colectării directe, singura modificare fiind că cererea „GET User” preia acum valoarea din fișierul JSON de mediu.

Rezultate de afirmare folosind Newman

Deoarece solicitările Postman pot conține și afirmații, vom face acum o prezentare generală a modului în care sunt afișate rezultatele afirmației atunci când colecțiile Postman sunt executate printr-un Newman.

Runnerul colecției Newman este într-o paritate completă cu alergătorul Postman Collection și executorul Request. Pentru cererile care au afirmații, afirmațiile sunt evaluate ca și când se finalizează execuția cererii și rezumatul execuției afirmației este afișat în rezumatul testului la sfârșitul testului.

Pentru colecția de mai sus, am adăugat o afirmație la nivel de colecție pentru a verifica codul de stare al răspunsului la 200, adică pentru fiecare cerere care face parte din colecție ar trebui să existe această afirmație asociată.

Deci, dacă această colecție a avut 3 cereri, înseamnă că ar trebui să existe un total de 3 afirmații care ar fi trebuit executate.

Vă rugăm să consultați captura de ecran de mai jos pentru rezultatele de execuție evidențiate și rezultatele afirmării.

Generarea de rapoarte folosind Newman

Până acum știm că Newman poate rula colecțiile Postman prin linia de comandă și poate genera câteva jurnale de testare și rezumatul executării testelor. Dar ce zici de rapoartele formatate care ar putea fi partajate sau publicate pe un server?

Ei bine, Newman are sprijin și pentru asta. Există câteva module de nod personalizate disponibile pentru generarea rapoartelor de execuție a testului Newman. Vom parcurge un exemplu folosind un newman-html-reporter .

Acest reporter este din nou un modul nod și trebuie instalat separat folosind comanda de mai jos.

Odată ce modulul de mai sus este instalat, acesta poate fi utilizat împreună cu comanda Newman run.

Semnalizatorul „-r”, indică reporterul care va fi utilizat cu colecția Newman executată.

Cu această opțiune, folosește modulul sau pachetele Newman-reporter-html și creează un raport bazat pe HTML pentru executarea testului.

Consultați o astfel de captură de ecran a raportului HTML prezentat mai jos:

Integrare cu instrumente CI

Având Newman capacitățile de a rula ca o linie de comandă, reduce o mare dependență de orice cerință prealabilă sub formă de consolă sau aplicație, adică singura dependență pe care Newman o are este un nod (care este în general disponibil ca o execuție mediu în toate mașinile CI precum sclavii Jenkins sau nodurile Travis).

Aceasta permite colecțiilor Postman să fie executate ca parte a conductelor de construcție în sine prin linia de comandă Newman.

Deoarece Newman are capabilități de a împinge rezultatele și în format Html, acest lucru este foarte util și la îndemână și în timpul executării conductei în sine, rezultatele HTML ar putea fi trimise către un server sau pot fi trimise printr-un e-mail către utilizatorii doriți etc. capabilitățile sunt nelimitate, deoarece dependențele sunt minime.

Pentru un exemplu detaliat de integrare cu Jenkins, vă rugăm să consultați acest exemplu de pe blogul oficial al lui Postman Aici .

Mai multe opțiuni cu Newman

Orice am acoperit este un subset al funcționalității oferite de Newman. Pentru detalii complete despre comenzi și comutatoare pe care Newman le acceptă, pur și simplu deschideți linia de comandă pentru Newman folosind comanda de mai jos.

Iată rezultatul comenzii de mai sus, cu detalii despre toate comutatoarele și semnificațiile acestora.

Există și alte resurse de informații pentru referința API-ului Newman. Vă rugăm să consultați Aici pentru documentația oficială.

Concluzie

În acest tutorial, am parcurs integrarea în linia de comandă a Postman numită Newman, care permite rularea colecțiilor Postman printr-o interfață din linia de comandă.

Este pur și simplu un pachet de noduri și orice linie de comandă care are nodul instalat împreună cu Newman ar trebui să poată rula colecția Postman și să genereze rapoarte bune despre execuția colecției.

Integrarea în linia de comandă este, de asemenea, de mare ajutor pentru integrarea testelor de colecție bazate pe Postman cu instrumente CI precum Jenkins, Travis, etc. Colectie.

=> Vizitați aici pentru seria de tutoriale de formare a poștașilor exclusivi.

Lectură recomandată

• Tăiați comanda în Unix cu exemple
• Sintaxa de comandă Cat Unix, Opțiuni cu exemple
• Comanda Ls în Unix cu exemple
• Cum și când se utilizează scripturile Postman Pre Request și Post Request?
• Comanda Grep în Unix cu exemple simple
• Argumente pentru linia de comandă în C ++
• Comanda de sortare Unix cu sintaxă, opțiuni și exemple
• Argumente de linie de comandă în scriptul Shell Unix cu exemplu