FlexDeploy - Postman Plugin Guide

Owned by Vijayalakshmi Karupusamy (Unlicensed)
Last updated: Mar 30, 2018 by Chandresh Patel
2 min read

The Postman plugin enables to run Postman Collections (multiple testsuites) and a specific folder within a collection defined in Postman. The entire collection must be exported to a file or the Postman collection URL(http or https) must be provided as an input to this plugin. Collection must contain one or more test suites, with one or more tests cases defined. FlexDeploy Plugin supports Postman Integration using Newman utility(command line collection runner for Postman). 

Setting up Testing Instance

You can install Newman and Node on your Build or Development servers for execution of Tests. This should be defined in FlexDeploy as Testing Instance. See Creating/Editing a Test Instance. You can use this Testing Instance as Override on your Test Definition, which means that if you are running Build or Deploy on any server/environment and as part of the Workflow you execute tests, execution will transfer to specific Testing Instance for execution of Tests.

You can omit setup of Testing instance if newman and node are available on PATH environment variable wherever you are executing Build, Deploy or Test Workflow.

Supported Versions

The Postman plugin has been tested with Postman version 6.0.9, 6.0.10 running on Windows and Linux Endpoints. Newman runs best with Postman version 6.0.10, but the test results will be identical across the versions of Postman. 

Newman is built on Node.js. Node.js must be installed and Newman should be configured globally on the endpoint system so that it can be run from anywhere.

Node.js needs to be setup in the system environment path of the endpoint before running the plugin operation. If this setup is not done, plugin will  set up the same in the end point and then proceed with the collection runner.

  • Tested against the latest version 3.9.3 of Newman with the current Postman version 6.0.10 collections.

Key Features

  • Plugin supports execution of an entire Postman collection and a specific folder within a collection as well.
  • Aggregates test results for each test execution.
  • Plugin includes features to run a Postman collection against the given Postman environment file, number of iterations to run tests, report file generation etc.

Plugin Operations

The following macros are not currently supported in the footer:
  • style