Struct OAuthMockServer

pub struct OAuthMockServer<'a> { /* private fields */ }

Available on crate feature testing and non-WebAssembly only.

A wiremock MockServer along with useful methods to help mocking OAuth 2.0 API endpoints easily.

It implements mock endpoints, limiting the shared code as much as possible, so the mocks are still flexible to use as scoped/unscoped mounts, named, and so on.

It works like this:

• start by saying which endpoint you’d like to mock, e.g. Self::mock_server_metadata(). This returns a specialized MockEndpoint data structure, with its own impl. For this example, it’s MockEndpoint<ServerMetadataEndpoint>.
• configure the response on the endpoint-specific mock data structure. For instance, if you want the sending to result in a transient failure, call MockEndpoint::error500; if you want it to succeed and return the metadata, call MockEndpoint::ok(). It’s still possible to call MockEndpoint::respond_with(), as we do with wiremock MockBuilder, for maximum flexibility when the helpers aren’t sufficient.
• once the endpoint’s response is configured, for any mock builder, you get a MatrixMock; this is a plain wiremock::Mock with the server curried, so one doesn’t have to pass it around when calling MatrixMock::mount() or MatrixMock::mount_as_scoped(). As such, it mostly defers its implementations to wiremock::Mock under the hood.

Implementations

impl<'a> OAuthMockServer<'a>

pub fn server_metadata(&self) -> AuthorizationServerMetadata

Get the mock OAuth 2.0 server metadata.

impl OAuthMockServer<'_>

pub fn mock_server_metadata(&self) -> MockEndpoint<'_, ServerMetadataEndpoint>

Creates a prebuilt mock for the Matrix endpoint used to query the authorization server’s metadata.

Contrary to all the other endpoints of OAuthMockServer, this is an endpoint from the Matrix API, but it is only used in the context of the OAuth 2.0 API, which is why it is mocked here rather than on MatrixMockServer.

pub fn mock_registration(&self) -> MockEndpoint<'_, RegistrationEndpoint>

Creates a prebuilt mock for the OAuth 2.0 endpoint used to register a new client.

pub fn mock_device_authorization( &self, ) -> MockEndpoint<'_, DeviceAuthorizationEndpoint>

Creates a prebuilt mock for the OAuth 2.0 endpoint used to authorize a device.

pub fn mock_token(&self) -> MockEndpoint<'_, TokenEndpoint>

Creates a prebuilt mock for the OAuth 2.0 endpoint used to request an access token.

pub fn mock_revocation(&self) -> MockEndpoint<'_, RevocationEndpoint>

Creates a prebuilt mock for the OAuth 2.0 endpoint used to revoke a token.