Protocol load testing using Locust

Specify number of virtual users

Set vus to the maximum number of virtual users to simulate during the test. The maximum limit for this config is currently 1000. Contact us if you want to increase this limit.

Specify the test scripts

The files block defines the key files needed to identify which tests to execute.

Single Locust file

For a test that lives in a single Python file, set testScripts to the absolute path of that file:

files:
  testScripts:
    - /Users/abc/Desktop/testing-locust/locustfile.py

Multi-file Locust project

If your test depends on helper modules, data files, or third-party Python packages, configure testDir along with testScripts:

• testDir: Absolute path to the directory that contains your Locust scripts, helper modules, data files, and requirements.txt. The CLI zips this directory as is and uploads it, so your folder structure is preserved.
• testScripts: Absolute path to the main Locust entry script. The path must point to a file inside testDir.

files:
  testDir: /Users/abc/Desktop/testing-locust
  testScripts:
    - /Users/abc/Desktop/testing-locust/locustfile.py

Behavior and constraints

• The CLI validates that the entry script defined in testScripts exists inside testDir. If it is missing, the run fails fast with an error.
• BrowserStack includes every file and folder under testDir in the upload, so relative imports such as from utils.helpers import login continue to work at runtime.
• To add third-party Python packages, place a requirements.txt file at the root of testDir. BrowserStack installs the listed packages before the run starts. Keep the install lightweight, since the install step has a 120-second timeout.
• The maximum upload size is 100 MB.
• If your test imports a file that is not present under testDir, the test run fails when Locust executes those imports.

Set reporting structure

• Use projectName to group related tests under the same project on the dashboard. Use testName to group multiple runs of the same test.
• Both projectName and testName must remain consistent across different runs of the same test.
• You can use the following characters in projectName and testName:
  • Letters (A to Z, a to z)
  • Digits (0 to 9)
  • Periods (.), colons (:), hyphens (-), square brackets ([]), forward slashes (/), at signs (@), ampersands (&), single quotes (‘), and underscores (_)
  • All other characters are ignored.