test_client.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992
  1. """Tests for ChattoClient.
  2. Since the client now goes through generated ConnectRPC service stubs, tests
  3. mock at the service-client method level with ``AsyncMock`` rather than at the
  4. HTTP transport layer. This exercises the request-building and response-parsing
  5. paths without any real network traffic.
  6. """
  7. from __future__ import annotations
  8. import datetime as dt
  9. from unittest.mock import AsyncMock
  10. import pytest
  11. from chattolib._pb.chatto.admin.v1 import (
  12. room_layout_pb2,
  13. )
  14. from chattolib._pb.chatto.admin.v1 import (
  15. server_pb2 as admin_server_pb2,
  16. )
  17. from chattolib._pb.chatto.api.v1 import (
  18. account_pb2,
  19. asset_uploads_pb2,
  20. attachments_pb2,
  21. messages_pb2,
  22. notification_preferences_pb2,
  23. notifications_pb2,
  24. presence_pb2,
  25. push_notifications_pb2,
  26. reactions_pb2,
  27. read_state_pb2,
  28. roles_pb2,
  29. room_directory_pb2,
  30. room_timeline_pb2,
  31. rooms_pb2,
  32. threads_pb2,
  33. user_service_pb2,
  34. viewer_pb2,
  35. voice_calls_pb2,
  36. )
  37. from chattolib._pb.chatto.discovery.v1 import server_pb2 as discovery_server_pb2
  38. from chattolib.client import ChattoClient
  39. from chattolib.types import (
  40. ImageFitMode,
  41. ImageTransformOptions,
  42. NotificationLevel,
  43. PresenceStatus,
  44. RoomKind,
  45. TimeFormat,
  46. )
  47. BASE = "https://chat.chatto.run"
  48. @pytest.fixture
  49. def client():
  50. return ChattoClient(token="test-token", base_url=BASE)
  51. def _mock_method(client: ChattoClient, service: str, method: str, response):
  52. """Replace a service-client method with an AsyncMock returning ``response``."""
  53. svc = getattr(client._svc, service)
  54. setattr(svc, method, AsyncMock(return_value=response))
  55. return getattr(svc, method)
  56. # --- Server discovery ---------------------------------------------------
  57. async def test_get_server(client):
  58. resp = discovery_server_pb2.GetServerResponse()
  59. resp.profile.name = "Chatto HQ"
  60. resp.profile.version = "0.4.2"
  61. resp.login.direct_registration_enabled = True
  62. resp.login.authorize_url = "/oauth"
  63. _mock_method(client, "server_discovery", "get_server", resp)
  64. async with client:
  65. profile, login = await client.get_server()
  66. assert profile.name == "Chatto HQ"
  67. assert profile.version == "0.4.2"
  68. assert login.direct_registration_enabled is True
  69. assert login.authorize_url == "/oauth"
  70. async def test_list_neighborhood_servers(client):
  71. resp = discovery_server_pb2.ListNeighborhoodServersResponse()
  72. s1 = resp.servers.add()
  73. s1.origin = "https://neighbor.example"
  74. s1.profile.name = "Neighbor"
  75. s1.profile.version = "0.5.0"
  76. s1.profile.logo_url = "/logos/neighbor.png"
  77. s1.direct_neighbor = True
  78. s2 = resp.servers.add()
  79. s2.origin = "https://referred.example"
  80. s2.profile.name = "Referred"
  81. s2.direct_neighbor = False
  82. s2.recommended_by_origins.append("https://neighbor.example")
  83. resp.refreshed_at.FromJsonString("2026-09-26T12:00:00Z")
  84. mocked = _mock_method(client, "server_discovery", "list_neighborhood_servers", resp)
  85. async with client:
  86. page = await client.list_neighborhood_servers()
  87. mocked.assert_awaited_once()
  88. assert [s.origin for s in page.servers] == [
  89. "https://neighbor.example",
  90. "https://referred.example",
  91. ]
  92. assert page.servers[0].profile is not None
  93. assert page.servers[0].profile.name == "Neighbor"
  94. assert page.servers[0].profile.logo_url == "/logos/neighbor.png"
  95. assert page.servers[0].direct_neighbor is True
  96. assert page.servers[1].direct_neighbor is False
  97. assert page.servers[1].recommended_by_origins == ["https://neighbor.example"]
  98. assert page.refreshed_at == dt.datetime(2026, 9, 26, 12, 0, tzinfo=dt.UTC)
  99. # --- Viewer -------------------------------------------------------------
  100. async def test_me(client):
  101. resp = viewer_pb2.GetViewerResponse()
  102. resp.user.profile.id = "u1"
  103. resp.user.profile.login = "alice"
  104. resp.user.profile.display_name = "Alice"
  105. resp.user.profile.presence_status = "PRESENCE_STATUS_ONLINE"
  106. resp.user.has_verified_email = True
  107. resp.user.settings.timezone = "UTC"
  108. resp.user.settings.time_format = "TIME_FORMAT_24_HOUR"
  109. resp.user.has_password = True
  110. _mock_method(client, "viewer", "get_viewer", resp)
  111. async with client:
  112. user = await client.me()
  113. assert user.id == "u1"
  114. assert user.login == "alice"
  115. assert user.display_name == "Alice"
  116. assert user.presence_status is PresenceStatus.ONLINE
  117. # --- Room directory ----------------------------------------------------
  118. async def test_list_rooms(client):
  119. resp = room_directory_pb2.ListRoomsResponse()
  120. entry = resp.rooms.add()
  121. entry.room.id = "r1"
  122. entry.room.kind = "ROOM_KIND_CHANNEL"
  123. entry.room.name = "general"
  124. entry.room.group_id = "g1"
  125. entry.viewer_state.is_member = True
  126. entry.viewer_state.has_unread = False
  127. _mock_method(client, "room_directory", "list_rooms", resp)
  128. async with client:
  129. rooms = await client.list_rooms()
  130. assert len(rooms) == 1
  131. assert rooms[0].room is not None
  132. assert rooms[0].room.name == "general"
  133. assert rooms[0].room.kind is RoomKind.CHANNEL
  134. assert rooms[0].viewer_state.is_member is True
  135. async def test_list_rooms_dm_keeps_deleted_participants(client):
  136. # Since Chatto 0.5.0-beta.10, a DM's member_user_ids keeps participants
  137. # whose accounts were deleted; the client must surface the full list
  138. # (resolution to a User then legitimately fails for the deleted one).
  139. resp = room_directory_pb2.ListRoomsResponse()
  140. entry = resp.rooms.add()
  141. entry.room.id = "r-dm"
  142. entry.room.kind = "ROOM_KIND_DM"
  143. entry.room.name = "me & u2"
  144. entry.viewer_state.is_member = True
  145. entry.member_user_ids.extend(["u1", "u-deleted"])
  146. _mock_method(client, "room_directory", "list_rooms", resp)
  147. async with client:
  148. rooms = await client.list_rooms()
  149. assert len(rooms) == 1
  150. assert rooms[0].room is not None
  151. assert rooms[0].room.kind is RoomKind.DM
  152. assert rooms[0].member_user_ids == ["u1", "u-deleted"]
  153. # --- Messages ----------------------------------------------------------
  154. async def test_post_message(client):
  155. resp = messages_pb2.CreateMessageResponse()
  156. resp.message.id = "e1"
  157. resp.message.room_id = "r1"
  158. resp.message.actor_id = "u1"
  159. resp.message.body = "Hello!"
  160. _mock_method(client, "messages", "create_message", resp)
  161. async with client:
  162. message = await client.post_message("r1", "Hello!")
  163. assert message.id == "e1"
  164. assert message.body == "Hello!"
  165. assert message.room_id == "r1"
  166. async def test_update_message(client):
  167. resp = messages_pb2.UpdateMessageResponse()
  168. resp.message.id = "e1"
  169. resp.message.room_id = "r1"
  170. resp.message.actor_id = "u1"
  171. resp.message.body = "edited"
  172. resp.message.updated_at.FromJsonString("2026-01-01T00:01:00Z")
  173. m = _mock_method(client, "messages", "update_message", resp)
  174. async with client:
  175. msg = await client.update_message("r1", "e1", body="edited")
  176. assert msg.body == "edited"
  177. assert msg.updated_at is not None
  178. # verify the request had the optional body field explicitly set
  179. call_args = m.call_args
  180. req = call_args.args[0]
  181. assert isinstance(req, messages_pb2.UpdateMessageRequest)
  182. assert req.HasField("body")
  183. assert req.body == "edited"
  184. async def test_delete_message(client):
  185. _mock_method(client, "messages", "delete_message", messages_pb2.DeleteMessageResponse())
  186. async with client:
  187. assert await client.delete_message("r1", "e1") is None
  188. async def test_add_reaction(client):
  189. resp = reactions_pb2.AddReactionResponse(added=True)
  190. _mock_method(client, "messages", "add_reaction", resp)
  191. async with client:
  192. assert await client.add_reaction("r1", "e1", "thumbsup") is True
  193. async def test_remove_reaction(client):
  194. resp = reactions_pb2.RemoveReactionResponse(removed=True)
  195. _mock_method(client, "messages", "remove_reaction", resp)
  196. async with client:
  197. assert await client.remove_reaction("r1", "e1", "thumbsup") is True
  198. # --- Room lifecycle ---------------------------------------------------
  199. async def test_create_room(client):
  200. resp = rooms_pb2.CreateRoomResponse()
  201. resp.room.id = "r1"
  202. resp.room.kind = "ROOM_KIND_CHANNEL"
  203. resp.room.name = "general"
  204. resp.room.group_id = "g1"
  205. _mock_method(client, "rooms", "create_room", resp)
  206. async with client:
  207. room = await client.create_room("general", "g1")
  208. assert room.id == "r1"
  209. assert room.name == "general"
  210. assert room.group_id == "g1"
  211. async def test_archive_room(client):
  212. resp = rooms_pb2.ArchiveRoomResponse()
  213. resp.room.id = "r1"
  214. resp.room.name = "general"
  215. resp.room.archived = True
  216. _mock_method(client, "rooms", "archive_room", resp)
  217. async with client:
  218. room = await client.archive_room("r1")
  219. assert room.archived is True
  220. async def test_remove_user(client):
  221. resp = rooms_pb2.RemoveUserResponse()
  222. mock = _mock_method(client, "rooms", "remove_user", resp)
  223. async with client:
  224. await client.remove_user("r1", "u2", "spam")
  225. await client.remove_user(
  226. "r1", "u2", "spam", suspension_expires_at=dt.datetime.fromtimestamp(0, dt.UTC)
  227. )
  228. await client.remove_user("r1", "u2", "spam", suspend_indefinitely=True)
  229. calls = [c.args[0] for c in mock.call_args_list]
  230. assert calls[0].WhichOneof("suspension") is None
  231. assert calls[1].WhichOneof("suspension") == "suspension_expires_at"
  232. assert calls[2].WhichOneof("suspension") == "suspend_indefinitely"
  233. async def test_remove_user_rejects_both_suspensions(client):
  234. _mock_method(client, "rooms", "remove_user", rooms_pb2.RemoveUserResponse())
  235. async with client:
  236. with pytest.raises(ValueError, match="not both"):
  237. await client.remove_user(
  238. "r1",
  239. "u2",
  240. "spam",
  241. suspension_expires_at=dt.datetime.fromtimestamp(0, dt.UTC),
  242. suspend_indefinitely=True,
  243. )
  244. async def test_lift_suspension(client):
  245. _mock_method(client, "rooms", "lift_suspension", rooms_pb2.LiftSuspensionResponse())
  246. async with client:
  247. assert await client.lift_suspension("r1", "u2", "reinstated") is None
  248. async def test_list_suspensions(client):
  249. resp = rooms_pb2.ListSuspensionsResponse()
  250. s = resp.suspensions.add()
  251. s.id = "s1"
  252. s.room_id = "r1"
  253. s.user_id = "u2"
  254. _mock_method(client, "rooms", "list_suspensions", resp)
  255. async with client:
  256. suspensions, _ = await client.list_suspensions(room_id="r1")
  257. assert [x.id for x in suspensions] == ["s1"]
  258. async def test_start_dm(client):
  259. resp = rooms_pb2.StartDMResponse()
  260. resp.room.id = "r1"
  261. resp.room.kind = "ROOM_KIND_DM"
  262. _mock_method(client, "rooms", "start_dm", resp)
  263. async with client:
  264. room = await client.start_dm(["u1", "u2"])
  265. assert room.id == "r1"
  266. assert room.kind is RoomKind.DM
  267. # --- Room timeline ----------------------------------------------------
  268. async def test_get_room_events(client):
  269. resp = room_timeline_pb2.GetRoomEventsResponse()
  270. event = resp.page.events.add()
  271. event.id = "e1"
  272. event.actor_id = "u1"
  273. event.created_at.FromJsonString("2026-01-01T00:00:00Z")
  274. event.message_posted.message.id = "e1"
  275. event.message_posted.message.room_id = "r1"
  276. event.message_posted.message.actor_id = "u1"
  277. event.message_posted.message.body = "hi"
  278. event.message_posted.message.created_at.FromJsonString("2026-01-01T00:00:00Z")
  279. resp.page.start_cursor = "cA"
  280. resp.page.end_cursor = "cB"
  281. resp.page.includes.users["u1"].id = "u1"
  282. resp.page.includes.users["u1"].login = "alice"
  283. resp.page.includes.users["u1"].display_name = "Alice"
  284. _mock_method(client, "rooms", "get_room_events", resp)
  285. async with client:
  286. page = await client.get_room_events("r1", limit=50)
  287. assert len(page.events) == 1
  288. assert page.events[0].kind == "message_posted"
  289. assert page.events[0].message is not None
  290. assert page.events[0].message.body == "hi"
  291. assert page.users_by_id["u1"].login == "alice"
  292. async def test_mark_room_as_read(client):
  293. resp = read_state_pb2.MarkRoomAsReadResponse()
  294. resp.last_read_at.FromJsonString("2026-01-01T00:00:00Z")
  295. resp.previous_last_read_at.FromJsonString("2025-12-31T00:00:00Z")
  296. _mock_method(client, "rooms", "mark_room_as_read", resp)
  297. async with client:
  298. last, previous = await client.mark_room_as_read("r1", up_to_event_id="e1")
  299. assert last is not None
  300. assert previous is not None
  301. # --- Profile / account ------------------------------------------------
  302. async def test_update_user_profile(client):
  303. resp = user_service_pb2.UpdateUserProfileResponse()
  304. resp.user.id = "u1"
  305. resp.user.login = "newname"
  306. resp.user.display_name = "New Name"
  307. resp.user.bio = "# Hi"
  308. resp.user.presence_status = "PRESENCE_STATUS_ONLINE"
  309. _mock_method(client, "user", "update_user_profile", resp)
  310. async with client:
  311. user = await client.update_user_profile(
  312. "u1", login="newname", display_name="New Name", bio="# Hi"
  313. )
  314. assert user.id == "u1"
  315. assert user.login == "newname"
  316. assert user.display_name == "New Name"
  317. assert user.bio == "# Hi"
  318. async def test_update_profile(client):
  319. """Self-service update resolves the caller id via the viewer, then
  320. delegates to the new UserService.UpdateUserProfile wire call."""
  321. viewer = viewer_pb2.GetViewerResponse()
  322. viewer.user.profile.id = "u1"
  323. viewer.user.profile.login = "alice"
  324. viewer.user.profile.display_name = "Alice"
  325. _mock_method(client, "viewer", "get_viewer", viewer)
  326. resp = user_service_pb2.UpdateUserProfileResponse()
  327. resp.user.id = "u1"
  328. resp.user.login = "newname"
  329. resp.user.display_name = "New Name"
  330. resp.user.presence_status = "PRESENCE_STATUS_ONLINE"
  331. update = _mock_method(client, "user", "update_user_profile", resp)
  332. async with client:
  333. user = await client.update_profile(login="newname", display_name="New Name")
  334. assert user.login == "newname"
  335. assert user.display_name == "New Name"
  336. (req,) = update.await_args.args
  337. assert req.user_id == "u1"
  338. async def test_set_presence(client):
  339. resp = presence_pb2.SetPresenceResponse()
  340. resp.status = "PRESENCE_STATUS_ONLINE"
  341. _mock_method(client, "account", "set_presence", resp)
  342. async with client:
  343. result = await client.set_presence(PresenceStatus.ONLINE)
  344. assert result is PresenceStatus.ONLINE
  345. async def test_set_presence_offline_rejected(client):
  346. async with client:
  347. with pytest.raises(ValueError):
  348. await client.set_presence(PresenceStatus.OFFLINE)
  349. async def test_get_presence_preference(client):
  350. resp = presence_pb2.GetPresencePreferenceResponse()
  351. resp.preference.status = "PRESENCE_STATUS_OFFLINE"
  352. resp.preference.revision = "rev-1"
  353. _mock_method(client, "account", "get_presence_preference", resp)
  354. async with client:
  355. pref = await client.get_presence_preference()
  356. assert pref is not None
  357. assert pref.status is PresenceStatus.OFFLINE
  358. assert pref.revision == "rev-1"
  359. async def test_get_presence_preference_absent(client):
  360. # No preference saved yet: the response carries no sub-message.
  361. _mock_method(
  362. client, "account", "get_presence_preference", presence_pb2.GetPresencePreferenceResponse()
  363. )
  364. async with client:
  365. assert await client.get_presence_preference() is None
  366. async def test_set_presence_preference(client):
  367. resp = presence_pb2.SetPresencePreferenceResponse()
  368. resp.preference.status = "PRESENCE_STATUS_DO_NOT_DISTURB"
  369. resp.preference.revision = "rev-2"
  370. m = _mock_method(client, "account", "set_presence_preference", resp)
  371. async with client:
  372. pref = await client.set_presence_preference(
  373. PresenceStatus.DO_NOT_DISTURB, expected_revision="rev-1"
  374. )
  375. assert pref.status is PresenceStatus.DO_NOT_DISTURB
  376. assert pref.revision == "rev-2"
  377. req = m.await_args.args[0]
  378. assert req.status == presence_pb2.PresenceStatus.Value("PRESENCE_STATUS_DO_NOT_DISTURB")
  379. assert req.expected_revision == "rev-1"
  380. async def test_set_presence_preference_offline_allowed(client):
  381. # Unlike set_presence, OFFLINE is a valid saved choice ("Appear Offline").
  382. resp = presence_pb2.SetPresencePreferenceResponse()
  383. resp.preference.status = "PRESENCE_STATUS_OFFLINE"
  384. _mock_method(client, "account", "set_presence_preference", resp)
  385. async with client:
  386. assert (await client.set_presence_preference(PresenceStatus.OFFLINE)).status is (
  387. PresenceStatus.OFFLINE
  388. )
  389. async def test_set_presence_preference_unspecified_rejected(client):
  390. async with client:
  391. with pytest.raises(ValueError):
  392. await client.set_presence_preference(PresenceStatus.UNSPECIFIED)
  393. async def test_refresh_presence(client):
  394. resp = presence_pb2.RefreshPresenceResponse()
  395. resp.preference.status = "PRESENCE_STATUS_ONLINE"
  396. resp.preference.revision = "rev-3"
  397. _mock_method(client, "account", "refresh_presence", resp)
  398. async with client:
  399. pref = await client.refresh_presence()
  400. assert pref is not None
  401. assert pref.status is PresenceStatus.ONLINE
  402. assert pref.revision == "rev-3"
  403. async def test_update_settings(client):
  404. resp = account_pb2.UpdateSettingsResponse()
  405. resp.settings.timezone = "Europe/Rome"
  406. resp.settings.time_format = "TIME_FORMAT_24_HOUR"
  407. _mock_method(client, "account", "update_settings", resp)
  408. async with client:
  409. settings = await client.update_settings(
  410. timezone="Europe/Rome", time_format=TimeFormat.HOUR_24
  411. )
  412. assert settings.timezone == "Europe/Rome"
  413. assert settings.time_format is TimeFormat.HOUR_24
  414. # --- Threads ----------------------------------------------------------
  415. async def test_list_followed_threads(client):
  416. resp = threads_pb2.ListFollowedThreadsResponse()
  417. ft = resp.threads.add()
  418. ft.room.id = "r1"
  419. ft.room.name = "general"
  420. ft.root_message.id = "e1"
  421. ft.root_message.room_id = "r1"
  422. ft.root_message.actor_id = "u1"
  423. ft.root_message.body = "root"
  424. ft.root_message.created_at.FromJsonString("2026-01-01T00:00:00Z")
  425. ft.thread.thread_root_event_id = "e1"
  426. ft.thread.reply_count = 3
  427. ft.thread.last_reply_at.FromJsonString("2026-01-02T00:00:00Z")
  428. ft.thread.viewer_state.is_following = True
  429. ft.thread.viewer_state.has_unread_replies = False
  430. resp.page.total_count = 1
  431. resp.page.has_more = False
  432. mocked = _mock_method(client, "threads", "list_followed_threads", resp)
  433. async with client:
  434. page = await client.list_followed_threads()
  435. await client.list_followed_threads(
  436. limit=5,
  437. offset=5,
  438. include_direct_message_threads=True,
  439. unread_only=True,
  440. )
  441. assert page.page.total_count == 1
  442. assert page.threads[0].thread is not None
  443. assert page.threads[0].thread.reply_count == 3
  444. assert page.threads[0].thread.is_following is True
  445. calls = [c.args[0] for c in mocked.call_args_list]
  446. assert calls[0].include_direct_message_threads is False
  447. assert calls[0].unread_only is False
  448. assert calls[1].include_direct_message_threads is True
  449. assert calls[1].unread_only is True
  450. assert calls[1].page.limit == 5
  451. assert calls[1].page.offset == 5
  452. async def test_follow_and_unfollow_thread(client):
  453. _mock_method(client, "threads", "follow_thread", threads_pb2.FollowThreadResponse())
  454. _mock_method(client, "threads", "unfollow_thread", threads_pb2.UnfollowThreadResponse())
  455. async with client:
  456. assert await client.follow_thread("r1", "e1") is None
  457. assert await client.unfollow_thread("r1", "e1") is None
  458. # --- Notifications ----------------------------------------------------
  459. async def test_list_notification_occurrences(client):
  460. resp = notifications_pb2.ListNotificationOccurrencesResponse()
  461. occ = resp.occurrences.add()
  462. occ.id = "n1"
  463. occ.created_at.FromJsonString("2026-01-01T00:00:00Z")
  464. occ.actor.id = "u1"
  465. occ.actor.login = "alice"
  466. occ.actor.display_name = "Alice"
  467. occ.unread = True
  468. sig = occ.signal.direct_mention_received
  469. sig.message.room.id = "r1"
  470. sig.message.room.name = "general"
  471. sig.message.event_id = "e1"
  472. resp.page.total_count = 1
  473. resp.unread_count = 1
  474. _mock_method(client, "notifications", "list_notification_occurrences", resp)
  475. async with client:
  476. page = await client.list_notification_occurrences()
  477. assert page.page.total_count == 1
  478. assert page.unread_count == 1
  479. assert page.occurrences[0].signal is not None
  480. assert page.occurrences[0].signal.kind == "direct_mention_received"
  481. assert page.occurrences[0].signal.message is not None
  482. assert page.occurrences[0].signal.message.event_id == "e1"
  483. assert page.occurrences[0].signal.message.room is not None
  484. assert page.occurrences[0].signal.message.room.name == "general"
  485. async def test_mark_and_delete_notification_occurrence(client):
  486. read_resp = notifications_pb2.MarkNotificationReadResponse()
  487. read_resp.occurrence.id = "n1"
  488. read_resp.occurrence.unread = False
  489. _mock_method(client, "notifications", "mark_notification_read", read_resp)
  490. del_resp = notifications_pb2.DeleteNotificationOccurrenceResponse(deleted=True)
  491. _mock_method(client, "notifications", "delete_notification_occurrence", del_resp)
  492. all_resp = notifications_pb2.DeleteAllNotificationOccurrencesResponse(deleted_count=3)
  493. _mock_method(client, "notifications", "delete_all_notification_occurrences", all_resp)
  494. async with client:
  495. occ = await client.mark_notification_read("n1")
  496. assert occ is not None and occ.unread is False
  497. assert await client.delete_notification_occurrence("n1") is True
  498. assert await client.delete_all_notification_occurrences() == 3
  499. async def test_notification_preference(client):
  500. resp = notification_preferences_pb2.UpdateNotificationPreferenceResponse()
  501. resp.preference.level = "NOTIFICATION_LEVEL_MUTED"
  502. resp.preference.effective_level = "NOTIFICATION_LEVEL_MUTED"
  503. _mock_method(
  504. client,
  505. "notification_prefs",
  506. "update_room_notification_preference",
  507. resp,
  508. )
  509. async with client:
  510. pref = await client.update_room_notification_preference("r1", NotificationLevel.MUTED)
  511. assert pref.level is NotificationLevel.MUTED
  512. assert pref.effective_level is NotificationLevel.MUTED
  513. # --- Push -------------------------------------------------------------
  514. async def test_subscribe_push(client):
  515. _mock_method(client, "push", "subscribe", push_notifications_pb2.SubscribeResponse())
  516. async with client:
  517. assert await client.subscribe_push("https://push", "k", "a") is True
  518. # --- Voice calls ------------------------------------------------------
  519. async def test_active_calls(client):
  520. resp = voice_calls_pb2.ListActiveCallsResponse()
  521. call = resp.calls.add()
  522. call.call_id = "c1"
  523. call.room.id = "r1"
  524. call.room.name = "voice"
  525. p = call.participants.add()
  526. p.user.id = "u1"
  527. p.user.login = "alice"
  528. p.user.display_name = "Alice"
  529. _mock_method(client, "voice_calls", "list_active_calls", resp)
  530. async with client:
  531. calls = await client.list_active_calls()
  532. assert len(calls) == 1
  533. assert calls[0].call_id == "c1"
  534. assert calls[0].room is not None
  535. assert calls[0].room.name == "voice"
  536. # --- Assets -----------------------------------------------------------
  537. async def test_get_asset_with_thumbnail(client):
  538. resp = attachments_pb2.GetAssetResponse()
  539. resp.asset.id = "a1"
  540. resp.asset.filename = "pic.png"
  541. resp.asset.content_type = "image/png"
  542. resp.asset.size = 1024
  543. resp.asset.asset_url.url = "https://cdn/pic.png"
  544. mock = _mock_method(client, "assets", "get_asset", resp)
  545. async with client:
  546. asset = await client.get_asset(
  547. "r1",
  548. "a1",
  549. thumbnail=ImageTransformOptions(128, 128, ImageFitMode.COVER),
  550. )
  551. assert asset is not None
  552. assert asset.filename == "pic.png"
  553. assert asset.asset_url is not None
  554. assert asset.asset_url.url == "https://cdn/pic.png"
  555. # verify the request encoded thumbnail options
  556. req = mock.call_args.args[0]
  557. assert req.thumbnail.width == 128
  558. assert req.thumbnail.height == 128
  559. # --- Roles ------------------------------------------------------------
  560. async def test_list_roles(client):
  561. resp = roles_pb2.ListRolesResponse()
  562. r1 = resp.roles.add()
  563. r1.name = "everyone"
  564. r1.display_name = "Everyone"
  565. r1.is_system = True
  566. r1.position = 0
  567. r2 = resp.roles.add()
  568. r2.name = "admin"
  569. r2.display_name = "Admin"
  570. r2.position = 10
  571. _mock_method(client, "roles", "list_roles", resp)
  572. async with client:
  573. roles = await client.list_roles()
  574. assert [r.name for r in roles] == ["everyone", "admin"]
  575. assert roles[0].is_system is True
  576. # --- Asset uploads ---------------------------------------------------
  577. async def test_asset_upload_end_to_end(client, tmp_path):
  578. import hashlib
  579. payload = b"hello world" * 100
  580. file = tmp_path / "greet.txt"
  581. file.write_bytes(payload)
  582. sha = hashlib.sha256(payload).hexdigest()
  583. create_resp = asset_uploads_pb2.CreateUploadResponse()
  584. create_resp.upload.upload_id = "up1"
  585. create_resp.upload.room_id = "r1"
  586. create_resp.upload.status = "ASSET_UPLOAD_STATUS_OPEN"
  587. create_resp.upload.committed_offset = 0
  588. create_resp.upload.size = len(payload)
  589. create_resp.upload.max_chunk_size = 4096
  590. create_resp.upload.sha256 = sha
  591. create_mock = _mock_method(client, "asset_uploads", "create_upload", create_resp)
  592. chunk_resp = asset_uploads_pb2.UploadChunkResponse()
  593. chunk_resp.upload.upload_id = "up1"
  594. chunk_resp.upload.room_id = "r1"
  595. chunk_resp.upload.status = "ASSET_UPLOAD_STATUS_OPEN"
  596. chunk_resp.upload.committed_offset = len(payload)
  597. chunk_resp.upload.size = len(payload)
  598. chunk_resp.upload.max_chunk_size = 4096
  599. chunk_resp.upload.sha256 = sha
  600. _mock_method(client, "asset_uploads", "upload_chunk", chunk_resp)
  601. complete_resp = asset_uploads_pb2.CompleteUploadResponse()
  602. complete_resp.upload.upload_id = "up1"
  603. complete_resp.upload.room_id = "r1"
  604. complete_resp.upload.status = "ASSET_UPLOAD_STATUS_COMPLETED"
  605. complete_resp.upload.committed_offset = len(payload)
  606. complete_resp.upload.size = len(payload)
  607. complete_resp.upload.sha256 = sha
  608. complete_resp.upload.asset_id = "a1"
  609. complete_resp.asset.id = "a1"
  610. complete_resp.asset.filename = "greet.txt"
  611. complete_resp.asset.content_type = "text/plain"
  612. complete_resp.asset.size = len(payload)
  613. _mock_method(client, "asset_uploads", "complete_upload", complete_resp)
  614. async with client:
  615. asset = await client.upload_attachment("r1", file, content_type="text/plain")
  616. assert asset.id == "a1"
  617. assert asset.filename == "greet.txt"
  618. create_req = create_mock.call_args.args[0]
  619. assert create_req.sha256 == sha
  620. assert create_req.size == len(payload)
  621. # --- External identities --------------------------------------------
  622. # --- Admin (structural smoke tests) ----------------------------------
  623. async def test_admin_list_room_groups(client):
  624. resp = room_layout_pb2.ListRoomGroupsResponse()
  625. g = resp.groups.add()
  626. g.id = "g1"
  627. g.name = "General"
  628. room_item = g.items.add()
  629. room_item.room.id = "r1"
  630. room_item.room.kind = "ROOM_KIND_CHANNEL"
  631. room_item.room.name = "chat"
  632. link_item = g.items.add()
  633. link_item.sidebar_link.id = "sl1"
  634. link_item.sidebar_link.label = "Docs"
  635. link_item.sidebar_link.url = "https://x"
  636. g.can_create_room = True
  637. _mock_method(client, "admin_room_layout", "list_room_groups", resp)
  638. async with client:
  639. groups = await client.admin_list_room_groups()
  640. assert len(groups) == 1
  641. assert groups[0].name == "General"
  642. assert groups[0].rooms[0].id == "r1"
  643. assert groups[0].sidebar_links[0].label == "Docs"
  644. assert groups[0].can_create_room is True
  645. async def test_admin_create_sidebar_link(client):
  646. resp = room_layout_pb2.CreateSidebarLinkResponse()
  647. resp.sidebar_link.id = "sl1"
  648. resp.sidebar_link.label = "Docs"
  649. resp.sidebar_link.url = "https://x"
  650. _mock_method(client, "admin_room_layout", "create_sidebar_link", resp)
  651. async with client:
  652. result = await client.admin_create_sidebar_link("g1", "Docs", "https://x")
  653. assert result == {"id": "sl1", "label": "Docs", "url": "https://x"}
  654. async def test_admin_move_room_group(client):
  655. resp = room_layout_pb2.MoveRoomGroupResponse()
  656. g = resp.groups.add()
  657. g.id = "g1"
  658. g.name = "General"
  659. mock = _mock_method(client, "admin_room_layout", "move_room_group", resp)
  660. async with client:
  661. groups = await client.admin_move_room_group("g1", before_group_id="g2")
  662. assert [g.id for g in groups] == ["g1"]
  663. sent = mock.call_args.args[0]
  664. assert sent.group_id == "g1"
  665. assert sent.before_group_id == "g2"
  666. async def test_admin_move_room_group_to_end(client):
  667. resp = room_layout_pb2.MoveRoomGroupResponse()
  668. mock = _mock_method(client, "admin_room_layout", "move_room_group", resp)
  669. async with client:
  670. await client.admin_move_room_group("g1")
  671. sent = mock.call_args.args[0]
  672. assert sent.group_id == "g1"
  673. assert not sent.HasField("before_group_id")
  674. async def test_admin_move_sidebar_item(client):
  675. resp = room_layout_pb2.MoveSidebarItemResponse()
  676. resp.group.id = "g1"
  677. resp.group.name = "General"
  678. mock = _mock_method(client, "admin_room_layout", "move_sidebar_item", resp)
  679. async with client:
  680. group = await client.admin_move_sidebar_item(
  681. ("sidebar_link", "sl1"),
  682. "g1",
  683. before=("room", "r1"),
  684. )
  685. assert group.id == "g1"
  686. sent = mock.call_args.args[0]
  687. assert sent.item.sidebar_link_id == "sl1"
  688. assert sent.before.room_id == "r1"
  689. assert sent.group_id == "g1"
  690. async def test_admin_update_server_config(client):
  691. resp = admin_server_pb2.UpdateServerConfigResponse()
  692. resp.config.server_name = "MyServer"
  693. resp.config.motd = "hi"
  694. resp.public_profile.name = "MyServer"
  695. resp.public_profile.version = "0.4.2"
  696. _mock_method(client, "admin_server", "update_server_config", resp)
  697. async with client:
  698. config, profile = await client.admin_update_server_config(server_name="MyServer", motd="hi")
  699. assert config.server_name == "MyServer"
  700. assert profile.version == "0.4.2"
  701. # --- Neighbors (0.5.0-alpha.3) -----------------------------------------
  702. async def test_list_neighbors_public(client):
  703. resp = discovery_server_pb2.ListNeighborsResponse()
  704. resp.origins.extend(["https://a.example", "https://b.example"])
  705. _mock_method(client, "server_discovery", "list_neighbors", resp)
  706. async with client:
  707. origins = await client.list_neighbors()
  708. assert origins == ["https://a.example", "https://b.example"]
  709. async def test_admin_neighbor_crud(client):
  710. list_resp = admin_server_pb2.ListNeighborsResponse()
  711. n = list_resp.neighbors.add()
  712. n.id = "n1"
  713. n.origin = "https://a.example"
  714. n.revision = "rev1"
  715. _mock_method(client, "admin_server", "list_neighbors", list_resp)
  716. get_resp = admin_server_pb2.GetNeighborResponse()
  717. get_resp.neighbor.id = "n1"
  718. get_resp.neighbor.origin = "https://a.example"
  719. get_resp.neighbor.revision = "rev1"
  720. _mock_method(client, "admin_server", "get_neighbor", get_resp)
  721. create_resp = admin_server_pb2.CreateNeighborResponse()
  722. create_resp.neighbor.id = "n2"
  723. create_resp.neighbor.origin = "https://b.example"
  724. create_resp.neighbor.revision = "rev2"
  725. _mock_method(client, "admin_server", "create_neighbor", create_resp)
  726. update_resp = admin_server_pb2.UpdateNeighborResponse()
  727. update_resp.neighbor.id = "n2"
  728. update_resp.neighbor.origin = "https://b2.example"
  729. update_resp.neighbor.revision = "rev3"
  730. _mock_method(client, "admin_server", "update_neighbor", update_resp)
  731. del_resp = admin_server_pb2.DeleteNeighborResponse()
  732. _mock_method(client, "admin_server", "delete_neighbor", del_resp)
  733. async with client:
  734. listed = await client.admin_list_neighbors()
  735. assert [x.origin for x in listed] == ["https://a.example"]
  736. got = await client.admin_get_neighbor("n1")
  737. assert got is not None and got.revision == "rev1"
  738. created = await client.admin_create_neighbor("https://b.example")
  739. assert created.id == "n2" and created.revision == "rev2"
  740. updated = await client.admin_update_neighbor("n2", "https://b2.example", "rev2")
  741. assert updated.origin == "https://b2.example" and updated.revision == "rev3"
  742. await client.admin_delete_neighbor("n2", "rev3")
  743. async def test_update_settings_share_timezone(client):
  744. resp = account_pb2.UpdateSettingsResponse()
  745. resp.settings.timezone = "Europe/Berlin"
  746. resp.settings.share_timezone = True
  747. _mock_method(client, "account", "update_settings", resp)
  748. async with client:
  749. settings = await client.update_settings(timezone="Europe/Berlin", share_timezone=True)
  750. assert settings.timezone == "Europe/Berlin"
  751. assert settings.share_timezone is True