Menu

Jak korzystać z integracji wiersza poleceń z Newman w Postman?

  • Główny
  • Inny
  • Jak korzystać z integracji wiersza poleceń z Newman w Postman?

how use command line integration with newman postman

Dowiedz się, jak wykonywać kolekcje listonosza za pomocą Newman:

W tym samouczku zobaczymy, jak możemy integrować lub uruchamiać kolekcje Postman za pomocą wiersza poleceń przy użyciu Newman, który jest narzędziem do integracji wiersza poleceń dla Postman.

Newman to darmowe narzędzie o otwartym kodzie źródłowym. Zapewnia potężne możliwości uruchamiania kolekcji Postman, wykorzystując bardzo przydatne funkcje programu Postman, takie jak testy, asercje, skrypty przed żądaniem itp. Oraz uruchamianie kolekcji za pomocą wiersza poleceń.

=> Sprawdź tutaj, aby zobaczyć samouczki szkoleniowe od A do Z tutaj.

Postman_ Integracja wiersza poleceń z Newman

Czego się nauczysz:

Co to jest Newman?

Newman to program uruchamiający z wiersza poleceń dla kolekcji Postman. Innymi słowy, pozwala użytkownikowi uruchomić istniejącą kolekcję Postman za pomocą wiersza poleceń.

Oczekuje lub zużywa wersję JSON kolekcji, którą można uzyskać, po prostu eksportując kolekcję w formacie JSON lub adres URL kolekcji, który jest niczym innym jak tym samym kodem JSON, który jest uzyskiwany podczas eksportu kolekcji.

alternatywa dla ccleaner dla Windows 10

Oto samouczek wideo:

Instalowanie Newmana

Newman jest modułem NodeJS i dlatego jest zależny od systemu z zainstalowanym węzłem. Aby sprawdzić, czy węzeł jest zainstalowany, czy nie, po prostu sprawdź wersję węzła w systemie za pomocą poniższego polecenia.

$ node -v v10.15.3

Jeśli polecenie zwróci jakieś dane wyjściowe jak powyżej, oznacza to, że węzeł jest zainstalowany i możemy przejść do instalacji Newmana. Jeśli nie, możesz zainstalować node, postępując zgodnie z instrukcjami instalacji tutaj

Po pomyślnej instalacji węzła możesz po prostu zainstalować Newman jak każdy inny pakiet węzłów, używając poniższego polecenia.

npm install -g newman

Tutaj „-g” oznacza instalację globalną, co oznacza, że ​​pakiet Newmana będzie dostępny z dowolnego folderu / lokalizacji w systemie plików. Aby przeprowadzić instalację lokalną, możesz usunąć flagę „-g” z powyższego, gdzie pakiet Newman będzie dostępny tylko z zainstalowanej lokalizacji lub folderu.

Aby potwierdzić pomyślną instalację Newmana, możesz po prostu sprawdzić jego wersję za pomocą poniższego polecenia.

newman -v 4.5.1

Uruchamianie kolekcji za pomocą Newmana

Aby uruchomić kolekcje za pomocą Newmana, powinieneś mieć jedną z 2.

  1. Kolekcja w formacie JSON.
  2. URL hostowanej kolekcji.

Polecenie użyte do uruchomienia kolekcji Postman przy użyciu Newmana to:

newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}

Spróbujmy uruchomić zbiór próbek za pomocą programu Postman.

  1. Przejdź do aplikacji Postman, użyj dowolnej istniejącej kolekcji Postman i wyeksportuj ją do formularza JSON. (Stworzymy nową kolekcję z 3 żądaniami, tj. Zarejestruj użytkownika, Zaloguj się i Pobierz użytkownika za pomocą formularza punktów końcowych API tutaj ).
  2. Teraz wyeksportuj kolekcję do formatu JSON.
  3. Po uzyskaniu kolekcji JSON otwórz wiersz polecenia i uruchom kolekcję za pomocą polecenia Newman run (załóżmy, że kolekcja została wyeksportowana z nazwą - Postman_Newman_IntegrationCollection .json), a użytkownik przeszedł do katalogu eksportu kolekcji, wtedy kolekcję można wykonać po prostu za pomocą poniższego polecenia.
newman run Postman_Newman_IntegrationCollection.json

Po wykonaniu powyższego polecenia generowane są następujące dane wyjściowe.

Kolekcja Runner

Integracja Newmana ze zmiennymi środowiskowymi

Zobaczmy teraz bardziej zaawansowane zastosowania Newmana. W przypadku kolekcji, która nie opiera się na żadnych zmiennych środowiskowych, można ją po prostu wykonać za pomocą polecenia Newman run. Ale w przypadku kolekcji, używając zmiennych środowiskowych, musimy dostarczyć zmienną środowiskową JSON, a także kolekcję JSON.

Przykład: Będziemy używać tej samej kolekcji i używamy zmiennej środowiskowej dla punktu końcowego GET User, tj. Do żądania z punkt końcowy .

Użyjemy userId z kolekcji zmiennych środowiskowych. Wynikowe żądanie stanie się więc https://reqres.in/api/users/{{userId}}

Teraz, po utworzeniu pliku środowiska, wyeksportuj go jako JSON, wykonując poniższe czynności.

  1. Utwórz środowisko z jedną zmienną o nazwie userId i wartością, która powinna być ustawiona na „4”.
  2. Teraz kliknij przycisk Ustawienia, aby otworzyć okno „Zarządzaj środowiskami”.
  3. Kliknij ikonę „Pobierz” obok utworzonego środowiska, aby pobrać środowisko jako plik JSON (zapisz plik pod nazwą „testEnv.json).

