Menu

Ako používať integráciu príkazového riadku s Newmanom v Postmani?

  • Hlavná
  • Iné
  • Ako používať integráciu príkazového riadku s Newmanom v Postmani?

how use command line integration with newman postman

Vyskúšajte Náš Nástroj Na Odstránenie Problémov

Naučte sa vykonávať poštové zbierky pomocou Newmana:

V tomto tutoriále uvidíme, ako môžeme integrovať alebo spustiť zbierky Postmana prostredníctvom príkazového riadku pomocou nástroja Newman, ktorý je nástrojom na integráciu príkazového riadku pre Postman.

Newman je bezplatný nástroj otvoreného zdroja. Poskytuje výkonné funkcie na spúšťanie zbierok Postman, využíva mimoriadne užitočné možnosti Postmana, ako sú Testy, Assertions, Skripty na vyžiadanie atď., A spúšťanie kolekcie prostredníctvom príkazového riadku.

=> Skontrolujte tu, aby ste tu videli A-Z výučbových kurzov pre poštárov.

Postman_ Integrácia príkazového riadku s Newmanom

Čo sa dozviete:

Čo je Newman?

Newman je príkazový riadok pre zbierky Postman. Inými slovami umožňuje používateľovi spustiť existujúcu zbierku Postman cez príkazový riadok.

Očakáva alebo spotrebúva verziu kolekcie JSON, ktorú je možné získať jednoduchým exportom kolekcie vo formáte kolekcie JSON alebo adresou URL kolekcie, ktorá nie je ničím iným než rovnakým súborom JSON, ktorý sa získal exportom kolekcie.

Tu je videonávod:

Inštaluje sa Newman

Newman je modul NodeJS a je teda závislý od systému, ktorý má nainštalovaný uzol. Ak chcete skontrolovať, či je uzol nainštalovaný alebo nie, jednoducho pomocou nasledujúceho príkazu skontrolujte verziu uzla v systéme.

$ node -v v10.15.3

Ak príkaz vráti nejaký výstup, ako je uvedené vyššie, znamená to, že uzol je nainštalovaný a je dobré ísť s inštaláciou Newmana. Ak nie, môžete uzol nainštalovať podľa pokynov na inštaláciu tu

Akonáhle je inštalácia uzla úspešná, môžete Newman jednoducho nainštalovať ako každý iný balíček uzlov pomocou príkazu nižšie.

npm install -g newman

„-G“ tu označuje globálnu inštaláciu, čo znamená, že balík Newman bude prístupný z ľubovoľného priečinka alebo umiestnenia v súborovom systéme. Pri lokálnej inštalácii môžete z vyššie uvedeného odstrániť príznak „-g“, kde bude balík Newman prístupný iba z nainštalovaného umiestnenia alebo priečinka.

Ak chcete overiť úspešnú inštaláciu produktu Newman, môžete jednoducho skontrolovať jeho verziu pomocou nasledujúceho príkazu.

newman -v 4.5.1

Spúšťanie zbierok pomocou Newmana

Ak chcete spúšťať zbierky pomocou Newmana, mali by ste mať ktorýkoľvek z 2.

  1. Zbierka vo formáte JSON.
  2. URL hostenej zbierky.

Príkaz použitý na spustenie kolekcie Postman pomocou Newmana je:

otázky na pohovor s vývojárom pl / sql
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}

Skúsme spustiť zbierku vzoriek pomocou aplikácie Postman.

  1. Prejdite do aplikácie Poštár, použite ľubovoľnú existujúcu zbierku Poštárov a exportujte ju do formulára JSON. (Vytvoríme novú kolekciu s 3 požiadavkami, t. J. Zaregistrujte sa, prihláste sa a získajte používateľa pomocou formulára koncových bodov API tu ).
  2. Teraz exportujte kolekciu do formátu JSON.
  3. Po získaní súboru JSON kolekcie otvorte príkazový riadok a spustite kolekciu pomocou príkazu Newman run (predpokladajme, že kolekcia bola exportovaná s názvom - Postman_Newman_IntegrationCollection .json) a používateľ prešiel do adresára na export kolekcie, potom môže byť kolekcia vykonaná jednoducho pomocou nižšie uvedeného príkazu.
newman run Postman_Newman_IntegrationCollection.json

Po spustení vyššie uvedeného príkazu sa vytvorí nasledujúci výstup.

Kolekcia Runner

Integrácia Newmana s premennými prostredia

Teraz sa pozrime na pokročilejšie zvyklosti Newmana. Pre kolekciu, ktorá sa nespolieha na žiadne premenné prostredia, by sa kolekcia dala jednoducho vykonať pomocou príkazu Newman run. Ale pre kolekcie, ktoré používajú premenné prostredia, musíme spolu s kolekciou JSON poskytnúť aj premennú prostredia JSON.

Príklad: Použijeme rovnakú kolekciu a použijeme premennú prostredia pre koncový bod GET User, tj. Na vyžiadanie s koncový bod .

Použijeme userId z kolekcie premenných prostredia. Výsledná žiadosť bude teda https://reqres.in/api/users/{{userId}}

Teraz, keď sa vytvorí súbor prostredia, exportujte ho ako JSON pomocou nasledujúcich krokov.

  1. Vytvorte prostredie s jednou premennou s názvom userId a hodnota by mala byť nastavená na „4“.
  2. Teraz kliknite na tlačidlo Nastavenia a otvorte okno „Správa prostredí“.
  3. Kliknutím na ikonu „Prevziať“ oproti vytvorenému prostrediu stiahnete prostredie ako súbor JSON (súbor s názvom uložte ako „testEnv.json).

