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
135 changes: 135 additions & 0 deletions spanner/backups/src/spanner_backups/create_backup_with_mr_cmek.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# 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_create_backup_with_mr_cmek]
import datetime
import sys

from google.api_core import exceptions
from google.cloud import spanner_admin_database_v1


def create_backup_with_mr_cmek(
project_id: str,
instance_id: str,
database_id: str,
backup_id: str,
kms_key_names: list[str],
) -> None:
"""Creates a multi-region Spanner backup protected by regional KMS keys.

Args:
project_id: The Google Cloud project ID.
instance_id: The multi-region Spanner instance ID.
database_id: The source Spanner database ID.
backup_id: The new backup ID to create.
kms_key_names: Regional Cloud KMS CryptoKey resource paths.
"""
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path(project_id, instance_id)
database_path = client.database_path(project_id, instance_id, database_id)
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=7
)
enc_type = (
spanner_admin_database_v1.CreateBackupEncryptionConfig.EncryptionType.CUSTOMER_MANAGED_ENCRYPTION
)
encryption_config = spanner_admin_database_v1.CreateBackupEncryptionConfig(
encryption_type=enc_type,
kms_key_names=kms_key_names,
)
backup_pb = spanner_admin_database_v1.Backup(
database=database_path,
expire_time=expire_time,
)
request = spanner_admin_database_v1.CreateBackupRequest(
parent=parent,
backup_id=backup_id,
backup=backup_pb,
encryption_config=encryption_config,
)

try:
operation = client.create_backup(request=request)
print(f"Waiting for multi-region CMEK backup '{backup_id}' creation...")
backup = operation.result(timeout=2100)
except exceptions.AlreadyExists as err:
print(
f"error: backup '{backup_id}' already exists on instance "
f"'{instance_id}': {err.message}",
file=sys.stderr,
)
except TimeoutError as err:
print(
f"error: timed out waiting for the operation on backup '{backup_id}' "
f"to complete; the operation may still be running: {err}",
file=sys.stderr,
)
except exceptions.GoogleAPICallError as err:
print(
f"error: failed to create multi-region CMEK backup '{backup_id}' "
f"on instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
enc_count = len(backup.encryption_information)
print(f"Resource ID: {backup_id}")
print(f"Backup Size Bytes: {backup.size_bytes}")
print(f"Encryption Info Entries: {enc_count}")


# [END spanner_create_backup_with_mr_cmek]


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

parser = argparse.ArgumentParser(
description="Create a multi-region CMEK Spanner database backup."
)
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_MR_INSTANCE_ID", "example-mr-instance"),
)
parser.add_argument(
"--database-id",
default=os.environ.get("SPANNER_MR_DATABASE_ID", "example-mr-db"),
)
parser.add_argument(
"--backup-id",
default="example-mr-cmek-backup",
)
parser.add_argument(
"--kms-key-names",
default=os.environ.get(
"SPANNER_MR_KMS_KEY_NAMES",
"projects/example-project-id/locations/us-central1/keyRings/example-ring/cryptoKeys/example-key,"
"projects/example-project-id/locations/us-east1/keyRings/example-ring/cryptoKeys/example-key,"
"projects/example-project-id/locations/us-east4/keyRings/example-ring/cryptoKeys/example-key",
),
)
args = parser.parse_args()

create_backup_with_mr_cmek(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
backup_id=args.backup_id,
kms_key_names=[k.strip() for k in args.kms_key_names.split(",") if k.strip()],
)
155 changes: 155 additions & 0 deletions spanner/backups/tests/create_backup_with_mr_cmek_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
# 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 os
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_backup_with_mr_cmek

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-mr-instance"
DATABASE_ID = "example-mr-db"
BACKUP_ID = "example-mr-cmek-backup"
MR_KEYS = [
f"projects/{PROJECT_ID}/locations/{loc}/keyRings/example-ring/cryptoKeys/example-key"
for loc in ("us-central1", "us-east1", "us-east4")
]
ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient"


def _setup_admin(mock_client_class: mock.MagicMock) -> None:
client = mock_client_class.return_value
client.instance_path.return_value = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
client.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
bkp = mock.MagicMock(size_bytes=8192, encryption_information=[1, 2, 3])
client.create_backup.return_value.result.return_value = bkp


@mock.patch(ADMIN_CLIENT)
def test_create_backup_with_mr_cmek_success(
mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str]
) -> None:
_setup_admin(mock_client_class)

create_backup_with_mr_cmek.create_backup_with_mr_cmek(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, BACKUP_ID, MR_KEYS
)

out, err = capsys.readouterr()
assert f"Resource ID: {BACKUP_ID}" in out
assert "Encryption Info Entries: 3" in out
assert PROJECT_ID not in out
assert err == ""


@pytest.mark.parametrize(
"error, expected_prefix",
[
(TimeoutError("deadline"), "error: timed out waiting for the operation"),
(
exceptions.AlreadyExists("dup"),
"error: backup 'example-mr-cmek-backup' already exists",
),
(
exceptions.FailedPrecondition("kms"),
"error: failed to create multi-region CMEK backup",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_create_backup_with_mr_cmek_errors(
mock_client_class: mock.MagicMock,
capsys: pytest.CaptureFixture[str],
error: Exception,
expected_prefix: str,
) -> None:
_setup_admin(mock_client_class)
mock_client_class.return_value.create_backup.side_effect = error

create_backup_with_mr_cmek.create_backup_with_mr_cmek(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, BACKUP_ID, MR_KEYS
)

_out, err = capsys.readouterr()
assert err.startswith(expected_prefix)
assert PROJECT_ID not in err


@mock.patch(ADMIN_CLIENT)
def test_create_backup_with_mr_cmek_cli_entrypoint(
mock_client_class: mock.MagicMock,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
_setup_admin(mock_client_class)
monkeypatch.setattr(
"sys.argv",
[
"create_backup_with_mr_cmek.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
"--backup-id",
BACKUP_ID,
"--kms-key-names",
",".join(MR_KEYS),
],
)

runpy.run_module("spanner_backups.create_backup_with_mr_cmek", run_name="__main__")

assert "Encryption Info Entries: 3" in capsys.readouterr().out


@conftest.live_only
def test_create_backup_with_mr_cmek_live(capsys: pytest.CaptureFixture[str]) -> None:
required = (
"SPANNER_MR_INSTANCE_ID",
"SPANNER_MR_DATABASE_ID",
"SPANNER_MR_KMS_KEY_NAMES",
)
missing = [name for name in required if not os.environ.get(name)]
if missing:
pytest.skip(f"Set {', '.join(missing)} to run this live test.")
mr_inst = os.environ["SPANNER_MR_INSTANCE_ID"]
mr_db = os.environ["SPANNER_MR_DATABASE_ID"]
mr_keys = [k for k in os.environ["SPANNER_MR_KMS_KEY_NAMES"].split(",") if k]
admin = spanner_admin_database_v1.DatabaseAdminClient()
bkp_id = f"example-mrb-{uuid.uuid4().hex[:6]}"
bkp_path = admin.backup_path(conftest.LIVE_PROJECT_ID, mr_inst, bkp_id)
try:
create_backup_with_mr_cmek.create_backup_with_mr_cmek(
conftest.LIVE_PROJECT_ID, mr_inst, mr_db, bkp_id, mr_keys
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert "Encryption Info Entries:" in out
finally:
try:
admin.delete_backup(name=bkp_path)
except exceptions.NotFound:
pass