-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathtest_domain.py
More file actions
390 lines (331 loc) · 11.2 KB
/
test_domain.py
File metadata and controls
390 lines (331 loc) · 11.2 KB
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
#
# Copyright (c) 2018 LabKey Corporation
#
# 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 json
import os
import tempfile
import pytest
from labkey.domain import (
create,
conditional_format,
Domain,
drop,
encode_conditional_format_filter,
get,
infer_fields,
save,
)
from labkey.exceptions import RequestAuthorizationError
from labkey.query import QueryFilter
from .utilities import (
MockLabKey,
mock_server_context,
success_test,
success_test_get,
throws_error_test,
throws_error_test_get,
)
domain_controller = "property"
@pytest.fixture
def create_setup():
domain_definition = {
"kind": "IntList",
"domainDesign": {
"name": "TheTestList",
"fields": [{"name": "theKey", "rangeURI": "int"}],
},
"options": {"keyName": "theKey"},
}
class MockCreate(MockLabKey):
api = "createDomain.api"
default_action = domain_controller
default_success_body = domain_definition
service = MockCreate()
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": json.dumps(domain_definition, sort_keys=True),
"headers": {"Content-Type": "application/json"},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), domain_definition]
return service, args, expected_kwargs
def test_create_success(create_setup):
service, args, expected_kwargs = create_setup
success_test(service.get_successful_response(), create, False, *args, **expected_kwargs)
def test_create_unauthorized(create_setup):
service, args, expected_kwargs = create_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
create,
*args,
**expected_kwargs,
)
@pytest.fixture
def drop_setup():
schema_name = "lists"
query_name = "TheTestList"
class MockDrop(MockLabKey):
api = "deleteDomain.api"
default_action = domain_controller
default_success_body = {}
service = MockDrop()
payload = {"schemaName": schema_name, "queryName": query_name}
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": json.dumps(payload, sort_keys=True),
"headers": {"Content-Type": "application/json"},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), schema_name, query_name]
return service, args, expected_kwargs
def test_drop_success(drop_setup):
service, args, expected_kwargs = drop_setup
success_test(service.get_successful_response(), drop, False, *args, **expected_kwargs)
def test_drop_unauthorized(drop_setup):
service, args, expected_kwargs = drop_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
drop,
*args,
**expected_kwargs,
)
@pytest.fixture
def get_setup():
schema_name = "lists"
query_name = "TheTestList"
class MockGet(MockLabKey):
api = "getDomain.api"
default_action = domain_controller
default_success_body = {}
service = MockGet()
expected_kwargs = {
"expected_args": [service.get_server_url()],
"headers": None,
"params": {"schemaName": schema_name, "queryName": query_name},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), schema_name, query_name]
return service, args, expected_kwargs
def test_get_success(get_setup):
service, args, expected_kwargs = get_setup
success_test_get(service.get_successful_response(), get, False, *args, **expected_kwargs)
def test_get_unauthorized(get_setup):
service, args, expected_kwargs = get_setup
throws_error_test_get(
RequestAuthorizationError,
service.get_unauthorized_response(),
get,
*args,
**expected_kwargs,
)
@pytest.fixture
def infer_fields_setup():
class MockInferFields(MockLabKey):
api = "inferDomain.api"
default_action = domain_controller
default_success_body = {}
service = MockInferFields()
fd, path = tempfile.mkstemp()
with os.fdopen(fd, "w") as tmp:
tmp.write("Name\tAge\nNick\t32\nBrian\t27\n")
# Re-open the file for reading in the test
file = open(path, "r")
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": None,
"files": {"inferfile": file},
"headers": None,
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), file]
yield service, args, expected_kwargs
file.close()
os.remove(path)
def test_infer_fields_success(infer_fields_setup):
service, args, expected_kwargs = infer_fields_setup
success_test(service.get_successful_response(), infer_fields, False, *args, **expected_kwargs)
def test_infer_fields_unauthorized(infer_fields_setup):
service, args, expected_kwargs = infer_fields_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
infer_fields,
*args,
**expected_kwargs,
)
@pytest.fixture
def save_setup():
domain = Domain(
**{
"container": "TestContainer",
"description": "A Test Domain",
"domain_id": 9823,
}
)
schema_name = "lists"
query_name = "TheTestList"
class MockSave(MockLabKey):
api = "saveDomain.api"
default_action = domain_controller
default_success_body = {}
service = MockSave()
payload = {
"domainDesign": domain.to_json(),
"queryName": query_name,
"schemaName": schema_name,
}
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": json.dumps(payload, sort_keys=True),
"headers": {"Content-Type": "application/json"},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), schema_name, query_name, domain]
return service, args, expected_kwargs
def test_save_success(save_setup):
service, args, expected_kwargs = save_setup
success_test(service.get_successful_response(), save, False, *args, **expected_kwargs)
def test_save_unauthorized(save_setup):
service, args, expected_kwargs = save_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
save,
*args,
**expected_kwargs,
)
@pytest.fixture
def conditional_format_create_setup():
domain_definition = {
"kind": "IntList",
"domainDesign": {
"name": "TheTestList_cf",
"fields": [
{
"name": "theKey",
"rangeURI": "int",
"conditionalFormats": [
{
"filter": encode_conditional_format_filter(QueryFilter("theKey", 500)),
"textColor": "f44e3b",
"backgroundColor": "fcba03",
"bold": True,
"italic": True,
"strikethrough": False,
}
],
}
],
},
}
class MockCreate(MockLabKey):
api = "createDomain.api"
default_action = domain_controller
default_success_body = domain_definition
service = MockCreate()
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": json.dumps(domain_definition, sort_keys=True),
"headers": {"Content-Type": "application/json"},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), domain_definition]
return service, args, expected_kwargs
def test_conditional_format_create_success(conditional_format_create_setup):
service, args, expected_kwargs = conditional_format_create_setup
success_test(service.get_successful_response(), create, False, *args, **expected_kwargs)
def test_conditional_format_create_unauthorized(conditional_format_create_setup):
service, args, expected_kwargs = conditional_format_create_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
create,
*args,
**expected_kwargs,
)
@pytest.fixture
def conditional_format_save_setup():
schema_name = "lists"
query_name = "TheTestList_cf"
test_domain = Domain(
**{
"container": "TestContainer",
"description": "A Test Domain",
"domain_id": 5314,
"fields": [{"name": "theKey", "rangeURI": "int"}],
}
)
test_domain.fields[0].conditional_formats = [
# create conditional format using our utility for a QueryFilter
conditional_format(
background_color="fcba03",
bold=True,
italic=True,
query_filter=QueryFilter("theKey", 200),
strike_through=True,
text_color="f44e3b",
),
# create conditional format using our utility for a QueryFilter list
conditional_format(
background_color="fcba03",
bold=True,
italic=True,
query_filter=[
QueryFilter("theKey", 500, QueryFilter.Types.GREATER_THAN),
QueryFilter("theKey", 1000, QueryFilter.Types.LESS_THAN),
],
strike_through=True,
text_color="f44e3b",
),
]
class MockSave(MockLabKey):
api = "saveDomain.api"
default_action = domain_controller
default_success_body = {}
service = MockSave()
payload = {
"domainDesign": test_domain.to_json(),
"queryName": query_name,
"schemaName": schema_name,
}
expected_kwargs = {
"expected_args": [service.get_server_url()],
"data": json.dumps(payload, sort_keys=True),
"headers": {"Content-Type": "application/json"},
"timeout": 300,
"allow_redirects": False,
}
args = [mock_server_context(service), schema_name, query_name, test_domain]
return service, args, expected_kwargs
def test_conditional_format_save_success(conditional_format_save_setup):
service, args, expected_kwargs = conditional_format_save_setup
success_test(service.get_successful_response(), save, True, *args, **expected_kwargs)
def test_conditional_format_save_unauthorized(conditional_format_save_setup):
service, args, expected_kwargs = conditional_format_save_setup
throws_error_test(
RequestAuthorizationError,
service.get_unauthorized_response(),
save,
*args,
**expected_kwargs,
)