Poďme exportovať kolekciu znova so zmenenou požiadavkou a skúsme spustiť rovnakú kolekciu spolu so súborom prostredia pomocou príkazu uvedeného nižšie:

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json

Po vykonaní vyššie uvedeného príkazu zostane výstup rovnaký ako v prípade priameho zberu, pričom jedinou zmenou bude požiadavka „ZÍSKAŤ Používateľ“, ktorá teraz načíta hodnotu zo súboru JSON v prostredí.

Výsledky tvrdenia pomocou Newmana

Pretože požiadavky Postmana môžu obsahovať aj tvrdenia, teraz si ukážeme, ako sa zobrazia výsledky tvrdenia, keď sa zbierky Postmana vykonávajú prostredníctvom Newmana.

Bežec zbierky Newman je v úplnej parite s bežcom Postman Collection a exekútorom požiadaviek. V prípade požiadaviek, ktoré majú tvrdenia, sa tvrdenia vyhodnotia, keď sa dokončí vykonávanie žiadosti, a súhrn vykonania tvrdenia sa zobrazí v súhrne testu na konci testovacej prevádzky.

Pre vyššie uvedenú kolekciu sme pridali tvrdenie na úrovni kolekcie, aby sme skontrolovali stavový kód odpovede na hodnotu 200, t. J. Pre každú požiadavku, ktorá je súčasťou kolekcie, by malo byť toto tvrdenie spojené.

Ak teda táto zbierka mala 3 žiadosti, znamená to, že by mali byť vykonané celkovo 3 tvrdenia.

Zvýraznené výsledky vykonania a výsledky uplatnenia nájdete na nasledujúcej snímke obrazovky.

Zvýraznené výsledky vykonania

Generovanie správ pomocou Newmana

Zatiaľ vieme, že Newman môže spúšťať zbierky Postman cez príkazový riadok a generovať nejaké protokoly testov a súhrn vykonania testu. Čo však s formátovanými správami, ktoré je možné zdieľať alebo zverejniť na nejakom serveri?

Newman má podporu aj pre toto. Existuje niekoľko vlastných uzlových modulov dostupných na generovanie správ o vykonaní testu Newman. Prejdeme si príklad pomocou a newman-html-reportér .

Tento reportér je opäť uzlovým modulom a musí byť nainštalovaný osobitne pomocou nižšie uvedeného príkazu.

npm install -g newman-reporter-html

Po nainštalovaní vyššie uvedeného modulu ho možno použiť spolu s príkazom Newman run.

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json -r html

Príznak „-r“ označuje reportéra, ktorý sa má použiť pri behu kolekcie Newman.

S touto voľbou využíva modul alebo balíčky Newman-reporter-html a vytvára pre vykonanie testu správu založenú na HTML.

Pozrite si jednu z týchto snímok obrazovky správy HTML, ktorá je uvedená nižšie:

Správa HTML

Integrácia s nástrojmi CI

Pretože má Newman schopnosť pracovať ako príkazový riadok, znižuje veľkú závislosť od všetkých predpokladov vo forme konzoly alebo aplikácie, tj. Jedinou závislosťou, ktorú má Newman, je uzol (ktorý je všeobecne dostupný ako vykonanie). prostredie vo všetkých strojoch CI, ako sú Jenkinsovi otroci alebo Travisove uzly).

Toto umožňuje vykonávanie zbierok Postman ako súčasť samotných potrubí zostavovania prostredníctvom príkazového riadku Newman.

Pretože Newman má schopnosť posielať výsledky aj do formátu Html, je to skutočne užitočné a užitočné a počas samotného vykonávania ropovodu môžu byť výsledky HTML zaslané na server alebo môžu byť zaslané e-mailom požadovaným používateľom atď. schopnosti sú nekonečné, pretože závislosti sú minimálne.

Podrobný príklad uskutočnenia integrácie s Jenkinsom nájdete v tomto príklade z oficiálneho blogu Postmana tu .

Viac možností s Newmanom

Všetko, čo sme pokryli, je podmnožinou funkcií, ktoré poskytuje Newman. Ak chcete získať úplné informácie o príkazoch a prepínačoch, ktoré podporuje Newman, jednoducho otvorte pomocníka príkazového riadku pre Newman pomocou príkazu nižšie.

newman run -h

Tu je výstup vyššie uvedeného príkazu s podrobnosťami o všetkých prepínačoch a ich význame.

Výstup s prepínačmi a ich významy

Pre referenciu Newman API existujú aj ďalšie informačné zdroje. Prosím odkáž tu za úradnú dokumentáciu.

Záver

V tomto tutoriáli sme prešli integráciou Postmana s názvom Newman z príkazového riadku, ktorá umožňuje spúšťanie zbierok Postman cez rozhranie príkazového riadku.

Je to jednoducho balíček uzlov a každý príkazový riadok, ktorý má nainštalovaný uzol spolu s Newmanom, by mal byť schopný spustiť kolekciu Postman a generovať dobre vyzerajúce správy o vykonaní kolekcie.

Integrácia pomocou príkazového riadku je tiež veľmi užitočnou pomôckou pri integrácii Postmanových zbierkových testov s nástrojmi CI, ako sú Jenkins, Travis atď., Pretože beh cez príkazový riadok nemá žiadne závislosti na OS alebo aplikácii a na spustenie zbierka.

=> Navštívte tu sériu výučbových kurzov Exkluzívne pre poštárov.

Odporúčané čítanie

^