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 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
|
# -------------------------------------------------------------------------
# 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 datetime import datetime, timedelta
from azure.core.exceptions import HttpResponseError
from azure.communication.identity import CommunicationIdentityClient
from azure.communication.rooms import ParticipantRole, RoomParticipant, RoomsClient
from azure.communication.rooms._shared.models import CommunicationUserIdentifier
from _shared.utils import get_http_logging_policy
from acs_rooms_test_case import ACSRoomsTestCase
from devtools_testutils import is_live, add_general_regex_sanitizer, recorded_by_proxy
class TestRoomsClient(ACSRoomsTestCase):
def setup_method(self):
super().setUp()
sanitizedId1 = "8:acs:sanitized1"
sanitizedId2 = "8:acs:sanitized2"
sanitizedId3 = "8:acs:sanitized3"
sanitizedId4 = "8:acs:sanitized4"
sanitizedId5 = "8:acs:sanitized5"
if is_live():
self.identity_client = CommunicationIdentityClient.from_connection_string(self.connection_str)
self.id1 = self.identity_client.create_user().properties["id"]
self.id2 = self.identity_client.create_user().properties["id"]
self.id3 = self.identity_client.create_user().properties["id"]
self.id4 = self.identity_client.create_user().properties["id"]
self.id5 = self.identity_client.create_user().properties["id"]
add_general_regex_sanitizer(regex=self.id1, value=sanitizedId1)
add_general_regex_sanitizer(regex=self.id2, value=sanitizedId2)
add_general_regex_sanitizer(regex=self.id3, value=sanitizedId3)
add_general_regex_sanitizer(regex=self.id4, value=sanitizedId4)
add_general_regex_sanitizer(regex=self.id5, value=sanitizedId5)
else:
self.id1 = sanitizedId1
self.id2 = sanitizedId2
self.id3 = sanitizedId3
self.id4 = sanitizedId4
self.id5 = sanitizedId5
self.rooms_client = RoomsClient.from_connection_string(
self.connection_str, http_logging_policy=get_http_logging_policy()
)
self.users = {
"john": RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id1), role=ParticipantRole.PRESENTER
),
"fred": RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.CONSUMER
),
"chris": RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE
),
"jordan": RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR
),
}
self.rooms_client = RoomsClient.from_connection_string(
self.connection_str, http_logging_policy=get_http_logging_policy()
)
@recorded_by_proxy
def test_create_room_no_attributes(self):
response = self.rooms_client.create_room()
# delete created room
self.rooms_client.delete_room(room_id=response.id)
@recorded_by_proxy
def test_create_room_only_participants(self):
# add john and chris to room
participants = [self.users["john"], self.users["chris"],self.users["jordan"]]
response = self.rooms_client.create_room(participants=participants)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
self.verify_successful_room_response(response=response)
@recorded_by_proxy
def test_create_room_validUntil_seven_months(self):
# room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(weeks=29)
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.create_room(valid_from=valid_from, valid_until=valid_until)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@recorded_by_proxy
def test_create_room_valid_until_in_past(self):
# room attributes
valid_until = datetime.now() - timedelta(weeks=1)
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.create_room(valid_until=valid_until)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@pytest.mark.live_test_only
@recorded_by_proxy
def test_create_room_correct_timerange(self):
# room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(weeks=4)
response = self.rooms_client.create_room(valid_from=valid_from, valid_until=valid_until)
self.verify_successful_room_response(response=response, valid_from=valid_from, valid_until=valid_until)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
@recorded_by_proxy
def test_create_room_incorrectMri(self):
# room attributes
participants = [
RoomParticipant(communication_identifier=CommunicationUserIdentifier("wrong_mri"), role="Attendee"),
self.users["john"],
]
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.create_room(participants=participants)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@pytest.mark.live_test_only
@recorded_by_proxy
def test_create_room_all_attributes(self):
# room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(weeks=4)
participants = [self.users["john"]]
response = self.rooms_client.create_room(
valid_from=valid_from, valid_until=valid_until, participants=participants
)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
self.verify_successful_room_response(response=response, valid_from=valid_from, valid_until=valid_until)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_get_room(self):
# room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(weeks=2)
# add john to room
participants = [self.users["john"]]
# create a room first
create_response = self.rooms_client.create_room(
valid_from=valid_from, valid_until=valid_until, participants=participants
)
get_response = self.rooms_client.get_room(room_id=create_response.id)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
self.verify_successful_room_response(
response=get_response, valid_from=valid_from, valid_until=valid_until, room_id=create_response.id
)
@recorded_by_proxy
def test_get_invalid_format_roomId(self):
# random room id
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.get_room(room_id="invalid_id")
# Bad request
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@pytest.mark.live_test_only
@recorded_by_proxy
def test_update_room_correct_timerange(self):
# room with no attributes
create_response = self.rooms_client.create_room()
# update room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = datetime.now() + timedelta(weeks=4)
update_response = self.rooms_client.update_room(
room_id=create_response.id, valid_from=valid_from, valid_until=valid_until
)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
self.verify_successful_room_response(
response=update_response, valid_from=valid_from, valid_until=valid_until, room_id=create_response.id
)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_update_room_PstnDialOutEnabled(self):
# room with no attributes
create_response = self.rooms_client.create_room()
# update room attributes
update_response = self.rooms_client.update_room(room_id=create_response.id, pstn_dial_out_enabled=True)
self.verify_successful_room_response(
response=update_response, pstn_dial_out_enabled=True, room_id=create_response.id
)
update_response = self.rooms_client.update_room(room_id=create_response.id, pstn_dial_out_enabled=False)
self.verify_successful_room_response(
response=update_response, pstn_dial_out_enabled=False, room_id=create_response.id
)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_update_room_PstnDialOutRemainsUnchanged(self):
# room with no attributes
create_response = self.rooms_client.create_room(pstn_dial_out_enabled=True)
# update room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = datetime.now() + timedelta(weeks=4)
# update room attributes
update_response = self.rooms_client.update_room(
room_id=create_response.id, valid_from=valid_from, valid_until=valid_until
)
self.verify_successful_room_response(
response=update_response,
valid_from=valid_from,
valid_until=valid_until,
pstn_dial_out_enabled=True,
room_id=create_response.id,
)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_update_room_invalid_format_roomId(self):
# try to update room with random room_id
with pytest.raises(HttpResponseError) as ex:
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(days=4)
self.rooms_client.update_room(room_id="invalid_id", valid_from=valid_from, valid_until=valid_until)
# assert error is bad request
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@recorded_by_proxy
def test_update_room_valid_until_in_past(self):
# room with no attributes
create_response = self.rooms_client.create_room()
with pytest.raises(HttpResponseError) as ex:
# update room attributes
valid_from = datetime.now() - timedelta(days=3)
valid_until = datetime.now() - timedelta(weeks=1)
self.rooms_client.update_room(room_id=create_response.id, valid_from=valid_from, valid_until=valid_until)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@recorded_by_proxy
def test_update_room_deleted_room(self):
# create a room -> delete it -> try to update it
create_response = self.rooms_client.create_room()
# delete the room
self.rooms_client.delete_room(room_id=create_response.id)
with pytest.raises(HttpResponseError) as ex:
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(days=4)
self.rooms_client.update_room(room_id=create_response.id, valid_from=valid_from, valid_until=valid_until)
# assert error is Resource not found
assert str(ex.value.status_code) == "404"
assert ex.value.message is not None
@recorded_by_proxy
def test_update_room_exceed_max_timerange(self):
# room with no attributes
create_response = self.rooms_client.create_room()
# update room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = datetime.now() + timedelta(weeks=29)
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.update_room(room_id=create_response.id, valid_from=valid_from, valid_until=valid_until)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_add_or_update_participants(self):
# add john and chris to room
create_participants = [self.users["john"], self.users["chris"],self.users["jordan"]]
create_response = self.rooms_client.create_room(participants=create_participants)
# update join to consumer and add fred to room
self.users["john"].role = ParticipantRole.CONSUMER
add_or_update_participants = [self.users["john"], self.users["fred"]]
expected_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id1), role=ParticipantRole.CONSUMER
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.CONSUMER
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.COLLABORATOR
),
]
self.rooms_client.add_or_update_participants(
room_id=create_response.id, participants=add_or_update_participants
)
update_response = self.rooms_client.list_participants(room_id=create_response.id)
participants = []
for participant in update_response:
participants.append(participant)
assert len(participants) == 4
case = unittest.TestCase()
case.assertCountEqual(expected_participants, participants)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_add_or_update_participants_with_null_role(self):
create_participants = [
RoomParticipant(communication_identifier=CommunicationUserIdentifier(self.id1), role=None),
RoomParticipant(communication_identifier=CommunicationUserIdentifier(self.id2)),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.PRESENTER
),
]
expected_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id1), role=ParticipantRole.ATTENDEE
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.ATTENDEE
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.PRESENTER
),
]
# Check participants with null roles were added in created room
create_response = self.rooms_client.create_room(participants=create_participants)
list_participants_response = self.rooms_client.list_participants(room_id=create_response.id)
participants = []
for participant in list_participants_response:
participants.append(participant)
assert len(participants) == 3
case = unittest.TestCase()
case.assertCountEqual(expected_participants, participants)
# Check participants were added or updated properly
add_or_update_participants = [
RoomParticipant(communication_identifier=CommunicationUserIdentifier(self.id1), role=None),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.CONSUMER
),
RoomParticipant(communication_identifier=CommunicationUserIdentifier(self.id3)),
RoomParticipant(communication_identifier=CommunicationUserIdentifier(self.id4)),
]
expected_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id1), role=ParticipantRole.ATTENDEE
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id2), role=ParticipantRole.CONSUMER
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id4), role=ParticipantRole.ATTENDEE
),
]
self.rooms_client.add_or_update_participants(
room_id=create_response.id, participants=add_or_update_participants
)
update_response = self.rooms_client.list_participants(room_id=create_response.id)
updated_participants = []
for participant in update_response:
updated_participants.append(participant)
assert len(updated_participants) == 4
case = unittest.TestCase()
case.assertCountEqual(expected_participants, updated_participants)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_add_or_update_participants_incorrectMri(self):
# room with no attributes
create_response = self.rooms_client.create_room()
participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier("wrong_mri"), role=ParticipantRole.ATTENDEE
),
self.users["john"],
]
# update room attributes
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.add_or_update_participants(room_id=create_response.id, participants=participants)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_add_or_update_room_wrongRoleName(self):
# room with no attributes
create_response = self.rooms_client.create_room()
participants = [
RoomParticipant(communication_identifier=self.users["john"].communication_identifier, role="Kafka"),
]
# update room attributes
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.add_or_update_participants(room_id=create_response.id, participants=participants)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_remove_participants(self):
# add john and chris to room
create_participants = [self.users["john"], self.users["chris"]]
create_response = self.rooms_client.create_room(participants=create_participants)
# participants to be removed
removed_participants = [self.users["john"].communication_identifier]
expected_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE
)
]
self.rooms_client.remove_participants(room_id=create_response.id, participants=removed_participants)
update_response = self.rooms_client.list_participants(room_id=create_response.id)
participants = []
for participant in update_response:
participants.append(participant)
assert len(participants) == 1
case = unittest.TestCase()
case.assertCountEqual(expected_participants, participants)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_remove_participant_who_do_not_exist(self):
# add john and chris to room
create_participants = [self.users["john"], self.users["chris"]]
remove_participants = [self.users["fred"].communication_identifier]
expected_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id1), role=ParticipantRole.PRESENTER
),
RoomParticipant(
communication_identifier=CommunicationUserIdentifier(self.id3), role=ParticipantRole.ATTENDEE
),
]
create_response = self.rooms_client.create_room(participants=create_participants)
self.rooms_client.remove_participants(room_id=create_response.id, participants=remove_participants)
update_response = self.rooms_client.list_participants(room_id=create_response.id)
participants = []
for participant in update_response:
participants.append(participant)
assert len(participants) == 2
case = unittest.TestCase()
case.assertCountEqual(expected_participants, participants)
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_remove_participant_wrong_mri(self):
# add john and chris to room
create_participants = [self.users["john"], self.users["chris"]]
remove_participants = [
RoomParticipant(
communication_identifier=CommunicationUserIdentifier("wrong_mri"), role=ParticipantRole.ATTENDEE
),
]
create_response = self.rooms_client.create_room(participants=create_participants)
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.remove_participants(room_id=create_response.id, participants=remove_participants)
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
# delete created room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_list_rooms_first_room_is_not_null_success(self):
# create a room -> list all rooms -> delete room
create_response = self.rooms_client.create_room()
all_rooms = self.rooms_client.list_rooms()
first_room = None
count = 0
for room in all_rooms:
if count == 1:
break
first_room = room
count += 1
assert first_room is not None
self.verify_successful_room_response(first_room)
# delete the room
self.rooms_client.delete_room(room_id=create_response.id)
@recorded_by_proxy
def test_delete_room_success(self):
# create a room -> delete the room -> cannot get the room
create_response = self.rooms_client.create_room()
# delete the room
self.rooms_client.delete_room(room_id=create_response.id)
# get the deleted room
with pytest.raises(HttpResponseError) as ex:
self.rooms_client.get_room(create_response.id)
assert str(ex.value.status_code) == "404"
assert ex.value.message is not None
@recorded_by_proxy
def test_delete_room_invalid_id(self):
# room with no attributes
with pytest.raises(HttpResponseError) as ex:
# delete created room with invalid id
self.rooms_client.delete_room(room_id="123")
assert str(ex.value.status_code) == "400"
assert ex.value.message is not None
@pytest.mark.live_test_only
@recorded_by_proxy
def test_create_room_pstn_dial_out_enabled(self):
# room attributes
response = self.rooms_client.create_room(pstn_dial_out_enabled=True)
self.verify_successful_room_response(response=response, pstn_dial_out_enabled=True)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
response = self.rooms_client.create_room(pstn_dial_out_enabled=False)
self.verify_successful_room_response(response=response, pstn_dial_out_enabled=False)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_create_room_timerange_pstn_dial_out_enabled(self):
# room attributes
valid_from = datetime.now() + timedelta(days=3)
valid_until = valid_from + timedelta(weeks=4)
response = self.rooms_client.create_room(
valid_from=valid_from, valid_until=valid_until, pstn_dial_out_enabled=True
)
self.verify_successful_room_response(
response=response, valid_from=valid_from, valid_until=valid_until, pstn_dial_out_enabled=True
)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
response = self.rooms_client.create_room(
valid_from=valid_from, valid_until=valid_until, pstn_dial_out_enabled=False
)
self.verify_successful_room_response(
response=response, valid_from=valid_from, valid_until=valid_until, pstn_dial_out_enabled=False
)
# delete created room
self.rooms_client.delete_room(room_id=response.id)
def verify_successful_room_response(
self, response, valid_from=None, valid_until=None, room_id=None, pstn_dial_out_enabled=None
):
if room_id is not None:
assert room_id == response.id
if valid_from is not None:
assert valid_from.replace(tzinfo=None) == datetime.strptime(
response.valid_from, "%Y-%m-%dT%H:%M:%S.%f%z"
).replace(tzinfo=None)
if valid_until is not None:
assert valid_until.replace(tzinfo=None) == datetime.strptime(
response.valid_until, "%Y-%m-%dT%H:%M:%S.%f%z"
).replace(tzinfo=None)
assert response.created_at is not None
if pstn_dial_out_enabled is not None:
assert pstn_dial_out_enabled == response.pstn_dial_out_enabled
|