/
test_backup_api.py
468 lines (379 loc) · 14.9 KB
/
test_backup_api.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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# Copyright 2021 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 datetime
import time
import pytest
from google.api_core import exceptions
from google.cloud import spanner_v1
from . import _helpers
skip_env_reason = f"""\
Remove {_helpers.SKIP_BACKUP_TESTS_ENVVAR} from environment to run these tests.\
"""
skip_emulator_reason = "Backup operations not supported by emulator."
pytestmark = [
pytest.mark.skipif(_helpers.SKIP_BACKUP_TESTS, reason=skip_env_reason),
pytest.mark.skipif(_helpers.USE_EMULATOR, reason=skip_emulator_reason),
]
@pytest.fixture(scope="session")
def same_config_instance(spanner_client, shared_instance, instance_operation_timeout):
current_config = shared_instance.configuration_name
same_config_instance_id = _helpers.unique_id("same-config")
create_time = str(int(time.time()))
labels = {"python-spanner-systests": "true", "created": create_time}
same_config_instance = spanner_client.instance(
same_config_instance_id, current_config, labels=labels
)
op = same_config_instance.create()
op.result(instance_operation_timeout)
yield same_config_instance
_helpers.scrub_instance_ignore_not_found(same_config_instance)
@pytest.fixture(scope="session")
def diff_config(shared_instance, instance_configs):
current_config = shared_instance.configuration_name
for config in instance_configs:
if "-us-" in config.name and config.name != current_config:
return config.name
return None
@pytest.fixture(scope="session")
def diff_config_instance(
spanner_client, shared_instance, instance_operation_timeout, diff_config,
):
if diff_config is None:
return None
diff_config_instance_id = _helpers.unique_id("diff-config")
create_time = str(int(time.time()))
labels = {"python-spanner-systests": "true", "created": create_time}
diff_config_instance = spanner_client.instance(
diff_config_instance_id, diff_config, labels=labels
)
op = diff_config_instance.create()
op.result(instance_operation_timeout)
yield diff_config_instance
_helpers.scrub_instance_ignore_not_found(diff_config_instance)
@pytest.fixture(scope="session")
def database_version_time(shared_database):
shared_database.reload()
diff = (
datetime.datetime.now(datetime.timezone.utc)
- shared_database.earliest_version_time
)
return shared_database.earliest_version_time + diff / 2
@pytest.fixture(scope="session")
def second_database(shared_instance, database_operation_timeout):
database_name = _helpers.unique_id("test_database2")
pool = spanner_v1.BurstyPool(labels={"testcase": "database_api"})
database = shared_instance.database(
database_name, ddl_statements=_helpers.DDL_STATEMENTS, pool=pool
)
operation = database.create()
operation.result(database_operation_timeout) # raises on failure / timeout.
yield database
database.drop()
@pytest.fixture(scope="function")
def backups_to_delete():
to_delete = []
yield to_delete
for backup in to_delete:
_helpers.retry_429_503(backup.delete)()
def test_backup_workflow(
shared_instance,
shared_database,
database_version_time,
backups_to_delete,
databases_to_delete,
):
from google.cloud.spanner_admin_database_v1 import (
CreateBackupEncryptionConfig,
EncryptionConfig,
EncryptionInfo,
RestoreDatabaseEncryptionConfig,
)
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
encryption_enum = CreateBackupEncryptionConfig.EncryptionType
encryption_config = CreateBackupEncryptionConfig(
encryption_type=encryption_enum.GOOGLE_DEFAULT_ENCRYPTION,
)
# Create backup.
backup = shared_instance.backup(
backup_id,
database=shared_database,
expire_time=expire_time,
version_time=database_version_time,
encryption_config=encryption_config,
)
operation = backup.create()
backups_to_delete.append(backup)
# Check metadata.
metadata = operation.metadata
assert backup.name == metadata.name
assert shared_database.name == metadata.database
operation.result() # blocks indefinitely
# Check backup object.
backup.reload()
assert shared_database.name == backup._database
assert expire_time == backup.expire_time
assert backup.create_time is not None
assert database_version_time == backup.version_time
assert backup.size_bytes is not None
assert backup.state is not None
assert (
EncryptionInfo.Type.GOOGLE_DEFAULT_ENCRYPTION
== backup.encryption_info.encryption_type
)
# Update with valid argument.
valid_expire_time = datetime.datetime.now(
datetime.timezone.utc
) + datetime.timedelta(days=7)
backup.update_expire_time(valid_expire_time)
assert valid_expire_time == backup.expire_time
# Restore database to same instance.
restored_id = _helpers.unique_id("restored_db", separator="_")
encryption_config = RestoreDatabaseEncryptionConfig(
encryption_type=RestoreDatabaseEncryptionConfig.EncryptionType.GOOGLE_DEFAULT_ENCRYPTION,
)
database = shared_instance.database(
restored_id, encryption_config=encryption_config,
)
databases_to_delete.append(database)
operation = database.restore(source=backup)
restored_db = operation.result() # blocks indefinitely
assert database_version_time == restored_db.restore_info.backup_info.version_time
metadata = operation.metadata
assert database_version_time == metadata.backup_info.version_time
database.reload()
expected_encryption_config = EncryptionConfig()
assert expected_encryption_config == database.encryption_config
database.drop()
backup.delete()
assert not backup.exists()
def test_backup_create_w_version_time_dflt_to_create_time(
shared_instance, shared_database, backups_to_delete, databases_to_delete,
):
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
# Create backup.
backup = shared_instance.backup(
backup_id, database=shared_database, expire_time=expire_time,
)
operation = backup.create()
backups_to_delete.append(backup)
# Check metadata.
metadata = operation.metadata
assert backup.name == metadata.name
assert shared_database.name == metadata.database
operation.result() # blocks indefinitely
# Check backup object.
backup.reload()
assert shared_database.name == backup._database
assert backup.create_time is not None
assert backup.create_time == backup.version_time
backup.delete()
assert not backup.exists()
def test_backup_create_w_invalid_expire_time(shared_instance, shared_database):
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc)
backup = shared_instance.backup(
backup_id, database=shared_database, expire_time=expire_time
)
with pytest.raises(exceptions.InvalidArgument):
op = backup.create()
op.result() # blocks indefinitely
def test_backup_create_w_invalid_version_time_past(
shared_instance, shared_database,
):
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
version_time = datetime.datetime.now(datetime.timezone.utc) - datetime.timedelta(
days=10
)
backup = shared_instance.backup(
backup_id,
database=shared_database,
expire_time=expire_time,
version_time=version_time,
)
with pytest.raises(exceptions.InvalidArgument):
op = backup.create()
op.result() # blocks indefinitely
def test_backup_create_w_invalid_version_time_future(
shared_instance, shared_database,
):
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
version_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=2
)
backup = shared_instance.backup(
backup_id,
database=shared_database,
expire_time=expire_time,
version_time=version_time,
)
with pytest.raises(exceptions.InvalidArgument):
op = backup.create()
op.result() # blocks indefinitely
def test_database_restore_to_diff_instance(
shared_instance,
shared_database,
backups_to_delete,
same_config_instance,
databases_to_delete,
):
backup_id = _helpers.unique_id("backup_id", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
# Create backup.
backup = shared_instance.backup(
backup_id, database=shared_database, expire_time=expire_time,
)
op = backup.create()
backups_to_delete.append(backup)
op.result()
# Restore database to different instance with same config.
restored_id = _helpers.unique_id("restored_db")
database = same_config_instance.database(restored_id)
databases_to_delete.append(database)
operation = database.restore(source=backup)
operation.result() # blocks indefinitely
database.drop()
backup.delete()
assert not backup.exists()
def test_multi_create_cancel_update_error_restore_errors(
shared_instance,
shared_database,
second_database,
diff_config_instance,
backups_to_delete,
databases_to_delete,
):
backup_id_1 = _helpers.unique_id("backup_id1", separator="_")
backup_id_2 = _helpers.unique_id("backup_id2", separator="_")
expire_time = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=3
)
backup1 = shared_instance.backup(
backup_id_1, database=shared_database, expire_time=expire_time
)
backup2 = shared_instance.backup(
backup_id_2, database=second_database, expire_time=expire_time
)
# Create two backups.
op1 = backup1.create()
backups_to_delete.append(backup1)
op2 = backup2.create()
backups_to_delete.append(backup2)
backup1.reload()
assert not backup1.is_ready()
backup2.reload()
assert not backup2.is_ready()
# Cancel a create operation.
op2.cancel()
assert op2.cancelled()
op1.result() # blocks indefinitely
backup1.reload()
assert backup1.is_ready()
# Update expire time to invalid value.
max_expire_days = 366 # documented maximum
invalid_expire_time = datetime.datetime.now(
datetime.timezone.utc
) + datetime.timedelta(days=max_expire_days + 1)
with pytest.raises(exceptions.InvalidArgument):
backup1.update_expire_time(invalid_expire_time)
# Restore to existing database.
with pytest.raises(exceptions.AlreadyExists):
shared_database.restore(source=backup1)
# Restore to instance with different config.
if diff_config_instance is not None:
new_db = diff_config_instance.database("diff_config")
with pytest.raises(exceptions.InvalidArgument):
new_db.restore(source=backup1)
def test_instance_list_backups(
shared_instance, shared_database, second_database, backups_to_delete,
):
# Remove un-scrubbed backups FBO count below.
_helpers.scrub_instance_backups(shared_instance)
backup_id_1 = _helpers.unique_id("backup_id1", separator="_")
backup_id_2 = _helpers.unique_id("backup_id2", separator="_")
expire_time_1 = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=21
)
expire_time_1_stamp = expire_time_1.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
backup1 = shared_instance.backup(
backup_id_1, database=shared_database, expire_time=expire_time_1,
)
expire_time_2 = datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(
days=1
)
backup2 = shared_instance.backup(
backup_id_2, database=second_database, expire_time=expire_time_2
)
# Create two backups.
op1 = backup1.create()
backups_to_delete.append(backup1)
op1.result() # blocks indefinitely
backup1.reload()
create_time_compare = datetime.datetime.now(datetime.timezone.utc)
create_time_stamp = create_time_compare.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
backup2.create()
# This test doesn't block for the result of the 'backup2.create()' call
# because it wants to find `backup2` in the upcoming search for
# backups matching 'state;CREATING`: inherently racy, but probably
# safe, given how long it takes to create a backup (on the order of
# minutes, not seconds).
backups_to_delete.append(backup2)
# List backups filtered by state.
filter_ = "state:CREATING"
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup2.name
# List backups filtered by backup name.
filter_ = f"name:{backup_id_1}"
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup1.name
# List backups filtered by database name.
filter_ = f"database:{shared_database.name}"
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup1.name
# List backups filtered by create time.
filter_ = f'create_time > "{create_time_stamp}"'
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup2.name
# List backups filtered by version time.
filter_ = f'version_time > "{create_time_stamp}"'
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup2.name
# List backups filtered by expire time.
filter_ = f'expire_time > "{expire_time_1_stamp}"'
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup1.name
# List backups filtered by size bytes.
# XXX: this one may only pass if other tests have run first,
# munging 'shared_database' so that its backup will be bigger?
filter_ = f"size_bytes < {backup1.size_bytes}"
for backup in shared_instance.list_backups(filter_=filter_):
assert backup.name == backup2.name
# List backups using pagination.
count = 0
for page in shared_instance.list_backups(page_size=1):
count += 1
assert count == 2