Menu

Jak používat integraci příkazového řádku s Newmanem v Postmanu?

  • Hlavní
  • Jiný
  • Jak používat integraci příkazového řádku s Newmanem v Postmanu?

how use command line integration with newman postman

Vyzkoušejte Náš Nástroj Pro Odstranění Problémů

Naučte se provádět poštovní sbírky pomocí Newmana:

V tomto kurzu uvidíme, jak můžeme integrovat nebo spustit kolekce Postman prostřednictvím příkazového řádku pomocí Newman, což je nástroj pro integraci příkazového řádku pro Postman.

Newman je bezplatný a otevřený nástroj. Poskytuje výkonné funkce pro spouštění kolekcí Postman, využívá super užitečné funkce Postmana, jako jsou Testy, Asserce, Pre-request skripty atd., A spouštění kolekce prostřednictvím příkazového řádku.

=> Podívejte se sem a podívejte se na A-Z výukových kurzů pošťáků zde.

Postman_ Integrace příkazového řádku s Newmanem

Co se naučíte:

Co je Newman?

Newman je běžec příkazového řádku pro sbírky Postman. Jinými slovy umožňuje uživateli spustit existující kolekci Postman prostřednictvím příkazového řádku.

Očekává nebo spotřebovává verzi JSON kolekce, kterou lze získat jednoduchým exportem kolekce ve formátu kolekce JSON nebo adresou URL kolekce, což není nic jiného než stejný JSON, který byl získán exportem kolekce.

Zde je videonávod:

Instalace Newmana

Newman je modul NodeJS a je tedy závislý na systému, který má nainstalovaný uzel. Chcete-li zkontrolovat, zda je uzel nainstalován nebo ne, jednoduše zkontrolujte verzi uzlu v systému pomocí níže uvedeného příkazu.

$ node -v v10.15.3

Pokud příkaz vrátí nějaký výstup, jak je uvedeno výše, znamená to, že uzel je nainstalován a je dobré jít s instalací Newmana. Pokud ne, můžete uzel nainstalovat podle pokynů k instalaci tady

Jakmile je instalace uzlu úspěšná, můžete jednoduše nainstalovat Newman jako jakýkoli jiný balíček uzlů pomocí níže uvedeného příkazu.

npm install -g newman

Zde „-g“ označuje globální instalaci, což znamená, že balíček Newman bude přístupný z jakékoli složky / umístění v systému souborů. Při provádění místní instalace můžete z výše uvedeného odebrat příznak „-g“, kde bude balíček Newman přístupný pouze z nainstalovaného umístění nebo složky.

Chcete-li ověřit úspěšnou instalaci Newmanu, můžete jednoduše zkontrolovat jeho verzi pomocí níže uvedeného příkazu.

newman -v 4.5.1

Spouštění kolekcí pomocí Newmana

Chcete-li spouštět sbírky pomocí Newmana, měli byste mít kteroukoli ze dvou.

  1. Kolekce ve formátu JSON.
  2. URL hostované kolekce.

Příkaz použitý ke spuštění kolekce Postman pomocí Newmana je:

primární přístupová práva k souborům v unixu jsou:
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}

Zkusme spustit ukázkovou sbírku pomocí Postmana.

  1. Přejděte do aplikace Postman, použijte libovolnou existující kolekci Postman a exportujte ji do formuláře JSON. (Vytvoříme novou kolekci se 3 požadavky, tj. Zaregistrujte uživatele, Přihlašte uživatele a Získejte uživatele pomocí formuláře koncových bodů API tady ).
  2. Nyní exportujte kolekci do formátu JSON.
  3. Po získání JSON kolekce otevřete příkazový řádek a spusťte kolekci pomocí příkazu Newman run (předpokládejme, že kolekce byla exportována s názvem - Postman_Newman_IntegrationCollection .json) a uživatel prošel do adresáře exportu kolekce, pak lze kolekci provést jednoduše pomocí níže uvedeného příkazu.
newman run Postman_Newman_IntegrationCollection.json

Po spuštění výše uvedeného příkazu se vytvoří následující výstup.

Kolekce Runner

Integrace Newmana s proměnnými prostředí

Nyní se podívejme na pokročilejší použití Newmana. U kolekce, která nespoléhá na žádné proměnné prostředí, lze kolekci jednoduše spustit pomocí příkazu Newman run. Ale pro kolekce pomocí proměnných prostředí musíme poskytnout také proměnnou prostředí JSON spolu s kolekcí JSON.

Příklad: Použijeme stejnou kolekci a použijeme proměnnou prostředí pro koncový bod GET User, tj. Pro požadavek s koncový bod .

Použijeme userId ze sbírky proměnných prostředí. Výsledný požadavek se tedy stane https://reqres.in/api/users/{{userId}}

Jakmile je soubor prostředí vytvořen, exportujte jej jako JSON pomocí níže uvedených kroků.

  1. Vytvořte prostředí s jednou proměnnou s názvem userId a hodnota by měla být nastavena na „4“.
  2. Nyní klikněte na tlačítko Nastavení a otevřete okno „Správa prostředí“.
  3. Kliknutím na ikonu Stáhnout proti vytvořenému prostředí stáhnete prostředí jako soubor JSON (soubor s názvem uložte jako testEnv.json).

