/
test_model.py
320 lines (278 loc) · 10.5 KB
/
test_model.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# -*- coding: utf-8 -*-
#
# 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.bigquery_v2.gapic import enums
KMS_KEY_NAME = "projects/1/locations/us/keyRings/1/cryptoKeys/1"
@pytest.fixture
def target_class():
from google.cloud.bigquery import Model
return Model
@pytest.fixture
def object_under_test(target_class):
return target_class("project-id.dataset_id.model_id")
def test_ctor(target_class):
from google.cloud.bigquery import ModelReference
ref = ModelReference.from_string("my-proj.my_dset.my_model")
got = target_class(ref)
assert got.reference == ref
def test_ctor_string(target_class):
from google.cloud.bigquery import ModelReference
model_id = "my-proj.my_dset.my_model"
ref = ModelReference.from_string(model_id)
got = target_class(model_id)
assert got.reference == ref
def test_from_api_repr(target_class):
from google.cloud.bigquery import ModelReference
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
)
expiration_time = datetime.datetime(
2012, 12, 21, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
resource = {
"modelReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"modelId": "my_model",
},
"location": "US",
"etag": "abcdefg",
"creationTime": str(google.cloud._helpers._millis(creation_time)),
"lastModifiedTime": str(google.cloud._helpers._millis(modified_time)),
"expirationTime": str(google.cloud._helpers._millis(expiration_time)),
"description": "A friendly description.",
"friendlyName": "A friendly name.",
"modelType": "LOGISTIC_REGRESSION",
"labels": {"greeting": u"こんにちは"},
"trainingRuns": [
{
"trainingOptions": {"initialLearnRate": 1.0},
"startTime": str(
google.cloud._helpers._datetime_to_rfc3339(creation_time)
),
},
{
"trainingOptions": {"initialLearnRate": 0.5},
"startTime": str(
google.cloud._helpers._datetime_to_rfc3339(modified_time)
),
},
{
"trainingOptions": {"initialLearnRate": 0.25},
# Allow milliseconds since epoch format.
# TODO: Remove this hack once CL 238585470 hits prod.
"startTime": str(google.cloud._helpers._millis(expiration_time)),
},
],
"featureColumns": [],
"encryptionConfiguration": {"kmsKeyName": KMS_KEY_NAME},
}
got = target_class.from_api_repr(resource)
assert got.project == "my-project"
assert got.dataset_id == "my_dataset"
assert got.model_id == "my_model"
assert got.reference == ModelReference.from_string("my-project.my_dataset.my_model")
assert got.path == "/projects/my-project/datasets/my_dataset/models/my_model"
assert got.location == "US"
assert got.etag == "abcdefg"
assert got.created == creation_time
assert got.modified == modified_time
assert got.expires == expiration_time
assert got.description == u"A friendly description."
assert got.friendly_name == u"A friendly name."
assert got.model_type == enums.Model.ModelType.LOGISTIC_REGRESSION
assert got.labels == {"greeting": u"こんにちは"}
assert got.encryption_configuration.kms_key_name == KMS_KEY_NAME
assert got.training_runs[0].training_options.initial_learn_rate == 1.0
assert (
got.training_runs[0]
.start_time.ToDatetime()
.replace(tzinfo=google.cloud._helpers.UTC)
== creation_time
)
assert got.training_runs[1].training_options.initial_learn_rate == 0.5
assert (
got.training_runs[1]
.start_time.ToDatetime()
.replace(tzinfo=google.cloud._helpers.UTC)
== modified_time
)
assert got.training_runs[2].training_options.initial_learn_rate == 0.25
assert (
got.training_runs[2]
.start_time.ToDatetime()
.replace(tzinfo=google.cloud._helpers.UTC)
== expiration_time
)
def test_from_api_repr_w_minimal_resource(target_class):
from google.cloud.bigquery import ModelReference
resource = {
"modelReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"modelId": "my_model",
}
}
got = target_class.from_api_repr(resource)
assert got.reference == ModelReference.from_string("my-project.my_dataset.my_model")
assert got.location == ""
assert got.etag == ""
assert got.created is None
assert got.modified is None
assert got.expires is None
assert got.description is None
assert got.friendly_name is None
assert got.model_type == enums.Model.ModelType.MODEL_TYPE_UNSPECIFIED
assert got.labels == {}
assert got.encryption_configuration is None
assert len(got.training_runs) == 0
assert len(got.feature_columns) == 0
assert len(got.label_columns) == 0
def test_from_api_repr_w_unknown_fields(target_class):
from google.cloud.bigquery import ModelReference
resource = {
"modelReference": {
"projectId": "my-project",
"datasetId": "my_dataset",
"modelId": "my_model",
},
"thisFieldIsNotInTheProto": "just ignore me",
}
got = target_class.from_api_repr(resource)
assert got.reference == ModelReference.from_string("my-project.my_dataset.my_model")
assert got._properties is resource
@pytest.mark.parametrize(
"resource,filter_fields,expected",
[
(
{
"friendlyName": "hello",
"description": "world",
"expirationTime": "12345",
"labels": {"a-label": "a-value"},
},
["description"],
{"description": "world"},
),
(
{"friendlyName": "hello", "description": "world"},
["friendlyName"],
{"friendlyName": "hello"},
),
(
{
"friendlyName": "hello",
"description": "world",
"expirationTime": "12345",
"labels": {"a-label": "a-value"},
},
["expires"],
{"expirationTime": "12345"},
),
(
{
"friendlyName": "hello",
"description": "world",
"expirationTime": None,
"labels": {"a-label": "a-value"},
},
["expires"],
{"expirationTime": None},
),
(
{
"friendlyName": "hello",
"description": "world",
"expirationTime": None,
"labels": {"a-label": "a-value"},
},
["labels"],
{"labels": {"a-label": "a-value"}},
),
(
{
"friendlyName": "hello",
"description": "world",
"expirationTime": None,
"labels": {"a-label": "a-value"},
"encryptionConfiguration": {"kmsKeyName": KMS_KEY_NAME},
},
["encryptionConfiguration"],
{"encryptionConfiguration": {"kmsKeyName": KMS_KEY_NAME}},
),
],
)
def test_build_resource(object_under_test, resource, filter_fields, expected):
object_under_test._properties = resource
got = object_under_test._build_resource(filter_fields)
assert got == expected
def test_set_description(object_under_test):
assert not object_under_test.description
object_under_test.description = "A model description."
assert object_under_test.description == "A model description."
object_under_test.description = None
assert not object_under_test.description
def test_set_expires(object_under_test):
assert not object_under_test.expires
expiration_time = datetime.datetime(
2012, 12, 21, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)
object_under_test.expires = expiration_time
assert object_under_test.expires == expiration_time
object_under_test.expires = None
assert not object_under_test.expires
def test_set_friendly_name(object_under_test):
assert not object_under_test.friendly_name
object_under_test.friendly_name = "A model name."
assert object_under_test.friendly_name == "A model name."
object_under_test.friendly_name = None
assert not object_under_test.friendly_name
def test_set_labels(object_under_test):
assert object_under_test.labels == {}
object_under_test.labels["data_owner"] = "someteam"
assert object_under_test.labels == {"data_owner": "someteam"}
del object_under_test.labels["data_owner"]
assert object_under_test.labels == {}
def test_replace_labels(object_under_test):
assert object_under_test.labels == {}
object_under_test.labels = {"data_owner": "someteam"}
assert object_under_test.labels == {"data_owner": "someteam"}
labels = {}
object_under_test.labels = labels
assert object_under_test.labels is labels
object_under_test.labels = None
assert object_under_test.labels == {}
def test_set_encryption_configuration(object_under_test):
from google.cloud.bigquery.encryption_configuration import EncryptionConfiguration
assert not object_under_test.encryption_configuration
object_under_test.encryption_configuration = EncryptionConfiguration(
kms_key_name=KMS_KEY_NAME
)
assert object_under_test.encryption_configuration.kms_key_name == KMS_KEY_NAME
object_under_test.encryption_configuration = None
assert not object_under_test.encryption_configuration
def test_repr(target_class):
model = target_class("my-proj.my_dset.my_model")
got = repr(model)
assert got == (
"Model(reference=ModelReference("
"project_id='my-proj', dataset_id='my_dset', model_id='my_model'))"
)