Module mocks 

Available on (crate features testing) and non-target_family=wasm only.

Helpers to mock a server and have a client automatically connected to that server, for the purpose of integration tests.

Modules

encryptione2e-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

AddRoomKeysVersionEndpoint

A prebuilt mock for POST room_keys/version: adding room key backups.

AuthedMediaDownloadEndpoint

A prebuilt mock for GET /client/v1/media/download requests.

AuthedMediaThumbnailEndpoint

A prebuilt mock for GET /client/v1/media/thumbnail requests.

AuthenticatedMediaConfigEndpoint

A prebuilt mock for GET /_matrix/client/v1/media/config request.

BanUserEndpoint

A prebuilt mock for POST /ban request.

CreateRoomAliasEndpoint

A prebuilt mock for creating a room alias.

CreateRoomEndpoint

A prebuilt mock for POST /createRoom requests.

DeleteProfileFieldEndpoint

A prebuilt mock for DELETE /_matrix/client/*/profile/{user_id}/{key_name}.

DeletePushRulesEndpoint

A prebuilt mock for DELETE /_matrix/client/v3/pushrules/global/{kind}/{ruleId}.

DeleteRoomKeysVersionEndpoint

A prebuilt mock for DELETE room_keys/version/xxx: deleting room key backups.

DevicesEndpoint

A prebuilt mock for GET /devices requests.

EnablePushRuleEndpoint

A prebuilt mock for PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}/enabled.

EncryptionStateEndpoint

A prebuilt mock for reading the encryption state of a room.

FederationVersionEndpoint

A prebuilt mock for the federation version endpoint.

GetDefaultSecretStorageKeyEndpointe2e-encryption

A prebuilt mock for a GET /_matrix/client/v3/user/{userId}/account_data/m.secret_storage.default_key request, which fetches the ID of the default secret storage key.

GetDeviceEndpoint

A prebuilt mock for GET /devices/{deviceId} requests.

GetHierarchyEndpoint

A prebuilt mock for GET /client/*/rooms/{roomId}/hierarchy

GetMasterSigningKeyEndpointe2e-encryption

A prebuilt mock for a GET /_matrix/client/v3/user/{userId}/account_data/m.cross_signing.master request, which fetches information about the master signing key.

GetProfileEndpoint

A prebuilt mock for GET /_matrix/client/*/profile/{user_id}.

GetProfileFieldEndpoint

A prebuilt mock for GET /_matrix/client/*/profile/{user_id}/{key_name}.

GetRecentEmojisEndpointexperimental-element-recent-emojis

A prebuilt mock for a GET /_matrix/client/v3/user/{userId}/account_data/io.element.recent_emoji request, which fetches the recently used emojis in the account data.

GetRoomMembersEndpoint

A prebuilt mock for GET /members request.

GetRoomVisibilityEndpoint

A prebuilt mock for getting the room’s visibility in the room directory.

GetSecretStorageKeyEndpointe2e-encryption

A prebuilt mock for a GET /_matrix/client/v3/user/{userId}/account_data/m.secret_storage.key.{keyId} request, which fetches information about a secret storage key.

GetThreadSubscriptionsEndpoint

A prebuilt mock for GET ^/_matrix/client/v3/thread_subscriptions.

InviteUserByIdEndpoint

A prebuilt mock for POST /invite request.

JoinRoomEndpoint

A prebuilt mock for GET /client/v3/rooms/{room_id}/join requests.

KickUserEndpoint

A prebuilt mock for POST /kick request.

LoginEndpoint

A prebuilt mock for POST /login requests.

LoginResponseTemplate200

A response to a LoginEndpoint query with status code 200.

LogoutEndpoint

A prebuilt mock for POST /logout request.

MatrixMock

A wrapper for a Mock as well as a MockServer, allowing us to call Mock::mount or Mock::mount_as_scoped without having to pass the MockServer reference (i.e. call mount() instead of mount(&server)).

MatrixMockServer

A wiremock MockServer along with useful methods to help mocking Matrix client-server API endpoints easily.

MediaAllocateEndpoint

A prebuilt mock for POST /media/v1/create requests.

MediaAllocatedUploadEndpoint

A prebuilt mock for PUT /media/v3/upload/{server_name}/{media_id} requests.

MediaConfigEndpoint

A prebuilt mock for GET /_matrix/media/v3/config request.

MediaDownloadEndpoint

A prebuilt mock for GET /media/v3/download requests.

MediaThumbnailEndpoint

A prebuilt mock for GET /media/v3/thumbnail requests.

MockEndpoint

Generic mocked endpoint, with useful common helpers.

PublicRoomsEndpoint

A prebuilt mock for paginating the public room list.

QueryKeysEndpoint

A prebuilt mock for POST /keys/query request.

