File size: 22,561 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 |
#
# Copyright 2019 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
#
# https://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 pytest
import google.cloud._helpers
from google.cloud import bigquery
@pytest.fixture
def target_class():
from google.cloud.bigquery.routine import Routine
return Routine
@pytest.fixture
def object_under_test(target_class):
return target_class("project-id.dataset_id.routine_id")
def test_ctor(target_class):
from google.cloud.bigquery.routine import RoutineReference
ref = RoutineReference.from_string("my-proj.my_dset.my_routine")
actual_routine = target_class(ref)
assert actual_routine.reference == ref
assert (
actual_routine.path == "/projects/my-proj/datasets/my_dset/routines/my_routine"
)
def test_ctor_w_string(target_class):
from google.cloud.bigquery.routine import RoutineReference
routine_id = "my-proj.my_dset.my_routine"
ref = RoutineReference.from_string(routine_id)
actual_routine = target_class(routine_id)
assert actual_routine.reference == ref
def test_ctor_w_properties(target_class):
from google.cloud.bigquery.routine import RoutineArgument
from google.cloud.bigquery.routine import RoutineReference
routine_id = "my-proj.my_dset.my_routine"
arguments = [
RoutineArgument(
name="x",
data_type=bigquery.standard_sql.StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.INT64
),
)
]
body = "x * 3"
language = "SQL"
return_type = bigquery.standard_sql.StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.INT64
)
type_ = "SCALAR_FUNCTION"
description = "A routine description."
determinism_level = bigquery.DeterminismLevel.NOT_DETERMINISTIC
options = bigquery.RemoteFunctionOptions(
endpoint="https://some.endpoint",
connection="connection_string",
max_batching_rows=99,
user_defined_context={"foo": "bar"},
)
actual_routine = target_class(
routine_id,
arguments=arguments,
body=body,
language=language,
return_type=return_type,
type_=type_,
description=description,
determinism_level=determinism_level,
remote_function_options=options,
)
ref = RoutineReference.from_string(routine_id)
assert actual_routine.reference == ref
assert actual_routine.arguments == arguments
assert actual_routine.body == body
assert actual_routine.language == language
assert actual_routine.return_type == return_type
assert actual_routine.type_ == type_
assert actual_routine.description == description
assert (
actual_routine.determinism_level == bigquery.DeterminismLevel.NOT_DETERMINISTIC
)
assert actual_routine.remote_function_options == options
def test_ctor_invalid_remote_function_options(target_class):
with pytest.raises(
ValueError,
match=".*must be google.cloud.bigquery.routine.RemoteFunctionOptions.*",
):
target_class(
"my-proj.my_dset.my_routine",
remote_function_options=object(),
)
def test_from_api_repr(target_class):
from google.cloud.bigquery.routine import RoutineArgument
from google.cloud.bigquery.routine import RoutineReference
creation_time = datetime.datetime(
2010, 5, 19, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
modified_time = datetime.datetime(
2011, 10, 1, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
resource = {
"routineReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
},
"etag": "abcdefg",
"creationTime": str(google.cloud._helpers._millis(creation_time)),
"lastModifiedTime": str(google.cloud._helpers._millis(modified_time)),
"definitionBody": "42",
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"someNewField": "someValue",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISTIC,
"remoteFunctionOptions": {
"endpoint": "https://some.endpoint",
"connection": "connection_string",
"maxBatchingRows": 50,
"userDefinedContext": {
"foo": "bar",
},
},
"dataGovernanceType": "DATA_MASKING",
}
actual_routine = target_class.from_api_repr(resource)
assert actual_routine.project == "my-project"
assert actual_routine.dataset_id == "my_dataset"
assert actual_routine.routine_id == "my_routine"
assert (
actual_routine.path
== "/projects/my-project/datasets/my_dataset/routines/my_routine"
)
assert actual_routine.reference == RoutineReference.from_string(
"my-project.my_dataset.my_routine"
)
assert actual_routine.etag == "abcdefg"
assert actual_routine.created == creation_time
assert actual_routine.modified == modified_time
assert actual_routine.arguments == [
RoutineArgument(
name="x",
data_type=bigquery.standard_sql.StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.INT64
),
)
]
assert actual_routine.body == "42"
assert actual_routine.language == "SQL"
assert actual_routine.return_type == bigquery.standard_sql.StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.INT64
)
assert actual_routine.return_table_type is None
assert actual_routine.type_ == "SCALAR_FUNCTION"
assert actual_routine._properties["someNewField"] == "someValue"
assert actual_routine.description == "A routine description."
assert actual_routine.determinism_level == "DETERMINISTIC"
assert actual_routine.remote_function_options.endpoint == "https://some.endpoint"
assert actual_routine.remote_function_options.connection == "connection_string"
assert actual_routine.remote_function_options.max_batching_rows == 50
assert actual_routine.remote_function_options.user_defined_context == {"foo": "bar"}
assert actual_routine.data_governance_type == "DATA_MASKING"
def test_from_api_repr_tvf_function(target_class):
from google.cloud.bigquery.routine import RoutineArgument
from google.cloud.bigquery.routine import RoutineReference
from google.cloud.bigquery.routine import RoutineType
StandardSqlDataType = bigquery.standard_sql.StandardSqlDataType
StandardSqlField = bigquery.standard_sql.StandardSqlField
StandardSqlTableType = bigquery.standard_sql.StandardSqlTableType
creation_time = datetime.datetime(
2010, 5, 19, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
modified_time = datetime.datetime(
2011, 10, 1, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
resource = {
"routineReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
},
"etag": "abcdefg",
"creationTime": str(google.cloud._helpers._millis(creation_time)),
"lastModifiedTime": str(google.cloud._helpers._millis(modified_time)),
"definitionBody": "SELECT x FROM UNNEST([1,2,3]) x WHERE x > a",
"arguments": [{"name": "a", "dataType": {"typeKind": "INT64"}}],
"language": "SQL",
"returnTableType": {
"columns": [{"name": "int_col", "type": {"typeKind": "INT64"}}]
},
"routineType": "TABLE_VALUED_FUNCTION",
"someNewField": "someValue",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISTIC,
}
actual_routine = target_class.from_api_repr(resource)
assert actual_routine.project == "my-project"
assert actual_routine.dataset_id == "my_dataset"
assert actual_routine.routine_id == "my_routine"
assert (
actual_routine.path
== "/projects/my-project/datasets/my_dataset/routines/my_routine"
)
assert actual_routine.reference == RoutineReference.from_string(
"my-project.my_dataset.my_routine"
)
assert actual_routine.etag == "abcdefg"
assert actual_routine.created == creation_time
assert actual_routine.modified == modified_time
assert actual_routine.arguments == [
RoutineArgument(
name="a",
data_type=StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.INT64
),
)
]
assert actual_routine.body == "SELECT x FROM UNNEST([1,2,3]) x WHERE x > a"
assert actual_routine.language == "SQL"
assert actual_routine.return_type is None
assert actual_routine.return_table_type == StandardSqlTableType(
columns=[
StandardSqlField(
name="int_col",
type=StandardSqlDataType(type_kind=bigquery.StandardSqlTypeNames.INT64),
)
]
)
assert actual_routine.type_ == RoutineType.TABLE_VALUED_FUNCTION
assert actual_routine._properties["someNewField"] == "someValue"
assert actual_routine.description == "A routine description."
assert actual_routine.determinism_level == "DETERMINISTIC"
def test_from_api_repr_w_minimal_resource(target_class):
from google.cloud.bigquery.routine import RoutineReference
resource = {
"routineReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
}
}
actual_routine = target_class.from_api_repr(resource)
assert actual_routine.reference == RoutineReference.from_string(
"my-project.my_dataset.my_routine"
)
assert actual_routine.etag is None
assert actual_routine.created is None
assert actual_routine.modified is None
assert actual_routine.arguments == []
assert actual_routine.body is None
assert actual_routine.language is None
assert actual_routine.return_type is None
assert actual_routine.type_ is None
assert actual_routine.description is None
assert actual_routine.determinism_level is None
assert actual_routine.remote_function_options is None
assert actual_routine.data_governance_type is None
def test_from_api_repr_w_unknown_fields(target_class):
from google.cloud.bigquery.routine import RoutineReference
resource = {
"routineReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"routineId": "my_routine",
},
"thisFieldIsNotInTheProto": "just ignore me",
}
actual_routine = target_class.from_api_repr(resource)
assert actual_routine.reference == RoutineReference.from_string(
"my-project.my_dataset.my_routine"
)
assert actual_routine._properties is resource
@pytest.mark.parametrize(
"resource,filter_fields,expected",
[
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["arguments"],
{"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}]},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["body"],
{"definitionBody": "x * 3"},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["language"],
{"language": "SQL"},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["return_type"],
{"returnType": {"typeKind": "INT64"}},
),
(
{
"definitionBody": "SELECT x FROM UNNEST([1,2,3]) x WHERE x > 1",
"language": "SQL",
"returnTableType": {
"columns": [{"name": "int_col", "type": {"typeKind": "INT64"}}]
},
"routineType": "TABLE_VALUED_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["return_table_type"],
{
"returnTableType": {
"columns": [{"name": "int_col", "type": {"typeKind": "INT64"}}]
}
},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["type_"],
{"routineType": "SCALAR_FUNCTION"},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["description"],
{"description": "A routine description."},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
},
["determinism_level"],
{
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED
},
),
(
{
"arguments": [{"name": "x", "dataType": {"typeKind": "INT64"}}],
"definitionBody": "x * 3",
"language": "SQL",
"returnType": {"typeKind": "INT64"},
"routineType": "SCALAR_FUNCTION",
"description": "A routine description.",
"determinismLevel": bigquery.DeterminismLevel.DETERMINISM_LEVEL_UNSPECIFIED,
"dataGovernanceType": "DATA_MASKING",
},
["data_governance_type"],
{"dataGovernanceType": "DATA_MASKING"},
),
(
{},
[
"arguments",
"language",
"body",
"type_",
"return_type",
"description",
"determinism_level",
],
{
"arguments": None,
"definitionBody": None,
"language": None,
"returnType": None,
"routineType": None,
"description": None,
"determinismLevel": None,
},
),
(
{"someNewField": "someValue"},
["someNewField"],
{"someNewField": "someValue"},
),
(
{
"routineType": "SCALAR_FUNCTION",
"remoteFunctionOptions": {
"endpoint": "https://some_endpoint",
"connection": "connection_string",
"max_batching_rows": 101,
},
},
["remote_function_options"],
{
"remoteFunctionOptions": {
"endpoint": "https://some_endpoint",
"connection": "connection_string",
"max_batching_rows": 101,
},
},
),
],
)
def test_build_resource(object_under_test, resource, filter_fields, expected):
object_under_test._properties = resource
actual_routine = object_under_test._build_resource(filter_fields)
assert actual_routine == expected
def test_set_arguments_w_none(object_under_test):
object_under_test.arguments = None
assert object_under_test.arguments == []
assert object_under_test._properties["arguments"] == []
def test_set_imported_libraries(object_under_test):
imported_libraries = ["gs://cloud-samples-data/bigquery/udfs/max-value.js"]
object_under_test.imported_libraries = imported_libraries
assert object_under_test.imported_libraries == imported_libraries
assert object_under_test._properties["importedLibraries"] == imported_libraries
def test_set_imported_libraries_w_none(object_under_test):
object_under_test.imported_libraries = None
assert object_under_test.imported_libraries == []
assert object_under_test._properties["importedLibraries"] == []
def test_set_return_type_w_none(object_under_test):
object_under_test.return_type = None
assert object_under_test.return_type is None
assert object_under_test._properties["returnType"] is None
def test_set_return_table_type_w_none(object_under_test):
object_under_test.return_table_type = None
assert object_under_test.return_table_type is None
assert object_under_test._properties["returnTableType"] is None
def test_set_return_table_type_w_not_none(object_under_test):
StandardSqlDataType = bigquery.standard_sql.StandardSqlDataType
StandardSqlField = bigquery.standard_sql.StandardSqlField
StandardSqlTableType = bigquery.standard_sql.StandardSqlTableType
table_type = StandardSqlTableType(
columns=[
StandardSqlField(
name="int_col",
type=StandardSqlDataType(type_kind=bigquery.StandardSqlTypeNames.INT64),
),
StandardSqlField(
name="str_col",
type=StandardSqlDataType(
type_kind=bigquery.StandardSqlTypeNames.STRING
),
),
]
)
object_under_test.return_table_type = table_type
assert object_under_test.return_table_type == table_type
assert object_under_test._properties["returnTableType"] == {
"columns": [
{"name": "int_col", "type": {"typeKind": "INT64"}},
{"name": "str_col", "type": {"typeKind": "STRING"}},
]
}
def test_set_description_w_none(object_under_test):
object_under_test.description = None
assert object_under_test.description is None
assert object_under_test._properties["description"] is None
def test_set_remote_function_options_w_none(object_under_test):
object_under_test.remote_function_options = None
assert object_under_test.remote_function_options is None
assert object_under_test._properties["remoteFunctionOptions"] is None
def test_set_data_governance_type_w_none(object_under_test):
object_under_test.data_governance_type = None
assert object_under_test.data_governance_type is None
assert object_under_test._properties["dataGovernanceType"] is None
def test_set_data_governance_type_valid(object_under_test):
object_under_test.data_governance_type = "DATA_MASKING"
assert object_under_test.data_governance_type == "DATA_MASKING"
assert object_under_test._properties["dataGovernanceType"] == "DATA_MASKING"
def test_set_data_governance_type_wrong_type(object_under_test):
with pytest.raises(ValueError) as exp:
object_under_test.data_governance_type = 1
assert "invalid data_governance_type" in str(exp)
assert object_under_test.data_governance_type is None
assert object_under_test._properties.get("dataGovernanceType") is None
def test_set_data_governance_type_wrong_str(object_under_test):
"""Client does not verify the content of data_governance_type string to be
compatible with future upgrades. If the value is not supported, BigQuery
itself will report an error.
"""
object_under_test.data_governance_type = "RANDOM_STRING"
assert object_under_test.data_governance_type == "RANDOM_STRING"
assert object_under_test._properties["dataGovernanceType"] == "RANDOM_STRING"
def test_repr(target_class):
model = target_class("my-proj.my_dset.my_routine")
actual_routine = repr(model)
assert actual_routine == "Routine('my-proj.my_dset.my_routine')"
|