executeCollection

Executes Postman Collection defined in a Postman application. The collection file or the collection URL will be passed as input along with other optional arguments to the plugin operation. JSON File(s) will be copied to the temporary directory and Property Replacement will be performed on the file before execution. Test Results will be generated as an XML file and copied to the FlexDeploy Test Results repository.

Test Instance Properties

Property Name

Property Code 

Required

Description

Property Name

Property Code 

Required

Description

Newman Executable Path

FDPMN_POSTMAN_PATH_TO_NEWMAN_UTILITY 

 No

Absolute Path to the Newman command line utility for Postman testing

This is an optional property. If newman is on the PATH, then you don't need to supply it. Otherwise, give the full path to newman utility.

Node Executable Path

FDPMN_POSTMAN_PATH_TO_NODEJS

 No

Absolute Path to the Node executable

This is an optional property. If the node executable is on the PATH, then you don't need to supply it. Otherwise, give the full path to node.

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Node Executable Path

FDPMN_INP_NODE_EXE_PATH

 

No

An absolute path to a Node executable. If not provided node must be on PATH or Test instance PATH properties must be set. See installNodeJS to install node.

Path or URL of Collection

FDPMN_POSTMAN_COLLECTION_FILE

Yes

Path to Collection File or the URL(http or https). Relative paths will be assumed to be in artifacts directory.

For example,

Path of Environment File

FDPMN_POSTMAN_ENVIRONMENT_FILE

 No

Path to Postman Environment file (e.g. /home/postman/dev.postman_environment.json)

This input resolves relative paths relative to the artifacts directory.

Folder Name in a Collection

FDPMN_POSTMAN_FOLDERNAME_IN_COLLECTION

 No

Folder name to run tests within a Collection.(e.g. test)

No of Test Iterations

FDPMN_TEST_ITERATIONS

 No

Number of iterations to run the collection.(e.g. any value must be > 0)

Artifacts

This operation consumes artifacts, which allows for test files to be part of artifacts.

Endpoint Selection

This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the Target.

Selecting a specific resource will result in selection of endpoints associated to the Target which have that resource defined.

Endpoint Execution 

This operation delegates endpoint execution to the workflow developer. The workflow editor will default to "Any", which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to "All" to will result in execution on all selected endpoints.

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