test_client.py 35 KB

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