File: test_identifier_raw_id.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 (359 lines) | stat: -rw-r--r-- 17,824 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
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
# coding: utf-8
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------

import pytest
import unittest
from azure.communication.identity import *


class IdentifierRawIdTest(unittest.TestCase):
    def test_raw_id(self):
        _assert_raw_id(
            CommunicationUserIdentifier(
                id="8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
            "8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            CommunicationUserIdentifier(
                id="8:gcch-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
            "8:gcch-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(CommunicationUserIdentifier(id="someFutureFormat"), "someFutureFormat")
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130"),
            "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"),
            "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD"),
            "8:dod:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"),
            "8:gcch:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", is_anonymous=False),
            "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", is_anonymous=True),
            "8:teamsvisitor:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsUserIdentifier(
                user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
                raw_id="8:orgid:legacyFormat",
            ),
            "8:orgid:legacyFormat",
        )
        _assert_raw_id(
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130"),
            "28:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"),
            "28:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD"),
            "28:dod:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"),
            "28:gcch:45ab2481-1c1c-4005-be24-0ffb879b1130",
        )
        _assert_raw_id(PhoneNumberIdentifier(value="+112345556789"), "4:+112345556789")
        _assert_raw_id(PhoneNumberIdentifier(value="112345556789"), "4:112345556789")
        _assert_raw_id(
            PhoneNumberIdentifier(value="+112345556789", raw_id="4:otherFormat"),
            "4:otherFormat",
        )
        _assert_raw_id(
            PhoneNumberIdentifier(value="otherFormat", raw_id="4:207ffef6-9444-41fb-92ab-20eacaae2768"),
            "4:207ffef6-9444-41fb-92ab-20eacaae2768",
        )
        # cspell:disable
        _assert_raw_id(
            PhoneNumberIdentifier(
                value="otherFormat",
                raw_id="4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
            ),
            "4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
        )
        _assert_raw_id(
            PhoneNumberIdentifier(
                value="otherFormat",
                raw_id="4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768",
            ),
            "4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768",
        )

    def test_identifier_from_raw_id(self):
        _assert_communication_identifier(
            "8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
            CommunicationUserIdentifier(
                id="8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
        )
        _assert_communication_identifier(
            "8:spool:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
            CommunicationUserIdentifier(
                id="8:spool:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
        )
        _assert_communication_identifier(
            "8:dod-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
            CommunicationUserIdentifier(
                id="8:dod-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
        )
        _assert_communication_identifier(
            "8:gcch-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130",
            CommunicationUserIdentifier(
                id="8:gcch-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
            ),
        )
        _assert_communication_identifier("8:acs:something", CommunicationUserIdentifier(id="8:acs:something"))
        _assert_communication_identifier(
            "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130"),
        )
        _assert_communication_identifier(
            "8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsUserIdentifier(
                user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
                cloud="PUBLIC",
                is_anonymous=False,
            ),
        )
        _assert_communication_identifier(
            "8:dod:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsUserIdentifier(
                user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
                cloud="DOD",
                is_anonymous=False,
            ),
        )
        _assert_communication_identifier(
            "8:gcch:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsUserIdentifier(
                user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
                cloud="GCCH",
                is_anonymous=False,
            ),
        )
        _assert_communication_identifier(
            "8:teamsvisitor:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", is_anonymous=True),
        )
        _assert_communication_identifier(
            "8:orgid:legacyFormat",
            MicrosoftTeamsUserIdentifier(user_id="legacyFormat", cloud="PUBLIC", is_anonymous=False),
        )
        _assert_communication_identifier(
            "28:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130"),
        )
        _assert_communication_identifier(
            "28:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"),
        )
        _assert_communication_identifier(
            "28:dod:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD"),
        )
        _assert_communication_identifier(
            "28:gcch:45ab2481-1c1c-4005-be24-0ffb879b1130",
            MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"),
        )
        _assert_communication_identifier("4:+112345556789", PhoneNumberIdentifier(value="+112345556789"))
        _assert_communication_identifier("4:112345556789", PhoneNumberIdentifier(value="112345556789"))
        _assert_communication_identifier("4:otherFormat", PhoneNumberIdentifier(value="otherFormat"))
        _assert_communication_identifier(
            "4:207ffef6-9444-41fb-92ab-20eacaae2768",
            PhoneNumberIdentifier(value="207ffef6-9444-41fb-92ab-20eacaae2768"),
        )
        # cspell:disable
        _assert_communication_identifier(
            "4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
            PhoneNumberIdentifier(value="207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768"),
        )
        _assert_communication_identifier(
            "4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768",
            PhoneNumberIdentifier(value="+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768"),
        )
        # cspell:enable
        _assert_communication_identifier(
            "28:ag08-global:01234567-89ab-cdef-0123-456789abcdef",
            UnknownIdentifier(identifier="28:ag08-global:01234567-89ab-cdef-0123-456789abcdef"),
        )
        _assert_communication_identifier("", UnknownIdentifier(identifier=""))
        with pytest.raises(Exception):
            identifier_from_raw_id(None)

    def test_roundtrip(self):
        _assert_roundtrip("8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:spool:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:dod-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:gcch-acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:acs:something")
        _assert_roundtrip("8:orgid:45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:dod:45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:gcch:45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:teamsvisitor:45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("8:orgid:legacyFormat")
        _assert_roundtrip("4:+112345556789")
        _assert_roundtrip("4:112345556789")
        _assert_roundtrip("4:otherFormat")
        _assert_roundtrip("4:207ffef6-9444-41fb-92ab-20eacaae2768")
        # cspell:disable
        _assert_roundtrip("4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768")
        _assert_roundtrip("4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768")
        # cspell:enable
        _assert_roundtrip("28:45ab2481-1c1c-4005-be24-0ffb879b1130")
        _assert_roundtrip("28:gcch-global:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("28:dod-global:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("28:orgid:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("28:gcch:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("28:dod:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("28:dod:01234567-89ab-cdef-0123-456789abcdef")
        _assert_roundtrip("")

    def test_equality_based_on_raw_id(self):
        # CommunicationUserIdentifiers are equal.
        assert CommunicationUserIdentifier(
            id="8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) == CommunicationUserIdentifier(
            id="8:acs:bbbcbc1e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
        )

        # CommunicationUserIdentifiers are not equal.
        assert CommunicationUserIdentifier(
            id="8:acs:6666e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) != CommunicationUserIdentifier(
            id="8:acs:555e-9f06-482a-b5d8-20e3f26ef0cd_45ab2481-1c1c-4005-be24-0ffb879b1130"
        )

        # MicrosoftTeamsUserIdentifiers are equal.
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) == MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"
        ) == MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD"
        ) == MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"
        ) == MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=False,
        ) == MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=False,
        )
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=True,
        ) == MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=True,
        )

        # MicrosoftTeamsUserIdentifiers are not equal.
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) != MicrosoftTeamsUserIdentifier(user_id="55ab2481-1c1c-4005-be24-0ffb879b1130")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"
        ) != MicrosoftTeamsUserIdentifier(user_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD")
        assert MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=False,
        ) != MicrosoftTeamsUserIdentifier(
            user_id="45ab2481-1c1c-4005-be24-0ffb879b1130",
            cloud="GCCH",
            is_anonymous=True,
        )

        # MicrosoftTeamsAppIdentifiers are equal.
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH"
        ) == MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="GCCH")

        # MicrosoftTeamsAppIdentifiers are not equal.
        assert MicrosoftTeamsAppIdentifier(
            app_id="54ab2481-1c1c-4005-be24-0ffb879b1130"
        ) != MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130")
        assert MicrosoftTeamsAppIdentifier(
            app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="PUBLIC"
        ) != MicrosoftTeamsAppIdentifier(app_id="45ab2481-1c1c-4005-be24-0ffb879b1130", cloud="DOD")

        # PhoneNumberIdentifiers are equal.
        assert PhoneNumberIdentifier(value="+112345556789") == PhoneNumberIdentifier(value="+112345556789")

        # PhoneNumberIdentifiers are not equal.
        assert PhoneNumberIdentifier(value="+112345556789") != PhoneNumberIdentifier(value="+512345556789")

        # UnknownIdentifiers are equal.
        assert UnknownIdentifier(identifier="28:ag08-global:01234567-89ab-cdef-0123-456789abcdef") == UnknownIdentifier(
            identifier="28:ag08-global:01234567-89ab-cdef-0123-456789abcdef"
        )

        # UnknownIdentifiers are not equal.
        assert UnknownIdentifier(identifier="48:8888-global:01234567-89ab-cdef-0123-456789abcdef") != UnknownIdentifier(
            identifier="48:ag08-global:01234567-89ab-cdef-0123-456789abcdef"
        )


def _assert_raw_id(identifier, want):
    # type: (CommunicationIdentifier, str) -> None
    assert identifier.raw_id == want


def _assert_communication_identifier(raw_id, want):
    # type: (str, CommunicationIdentifier) -> None
    got = identifier_from_raw_id(raw_id)
    assert got.raw_id == want.raw_id
    assert got.kind == want.kind
    assert len(got.properties) == len(want.properties)
    for key in want.properties:
        assert key in got.properties
        assert got.properties[key] == want.properties[key]


def _assert_roundtrip(raw_id):
    # type: (str) -> None
    assert identifier_from_raw_id(raw_id).raw_id == raw_id