-
Notifications
You must be signed in to change notification settings - Fork 298
/
test_dbapi_connection.py
222 lines (174 loc) · 8.02 KB
/
test_dbapi_connection.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# Copyright 2017 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 gc
import unittest
import mock
try:
from google.cloud import bigquery_storage
except ImportError: # pragma: NO COVER
bigquery_storage = None
class TestConnection(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.bigquery.dbapi import Connection
return Connection
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
def _mock_client(self):
from google.cloud.bigquery import client
mock_client = mock.create_autospec(client.Client)
return mock_client
def _mock_bqstorage_client(self):
# Assumption: bigquery_storage exists. It's the test's responisbility to
# not use this helper or skip itself if bqstroage is not installed.
mock_client = mock.create_autospec(bigquery_storage.BigQueryReadClient)
mock_client._transport = mock.Mock(spec=["channel"])
mock_client._transport.grpc_channel = mock.Mock(spec=["close"])
return mock_client
def test_ctor_wo_bqstorage_client(self):
from google.cloud.bigquery.dbapi import Connection
mock_client = self._mock_client()
mock_client._create_bqstorage_client.return_value = None
connection = self._make_one(client=mock_client)
self.assertIsInstance(connection, Connection)
self.assertIs(connection._client, mock_client)
self.assertIs(connection._bqstorage_client, None)
@unittest.skipIf(
bigquery_storage is None, "Requires `google-cloud-bigquery-storage`"
)
def test_ctor_w_bqstorage_client(self):
from google.cloud.bigquery.dbapi import Connection
mock_client = self._mock_client()
mock_bqstorage_client = self._mock_bqstorage_client()
connection = self._make_one(
client=mock_client, bqstorage_client=mock_bqstorage_client,
)
self.assertIsInstance(connection, Connection)
self.assertIs(connection._client, mock_client)
self.assertIs(connection._bqstorage_client, mock_bqstorage_client)
@mock.patch("google.cloud.bigquery.Client", autospec=True)
def test_connect_wo_client(self, mock_client):
from google.cloud.bigquery.dbapi import connect
from google.cloud.bigquery.dbapi import Connection
connection = connect()
self.assertIsInstance(connection, Connection)
self.assertIsNotNone(connection._client)
self.assertIsNotNone(connection._bqstorage_client)
@unittest.skipIf(
bigquery_storage is None, "Requires `google-cloud-bigquery-storage`"
)
def test_connect_w_client(self):
from google.cloud.bigquery.dbapi import connect
from google.cloud.bigquery.dbapi import Connection
mock_client = self._mock_client()
mock_bqstorage_client = self._mock_bqstorage_client()
mock_client._create_bqstorage_client.return_value = mock_bqstorage_client
connection = connect(client=mock_client)
self.assertIsInstance(connection, Connection)
self.assertIs(connection._client, mock_client)
self.assertIs(connection._bqstorage_client, mock_bqstorage_client)
@unittest.skipIf(
bigquery_storage is None, "Requires `google-cloud-bigquery-storage`"
)
def test_connect_w_both_clients(self):
from google.cloud.bigquery.dbapi import connect
from google.cloud.bigquery.dbapi import Connection
mock_client = self._mock_client()
mock_bqstorage_client = self._mock_bqstorage_client()
connection = connect(
client=mock_client, bqstorage_client=mock_bqstorage_client,
)
self.assertIsInstance(connection, Connection)
self.assertIs(connection._client, mock_client)
self.assertIs(connection._bqstorage_client, mock_bqstorage_client)
def test_raises_error_if_closed(self):
from google.cloud.bigquery.dbapi.exceptions import ProgrammingError
connection = self._make_one(client=self._mock_client())
connection.close()
for method in ("close", "commit", "cursor"):
with self.assertRaisesRegex(
ProgrammingError, r"Operating on a closed connection\."
):
getattr(connection, method)()
@unittest.skipIf(
bigquery_storage is None, "Requires `google-cloud-bigquery-storage`"
)
def test_close_closes_all_created_bigquery_clients(self):
client = self._mock_client()
bqstorage_client = self._mock_bqstorage_client()
client_patcher = mock.patch(
"google.cloud.bigquery.dbapi.connection.bigquery.Client",
return_value=client,
)
bqstorage_client_patcher = mock.patch.object(
client, "_create_bqstorage_client", return_value=bqstorage_client,
)
with client_patcher, bqstorage_client_patcher:
connection = self._make_one(client=None, bqstorage_client=None)
connection.close()
self.assertTrue(client.close.called)
self.assertTrue(bqstorage_client._transport.grpc_channel.close.called)
@unittest.skipIf(
bigquery_storage is None, "Requires `google-cloud-bigquery-storage`"
)
def test_close_does_not_close_bigquery_clients_passed_to_it(self):
client = self._mock_client()
bqstorage_client = self._mock_bqstorage_client()
connection = self._make_one(client=client, bqstorage_client=bqstorage_client)
connection.close()
self.assertFalse(client.close.called)
self.assertFalse(bqstorage_client._transport.grpc_channel.close.called)
def test_close_closes_all_created_cursors(self):
connection = self._make_one(client=self._mock_client())
cursor_1 = connection.cursor()
cursor_2 = connection.cursor()
self.assertFalse(cursor_1._closed)
self.assertFalse(cursor_2._closed)
connection.close()
self.assertTrue(cursor_1._closed)
self.assertTrue(cursor_2._closed)
def test_close_closes_only_open_created_cursors(self):
connection = self._make_one(client=self._mock_client())
cursor_1 = connection.cursor()
cursor_2 = connection.cursor()
self.assertFalse(cursor_1._closed)
self.assertFalse(cursor_2._closed)
cursor_1.close()
self.assertTrue(cursor_1._closed)
cursor_1.close = mock.MagicMock()
connection.close()
self.assertFalse(cursor_1.close.called)
self.assertTrue(cursor_2._closed)
def test_does_not_keep_cursor_instances_alive(self):
from google.cloud.bigquery.dbapi import Cursor
connection = self._make_one(client=self._mock_client())
cursor_1 = connection.cursor() # noqa
cursor_2 = connection.cursor()
cursor_3 = connection.cursor() # noqa
del cursor_2
# Connections should not hold strong references to the Cursor instances
# they created, unnecessarily keeping them alive.
gc.collect()
cursors = [obj for obj in gc.get_objects() if isinstance(obj, Cursor)]
self.assertEqual(len(cursors), 2)
def test_commit(self):
connection = self._make_one(client=self._mock_client())
# commit() is a no-op, there is nothing to test.
connection.commit()
def test_cursor(self):
from google.cloud.bigquery.dbapi import Cursor
connection = self._make_one(client=self._mock_client())
cursor = connection.cursor()
self.assertIsInstance(cursor, Cursor)
self.assertIs(cursor.connection, connection)