CLI
Last updated
Was this helpful?
Last updated
Was this helpful?
You can operate BugBug via the Command Line Interface (CLI). This empowers you to integrate with any continuous integration (CI) or continuous deployment (CD) pipelines or build system hooks.
After you have NodeJS and npm installed simply run:
Remember that you need to have admin user permissions on NodeJS execution.
You need to take the API token of the project you want to run with CLI. You will find that in the BugBug web app in the Integrations tab from the side menu:
Then configure CLI with the project's API token:
On BugBug npm's page, you find the available commands. You can also just strike bugbug help to see what you can do and how.
Example: list suites within the connected project:
To run a particular test via CLI you need to find the ID of the test. It's easy, just go to your test, expand 3 dots, and select Run via CLI. Just simply copy the command for running, open the terminal, and paste and run. The command looks as below:
You can run the whole suite as well by going to Suites the tab, expanding the details, and selecting Run via CLI. The command is the same but SUITE_ID is different. That's how we recognize you want to run the whole suite!
Update your CI/CD build scripts to see test results directly in your build management tool (for example in Bitbucket)
Here's an example of what you can add to your build script:
When you run your pipeline, BugBug tests would be triggered and your build will only be successful if all tests passed.
Here is a list of the commands that may be in use with different options and/or flags:
bugbug help <option>config
remote
version
N/A
Show help menu for a specific command.
bugbug config <option>set-token <token>
N/A
You can use this option for the command to set a valid token from your web app project settings
bugbug remote <option>list test
--no-wait
Exit immediately without waiting for the result
--no-progress
Don't show progress spinner
--debug
Show more data (like raw API response)
Returns a list of all existing tests
list suite
--no-wait
Exit immediately without waiting for the result
--no-progress
Don't show progress spinner
--debug
Show more data (like raw API response)
Returns a list of all existing test suites
list profile
--no-wait
Exit immediately without waiting for the result
--no-progress
Don't show progress spinner
--debug
Show more data (like raw API response)
Returns a list of all existing test profiles
run test <test-id>
--no-wait
Exit immediately without waiting for the result
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--with-details
Show result with details
--profile
"<profile-name>"
Run with a specific, existing profile
--variable
"<variable-name>"
Override default variable during a single run
--reporter
The name of the reporter to use (default: "inline"). Instead of "inline" you can also set "junit" for the report to be exported to an XML file
--output-path
The path to save the test report. Relative to the current working directory
Runs a specific test based on its ID
stop test <test-run-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--result-timeout <int>
Modify the default result waiting time (minutes, default: 60)
Stop the test run based on its ID
run suite <suite-id>
--no-wait
Exit immediately without waiting for the result
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--with-details
Show result with details
--profile
"<profile-name>"
Run with a specific, existing profile
--variable
"<variable-name>"
Override default variable during a single run
--reporter
The name of the reporter to use (default: "inline"). Instead of "inline" you can also set "junit" for the report to be exported to an XML file
--output-path
The path to save the test report. Relative to the current working directory
Runs a specific test suite based on its ID
stop suite <suite-run-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--result-timeout <int>
Modify the default result waiting time (minutes, default: 60)
Stop the test suite run based on its ID
status test <test-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
Display the test's status based on a run ID
status suite <suite-run-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
Display the test suite's status based on a run ID
result test <test-run-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--with-details
Show results with details
Display the test result based on a run ID
result suite <test-run-id>
--no-progress
Exit immediately without waiting for the result
--debug
Show more data (like raw API response)
--with-details
Show results with details
Display the test suite's result based on a run ID
Output:
Output:
Output:
The XML file is automatically exported to your project's main directory:
Output:
Output:
Open your terminal. First of all, you need installed on your machine and installed.
You can also override individual from the command line with --variable variableName="customVariableValue". This allows you to run different combinations of test data in different environments, for example, you can insert a different user password on prod and a different one on staging.
Also read:
