From 5f8ed1f08cc12834d935da913aa26cdb99d2a694 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 22:16:09 +0000 Subject: [PATCH 1/3] feat(spanner): Add single-region CMEK database creation sample Regulated workloads protect Spanner databases at rest with a Cloud KMS CryptoKey passed via EncryptionConfig.kms_key_name. Add spanner_create_database_with_encryption_key. --- .../create_database_with_encryption_key.py | 115 +++++++++++++ ...reate_database_with_encryption_key_test.py | 155 ++++++++++++++++++ 2 files changed, 270 insertions(+) create mode 100644 spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py create mode 100644 spanner/database_admin/tests/create_database_with_encryption_key_test.py diff --git a/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py b/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py new file mode 100644 index 0000000000..55f746623d --- /dev/null +++ b/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py @@ -0,0 +1,115 @@ +# 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_encryption_key] +import sys + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 + + +def create_database_with_encryption_key( + project_id: str, instance_id: str, database_id: str, kms_key_name: str +) -> None: + """Creates a Spanner database protected by a single-region Cloud KMS key. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The new Spanner database 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) + encryption_config = spanner_admin_database_v1.EncryptionConfig( + kms_key_name=kms_key_name + ) + 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 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 CMEK database '{database_id}' on " + f"instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + configured_key_id = database.encryption_config.kms_key_name.split("/")[-1] + print(f"Resource ID: {database_id}") + print(f"Encryption Key ID: {configured_key_id}") + + +# [END spanner_create_database_with_encryption_key] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Create a Spanner database encrypted with Cloud KMS CMEK." + ) + 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-cmek-db"), + ) + 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_database_with_encryption_key( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + kms_key_name=args.kms_key_name, + ) diff --git a/spanner/database_admin/tests/create_database_with_encryption_key_test.py b/spanner/database_admin/tests/create_database_with_encryption_key_test.py new file mode 100644 index 0000000000..b3d3d2a03e --- /dev/null +++ b/spanner/database_admin/tests/create_database_with_encryption_key_test.py @@ -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_encryption_key + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-cmek-db" +KMS_KEY = f"projects/{PROJECT_ID}/locations/us-central1/keyRings/example-ring/cryptoKeys/example-key" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" + + +@mock.patch(ADMIN_CLIENT) +def test_create_database_with_encryption_key_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_name = KMS_KEY + mock_client_class.return_value.create_database.return_value.result.return_value = ( + db_pb + ) + + create_database_with_encryption_key.create_database_with_encryption_key( + PROJECT_ID, INSTANCE_ID, DATABASE_ID, KMS_KEY + ) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Encryption Key ID: example-key" 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-cmek-db' already exists", + ), + ( + exceptions.FailedPrecondition("kms"), + "error: failed to create CMEK database 'example-cmek-db'", + ), + ], +) +@mock.patch(ADMIN_CLIENT) +def test_create_database_with_encryption_key_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_encryption_key.create_database_with_encryption_key( + PROJECT_ID, INSTANCE_ID, DATABASE_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_database_with_encryption_key_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_name = KMS_KEY + mock_client_class.return_value.create_database.return_value.result.return_value = ( + db_pb + ) + monkeypatch.setattr( + "sys.argv", + [ + "create_database_with_encryption_key.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + "--kms-key-name", + KMS_KEY, + ], + ) + + runpy.run_module( + "spanner_database_admin.create_database_with_encryption_key", + run_name="__main__", + ) + + assert "Encryption Key ID: example-key" in capsys.readouterr().out + + +@conftest.live_only +def test_create_database_with_encryption_key_live( + capsys: pytest.CaptureFixture[str], +) -> None: + kms_key = os.environ["SPANNER_KMS_KEY_NAME"] + admin = spanner_admin_database_v1.DatabaseAdminClient() + temp_db_id = f"example-cmk-{uuid.uuid4().hex[:6]}" + db_path = admin.database_path( + conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id + ) + try: + create_database_with_encryption_key.create_database_with_encryption_key( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + temp_db_id, + kms_key, + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Encryption Key ID:" in out + finally: + try: + admin.drop_database(database=db_path) + except exceptions.NotFound: + pass From 81abf3307e513cbde2f46d45fadfa3bdcbd8a2e1 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:44:18 +0000 Subject: [PATCH 2/3] style(spanner): use triple-quoted SQL strings in create_database_with_encryption_key Problem: multi-line SQL and DDL statements were written as adjacent string fragments. That style is easy to get wrong (a missing trailing space joins two SQL tokens) and is harder to read than the statement itself, and the samples in this set mixed it with triple-quoted SQL. Solution: write each multi-line statement as a single triple-quoted string, matching the layout already used by the other samples. Only whitespace between SQL tokens changes; the statements are otherwise identical. Files updated: - spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py --- .../create_database_with_encryption_key.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py b/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py index 55f746623d..b749925074 100644 --- a/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py +++ b/spanner/database_admin/src/spanner_database_admin/create_database_with_encryption_key.py @@ -39,11 +39,13 @@ def create_database_with_encryption_key( 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)", + """ + CREATE TABLE Singers ( + SingerId INT64 NOT NULL, + FirstName STRING(1024), + LastName STRING(1024) + ) PRIMARY KEY (SingerId) + """, ], encryption_config=encryption_config, ) From c13def1d8eda67b70002cce14fd802e4aba81d7f Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 06:19:41 +0000 Subject: [PATCH 3/3] fix(spanner): address review feedback for create_database_with_encryption_key Problem: review of this sample identified correctness and robustness improvements in the sample and its tests. Solution: apply the accepted review suggestions and extend the tests to cover the updated behavior. Details are in the review thread replies. Files updated: - spanner/database_admin/tests/create_database_with_encryption_key_test.py --- .../tests/create_database_with_encryption_key_test.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spanner/database_admin/tests/create_database_with_encryption_key_test.py b/spanner/database_admin/tests/create_database_with_encryption_key_test.py index b3d3d2a03e..9ab41df656 100644 --- a/spanner/database_admin/tests/create_database_with_encryption_key_test.py +++ b/spanner/database_admin/tests/create_database_with_encryption_key_test.py @@ -131,6 +131,10 @@ def test_create_database_with_encryption_key_cli_entrypoint( def test_create_database_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() temp_db_id = f"example-cmk-{uuid.uuid4().hex[:6]}"