File size: 43,218 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 |
# 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 unittest
from unittest import mock
from google.cloud.bigquery.routine.routine import Routine, RoutineReference
import pytest
from google.cloud.bigquery.dataset import (
AccessEntry,
Dataset,
DatasetReference,
Table,
TableReference,
)
class TestAccessEntry(unittest.TestCase):
@staticmethod
def _get_target_class():
return AccessEntry
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
def test_ctor_defaults(self):
entry = self._make_one("OWNER", "userByEmail", "phred@example.com")
self.assertEqual(entry.role, "OWNER")
self.assertEqual(entry.entity_type, "userByEmail")
self.assertEqual(entry.entity_id, "phred@example.com")
def test_ctor_view_success(self):
role = None
entity_type = "view"
entity_id = object()
entry = self._make_one(role, entity_type, entity_id)
self.assertEqual(entry.role, role)
self.assertEqual(entry.entity_type, entity_type)
self.assertEqual(entry.entity_id, entity_id)
def test_ctor_routine_success(self):
role = None
entity_type = "routine"
entity_id = object()
entry = self._make_one(role, entity_type, entity_id)
self.assertEqual(entry.role, role)
self.assertEqual(entry.entity_type, entity_type)
self.assertEqual(entry.entity_id, entity_id)
def test___eq___role_mismatch(self):
entry = self._make_one("OWNER", "userByEmail", "phred@example.com")
other = self._make_one("WRITER", "userByEmail", "phred@example.com")
self.assertNotEqual(entry, other)
def test___eq___entity_type_mismatch(self):
entry = self._make_one("OWNER", "userByEmail", "phred@example.com")
other = self._make_one("OWNER", "groupByEmail", "phred@example.com")
self.assertNotEqual(entry, other)
def test___eq___entity_id_mismatch(self):
entry = self._make_one("OWNER", "userByEmail", "phred@example.com")
other = self._make_one("OWNER", "userByEmail", "bharney@example.com")
self.assertNotEqual(entry, other)
def test___eq___hit(self):
entry = self._make_one("OWNER", "userByEmail", "phred@example.com")
other = self._make_one("OWNER", "userByEmail", "phred@example.com")
self.assertEqual(entry, other)
def test__eq___type_mismatch(self):
entry = self._make_one("OWNER", "userByEmail", "silly@example.com")
self.assertNotEqual(entry, object())
self.assertEqual(entry, mock.ANY)
def test___hash__set_equality(self):
entry1 = self._make_one("OWNER", "userByEmail", "silly@example.com")
entry2 = self._make_one("OWNER", "userByEmail", "phred@example.com")
set_one = {entry1, entry2}
set_two = {entry1, entry2}
self.assertEqual(set_one, set_two)
def test___hash__not_equals(self):
entry1 = self._make_one("OWNER", "userByEmail", "silly@example.com")
entry2 = self._make_one("OWNER", "userByEmail", "phred@example.com")
set_one = {entry1}
set_two = {entry2}
self.assertNotEqual(set_one, set_two)
def test_to_api_repr(self):
entry = self._make_one("OWNER", "userByEmail", "salmon@example.com")
resource = entry.to_api_repr()
exp_resource = {"role": "OWNER", "userByEmail": "salmon@example.com"}
self.assertEqual(resource, exp_resource)
def test_to_api_repr_view(self):
view = {
"projectId": "my-project",
"datasetId": "my_dataset",
"tableId": "my_table",
}
entry = self._make_one(None, "view", view)
resource = entry.to_api_repr()
exp_resource = {"view": view, "role": None}
self.assertEqual(resource, exp_resource)
def test_to_api_repr_routine(self):
routine = {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
entry = self._make_one(None, "routine", routine)
resource = entry.to_api_repr()
exp_resource = {"routine": routine, "role": None}
self.assertEqual(resource, exp_resource)
def test_to_api_repr_dataset(self):
dataset = {
"dataset": {"projectId": "my-project", "datasetId": "my_dataset"},
"target_types": "VIEWS",
}
entry = self._make_one(None, "dataset", dataset)
resource = entry.to_api_repr()
exp_resource = {"dataset": dataset, "role": None}
self.assertEqual(resource, exp_resource)
def test_from_api_repr(self):
resource = {"role": "OWNER", "userByEmail": "salmon@example.com"}
entry = self._get_target_class().from_api_repr(resource)
self.assertEqual(entry.role, "OWNER")
self.assertEqual(entry.entity_type, "userByEmail")
self.assertEqual(entry.entity_id, "salmon@example.com")
def test_from_api_repr_w_unknown_entity_type(self):
resource = {"role": "READER", "unknown": "UNKNOWN"}
entry = self._get_target_class().from_api_repr(resource)
self.assertEqual(entry.role, "READER")
self.assertEqual(entry.entity_type, "unknown")
self.assertEqual(entry.entity_id, "UNKNOWN")
exp_resource = entry.to_api_repr()
self.assertEqual(resource, exp_resource)
def test_from_api_repr_wo_role(self):
resource = {
"view": {
"projectId": "my-project",
"datasetId": "my_dataset",
"tableId": "my_table",
}
}
entry = self._get_target_class().from_api_repr(resource)
exp_entry = self._make_one(
role=None,
entity_type="view",
entity_id=resource["view"],
)
self.assertEqual(entry, exp_entry)
def test_to_api_repr_w_extra_properties(self):
resource = {
"role": "READER",
"userByEmail": "salmon@example.com",
}
entry = self._get_target_class().from_api_repr(resource)
entry._properties["specialGroup"] = resource["specialGroup"] = "projectReaders"
exp_resource = entry.to_api_repr()
self.assertEqual(resource, exp_resource)
def test_from_api_repr_entries_w_extra_keys(self):
resource = {
"role": "READER",
"specialGroup": "projectReaders",
"userByEmail": "salmon@example.com",
}
with self.assertRaises(ValueError):
self._get_target_class().from_api_repr(resource)
def test_view_getter_setter(self):
view = {
"projectId": "my_project",
"datasetId": "my_dataset",
"tableId": "my_table",
}
view_ref = TableReference.from_api_repr(view)
entry = self._make_one(None)
entry.view = view
resource = entry.to_api_repr()
exp_resource = {"view": view, "role": None}
self.assertEqual(entry.view, view_ref)
self.assertEqual(resource, exp_resource)
def test_view_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.view, None)
def test_view_getter_setter_string(self):
project = "my_project"
dataset = "my_dataset"
table = "my_table"
view = {
"projectId": project,
"datasetId": dataset,
"tableId": table,
}
entry = self._make_one(None)
entry.view = f"{project}.{dataset}.{table}"
resource = entry.to_api_repr()
exp_resource = {"view": view, "role": None}
self.assertEqual(resource, exp_resource)
def test_view_getter_setter_table(self):
project = "my_project"
dataset = "my_dataset"
table = "my_table"
view = {
"projectId": project,
"datasetId": dataset,
"tableId": table,
}
view_ref = Table.from_string(f"{project}.{dataset}.{table}")
entry = self._make_one(None)
entry.view = view_ref
resource = entry.to_api_repr()
exp_resource = {"view": view, "role": None}
self.assertEqual(resource, exp_resource)
def test_view_getter_setter_table_ref(self):
project = "my_project"
dataset = "my_dataset"
table = "my_table"
view = {
"projectId": project,
"datasetId": dataset,
"tableId": table,
}
view_ref = TableReference.from_string(f"{project}.{dataset}.{table}")
entry = self._make_one(None)
entry.view = view_ref
resource = entry.to_api_repr()
exp_resource = {"view": view, "role": None}
self.assertEqual(resource, exp_resource)
def test_view_getter_setter_incorrect_role(self):
view = {
"projectId": "my_project",
"datasetId": "my_dataset",
"tableId": "my_table",
}
view_ref = TableReference.from_api_repr(view)
entry = self._make_one("READER")
with self.assertRaises(ValueError):
entry.view = view_ref
def test_dataset_getter_setter(self):
dataset = {"projectId": "my-project", "datasetId": "my_dataset"}
entry = self._make_one(None)
entry.dataset = dataset
resource = entry.to_api_repr()
exp_resource = {
"dataset": {"dataset": dataset, "targetTypes": None},
"role": None,
}
dataset_ref = DatasetReference.from_api_repr(dataset)
prop = entry.dataset
self.assertEqual(resource, exp_resource)
self.assertEqual(prop, dataset_ref)
def test_dataset_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.dataset, None)
def test_dataset_getter_setter_string(self):
project = "my-project"
dataset_id = "my_dataset"
dataset = {
"projectId": project,
"datasetId": dataset_id,
}
entry = self._make_one(None)
string_ref = f"{project}.{dataset_id}"
entry.dataset = string_ref
resource = entry.to_api_repr()
exp_resource = {
"dataset": {"dataset": dataset, "targetTypes": None},
"role": None,
}
self.assertEqual(resource, exp_resource)
def test_dataset_getter_setter_dataset_ref(self):
project = "my-project"
dataset_id = "my_dataset"
dataset_ref = DatasetReference(project, dataset_id)
entry = self._make_one(None)
entry.dataset = dataset_ref
resource = entry.to_api_repr()
exp_resource = {
"dataset": {"dataset": dataset_ref, "targetTypes": None},
"role": None,
}
self.assertEqual(resource, exp_resource)
def test_dataset_getter_setter_dataset(self):
project = "my-project"
dataset_id = "my_dataset"
dataset_repr = {
"projectId": project,
"datasetId": dataset_id,
}
dataset = Dataset(f"{project}.{dataset_id}")
entry = self._make_one(None)
entry.dataset = dataset
resource = entry.to_api_repr()
exp_resource = {
"role": None,
"dataset": {"dataset": dataset_repr, "targetTypes": None},
}
self.assertEqual(resource, exp_resource)
def test_dataset_getter_setter_incorrect_role(self):
dataset = {"dataset": {"projectId": "my-project", "datasetId": "my_dataset"}}
entry = self._make_one("READER")
with self.assertRaises(ValueError):
entry.dataset = dataset
def test_routine_getter_setter(self):
routine = {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
entry = self._make_one(None)
entry.routine = routine
resource = entry.to_api_repr()
exp_resource = {"routine": routine, "role": None}
self.assertEqual(resource, exp_resource)
def test_routine_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.routine, None)
def test_routine_getter_setter_string(self):
project = "my-project"
dataset_id = "my_dataset"
routine_id = "my_routine"
routine = {
"projectId": project,
"datasetId": dataset_id,
"routineId": routine_id,
}
entry = self._make_one(None)
entry.routine = f"{project}.{dataset_id}.{routine_id}"
resource = entry.to_api_repr()
exp_resource = {
"routine": routine,
"role": None,
}
self.assertEqual(resource, exp_resource)
def test_routine_getter_setter_routine_ref(self):
routine = {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
entry = self._make_one(None)
entry.routine = RoutineReference.from_api_repr(routine)
resource = entry.to_api_repr()
exp_resource = {
"routine": routine,
"role": None,
}
self.assertEqual(resource, exp_resource)
def test_routine_getter_setter_routine(self):
routine = {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
routine_ref = RoutineReference.from_api_repr(routine)
entry = self._make_one(None)
entry.routine = Routine(routine_ref)
resource = entry.to_api_repr()
exp_resource = {
"routine": routine,
"role": None,
}
self.assertEqual(entry.routine, routine_ref)
self.assertEqual(resource, exp_resource)
def test_routine_getter_setter_incorrect_role(self):
routine = {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
entry = self._make_one("READER")
with self.assertRaises(ValueError):
entry.routine = routine
def test_group_by_email_getter_setter(self):
email = "cloud-developer-relations@google.com"
entry = self._make_one(None)
entry.group_by_email = email
resource = entry.to_api_repr()
exp_resource = {"groupByEmail": email, "role": None}
self.assertEqual(entry.group_by_email, email)
self.assertEqual(resource, exp_resource)
def test_group_by_email_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.group_by_email, None)
def test_user_by_email_getter_setter(self):
email = "cloud-developer-relations@google.com"
entry = self._make_one(None)
entry.user_by_email = email
resource = entry.to_api_repr()
exp_resource = {"userByEmail": email, "role": None}
self.assertEqual(entry.user_by_email, email)
self.assertEqual(resource, exp_resource)
def test_user_by_email_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.user_by_email, None)
def test_domain_setter(self):
domain = "my_domain"
entry = self._make_one(None)
entry.domain = domain
resource = entry.to_api_repr()
exp_resource = {"domain": domain, "role": None}
self.assertEqual(entry.domain, domain)
self.assertEqual(resource, exp_resource)
def test_domain_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.domain, None)
def test_special_group_getter_setter(self):
special_group = "my_special_group"
entry = self._make_one(None)
entry.special_group = special_group
resource = entry.to_api_repr()
exp_resource = {"specialGroup": special_group, "role": None}
self.assertEqual(entry.special_group, special_group)
self.assertEqual(resource, exp_resource)
def test_special_group_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.special_group, None)
def test_role_getter_setter(self):
role = "READER"
entry = self._make_one(None)
entry.role = role
resource = entry.to_api_repr()
exp_resource = {"role": role}
self.assertEqual(resource, exp_resource)
def test_role_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.role, None)
def test_dataset_target_types_getter_setter(self):
target_types = ["VIEWS"]
entry = self._make_one(None)
entry.dataset_target_types = target_types
self.assertEqual(entry.dataset_target_types, target_types)
def test_dataset_target_types_getter_setter_none(self):
entry = self._make_one(None)
self.assertEqual(entry.dataset_target_types, None)
def test_dataset_target_types_getter_setter_w_dataset(self):
dataset = {"projectId": "my-project", "datasetId": "my_dataset"}
target_types = ["VIEWS"]
entry = self._make_one(None)
entry.dataset = dataset
entry.dataset_target_types = target_types
self.assertEqual(entry.dataset_target_types, target_types)
class TestDatasetReference(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.bigquery.dataset import DatasetReference
return DatasetReference
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
def test_ctor_defaults(self):
dataset_ref = self._make_one("some-project-1", "dataset_1")
self.assertEqual(dataset_ref.project, "some-project-1")
self.assertEqual(dataset_ref.dataset_id, "dataset_1")
def test_ctor_bad_args(self):
with self.assertRaises(ValueError):
self._make_one(1, "d")
with self.assertRaises(ValueError):
self._make_one("p", 2)
def test_table(self):
dataset_ref = self._make_one("some-project-1", "dataset_1")
table_ref = dataset_ref.table("table_1")
self.assertEqual(table_ref.dataset_id, "dataset_1")
self.assertEqual(table_ref.project, "some-project-1")
self.assertEqual(table_ref.table_id, "table_1")
def test_model(self):
dataset_ref = self._make_one("some-project-1", "dataset_1")
model_ref = dataset_ref.model("model_1")
self.assertEqual(model_ref.project, "some-project-1")
self.assertEqual(model_ref.dataset_id, "dataset_1")
self.assertEqual(model_ref.model_id, "model_1")
def test_routine(self):
dataset_ref = self._make_one("some-project-1", "dataset_1")
routine_ref = dataset_ref.routine("routine_1")
self.assertEqual(routine_ref.project, "some-project-1")
self.assertEqual(routine_ref.dataset_id, "dataset_1")
self.assertEqual(routine_ref.routine_id, "routine_1")
def test_to_api_repr(self):
dataset = self._make_one("project_1", "dataset_1")
resource = dataset.to_api_repr()
self.assertEqual(resource, {"projectId": "project_1", "datasetId": "dataset_1"})
def test_from_api_repr(self):
cls = self._get_target_class()
expected = self._make_one("project_1", "dataset_1")
got = cls.from_api_repr({"projectId": "project_1", "datasetId": "dataset_1"})
self.assertEqual(expected, got)
def test_from_string(self):
cls = self._get_target_class()
got = cls.from_string("string-project.string_dataset")
self.assertEqual(got.project, "string-project")
self.assertEqual(got.dataset_id, "string_dataset")
def test_from_string_w_prefix(self):
cls = self._get_target_class()
got = cls.from_string("google.com:string-project.string_dataset")
self.assertEqual(got.project, "google.com:string-project")
self.assertEqual(got.dataset_id, "string_dataset")
def test_from_string_legacy_string(self):
cls = self._get_target_class()
with self.assertRaises(ValueError):
cls.from_string("string-project:string_dataset")
def test_from_string_w_incorrect_prefix(self):
cls = self._get_target_class()
with self.assertRaises(ValueError):
cls.from_string("google.com.string-project.dataset_id")
def test_from_string_w_prefix_and_too_many_parts(self):
cls = self._get_target_class()
with self.assertRaises(ValueError):
cls.from_string("google.com:string-project.dataset_id.table_id")
def test_from_string_not_fully_qualified(self):
cls = self._get_target_class()
with self.assertRaises(ValueError):
cls.from_string("string_dataset")
with self.assertRaises(ValueError):
cls.from_string("a.b.c")
def test_from_string_with_default_project(self):
cls = self._get_target_class()
got = cls.from_string("string_dataset", default_project="default-project")
self.assertEqual(got.project, "default-project")
self.assertEqual(got.dataset_id, "string_dataset")
def test_from_string_ignores_default_project(self):
cls = self._get_target_class()
got = cls.from_string(
"string-project.string_dataset", default_project="default-project"
)
self.assertEqual(got.project, "string-project")
self.assertEqual(got.dataset_id, "string_dataset")
def test___eq___wrong_type(self):
dataset = self._make_one("project_1", "dataset_1")
other = object()
self.assertNotEqual(dataset, other)
self.assertEqual(dataset, mock.ANY)
def test___eq___project_mismatch(self):
dataset = self._make_one("project_1", "dataset_1")
other = self._make_one("project_2", "dataset_1")
self.assertNotEqual(dataset, other)
def test___eq___dataset_mismatch(self):
dataset = self._make_one("project_1", "dataset_1")
other = self._make_one("project_1", "dataset_2")
self.assertNotEqual(dataset, other)
def test___eq___equality(self):
dataset = self._make_one("project_1", "dataset_1")
other = self._make_one("project_1", "dataset_1")
self.assertEqual(dataset, other)
def test___hash__set_equality(self):
dataset1 = self._make_one("project_1", "dataset_1")
dataset2 = self._make_one("project_1", "dataset_2")
set_one = {dataset1, dataset2}
set_two = {dataset1, dataset2}
self.assertEqual(set_one, set_two)
def test___hash__not_equals(self):
dataset1 = self._make_one("project_1", "dataset_1")
dataset2 = self._make_one("project_1", "dataset_2")
set_one = {dataset1}
set_two = {dataset2}
self.assertNotEqual(set_one, set_two)
def test___repr__(self):
dataset = self._make_one("project1", "dataset1")
expected = "DatasetReference('project1', 'dataset1')"
self.assertEqual(repr(dataset), expected)
def test___str__(self):
dataset = self._make_one("project1", "dataset1")
self.assertEqual(str(dataset), "project1.dataset1")
class TestDataset(unittest.TestCase):
from google.cloud.bigquery.dataset import DatasetReference
PROJECT = "project"
DS_ID = "dataset-id"
DS_REF = DatasetReference(PROJECT, DS_ID)
KMS_KEY_NAME = "projects/1/locations/us/keyRings/1/cryptoKeys/1"
@staticmethod
def _get_target_class():
from google.cloud.bigquery.dataset import Dataset
return Dataset
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
def _setUpConstants(self):
import datetime
from google.cloud._helpers import UTC
self.WHEN_TS = 1437767599.006
self.WHEN = datetime.datetime.utcfromtimestamp(self.WHEN_TS).replace(tzinfo=UTC)
self.ETAG = "ETAG"
self.DS_FULL_ID = "%s:%s" % (self.PROJECT, self.DS_ID)
self.RESOURCE_URL = "http://example.com/path/to/resource"
def _make_resource(self):
self._setUpConstants()
USER_EMAIL = "phred@example.com"
GROUP_EMAIL = "group-name@lists.example.com"
return {
"creationTime": self.WHEN_TS * 1000,
"datasetReference": {"projectId": self.PROJECT, "datasetId": self.DS_ID},
"etag": self.ETAG,
"id": self.DS_FULL_ID,
"lastModifiedTime": self.WHEN_TS * 1000,
"location": "US",
"selfLink": self.RESOURCE_URL,
"defaultTableExpirationMs": 3600,
"storageBillingModel": "LOGICAL",
"access": [
{"role": "OWNER", "userByEmail": USER_EMAIL},
{"role": "OWNER", "groupByEmail": GROUP_EMAIL},
{"role": "WRITER", "specialGroup": "projectWriters"},
{"role": "READER", "specialGroup": "projectReaders"},
],
"defaultEncryptionConfiguration": {"kmsKeyName": self.KMS_KEY_NAME},
}
def _verify_access_entry(self, access_entries, resource):
r_entries = []
for r_entry in resource["access"]:
role = r_entry.pop("role")
for entity_type, entity_id in sorted(r_entry.items()):
r_entries.append(
{"role": role, "entity_type": entity_type, "entity_id": entity_id}
)
self.assertEqual(len(access_entries), len(r_entries))
for a_entry, r_entry in zip(access_entries, r_entries):
self.assertEqual(a_entry.role, r_entry["role"])
self.assertEqual(a_entry.entity_type, r_entry["entity_type"])
self.assertEqual(a_entry.entity_id, r_entry["entity_id"])
def _verify_readonly_resource_properties(self, dataset, resource):
self.assertEqual(dataset.project, self.PROJECT)
self.assertEqual(dataset.dataset_id, self.DS_ID)
self.assertEqual(dataset.reference.project, self.PROJECT)
self.assertEqual(dataset.reference.dataset_id, self.DS_ID)
if "creationTime" in resource:
self.assertEqual(dataset.created, self.WHEN)
else:
self.assertIsNone(dataset.created)
if "etag" in resource:
self.assertEqual(dataset.etag, self.ETAG)
else:
self.assertIsNone(dataset.etag)
if "lastModifiedTime" in resource:
self.assertEqual(dataset.modified, self.WHEN)
else:
self.assertIsNone(dataset.modified)
if "selfLink" in resource:
self.assertEqual(dataset.self_link, self.RESOURCE_URL)
else:
self.assertIsNone(dataset.self_link)
def _verify_resource_properties(self, dataset, resource):
self._verify_readonly_resource_properties(dataset, resource)
if "defaultTableExpirationMs" in resource:
self.assertEqual(
dataset.default_table_expiration_ms,
int(resource.get("defaultTableExpirationMs")),
)
else:
self.assertIsNone(dataset.default_table_expiration_ms)
self.assertEqual(dataset.description, resource.get("description"))
self.assertEqual(dataset.friendly_name, resource.get("friendlyName"))
self.assertEqual(dataset.location, resource.get("location"))
self.assertEqual(
dataset.is_case_insensitive, resource.get("isCaseInsensitive") or False
)
if "defaultEncryptionConfiguration" in resource:
self.assertEqual(
dataset.default_encryption_configuration.kms_key_name,
resource.get("defaultEncryptionConfiguration")["kmsKeyName"],
)
else:
self.assertIsNone(dataset.default_encryption_configuration)
if "storageBillingModel" in resource:
self.assertEqual(
dataset.storage_billing_model, resource.get("storageBillingModel")
)
else:
self.assertIsNone(dataset.storage_billing_model)
if "access" in resource:
self._verify_access_entry(dataset.access_entries, resource)
else:
self.assertEqual(dataset.access_entries, [])
def test_ctor_defaults(self):
dataset = self._make_one(self.DS_REF)
self.assertEqual(dataset.dataset_id, self.DS_ID)
self.assertEqual(dataset.project, self.PROJECT)
self.assertEqual(
dataset.path, "/projects/%s/datasets/%s" % (self.PROJECT, self.DS_ID)
)
self.assertEqual(dataset.access_entries, [])
self.assertIsNone(dataset.created)
self.assertIsNone(dataset.full_dataset_id)
self.assertIsNone(dataset.etag)
self.assertIsNone(dataset.modified)
self.assertIsNone(dataset.self_link)
self.assertIsNone(dataset.default_table_expiration_ms)
self.assertIsNone(dataset.description)
self.assertIsNone(dataset.friendly_name)
self.assertIsNone(dataset.location)
self.assertEqual(dataset.is_case_insensitive, False)
def test_ctor_string(self):
dataset = self._make_one("some-project.some_dset")
self.assertEqual(dataset.project, "some-project")
self.assertEqual(dataset.dataset_id, "some_dset")
def test_ctor_string_wo_project_id(self):
with pytest.raises(ValueError):
# Project ID is missing.
self._make_one("some_dset")
def test_ctor_explicit(self):
from google.cloud.bigquery.dataset import DatasetReference, AccessEntry
phred = AccessEntry("OWNER", "userByEmail", "phred@example.com")
bharney = AccessEntry("OWNER", "userByEmail", "bharney@example.com")
entries = [phred, bharney]
OTHER_PROJECT = "foo-bar-123"
dataset = self._make_one(DatasetReference(OTHER_PROJECT, self.DS_ID))
dataset.access_entries = entries
self.assertEqual(dataset.dataset_id, self.DS_ID)
self.assertEqual(dataset.project, OTHER_PROJECT)
self.assertEqual(
dataset.path, "/projects/%s/datasets/%s" % (OTHER_PROJECT, self.DS_ID)
)
self.assertEqual(dataset.access_entries, entries)
self.assertIsNone(dataset.created)
self.assertIsNone(dataset.full_dataset_id)
self.assertIsNone(dataset.etag)
self.assertIsNone(dataset.modified)
self.assertIsNone(dataset.self_link)
self.assertIsNone(dataset.default_table_expiration_ms)
self.assertIsNone(dataset.description)
self.assertIsNone(dataset.friendly_name)
self.assertIsNone(dataset.location)
self.assertEqual(dataset.is_case_insensitive, False)
def test_access_entries_setter_non_list(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(TypeError):
dataset.access_entries = object()
def test_access_entries_setter_invalid_field(self):
from google.cloud.bigquery.dataset import AccessEntry
dataset = self._make_one(self.DS_REF)
phred = AccessEntry("OWNER", "userByEmail", "phred@example.com")
with self.assertRaises(ValueError):
dataset.access_entries = [phred, object()]
def test_access_entries_setter(self):
from google.cloud.bigquery.dataset import AccessEntry
dataset = self._make_one(self.DS_REF)
phred = AccessEntry("OWNER", "userByEmail", "phred@example.com")
bharney = AccessEntry("OWNER", "userByEmail", "bharney@example.com")
dataset.access_entries = [phred, bharney]
self.assertEqual(dataset.access_entries, [phred, bharney])
def test_default_partition_expiration_ms(self):
dataset = self._make_one("proj.dset")
assert dataset.default_partition_expiration_ms is None
dataset.default_partition_expiration_ms = 12345
assert dataset.default_partition_expiration_ms == 12345
dataset.default_partition_expiration_ms = None
assert dataset.default_partition_expiration_ms is None
def test_default_table_expiration_ms_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.default_table_expiration_ms = "bogus"
def test_default_table_expiration_ms_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.default_table_expiration_ms = 12345
self.assertEqual(dataset.default_table_expiration_ms, 12345)
def test_description_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.description = 12345
def test_description_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.description = "DESCRIPTION"
self.assertEqual(dataset.description, "DESCRIPTION")
def test_friendly_name_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.friendly_name = 12345
def test_friendly_name_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.friendly_name = "FRIENDLY"
self.assertEqual(dataset.friendly_name, "FRIENDLY")
def test_location_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.location = 12345
def test_location_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.location = "LOCATION"
self.assertEqual(dataset.location, "LOCATION")
def test_labels_update_in_place(self):
dataset = self._make_one(self.DS_REF)
del dataset._properties["labels"] # don't start w/ existing dict
labels = dataset.labels
labels["foo"] = "bar" # update in place
self.assertEqual(dataset.labels, {"foo": "bar"})
def test_labels_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.labels = {"color": "green"}
self.assertEqual(dataset.labels, {"color": "green"})
def test_labels_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.labels = None
def test_labels_getter_missing_value(self):
dataset = self._make_one(self.DS_REF)
self.assertEqual(dataset.labels, {})
def test_is_case_insensitive_setter_bad_value(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError):
dataset.is_case_insensitive = 0
def test_is_case_insensitive_setter_true(self):
dataset = self._make_one(self.DS_REF)
dataset.is_case_insensitive = True
self.assertEqual(dataset.is_case_insensitive, True)
def test_is_case_insensitive_setter_none(self):
dataset = self._make_one(self.DS_REF)
dataset.is_case_insensitive = None
self.assertEqual(dataset.is_case_insensitive, False)
def test_is_case_insensitive_setter_false(self):
dataset = self._make_one(self.DS_REF)
dataset.is_case_insensitive = False
self.assertEqual(dataset.is_case_insensitive, False)
def test_from_api_repr_missing_identity(self):
self._setUpConstants()
RESOURCE = {}
klass = self._get_target_class()
with self.assertRaises(KeyError):
klass.from_api_repr(RESOURCE)
def test_from_api_repr_bare(self):
self._setUpConstants()
RESOURCE = {
"id": "%s:%s" % (self.PROJECT, self.DS_ID),
"datasetReference": {"projectId": self.PROJECT, "datasetId": self.DS_ID},
}
klass = self._get_target_class()
dataset = klass.from_api_repr(RESOURCE)
self._verify_resource_properties(dataset, RESOURCE)
def test_from_api_repr_w_properties(self):
RESOURCE = self._make_resource()
klass = self._get_target_class()
dataset = klass.from_api_repr(RESOURCE)
self._verify_resource_properties(dataset, RESOURCE)
def test_to_api_repr_w_custom_field(self):
dataset = self._make_one(self.DS_REF)
dataset._properties["newAlphaProperty"] = "unreleased property"
resource = dataset.to_api_repr()
exp_resource = {
"datasetReference": self.DS_REF.to_api_repr(),
"labels": {},
"newAlphaProperty": "unreleased property",
}
self.assertEqual(resource, exp_resource)
def test_default_encryption_configuration_setter(self):
from google.cloud.bigquery.encryption_configuration import (
EncryptionConfiguration,
)
dataset = self._make_one(self.DS_REF)
encryption_configuration = EncryptionConfiguration(
kms_key_name=self.KMS_KEY_NAME
)
dataset.default_encryption_configuration = encryption_configuration
self.assertEqual(
dataset.default_encryption_configuration.kms_key_name, self.KMS_KEY_NAME
)
dataset.default_encryption_configuration = None
self.assertIsNone(dataset.default_encryption_configuration)
def test_storage_billing_model_setter(self):
dataset = self._make_one(self.DS_REF)
dataset.storage_billing_model = "PHYSICAL"
self.assertEqual(dataset.storage_billing_model, "PHYSICAL")
def test_storage_billing_model_setter_with_none(self):
dataset = self._make_one(self.DS_REF)
dataset.storage_billing_model = None
self.assertIsNone(dataset.storage_billing_model)
def test_storage_billing_model_setter_with_invalid_type(self):
dataset = self._make_one(self.DS_REF)
with self.assertRaises(ValueError) as raises:
dataset.storage_billing_model = object()
self.assertIn("storage_billing_model", str(raises.exception))
def test_from_string(self):
cls = self._get_target_class()
got = cls.from_string("string-project.string_dataset")
self.assertEqual(got.project, "string-project")
self.assertEqual(got.dataset_id, "string_dataset")
def test_from_string_legacy_string(self):
cls = self._get_target_class()
with self.assertRaises(ValueError):
cls.from_string("string-project:string_dataset")
def test__build_resource_w_custom_field(self):
dataset = self._make_one(self.DS_REF)
dataset._properties["newAlphaProperty"] = "unreleased property"
resource = dataset._build_resource(["newAlphaProperty"])
exp_resource = {"newAlphaProperty": "unreleased property"}
self.assertEqual(resource, exp_resource)
def test__build_resource_w_custom_field_not_in__properties(self):
dataset = self._make_one(self.DS_REF)
dataset.bad = "value"
with self.assertRaises(ValueError):
dataset._build_resource(["bad"])
def test_table(self):
from google.cloud.bigquery.table import TableReference
dataset = self._make_one(self.DS_REF)
table = dataset.table("table_id")
self.assertIsInstance(table, TableReference)
self.assertEqual(table.table_id, "table_id")
self.assertEqual(table.dataset_id, self.DS_ID)
self.assertEqual(table.project, self.PROJECT)
def test___repr__(self):
from google.cloud.bigquery.dataset import DatasetReference
dataset = self._make_one(DatasetReference("project1", "dataset1"))
expected = "Dataset(DatasetReference('project1', 'dataset1'))"
self.assertEqual(repr(dataset), expected)
class TestDatasetListItem(unittest.TestCase):
@staticmethod
def _get_target_class():
from google.cloud.bigquery.dataset import DatasetListItem
return DatasetListItem
def _make_one(self, *args, **kw):
return self._get_target_class()(*args, **kw)
def test_ctor(self):
project = "test-project"
dataset_id = "test_dataset"
resource = {
"kind": "bigquery#dataset",
"id": "{}:{}".format(project, dataset_id),
"datasetReference": {"projectId": project, "datasetId": dataset_id},
"friendlyName": "Data of the Test",
"labels": {"some-stuff": "this-is-a-label"},
}
dataset = self._make_one(resource)
self.assertEqual(dataset.project, project)
self.assertEqual(dataset.dataset_id, dataset_id)
self.assertEqual(dataset.full_dataset_id, "{}:{}".format(project, dataset_id))
self.assertEqual(dataset.reference.project, project)
self.assertEqual(dataset.reference.dataset_id, dataset_id)
self.assertEqual(dataset.friendly_name, "Data of the Test")
self.assertEqual(dataset.labels["some-stuff"], "this-is-a-label")
def test_ctor_missing_properties(self):
resource = {
"datasetReference": {"projectId": "testproject", "datasetId": "testdataset"}
}
dataset = self._make_one(resource)
self.assertEqual(dataset.project, "testproject")
self.assertEqual(dataset.dataset_id, "testdataset")
self.assertIsNone(dataset.full_dataset_id)
self.assertIsNone(dataset.friendly_name)
self.assertEqual(dataset.labels, {})
def test_ctor_wo_project(self):
resource = {"datasetReference": {"datasetId": "testdataset"}}
with self.assertRaises(ValueError):
self._make_one(resource)
def test_ctor_wo_dataset(self):
resource = {"datasetReference": {"projectId": "testproject"}}
with self.assertRaises(ValueError):
self._make_one(resource)
def test_ctor_wo_reference(self):
with self.assertRaises(ValueError):
self._make_one({})
def test_labels_update_in_place(self):
resource = {
"datasetReference": {"projectId": "testproject", "datasetId": "testdataset"}
}
dataset = self._make_one(resource)
labels = dataset.labels
labels["foo"] = "bar" # update in place
self.assertEqual(dataset.labels, {"foo": "bar"})
def test_table(self):
from google.cloud.bigquery.table import TableReference
project = "test-project"
dataset_id = "test_dataset"
resource = {"datasetReference": {"projectId": project, "datasetId": dataset_id}}
dataset = self._make_one(resource)
table = dataset.table("table_id")
self.assertIsInstance(table, TableReference)
self.assertEqual(table.table_id, "table_id")
self.assertEqual(table.dataset_id, dataset_id)
self.assertEqual(table.project, project)
|