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,122 @@
# 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_database_with_mr_cmek]
import sys

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


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

Args:
project_id: The Google Cloud project ID.
instance_id: The multi-region Spanner instance ID.
database_id: The new Spanner database 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)
encryption_config = spanner_admin_database_v1.EncryptionConfig(
kms_key_names=kms_key_names
)
request = spanner_admin_database_v1.CreateDatabaseRequest(
parent=parent,
create_statement=f"CREATE DATABASE `{database_id}`",
extra_statements=[
"""
CREATE TABLE Singers (
SingerId INT64 NOT NULL,
FirstName STRING(1024),
LastName STRING(1024)
) PRIMARY KEY (SingerId)
""",
],
encryption_config=encryption_config,
)

try:
operation = client.create_database(request=request)
print(f"Waiting for multi-region CMEK database '{database_id}' creation...")
database = operation.result(timeout=300)
except exceptions.AlreadyExists as err:
print(
f"error: database '{database_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 database '{database_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 database '{database_id}' "
f"on instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
key_count = len(database.encryption_config.kms_key_names)
print(f"Resource ID: {database_id}")
print(f"Configured KMS Keys: {key_count}")


# [END spanner_create_database_with_mr_cmek]


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

parser = argparse.ArgumentParser(
description="Create a multi-region Spanner database with regional KMS keys."
)
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_DATABASE_ID", "example-mr-cmek-db"),
)
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_database_with_mr_cmek(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
kms_key_names=[k.strip() for k in args.kms_key_names.split(",") if k.strip()],
)
155 changes: 155 additions & 0 deletions spanner/database_admin/tests/create_database_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_database_admin import create_database_with_mr_cmek

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-mr-instance"
DATABASE_ID = "example-mr-cmek-db"
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"


@mock.patch(ADMIN_CLIENT)
def test_create_database_with_mr_cmek_success(
mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str]
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
db_pb = mock.MagicMock()
db_pb.encryption_config.kms_key_names = MR_KEYS
mock_client_class.return_value.create_database.return_value.result.return_value = (
db_pb
)

create_database_with_mr_cmek.create_database_with_mr_cmek(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, MR_KEYS
)

out, err = capsys.readouterr()
assert f"Resource ID: {DATABASE_ID}" in out
assert "Configured KMS Keys: 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: database 'example-mr-cmek-db' already exists",
),
(
exceptions.FailedPrecondition("kms"),
"error: failed to create multi-region CMEK database",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_create_database_with_mr_cmek_errors(
mock_client_class: mock.MagicMock,
capsys: pytest.CaptureFixture[str],
error: Exception,
expected_prefix: str,
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
mock_client_class.return_value.create_database.side_effect = error

create_database_with_mr_cmek.create_database_with_mr_cmek(
PROJECT_ID, INSTANCE_ID, DATABASE_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_database_with_mr_cmek_cli_entrypoint(
mock_client_class: mock.MagicMock,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
db_pb = mock.MagicMock()
db_pb.encryption_config.kms_key_names = MR_KEYS
mock_client_class.return_value.create_database.return_value.result.return_value = (
db_pb
)
monkeypatch.setattr(
"sys.argv",
[
"create_database_with_mr_cmek.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
"--kms-key-names",
",".join(MR_KEYS),
],
)

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

assert "Configured KMS Keys: 3" in capsys.readouterr().out


@conftest.live_only
def test_create_database_with_mr_cmek_live(capsys: pytest.CaptureFixture[str]) -> None:
required = ("SPANNER_MR_INSTANCE_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_instance = os.environ["SPANNER_MR_INSTANCE_ID"]
mr_keys = [k for k in os.environ["SPANNER_MR_KMS_KEY_NAMES"].split(",") if k]
Comment on lines +138 to +139

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

If SPANNER_MR_INSTANCE_ID or SPANNER_MR_KMS_KEY_NAMES are not set in the environment, this test will fail with a KeyError. Since these are not checked in conftest.py, it is safer to retrieve them using os.environ.get() and skip the test if they are missing.

    mr_instance = os.environ.get("SPANNER_MR_INSTANCE_ID")
    mr_keys_raw = os.environ.get("SPANNER_MR_KMS_KEY_NAMES")
    if not mr_instance or not mr_keys_raw:
        pytest.skip(
            "SPANNER_MR_INSTANCE_ID and SPANNER_MR_KMS_KEY_NAMES environment "
            "variables are required for this test."
        )
    mr_keys = [k for k in mr_keys_raw.split(",") if k]

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.

Good catch, done: the live test now checks for its required environment variables up front and skips with a clear message when one is missing, instead of failing with a KeyError (c4de0f2).

admin = spanner_admin_database_v1.DatabaseAdminClient()
temp_db_id = f"example-mrc-{uuid.uuid4().hex[:6]}"
db_path = admin.database_path(conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id)
try:
create_database_with_mr_cmek.create_database_with_mr_cmek(
conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id, mr_keys
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert f"Configured KMS Keys: {len(mr_keys)}" in out
finally:
try:
admin.drop_database(database=db_path)
except exceptions.NotFound:
pass