Available on crate feature
testing
and non-target_family="wasm"
only.Expand description
Helpers to mock a server and have a client automatically connected to that server, for the purpose of integration tests.
Modules§
- encryption
e2e-encryption
- Helpers to mock a server that supports the main crypto API and have a client automatically connected to that server, for the purpose of integration tests.
- oauth
- Helpers to mock an OAuth 2.0 server for the purpose of integration tests.
Structs§
- AddRoom
Keys Version Endpoint - A prebuilt mock for
POST room_keys/version
: adding room key backups. - Authed
Media Download Endpoint - A prebuilt mock for
GET /client/v1/media/download
requests. - Authed
Media Thumbnail Endpoint - A prebuilt mock for
GET /client/v1/media/thumbnail
requests. - Authenticated
Media Config Endpoint - A prebuilt mock for
GET /_matrix/client/v1/media/config
request. - BanUser
Endpoint - A prebuilt mock for
POST /ban
request. - Create
Room Alias Endpoint - A prebuilt mock for creating a room alias.
- Create
Room Endpoint - A prebuilt mock for
POST /createRoom
requests. - Delete
Push Rules Endpoint - A prebuilt mock for
DELETE /_matrix/client/v3/pushrules/global/{kind}/{ruleId}
. - Delete
Room Keys Version Endpoint - A prebuilt mock for
DELETE room_keys/version/xxx
: deleting room key backups. - Devices
Endpoint - A prebuilt mock for
GET /devices
requests. - Enable
Push Rule Endpoint - A prebuilt mock for
PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}/enabled
. - Encryption
State Endpoint - A prebuilt mock for reading the encryption state of a room.
- Federation
Version Endpoint - A prebuilt mock for the federation version endpoint.
- GetHierarchy
Endpoint - A prebuilt mock for
GET /client/*/rooms/{roomId}/hierarchy
- GetRoom
Members Endpoint - A prebuilt mock for
GET /members
request. - GetRoom
Visibility Endpoint - A prebuilt mock for getting the room’s visibility in the room directory.
- GetThread
Subscriptions Endpoint - A prebuilt mock for
GET ^/_matrix/client/v3/thread_subscriptions
. - Global
Account Data Endpoint - A prebuilt mock for the global account data endpoint.
- Invite
User ById Endpoint - A prebuilt mock for
POST /invite
request. - Join
Room Endpoint - A prebuilt mock for
GET /client/v3/rooms/{room_id}/join
requests. - Kick
User Endpoint - A prebuilt mock for
POST /kick
request. - Login
Endpoint - A prebuilt mock for
POST /login
requests. - Login
Response Template200 - A response to a
LoginEndpoint
query with status code 200. - Logout
Endpoint - A prebuilt mock for
POST /logout
request. - Matrix
Mock - A wrapper for a
Mock
as well as aMockServer
, allowing us to callMock::mount
orMock::mount_as_scoped
without having to pass theMockServer
reference (i.e. callmount()
instead ofmount(&server)
). - Matrix
Mock Server - A
wiremock
MockServer
along with useful methods to help mocking Matrix client-server API endpoints easily. - Media
Allocate Endpoint - A prebuilt mock for
POST /media/v1/create
requests. - Media
Allocated Upload Endpoint - A prebuilt mock for
PUT /media/v3/upload/{server_name}/{media_id}
requests. - Media
Config Endpoint - A prebuilt mock for
GET /_matrix/media/v3/config
request. - Media
Download Endpoint - A prebuilt mock for
GET /media/v3/download
requests. - Media
Thumbnail Endpoint - A prebuilt mock for
GET /media/v3/thumbnail
requests. - Mock
Endpoint - Generic mocked endpoint, with useful common helpers.
- Public
Rooms Endpoint - A prebuilt mock for paginating the public room list.
- Query
Keys Endpoint - A prebuilt mock for
POST /keys/query
request. - Read
Markers Endpoint - A prebuilt mock for
POST /rooms/{roomId}/read_markers
request. - Receipt
Endpoint - A prebuilt mock for
POST /rooms/{roomId}/receipt/{receiptType}/{eventId}
request. - Remove
Room Alias Endpoint - A prebuilt mock for removing a room alias.
- Resolve
Room Alias Endpoint - A prebuilt mock for resolving a room alias.
- Room
Account Data Endpoint - A prebuilt mock for
PUT /user/{userId}/rooms/{roomId}/account_data/{type}
request. - Room
Delete Thread Subscription Endpoint - A prebuilt mock for
DELETE /client/*/rooms/{room_id}/threads/{thread_root}/subscription
- Room
Event Context Endpoint - A prebuilt mock for getting a single event with its context in a room.
- Room
Event Endpoint - A prebuilt mock for getting a single event in a room.
- Room
Forget Endpoint - A prebuilt mock for the room forget endpoint.
- Room
GetThread Subscription Endpoint - A prebuilt mock for
GET /client/*/rooms/{room_id}/threads/{thread_root}/subscription
- Room
Keys Version Endpoint - A prebuilt mock for
GET room_keys/version
: storage (“backup”) of room keys. - Room
Leave Endpoint - A prebuilt mock for the room leave endpoint.
- Room
Messages Endpoint - A prebuilt mock for the
/messages
endpoint. - Room
Messages Response Template - A response to a
RoomMessagesEndpoint
query. - Room
PutThread Subscription Endpoint - A prebuilt mock for
PUT /client/*/rooms/{room_id}/threads/{thread_root}/subscription
- Room
Redact Endpoint - A prebuilt mock for redacting an event in a room.
- Room
Relations Endpoint - A prebuilt mock for a
GET /rooms/{roomId}/relations/{eventId}
family of requests. - Room
Relations Response Template - A response to a
RoomRelationsEndpoint
query. - Room
Send Endpoint - A prebuilt mock for sending a message like event in a room.
- Room
Send State Endpoint - A prebuilt mock for sending a state event in a room.
- Room
Summary Endpoint - A prebuilt mock for the room summary endpoint.
- Room
Threads Endpoint - A prebuilt mock for a
GET /rooms/{roomId}/threads
request. - Send
ToDevice Endpoint - A prebuilt mock for the
/sendToDevice
endpoint. - SetEncryption
State Endpoint - A prebuilt mock for setting the encryption state of a room.
- SetPush
Rules Actions Endpoint - A prebuilt mock for
PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}/actions
. - SetPush
Rules Endpoint - A prebuilt mock for
PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}
. - SetRoom
Pinned Events Endpoint - A prebuilt mock to set a room’s pinned events.
- SetRoom
Visibility Endpoint - A prebuilt mock for setting the room’s visibility in the room directory.
- Sync
Endpoint - A prebuilt mock for running sync v2.
- Upgrade
Room Endpoint - A prebuilt mock for
POST /rooms/{roomId}/upgrade
requests. - Upload
Cross Signing Keys Endpoint - A prebuilt mock for
POST /keys/device_signing/upload
request. - Upload
Cross Signing Signatures Endpoint - A prebuilt mock for
POST /keys/signatures/upload
request. - Upload
Endpoint - A prebuilt mock for uploading media.
- Upload
Keys Endpoint - A prebuilt mock for
POST /keys/upload
request. - User
Directory Endpoint - A prebuilt mock for
POST /user_directory/search
requests. - Versions
Endpoint - A prebuilt mock for
GET /versions
request. - Well
Known Endpoint - A prebuilt mock for
GET /.well-known/matrix/client
request. - WhoAmI
Endpoint - A prebuilt mock for
GET /account/whoami
request.
Enums§
- AnyRoom
Builder - Parameter to
MatrixMockServer::sync_room
. - Push
Rule IdSpec - A specification for a push rule ID.