Коллекции Postman. Часть 2

🔥 Полезность. Скачивайте книгу API Testing and Development with Postman.PDF 🔥

Коллекции Postman. Часть 1 читайте здесь

Содержание:

Тестирование функциональности API

В Postman можно запускать коллекции для тестирования и взаимодействия с вашими API. Коллекция в Postman может представлять собой группу сохраненных запросовворкфлоу или тестовый набор. При запуске коллекции Postman отправляет запросы в заданном порядке.

Вы можете запускать коллекции различными способами:

  • Вручную с помощью Collection Runner. Запуск коллекций вручную полезен, когда вы отправляете небольшое количество запросов и не хотите повторять их по регулярному графику.
  • Через расширение Postman VS Code – позволяет запускать коллекции прямо в среде разработки API.
  • По расписанию – автоматический запуск коллекций полезен для регулярного тестирования API. Мониторы полезны для проверки производительности, доступности и надежности API.
  • В CI/CD-пайплайне – автоматизация тестирования с помощью Postman CLI или Newman.
  • С использованием вебхуков – коллекции могут запускаться в ответ на определенные события или в назначенное время.

Вы также можете запускать коллекции для имитации реального трафика и тестирования производительности вашего API под нагрузкой.

Тестирование API с помощью Collection Runner

С помощью Collection Runner в Postman можно отправлять все или часть запросов из коллекции API в заданном порядке. Collection Runner записывает результаты тестов для каждого запроса и может использовать скрипты для передачи данных между запросами и изменения последовательности их выполнения.

Используйте запуск коллекций для автоматизации функционального тестирования API:

  • Ручной запуск коллекций с помощью Collection Runner.
  • Запуск по расписанию в Postman Cloud с использованием Collection Runner или мониторов.
  • Интеграция с CI/CD с помощью Postman CLI, инструмента командной строки Postman.
Шаблоны почтальона. Значок.

Начните работу с шаблоном интеграционного тестирования

Посмотреть шаблон

Настройка запуска коллекции

Вы можете вручную запустить выполнение запросов внутри коллекции или папке.

  1. Выберите Collections на боковой панели и выберите коллекцию или папку, которую вы хотите запустить.

Вы также можете запустить коллекцию или папку, связанную с API. Узнайте больше о добавлении коллекции в API.

  1. Нажмите на иконку Значок бегуна Run .

Вы также можете выбрать Значок «Выполнить» Runner в нижней части Postman. Перетащите коллекцию из боковой панели в Collection Runner. Или выберите Start with a template, чтобы создать новую коллекцию с примерами тестов для запуска.

  1. На вкладке Functional выберите Run manually.

Вы также можете настроить расписание запусков и автоматизировать запуски с помощью Postman CLI.

  1. Если вы хотите, чтобы ваша коллекция работала с окружением, выберите его с помощью селектора окружения в правом верхнем углу Postman. Вы также можете выбрать Environments на боковой панели, а затем выбрать нужное окружение.
  2. Выберите любые параметры конфигурации:
    • Iterations — количество запусков коллекции.
    • Delay— интервал задержки в миллисекундах между каждым запросом.
    • Data— файл с данными для запуска коллекции.
    • Advanced settings (Расширенные настройки)
      • Persist responses for a session — по умолчанию заголовки и тела ответов сохраняются, чтобы вы могли просмотреть их после запуска коллекции.
      • Turn off logs during run — отключите логирование в консоли Postman во время запуска коллекции.
      • Stop run if an error occurs — cнимите этот флажок, если вы хотите, чтобы выполнение коллекции продолжалось после возникновения ошибки.
      • Keep variable values — сохраните переменные, используемые в ходе выполнения, чтобы все переменные, обновленные в процессе выполнения, оставались измененными после его завершения.
      • Run collection without using stored cookies — если ваши запросы используют файлы cookie, вы можете по желанию отключить их для выполнения коллекции.
      • Save cookies after collection run — cохраните cookies, использованные в этой сессии, в менеджер файлов cookie.
  3. По умолчанию ваши запросы выполняются в том порядке, в котором они перечислены в коллекции. Если вам нужно изменить порядок выполнения, выберите запрос и перетащите его в новое место в порядке. Вы также можете удалить отдельный запрос из выполнения, сняв флажок рядом с его названием.
  4. Когда настройка будет завершена, нажмите Run (имя коллекции) .

Ваш план в Postman ограничивает количество запусков коллекций, которые вы можете использовать каждый месяц. Это ограничение применяется только к коллекциям, которые вы запускаете в рабочем пространстве с использованием опции Run manually (Запуск вручную). Оно не применяется к запускам коллекций по расписанию в Postman Cloud. Запуск коллекции с несколькими итерациями считается за один запуск.

Сообщение будет отображаться в Collection Runner, когда вы приблизитесь к пределу использования. Узнайте больше об использовании ресурсов в Postman.

Отладка результатов выполнения

При запуске коллекций вручную Postman отображает результаты выполнения ваших запросов и тестов в реальном времени. Вы можете просматривать исходные данные выполнения коллекции, выбранное окружение, количество итераций, общую продолжительность, количество тестов и среднее время отклика.