Pojďme exportovat kolekci znovu se změněným požadavkem a zkusme spustit stejnou kolekci spolu se souborem prostředí s příkazem uvedeným níže:

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json

Po provedení výše uvedeného příkazu zůstane výstup stejný jako při přímém spuštění kolekce, přičemž jedinou změnou bude požadavek „ZÍSKAT uživatele“, který nyní načte hodnotu ze souboru JSON prostředí.

Výsledky tvrzení pomocí Newmana

Vzhledem k tomu, že požadavky Postmana mohou obsahovat také tvrzení, nyní provedeme návod, jak se zobrazí výsledky tvrzení, když jsou kolekce Postmana prováděny prostřednictvím Newmana.

Běžec kolekce Newman je v úplné paritě s běžecem kolekce Postman a exekutorem požadavků. U požadavků s tvrzeními se tvrzení vyhodnotí, jakmile se dokončí provádění požadavku a souhrn provedení tvrzení se zobrazí v souhrnu testu na konci testovacího běhu.

U výše uvedené kolekce jsme přidali tvrzení na úrovni kolekce, abychom zkontrolovali stavový kód odpovědi na 200, tj. U každého požadavku, který je součástí kolekce, by mělo být toto tvrzení přidruženo.

Pokud tedy tato kolekce měla 3 požadavky, znamená to, že by měly být provedeny celkem 3 tvrzení.

Na níže uvedeném snímku obrazovky najdete zvýrazněné výsledky provedení a výsledky tvrzení.

Výsledky provedení zvýrazněny

Generování reportů pomocí Newmana

Zatím víme, že Newman může spouštět sbírky Postmana prostřednictvím příkazového řádku a generovat některé protokoly testů a shrnutí provádění testů. Ale co formátované zprávy, které lze sdílet nebo publikovat na nějakém serveru?

Newman má také podporu. K dispozici jsou některé vlastní moduly uzlů pro generování zpráv o provedení testu Newman. Projdeme si příklad pomocí a reportér newman-html .

Tento reportér je opět modul uzlu a musí být samostatně nainstalován pomocí níže uvedeného příkazu.

npm install -g newman-reporter-html

Jakmile je výše uvedený modul nainstalován, lze jej použít společně s příkazem Newman run.

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

Příznak „-r“ označuje reportéra, který má být použit při běhu kolekce Newman.

S touto možností využívá modul nebo balíčky Newman-reporter-html a vytváří pro provedení testu zprávu založenou na HTML.

Viz jeden takový snímek obrazovky zprávy HTML zobrazený níže:

Zpráva HTML

Integrace s nástroji CI

S Newmanem, který má schopnosti běžet jako příkazový řádek, snižuje velkou závislost na jakýchkoli předpokladech ve formě konzoly nebo aplikace, tj. Jediná závislost, kterou Newman má, je uzel (který je obecně dostupný jako provedení prostředí ve všech strojích CI, jako jsou Jenkinsovi otroci nebo Travisovy uzly).

To umožňuje, aby kolekce Postman byly prováděny jako součást samotných sestavovacích kanálů prostřednictvím příkazového řádku Newman.

S Newmanem, který má schopnost posílat výsledky také ve formátu Html, je to opravdu užitečné a praktické a během samotného provádění kanálu mohou být výsledky HTML poslány na server nebo mohou být zaslány e-mailem požadovaným uživatelům atd. schopnosti jsou nekonečné, protože závislosti jsou minimální.

Podrobný příklad provedení integrace s Jenkinsem najdete v tomto příkladu z oficiálního blogu Postmana tady .

Více možností s Newmanem

Cokoli jsme pokryli, je podmnožina funkcí, které poskytuje Newman. Chcete-li získat úplné podrobnosti o příkazech a přepínačích, které Newman podporuje, jednoduše otevřete nápovědu příkazového řádku pro Newmana pomocí níže uvedeného příkazu.

newman run -h

Zde je výstup výše uvedeného příkazu s podrobnostmi o všech přepínačích a jejich významu.

Výstup s přepínači a jejich významy

Pro odkaz na Newman API existují i ​​další informační zdroje. Přečtěte si prosím tady pro oficiální dokumentaci.

Závěr

V tomto kurzu jsme prošli integrací Postmanu s názvem Newman z příkazového řádku, která umožňuje spouštění kolekcí Postman prostřednictvím rozhraní příkazového řádku.

Je to prostě balíček uzlů a jakýkoli příkazový řádek, který má nainstalovaný uzel spolu s Newmanem, by měl být schopen spustit kolekci Postman a generovat dobře vypadající zprávy o provedení kolekce.

Integrace příkazového řádku je také velkou pomocí pro integraci testů sběru Postman založených na nástrojích CI, jako je Jenkins, Travis atd., Protože běh přes příkazový řádek nemá žádné závislosti na OS nebo aplikaci a prostě potřebuje prostředí uzlu ke spuštění sbírka.

=> Navštivte zde exkluzivní sérii výukových kurzů pošťáků.

Doporučené čtení

^