File: test_enrollment_groups_async.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (319 lines) | stat: -rw-r--r-- 12,460 bytes parent folder | download
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
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
from conftest import (
    API_VERSION,
    CUSTOM_ALLOCATION,
    REPROVISION_MIGRATE,
    WEBHOOK_URL,
    ProvisioningServicePreparer,
)
from devtools_testutils import AzureRecordedTestCase
from devtools_testutils.aio import recorded_by_proxy_async
from utility.common import create_test_cert, generate_enrollment_group, generate_key


class TestEnrollmentGroups(AzureRecordedTestCase):
    def create_provisioning_service_client(self, endpoint):
        credential = self.get_credential(DeviceProvisioningClient, is_async=True)
        client = DeviceProvisioningClient(endpoint=endpoint, credential=credential)
        return client

    @ProvisioningServicePreparer()
    @recorded_by_proxy_async
    async def test_enrollment_group_x509_lifecycle(
        self, iothub_dps_endpoint
    ):
        client = self.create_provisioning_service_client(
            iothub_dps_endpoint
        )
        enrollment_group_id = self.create_random_name("x509_enroll_grp_")
        attestation_type = "x509"

        cert_name = self.create_random_name("enroll_cert_")
        cert = create_test_cert(subject=cert_name)
        cert_contents = cert["certificate"]
        thumb = cert["thumbprint"]

        enrollment_group = generate_enrollment_group(
            id=enrollment_group_id,
            primary_cert=cert_contents,
            secondary_cert=cert_contents,
            provisioning_status="enabled",
            allocation_policy="hashed",
            attestation_type=attestation_type,
            reprovision_policy=REPROVISION_MIGRATE,
        )
        enrollment_group_response = await client.enrollment_group.create_or_update(
            id=enrollment_group_id,
            enrollment_group=enrollment_group,
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id

        # check auth
        assert enrollment_group_response["attestation"]["x509"]
        assert enrollment_group_response["attestation"]["type"] == "x509"
        assert (
            enrollment_group_response["attestation"]["x509"]["signingCertificates"][
                "primary"
            ]["info"]["subjectName"]
            == f"CN={cert_name}"
        )
        if self.is_live:
            assert (
                enrollment_group_response["attestation"]["x509"]["signingCertificates"][
                    "primary"
                ]["info"]["sha256Thumbprint"]
                == thumb
            )

        assert enrollment_group_response["provisioningStatus"] == "enabled"
        assert enrollment_group_response["allocationPolicy"] == "hashed"
        assert enrollment_group_response["reprovisionPolicy"]["migrateDeviceData"]
        assert enrollment_group_response["reprovisionPolicy"]["updateHubAssignment"]

        # check for enrollment in query response
        enrollment_group_list = await client.enrollment_group.query(
            query_specification={"query": "SELECT *"}
        )
        enrollments = [eg async for eg in enrollment_group_list]
        assert len(enrollments) == 1
        assert enrollments[0]["enrollmentGroupId"] == enrollment_group_id

        # check enrollment get
        enrollment_group_response = await client.enrollment_group.get(
            id=enrollment_group_id
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id

        # check enrollment update
        enrollment_group["provisioningStatus"] = "disabled"
        enrollment_group["allocationPolicy"] = "custom"
        enrollment_group["customAllocationDefinition"] = CUSTOM_ALLOCATION
        enrollment_group_response = await client.enrollment_group.create_or_update(
            id=enrollment_group_id,
            enrollment_group=enrollment_group,
            if_match=enrollment_group_response["etag"],
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id
        assert enrollment_group_response["provisioningStatus"] == "disabled"
        assert (
            enrollment_group_response["customAllocationDefinition"]["webhookUrl"]
            == WEBHOOK_URL
        )
        assert (
            enrollment_group_response["customAllocationDefinition"]["apiVersion"]
            == API_VERSION
        )

        # delete enrollment
        await client.enrollment_group.delete(id=enrollment_group_id)

        # ensure deletion
        enrollment_group_list = await client.enrollment_group.query(
            query_specification={"query": "SELECT *"}
        )
        assert len([eg async for eg in enrollment_group_list]) == 0

    @ProvisioningServicePreparer()
    @recorded_by_proxy_async
    async def test_enrollment_group_symmetrickey_lifecycle(
        self, iothub_dps_endpoint
    ):
        client = self.create_provisioning_service_client(
            iothub_dps_endpoint
        )
        attestation_type = "symmetricKey"
        enrollment_group_id = self.create_random_name("sym_enroll_grp_")
        primary_key = generate_key()
        secondary_key = generate_key()
        allocation_policy = "geoLatency"
        reprovision_policy = REPROVISION_MIGRATE
        enrollment_group = generate_enrollment_group(
            id=enrollment_group_id,
            allocation_policy=allocation_policy,
            reprovision_policy=reprovision_policy,
            attestation_type=attestation_type,
            primary_key=primary_key,
            secondary_key=secondary_key,
        )

        enrollment_group_id2 = self.create_random_name("sym_enroll_grp2_")

        # Use provided keys
        enrollment_group_response = await client.enrollment_group.create_or_update(
            id=enrollment_group_id, enrollment_group=enrollment_group
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id
        assert enrollment_group_response["attestation"]["symmetricKey"]

        if self.is_live:
            assert (
                enrollment_group_response["attestation"]["symmetricKey"]["primaryKey"]
                == primary_key
            )
            assert (
                enrollment_group_response["attestation"]["symmetricKey"]["secondaryKey"]
                == secondary_key
            )
        # reprovision migrate true
        assert enrollment_group_response["reprovisionPolicy"]["migrateDeviceData"]
        # reprovision update true
        assert enrollment_group_response["reprovisionPolicy"]["updateHubAssignment"]

        # check for enrollment in query response
        enrollment_group_list = await client.enrollment_group.query(
            query_specification={"query": "SELECT *"}
        )
        enrollment_groups = [eg async for eg in enrollment_group_list]
        assert len(enrollment_groups) == 1
        assert enrollment_groups[0]["enrollmentGroupId"] == enrollment_group_id

        # check enrollment get
        enrollment_group_response = await client.enrollment_group.get(
            id=enrollment_group_id
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id

        # check attestation
        attestation_response = await client.enrollment_group.get_attestation_mechanism(
            id=enrollment_group_id
        )
        if self.is_live:
            assert attestation_response["symmetricKey"]["primaryKey"] == primary_key
            assert attestation_response["symmetricKey"]["secondaryKey"] == secondary_key

        # check enrollment update
        enrollment_group["provisioningStatus"] = "disabled"
        enrollment_group["allocationPolicy"] = "custom"
        enrollment_group["customAllocationDefinition"] = CUSTOM_ALLOCATION
        enrollment_group_response = await client.enrollment_group.create_or_update(
            id=enrollment_group_id,
            enrollment_group=enrollment_group,
            if_match=enrollment_group_response["etag"],
        )

        assert enrollment_group_response["enrollmentGroupId"] == enrollment_group_id
        assert enrollment_group_response["provisioningStatus"] == "disabled"
        assert (
            enrollment_group_response["customAllocationDefinition"]["webhookUrl"]
            == WEBHOOK_URL
        )
        assert (
            enrollment_group_response["customAllocationDefinition"]["apiVersion"]
            == API_VERSION
        )

        # reprovision migrate true
        assert enrollment_group_response["reprovisionPolicy"]["migrateDeviceData"]
        # reprovision update true
        assert enrollment_group_response["reprovisionPolicy"]["updateHubAssignment"]

        # second enrollment
        enrollment_group2 = generate_enrollment_group(
            id=enrollment_group_id2,
            attestation_type=attestation_type,
            allocation_policy="custom",
            webhook_url=WEBHOOK_URL,
            api_version=API_VERSION,
        )
        enrollment_group_2 = await client.enrollment_group.create_or_update(
            id=enrollment_group_id2, enrollment_group=enrollment_group2
        )

        assert enrollment_group_2

        # check both enrollments
        enrollment_group_list = await client.enrollment_group.query(
            query_specification={"query": "SELECT *"}
        )
        enrollment_groups = [eg async for eg in enrollment_group_list]
        assert len(enrollment_groups) == 2
        assert enrollment_group_id in [
            e["enrollmentGroupId"] for e in enrollment_groups
        ]
        assert enrollment_group_id2 in [
            e["enrollmentGroupId"] for e in enrollment_groups
        ]

        # delete both enrollments
        await client.enrollment_group.delete(id=enrollment_group_id)
        await client.enrollment_group.delete(id=enrollment_group_id2)

        # ensure deletion
        enrollment_group_list = await client.enrollment_group.query(
            query_specification={"query": "SELECT *"}
        )
        assert len([eg async for eg in enrollment_group_list]) == 0

    @ProvisioningServicePreparer()
    @recorded_by_proxy_async
    async def test_enrollment_group_bulk_operations(
        self, iothub_dps_endpoint
    ):
        client = self.create_provisioning_service_client(
            iothub_dps_endpoint
        )
        eg1_id = self.create_random_name("x509_enroll_grp_")
        attestation_type = "x509"

        cert_name = self.create_random_name("enroll_cert_")
        cert = create_test_cert(subject=cert_name)
        cert_contents = cert["certificate"]

        eg1 = generate_enrollment_group(
            id=eg1_id,
            primary_cert=cert_contents,
            secondary_cert=cert_contents,
            provisioning_status="enabled",
            allocation_policy="hashed",
            attestation_type=attestation_type,
            reprovision_policy=REPROVISION_MIGRATE,
        )

        attestation_type = "symmetricKey"
        eg2_id = self.create_random_name("sym_key_enroll_grp_")
        primary_key = generate_key()
        secondary_key = generate_key()
        allocation_policy = "geoLatency"
        reprovision_policy = REPROVISION_MIGRATE
        eg2 = generate_enrollment_group(
            id=eg2_id,
            allocation_policy=allocation_policy,
            reprovision_policy=reprovision_policy,
            attestation_type=attestation_type,
            primary_key=primary_key,
            secondary_key=secondary_key,
        )

        bulk_enrollment_operation = {
            "enrollmentGroups": [eg1, eg2],
            "mode": "create",
        }

        bulk_enrollment_response = await client.enrollment_group.run_bulk_operation(
            bulk_operation=bulk_enrollment_operation
        )
        assert bulk_enrollment_response

        bulk_enrollment_operation["enrollmentGroups"][0][
            "provisioningStatus"
        ] == "disabled"
        bulk_enrollment_operation["enrollmentGroups"][1][
            "provisioningStatus"
        ] == "disabled"
        bulk_enrollment_operation["mode"] = "update"

        bulk_enrollment_response = await client.enrollment_group.run_bulk_operation(
            bulk_operation=bulk_enrollment_operation
        )
        assert bulk_enrollment_response

        bulk_enrollment_operation["mode"] = "delete"
        bulk_enrollment_response = await client.enrollment_group.run_bulk_operation(
            bulk_operation=bulk_enrollment_operation
        )
        assert bulk_enrollment_response