Чтобы узнать больше о том, что произошло во время выполнения коллекции, выполните одно из следующих действий:

  • Выберите запрос для просмотра деталей: вы можете просматривать общую информацию о запросе, включая заголовки и тело запроса. Также, если была выбрана опция Persist responses for a session, вы сможете увидеть заголовки и тело ответа.
  • Откройте запрос в новой вкладке: нажмите на название запроса, чтобы открыть его в новой вкладке. Вы можете просматривать скрипты после ответа или выбрать Send для повторной отправки запроса.
  • Выберите вкладки Passed , Failed или Skipped для фильтрации результатов по статусу теста. Чтобы показать все запросы, выберите вкладку All Tests. Если какой-либо тест в скрипте запроса не прошел, весь запрос считается неудачным.
  • Если выполнение вашей коллекции включало несколько итераций, выберите номер итерации, чтобы перейти к результатам конкретной итерации.
  • Нажмите View all runs, чтобы просмотреть список предыдущих запусков. Узнайте больше о просмотре истории запусков.
  • Нажмите View Summary, чтобы увидеть сводку выполнения коллекции, включая результаты тестов. Чтобы вернуться к полным результатам, выберите View Results.

Вы можете добавлять скрипты и тесты в пакеты в Package Library вашей команды и запускать содержимое пакетов через Collection Runner. Узнайте как добавлять пакеты в Package Library и импортировать пакеты в ваши pre-request и post-response скрипты.

Повторный запуск коллекции

После того как вы ознакомитесь с результатами выполнения коллекции, вы можете снова запустить коллекцию. Например, вы можете отредактировать код для неудавшегося теста и запустить коллекцию снова, чтобы проверить, успешен ли тест.

Чтобы снова запустить коллекцию из результатов выполнения, выполните одно из следующих действий:

  • Выберите Run Again, чтобы снова запустить коллекцию данных с теми же настройками.
  • Выберите + New Run, ччтобы настроить новый запуск коллекции. Измените любые настройки, а затем выберите Run (имя коллекции) для повторного выполнения.
  • Выберите Automate Run , чтобы автоматизировать запуск коллекции. Вы можете запланировать запуск, выполнить его с помощью Postman CLI или интегрировать запуск в ваш CI/CD-пайплайн.

Если вы изменили выбор или порядок запросов, или другие настройки, то индивидуальный порядок и конфигурация сохраняются вместе с результатами выполнения.

Чтобы запустить коллекцию снова позже с использованием вашей пользовательской конфигурации, выберите вкладку Runs в коллекции, чтобы просмотреть прошлые запуски. Нажмите на иконку просмотра отчета Просмотреть значок отчета рядом с запуском, чтобы открыть результаты запуска коллекции. Здесь вы можете выбрать Run Again , чтобы запустить коллекцию снова с теми же настройками.

Устранение неполадок при больших запусках коллекций

Запуск коллекции может быть большим, если она включает много запросов, запросы и ответы имеют большой размер, или количество итераций высоко. В таком случае ваш браузер или компьютер может не иметь достаточного объема памяти, что снижает производительность при выполнении коллекции.

Вы можете использовать веб-приложение Postman при больших запусках коллекций, так как оно использует пространство на диске вашего компьютера, освобождая память для больших запусков коллекций.

Если вы используете веб-приложение Postman для крупных запусков коллекций, выполните следующие действия, чтобы освободить память в вашем браузере и улучшить производительность:

Если вы используете приложение Postman для ПК для больших запусков коллекций, выполните следующие действия, чтобы освободить больше памяти на вашем компьютере и улучшить производительность:

  • Снимите флажок Persist responses for a session при настройке запуска коллекции.
  • Очистите локальные данные и перезапустите Postman. Откройте приложение Postman для рабочего стола, в строке меню компьютера выберите Help, затем выберите Clear Cache and Reload.
  • Освободите место на диске вашего компьютера.
  • Установите флажок Turn off logs during run при настройке запуска коллекции.
  • Если в коллекции много запросов, разделите запросы на несколько меньших коллекций и запустите их по отдельности.
  • Уменьшите количество итераций для запуска коллекции при настройке запуска коллекции.

Во время большого запуска коллекции может возникнуть ситуация, когда ответы не будут сохранены, если ваш компьютер исчерпал память во время выполнения. В таком случае Postman может удалить ранее сохраненные ответы, чтобы освободить место для новых сохраненных ответов. Вам будет показано уведомление в результатах запуска, если память была исчерпана. Вы можете выбрать Retry Run в уведомлении, чтобы запустить коллекцию снова с теми же настройками.

Чтобы получить дополнительную помощь в устранении неполадок при большом запуске коллекции, обратитесь в службу поддержки Postman, приложив к запросу файлы журналов. Узнайте как найти журналы Postman.

Экспорт результатов выполнения коллекции

Вы можете поделиться результатами выполнения коллекции с другими, экспортировав результаты из Collection Runner.

Возможность экспорта отчета о выполнении коллекции данных доступна в приложении Postman для ПК, но не в веб-версии Postman.

