-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathtest_async_model_targets.py
More file actions
409 lines (355 loc) · 13.8 KB
/
Copy pathtest_async_model_targets.py
File metadata and controls
409 lines (355 loc) · 13.8 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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
"""Tests for the async Model Target Web API client."""
import io
import json
import uuid
import zipfile
from http import HTTPStatus
import pytest
from mock_vws import (
MockVWS,
ModelTargetGenerationFailure,
ModelTargetGenerationWarning,
)
from vws import AsyncModelTargetService
from vws.exceptions.model_target_exceptions import (
ModelTargetDatasetNotDoneError,
ModelTargetDatasetTimeoutError,
ModelTargetOAuth2Error,
ModelTargetValidationError,
UnknownModelTargetDatasetError,
)
from vws.model_target_datasets import (
CadDataFormat,
ModelTargetDatasetType,
ModelTargetModel,
RealisticAppearance,
)
from vws.reports import ModelTargetDatasetStatuses
# The mock accepts one hard-coded pair of Model Target Web API OAuth2
# credentials, which it does not expose.
_CLIENT_ID = "client-id"
_CLIENT_SECRET = "client-secret" # noqa: S105
_DATASET_TYPES = [
ModelTargetDatasetType.STANDARD,
ModelTargetDatasetType.ADVANCED,
]
class TestAccessToken:
"""Tests for getting an access token."""
@staticmethod
@pytest.mark.asyncio
async def test_token_is_a_bearer_token(
*,
async_model_target_client: AsyncModelTargetService,
) -> None:
"""An access token is given for valid credentials."""
assert await async_model_target_client.get_access_token()
@staticmethod
@pytest.mark.asyncio
@pytest.mark.usefixtures("_mock_model_targets")
async def test_invalid_credentials() -> None:
"""An exception is raised when the credentials are not known."""
async with AsyncModelTargetService(
client_id="not-a-client-id",
client_secret="not-a-client-secret", # noqa: S106
) as client:
with pytest.raises(
expected_exception=ModelTargetOAuth2Error,
) as exc:
await client.get_access_token()
assert exc.value.response.status_code == HTTPStatus.UNAUTHORIZED
assert exc.value.error == "invalid_client"
class TestDatasetLifecycle:
"""Tests for the dataset lifecycle."""
@staticmethod
@pytest.mark.asyncio
@pytest.mark.parametrize(
argnames="dataset_type",
argvalues=_DATASET_TYPES,
)
async def test_create_wait_download_delete(
*,
async_model_target_client: AsyncModelTargetService,
model_target_model: ModelTargetModel,
dataset_type: ModelTargetDatasetType,
) -> None:
"""A dataset can be created, downloaded and then deleted."""
dataset_uuid = await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=dataset_type,
)
report = await async_model_target_client.wait_for_dataset_generated(
dataset_uuid=dataset_uuid,
dataset_type=dataset_type,
)
assert report.status == ModelTargetDatasetStatuses.DONE
assert report.dataset_uuid == dataset_uuid
assert report.completed_at is not None
assert report.eta is None
assert report.error is None
assert report.warning is None
dataset = await async_model_target_client.download_dataset(
dataset_uuid=dataset_uuid,
dataset_type=dataset_type,
)
with zipfile.ZipFile(
file=io.BytesIO(initial_bytes=dataset)
) as archive:
dataset_json = json.loads(s=archive.read(name="dataset.json"))
assert dataset_json["uuid"] == dataset_uuid
assert dataset_json["type"] == dataset_type.value
await async_model_target_client.delete_dataset(
dataset_uuid=dataset_uuid,
dataset_type=dataset_type,
)
with pytest.raises(expected_exception=UnknownModelTargetDatasetError):
await async_model_target_client.get_dataset_status(
dataset_uuid=dataset_uuid,
dataset_type=dataset_type,
)
@staticmethod
@pytest.mark.asyncio
async def test_status_while_processing(
*,
async_model_target_client: AsyncModelTargetService,
model_target_model: ModelTargetModel,
) -> None:
"""A processing dataset has an estimated completion time."""
dataset_uuid = await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.STANDARD,
)
report = await async_model_target_client.get_dataset_status(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert report.status == ModelTargetDatasetStatuses.PROCESSING
assert report.eta is not None
assert report.completed_at is None
@staticmethod
@pytest.mark.asyncio
async def test_download_while_processing(
*,
async_model_target_client: AsyncModelTargetService,
model_target_model: ModelTargetModel,
) -> None:
"""A dataset cannot be downloaded before it is generated."""
dataset_uuid = await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.STANDARD,
)
with pytest.raises(
expected_exception=ModelTargetDatasetNotDoneError,
) as exc:
await async_model_target_client.download_dataset(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert (
exc.value.response.status_code == HTTPStatus.UNPROCESSABLE_ENTITY
)
assert exc.value.code == "UNSUPPORTED_STATE"
@staticmethod
@pytest.mark.asyncio
async def test_dataset_types_are_separate(
*,
async_model_target_client: AsyncModelTargetService,
model_target_model: ModelTargetModel,
) -> None:
"""A dataset is not visible to requests for the other type."""
dataset_uuid = await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.ADVANCED,
)
with pytest.raises(expected_exception=UnknownModelTargetDatasetError):
await async_model_target_client.get_dataset_status(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
@staticmethod
@pytest.mark.asyncio
async def test_advanced_dataset_takes_multiple_models(
*,
async_model_target_client: AsyncModelTargetService,
model_target_model: ModelTargetModel,
) -> None:
"""An advanced dataset can be generated from multiple models."""
other_model = ModelTargetModel(
name="other-model",
cad_data_blob="ZmFrZS1jYWQtZGF0YQ==",
cad_data_format=CadDataFormat.GLB,
realistic_appearance=RealisticAppearance.TRUE,
)
assert await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model, other_model],
dataset_type=ModelTargetDatasetType.ADVANCED,
)
class TestUnknownDataset:
"""Tests for requests for datasets which do not exist."""
@staticmethod
@pytest.mark.asyncio
async def test_get_status(
*,
async_model_target_client: AsyncModelTargetService,
) -> None:
"""An exception is raised for an unknown dataset."""
dataset_uuid = uuid.uuid4().hex
with pytest.raises(
expected_exception=UnknownModelTargetDatasetError,
) as exc:
await async_model_target_client.get_dataset_status(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert exc.value.response.status_code == HTTPStatus.NOT_FOUND
assert dataset_uuid in exc.value.message
@staticmethod
@pytest.mark.asyncio
async def test_download(
*,
async_model_target_client: AsyncModelTargetService,
) -> None:
"""An exception is raised for an unknown dataset."""
with pytest.raises(expected_exception=UnknownModelTargetDatasetError):
await async_model_target_client.download_dataset(
dataset_uuid=uuid.uuid4().hex,
dataset_type=ModelTargetDatasetType.STANDARD,
)
@staticmethod
@pytest.mark.asyncio
async def test_delete(
*,
async_model_target_client: AsyncModelTargetService,
) -> None:
"""An exception is raised for an unknown dataset."""
with pytest.raises(expected_exception=UnknownModelTargetDatasetError):
await async_model_target_client.delete_dataset(
dataset_uuid=uuid.uuid4().hex,
dataset_type=ModelTargetDatasetType.STANDARD,
)
class TestValidation:
"""Tests for requests which Vuforia rejects."""
@staticmethod
@pytest.mark.asyncio
async def test_no_cad_data(
*,
async_model_target_client: AsyncModelTargetService,
) -> None:
"""A model needs exactly one CAD data source."""
with pytest.raises(
expected_exception=ModelTargetValidationError,
) as exc:
await async_model_target_client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[ModelTargetModel(name="model")],
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert exc.value.response.status_code == HTTPStatus.BAD_REQUEST
(detail,) = exc.value.details
assert detail.code == "VALIDATION_ERROR"
class TestGenerationResult:
"""Tests for datasets which Vuforia does not generate cleanly."""
@staticmethod
@pytest.mark.asyncio
async def test_generation_failure(
*,
model_target_model: ModelTargetModel,
) -> None:
"""A dataset which fails to generate reports the failure."""
message = "Model Target dataset generation failed"
failure = ModelTargetGenerationFailure(message=message)
with MockVWS(
processing_time_seconds=0.2,
model_target_generation_failure=failure,
):
async with AsyncModelTargetService(
client_id=_CLIENT_ID,
client_secret=_CLIENT_SECRET,
) as client:
dataset_uuid = await client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.STANDARD,
)
report = await client.wait_for_dataset_generated(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert report.status == ModelTargetDatasetStatuses.FAILED
assert report.error is not None
assert report.error.message == message
@staticmethod
@pytest.mark.asyncio
async def test_generation_warning(
*,
model_target_model: ModelTargetModel,
) -> None:
"""A dataset which generates with a warning reports the
warning.
"""
warning = ModelTargetGenerationWarning()
with MockVWS(
processing_time_seconds=0.2,
model_target_generation_warning=warning,
):
async with AsyncModelTargetService(
client_id=_CLIENT_ID,
client_secret=_CLIENT_SECRET,
) as client:
dataset_uuid = await client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.STANDARD,
)
report = await client.wait_for_dataset_generated(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert report.status == ModelTargetDatasetStatuses.DONE
assert report.warning is not None
assert report.warning.target == dataset_uuid
(detail,) = report.warning.details
assert detail.code == "LOW_RECOGNITION_QUALITY"
class TestWaitForDatasetGenerated:
"""Tests for waiting for a dataset to be generated."""
@staticmethod
@pytest.mark.asyncio
async def test_timeout(*, model_target_model: ModelTargetModel) -> None:
"""An exception is raised when the wait times out."""
with MockVWS(processing_time_seconds=60):
async with AsyncModelTargetService(
client_id=_CLIENT_ID,
client_secret=_CLIENT_SECRET,
) as client:
dataset_uuid = await client.create_dataset(
name="dataset",
target_sdk="11.0",
models=[model_target_model],
dataset_type=ModelTargetDatasetType.STANDARD,
)
with pytest.raises(
expected_exception=ModelTargetDatasetTimeoutError,
):
await client.wait_for_dataset_generated(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
seconds_between_requests=0.01,
timeout_seconds=0.05,
)
report = await client.get_dataset_status(
dataset_uuid=dataset_uuid,
dataset_type=ModelTargetDatasetType.STANDARD,
)
assert report.status == ModelTargetDatasetStatuses.PROCESSING