ReadMarkersEndpoint

A prebuilt mock for POST /rooms/{roomId}/read_markers request.

ReceiptEndpoint

A prebuilt mock for POST /rooms/{roomId}/receipt/{receiptType}/{eventId} request.

RemoveRoomAliasEndpoint

A prebuilt mock for removing a room alias.

ResolveRoomAliasEndpoint

A prebuilt mock for resolving a room alias.

RoomAccountDataEndpoint

A prebuilt mock for PUT /user/{userId}/rooms/{roomId}/account_data/{type} request.

RoomContextResponseTemplate

A builder pattern for the response to a RoomEventContextEndpoint request.

RoomDeleteThreadSubscriptionEndpoint

A prebuilt mock for DELETE /client/*/rooms/{room_id}/threads/{thread_root}/subscription

RoomEventContextEndpoint

A prebuilt mock for getting a single event with its context in a room.

RoomEventEndpoint

A prebuilt mock for getting a single event in a room.

RoomForgetEndpoint

A prebuilt mock for the room forget endpoint.

RoomGetThreadSubscriptionEndpoint

A prebuilt mock for GET /client/*/rooms/{room_id}/threads/{thread_root}/subscription

RoomKeysVersionEndpoint

A prebuilt mock for GET room_keys/version: storage (“backup”) of room keys.

RoomLeaveEndpoint

A prebuilt mock for the room leave endpoint.

RoomMessagesEndpoint

A prebuilt mock for the /messages endpoint.

RoomMessagesResponseTemplate

A response to a RoomMessagesEndpoint query.

RoomPutThreadSubscriptionEndpoint

A prebuilt mock for PUT /client/*/rooms/{room_id}/threads/{thread_root}/subscription

RoomRedactEndpoint

A prebuilt mock for redacting an event in a room.

RoomRelationsEndpoint

A prebuilt mock for a GET /rooms/{roomId}/relations/{eventId} family of requests.

RoomRelationsResponseTemplate

A response to a RoomRelationsEndpoint query.

RoomSendEndpoint

A prebuilt mock for sending a message like event in a room.

RoomSendStateEndpoint

A prebuilt mock for sending a state event in a room.

RoomSummaryEndpoint

A prebuilt mock for the room summary endpoint.

RoomThreadsEndpoint

A prebuilt mock for a GET /rooms/{roomId}/threads request.

SendToDeviceEndpoint

A prebuilt mock for the /sendToDevice endpoint.

SetEncryptionStateEndpoint

A prebuilt mock for setting the encryption state of a room.

SetProfileFieldEndpoint

A prebuilt mock for PUT /_matrix/client/*/profile/{user_id}/{key_name}.

SetPushRulesActionsEndpoint

A prebuilt mock for PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}/actions.

SetPushRulesEndpoint

A prebuilt mock for PUT /_matrix/client/v3/pushrules/global/{kind}/{ruleId}.

SetRoomPinnedEventsEndpoint

A prebuilt mock to set a room’s pinned events.

SetRoomVisibilityEndpoint

A prebuilt mock for setting the room’s visibility in the room directory.

SetSpaceChildEndpoint

A prebuilt mock for PUT /_matrix/client/v3/rooms/{roomId}/state/m.space.child/{stateKey}

SetSpaceParentEndpoint

A prebuilt mock for PUT /_matrix/client/v3/rooms/{roomId}/state/m.space.parent/{stateKey}

SlidingSyncEndpoint

A prebuilt mock for running simplified sliding sync.

SyncEndpoint

A prebuilt mock for running sync v2.

UpdateRecentEmojisEndpointexperimental-element-recent-emojis

A prebuilt mock for a PUT /_matrix/client/v3/user/{userId}/account_data/io.element.recent_emoji request, which updates the recently used emojis in the account data.

UpgradeRoomEndpoint

A prebuilt mock for POST /rooms/{roomId}/upgrade requests.

UploadCrossSigningKeysEndpoint

A prebuilt mock for POST /keys/device_signing/upload request.

UploadCrossSigningSignaturesEndpoint

A prebuilt mock for POST /keys/signatures/upload request.

UploadEndpoint

A prebuilt mock for uploading media.

UploadKeysEndpoint

A prebuilt mock for POST /keys/upload request.

UserDirectoryEndpoint

A prebuilt mock for POST /user_directory/search requests.

VersionsEndpoint

A prebuilt mock for GET /versions request.

WellKnownEndpoint

A prebuilt mock for GET /.well-known/matrix/client request.

WhoAmIEndpoint

A prebuilt mock for GET /account/whoami request.

Enums

AnyRoomBuilder

Parameter to MatrixMockServer::sync_room.

PushRuleIdSpec

A specification for a push rule ID.