File size: 46,975 Bytes
065fee7 |
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 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 |
# Copyright 2015 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 copy
import http
import unittest
from unittest import mock
from google.api_core import exceptions
import google.api_core.retry
from google.api_core.future import polling
import pytest
from google.cloud.bigquery.retry import DEFAULT_GET_JOB_TIMEOUT
from ..helpers import make_connection
from .helpers import _make_client
from .helpers import _make_retriable_exception
from .helpers import _make_job_resource
class Test__error_result_to_exception(unittest.TestCase):
def _call_fut(self, *args, **kwargs):
from google.cloud.bigquery import job
return job._error_result_to_exception(*args, **kwargs)
def test_simple(self):
error_result = {"reason": "invalid", "message": "bad request"}
exception = self._call_fut(error_result)
self.assertEqual(exception.code, http.client.BAD_REQUEST)
self.assertTrue(exception.message.startswith("bad request"))
self.assertIn(error_result, exception.errors)
def test_missing_reason(self):
error_result = {}
exception = self._call_fut(error_result)
self.assertEqual(exception.code, http.client.INTERNAL_SERVER_ERROR)
def test_contatenate_errors(self):
# Added test for b/310544564 and b/318889899.
# Ensures that error messages from both error_result and errors are
# present in the exception raised.
error_result = {
"reason": "invalid1",
"message": "error message 1",
}
errors = [
{"reason": "invalid2", "message": "error message 2"},
{"reason": "invalid3", "message": "error message 3"},
]
exception = self._call_fut(error_result, errors)
self.assertEqual(
exception.message,
"error message 1; reason: invalid2, message: error message 2; "
"reason: invalid3, message: error message 3",
)
class Test_JobReference(unittest.TestCase):
JOB_ID = "job-id"
PROJECT = "test-project-123"
LOCATION = "us-central"
@staticmethod
def _get_target_class():
from google.cloud.bigquery import job
return job._JobReference
def _make_one(self, job_id, project, location):
return self._get_target_class()(job_id, project, location)
def test_ctor(self):
job_ref = self._make_one(self.JOB_ID, self.PROJECT, self.LOCATION)
self.assertEqual(job_ref.job_id, self.JOB_ID)
self.assertEqual(job_ref.project, self.PROJECT)
self.assertEqual(job_ref.location, self.LOCATION)
def test__to_api_repr(self):
job_ref = self._make_one(self.JOB_ID, self.PROJECT, self.LOCATION)
self.assertEqual(
job_ref._to_api_repr(),
{
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": self.LOCATION,
},
)
def test_from_api_repr(self):
api_repr = {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": self.LOCATION,
}
job_ref = self._get_target_class()._from_api_repr(api_repr)
self.assertEqual(job_ref.job_id, self.JOB_ID)
self.assertEqual(job_ref.project, self.PROJECT)
self.assertEqual(job_ref.location, self.LOCATION)
class Test_AsyncJob(unittest.TestCase):
JOB_ID = "job-id"
PROJECT = "test-project-123"
LOCATION = "us-central"
@staticmethod
def _get_target_class():
from google.cloud.bigquery import job
return job._AsyncJob
def _make_one(self, job_id, client):
return self._get_target_class()(job_id, client)
def _make_derived_class(self):
class Derived(self._get_target_class()):
_JOB_TYPE = "derived"
return Derived
def _make_derived(self, job_id, client):
return self._make_derived_class()(job_id, client)
@staticmethod
def _job_reference(job_id, project, location):
from google.cloud.bigquery import job
return job._JobReference(job_id, project, location)
def test_ctor_w_bare_job_id(self):
import threading
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertEqual(job.job_id, self.JOB_ID)
self.assertEqual(job.project, self.PROJECT)
self.assertIsNone(job.location)
self.assertIs(job._client, client)
self.assertEqual(
job._properties,
{"jobReference": {"projectId": self.PROJECT, "jobId": self.JOB_ID}},
)
self.assertIsInstance(job._completion_lock, type(threading.Lock()))
self.assertEqual(
job.path, "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID)
)
def test_ctor_w_job_ref(self):
import threading
other_project = "other-project-234"
client = _make_client(project=other_project)
job_ref = self._job_reference(self.JOB_ID, self.PROJECT, self.LOCATION)
job = self._make_one(job_ref, client)
self.assertEqual(job.job_id, self.JOB_ID)
self.assertEqual(job.project, self.PROJECT)
self.assertEqual(job.location, self.LOCATION)
self.assertIs(job._client, client)
self.assertEqual(
job._properties,
{
"jobReference": {
"projectId": self.PROJECT,
"location": self.LOCATION,
"jobId": self.JOB_ID,
}
},
)
self.assertFalse(job._result_set)
self.assertIsInstance(job._completion_lock, type(threading.Lock()))
self.assertEqual(
job.path, "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID)
)
def test__require_client_w_none(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIs(job._require_client(None), client)
def test__require_client_w_other(self):
client = _make_client(project=self.PROJECT)
other = object()
job = self._make_one(self.JOB_ID, client)
self.assertIs(job._require_client(other), other)
def test_job_type(self):
client = _make_client(project=self.PROJECT)
derived = self._make_derived(self.JOB_ID, client)
self.assertEqual(derived.job_type, "derived")
def test_parent_job_id(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.parent_job_id)
job._properties["statistics"] = {"parentJobId": "parent-job-123"}
self.assertEqual(job.parent_job_id, "parent-job-123")
def test_script_statistics(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.script_statistics)
job._properties["statistics"] = {
"scriptStatistics": {
"evaluationKind": "EXPRESSION",
"stackFrames": [
{
"startLine": 5,
"startColumn": 29,
"endLine": 9,
"endColumn": 14,
"text": "QUERY TEXT",
}
],
}
}
script_stats = job.script_statistics
self.assertEqual(script_stats.evaluation_kind, "EXPRESSION")
stack_frames = script_stats.stack_frames
self.assertEqual(len(stack_frames), 1)
stack_frame = stack_frames[0]
self.assertIsNone(stack_frame.procedure_id)
self.assertEqual(stack_frame.start_line, 5)
self.assertEqual(stack_frame.start_column, 29)
self.assertEqual(stack_frame.end_line, 9)
self.assertEqual(stack_frame.end_column, 14)
self.assertEqual(stack_frame.text, "QUERY TEXT")
def test_session_info(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.session_info)
job._properties["statistics"] = {"sessionInfo": {"sessionId": "abcdefg"}}
self.assertIsNotNone(job.session_info)
self.assertEqual(job.session_info.session_id, "abcdefg")
def test_transaction_info(self):
from google.cloud.bigquery.job.base import TransactionInfo
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
assert job.transaction_info is None
statistics = job._properties["statistics"] = {}
assert job.transaction_info is None
statistics["transactionInfo"] = {"transactionId": "123-abc-xyz"}
assert isinstance(job.transaction_info, TransactionInfo)
assert job.transaction_info.transaction_id == "123-abc-xyz"
def test_num_child_jobs(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertEqual(job.num_child_jobs, 0)
job._properties["statistics"] = {"numChildJobs": "17"}
self.assertEqual(job.num_child_jobs, 17)
def test_labels_miss(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertEqual(job.labels, {})
def test_labels_update_in_place(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
labels = job.labels
labels["foo"] = "bar" # update in place
self.assertEqual(job.labels, {"foo": "bar"})
def test_labels_hit(self):
labels = {"foo": "bar"}
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties.setdefault("configuration", {})["labels"] = labels
self.assertEqual(job.labels, labels)
def test_etag(self):
etag = "ETAG-123"
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.etag)
job._properties["etag"] = etag
self.assertEqual(job.etag, etag)
def test_self_link(self):
self_link = "https://api.example.com/123"
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.self_link)
job._properties["selfLink"] = self_link
self.assertEqual(job.self_link, self_link)
def test_user_email(self):
user_email = "user@example.com"
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.user_email)
job._properties["user_email"] = user_email
self.assertEqual(job.user_email, user_email)
@staticmethod
def _datetime_and_millis():
import datetime
from google.cloud._helpers import _millis
now = datetime.datetime.utcnow().replace(
microsecond=123000,
tzinfo=datetime.timezone.utc, # stats timestamps have ms precision
)
return now, _millis(now)
def test_created(self):
now, millis = self._datetime_and_millis()
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.created)
stats = job._properties["statistics"] = {}
self.assertIsNone(job.created)
stats["creationTime"] = millis
self.assertEqual(job.created, now)
def test_started(self):
now, millis = self._datetime_and_millis()
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.started)
stats = job._properties["statistics"] = {}
self.assertIsNone(job.started)
stats["startTime"] = millis
self.assertEqual(job.started, now)
def test_ended(self):
now, millis = self._datetime_and_millis()
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.ended)
stats = job._properties["statistics"] = {}
self.assertIsNone(job.ended)
stats["endTime"] = millis
self.assertEqual(job.ended, now)
def test_reservation_usage_no_stats(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["statistics"] = {}
self.assertEqual(job.reservation_usage, [])
def test_reservation_usage_stats_exist(self):
from google.cloud.bigquery.job import ReservationUsage
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["statistics"] = {
"reservationUsage": [
{"name": "slot_foo", "slotMs": "42"},
{"name": "slot_bar", "slotMs": "123"},
],
}
expected = [
ReservationUsage(name="slot_foo", slot_ms=42),
ReservationUsage(name="slot_bar", slot_ms=123),
]
self.assertEqual(job.reservation_usage, expected)
def test__job_statistics(self):
statistics = {"foo": "bar"}
client = _make_client(project=self.PROJECT)
derived = self._make_derived(self.JOB_ID, client)
self.assertEqual(derived._job_statistics(), {})
stats = derived._properties["statistics"] = {}
self.assertEqual(derived._job_statistics(), {})
stats["derived"] = statistics
self.assertEqual(derived._job_statistics(), statistics)
def test_error_result(self):
error_result = {
"debugInfo": "DEBUG INFO",
"location": "LOCATION",
"message": "MESSAGE",
"reason": "REASON",
}
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.error_result)
status = job._properties["status"] = {}
self.assertIsNone(job.error_result)
status["errorResult"] = error_result
self.assertEqual(job.error_result, error_result)
def test_errors(self):
errors = [
{
"debugInfo": "DEBUG INFO",
"location": "LOCATION",
"message": "MESSAGE",
"reason": "REASON",
}
]
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.errors)
status = job._properties["status"] = {}
self.assertIsNone(job.errors)
status["errors"] = errors
self.assertEqual(job.errors, errors)
def test_state(self):
state = "STATE"
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertIsNone(job.state)
status = job._properties["status"] = {}
self.assertIsNone(job.state)
status["state"] = state
self.assertEqual(job.state, state)
def _set_properties_job(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._set_future_result = mock.Mock()
job._properties = {
"jobReference": job._properties["jobReference"],
"foo": "bar",
}
return job
def test__set_properties_no_stats(self):
config = {"test": True}
resource = {"configuration": config}
expected = resource.copy()
expected["statistics"] = {}
job = self._set_properties_job()
original_resource = job._properties
job._set_properties(resource)
self.assertEqual(job._properties, expected)
# Make sure we don't mutate the object used in the request, as that
# makes debugging more difficult and leads to false positives in unit
# tests.
self.assertIsNot(job._properties, original_resource)
def test__set_properties_w_creation_time(self):
now, millis = self._datetime_and_millis()
config = {"test": True}
stats = {"creationTime": str(millis)}
resource = {"configuration": config, "statistics": stats}
job = self._set_properties_job()
job._set_properties(resource)
cleaned = copy.deepcopy(resource)
cleaned["statistics"]["creationTime"] = float(millis)
self.assertEqual(job._properties, cleaned)
def test__set_properties_w_start_time(self):
now, millis = self._datetime_and_millis()
config = {"test": True}
stats = {"startTime": str(millis)}
resource = {"configuration": config, "statistics": stats}
job = self._set_properties_job()
job._set_properties(resource)
cleaned = copy.deepcopy(resource)
cleaned["statistics"]["startTime"] = float(millis)
self.assertEqual(job._properties, cleaned)
def test__set_properties_w_end_time(self):
now, millis = self._datetime_and_millis()
config = {"test": True}
stats = {"endTime": str(millis)}
resource = {"configuration": config, "statistics": stats}
job = self._set_properties_job()
job._set_properties(resource)
cleaned = copy.deepcopy(resource)
cleaned["statistics"]["endTime"] = float(millis)
self.assertEqual(job._properties, cleaned)
def test__check_resource_config_missing_job_ref(self):
resource = {}
klass = self._make_derived_class()
with self.assertRaises(KeyError):
klass._check_resource_config(resource)
def test__check_resource_config_missing_job_id(self):
resource = {"jobReference": {}}
klass = self._make_derived_class()
with self.assertRaises(KeyError):
klass._check_resource_config(resource)
def test__check_resource_config_missing_configuration(self):
resource = {"jobReference": {"jobId": self.JOB_ID}}
klass = self._make_derived_class()
with self.assertRaises(KeyError):
klass._check_resource_config(resource)
def test__check_resource_config_missing_config_type(self):
resource = {"jobReference": {"jobId": self.JOB_ID}, "configuration": {}}
klass = self._make_derived_class()
with self.assertRaises(KeyError):
klass._check_resource_config(resource)
def test__check_resource_config_ok(self):
derived_config = {"foo": "bar"}
resource = {
"jobReference": {"jobId": self.JOB_ID},
"configuration": {"derived": derived_config},
}
klass = self._make_derived_class()
# Should not throw.
klass._check_resource_config(resource)
def test__build_resource(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
resource = job._build_resource()
assert resource["jobReference"]["jobId"] == self.JOB_ID
def test_to_api_repr(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
resource = job.to_api_repr()
assert resource["jobReference"]["jobId"] == self.JOB_ID
def test__begin_already(self):
job = self._set_properties_job()
job._properties["status"] = {"state": "WHATEVER"}
with self.assertRaises(ValueError):
job._begin()
def test__begin_defaults(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
job = self._set_properties_job()
builder = job.to_api_repr = mock.Mock()
builder.return_value = resource
call_api = job._client._call_api = mock.Mock()
call_api.return_value = resource
path = "/projects/{}/jobs".format(self.PROJECT)
job._begin()
call_api.assert_called_once_with(
DEFAULT_RETRY,
span_name="BigQuery.job.begin",
span_attributes={"path": path},
job_ref=job,
method="POST",
path=path,
data=resource,
timeout=None,
)
self.assertEqual(job._properties, expected)
def test__begin_explicit(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
other_project = "other-project-234"
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
job = self._set_properties_job()
builder = job.to_api_repr = mock.Mock()
builder.return_value = resource
client = _make_client(project=other_project)
call_api = client._call_api = mock.Mock()
call_api.return_value = resource
retry = DEFAULT_RETRY.with_deadline(1)
path = "/projects/{}/jobs".format(self.PROJECT)
job._begin(client=client, retry=retry, timeout=7.5)
call_api.assert_called_once_with(
retry,
span_name="BigQuery.job.begin",
span_attributes={"path": path},
job_ref=job,
method="POST",
path=path,
data=resource,
timeout=7.5,
)
self.assertEqual(job._properties, expected)
def test_exists_defaults_miss(self):
from google.cloud.exceptions import NotFound
from google.cloud.bigquery.retry import DEFAULT_RETRY
job = self._set_properties_job()
job._properties["jobReference"]["location"] = self.LOCATION
call_api = job._client._call_api = mock.Mock()
call_api.side_effect = NotFound("testing")
self.assertFalse(job.exists())
call_api.assert_called_once_with(
DEFAULT_RETRY,
span_name="BigQuery.job.exists",
span_attributes={
"path": "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID)
},
job_ref=job,
method="GET",
path="/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
query_params={"fields": "id", "location": self.LOCATION},
timeout=None,
)
def test_exists_explicit_hit(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
other_project = "other-project-234"
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
job = self._set_properties_job()
client = _make_client(project=other_project)
call_api = client._call_api = mock.Mock()
call_api.return_value = resource
retry = DEFAULT_RETRY.with_deadline(1)
self.assertTrue(job.exists(client=client, retry=retry))
call_api.assert_called_once_with(
retry,
span_name="BigQuery.job.exists",
span_attributes={
"path": "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID)
},
job_ref=job,
method="GET",
path="/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
query_params={"fields": "id"},
timeout=None,
)
def test_exists_w_timeout(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
PATH = "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID)
job = self._set_properties_job()
call_api = job._client._call_api = mock.Mock()
job.exists(timeout=7.5)
call_api.assert_called_once_with(
DEFAULT_RETRY,
span_name="BigQuery.job.exists",
span_attributes={"path": PATH},
job_ref=job,
method="GET",
path=PATH,
query_params={"fields": "id"},
timeout=7.5,
)
def test_reload_defaults(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY, DEFAULT_GET_JOB_TIMEOUT
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
job = self._set_properties_job()
job._properties["jobReference"]["location"] = self.LOCATION
call_api = job._client._call_api = mock.Mock()
call_api.return_value = resource
job.reload()
call_api.assert_called_once_with(
DEFAULT_RETRY,
span_name="BigQuery.getJob",
span_attributes={
"path": "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
"job_id": "job-id",
"location": "us-central",
},
method="GET",
path="/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
query_params={
"projection": "full",
"location": "us-central",
},
timeout=DEFAULT_GET_JOB_TIMEOUT,
)
self.assertEqual(job._properties, expected)
def test_reload_explicit(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
other_project = "other-project-234"
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
job = self._set_properties_job()
client = _make_client(project=other_project)
call_api = client._call_api = mock.Mock()
call_api.return_value = resource
retry = DEFAULT_RETRY.with_deadline(1)
job.reload(client=client, retry=retry, timeout=4.2)
call_api.assert_called_once_with(
retry,
span_name="BigQuery.getJob",
span_attributes={
"path": "/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
"job_id": "job-id",
"location": None,
},
method="GET",
path="/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
query_params={"projection": "full"},
timeout=4.2,
)
self.assertEqual(job._properties, expected)
def test_reload_none_timeout(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
client = _make_client(project=self.PROJECT)
conn = client._connection = make_connection(resource)
job = self._set_properties_job()
retry = DEFAULT_RETRY.with_deadline(1)
job.reload(client=client, retry=retry, timeout=None)
conn.api_request.assert_called_once_with(
method="GET",
path="/projects/{}/jobs/{}".format(self.PROJECT, self.JOB_ID),
query_params={"projection": "full"},
timeout=None,
)
def test_cancel_defaults(self):
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
response = {"job": resource}
job = self._set_properties_job()
job._properties["jobReference"]["location"] = self.LOCATION
connection = job._client._connection = make_connection(response)
with mock.patch(
"google.cloud.bigquery.opentelemetry_tracing._get_final_span_attributes"
) as final_attributes:
self.assertTrue(job.cancel())
final_attributes.assert_called()
connection.api_request.assert_called_once_with(
method="POST",
path="/projects/{}/jobs/{}/cancel".format(self.PROJECT, self.JOB_ID),
query_params={"location": self.LOCATION},
timeout=None,
)
self.assertEqual(job._properties, expected)
def test_cancel_explicit(self):
other_project = "other-project-234"
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
response = {"job": resource}
job = self._set_properties_job()
client = _make_client(project=other_project)
connection = client._connection = make_connection(response)
with mock.patch(
"google.cloud.bigquery.opentelemetry_tracing._get_final_span_attributes"
) as final_attributes:
self.assertTrue(job.cancel(client=client, timeout=7.5))
final_attributes.assert_called_with(
{"path": "/projects/{}/jobs/{}/cancel".format(self.PROJECT, self.JOB_ID)},
client,
job,
)
connection.api_request.assert_called_once_with(
method="POST",
path="/projects/{}/jobs/{}/cancel".format(self.PROJECT, self.JOB_ID),
query_params={},
timeout=7.5,
)
self.assertEqual(job._properties, expected)
def test_cancel_w_custom_retry(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
api_path = "/projects/{}/jobs/{}/cancel".format(self.PROJECT, self.JOB_ID)
resource = {
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": None,
},
"configuration": {"test": True},
}
expected = resource.copy()
expected["statistics"] = {}
response = {"job": resource}
job = self._set_properties_job()
api_request_patcher = mock.patch.object(
job._client._connection, "api_request", side_effect=[ValueError, response]
)
retry = DEFAULT_RETRY.with_deadline(1).with_predicate(
lambda exc: isinstance(exc, ValueError)
)
with api_request_patcher as fake_api_request:
with mock.patch(
"google.cloud.bigquery.opentelemetry_tracing._get_final_span_attributes"
) as final_attributes:
result = job.cancel(retry=retry, timeout=7.5)
final_attributes.assert_called()
self.assertTrue(result)
self.assertEqual(job._properties, expected)
self.assertEqual(
fake_api_request.call_args_list,
[
mock.call(method="POST", path=api_path, query_params={}, timeout=7.5),
mock.call(
method="POST", path=api_path, query_params={}, timeout=7.5
), # was retried once
],
)
def test__set_future_result_wo_done(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
set_exception = job.set_exception = mock.Mock()
set_result = job.set_result = mock.Mock()
job._set_future_result()
set_exception.assert_not_called()
set_result.assert_not_called()
def test__set_future_result_w_result_set(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {"state": "DONE"}
job._result_set = True
set_exception = job.set_exception = mock.Mock()
set_result = job.set_result = mock.Mock()
job._set_future_result()
set_exception.assert_not_called()
set_result.assert_not_called()
def test__set_future_result_w_done_wo_result_set_w_error(self):
from google.cloud.exceptions import NotFound
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {
"state": "DONE",
"errorResult": {"reason": "notFound", "message": "testing"},
}
set_exception = job.set_exception = mock.Mock()
set_result = job.set_result = mock.Mock()
job._set_future_result()
set_exception.assert_called_once()
args, kw = set_exception.call_args
(exception,) = args
self.assertIsInstance(exception, NotFound)
self.assertEqual(exception.message, "testing")
self.assertEqual(kw, {})
set_result.assert_not_called()
def test__set_future_result_w_done_wo_result_set_wo_error(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {"state": "DONE"}
set_exception = job.set_exception = mock.Mock()
set_result = job.set_result = mock.Mock()
job._set_future_result()
set_exception.assert_not_called()
set_result.assert_called_once_with(job)
def test_done_defaults_wo_state(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
reload_ = job.reload = mock.Mock()
self.assertFalse(job.done())
reload_.assert_called_once_with(
retry=DEFAULT_RETRY,
timeout=DEFAULT_GET_JOB_TIMEOUT,
)
def test_done_explicit_wo_state(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
reload_ = job.reload = mock.Mock()
retry = DEFAULT_RETRY.with_deadline(1)
self.assertFalse(job.done(retry=retry, timeout=7.5))
reload_.assert_called_once_with(retry=retry, timeout=7.5)
def test_done_with_none_timeout(self):
from google.cloud.bigquery.retry import DEFAULT_RETRY
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
reload_ = job.reload = mock.Mock()
retry = DEFAULT_RETRY.with_deadline(1)
self.assertFalse(job.done(retry=retry, timeout=None))
reload_.assert_called_once_with(retry=retry, timeout=None)
def test_done_already(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {"state": "DONE"}
self.assertTrue(job.done())
def test_result_default_wo_state(self):
from google.cloud.bigquery.retry import DEFAULT_GET_JOB_TIMEOUT
begun_job_resource = _make_job_resource(
job_id=self.JOB_ID, project_id=self.PROJECT, location="US", started=True
)
done_job_resource = _make_job_resource(
job_id=self.JOB_ID,
project_id=self.PROJECT,
location="US",
started=True,
ended=True,
)
conn = make_connection(
_make_retriable_exception(),
begun_job_resource,
done_job_resource,
)
client = _make_client(project=self.PROJECT, connection=conn)
job = self._make_one(self.JOB_ID, client)
self.assertIs(job.result(retry=polling.DEFAULT_RETRY), job)
begin_call = mock.call(
method="POST",
path=f"/projects/{self.PROJECT}/jobs",
data={"jobReference": {"jobId": self.JOB_ID, "projectId": self.PROJECT}},
timeout=None,
)
reload_call = mock.call(
method="GET",
path=f"/projects/{self.PROJECT}/jobs/{self.JOB_ID}",
query_params={
"projection": "full",
"location": "US",
},
timeout=DEFAULT_GET_JOB_TIMEOUT,
)
conn.api_request.assert_has_calls([begin_call, begin_call, reload_call])
def test_result_w_retry_wo_state(self):
from google.cloud.bigquery.retry import DEFAULT_GET_JOB_TIMEOUT
begun_job_resource = _make_job_resource(
job_id=self.JOB_ID, project_id=self.PROJECT, location="EU", started=True
)
done_job_resource = _make_job_resource(
job_id=self.JOB_ID,
project_id=self.PROJECT,
location="EU",
started=True,
ended=True,
)
conn = make_connection(
exceptions.NotFound("not normally retriable"),
begun_job_resource,
exceptions.NotFound("not normally retriable"),
done_job_resource,
)
client = _make_client(project=self.PROJECT, connection=conn)
job = self._make_one(
self._job_reference(self.JOB_ID, self.PROJECT, "EU"), client
)
custom_predicate = mock.Mock()
custom_predicate.return_value = True
custom_retry = google.api_core.retry.Retry(
predicate=custom_predicate,
initial=0.001,
maximum=0.001,
deadline=0.1,
)
self.assertIs(job.result(retry=custom_retry), job)
begin_call = mock.call(
method="POST",
path=f"/projects/{self.PROJECT}/jobs",
data={
"jobReference": {
"jobId": self.JOB_ID,
"projectId": self.PROJECT,
"location": "EU",
}
},
timeout=None,
)
reload_call = mock.call(
method="GET",
path=f"/projects/{self.PROJECT}/jobs/{self.JOB_ID}",
query_params={
"projection": "full",
"location": "EU",
},
timeout=DEFAULT_GET_JOB_TIMEOUT,
)
conn.api_request.assert_has_calls(
[begin_call, begin_call, reload_call, reload_call]
)
def test_result_explicit_w_state(self):
conn = make_connection()
client = _make_client(project=self.PROJECT, connection=conn)
job = self._make_one(self.JOB_ID, client)
# Use _set_properties() instead of directly modifying _properties so
# that the result state is set properly.
job_resource = job._properties
job_resource["status"] = {"state": "DONE"}
job._set_properties(job_resource)
timeout = 1
self.assertIs(job.result(timeout=timeout), job)
conn.api_request.assert_not_called()
def test_cancelled_wo_error_result(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
self.assertFalse(job.cancelled())
def test_cancelled_w_error_result_not_stopped(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {"errorResult": {"reason": "other"}}
self.assertFalse(job.cancelled())
def test_cancelled_w_error_result_w_stopped(self):
client = _make_client(project=self.PROJECT)
job = self._make_one(self.JOB_ID, client)
job._properties["status"] = {"errorResult": {"reason": "stopped"}}
self.assertTrue(job.cancelled())
def test_repr(self):
client = _make_client(project="project-foo")
job = self._make_one("job-99", client)
job._properties.setdefault("jobReference", {})["location"] = "ABC"
assert repr(job) == "_AsyncJob<project=project-foo, location=ABC, id=job-99>"
class Test_JobConfig(unittest.TestCase):
JOB_TYPE = "testing"
@staticmethod
def _get_target_class():
from google.cloud.bigquery import job
return job._JobConfig
def _make_one(self, job_type=JOB_TYPE):
return self._get_target_class()(job_type)
def test_ctor(self):
job_config = self._make_one()
self.assertEqual(job_config._job_type, self.JOB_TYPE)
self.assertEqual(job_config._properties, {self.JOB_TYPE: {}})
def test_ctor_with_unknown_property_raises_error(self):
error_text = "Property wrong_name is unknown for"
with pytest.raises(AttributeError, match=error_text):
config = self._make_one()
config.wrong_name = None
def test_fill_query_job_config_from_default(self):
from google.cloud.bigquery import QueryJobConfig
job_config = QueryJobConfig()
job_config.dry_run = True
job_config.maximum_bytes_billed = 1000
default_job_config = QueryJobConfig()
default_job_config.use_query_cache = True
default_job_config.maximum_bytes_billed = 2000
final_job_config = job_config._fill_from_default(default_job_config)
self.assertTrue(final_job_config.dry_run)
self.assertTrue(final_job_config.use_query_cache)
self.assertEqual(final_job_config.maximum_bytes_billed, 1000)
def test_fill_load_job_from_default(self):
from google.cloud.bigquery import LoadJobConfig
job_config = LoadJobConfig()
job_config.create_session = True
job_config.encoding = "UTF-8"
default_job_config = LoadJobConfig()
default_job_config.ignore_unknown_values = True
default_job_config.encoding = "ISO-8859-1"
final_job_config = job_config._fill_from_default(default_job_config)
self.assertTrue(final_job_config.create_session)
self.assertTrue(final_job_config.ignore_unknown_values)
self.assertEqual(final_job_config.encoding, "UTF-8")
def test_fill_from_default_conflict(self):
from google.cloud.bigquery import QueryJobConfig
basic_job_config = QueryJobConfig()
conflicting_job_config = self._make_one("conflicting_job_type")
self.assertNotEqual(
basic_job_config._job_type, conflicting_job_config._job_type
)
with self.assertRaises(TypeError):
basic_job_config._fill_from_default(conflicting_job_config)
def test_fill_from_empty_default_conflict(self):
from google.cloud.bigquery import QueryJobConfig
job_config = QueryJobConfig()
job_config.dry_run = True
job_config.maximum_bytes_billed = 1000
final_job_config = job_config._fill_from_default(default_job_config=None)
self.assertTrue(final_job_config.dry_run)
self.assertEqual(final_job_config.maximum_bytes_billed, 1000)
@mock.patch("google.cloud.bigquery._helpers._get_sub_prop")
def test__get_sub_prop_wo_default(self, _get_sub_prop):
job_config = self._make_one()
key = "key"
self.assertIs(job_config._get_sub_prop(key), _get_sub_prop.return_value)
_get_sub_prop.assert_called_once_with(
job_config._properties, [self.JOB_TYPE, key], default=None
)
@mock.patch("google.cloud.bigquery._helpers._get_sub_prop")
def test__get_sub_prop_w_default(self, _get_sub_prop):
job_config = self._make_one()
key = "key"
default = "default"
self.assertIs(
job_config._get_sub_prop(key, default=default), _get_sub_prop.return_value
)
_get_sub_prop.assert_called_once_with(
job_config._properties, [self.JOB_TYPE, key], default=default
)
@mock.patch("google.cloud.bigquery._helpers._set_sub_prop")
def test__set_sub_prop(self, _set_sub_prop):
job_config = self._make_one()
key = "key"
value = "value"
job_config._set_sub_prop(key, value)
_set_sub_prop.assert_called_once_with(
job_config._properties, [self.JOB_TYPE, key], value
)
def test_to_api_repr(self):
job_config = self._make_one()
expected = job_config._properties = {self.JOB_TYPE: {"foo": "bar"}}
found = job_config.to_api_repr()
self.assertEqual(found, expected)
self.assertIsNot(found, expected) # copied
# 'from_api_repr' cannot be tested on '_JobConfig', because it presumes
# the ctor can be called w/o arguments
def test_labels_miss(self):
job_config = self._make_one()
self.assertEqual(job_config.labels, {})
def test_labels_update_in_place(self):
job_config = self._make_one()
labels = job_config.labels
labels["foo"] = "bar" # update in place
self.assertEqual(job_config.labels, {"foo": "bar"})
def test_labels_hit(self):
labels = {"foo": "bar"}
job_config = self._make_one()
job_config._properties["labels"] = labels
self.assertEqual(job_config.labels, labels)
def test_labels_setter_invalid(self):
labels = object()
job_config = self._make_one()
with self.assertRaises(ValueError):
job_config.labels = labels
def test_labels_setter(self):
labels = {"foo": "bar"}
job_config = self._make_one()
job_config.labels = labels
self.assertEqual(job_config._properties["labels"], labels)
def test_job_timeout_ms_raises_valueerror(self):
# Confirm that attempting to set a non-integer values will raise an Error.
with pytest.raises(ValueError):
job_config = self._make_one()
job_config.job_timeout_ms = "WillRaiseError"
def test_job_timeout_ms(self):
# Confirm that default status is None.
job_config = self._make_one()
assert job_config.job_timeout_ms is None
# Confirm that integers get converted to strings.
job_config.job_timeout_ms = 5000
assert job_config.job_timeout_ms == "5000" # int is converted to string
|