Skip to content

python_client.md

Latest commit

 

History

History
73 lines (54 loc) · 1.94 KB

python_client.md

File metadata and controls

73 lines (54 loc) · 1.94 KB

Python Client

opp_ci/client.py provides OppCiClient, a thin wrapper around the REST API for programmatic submission and querying.

Setup

from opp_ci.client import OppCiClient

ci = OppCiClient(url="https://ci.omnetpp.org/api", token="<submitter-token>")

Note the /api suffix on the URL — OppCiClient does not prepend it. The --remote CLI mode, by contrast, takes the bare coordinator URL (https://ci.omnetpp.org) in OPP_CI_COORDINATOR_URL and appends /api on your behalf.

Token roles are described in rest_api.md. Use a submitter token for run submission and a readonly token for read-only scripts.

Submitting runs

# Single run
run = ci.submit_run(project="inet", test_type="smoke", git_ref="topic/my-feature")
print(run)  # {"id": 42, "status": "queued"}

# Fully-specified run on a podman/host-toolchain worker
ci.submit_run(
    project="inet-4.5", test_type="fingerprint",
    mode="release", git_ref="master",
    os="Ubuntu", os_version="26.04", arch="amd64",
    compiler="clang", compiler_version="22",
    isolation="podman", toolchain="none",
    force=True,
)

# All jobs in a named matrix
ci.submit_matrix(matrix_name="inet-full")

Querying

ci.get_run(42)
ci.list_runs(project="inet", status="FAIL")
ci.list_workers()

Admin operations (admin token required)

ci.register_worker(name="builder-1", tags=["linux", "amd64"], concurrency=4)
ci.create_token(name="github-bot", role="submitter")

CLI equivalent

The CLI accepts --remote to route through the API instead of running locally:

export OPP_CI_COORDINATOR_URL=https://ci.omnetpp.org
export OPP_CI_API_TOKEN=<submitter-token>

opp_ci --remote run --project inet-4.5 --test smoke,fingerprint --ref master
opp_ci --remote list-runs --project inet --status FAIL

Useful for one-off submissions, cron jobs, or scripting around the CI without writing Python.