Меню

Як використовувати інтеграцію командного рядка з Newman In Postman?

  • Головна
  • Інший
  • Як використовувати інтеграцію командного рядка з Newman In Postman?

how use command line integration with newman postman

Спробуйте Наш Інструмент Для Усунення Проблем

Навчіться виконувати колекції листонош за допомогою Newman:

У цьому підручнику ми побачимо, як ми можемо інтегрувати або виконувати колекції Postman через командний рядок, використовуючи Newman, який є інструментом інтеграції командного рядка для Postman.

Newman - це безкоштовний інструмент із відкритим кодом. Він надає потужні можливості для запуску колекцій Postman, використовуючи надзвичайно корисні можливості Postman, такі як тести, твердження, сценарії попереднього запиту тощо та запускаючи колекцію через командний рядок.

=> Перегляньте тут, щоб побачити A-Z навчальних посібників з навчання листонош тут.

Postman_ Інтеграція командного рядка з Newman

Що ви дізнаєтесь:

Що таке Ньюман?

Newman - програма запуску командного рядка для колекцій Postman. Іншими словами, це дозволяє користувачеві запускати існуючу колекцію Поштовиків через командний рядок.

Він очікує або споживає версію колекції JSON, яку можна отримати, просто експортувавши колекцію у форматі колекції JSON або URL-адресу колекції, яка є не чим іншим, як тим самим JSON, який отримано експортом колекції.

Ось відеоурок:

Встановлення Newman

Newman є модулем NodeJS і, отже, залежить від системи, на якій встановлений вузол. Щоб перевірити, чи встановлений вузол чи ні, просто перевірте версію вузла в системі, використовуючи команду нижче.

$ node -v v10.15.3

Якщо команда повертає певний результат, як зазначено вище, це означає, що вузол встановлено, і ми маємо перейти до встановлення Newman. Якщо ні, ви можете встановити вузол, звернувшись до інструкцій з встановлення тут

Після успішної установки вузла ви можете просто встановити Newman, як і будь-який інший пакет вузлів, використовуючи команду нижче.

npm install -g newman

Тут «-g» означає глобальну інсталяцію, що означає, що пакет Newman буде доступний з будь-якої папки / місця у файловій системі. Для локальної інсталяції ви можете видалити прапор ‘-g’ з вищезазначеного, де пакет Newman буде доступний лише із встановленого розташування або папки.

Щоб підтвердити успішне встановлення Newman, ви можете просто перевірити його версію, використовуючи команду нижче.

newman -v 4.5.1

Запуск колекцій за допомогою Newman

Щоб запускати колекції за допомогою Newman, вам слід мати будь-який із 2.

  1. Колекція у форматі JSON.
  2. URL-адреса розміщеної колекції.

Команда, яка використовується для запуску колекції Postman за допомогою Newman:

крапкові мережеві запитання та відповіді для досвідчених
newman run {{collectionJsonPath}} OR newman run {{collectionUrl}}

