Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# [START spanner_list_database_roles]
import sys

from google.api_core import exceptions
from google.cloud import spanner_admin_database_v1
Comment on lines +16 to +19

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

With the exception handling refactored to propagate exceptions, the sys and google.api_core.exceptions modules are no longer used and can be safely removed.

Suggested change
import sys
from google.api_core import exceptions
from google.cloud import spanner_admin_database_v1
from google.cloud import spanner_admin_database_v1

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! The sample keeps its exception handling (see the reply below), so these imports are still used.



def list_database_roles(project_id: str, instance_id: str, database_id: str) -> None:
"""Lists all system and user-defined database roles in a Spanner database.

Args:
project_id: The Google Cloud project ID.
instance_id: The Spanner instance ID.
database_id: The Spanner database ID.
"""
client = spanner_admin_database_v1.DatabaseAdminClient()
database_path = client.database_path(project_id, instance_id, database_id)
request = spanner_admin_database_v1.ListDatabaseRolesRequest(parent=database_path)

try:
roles = list(client.list_database_roles(request=request))
except exceptions.NotFound as err:
print(
f"error: database '{database_id}' on instance '{instance_id}' "
f"was not found: {err.message}",
file=sys.stderr,
)
except exceptions.GoogleAPICallError as err:
print(
f"error: failed to list database roles on database "
f"'{database_id}' in instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
print(f"Resource ID: {database_id}")
for role in roles:
role_id = role.name.split("/")[-1]
print(f"Database Role: {role_id}")
print(f"Role Count: {len(roles)}")
Comment on lines +34 to +53

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Swallowing exceptions and printing them to sys.stderr inside a library/sample function is an anti-pattern. It prevents callers (including tests and other scripts) from programmatically detecting failures, and causes the CLI script to exit with a success status code (0) even when an error occurs.

Instead, let the exceptions propagate naturally. This simplifies the code, ensures the CLI exits with a non-zero status on failure, and makes the function much easier to test using pytest.raises.

    roles = list(client.list_database_roles(request=request))

    print(f"Resource ID: {database_id}")
    for role in roles:
        role_id = role.name.split("/")[-1]
        print(f"Database Role: {role_id}")
    print(f"Role Count: {len(roles)}")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the feedback! Standalone documentation snippets here intentionally catch google.api_core.exceptions inside the sample function and print actionable diagnostic messages to stderr so readers can see concrete error handling directly in context, so we are keeping the try/except block.



# [END spanner_list_database_roles]


if __name__ == "__main__":
import argparse
import os

parser = argparse.ArgumentParser(
description="List database roles in a Spanner database."
)
parser.add_argument(
"--project-id",
default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"),
help="Google Cloud project ID (default: $GOOGLE_CLOUD_PROJECT)",
)
parser.add_argument(
"--instance-id",
default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"),
help="Spanner instance ID (default: $SPANNER_INSTANCE_ID)",
)
parser.add_argument(
"--database-id",
default=os.environ.get("SPANNER_DATABASE_ID", "example-db"),
help="Spanner database ID (default: $SPANNER_DATABASE_ID)",
)
args = parser.parse_args()

list_database_roles(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
)
118 changes: 118 additions & 0 deletions spanner/database_admin/tests/list_database_roles_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Copyright 2026 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import runpy
from unittest import mock

from google.api_core import exceptions
import pytest
from spanner_database_admin import list_database_roles

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-instance"
DATABASE_ID = "example-db"
ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient"


@mock.patch(ADMIN_CLIENT)
def test_list_database_roles_success(
mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str]
) -> None:
mock_client_class.return_value.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
role_pb = mock.MagicMock()
role_pb.name = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}/databaseRoles/public"
mock_client_class.return_value.list_database_roles.return_value = [role_pb]

list_database_roles.list_database_roles(PROJECT_ID, INSTANCE_ID, DATABASE_ID)

out, err = capsys.readouterr()
assert f"Resource ID: {DATABASE_ID}" in out
assert "Database Role: public" in out
assert "Role Count: 1" in out
assert PROJECT_ID not in out
assert err == ""


@pytest.mark.parametrize(
"error, expected_prefix",
[
(exceptions.NotFound("missing"), "error: database 'example-db'"),
(
exceptions.PermissionDenied("denied"),
"error: failed to list database roles",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_list_database_roles_errors(
mock_client_class: mock.MagicMock,
capsys: pytest.CaptureFixture[str],
error: Exception,
expected_prefix: str,
) -> None:
mock_client_class.return_value.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
mock_client_class.return_value.list_database_roles.side_effect = error

list_database_roles.list_database_roles(PROJECT_ID, INSTANCE_ID, DATABASE_ID)

_out, err = capsys.readouterr()
assert err.startswith(expected_prefix)
assert PROJECT_ID not in err
Comment on lines +51 to +77

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since the list_database_roles function has been refactored to propagate exceptions rather than swallowing them, update the unit tests to assert that the expected exceptions are raised using pytest.raises.

@pytest.mark.parametrize(
    "error",
    [
        exceptions.NotFound("missing"),
        exceptions.PermissionDenied("denied"),
    ],
)
@mock.patch(ADMIN_CLIENT)
def test_list_database_roles_errors(
    mock_client_class: mock.MagicMock,
    error: Exception,
) -> None:
    mock_client_class.return_value.database_path.return_value = (
        f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
    )
    mock_client_class.return_value.list_database_roles.side_effect = error

    with pytest.raises(type(error)):
        list_database_roles.list_database_roles(PROJECT_ID, INSTANCE_ID, DATABASE_ID)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Since the sample keeps its explicit exception handling and stderr reporting, this test keeps its capsys stderr assertions.



@mock.patch(ADMIN_CLIENT)
def test_list_database_roles_cli_entrypoint(
mock_client_class: mock.MagicMock,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
mock_client_class.return_value.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
mock_client_class.return_value.list_database_roles.return_value = []
monkeypatch.setattr(
"sys.argv",
[
"list_database_roles.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
],
)

runpy.run_module("spanner_database_admin.list_database_roles", run_name="__main__")

assert "Role Count: 0" in capsys.readouterr().out


@conftest.live_only
def test_list_database_roles_live(capsys: pytest.CaptureFixture[str]) -> None:
list_database_roles.list_database_roles(
conftest.LIVE_PROJECT_ID,
conftest.LIVE_INSTANCE_ID,
conftest.LIVE_DATABASE_ID,
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert "Database Role: public" in out