Чтобы экспортировать результаты выполнения коллекции, выполните следующие шаги:

  1. Откройте запуск коллекции в Collection Runner. Вы также можете получить доступ к запуску коллекции через History в боковой панели, если запуск не открыт.
  2. Чтобы загрузить результаты, выберите Значок полного экрана Export Results в правом верхнем углу.
  3. Выберите место для сохранения скачанных результатов запуска коллекции и нажмите Save.

Вы можете импортировать результаты запуска коллекции, которые были экспортированы в файл. Выберите Значок бегуна Runner в нижней части экрана и перетащите экспортированный файл в Collection Runner.

Просмотр истории запусков

Каждая коллекция имеет вкладку Runs, которую можно использовать для просмотра прошлых функциональных запусков, запланированных запусков и запусков производительности. Вы также можете просматривать такие детали, как количество тестов и среднее время отклика.

Вкладка прошлых запусков

На вкладке Functional есть элементы управления для выбора, сколько последних запусков коллекции отображать. Вы можете фильтровать отображаемые запуски по пользователю, статусу запуска и источнику (Collection Runner или Postman CLI).

Для каждого запуска коллекции отображаются следующие данные:

  • Флажок для каждого запуска и опция выбрать все запуски. Выберите один или несколько запусков и нажмите Delete, чтобы удалить их.
  • Время начала выполнения коллекции.
  • Источник выполнения, продолжительность, общее количество тестов, прошедших тестов, неудавшихся тестов, пропущенных тестов и среднее время отклика. Выберите любой из этих элементов, чтобы отсортировать таблицу по нему. Нажмите снова, чтобы изменить порядок сортировки.

Наведите курсор на элемент, чтобы отобразить следующие элементы управления:

  • Просмотреть значок отчета View Report — выберите, чтобы открыть полные результаты для этого запуска коллекции. Узнайте больше об отладке результатов запуска .
  • Значок «Поделиться» Share — выберите, чтобы поделиться результатами с другим членом команды. Это предоставляет ссылку, которую можно передать другим участникам, чтобы они могли просмотреть детали этого запуска. Обратите внимание, что эта опция не работает в рабочих пространствах, доступных только вам.

Просмотр запланированных запусков

Во вкладке Scheduled отображаются все запланированные запуски для текущей коллекции. Для каждого запланированного запуска отображаются следующие данные:

  • Время запланированного запуска.
  • Название запланированного запуска
  • Окружение, связанное с запланированным запуском (если оно есть).

Наведите курсор на элемент, чтобы отобразить следующие элементы управления:

Просмотр запусков производительности

Во вкладке Performance отображаются прошлые запуски производительности для коллекции. Вы можете просматривать метрики для каждого запуска, включая количество виртуальных пользователей (VU), продолжительность, общее количество запросов, запросы в секунду, среднее время отклика и количество ошибок.

Выберите запуск, чтобы просмотреть график и полную информацию о запуске производительности. Узнайте больше о просмотре показателей производительности .

Автоматизация запусков коллекций по расписанию

Помимо ручного запуска коллекций, вы можете запланировать автоматический запуск коллекций в указанное время в Postman Cloud. Также вы можете использовать запуски коллекций с другими инструментами Postman, чтобы встроить автоматизацию в ваши проекты API:

  • Используйте интерфейс командной строки Postman CLI, чтобы запускать коллекции и интегрировать их в ваш процесс разработки, реагируя на результаты тестов для поддержки производительности вашего API.
  • Вы также можете использовать Newman для запуска коллекций из командной строки.
  • Добавление монитора к вашей коллекции позволяет вам планировать запуск коллекций и получать уведомления о любых проблемах.
  • Вы можете настроить вебхук для коллекции, чтобы инициировать запуск коллекции в определенное время с вашими собственными настройками данных. 

Следующие шаги

Развивайте основы Collection Runner, которые вы изучили, с помощью следующих тем:

Автоматизация запусков коллекций по расписанию

Вместо того чтобы запускать коллекции вручную, Postman может запускать их по расписанию. Используйте Collection Runner, чтобы выбрать коллекцию и настроить расписание. Например, вы можете настроить запуск коллекции, которая тестирует функциональность вашего API, каждый день в определенное время.

Когда вы планируете запуск коллекции с помощью Collection Runner, запланированный запуск добавляется во вкладку Runs > Scheduled в коллекции. Отсюда вы можете просматривать, приостанавливать, редактировать и удалять запланированные запуски.

Вы также можете настроить запуск коллекций с помощью мониторов. Запланируйте запуск с использованием мониторов, если хотите настроить оповещения, например, для активации уведомлений о сбоях. Для всех других случаев, таких как автоматизация тестирования API, рекомендуется использовать Collection Runner для планирования запусков.

О запланированных запусках коллекций

