Hoppscotch CLI

​

Pre-requisites

​

Installing Hoppscotch CLI

npm i -g @hoppscotch/cli

​

Commands

​

hopp test

• The hopp test command recursively goes through each request in the collection and runs them, validating the responses with the test script provided in each request. Hence, the order of execution is the same as the order specified in the collection structure.
• If upon executing the command, a failed assertion (a failing test case) has occurred, the command will give a non-zero exit code and 0 exit code if all tests have passed.
• Unless there was a network error (for example, DNS resolution errors or network Connectivity Issues), the test script will be running and it is up to the test script to define what happens to error status codes. Non-200 status codes are still considered valid responses for test script execution.

hopp test [-e <environment file>] [-d <delay_in_ms> ] <hoppscotch collection file>

​

Running Collections present on the API client

hopp test  [-e <environment id>] [-d <delay_i_ms>] <hoppscotch collection id> [--token <access_token>] [--server <server url>]

​

Generate JUnit Report for Collection Runs

hopp test <file_path_or_id> --env <file_path_or_id> --reporter-junit [path]

​

JUnit Report Format Overview

​

Arguments

• hoppscotch collection id : Each collection created in a Hoppscotch 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 Hoppscotch 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 Hoppscotch 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).
  Copy

  hopp test <hoppscotch_collection_file_or_id> [--iteration-count <no_of_iterations>] [--iteration-data <file_path>]
  

• file_path: The path to the CSV file for iteration data. This file should follow the format:
  Copy

  key1,key2,key3
  value1,value2,value3
  value4,value5,value6
  

  Each row in the CSV corresponds to an iteration, and the values from that row will replace the respective environment variables during the iteration. For example:
  • Iteration 1: The values value1, value2, and value3 will be used.
  • Iteration 2: The values value4, value5, and value6 will be used.

​

Example

hopp test kitchen-sink-hoppscotch-collection.json
hopp test -e environment.json kitchen-sink-hoppscotch-collection.json
hopp test -e environment.json -d 1000 kitchen-sink-hoppscotch-collection.json
hopp test clxsntdgh0000lcx9fnits2h8 --token <access token> 
hopp test -e clxspay2r0006lcx99aqgjbay -d 1000 clxsntdgh0000lcx9fnits2h8 --token <access token> --server http://localhost:3170
hopp test -e environment.json kitchen-sink-hoppscotch-collection.json --reporter-junit kitchen-sink-junit.xml
hopp test kitchen-sink-hoppscotch-collection.json --iteration-count 3 --iteration-data /path/to/iteration-data.csv

​

Environment

​

1. Single Environment Entry Export Format

{
  "name": "my_env",
  "variables": [
    {
      "key": "base_url",
      "value": "https://echo.hoppscotch.io"
    },
    {
      "key": "auth_token",
      "value": "xxxxxxxxxxxx"
    }
  ]
}

​

2. Legacy Export Format

{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

​

3. Environment ID

​

Secrets

1. Inject the secret values as variables into the OS environment
2. Edit the environment export file and add the secret values manually

​

Options

​

Test Report Components