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,125 @@
# 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_default_leader]
import sys

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


def create_database_with_default_leader(
project_id: str, instance_id: str, database_id: str, default_leader: str
) -> None:
"""Creates a Spanner database configured with an explicit default_leader.

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.
default_leader: The leader region (for example, 'us-east4').
"""
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path(project_id, instance_id)
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),
SingerInfo BYTES(MAX)
) PRIMARY KEY (SingerId)
""",
"""
CREATE TABLE Albums (
SingerId INT64 NOT NULL,
AlbumId INT64 NOT NULL,
AlbumTitle STRING(MAX)
) PRIMARY KEY (SingerId, AlbumId),
INTERLEAVE IN PARENT Singers ON DELETE CASCADE
""",
f"""
ALTER DATABASE `{database_id}`
SET OPTIONS (default_leader = '{default_leader}')
""",
],
)

try:
operation = client.create_database(request=request)
print(
f"Waiting for database '{database_id}' creation with leader "
f"'{default_leader}'..."
)
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 database '{database_id}' with default "
f"leader '{default_leader}' on instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
print(f"Resource ID: {database_id}")
print(f"Default Leader: {database.default_leader}")


# [END spanner_create_database_with_default_leader]


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

parser = argparse.ArgumentParser(
description="Create a Spanner database with an explicit default_leader."
)
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-db"),
)
parser.add_argument(
"--default-leader",
default=os.environ.get("SPANNER_DEFAULT_LEADER", "us-east4"),
)
args = parser.parse_args()

create_database_with_default_leader(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
default_leader=args.default_leader,
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# 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_default_leader

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-mr-instance"
DATABASE_ID = "example-db"
DEFAULT_LEADER = "us-east4"
ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient"


@mock.patch(ADMIN_CLIENT)
def test_create_database_with_default_leader_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(default_leader=DEFAULT_LEADER)
mock_client_class.return_value.create_database.return_value.result.return_value = (
db_pb
)

create_database_with_default_leader.create_database_with_default_leader(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, DEFAULT_LEADER
)

out, err = capsys.readouterr()
assert f"Resource ID: {DATABASE_ID}" in out
assert f"Default Leader: {DEFAULT_LEADER}" 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-db' already exists",
),
(
exceptions.InvalidArgument("bad leader"),
"error: failed to create database 'example-db' with default leader",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_create_database_with_default_leader_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_default_leader.create_database_with_default_leader(
PROJECT_ID, INSTANCE_ID, DATABASE_ID, DEFAULT_LEADER
)

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


@mock.patch(ADMIN_CLIENT)
def test_create_database_with_default_leader_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(default_leader=DEFAULT_LEADER)
mock_client_class.return_value.create_database.return_value.result.return_value = (
db_pb
)
monkeypatch.setattr(
"sys.argv",
[
"create_database_with_default_leader.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
"--default-leader",
DEFAULT_LEADER,
],
)

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

assert f"Default Leader: {DEFAULT_LEADER}" in capsys.readouterr().out


@conftest.live_only
def test_create_database_with_default_leader_live(
capsys: pytest.CaptureFixture[str],
) -> None:
required = ("SPANNER_MR_INSTANCE_ID",)
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"]

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

Accessing os.environ["SPANNER_MR_INSTANCE_ID"] directly will raise a KeyError if the environment variable is not set, which can crash the test suite ungracefully. Since this environment variable is not validated in conftest.py, we should safely retrieve it and skip the test if it is missing.

Suggested change
mr_instance = os.environ["SPANNER_MR_INSTANCE_ID"]
mr_instance = os.environ.get("SPANNER_MR_INSTANCE_ID")
if not mr_instance:
pytest.skip("SPANNER_MR_INSTANCE_ID environment variable not set")

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 (eb1a8fa).

admin = spanner_admin_database_v1.DatabaseAdminClient()
temp_db_id = f"example-ldr-{uuid.uuid4().hex[:6]}"
db_path = admin.database_path(conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id)
try:
create_database_with_default_leader.create_database_with_default_leader(
conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id, "us-east4"
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert "Default Leader: us-east4" in out
finally:
try:
admin.drop_database(database=db_path)
except exceptions.NotFound:
pass