При работе с запланированными запусками коллекций следует учитывать следующие моменты:

  • Запланированные коллекции выполняются в Postman Cloud, а не локально.
  • Запланированные запуски не поддерживают запросы, которые используют файлы из вашего локального рабочего каталога для отправки данных в теле запроса. Вместо этого загрузите файлы тестовых данных в облако, чтобы они были доступны для запланированных запусков.
  • Расписания наследуют разрешения коллекций. Например, если у вас есть разрешение на редактирование коллекции, вы можете редактировать и расписания этой коллекции.
  • Вы можете запланировать запуск коллекций в персональных, частных и командных рабочих пространствах.
  • Если вы импортируете или экспортируете коллекцию, её расписания не импортируются и не экспортируются вместе с ней. Однако если вы удалите коллекцию, её расписания также будут удалены.
  • Запланированные коллекции подчиняются тем же ограничениям по использованию, что и мониторы .
  • Запланированные запуски не поддерживают типы аутентификации OAuth 2.0, которые требуют взаимодействия с пользователем, такие как authorization code, для вручную сгенерированного токена доступа. Узнайте больше в обзоре OAuth 2.0 .

Настройка запланированного запуска

Чтобы запланировать запуск для выполнения запросов в коллекции или папке, выполните следующие шаги:

  1. Выберите Collections на боковой панели и выберите коллекцию или папку, которую хотите запланировать для выполнения.
  2. Нажмите Значок бегуна Run.

Вы также можете выбрать Значок бегуна Runner из нижней панели Postman и перетащить коллекцию из раздела Collections или History на боковой панели.

  1. Перейдите в вкладку Functional и нажмите Schedule runs. Выберите любые параметры конфигурации:
    • Schedule name — название запланированного запуска.
    • Run Frequency — когда и как часто вы хотите, чтобы коллекция запускалась.
    • Environment— (необязательно) окружение с переменными, которые должна использовать коллекция.
    • Iterations  — количество запусков коллекций.
    • Data — файл с данными для запланированного запуска.
    • Notification recipients — укажите до пяти участников команды, которые будут получать уведомления о запуске.
    • Advanced settings (Расширенные настройки):
      • Retry if run fails – Отметьте этот флажок, чтобы попытаться выполнить запрос снова, если он не удался, и укажите количество попыток. Каждая попытка будет засчитываться в мониторинге использования.
      • Set request timeout – Отметьте этот флажок, чтобы пропустить запрос после истечения времени ожидания, и введите продолжительность тайм-аута в миллисекундах. Запланированный запуск не может превышать 15 минут.
      • Set delay between requests — Отметьте этот флажок, чтобы задать интервал задержки между отправкой запросов и введите задержку в миллисекундах.
      • Follow redirects — Снимите этот флажок, чтобы запросы, возвращающие ответ 3xx (редирект), не перенаправлялись автоматически.
      • Enable SSL validation — Снимите этот флажок, чтобы Postman не проверял действительность SSL-сертификатов при выполнении запросов.
  2. По умолчанию запросы выполняются в том порядке, в котором они указаны в коллекции. Если необходимо изменить порядок выполнения, перетащите запрос в нужное место. Также можно снять флажок с запроса, чтобы исключить его из выполнения.
  3. Когда все настройки будут завершены, выберите Schedule Run.

Запросы, отправленные в рамках запланированных запусков коллекции, вычитаются из вашего максимального количества вызовов API для мониторинга.

Чтобы узнать больше о том, как отслеживать использование ваших мониторов, ознакомьтесь с разделом Управление использованием монитора в Postman.

Просмотр запланированного запуска

Чтобы просмотреть результаты прошлых запланированных запусков, выполните следующие шаги:

  1. Выберите Collections на боковой панели и выберите коллекцию, которая содержит запланированный запуск, результаты которого вы хотите просмотреть.
  2. Выберите вкладку Runs> Scheduled.
  3. Наведите курсор на запланированный запуск и выберите View.
  1. В графике каждая колонка представляет собой отдельный запуск. Выберите колонку, чтобы просмотреть результаты тестов и лог консоли для этого запуска. Для получения дополнительной информации см. Просмотр запланированных запусков в Postman .

Выполнение запланированного запуска вручную

Когда запланированный запуск выполняется вручную, он запускается в Postman Cloud. Это полезно, если вы хотите исправить ошибки или воспроизвести проблемы.

  1. Выберите Collections  на боковой панели и выберите коллекцию с запланированным запуском, который вы хотите запустить вручную.
  2. Выберите вкладку Runs > Scheduled.
  3. Наведите курсор на нужный запланированный запуск и выберите View.
  1. Нажмите Run.

Приостановка или возобновление запланированного запуска

Когда вы приостанавливаете запланированный запуск, Postman больше не будет выполнять коллекцию до тех пор, пока вы не возобновите выполнение расписания.

  1. Выберите Collections на боковой панели и выберите коллекцию, которая содержит запланированный запуск, который вы хотите приостановить или возобновить.
  2. Выберите вкладку Runs > Scheduled.
  3. Наведите курсор на нужный запланированный запуск, Выберите иконку дополнительных действий Значок дополнительных действий и выберите Pause или Resume.

Редактирование запланированного запуска

Чтобы отредактировать запланированный запуск, выполните следующие шаги:

  1. Выберите Collections на боковой панели и выберите коллекцию с расписанием, которое вы хотите изменить.
  2. Выберите вкладку Runs > Scheduled.
  3. Наведите курсор на нужный запланированный запуск, Выберите иконку дополнительных действий Значок дополнительных действий и выберите Edit.
  1. Внесите изменения в параметры запланированного запуска, затем нажмите Save Changes.

