python-manilaclient — Errors

Errors — python-manilaclient — branch stable/2026.2

Branch stable/2026.2 @ d18a7e966 (6.3.0 + 2 maintenance commits) — repository https://opendev.org/openstack/python-manilaclient — analysed on 2026-11-01

The package is a client, so there are no HTTP statuses to return. A user sees a line on stderr and an exit code. [observed] means reproduced against the local stub; each case is recorded with its requests in [_rewrite/defects-observed_stable-2026.2.json](_rewrite/defects-observed_stable-2026.2.json) and can be replayed with [_rewrite/defects_stable-2026.2.py](_rewrite/defects_stable-2026.2.py). The stub is not Manila: a case shows what the client does with an answer, not that Manila gives this answer.

1. Exit codes

No command of this package returns a value from command.Command, which cliff would treat as the exit code. static_scan_stable-2026.2.py checks this, along with parsed_args attributes that the parser does not define, and found neither.

2. How a service failure reaches the user

SessionClient.request asks keystoneauth not to raise, then calls exceptions.from_response for any status >= 400 (manilaclient/common/httpclient.py:97-99).

A 404 during a name lookup does not reach the user as a 404. apiutils.find_resource catches it and prints No share with a name or ID of 'x' exists. (manilaclient/common/apiclient/utils.py:68-74). A multiple match prints Multiple share matches found for 'x', use an ID to be more specific. (manilaclient/common/apiclient/utils.py:76-83).

Other answers are also swallowed: osc_lib.utils.find_resource catches every exception of its first get (osc-lib:osc_lib/utils/__init__.py:236). **A 500 or a 403 on GET /share-backups/{id} therefore looks like a missing resource**, or leads to a listing [inferred from the code; the 404 path was observed].

3. Discovery, version and connection failures [observed]

Note that OS_SHARE_API_VERSION=2, a natural setting for a major version, breaks every share command with this plugin. OSC's own default for its unloaded copy is the string 2 (openstackclient:openstackclient/share/client.py:30).

4. Defects found

All reproduced on the stub, unless the row says otherwise. Severity is my reading of the impact.

Impact of defects 1 and 2 on a real Manila [inferred, read in the Manila code, not run]: reset_task_state needs the admin role (manila:manila/policies/shares.py:564-566), and Manila accepts a null task state (manila:manila/common/constants.py:265, manila:manila/api/openstack/wsgi.py:1209). So a project member running share set --name x should get a renamed share, a 403, and exit 1. An admin running the same command clears any task state on the share, including during a migration. Unit tests cannot show this: FakeShareClient is a mock (manilaclient/tests/unit/osc/v2/fakes.py:27), and they assert that reset_task_state is called with None for the explicit option only (manilaclient/tests/unit/osc/v2/test_share.py:1472).

Impact of defect 3 on a real Manila [inferred]: Manila's check is expected to return a populated dict (manila:manila/api/v2/share_servers.py:479), so this needs an empty answer. A compatible service must never answer {} to migration_check.

Not a defect, for the record: the probe's first runs reported Type names and field names must be valid identifiers on share access list below 2.45. That came from a colon in a key of the stub's body, read by a namedtuple (manilaclient/v2/shares.py:1080). Manila does send only plain keys there [inferred].

5. Fields a command needs in an answer [observed]

Missing fields raise on the client. These are hard requirements for a compatible service.

A service that ignores is_soft_deleted=True breaks every name lookup of a share from 2.69: Multiple share matches found for 'x' (case name-lookup-nofilter, manilaclient/base.py:264-269).

6. Exception classes

The package defines 49 classes (_inventory/inventory_stable-2026.2.json). Commands raise osc_lib.exceptions.CommandError for their own checks, and let these pass through.

One trap for code that catches these: find_resource matches exceptions.NotFound from manilaclient, while the python-keystoneclient lookups go through osc-lib, which compares class names (osc-lib:osc_lib/utils/__init__.py:258).

7. Asynchronous errors

There is no background process, so the client knows about an asynchronous failure only by polling. See 05. Manila's user messages are readable with share message list, and with --resource-id for one share (manilaclient/osc/v2/messages.py:156). The client does not read them by itself.

8. Key log messages

9. Catalogue of messages raised by the commands

176 distinct messages at 199 sites, read from the source by extract_plugin_stable-2026.2.py. Most are client-side checks: no request is needed to raise them, unless the check follows a lookup. Variables keep their template form.

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