Run tests, manage automated API monitoring, and more.
Windows & macOS
node-gyp
installed. Thus, follow the instructions from node-gyp.Debian / Ubuntu derivatives
Alpine Linux
Amazon Linux (AMI)
Arch Linux
RHEL / Fedora derivatives
v0.11.1
. Future CLI versions will require Node.js v20 or higher. hopp test
hopp test
command allows you to run tests against a Postdata collection file.
hopp test
command can also be used to run collections present in your API client on Postdata cloud or self-hosted platforms.
Do note that you need to create a personal access token for your CLI to connect to your API client, and you can not run collections present in your personal workspace.
hopp test
command now has the ability to generate a JUnit Report for collection runs in the CLI. The report is generated as an XML file at the specified path provided in the command. If no path is specified, the report will be saved in the working directory with the default name hopp-junit-report.xml
.
Element | Description |
---|---|
<testsuites> | Root element representing the entire set of test suites. |
<testsuite> | Represents a collection of test cases for a specific request. |
<testcase> | Represents an individual test case. It corresponds to pw.expect() assertions with the description prefixed by that of the test suite pw.test() . It appears as a direct child of <testsuite> . |
name | Attribute for <testsuite> and <testcase> elements. For <testsuite> , it indicates the hierarchy of collections up to the request. Organized at the request level using the naming convention: <parent-collection-name>/<child-collection-name>/<request-name> . While, for <testcase> , it’ll be the description. |
classname | Attribute of <testcase> that mirrors the name attribute of the parent <testsuite> . |
<failure> | Indicates an assertion failure within a <testcase> . Includes type and message attributes describing the failure. |
<error> | Indicates an error during assertion within a <testcase> . Includes message attribute describing the error. |
<system-err> | Represents errors reported at the request level (e.g., invalid URL, reference error in the test script). These errors are detailed within a CDATA section, with each error separated by newlines to ensure each issue is clearly identified. |
time | Attribute of <testsuite> that shows the execution time for the test cases (excluding request execution time). The total time is at the root <testsuites> . |
timestamp | Attribute of <testsuite> that records the execution date and time in ISO string format. |
tests , failures , errors | Attributes of <testsuite> and <testsuites> that track the number of test cases, failed cases, and errors, at the request level and effective count at the root level test suite respectively. Set to 0 at a request level test suite, if errors halt further execution. |
postdata collection id
: Each collection created in a Postdata workspace is given a unique identifier known as the Collection ID. Collection IDs for each collection can be found under “Details” tab inside Collection “Properties”.
environment id
: Similar to Collection IDs, each environment created in a Postdata workspace is assigned a unique identifier known as the Environment ID.
delay_i_ms
: Represents a time interval (in milliseconds) to pause execution of API requests before within a collection.
access token
: It is a secure, unique identifier used to authenticate a user’s access to their Postdata account and its resources like collections, environments data. Learn more about personal access tokens
server url
: This optional and is the URL of your self-hosted instance when you’re self-hosting your API client
path
: Accounts for a file path where the JUnit report will be saved as an XML file in your file system.
no_of_iterations
: Indicates the number of iterations to run the collection. Each iteration will run the entire collection once, replacing any iteration-specific data defined by the --iteration-data
flag (if provided).
file_path
: The path to the CSV file for iteration data. This file should follow the format:
<<baseurl>>/post
and specify baseurl as https://echo.postdata.cn
in an environment file.
Postdata CLI supports environment files in two specific formats:
Properties
action present in the menu icon next to each environment. Within the Details section, you’ll find the Environment ID. Copy this ID and use it in the Postdata CLI for execution.
Option | Description |
---|---|
-h | Gives a list of associated commands and their descriptions |
-v | Displays the current version of the CLI |
--env or -e | Accepts environments in all the formats present in Environment section. |
--delay or -d | Used to defer the execution of requests in a collection. |
--token | Expects a personal access token to be passed for establishing connection with your Postdata account. |
--server | URL of your self-hosted instance, if your collections are on a self-hosted instance. |
--reporter-junit | Expects a file path to store the JUnit Report. |
--iteration-count | Defines the number of iterations to run the collection. |
--iteration-data | Accepts the path to a CSV file that contains iteration data. |
pw.expect()
within the testScript of a request is considered a test case.pw.test()
within the testScript of a request is regarded as a test suite.testScript
fields across all requests in the provided collection export file, representing the overall number of test scripts executed.