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
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import os
import pytest
import functools
from devtools_testutils import AzureRecordedTestCase
from azure.core.exceptions import ResourceNotFoundError
from azure.iot.modelsrepository import (
ModelsRepositoryClient,
DEPENDENCY_MODE_ENABLED,
DEPENDENCY_MODE_DISABLED,
DEPENDENCY_MODE_TRY_FROM_EXPANDED,
ModelError,
)
from azure.iot.modelsrepository._resolver import HttpFetcher
pytestmark = pytest.mark.usefixtures("recorded_test")
LOCAL_REPO = "Local Repository"
REMOTE_REPO = "Remote Repository"
@pytest.fixture(params=[REMOTE_REPO, LOCAL_REPO], autouse=True)
def client_type(request):
return request.param
@pytest.fixture
def client(client_type):
if client_type == REMOTE_REPO:
client = ModelsRepositoryClient()
elif client_type == LOCAL_REPO:
test_dir = os.path.dirname(os.path.abspath(__file__))
local_repo = os.path.join(test_dir, "local_repository")
client = ModelsRepositoryClient(repository_location=local_repo)
else:
raise Exception("Bad fixture")
yield client
client.close()
def skip_remote(test_fn):
"""This decorator can be added to a test function to skip it for remote clients if
insufficent data exists on the remote test repository"""
@functools.wraps(test_fn)
def wrapper(*args, **kwargs):
# A bit of a hack - since we can't easily access the client_type fixture here,
# instead check the type of the client's fetcher. HttpFetcher means remote.
client = kwargs["client"]
if type(client.fetcher) is HttpFetcher:
return pytest.skip("Insufficient test data")
else:
return test_fn(*args, **kwargs)
return wrapper
@pytest.mark.describe(".get_models() - Dependency Mode: Enabled")
class TestGetModelsDependencyModeEnabled(AzureRecordedTestCase):
@pytest.mark.parametrize("dtmi", [
pytest.param("dtmi:com:example:Thermostat:1", id="No semicolon"),
pytest.param("dtmi:com:example::Thermostat;1", id="Double colon"),
pytest.param("com:example:Thermostat;1", id="No DTMI prefix"),
])
def test_invalid_dtmi_format(self, client, dtmi):
with pytest.raises(ValueError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
def test_dtmi_mismatch_casing(self, client):
dtmi = "dtmi:com:example:thermostat;1"
with pytest.raises(ModelError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
def test_nonexistant_dtdl_doc(self, client):
dtmi = "dtmi:com:example:thermojax;999"
with pytest.raises(ResourceNotFoundError):
client.get_models(dtmi)
def test_nonexistent_dependency_dtdl_doc(self, client):
dtmi = "dtmi:com:example:invalidmodel;1"
with pytest.raises(ResourceNotFoundError):
client.get_models(dtmi)
def test_single_dtmi_no_components_no_extends(self, client):
dtmi = "dtmi:com:example:Thermostat;1"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
def test_multiple_dtmis_no_components_no_extends(self, client):
dtmi1 = "dtmi:com:example:Thermostat;1"
dtmi2 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
model_map = client.get_models(
[dtmi1, dtmi2], dependency_resolution=DEPENDENCY_MODE_ENABLED
)
assert len(model_map) == 2
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model1 = model_map[dtmi1]
model2 = model_map[dtmi2]
assert model1["@id"] == dtmi1
assert model2["@id"] == dtmi2
def test_single_dtmi_with_component_deps(self, client):
root_dtmi = "dtmi:com:example:TemperatureController;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
]
expected_dtmis = [root_dtmi] + expected_deps
model_map = client.get_models(root_dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_multiple_dtmis_with_component_deps(self, client):
root_dtmi1 = "dtmi:com:example:Phone;2"
root_dtmi2 = "dtmi:com:example:TemperatureController;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:azure:DeviceManagement:DeviceInformation;2",
"dtmi:com:example:Camera;3",
]
expected_dtmis = [root_dtmi1, root_dtmi2] + expected_deps
model_map = client.get_models(
[root_dtmi1, root_dtmi2], dependency_resolution=DEPENDENCY_MODE_ENABLED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_multiple_dtmis_with_extends_deps_single_dtmi(self, client, client_type):
root_dtmi1 = "dtmi:com:example:TemperatureController;1"
root_dtmi2 = "dtmi:com:example:ConferenceRoom;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:com:example:Room;1",
]
expected_dtmis = [root_dtmi1, root_dtmi2] + expected_deps
model_map = client.get_models(
[root_dtmi1, root_dtmi2], dependency_resolution=DEPENDENCY_MODE_ENABLED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_multiple_dtmis_with_extends_deps_multiple_dtmi(self, client):
root_dtmi1 = "dtmi:com:example:TemperatureController;1"
root_dtmi2 = "dtmi:com:example:ColdStorage;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:com:example:Room;1",
"dtmi:com:example:Freezer;1",
]
expected_dtmis = [root_dtmi1, root_dtmi2] + expected_deps
model_map = client.get_models(
[root_dtmi1, root_dtmi2], dependency_resolution=DEPENDENCY_MODE_ENABLED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_single_dtmi_with_extends_single_model_inline(self, client, client_type):
dtmi = "dtmi:com:example:base;1"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_single_dtmi_with_extends_mixed_inline_and_dtmi(self, client, client_type):
root_dtmi = "dtmi:com:example:base;2"
expected_deps = ["dtmi:com:example:Freezer;1", "dtmi:com:example:Thermostat;1"]
expected_dtmis = [root_dtmi] + expected_deps
model_map = client.get_models(root_dtmi, dependency_resolution=DEPENDENCY_MODE_ENABLED)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
def test_duplicate_dtmi(self, client):
dtmi1 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
dtmi2 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
model_map = client.get_models(
[dtmi1, dtmi1], dependency_resolution=DEPENDENCY_MODE_ENABLED
)
assert len(model_map) == 1
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model = model_map[dtmi1]
assert model["@id"] == dtmi1 == dtmi2
@pytest.mark.describe(".get_models() - Dependency Mode: Disabled")
class TestGetModelsDependencyModeDisabled(AzureRecordedTestCase):
@pytest.mark.parametrize("dtmi", [
pytest.param("dtmi:com:example:Thermostat:1", id="No semicolon"),
pytest.param("dtmi:com:example::Thermostat;1", id="Double colon"),
pytest.param("com:example:Thermostat;1", id="No DTMI prefix"),
])
def test_invalid_dtmi_format(self, client, dtmi):
with pytest.raises(ValueError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
def test_dtmi_mismatch_casing(self, client):
dtmi = "dtmi:com:example:thermostat;1"
with pytest.raises(ModelError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
def test_nonexistant_dtdl_doc(self, client):
dtmi = "dtmi:com:example:thermojax;999"
with pytest.raises(ResourceNotFoundError):
client.get_models(dtmi)
def test_nonexistent_dependency_dtdl_doc(self, client):
dtmi = "dtmi:com:example:invalidmodel;1"
with pytest.raises(ResourceNotFoundError):
client.get_models(dtmi)
def test_single_dtmi_no_components_no_extends(self, client):
dtmi = "dtmi:com:example:Thermostat;1"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
def test_multiple_dtmis_no_components_no_extends(self, client):
dtmi1 = "dtmi:com:example:Thermostat;1"
dtmi2 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
model_map = client.get_models(
[dtmi1, dtmi2], dependency_resolution=DEPENDENCY_MODE_DISABLED
)
assert len(model_map) == 2
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model1 = model_map[dtmi1]
model2 = model_map[dtmi2]
assert model1["@id"] == dtmi1
assert model2["@id"] == dtmi2
def test_single_dtmi_with_component_deps(self, client):
dtmi = "dtmi:com:example:TemperatureController;1"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_multiple_dtmis_with_component_deps(self, client):
dtmi1 = "dtmi:com:example:Phone;2"
dtmi2 = "dtmi:com:example:TemperatureController;1"
model_map = client.get_models(
[dtmi1, dtmi2], dependency_resolution=DEPENDENCY_MODE_DISABLED
)
assert len(model_map) == 2
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model1 = model_map[dtmi1]
model2 = model_map[dtmi2]
assert model1["@id"] == dtmi1
assert model2["@id"] == dtmi2
@skip_remote
def test_multiple_dtmis_with_extends_deps_single_dtmi(self, client):
dtmi1 = "dtmi:com:example:TemperatureController;1"
dtmi2 = "dtmi:com:example:ConferenceRoom;1"
model_map = client.get_models(
[dtmi1, dtmi2], dependency_resolution=DEPENDENCY_MODE_DISABLED
)
assert len(model_map) == 2
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model1 = model_map[dtmi1]
model2 = model_map[dtmi2]
assert model1["@id"] == dtmi1
assert model2["@id"] == dtmi2
@skip_remote
def test_multiple_dtmis_with_extends_deps_multiple_dtmi(self, client):
dtmi1 = "dtmi:com:example:TemperatureController;1"
dtmi2 = "dtmi:com:example:ColdStorage;1"
model_map = client.get_models(
[dtmi1, dtmi2], dependency_resolution=DEPENDENCY_MODE_DISABLED
)
assert len(model_map) == 2
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model1 = model_map[dtmi1]
model2 = model_map[dtmi2]
assert model1["@id"] == dtmi1
assert model2["@id"] == dtmi2
@skip_remote
def test_single_dtmi_with_extends_single_model_inline(self, client):
dtmi = "dtmi:com:example:base;1"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_single_dtmi_with_extends_mixed_inline_and_dtmi(self, client):
dtmi = "dtmi:com:example:base;2"
model_map = client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_DISABLED)
assert len(model_map) == 1
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
def test_duplicate_dtmi(self, client):
dtmi1 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
dtmi2 = "dtmi:azure:DeviceManagement:DeviceInformation;1"
model_map = client.get_models(
[dtmi1, dtmi1], dependency_resolution=DEPENDENCY_MODE_DISABLED
)
assert len(model_map) == 1
assert dtmi1 in model_map.keys()
assert dtmi2 in model_map.keys()
model = model_map[dtmi1]
assert model["@id"] == dtmi1 == dtmi2
@pytest.mark.describe(".get_models() - Dependency Mode: Try From Expanded")
class TestGetModelsDependencyModeTryFromExpanded(AzureRecordedTestCase):
@pytest.mark.parametrize("dtmi", [
pytest.param("dtmi:com:example:Thermostat:1", id="No semicolon"),
pytest.param("dtmi:com:example::Thermostat;1", id="Double colon"),
pytest.param("com:example:Thermostat;1", id="No DTMI prefix"),
])
def test_invalid_dtmi_format(self, dtmi, client):
with pytest.raises(ValueError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED)
def test_dtmi_mismatch_casing(self, client):
dtmi = "dtmi:com:example:thermostat;1"
with pytest.raises(ModelError):
client.get_models(dtmi, dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED)
def test_nonexistant_dtdl_doc(self, client):
dtmi = "dtmi:com:example:thermojax;999"
with pytest.raises(ResourceNotFoundError):
client.get_models(dtmi)
def test_single_dtmi_with_component_deps_expanded_json(self, client):
root_dtmi = "dtmi:com:example:TemperatureController;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
]
expected_dtmis = [root_dtmi] + expected_deps
model_map = client.get_models(
root_dtmi, dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_single_dtmi_with_component_deps_no_expanded_json(self, client):
# this tests the fallback procedure when no expanded doc exists
root_dtmi = "dtmi:com:example:Phone;2"
expected_deps = [
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:azure:DeviceManagement:DeviceInformation;2",
"dtmi:com:example:Camera;3",
]
expected_dtmis = [root_dtmi] + expected_deps
model_map = client.get_models(
root_dtmi, dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_multiple_dtmis_with_component_deps_no_expanded_json(self, client):
# this tests the fallback procedure when no expanded doc exists
root_dtmi1 = "dtmi:com:example:Phone;2"
root_dtmi2 = "dtmi:com:example:Freezer;1"
expected_deps = [
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:azure:DeviceManagement:DeviceInformation;2",
"dtmi:com:example:Camera;3",
"dtmi:com:example:Thermostat;1",
]
expected_dtmis = [root_dtmi1, root_dtmi2] + expected_deps
model_map = client.get_models(
[root_dtmi1, root_dtmi2], dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_dtmis_component_deps_extends_deps_mixed_expanded_json(self, client):
root_dtmi1 = "dtmi:com:example:ColdStorage;1" # no expanded doc
root_dtmi2 = "dtmi:com:example:TemperatureController;1" # has expanded doc
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
"dtmi:com:example:Room;1",
"dtmi:com:example:Freezer;1",
]
expected_dtmis = [root_dtmi1, root_dtmi2] + expected_deps
model_map = client.get_models(
[root_dtmi1, root_dtmi2], dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
@skip_remote
def test_dangling_expanded(self, client):
root_dtmi = "dtmi:com:example:DanglingExpanded;1"
expected_deps = [
"dtmi:com:example:Thermostat;1",
"dtmi:azure:DeviceManagement:DeviceInformation;1",
]
expected_dtmis = [root_dtmi] + expected_deps
model_map = client.get_models(
root_dtmi, dependency_resolution=DEPENDENCY_MODE_TRY_FROM_EXPANDED
)
assert len(model_map) == len(expected_dtmis)
for dtmi in expected_dtmis:
assert dtmi in model_map.keys()
model = model_map[dtmi]
assert model["@id"] == dtmi
|