Wyeksportujmy ponownie kolekcję ze zmienionym żądaniem i spróbujmy uruchomić tę samą kolekcję wraz z plikiem środowiskowym za pomocą poniższego polecenia:

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json

Po wykonaniu powyższego polecenia dane wyjściowe pozostają takie same, jak w przypadku bezpośredniego uruchomienia kolekcji, z jedyną zmianą jest to, że żądanie „GET User” pobiera teraz wartość z pliku JSON środowiska.

Wyniki asercji przy użyciu Newmana

Ponieważ żądania Postman mogą również zawierać potwierdzenia, teraz przejdziemy do sposobu wyświetlania wyników asercji, gdy kolekcje Postman są wykonywane przez Newman.

Runner kolekcji Newmana jest w pełnej równości z runner'em kolekcji Postman i wykonawcą żądań. W przypadku żądań z asercjami, asercje są oceniane w momencie zakończenia wykonywania żądania, a podsumowanie wykonania potwierdzenia jest wyświetlane w podsumowaniu testu na koniec przebiegu testu.

W przypadku powyższego zbioru dodaliśmy potwierdzenie na poziomie kolekcji, aby sprawdzić, czy kod stanu odpowiedzi wynosi 200, tj. Dla każdego żądania będącego częścią kolekcji powinno być skojarzone to potwierdzenie.

Więc jeśli ta kolekcja miała 3 żądania, oznacza to, że powinny być w sumie 3 asercje, które powinny były zostać wykonane.

Zapoznaj się z poniższym zrzutem ekranu, aby uzyskać wyróżnione wyniki wykonania i wyniki asercji.

Podświetlone wyniki wykonania

Generowanie raportów przy użyciu Newman

Jak dotąd wiemy, że Newman może uruchamiać kolekcje Postman za pomocą wiersza poleceń i generować dzienniki testów oraz podsumowanie wykonania testów. Ale co ze sformatowanymi raportami, które można udostępniać lub publikować na jakimś serwerze?

Cóż, Newman również to wspiera. Dostępnych jest kilka niestandardowych modułów węzłów do generowania raportów z wykonania testów Newmana. Przejdziemy przez przykład przy użyciu pliku newman-html-reporter .

Ten raportator jest ponownie modułem węzła i musi być zainstalowany oddzielnie za pomocą poniższego polecenia.

npm install -g newman-reporter-html

Po zainstalowaniu powyższego modułu można go używać wraz z poleceniem uruchamiania Newman.

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

Flaga „-r” wskazuje raport, który ma być użyty z uruchomieniem kolekcji Newman.

Dzięki tej opcji korzysta z modułu lub pakietów Newman-reporter-html i tworzy raport w formacie HTML do wykonania testu.

Zobacz jeden taki zrzut ekranu raportu HTML pokazanego poniżej:

Raport HTML

Integracja z narzędziami CI

Dzięki możliwości uruchamiania Newmana jako wiersza poleceń, zmniejsza on dużą zależność od wszelkich wymagań wstępnych w postaci konsoli lub aplikacji, tj. Jedyną zależnością, jaką ma Newman, jest węzeł (który jest ogólnie dostępny jako wykonanie środowisko we wszystkich maszynach CI, takich jak niewolnicy Jenkins lub węzły Travis).

Umożliwia to wykonywanie kolekcji Postmana jako części potoku kompilacji za pośrednictwem wiersza poleceń Newmana.

Ponieważ Newman ma możliwość wypychania wyników również w formacie HTML, jest to bardzo przydatne i przydatne, a podczas samego wykonywania potoku wyniki HTML mogą zostać przesłane na serwer lub wysłane pocztą e-mail do wybranych użytkowników itp. możliwości są nieograniczone, ponieważ zależności są minimalne.

Aby zapoznać się ze szczegółowym przykładem wykonania integracji z Jenkinsem, zapoznaj się z tym przykładem na oficjalnym blogu firmy Postman tutaj .

Więcej opcji z Newmanem

Wszystko, co omówiliśmy, jest podzbiorem funkcji zapewnianych przez firmę Newman. Aby uzyskać szczegółowe informacje na temat poleceń i przełączników obsługiwanych przez Newman, po prostu otwórz pomoc wiersza polecenia dla Newmana, używając poniższego polecenia.

newman run -h

Oto wynik powyższego polecenia, ze szczegółami dotyczącymi wszystkich przełączników i ich znaczeń.

Wyjście z przełącznikami i ich znaczenie

Istnieją również inne zasoby informacyjne dotyczące interfejsu API Newman. Proszę odnieś się tutaj do oficjalnej dokumentacji.

Wniosek

W tym samouczku omówiliśmy integrację z wierszem poleceń programu Postman o nazwie Newman, która umożliwia uruchamianie kolekcji programu Postman za pośrednictwem interfejsu wiersza poleceń.

To po prostu pakiet węzłów, a każdy wiersz poleceń, w którym węzeł jest zainstalowany wraz z programem Newman, powinien być w stanie uruchomić kolekcję Postman i generować dobrze wyglądające raporty z wykonania kolekcji.

Integracja z wierszem poleceń jest również bardzo pomocna w integracji testów kolekcji opartych na programie Postman z narzędziami CI, takimi jak Jenkins, Travis itp., Ponieważ uruchamianie z wiersza poleceń nie ma żadnych zależności od systemu operacyjnego ani aplikacji i po prostu potrzebuje środowiska węzłów do uruchomienia kolekcja.

=> Odwiedź tutaj, aby zapoznać się z ekskluzywną serią samouczków szkoleniowych dla listonosza.

rekomendowane lektury

^