Изменение порядка выполнения запросов

Вы можете отправлять запросы в коллекции в различных комбинациях или последовательностях, чтобы моделировать различные воркфлоу. В Collection Runner измените порядок запросов, перетаскивая их, или снимите галочку рядом с запросом, чтобы пропустить его.

Когда вы планируете запуск коллекции, вы можете изменить порядок запросов и сохранить этот пользовательский порядок для выполнения по расписанию. Таким образом, вы можете использовать одну и ту же коллекцию для автоматизации нескольких тестовых сценариев.

Чтобы изменить порядок запросов в запланированном запуске, выполните следующие шаги:

  1. ВыберитеCollections на боковой панели и выберите коллекцию или папку, которую вы хотите запланировать.
  2. Нажмите на иконку Значок бегуна Run. 

Вы также можете выбрать Значок бегуна Runner в нижней части Postman и перетащить коллекцию из раздела Collections или Historyна боковой панели.

  1. На вкладке Functional выберите Schedule runs.
  1. В разделе Run Order измените порядок, перетаскивая запросы. Чтобы пропустить запрос, снимите его галочку.
  1. Выберите Schedule Run.

На вкладке Runs > Scheduled сообщение Custom run order указывает, что запланированный запуск использует пользовательский порядок запросов. Если запрос был добавлен или удален из запланированной коллекции, рядом с запланированным запуском появляется ссылка Review Changes. Выберите эту ссылку, чтобы просмотреть и отредактировать изменения.

Запросы, отправленные в рамках запланированных запусков коллекции, вычитаются из вашего максимального количества API вызовов для мониторинга. Для получения дополнительной информации о проверке использования мониторов, смотрите раздел Управление использованием мониторов в Postman .

Удаление запланированного запуска

  1. Выберите Collections на боковой панели и выберите коллекцию с запланированным запуском, который вы хотите удалить.
  2. Перейдите во вкладку Runs > Scheduled.
  3. Наведите курсор на запланированный запуск, выберите иконку дополнительных действий Значок дополнительных действий и выберете Delete.

Просмотр запланированных запусков коллекций

Postman может запускать ваши коллекции по расписанию в определённое время каждый день или неделю. Например, вы можете настроить запуск коллекции, которая тестирует ваш API каждый день. Используйте Collection Runner для планирования автоматических запусков коллекций на определённые даты и время.

Чтобы просмотреть запланированные запуски коллекций в Postman, выберите коллекцию в боковой панели и перейдите во вкладку Runs > Scheduled. Чтобы просмотреть результаты запланированного запуска коллекции, наведите курсор на запуск и выберите View.

Запланированные запуски коллекций в рабочих пространствах видны всем участникам этого рабочего пространства.

Сводка запланированных запусков коллекций

Используйте график, чтобы анализировать состояние ваших API со временем. Каждая колонка на графике представляет отдельный запуск коллекции.

Верхняя часть графика отображает среднее время отклика для каждого запланированного запуска коллекции. Нижняя часть показывает количество неудачных тестов в каждом запуске по всем регионам. Чтобы увидеть точные значения процента сбоев и времени отклика, наведите курсор на конкретный запуск.

Красная полоса указывает на сбои тестов или возникшие ошибки во время выполнения. Для получения дополнительной информации откройте журнал консоли.

Фильтры

Используйте фильтры, чтобы выявлять повторяющиеся шаблоны в ваших запланированных запусках коллекций, выбирая определённые типы запусков и результаты.

Выберите Clear Filters, чтобы вернуться к исходному виду дашборда.

Фильтрация по типу

Фильтруйте по типу запуска, чтобы сравнить изменения времени отклика между всеми запусками, ручными запусками и запланированными запусками. Откройте Type в выпадающем списке и выберите нужный тип запуска.

Ручные запуски (Manual runs) — инициируются вручную в Postman. Запланированные запуски (Scheduled runs) — выполняются по расписанию, которое вы задали. Запуски через вебхуки (Webhook runs) — инициируются интеграциями, которые вы настроили.

Фильтрация по результату запуска

Каждый запланированный запуск имеет метку, соответствующую его результату:

  • Successful — Запуск коллекции завершён без ошибок, все тесты пройдены.
  • Failure — Запуск завершён, но один или несколько тестов не прошли.
  • Error — Запуск не завершён из-за ошибки (например, синтаксическая ошибка в коде теста, сетевые проблемы и т. д.). Для диагностики ошибок используйте журнал консоли.
  • Abort — Запуск превысил допустимое время выполнения (10 минут для бесплатного плана Postman, 15 минут для платных планов).

Фильтруйте запуски по их результату, чтобы сравнивать различия между ними. Откройте выпадающий список Run result. Выберите один или несколько типов результатов, которые хотите просмотреть.

Перемещение во времени

Анализируйте результаты прошлых запусков, чтобы понять, что происходило в конкретный момент времени. Чтобы перейти к определенному моменту времени, нажмите Go to на графике, выберите время и дату, а затем выберите Apply.