Спробуємо запустити колекцію зразків за допомогою Postman.

  1. Перейдіть до програми Postman, скористайтеся будь-якою наявною колекцією Postman та експортуйте її у форму JSON. (Ми створимо нову колекцію з 3 запитами, тобто зареєструвати користувача, зареєструвати користувача та отримати користувача за допомогою форми кінцевих точок API тут ).
  2. Тепер експортуйте колекцію у формат JSON.
  3. Після отримання колекції JSON відкрийте командний рядок і запустіть колекцію за допомогою команди запуску Newman (припустимо, колекцію було експортовано з ім'ям - Postman_Newman_IntegrationCollection .json) і користувач перейшов до каталогу експорту колекції, тоді колекцію можна виконати, просто використовуючи команду нижче.
newman run Postman_Newman_IntegrationCollection.json

Після запуску наведеної вище команди створюється наступний результат.

Колекція Runner

Інтеграція Ньюмена із змінними середовища

Тепер давайте подивимося більш досконалі звичаї Ньюмена. Для колекції, яка не покладається на будь-які змінні середовища, колекція може бути просто виконана за допомогою команди запуску Newman. Але для колекцій, що використовують змінні середовища, нам потрібно надати змінну середовища JSON, а також колекцію JSON.

Приклад: Ми будемо використовувати ту саму колекцію та використовувати змінну середовища для кінцевої точки GET User, тобто для запиту з кінцева точка .

Ми будемо використовувати userId із колекції змінних середовища. Тож отриманий запит стане https://reqres.in/api/users/{{userId}}

Тепер, як тільки файл середовища буде створений, експортуйте його у форматі JSON, дотримуючись наведених нижче кроків.

  1. Створіть середовище з однією змінною з іменем userId, і для значення слід встановити значення «4».
  2. Тепер натисніть кнопку Налаштування, щоб відкрити вікно «Керувати середовищами».
  3. Клацніть піктограму «Завантажити» проти створеного середовища, щоб завантажити середовище у вигляді файлу JSON (збережіть файл із назвою «testEnv.json).

Давайте експортуємо колекцію знову зі зміненим запитом та спробуємо запустити ту ж колекцію разом із файлом середовища за допомогою команди, як показано нижче:

newman run Postman_Newman_IntegrationCollection.json -e testEnv.json

Після виконання вищезазначеної команди вихідні дані залишаються такими ж, як запуск прямого збору, з єдиною зміною - запит «ОТРИМАТИ користувача» тепер отримує значення з файлу JSON середовища.

Результати твердження за допомогою Ньюмена

Оскільки запити Листоноша можуть містити твердження, ми також пройдемо покрокові інструкції щодо того, як відображаються результати тверджень, коли колекції Листоноша виконуються через Ньюмена.

Бігун колекції Newman повністю відповідає рівню колекції Postman Collection та виконавцю запитів. Для запитів, що мають твердження, твердження оцінюються як і коли виконання запиту завершується, а підсумок виконання твердження відображається в підсумку тесту в кінці запуску тесту.

Для вищезгаданої колекції ми додали твердження рівня колекції, щоб перевірити код стану відповіді рівним 200, тобто для кожного запиту, що входить до колекції, це твердження повинно бути пов’язане.

Отже, якщо у цій колекції було 3 запити, це означає, що в цілому повинно бути виконано 3 твердження.

Будь ласка, зверніться до знімка екрана нижче, щоб виділити результати виконання та результати твердження.

Результати виконання виділено

Генерація звітів за допомогою Newman

Наразі ми знаємо, що Newman може запускати колекції Postman через командний рядок та генерувати деякі журнали тестів та підсумок виконання тесту. Але як щодо форматованих звітів, якими можна поділитися або опублікувати на якомусь сервері?

Що ж, Ньюман також має підтримку для цього. Для створення звітів про виконання тестів Ньюмана доступні деякі користувальницькі модулі вузлів. Ми розглянемо приклад, використовуючи a newman-html-reporter .

Цей репортер знову є вузловим модулем і повинен бути встановлений окремо за допомогою наведеної нижче команди.

npm install -g newman-reporter-html

Після встановлення вищевказаного модуля його можна використовувати разом із командою запуску Newman.

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

Прапор «-r» означає, що репортер буде використовуватися для запуску колекції Ньюмена.

За допомогою цієї опції він використовує модуль або пакети Newman-reporter-html і створює звіт на основі HTML для виконання тесту.

Зверніться до одного з таких знімків екрана звіту HTML, показаного нижче:

Звіт HTML

Інтеграція з інструментами CI

Оскільки Newman має можливості запускатись як командний рядок, це зменшує значну залежність від будь-яких передумов у вигляді консолі або програми, тобто єдина залежність, яку має Newman, - це вузол (який зазвичай доступний як виконання навколишнього середовища у всіх машинах CI, таких як раби Дженкінса або вузли Тревіса).

Це дозволяє виконувати колекції Postman як частину самого конвеєра збірки за допомогою командного рядка Newman.

Оскільки Newman також має можливості надсилання результатів у форматі Html, це дійсно корисно та зручно, і під час самого виконання конвеєра результати HTML можуть бути передані на сервер або надіслані електронною поштою бажаним користувачам тощо. можливості нескінченні, оскільки залежності мінімальні.

Для детального прикладу виконання інтеграції з Jenkins, будь ласка, зверніться до цього прикладу з офіційного блогу Postman тут .

Більше варіантів із Newman

Що б ми не розглядали, це підмножина функціональних можливостей, яку надає Newman. Для отримання детальної інформації про команди та перемикачі, які підтримує Newman, просто відкрийте довідку командного рядка для Newman, використовуючи команду нижче.

newman run -h

Ось результат вищевказаної команди з деталями про всі комутатори та їх значення.

Вихідні дані з перемикачами та їх значення

Існують також інші інформаційні ресурси для посилання на API Ньюмана. Будь ласка, зверніться тут для офіційної документації.

Висновок

У цьому підручнику ми пройшли інтеграцію командного рядка Postman під назвою Newman, що дозволяє запускати колекції Postman через інтерфейс командного рядка.

Це просто пакет вузлів, і будь-який командний рядок, який має вузол, встановлений разом із Newman, повинен мати можливість запускати колекцію Postman та створювати гарні звіти про виконання колекції.

Інтеграція з командним рядком також є великою підмогою для інтеграції тестів збору колекцій на основі Postman з інструментами CI, такими як Дженкінс, Тревіс тощо, оскільки запуск через командний рядок не має ніяких залежностей від ОС чи програми, а йому просто потрібно середовище вузла для запуску колекція.

=> Завітайте сюди, щоб ознайомитись із ексклюзивними навчальними посібниками для листонош.

Рекомендована література

^