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
|
# -------------------------------------------------------------------------
# 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 time
from datetime import datetime, timezone
from devtools_testutils import AzureRecordedTestCase, is_live, recorded_by_proxy
from azure.communication.identity import CommunicationIdentityClient
from azure.communication.chat import ChatClient, ChatParticipant, ChatMessageType, CommunicationTokenCredential
from azure.communication.chat._shared.utils import parse_connection_str
from chat_e2e_helper import get_connection_str
from _shared.utils import get_http_logging_policy
class TestChatThreadClient(AzureRecordedTestCase):
def setup_method(self):
connection_str = get_connection_str()
self.identity_client = CommunicationIdentityClient.from_connection_string(connection_str)
endpoint, _ = parse_connection_str(connection_str)
self.endpoint = endpoint
# create user and issue token
self.user = self.identity_client.create_user()
tokenresponse = self.identity_client.get_token(self.user, scopes=["chat"])
self.token = tokenresponse.token
# create another user
self.new_user = self.identity_client.create_user()
tokenresponse = self.identity_client.get_token(self.new_user, scopes=["chat"])
self.token_new_user = tokenresponse.token
# create ChatClient
self.chat_client = ChatClient(
self.endpoint, CommunicationTokenCredential(self.token), http_logging_policy=get_http_logging_policy()
)
self.chat_client_new_user = ChatClient(
self.endpoint,
CommunicationTokenCredential(self.token_new_user),
http_logging_policy=get_http_logging_policy(),
)
def teardown_method(self):
# delete created users and chat threads
if is_live():
self.chat_client.delete_chat_thread(self.thread_id)
self.identity_client.delete_user(self.user)
self.identity_client.delete_user(self.new_user)
def _create_thread(self, **kwargs):
# create chat thread, and ChatThreadClient
topic = "test topic"
share_history_time = datetime.utcnow()
share_history_time = share_history_time.replace(tzinfo=timezone.utc)
participants = [
ChatParticipant(identifier=self.user, display_name="name", share_history_time=share_history_time)
]
create_chat_thread_result = self.chat_client.create_chat_thread(topic, thread_participants=participants)
self.chat_thread_client = self.chat_client.get_chat_thread_client(create_chat_thread_result.chat_thread.id)
self.thread_id = self.chat_thread_client.thread_id
def _create_thread_w_two_users(self, **kwargs):
# create chat thread, and ChatThreadClient
topic = "test topic"
share_history_time = datetime.utcnow()
share_history_time = share_history_time.replace(tzinfo=timezone.utc)
participants = [
ChatParticipant(identifier=self.user, display_name="name", share_history_time=share_history_time),
ChatParticipant(identifier=self.new_user, display_name="name", share_history_time=share_history_time),
]
create_chat_thread_result = self.chat_client.create_chat_thread(topic, thread_participants=participants)
self.chat_thread_client = self.chat_client.get_chat_thread_client(create_chat_thread_result.chat_thread.id)
self.thread_id = self.chat_thread_client.thread_id
def _send_message(self):
# send a message
content = "hello world"
sender_display_name = "sender name"
create_message_result = self.chat_thread_client.send_message(content, sender_display_name=sender_display_name)
message_id = create_message_result.id
return message_id
@pytest.mark.live_test_only
@recorded_by_proxy
def test_update_topic(self):
self._create_thread()
topic = "update topic"
self.chat_thread_client.update_topic(topic=topic)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_send_message(self):
self._create_thread()
content = "hello world"
sender_display_name = "sender name"
create_message_result = self.chat_thread_client.send_message(content, sender_display_name=sender_display_name)
create_message_result_id = create_message_result.id
assert create_message_result_id is not None
@pytest.mark.live_test_only
@recorded_by_proxy
def test_get_message(self):
self._create_thread()
message_id = self._send_message()
message = self.chat_thread_client.get_message(message_id)
assert message.id == message_id
assert message.type == ChatMessageType.TEXT
assert message.content.message == "hello world"
@pytest.mark.live_test_only
@recorded_by_proxy
def test_list_messages(self):
self._create_thread()
self._send_message()
chat_messages = self.chat_thread_client.list_messages(results_per_page=1)
for chat_message in chat_messages.by_page():
li = list(chat_message)
assert len(li) <= 1
@pytest.mark.live_test_only
@recorded_by_proxy
def test_update_message(self):
self._create_thread()
message_id = self._send_message()
content = "updated message content"
self.chat_thread_client.update_message(message_id, content=content)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_delete_message(self):
self._create_thread()
message_id = self._send_message()
self.chat_thread_client.delete_message(message_id)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_list_participants(self):
self._create_thread()
# add another participant
share_history_time = datetime.utcnow()
share_history_time = share_history_time.replace(tzinfo=timezone.utc)
new_participant = ChatParticipant(
identifier=self.new_user, display_name="name", share_history_time=share_history_time
)
self.chat_thread_client.add_participants([new_participant])
# fetch list of participants
chat_thread_participants = self.chat_thread_client.list_participants(results_per_page=1, skip=1)
participant_count = 0
for chat_thread_participant_page in chat_thread_participants.by_page():
li = list(chat_thread_participant_page)
assert len(li) <= 1
participant_count += len(li)
li[0].identifier.properties["id"] = self.user.properties["id"]
assert participant_count == 1
@pytest.mark.live_test_only
@recorded_by_proxy
def test_add_participants(self):
self._create_thread()
share_history_time = datetime.utcnow()
share_history_time = share_history_time.replace(tzinfo=timezone.utc)
new_participant = ChatParticipant(
identifier=self.new_user, display_name="name", share_history_time=share_history_time
)
participants = [new_participant]
failed_participants = self.chat_thread_client.add_participants(participants)
# no error occured while adding participants
assert len(failed_participants) == 0
@pytest.mark.live_test_only
@recorded_by_proxy
def test_remove_participant(self):
self._create_thread()
# add participant first
share_history_time = datetime.utcnow()
share_history_time = share_history_time.replace(tzinfo=timezone.utc)
new_participant = ChatParticipant(
identifier=self.new_user, display_name="name", share_history_time=share_history_time
)
participants = [new_participant]
self.chat_thread_client.add_participants(participants)
# test remove participant
self.chat_thread_client.remove_participant(self.new_user)
@pytest.mark.live_test_only
@recorded_by_proxy
def test_send_typing_notification(self):
self._create_thread()
self.chat_thread_client.send_typing_notification()
@pytest.mark.live_test_only
@recorded_by_proxy
def test_send_typing_notification_with_display_name(self):
self._create_thread()
self.chat_thread_client.send_typing_notification(sender_display_name="John")
@pytest.mark.live_test_only
@recorded_by_proxy
def test_send_read_receipt(self):
self._create_thread()
message_id = self._send_message()
self.chat_thread_client.send_read_receipt(message_id)
def _wait_on_thread(self, chat_client, thread_id, message_id):
# print("Read Receipts Sent: ", read_receipts_sent)
chat_thread_client = chat_client.get_chat_thread_client(thread_id)
for _ in range(10):
read_receipts_paged = chat_thread_client.list_read_receipts()
chat_message_ids = []
for page in read_receipts_paged.by_page():
for item in page:
chat_message_ids.append(item.chat_message_id)
if message_id in chat_message_ids:
return
else:
print("Sleeping for additional 2 secs")
time.sleep(2)
raise Exception("Read receipts not updated in 20 seconds. Failing.")
@pytest.mark.live_test_only
@recorded_by_proxy
def test_list_read_receipts(self):
self._create_thread_w_two_users()
# first user send 2 messages
# send messages and read receipts
for i in range(2):
message_id = self._send_message()
self.chat_thread_client.send_read_receipt(message_id)
if self.is_live:
self._wait_on_thread(chat_client=self.chat_client, thread_id=self.thread_id, message_id=message_id)
# get chat thread client for second user
chat_thread_client_new_user = self.chat_client_new_user.get_chat_thread_client(self.thread_id)
# second user sends 1 message
message_result_new_user = chat_thread_client_new_user.send_message(
"content", sender_display_name="sender_display_name"
)
message_id_new_user = message_result_new_user.id
# send read receipt
chat_thread_client_new_user.send_read_receipt(message_id_new_user)
if self.is_live:
self._wait_on_thread(
chat_client=self.chat_client_new_user, thread_id=self.thread_id, message_id=message_id_new_user
)
# list read receipts
read_receipts = self.chat_thread_client.list_read_receipts(results_per_page=2, skip=0)
items = []
for page in read_receipts.by_page():
for item in page:
items.append(item)
assert len(items) == 2
@pytest.mark.live_test_only
@recorded_by_proxy
def test_get_properties(self):
self._create_thread()
get_thread_result = self.chat_thread_client.get_properties()
assert get_thread_result.id == self.thread_id
|