Чтобы вернуться к просмотру последних запусков, выберите время и дату на графике, затем выберите Reset.

Результаты тестов

Чтобы получить подробную информацию о тестах запланированного запуска, выберите столбец на графике, затем нажмите Test Results под графиком. Вы увидите пройденные и проваленные тесты, коды ответов и время отклика.

Журнал консоли

Журнал консоли содержит сведения о запланированном запуске, включая лог-записи из pre-request и post-response скриптов. Используйте его для отладки и анализа выполнения. Чтобы открыть журнал консоли выберите столбец на графике и нажмите Console Log под графиком.

Детали журнала включают этапы выполнения коллекции, такие как: подготовка к запуску, выполнение, завершение. Журнал также показывает ошибки и проваленные тесты.

💡 Если выбрать запрос в журнале консоли, он откроется в новой вкладке, где его можно просмотреть и отредактировать.

Логи запланированных запусков хранятся 6 месяцев. Если запуск старше, доступны только сведения о количестве провалов и ошибок. Полные данные получить нельзя, но можно обратиться в службу поддержки Postman .

Автоматизация запуска коллекций с помощью мониторов Postman

Вы можете автоматизировать запуски коллекций с помощью мониторов Postman. Создайте новый монитор, выберите коллекцию, настройте расписание выполнения. Postman выполнит коллекцию по заданному расписанию в Postman Cloud. Если возникнут ошибки или сбои, вы получите уведомление.

Вы также можете запланировать выполнение коллекций с помощью Collection Runner. Используйте мониторы для планирования запусков, если вам нужно настроить оповещения, например, для триггеров вызова на случай ошибок. Для всех остальных случаев, таких как автоматизация API-тестов, запланируйте запуски с помощью Collection Runner .

Читайте также: Как использовать мониторы в Postman для планирования конвейеров в CircleCI

Чтобы запланировать выполнение коллекции с помощью монитора, выполните следующие шаги:

  1. Выберите Monitors на боковой панели, затем выберите + Create new monitor.

Если на боковой панели нет раздела Monitors, вы можете добавить их, выбрав иконку Настроить значок боковой панели рабочего пространства Configure workspace sidebar.

  1. Введите имя монитора и выберите коллекцию , которую вы хотите запустить.
  2. В разделе Run this monitor укажите, когда и как часто вы хотите, чтобы коллекция выполнялась.
  3. Выберите другие параметры конфигурации для вашего монитора. Для получения дополнительной помощи ознакомьтесь с разделом Настройка монитора в Postman .
  4. Нажмите Create Monitor.

Postman будет запускать коллекцию по расписанию, которое вы настроили в мониторе. Вы получите уведомление, если возникнут ошибки или сбои. Чтобы просмотреть сводку результатов монитора, выберите Monitors на боковой панели и выберите нужный монитор. Узнайте больше о просмотре результатов монитора.

Ваш тарифный план в Postman ограничивает количество запросов, которые могут быть выполнены с помощью ваших Postman Monitors каждый месяц. Запросы, выполненные в рамках запланированных запусков коллекций, также учитываются в этом ограничении. Узнайте больше об использовании ресурсов в Postman .

Запуск коллекций с помощью вебхуков

Вебхук предоставляет способ автоматически отправлять данные из одного приложения в другое. С помощью вебхука вы можете инициировать запуск коллекции в Postman в определённое время или при наступлении какого-либо события. Когда вебхук срабатывает, Postman выполняет коллекцию с использованием монитора.

Вы также можете отправить на вебхук кастомную полезную нагрузку (payload), и Postman сможет использовать эти данные при выполнении коллекции. Отправка кастомной полезной нагрузки позволяет запускать коллекцию без использования окружения, полагаясь исключительно на данные, переданные через вебхук.

Создание вебхука

С помощью вебхука для коллекции данные отправляются на URL вебхука с использованием POST-запроса, когда определённые события активируются. Для этого необходимо настроить приложение, которое будет отправлять данные, и определить события-триггеры. Вебхуки для коллекций должны быть созданы с использованием Postman API . Узнайте, как использовать Postman API для создания вебхука.

Чтобы получить данные, отправленные на вебхук, используйте метод pm.globals.get с глобальной переменной previousRequest. С помощью скриптов, вы можете разобрать эти данные и использовать их в процессе выполнения коллекции любым доступным способом.

Доступ к телу запроса в скриптах

Когда вебхук активируется, временно создаётся глобальная переменная previousRequest, и её значение будет телом запроса вебхука в виде строки JSON. Чтобы получить тело запроса вебхука, используйте метод pm.globals.get('previousRequest'), а затем распарсите его с помощью JSON.parse(). Данные, отправленные на вебхук, будут доступны в параметре data внутри разобранного объекта. Вот пример кода:

var previousRequest = JSON.parse(pm.globals.get('previousRequest'));

var webhookRequestData = previousRequest.data;

// webhookRequestData contains the data sent to your webhook.
console.log(JSON.stringify(webhookRequestData));

Тело запроса, отправляемое в вебхук, должно использовать формат JSON.

