From acd63e373f4c5b53ea0c1ad951113fe11febb2ee Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 22:16:16 +0000 Subject: [PATCH] feat(spanner): Add ListBackupSchedules database schedule sample Enumerating full and incremental backup schedules on a database calls DatabaseAdminClient.list_backup_schedules. Add a standalone spanner_list_backup_schedules sample. --- .../spanner_backups/list_backup_schedules.py | 84 ++++++++++ .../tests/list_backup_schedules_test.py | 146 ++++++++++++++++++ 2 files changed, 230 insertions(+) create mode 100644 spanner/backups/src/spanner_backups/list_backup_schedules.py create mode 100644 spanner/backups/tests/list_backup_schedules_test.py diff --git a/spanner/backups/src/spanner_backups/list_backup_schedules.py b/spanner/backups/src/spanner_backups/list_backup_schedules.py new file mode 100644 index 0000000000..360078d584 --- /dev/null +++ b/spanner/backups/src/spanner_backups/list_backup_schedules.py @@ -0,0 +1,84 @@ +# 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_backup_schedules] +import sys + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 + + +def list_backup_schedules(project_id: str, instance_id: str, database_id: str) -> None: + """Lists all backup schedules configured on a Cloud 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() + parent = client.database_path(project_id, instance_id, database_id) + request = spanner_admin_database_v1.ListBackupSchedulesRequest(parent=parent) + + try: + schedules = list(client.list_backup_schedules(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 backup schedules on database " + f"'{database_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Schedule Count: {len(schedules)}") + for sched in schedules: + sched_id = sched.name.split("/")[-1] + print(f"Schedule ID: {sched_id}, " f"Cron: {sched.spec.cron_spec.text}") + + +# [END spanner_list_backup_schedules] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="List backup schedules on a Spanner database." + ) + parser.add_argument( + "--project-id", + default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"), + ) + parser.add_argument( + "--instance-id", + default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"), + ) + parser.add_argument( + "--database-id", + default=os.environ.get("SPANNER_DATABASE_ID", "example-db"), + ) + args = parser.parse_args() + + list_backup_schedules( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/backups/tests/list_backup_schedules_test.py b/spanner/backups/tests/list_backup_schedules_test.py new file mode 100644 index 0000000000..a2cee026c7 --- /dev/null +++ b/spanner/backups/tests/list_backup_schedules_test.py @@ -0,0 +1,146 @@ +# 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 +import uuid + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 +import pytest +from spanner_backups import create_full_backup_schedule +from spanner_backups import list_backup_schedules + +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_backup_schedules_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + client = mock_client_class.return_value + client.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + sched = mock.MagicMock() + sched.name = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}/backupSchedules/sched-1" + sched.spec.cron_spec.text = "30 12 * * *" + client.list_backup_schedules.return_value = [sched] + + list_backup_schedules.list_backup_schedules(PROJECT_ID, INSTANCE_ID, DATABASE_ID) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Schedule Count: 1" in out + assert "Schedule ID: sched-1, Cron: 30 12 * * *" 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 backup schedules", + ), + ], +) +@mock.patch(ADMIN_CLIENT) +def test_list_backup_schedules_errors( + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + client = mock_client_class.return_value + client.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + client.list_backup_schedules.side_effect = error + + list_backup_schedules.list_backup_schedules(PROJECT_ID, INSTANCE_ID, DATABASE_ID) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(ADMIN_CLIENT) +def test_list_backup_schedules_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + client = mock_client_class.return_value + client.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + client.list_backup_schedules.return_value = [] + monkeypatch.setattr( + "sys.argv", + [ + "list_backup_schedules.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module("spanner_backups.list_backup_schedules", run_name="__main__") + + assert "Schedule Count: 0" in capsys.readouterr().out + + +@conftest.live_only +def test_list_backup_schedules_live(capsys: pytest.CaptureFixture[str]) -> None: + admin = spanner_admin_database_v1.DatabaseAdminClient() + sid = f"example-lsc-{uuid.uuid4().hex[:6]}" + spath = admin.backup_schedule_path( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + sid, + ) + try: + create_full_backup_schedule.create_full_backup_schedule( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + sid, + ) + capsys.readouterr() + list_backup_schedules.list_backup_schedules( + 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 f"Schedule ID: {sid}" in out + finally: + try: + admin.delete_backup_schedule(name=spath) + except exceptions.NotFound: + pass