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,133 @@
# 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_encryption_key]
import datetime
import sys

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


def create_backup_with_encryption_key(
project_id: str,
instance_id: str,
database_id: str,
backup_id: str,
kms_key_name: str,
) -> None:
"""Creates a Spanner database backup protected by a Cloud KMS CMEK key.

Args:
project_id: The Google Cloud project ID.
instance_id: The Spanner instance ID.
database_id: The source Spanner database ID.
backup_id: The new backup ID to create.
kms_key_name: The Cloud KMS CryptoKey resource path.
"""
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_name=kms_key_name,
)
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 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 CMEK backup '{backup_id}' on instance "
f"'{instance_id}': {err.message}",
file=sys.stderr,
)
else:
enc_state = backup.encryption_info.encryption_type.name
print(f"Resource ID: {backup_id}")
print(f"Backup Size Bytes: {backup.size_bytes}")
print(f"Encryption Type: {enc_state}")


# [END spanner_create_backup_with_encryption_key]


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

parser = argparse.ArgumentParser(
description="Create a CMEK-encrypted 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_INSTANCE_ID", "example-instance"),
)
parser.add_argument(
"--database-id",
default=os.environ.get("SPANNER_DATABASE_ID", "example-db"),
)
parser.add_argument(
"--backup-id",
default="example-cmek-backup",
)
parser.add_argument(
"--kms-key-name",
default=os.environ.get(
"SPANNER_KMS_KEY_NAME",
"projects/example-project-id/locations/us-central1/keyRings/example-ring/cryptoKeys/example-key",
),
)
args = parser.parse_args()

create_backup_with_encryption_key(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
backup_id=args.backup_id,
kms_key_name=args.kms_key_name,
)
158 changes: 158 additions & 0 deletions spanner/backups/tests/create_backup_with_encryption_key_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# 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_encryption_key

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-instance"
DATABASE_ID = "example-db"
BACKUP_ID = "example-cmek-backup"
KMS_KEY = f"projects/{PROJECT_ID}/locations/us-central1/keyRings/example-ring/cryptoKeys/example-key"
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)
bkp.encryption_info.encryption_type.name = "CUSTOMER_MANAGED_ENCRYPTION"
client.create_backup.return_value.result.return_value = bkp


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

create_backup_with_encryption_key.create_backup_with_encryption_key(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, BACKUP_ID, KMS_KEY
)

out, err = capsys.readouterr()
assert f"Resource ID: {BACKUP_ID}" in out
assert "Backup Size Bytes: 8192" in out
assert "Encryption Type: CUSTOMER_MANAGED_ENCRYPTION" 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-cmek-backup' already exists",
),
(
exceptions.FailedPrecondition("kms"),
"error: failed to create CMEK backup 'example-cmek-backup'",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_create_backup_with_encryption_key_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_encryption_key.create_backup_with_encryption_key(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, BACKUP_ID, KMS_KEY
)

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


@mock.patch(ADMIN_CLIENT)
def test_create_backup_with_encryption_key_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_encryption_key.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
"--backup-id",
BACKUP_ID,
"--kms-key-name",
KMS_KEY,
],
)

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

assert "Encryption Type: CUSTOMER_MANAGED_ENCRYPTION" in capsys.readouterr().out


@conftest.live_only
def test_create_backup_with_encryption_key_live(
capsys: pytest.CaptureFixture[str],
) -> None:
required = ("SPANNER_KMS_KEY_NAME",)
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.")
kms_key = os.environ["SPANNER_KMS_KEY_NAME"]
admin = spanner_admin_database_v1.DatabaseAdminClient()
bkp_id = f"example-cbk-{uuid.uuid4().hex[:6]}"
bkp_path = admin.backup_path(
conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, bkp_id
)
try:
create_backup_with_encryption_key.create_backup_with_encryption_key(
conftest.LIVE_PROJECT_ID,
conftest.LIVE_INSTANCE_ID,
conftest.LIVE_DATABASE_ID,
bkp_id,
kms_key,
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert "Encryption Type: CUSTOMER_MANAGED_ENCRYPTION" in out
finally:
try:
admin.delete_backup(name=bkp_path)
except exceptions.NotFound:
pass