При создании вебхука с помощью Postman API, для вебхука создается монитор. Чтобы запустить примерный код с использованием монитора, вы должны вызвать вебхук в отдельном запросе. Затем вы можете просмотреть детали выполнения монитора, которые были записаны в Консоль. Чтобы узнать больше о результатах монитора, перейдите в раздел Просмотр результатов монитора .

Отправить вывод в другой API

Используйте данные, отправленные в вебхук коллекции, для определения логики и вызова другого API. Например, вы можете настроить вебхук для вашего репозитория на GitHub. В зависимости от обновлений, происходящих в вашем репозитории, вы можете использовать вебхук для запуска пользовательских пайплайнов сборки или выполнения тестов CI.

Настройка порядка запросов в выполнении коллекции

По умолчанию при запуске коллекции Postman выполняет все запросы в том порядке, в котором они отображаются в коллекции. Запросы в папках выполняются первыми, затем идут запросы в корне коллекции. Чтобы динамически изменить порядок выполнения запросов во время выполнения коллекции, используйте функцию pm.execution.setNextRequest().

Вместо того, чтобы вручную изменять порядок запросов каждый раз при запуске коллекции, вы можете автоматизировать это поведение. Добавьте функцию pm.execution.setNextRequest() в ваши скрипты, чтобы указать, какой запрос Postman выполнит следующим, после текущего запроса. С помощью этой функции вы можете создавать воркфлоу, которые цепляют запросы, выполняя их один за другим в пользовательском порядке.

Установка следующего запроса

Чтобы указать запрос, который должен быть выполнен следующим, добавьте следующий код на вкладке Scripts > Post-response. Замените request_name на имя запроса, который вы хотите выполнить следующим.

pm.execution.setNextRequest("request_name");

Postman выполнит указанный запрос после завершения текущего запроса.

Цикл по запросу

Если передать имя текущего запроса в функцию setNextRequest, Postman будет выполнять текущий запрос несколько раз.

Важно: Чтобы избежать бесконечного цикла, оберните функцию setNextRequest в дополнительную логику. Например, можно задать условие, при котором запрос выйдет из цикла после определённого количества итераций или когда выполнится другое условие. В противном случае, чтобы завершить цикл, можно принудительно закрыть Collection Runner.

Остановка ворфлоу

Чтобы остановить воркфлоу, добавьте следующий код на вкладку Scripts > Post-response:

pm.execution.setNextRequest(null);

После выполнения текущего запроса, выполнение коллекции будет остановлено.

Также можно пропустить выполнение запроса из вкладки Pre-request скрипта, используя метод pm.execution.skipRequest. Узнайте больше о пропуске выполнения запроса из скриптов pre-request.

Советы по созданию воркфлоу запросов

Вот несколько важных советов, которые следует учитывать при использовании функции pm.execution.setNextRequest().

Используйте setNextRequest() при запуске всей коллекции

Используйте функцию pm.execution.setNextRequest() при запуске коллекции с помощью Collection Runner, Postman CLI или Newman. Эта функция не имеет эффекта, если вы запускаете выполнение запроса с помощью кнопки Send.

Используйте setNextRequest() в скриптах pre-request или post-response

Вы можете использовать функцию pm.execution.setNextRequest() как в скрипте pre-request, так и в скрипте post-response. Если заданы несколько значений, приоритет имеет последнее установленное значение.

Укажите следующий запрос с использованием ID запроса

Имя запроса может измениться, но его ID останется постоянным. Поэтому лучше всего использовать ID запроса, когда вы указываете следующий запрос.

Чтобы получить ID запроса, используйте pm.info.requestId. Например, можно выполнить console.log(pm.info.requestId). Для получения дополнительной информации, ознакомьтесь с информацией о скриптах воркфлоу.

Вы также можете получить ID запроса в Postman. Откройте запрос и в правой панели выберите иконку информации Значок информации. ID запроса будет начинаться с вашего ID пользователя (первый блок символов). Скопируйте ID запроса. Например, если ID запроса выглядит как 33664548-8de70c53-3f37-4570-a066-d1171451d11e, скопируйте 8de70c53-3f37-4570-a066-d1171451d11e.

setNextRequest() всегда выполняется последним

Функция pm.execution.setNextRequest() всегда выполняется в конце текущего запроса. Если вы разместите другие блоки кода в любой части скрипта pre-request или post-response после этой функции, эти блоки все равно будут выполняться перед pm.execution.setNextRequest().

Область действия setNextRequest() ограничена коллекцией

Область действия функции pm.execution.setNextRequest() ограничена источником вашего запуска коллекции.

  • Если вы запускаете всю коллекцию, вы можете установить любой запрос из коллекции как следующий запрос, включая запросы внутри папок.
  • Если вы запускаете папку, область действия pm.execution.setNextRequest() ограничена этой папкой. В этом случае вы можете установить следующий запрос только из той же папки, но не из других папок или корня коллекции.

Узнайте больше о запуске коллекций и работе с папками.

Следующие шаги

После того как вы узнали, как строить рабочие процессы запросов, вы можете начать писать скрипты.

Запуск коллекций с использованием импортированных данных

