Skip to content

postman

postman/postman@v1

Process ‘postman’ action.

postman actions have a mandatory collection input.

If the action is used more than once in a job, it is up to the caller to ensure no previous test execution results remains before executing a new test.

It is also up to the caller to attach the relevant reports so that publishers can do their job too, by using the actions/get-files@v1 action or some other means.

Example

- uses: postman/postman@v1
  with:
    collection: path/to/collection (JSON_file|URL)
- uses: postman/postman@v1
  with:
    collection: path/to/collection (JSON_file|URL)
    folder: folderName
    environment: path/to/Postman_environment (JSON_file|URL)
    iteration-data: path/to/Data_file (JSON|CSV)
    globals: path/to/Postman_globals_file (JSON)
    iteration-count: value1 (number)
    delay-request: value2 (number in ms)
    timeout-request: value3 (number in ms)
    bail: ('folder'|'failure'|true)

    extra-options: any other option

Inputs

  • collection (required)

    The Postman collection to run

  • folder (optional)

    Specify a single folder to run from a collection (--folder option)

  • environment (optional)

    Specify a Postman environment as a JSON [file] (-e, --environment option)

  • iteration-data (optional)

    Specify a data file to use either JSON or CSV (-d, --iteration-data option)

  • globals (optional)

    Specify a Postman globals file as JSON [file] (-g, --globals option)

  • iteration-count (optional)

    Define the number of iterations to run (-n, --iteration-count option)

  • delay-request (optional)

    Specify a delay (in ms) between requests [number] (--delay-request option)

  • timeout-request (optional)

    Specify a request timeout (in ms) for a request (--timeout-request option)

  • bail (optional)

    Stop the runner when an invalid folder was specified using the --folder option or an error was encountered in general (--bail option)

  • extra-options (optional)

    Any other option.

postman/execute@v1

An ‘execute’ action for use by generators.

execute actions have a mandatory test input.

Example

- uses: postman/execute@v1
  with:
    test: path/to/collection#folderName#requestName

Inputs

  • test (required)

    the datasource to use

postman/params@v1

A ‘params’ action for use by generators.

params actions have mandatory data and format inputs.

Example

- uses: postman/params@v1
  with:
    data:
      global:
        key1: value1
        key2: value2
      test:
        key1: value3
        key3: value4
    format: format
format must so far be SQUASHTM_FORMAT (tm.squashtest.org/params@v1).

data can have two keys:

  • global for defining global parameters
  • test for defining test parameters

Inputs

  • data (required)

    the data to use for the automated test

  • format (required)

    the format to use for the automated test data