python-octaviaclient — Errors

Errors — python-octaviaclient — branch stable/2026.2

Branch stable/2026.2 @ b37975ec8f2d (tag 3.15.0 + 2 commits) — repository https://opendev.org/openstack/python-octaviaclient — analysed on 2026-11-01

[observed] means reproduced against the local stub (scenarios in [_rewrite/defect-repro_stable-2026.2.json](_rewrite/defect-repro_stable-2026.2.json)). A stub shows how the client reacts to an answer, not whether a real service sends that answer.

1. Exit codes

**The command.Command return value is not a problem here**: cliff treats a returned value as the exit code (cliff:cliff/command.py:196), but none of the 38 command.Command classes returns one. This was checked by an AST walk, and all of them exit 0 on the typed stub [observed].

2. HTTP errors: correct_return_codes

All 73 API methods go through this decorator (octaviaclient/api/v2/octavia.py:26-62). keystoneauth raises an HttpError for any status of 400 or more; it carries response and request_id (keystoneauth:keystoneauth1/exceptions/http.py:81-82).

Status table: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not found, 409 Conflict, 413 Over Limit, 501 Not Implemented, 503 Service Unavailable. The request ID comes from the service's x-openstack-request-id header: denied (HTTP 403) (Request-ID: req-1234) [observed].

Consequence of the first row: the body {"faultcode", "faultstring", "debuginfo"} is what puts the service's text in front of the user. Octavia sends it (octavia:octavia/tests/functional/api/v2/test_load_balancer.py:139). A service using another shape shows canned text only.

**Status on GET of one resource**: find turns 404 and 400 into osc-lib NotFound (osc-lib:osc_lib/api/api.py:411-425), which triggers the show fallback [observed]. A 403 becomes denied (HTTP 403)… and stops there [observed].

3. Messages raised by the client

4. How a failure reaches the user

flowchart TD
  a[HTTP status 400 or more] --> b[keystoneauth HttpError]
  b --> c{find on 404 or 400?}
  c -->|yes| d[osc-lib NotFound, show falls back on lookup]
  c -->|no| e[correct_return_codes: OctaviaClientException]
  f[local validation] --> g[CommandError or InvalidValue]
  h[missing key, bad body, bad input] --> i[KeyError, TypeError, AttributeError, ValueError]
  d --> j[cliff logs the text on stderr, exit 1]
  e --> j
  g --> j
  i --> j

There is no asynchronous error beyond --wait, and no log message of the plugin's own. The package never uses its LOG (octaviaclient/osc/plugin.py:19).

5. Defects

Reproductions are in _rewrite/defect-repro_stable-2026.2.json, by scenario name. The stub chooses the answer, so "reproduced" means the client behaves this way on that answer. Whether a real service sends it is stated row by row.

Lesser oddities [observed]:

• --no-tag on create is accepted and has no effect.
• set with no option sends an empty PUT, which may move a load balancer to PENDING_UPDATE on a real service [inferred].
• listener set --hsts-preload skips the check that create applies; this is defensible, since the listener may already hold a maximum age.
• Quota field spelling differs between set and unset.
• A next link that repeats makes _list loop with no delay: 4,693 requests in 5 s in pagination_never_ends. Only a faulty service would cause it.
• --os-loadbalancer-api-version validates nothing and is not sent.

Items 1 to 13 pass all unit tests, because commands use a mocked API (octaviaclient/tests/unit/osc/v2/test_load_balancer.py:36) and the API tests use well-formed bodies.

6. Timeouts and retries

• The session is the one built by OSC; make_client adds no timeout (octaviaclient/osc/plugin.py:37-41). Unless the cloud sets api_timeout, a stuck service blocks the command [inferred; default read in python-openstackclient's report].
• keystoneauth's connect_retries defaults to 0 (keystoneauth:keystoneauth1/session.py:408). The plugin sets no retry.
• Connection failures carry no response, so they pass through the decorator unchanged (octaviaclient/api/v2/octavia.py:54-55) [inferred].

Source: reverse-spec-python-octaviaclient/02-errors_stable-2026.2.md. The _rewrite/ and _inventory/ files are not published on the site.