Запустите свои коллекции в Postman, используя пользовательские данные для каждой итерации. В Collection Runner выберите файл CSV или JSON с данными, которые вы хотите использовать. Когда вы запускаете коллекцию, Postman использует данные из файла для заполнения переменных в запросах коллекции.

Формат файла данных

Чтобы использовать файл CSV в Postman, его нужно правильно отформатировать следующим образом. Первая строка должна содержать имена переменных, которые вы хотите использовать в запросах. Эти имена переменных будут использоваться в коллекции для подстановки данных в соответствующие места. Каждая последующая строка будет использоваться как отдельный набор данных для выполнения итерации с данными. Конец строки в CSV файле должен быть в формате Unix. Каждая строка в файле должна содержать одинаковое количество столбцов. Это необходимо для того, чтобы все переменные могли быть правильно связаны с данными.

Для файлов CSV имейте в виду следующее:

  • Если числа в вашем файле данных длиннее 15 цифр, вам нужно отформатировать их как текст в программе для работы с таблицами, чтобы они не были усечены при экспорте в формат CSV.
  • Если в вашем CSV файле есть числа, длиннее 16 цифр, числа с ведущими нулями (например, 000000345) или телефонные номера (например, +12125556709), вам нужно будет предварительно просмотреть файл и указать тип столбца.

Форматируйте JSON-файлы как массив пар ключ-значение. Каждый ключ — это имя переменной, а значение — это данные, которые будут использоваться в запросе.

Имена переменных чувствительны к регистру, поэтому убедитесь, что вы используете одинаковый регистр для переменных в Postman, как в CSV или JSON файле. Переменные в файлах данных обрабатываются как локальные переменные, и вы можете получить к ним доступ с помощью метода pm.variables.get("variable_key"). Узнайте больше об использовании переменных в скриптах.

Запуск коллекции с файлами данных

Предположим, у вас есть коллекция с запросом, который принимает серийный номер и номер контакта в качестве параметров запроса, а также тест для проверки того, является ли значение переменной true.

Предположим, что серийные номера в вашем файле данных содержат ведущие нули, а номера контактов имеют префикс страны с символом + .

В этом примере вы создадите коллекцию, напишете тест для значений переменных и импортируете CSV-файл в Collection Runner. Вы просмотрите файл, при необходимости укажете типы столбцов и выполните коллекцию. Затем вы проверите лог, чтобы убедиться, что ваши данные были правильно обработаны.

  • Выберите Collections на боковой панели и нажмите + для добавления новой коллекции. Назовите коллекцию CSV Data Types.
  • Добавьте GET запрос со следующим адресом и назовите его Query Serial .
https://www.xcorp.io?serial={{serial}}&contact_no={{contact_no}}

Параметры запроса заполняются ключами serial и contact_no, а также значениями переменных.

  1. На вкладке Scripts > Post-response добавьте следующий скрипт для проверки значений переменных.
 pm.test('Variable should be true', () => {
     const variableValue = pm.variables.get('value');

     if (variableValue === true) {
         console.log('Value is true')
     } else if (variableValue === false) {
         console.log('Value is false')
     } else {
         console.log('Value is neither true or false')
     }
     pm.expect(variableValue).to.be.true
 });

Дополнительную информацию о том, что можно делать с данными итерации, см. в справочнике по Postman JavaScript .

  1. Создайте тестовый CSV-файл, как показано ниже. Назовите его test.csv
serial,value,name,contact_no
0001,true,Sunny,+14155553535
0002,false,4545,+16785553509
0003,true,Vicky,+12125556709

  1. Вернитесь к обзору коллекции CSV Data Types и выберите значок Значок бегуна Run.
  2. Выберите свой файл данных, нажав кнопку Select File. Postman автоматически установит количество итераций в зависимости от числа строк данных в файле.
  1. Выберите Preview, чтобы просмотреть данные в файле перед запуском.

Обратите внимание, что ведущие нули в серийном номере и префикс в номере телефона были удалены. Измените тип данных для этих чисел на String, чтобы сохранить исходные значения.

  1. Выберите Run CSV Data Types, чтобы начать выполнение коллекции с использованием значений из файла данных. Collection Runner выполнит все запросы в коллекции для каждой итерации в файле данных. Результаты показывают результаты для любых тестов, которые вы определили в своих запросах.
  2. Просмотрите Консоль в нижней части экрана, выбрав Console, и убедитесь, что как значения, так и проверка переменных правильные.

Ошибки при чтении файлов данных

Вы можете столкнуться с ошибками, когда Postman пытается прочитать ваш файл данных во время выполнения коллекции. Если это происходит, убедитесь, что ваш файл правильно отформатирован. Для получения инструкций см. Формат файла даты .

Если ошибки повторяются, обратитесь в службу поддержки Postman.

Перевод статьи «Test your API functionality».

🔥 Какой была ваша первая зарплата в QA и как вы искали первую работу? 

Мега обсуждение в нашем телеграм-канале о поиске первой работы. Обмен опытом и мнения.

Читать в телеграм

1 комментарий к “Коллекции Postman. Часть 2”

  1. Пингбэк: Коллекции Postman. Часть 3

Оставьте комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *