Com s'utilitza la integració de línia d'ordres amb Newman In Postman?

how use command line integration with newman postman

Apreneu a executar col·leccions de carters amb Newman:

En aquest tutorial, veurem com podem integrar o executar col·leccions de Postman a través de la línia d'ordres mitjançant Newman, que és una eina d'integració de línia d'ordres per a Postman.

Newman és una eina gratuïta i de codi obert. Proporciona funcions potents per executar les col·leccions Postman, aprofitant funcions súper útils de Postman, com ara proves, afirmacions, scripts de sol·licitud prèvia, etc. i executant la col·lecció a través de la línia d'ordres.

=> Consulteu aquí per veure aquí A-Z de tutorials de formació sobre carters.

Què aprendreu:

• Què és Newman?
  • Instal·lació de Newman
  • Execució de col·leccions mitjançant Newman
  • Integració de Newman amb variables d'entorn
  • Resultats de l'asserció mitjançant Newman
  • Generació d'informes mitjançant Newman
  • Integració amb eines CI
  • Més opcions amb Newman
• Conclusió
  • Lectura recomanada

Què és Newman?

Newman és un corredor de línia d'ordres per a col·leccions de Postman. En altres paraules, permet a un usuari executar una col·lecció Postman existent a través de la línia d'ordres.

Espera o consumeix la versió JSON de la col·lecció que es pot obtenir simplement exportant la col·lecció en format de col·lecció JSON o l’URL de la col·lecció, que no és altra cosa que el mateix JSON obtingut per l’exportació de la col·lecció.

Aquí teniu un vídeo tutorial:

Instal·lació de Newman

Newman és un mòdul NodeJS i, per tant, depèn del sistema que tingui el node instal·lat. Per comprovar si el node està instal·lat o no, només cal que comproveu la versió del node al sistema mitjançant l'ordre següent.

Si l'ordre retorna una sortida tal com s'ha indicat anteriorment, vol dir que aquest node està instal·lat i que estem bé d'anar amb la instal·lació de Newman. Si no, podeu instal·lar el node consultant les instruccions d'instal·lació aquí

Quan la instal·lació del node tingui èxit, podeu instal·lar Newman com qualsevol altre paquet de nodes mitjançant l'ordre següent.

Aquí ‘-g’ indica una instal·lació global que significa que el paquet Newman serà accessible des de qualsevol carpeta / ubicació del sistema de fitxers. Per fer una instal·lació local, podeu eliminar el senyalador '-g' de l'anterior, on el paquet Newman només serà accessible des de la ubicació o carpeta instal·lada.

Per validar la correcta instal·lació de Newman, només podeu comprovar-ne la versió mitjançant l'ordre següent.

Execució de col·leccions mitjançant Newman

Per executar col·leccions amb Newman, n’heu de tenir una de les dues.

1. La col·lecció en format JSON.
2. URL de la col·lecció allotjada.

L'ordre que s'utilitza per executar la col·lecció Postman mitjançant Newman és:

on trobar la clau de seguretat de la xarxa

Intentem executar una col·lecció de mostres amb Postman.

1. Aneu a l'aplicació Postman, utilitzeu qualsevol col·lecció existent de Postman i exporteu-la al formulari JSON. (Crearem una nova col·lecció amb 3 sol·licituds, és a dir, Registre d'usuari, usuari d'inici de sessió i obtenció d'usuari mitjançant el formulari de punts finals de l'API aquí ).
2. Ara exporteu la col·lecció al format JSON.
3. Un cop obtinguda la col·lecció JSON, obriu un símbol del sistema i executeu la col·lecció mitjançant l'ordre Newman run (suposem que la col·lecció s'ha exportat amb nom - Postman_Newman_IntegrationCollection .json) i l’usuari ha navegat al directori d’exportació de col·leccions, la col·lecció es pot executar simplement utilitzant l’ordre següent.

Un cop executada l'ordre anterior, es produeix la següent sortida.

Integració de Newman amb variables d'entorn

Ara vegem usos més avançats de Newman. Per a una col·lecció que no depengui de cap variable d'entorn, la col·lecció es podria executar simplement mitjançant l'ordre Newman run. Però per a les col·leccions, utilitzant les variables d'entorn, hem de proporcionar la variable d'entorn JSON, juntament amb la col·lecció JSON.

Exemple: Utilitzarem la mateixa col·lecció i utilitzarem una variable d’entorn per al punt final de l’usuari GET, és a dir, per a sol·licitud amb punt final .

Utilitzarem userId de la col·lecció de variables d’entorn. Per tant, la sol·licitud resultant es convertirà en https://reqres.in/api/users/{{userId}}

Ara, un cop creat el fitxer d'entorn, exporteu-lo com a JSON seguint els passos següents.

1. Creeu un entorn, amb una variable anomenada userId i el valor s’ha d’establir a ‘4’.
2. Ara feu clic al botó Configuració per obrir la finestra 'Gestiona entorns'.
3. Feu clic a la icona 'Baixa' a l'entorn creat per baixar-lo com a fitxer JSON (deseu el fitxer amb el nom com a 'testEnv.json).

Tornem a exportar la col·lecció amb la sol·licitud modificada i provem d'executar la mateixa col·lecció juntament amb el fitxer d'entorn amb l'ordre següent:

Una vegada que s’executa l’ordre anterior, la sortida continua sent la mateixa que l’execució de recopilació directa, sent l’únic canvi que la sol·licitud ‘GET User’ ara obté el valor del fitxer JSON de l’entorn.

Resultats de l'asserció mitjançant Newman

Com que les sol·licituds de Postman també poden contenir afirmacions, ara farem un seguit de com es mostren els resultats de les afirmacions quan les col·leccions de Postman s’executen a través d’un Newman.

El corredor de la col·lecció Newman està en paritat amb el corredor de la col·lecció Postman i l'executor de la sol·licitud. Per a les sol·licituds que tinguin afirmacions, les afirmacions s'avaluen a mesura que finalitza l'execució de la sol·licitud i es mostra el resum de l'execució de l'asserció al resum de la prova al final de l'execució de la prova.

Per a la col·lecció anterior, hem afegit una afirmació de nivell de col·lecció per comprovar que el codi d'estat de la resposta és de 200, és a dir, per a cada sol·licitud que formi part de la col·lecció hi hauria d'haver-hi associada.

Per tant, si aquesta col·lecció tenia 3 sol·licituds, vol dir que hi hauria d’haver un total de 3 afirmacions que s’haurien d’haver executat.

Consulteu la captura de pantalla següent per obtenir resultats d’execució i d’assercions ressaltats.

Generació d'informes mitjançant Newman

Fins ara sabem que Newman pot executar col·leccions de Postman a través de la línia d’ordres i generar alguns registres de proves i resum d’execució de proves. Però, què passa amb els informes amb format que es podrien compartir o publicar en algun servidor?

Bé, Newman també hi dóna suport. Hi ha alguns mòduls de nodes personalitzats disponibles per generar informes d'execució de proves de Newman. Passarem per un exemple amb un newman-html-reporter .

Aquest reporter torna a ser un mòdul de node i s’ha d’instal·lar per separat mitjançant l’ordre següent.

Un cop instal·lat el mòdul anterior, es pot utilitzar juntament amb l'ordre Newman run.

El senyalador ‘-r’ indica l’informador que s’ha d’utilitzar amb la col·lecció Newman.

Amb aquesta opció, fa ús del mòdul o paquets Newman-reporter-html i crea un informe basat en HTML per a l'execució de la prova.

Consulteu una d'aquestes captures de pantalla de l'informe HTML que es mostra a continuació:

Integració amb eines CI

Amb Newman que té la capacitat d’executar-se com a línia d’ordres, redueix molta dependència de qualsevol requisit previ en forma de consola o aplicació, és a dir, l’única dependència que té Newman és un node (que generalment està disponible com a execució entorn de totes les màquines CI com els esclaus Jenkins o els nodes Travis).

Això permet que les col·leccions Postman s'executin com a part de les canonades de construcció a través de la línia d'ordres de Newman.

Com que Newman també té la possibilitat d’imprimir resultats en format Html, això és molt útil i útil i durant la pròpia execució de la canonada, els resultats HTML es poden enviar a un servidor o es poden enviar per correu electrònic als usuaris desitjats, etc. les capacitats són infinites ja que les dependències són mínimes.

Per obtenir un exemple d’execució detallada d’execució d’integració amb Jenkins, consulteu aquest exemple del blog oficial de Postman aquí .

Més opcions amb Newman

Tot el que hem cobert és un subconjunt de la funcionalitat que proporciona Newman. Per obtenir detalls complets d'ordres i commutadors compatibles amb Newman, només cal que obriu l'ajuda de la línia d'ordres per a Newman mitjançant l'ordre següent.

Aquí teniu la sortida de l’ordre anterior, amb detalls sobre tots els commutadors i els seus significats.

També hi ha altres recursos d'informació per a la referència de l'API Newman. Consulteu aquí per a la documentació oficial.

Conclusió

En aquest tutorial, vam recórrer la integració de la línia d'ordres de Postman anomenada Newman, que permet executar col·leccions de Postman a través d'una interfície de línia d'ordres.

Simplement és un paquet de nodes i qualsevol línia de comandes que tingui un node instal·lat juntament amb Newman hauria de poder executar la col·lecció Postman i generar informes d’execució de la col·lecció.

La integració a la línia d’ordres també és de gran ajuda per a la integració de proves de col·lecció basades en Postman amb eines de CI com Jenkins, Travis, etc. col · lecció.

=> Visiteu aquí la sèrie de cursos de formació exclusiva sobre carters.

Lectura recomanada

• Talla l'ordre a Unix amb exemples
• Sintaxi d’ordres Unix Cat, opcions amb exemples
• Ordre Ls a Unix amb exemples
• Com i quan s'utilitzen els scripts Post Request Pre i Post Request?
• Ordre Grep a Unix amb exemples senzills
• Arguments de la línia d'ordres a C ++
• Ordre d'ordenació Unix amb sintaxi, opcions i exemples
• Arguments de la línia d'ordres a Unix Shell Script amb exemple