documentation
Bud tools
Every bud_ tool: products, test runs, statistics, the test catalog, the execution queue, Test Stations, results and artifacts.
Tools for Bud TMP. Each one calls the Bud API as the signed-in user, so Bud’s own permissions and rules apply.
22 tools: 16 read-only, 6 that change data.
Products
Section titled “Products”bud_products_list
Section titled “bud_products_list”List Bud products
read-only
List Bud products visible to the authenticated entity.
No input.
bud_products_get
Section titled “bud_products_get”Get Bud product
read-only
Get one Bud product by numeric ID.
| Input | Type | Required | Notes |
|---|---|---|---|
product_id |
integer | yes |
bud_products_create
Section titled “bud_products_create”Create Bud product
changes data
Create a Bud product. Requires Bud admin permissions.
| Input | Type | Required | Notes |
|---|---|---|---|
name |
string | yes | |
description |
string | ||
openproject_id |
string |
Test runs and publishing
Section titled “Test runs and publishing”bud_runs_list
Section titled “bud_runs_list”List Bud test runs
read-only
List Bud test runs with the filters supported by Bud.
| Input | Type | Required | Notes |
|---|---|---|---|
status |
string | ||
runner_account |
string | ||
location |
string | ||
q |
string | ||
suite |
string | ||
latest_per_suite |
boolean | Default false. |
|
limit |
integer | Default 50. 1 to 100. |
|
offset |
integer | Default 0. 0 to 9007199254740991. |
bud_runs_get
Section titled “bud_runs_get”Get Bud test run
read-only
Get one Bud test run by numeric ID.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes |
bud_runs_create
Section titled “bud_runs_create”Create Bud CI test run
changes data
Create a Bud CI test run record. Bud accepts this only from a Test Station; a signed-in user gets a 403 that names the custom-run alternative.
| Input | Type | Required | Notes |
|---|---|---|---|
test_case_list |
string | yes | |
test_suite_name |
string | yes | |
url_test_software |
string | ||
ref_test_software |
string | Default "main". |
|
url_software_under_test |
string | ||
ref_software_under_test |
string | ||
product_composition_id |
integer | ||
status |
Pending \ |
Running \ |
Completed \ |
pipeline_software_under_test |
boolean | Default false. |
|
runner_account |
string |
bud_runs_update
Section titled “bud_runs_update”Update Bud CI test run
changes dataupdates or deletes
Update a Bud CI test run execution state and counters. Bud accepts this only from the Test Station running it; a signed-in user gets a 403 that names the custom-run alternative.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes | |
status |
Pending \ |
Running \ |
Completed \ |
total_tests |
integer | 0 to 9007199254740991. | |
passed_tests |
integer | 0 to 9007199254740991. | |
failed_tests |
integer | 0 to 9007199254740991. | |
skipped_tests |
integer | 0 to 9007199254740991. | |
duration_seconds |
number |
bud_runs_stats
Section titled “bud_runs_stats”Get Bud test run statistics
read-only
Get aggregated test run and test case statistics (totals, pass/fail counts, pass rates).
| Input | Type | Required | Notes |
|---|---|---|---|
days |
integer | 1 to 3650. | |
runner_account |
string | ||
suite |
string |
bud_runs_filter_options
Section titled “bud_runs_filter_options”List Bud test run filter options
read-only
List available test suite names and runner station accounts that appear in test runs.
| Input | Type | Required | Notes |
|---|---|---|---|
days |
integer | 1 to 3650. |
bud_runs_publish_to_bloom
Section titled “bud_runs_publish_to_bloom”Publish Bud test run report to Bloom
changes data
Publish a completed Bud test run report into Bloom as a verification Report (RPT) document.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes |
bud_runs_trigger_custom
Section titled “bud_runs_trigger_custom”Queue Bud custom test run
changes data
Queue a custom test run for selected test paths on their assigned or pinned Test Station.
| Input | Type | Required | Notes |
|---|---|---|---|
test_paths |
string[] | yes | |
name |
string | ||
runner_account |
string |
bud_runs_events
Section titled “bud_runs_events”List Bud test run events
read-only
List execution and integration events for a Bud test run.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes |
bud_runs_artifacts
Section titled “bud_runs_artifacts”List Bud test run artifacts
read-only
List artifacts attached to a Bud test run.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes |
Catalog, queue and stations
Section titled “Catalog, queue and stations”bud_catalog_list
Section titled “bud_catalog_list”List Bud test catalog
read-only
List the Bud test catalog showing discovered test cases, suites, stations, method counts, and last pass/fail status.
| Input | Type | Required | Notes |
|---|---|---|---|
runner_account |
string | ||
suite |
string |
bud_execution_requests_list
Section titled “bud_execution_requests_list”List Bud execution requests
read-only
List queued and claimed custom execution requests in Bud.
No input.
bud_execution_requests_get
Section titled “bud_execution_requests_get”Get Bud execution request
read-only
Get one Bud custom execution request by numeric ID.
| Input | Type | Required | Notes |
|---|---|---|---|
request_id |
integer | yes |
bud_runners_status
Section titled “bud_runners_status”Get Bud Test Station status
read-only
Get online status, last heartbeat, location, and currently active run for all Bud Test Stations.
No input.
Results and artifacts
Section titled “Results and artifacts”bud_artifacts_info
Section titled “bud_artifacts_info”Get Bud artifact metadata
read-only
Get metadata for one Bud artifact without downloading its file body.
| Input | Type | Required | Notes |
|---|---|---|---|
artifact_id |
integer | yes |
bud_artifacts_get_content
Section titled “bud_artifacts_get_content”Read Bud artifact content
read-only
Read the text content of a Bud artifact (such as test logs or reports) by numeric ID, at most max_bytes from offset. Binary artifacts return their metadata without a body.
| Input | Type | Required | Notes |
|---|---|---|---|
artifact_id |
integer | yes | |
offset |
integer | Default 0. 0 to 9007199254740991. |
|
max_bytes |
integer | Default 65536. 1 to 1048576. |
bud_results_list_for_run
Section titled “bud_results_list_for_run”List Bud results for test run
read-only
List Bud test results belonging to one test run.
| Input | Type | Required | Notes |
|---|---|---|---|
run_id |
integer | yes |
bud_results_get
Section titled “bud_results_get”Get Bud test result
read-only
Get one detailed Bud test result including full error message, traceback, and assertions.
| Input | Type | Required | Notes |
|---|---|---|---|
result_id |
integer | yes |
bud_results_create
Section titled “bud_results_create”Submit Bud CI test results
changes data
Submit CI test execution results to Bud. Bud accepts this only from a Test Station; a signed-in user gets a 403 that names the custom-run alternative.
| Input | Type | Required | Notes |
|---|---|---|---|
results |
object[] | yes | |
test_run_id |
integer | ||
product_id |
integer | ||
runner_account |
string | ||
test_suite_name |
string | ||
url_test_software |
string | ||
ref_test_software |
string | ||
url_software_under_test |
string | ||
ref_software_under_test |
string |