|
| 1 | +# Copyright 2024 Google LLC All rights reserved. |
| 2 | +# |
| 3 | +# Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +# you may not use this file except in compliance with the License. |
| 5 | +# You may obtain a copy of the License at |
| 6 | +# |
| 7 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +# |
| 9 | +# Unless required by applicable law or agreed to in writing, software |
| 10 | +# distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +# See the License for the specific language governing permissions and |
| 13 | +# limitations under the License. |
| 14 | + |
| 15 | +from google.cloud.spanner_dbapi import Connection |
| 16 | +from google.cloud.spanner_v1 import ( |
| 17 | + BatchCreateSessionsRequest, |
| 18 | + ExecuteSqlRequest, |
| 19 | + BeginTransactionRequest, |
| 20 | + TypeCode, |
| 21 | + CommitRequest, |
| 22 | +) |
| 23 | +from tests.mockserver_tests.mock_server_test_base import ( |
| 24 | + MockServerTestBase, |
| 25 | + add_single_result, |
| 26 | +) |
| 27 | + |
| 28 | + |
| 29 | +class TestTags(MockServerTestBase): |
| 30 | + @classmethod |
| 31 | + def setup_class(cls): |
| 32 | + super().setup_class() |
| 33 | + add_single_result( |
| 34 | + "select name from singers", "name", TypeCode.STRING, [("Some Singer",)] |
| 35 | + ) |
| 36 | + |
| 37 | + def test_select_autocommit_no_tags(self): |
| 38 | + connection = Connection(self.instance, self.database) |
| 39 | + connection.autocommit = True |
| 40 | + request = self._execute_and_verify_select_singers(connection) |
| 41 | + self.assertEqual("", request.request_options.request_tag) |
| 42 | + self.assertEqual("", request.request_options.transaction_tag) |
| 43 | + |
| 44 | + def test_select_autocommit_with_request_tag(self): |
| 45 | + connection = Connection(self.instance, self.database) |
| 46 | + connection.autocommit = True |
| 47 | + request = self._execute_and_verify_select_singers( |
| 48 | + connection, request_tag="my_tag" |
| 49 | + ) |
| 50 | + self.assertEqual("my_tag", request.request_options.request_tag) |
| 51 | + self.assertEqual("", request.request_options.transaction_tag) |
| 52 | + |
| 53 | + def test_select_read_only_transaction_no_tags(self): |
| 54 | + connection = Connection(self.instance, self.database) |
| 55 | + connection.autocommit = False |
| 56 | + connection.read_only = True |
| 57 | + request = self._execute_and_verify_select_singers(connection) |
| 58 | + self.assertEqual("", request.request_options.request_tag) |
| 59 | + self.assertEqual("", request.request_options.transaction_tag) |
| 60 | + |
| 61 | + def test_select_read_only_transaction_with_request_tag(self): |
| 62 | + connection = Connection(self.instance, self.database) |
| 63 | + connection.autocommit = False |
| 64 | + connection.read_only = True |
| 65 | + request = self._execute_and_verify_select_singers( |
| 66 | + connection, request_tag="my_tag" |
| 67 | + ) |
| 68 | + self.assertEqual("my_tag", request.request_options.request_tag) |
| 69 | + self.assertEqual("", request.request_options.transaction_tag) |
| 70 | + |
| 71 | + def test_select_read_only_transaction_with_transaction_tag(self): |
| 72 | + connection = Connection(self.instance, self.database) |
| 73 | + connection.autocommit = False |
| 74 | + connection.read_only = True |
| 75 | + connection.transaction_tag = "my_transaction_tag" |
| 76 | + self._execute_and_verify_select_singers(connection) |
| 77 | + self._execute_and_verify_select_singers(connection) |
| 78 | + |
| 79 | + # Read-only transactions do not support tags, so the transaction_tag is |
| 80 | + # also not cleared from the connection when a read-only transaction is |
| 81 | + # executed. |
| 82 | + self.assertEqual("my_transaction_tag", connection.transaction_tag) |
| 83 | + |
| 84 | + # Read-only transactions do not need to be committed or rolled back on |
| 85 | + # Spanner, but dbapi requires this to end the transaction. |
| 86 | + connection.commit() |
| 87 | + requests = self.spanner_service.requests |
| 88 | + self.assertEqual(4, len(requests)) |
| 89 | + self.assertTrue(isinstance(requests[0], BatchCreateSessionsRequest)) |
| 90 | + self.assertTrue(isinstance(requests[1], BeginTransactionRequest)) |
| 91 | + self.assertTrue(isinstance(requests[2], ExecuteSqlRequest)) |
| 92 | + self.assertTrue(isinstance(requests[3], ExecuteSqlRequest)) |
| 93 | + # Transaction tags are not supported for read-only transactions. |
| 94 | + self.assertEqual("", requests[2].request_options.transaction_tag) |
| 95 | + self.assertEqual("", requests[3].request_options.transaction_tag) |
| 96 | + |
| 97 | + def test_select_read_write_transaction_no_tags(self): |
| 98 | + connection = Connection(self.instance, self.database) |
| 99 | + connection.autocommit = False |
| 100 | + request = self._execute_and_verify_select_singers(connection) |
| 101 | + self.assertEqual("", request.request_options.request_tag) |
| 102 | + self.assertEqual("", request.request_options.transaction_tag) |
| 103 | + |
| 104 | + def test_select_read_write_transaction_with_request_tag(self): |
| 105 | + connection = Connection(self.instance, self.database) |
| 106 | + connection.autocommit = False |
| 107 | + request = self._execute_and_verify_select_singers( |
| 108 | + connection, request_tag="my_tag" |
| 109 | + ) |
| 110 | + self.assertEqual("my_tag", request.request_options.request_tag) |
| 111 | + self.assertEqual("", request.request_options.transaction_tag) |
| 112 | + |
| 113 | + def test_select_read_write_transaction_with_transaction_tag(self): |
| 114 | + connection = Connection(self.instance, self.database) |
| 115 | + connection.autocommit = False |
| 116 | + connection.transaction_tag = "my_transaction_tag" |
| 117 | + # The transaction tag should be included for all statements in the transaction. |
| 118 | + self._execute_and_verify_select_singers(connection) |
| 119 | + self._execute_and_verify_select_singers(connection) |
| 120 | + |
| 121 | + # The transaction tag was cleared from the connection when the transaction |
| 122 | + # was started. |
| 123 | + self.assertIsNone(connection.transaction_tag) |
| 124 | + # The commit call should also include a transaction tag. |
| 125 | + connection.commit() |
| 126 | + requests = self.spanner_service.requests |
| 127 | + self.assertEqual(5, len(requests)) |
| 128 | + self.assertTrue(isinstance(requests[0], BatchCreateSessionsRequest)) |
| 129 | + self.assertTrue(isinstance(requests[1], BeginTransactionRequest)) |
| 130 | + self.assertTrue(isinstance(requests[2], ExecuteSqlRequest)) |
| 131 | + self.assertTrue(isinstance(requests[3], ExecuteSqlRequest)) |
| 132 | + self.assertTrue(isinstance(requests[4], CommitRequest)) |
| 133 | + self.assertEqual( |
| 134 | + "my_transaction_tag", requests[2].request_options.transaction_tag |
| 135 | + ) |
| 136 | + self.assertEqual( |
| 137 | + "my_transaction_tag", requests[3].request_options.transaction_tag |
| 138 | + ) |
| 139 | + self.assertEqual( |
| 140 | + "my_transaction_tag", requests[4].request_options.transaction_tag |
| 141 | + ) |
| 142 | + |
| 143 | + def test_select_read_write_transaction_with_transaction_and_request_tag(self): |
| 144 | + connection = Connection(self.instance, self.database) |
| 145 | + connection.autocommit = False |
| 146 | + connection.transaction_tag = "my_transaction_tag" |
| 147 | + # The transaction tag should be included for all statements in the transaction. |
| 148 | + self._execute_and_verify_select_singers(connection, request_tag="my_tag1") |
| 149 | + self._execute_and_verify_select_singers(connection, request_tag="my_tag2") |
| 150 | + |
| 151 | + # The transaction tag was cleared from the connection when the transaction |
| 152 | + # was started. |
| 153 | + self.assertIsNone(connection.transaction_tag) |
| 154 | + # The commit call should also include a transaction tag. |
| 155 | + connection.commit() |
| 156 | + requests = self.spanner_service.requests |
| 157 | + self.assertEqual(5, len(requests)) |
| 158 | + self.assertTrue(isinstance(requests[0], BatchCreateSessionsRequest)) |
| 159 | + self.assertTrue(isinstance(requests[1], BeginTransactionRequest)) |
| 160 | + self.assertTrue(isinstance(requests[2], ExecuteSqlRequest)) |
| 161 | + self.assertTrue(isinstance(requests[3], ExecuteSqlRequest)) |
| 162 | + self.assertTrue(isinstance(requests[4], CommitRequest)) |
| 163 | + self.assertEqual( |
| 164 | + "my_transaction_tag", requests[2].request_options.transaction_tag |
| 165 | + ) |
| 166 | + self.assertEqual("my_tag1", requests[2].request_options.request_tag) |
| 167 | + self.assertEqual( |
| 168 | + "my_transaction_tag", requests[3].request_options.transaction_tag |
| 169 | + ) |
| 170 | + self.assertEqual("my_tag2", requests[3].request_options.request_tag) |
| 171 | + self.assertEqual( |
| 172 | + "my_transaction_tag", requests[4].request_options.transaction_tag |
| 173 | + ) |
| 174 | + |
| 175 | + def test_request_tag_is_cleared(self): |
| 176 | + connection = Connection(self.instance, self.database) |
| 177 | + connection.autocommit = True |
| 178 | + with connection.cursor() as cursor: |
| 179 | + cursor.request_tag = "my_tag" |
| 180 | + cursor.execute("select name from singers") |
| 181 | + # This query will not have a request tag. |
| 182 | + cursor.execute("select name from singers") |
| 183 | + requests = self.spanner_service.requests |
| 184 | + self.assertTrue(isinstance(requests[1], ExecuteSqlRequest)) |
| 185 | + self.assertTrue(isinstance(requests[2], ExecuteSqlRequest)) |
| 186 | + self.assertEqual("my_tag", requests[1].request_options.request_tag) |
| 187 | + self.assertEqual("", requests[2].request_options.request_tag) |
| 188 | + |
| 189 | + def _execute_and_verify_select_singers( |
| 190 | + self, connection: Connection, request_tag: str = "", transaction_tag: str = "" |
| 191 | + ) -> ExecuteSqlRequest: |
| 192 | + with connection.cursor() as cursor: |
| 193 | + if request_tag: |
| 194 | + cursor.request_tag = request_tag |
| 195 | + cursor.execute("select name from singers") |
| 196 | + result_list = cursor.fetchall() |
| 197 | + for row in result_list: |
| 198 | + self.assertEqual("Some Singer", row[0]) |
| 199 | + self.assertEqual(1, len(result_list)) |
| 200 | + requests = self.spanner_service.requests |
| 201 | + return next( |
| 202 | + request |
| 203 | + for request in requests |
| 204 | + if isinstance(request, ExecuteSqlRequest) |
| 205 | + and request.sql == "select name from singers" |
| 206 | + ) |
0 commit comments