-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: create base class for mockserver tests (#1255)
* test: create base class for mockserver tests Move the boiler-plate code for mockserver tests to a separate class, so this can easily be re-used for other tests. * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
- Loading branch information
1 parent
758bf48
commit 96da8e1
Showing
2 changed files
with
147 additions
and
113 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| # Copyright 2024 Google LLC All rights reserved. | ||
| # | ||
| # 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 unittest | ||
|
|
||
| from google.cloud.spanner_dbapi.parsed_statement import AutocommitDmlMode | ||
| from google.cloud.spanner_v1.testing.mock_database_admin import DatabaseAdminServicer | ||
| from google.cloud.spanner_v1.testing.mock_spanner import ( | ||
| start_mock_server, | ||
| SpannerServicer, | ||
| ) | ||
| import google.cloud.spanner_v1.types.type as spanner_type | ||
| import google.cloud.spanner_v1.types.result_set as result_set | ||
| from google.api_core.client_options import ClientOptions | ||
| from google.auth.credentials import AnonymousCredentials | ||
| from google.cloud.spanner_v1 import Client, TypeCode, FixedSizePool | ||
| from google.cloud.spanner_v1.database import Database | ||
| from google.cloud.spanner_v1.instance import Instance | ||
| import grpc | ||
|
|
||
|
|
||
| def add_result(sql: str, result: result_set.ResultSet): | ||
| MockServerTestBase.spanner_service.mock_spanner.add_result(sql, result) | ||
|
|
||
|
|
||
| def add_update_count( | ||
| sql: str, count: int, dml_mode: AutocommitDmlMode = AutocommitDmlMode.TRANSACTIONAL | ||
| ): | ||
| if dml_mode == AutocommitDmlMode.PARTITIONED_NON_ATOMIC: | ||
| stats = dict(row_count_lower_bound=count) | ||
| else: | ||
| stats = dict(row_count_exact=count) | ||
| result = result_set.ResultSet(dict(stats=result_set.ResultSetStats(stats))) | ||
| add_result(sql, result) | ||
|
|
||
|
|
||
| def add_select1_result(): | ||
| add_single_result("select 1", "c", TypeCode.INT64, [("1",)]) | ||
|
|
||
|
|
||
| def add_single_result( | ||
| sql: str, column_name: str, type_code: spanner_type.TypeCode, row | ||
| ): | ||
| result = result_set.ResultSet( | ||
| dict( | ||
| metadata=result_set.ResultSetMetadata( | ||
| dict( | ||
| row_type=spanner_type.StructType( | ||
| dict( | ||
| fields=[ | ||
| spanner_type.StructType.Field( | ||
| dict( | ||
| name=column_name, | ||
| type=spanner_type.Type(dict(code=type_code)), | ||
| ) | ||
| ) | ||
| ] | ||
| ) | ||
| ) | ||
| ) | ||
| ), | ||
| ) | ||
| ) | ||
| result.rows.extend(row) | ||
| MockServerTestBase.spanner_service.mock_spanner.add_result(sql, result) | ||
|
|
||
|
|
||
| class MockServerTestBase(unittest.TestCase): | ||
| server: grpc.Server = None | ||
| spanner_service: SpannerServicer = None | ||
| database_admin_service: DatabaseAdminServicer = None | ||
| port: int = None | ||
|
|
||
| def __init__(self, *args, **kwargs): | ||
| super(MockServerTestBase, self).__init__(*args, **kwargs) | ||
| self._client = None | ||
| self._instance = None | ||
| self._database = None | ||
|
|
||
| @classmethod | ||
| def setup_class(cls): | ||
| ( | ||
| MockServerTestBase.server, | ||
| MockServerTestBase.spanner_service, | ||
| MockServerTestBase.database_admin_service, | ||
| MockServerTestBase.port, | ||
| ) = start_mock_server() | ||
|
|
||
| @classmethod | ||
| def teardown_class(cls): | ||
| if MockServerTestBase.server is not None: | ||
| MockServerTestBase.server.stop(grace=None) | ||
| MockServerTestBase.server = None | ||
|
|
||
| def setup_method(self, *args, **kwargs): | ||
| self._client = None | ||
| self._instance = None | ||
| self._database = None | ||
|
|
||
| def teardown_method(self, *args, **kwargs): | ||
| MockServerTestBase.spanner_service.clear_requests() | ||
| MockServerTestBase.database_admin_service.clear_requests() | ||
|
|
||
| @property | ||
| def client(self) -> Client: | ||
| if self._client is None: | ||
| self._client = Client( | ||
| project="p", | ||
| credentials=AnonymousCredentials(), | ||
| client_options=ClientOptions( | ||
| api_endpoint="localhost:" + str(MockServerTestBase.port), | ||
| ), | ||
| ) | ||
| return self._client | ||
|
|
||
| @property | ||
| def instance(self) -> Instance: | ||
| if self._instance is None: | ||
| self._instance = self.client.instance("test-instance") | ||
| return self._instance | ||
|
|
||
| @property | ||
| def database(self) -> Database: | ||
| if self._database is None: | ||
| self._database = self.instance.database( | ||
| "test-database", pool=FixedSizePool(size=10) | ||
| ) | ||
| return self._database |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters