test(sdk): Port sliding-sync tests to MatrixMockServer and MockClientBuilder

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

Author: zecakeh

crates/matrix-sdk/src/test_utils/mocks/mod.rs

@@ -38,6 +38,7 @@ use ruma::{
         room::member::RoomMemberEvent, AnyStateEvent, AnyTimelineEvent, GlobalAccountDataEventType,
         MessageLikeEventType, RoomAccountDataEventType, StateEventType,
     },
+    media::Method,
     serde::Raw,
     time::Duration,
     DeviceId, MxcUri, OwnedDeviceId, OwnedEventId, OwnedOneTimeKeyId, OwnedRoomId, OwnedUserId,
@@ -1226,6 +1227,76 @@ impl MatrixMockServer {
         let mock = Mock::given(method("POST")).and(path("/_matrix/client/v3/createRoom"));
         self.mock_endpoint(mock, CreateRoomEndpoint).expect_default_access_token()
     }
+
+    /// Create a prebuilt mock for the endpoint used to pre-allocate a MXC URI
+    /// for a media file.
+    pub fn mock_media_allocate(&self) -> MockEndpoint<'_, MediaAllocateEndpoint> {
+        let mock = Mock::given(method("POST")).and(path("/_matrix/media/v1/create"));
+        self.mock_endpoint(mock, MediaAllocateEndpoint)
+    }
+
+    /// Create a prebuilt mock for the endpoint used to upload a media file with
+    /// a pre-allocated MXC URI.
+    pub fn mock_media_allocated_upload(
+        &self,
+        server_name: &str,
+        media_id: &str,
+    ) -> MockEndpoint<'_, MediaAllocatedUploadEndpoint> {
+        let mock = Mock::given(method("PUT"))
+            .and(path(format!("/_matrix/media/v3/upload/{server_name}/{media_id}")));
+        self.mock_endpoint(mock, MediaAllocatedUploadEndpoint)
+    }
+
+    /// Create a prebuilt mock for the endpoint used to download a media file
+    /// without requiring authentication.
+    pub fn mock_media_download(&self) -> MockEndpoint<'_, MediaDownloadEndpoint> {
+        let mock = Mock::given(method("GET")).and(path_regex("^/_matrix/media/v3/download/"));
+        self.mock_endpoint(mock, MediaDownloadEndpoint)
+    }
+
+    /// Create a prebuilt mock for the endpoint used to download a thumbnail of
+    /// a media file without requiring authentication.
+    pub fn mock_media_thumbnail(
+        &self,
+        resize_method: Method,
+        width: u16,
+        height: u16,
+        animated: bool,
+    ) -> MockEndpoint<'_, MediaThumbnailEndpoint> {
+        let mock = Mock::given(method("GET"))
+            .and(path_regex("^/_matrix/media/v3/thumbnail/"))
+            .and(query_param("method", resize_method.as_str()))
+            .and(query_param("width", width.to_string()))
+            .and(query_param("height", height.to_string()))
+            .and(query_param("animated", animated.to_string()));
+        self.mock_endpoint(mock, MediaThumbnailEndpoint)
+    }
+
+    /// Create a prebuilt mock for the endpoint used to download a media file
+    /// that requires authentication.
+    pub fn mock_authed_media_download(&self) -> MockEndpoint<'_, AuthedMediaDownloadEndpoint> {
+        let mock =
+            Mock::given(method("GET")).and(path_regex("^/_matrix/client/v1/media/download/"));
+        self.mock_endpoint(mock, AuthedMediaDownloadEndpoint).expect_default_access_token()
+    }
+
+    /// Create a prebuilt mock for the endpoint used to download a thumbnail of
+    /// a media file that requires authentication.
+    pub fn mock_authed_media_thumbnail(
+        &self,
+        resize_method: Method,
+        width: u16,
+        height: u16,
+        animated: bool,
+    ) -> MockEndpoint<'_, AuthedMediaThumbnailEndpoint> {
+        let mock = Mock::given(method("GET"))
+            .and(path_regex("^/_matrix/client/v1/media/thumbnail/"))
+            .and(query_param("method", resize_method.as_str()))
+            .and(query_param("width", width.to_string()))
+            .and(query_param("height", height.to_string()))
+            .and(query_param("animated", animated.to_string()));
+        self.mock_endpoint(mock, AuthedMediaThumbnailEndpoint).expect_default_access_token()
+    }
 }
 
 /// Parameter to [`MatrixMockServer::sync_room`].
@@ -2666,6 +2737,19 @@ impl<'a> MockEndpoint<'a, VersionsEndpoint> {
             "versions": Self::versions()
         })))
     }
+
+    /// Returns a successful `/_matrix/client/versions` request with the given
+    /// versions and unstable features.
+    pub fn ok_custom(
+        self,
+        versions: &[&str],
+        unstable_features: &BTreeMap<&str, bool>,
+    ) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_json(json!({
+            "unstable_features": unstable_features,
+            "versions": versions,
+        })))
+    }
 }
 
 /// A prebuilt mock for the room summary endpoint.
@@ -3176,3 +3260,84 @@ impl<'a> MockEndpoint<'a, CreateRoomEndpoint> {
         )
     }
 }
+
+/// A prebuilt mock for `POST /media/v1/create` requests.
+pub struct MediaAllocateEndpoint;
+
+impl<'a> MockEndpoint<'a, MediaAllocateEndpoint> {
+    /// Returns a successful response.
+    pub fn ok(self) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_json(json!({
+          "content_uri": "mxc://example.com/AQwafuaFswefuhsfAFAgsw"
+        })))
+    }
+}
+
+/// A prebuilt mock for `PUT /media/v3/upload/{server_name}/{media_id}`
+/// requests.
+pub struct MediaAllocatedUploadEndpoint;
+
+impl<'a> MockEndpoint<'a, MediaAllocatedUploadEndpoint> {
+    /// Returns a successful response.
+    pub fn ok(self) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
+    }
+}
+
+/// A prebuilt mock for `GET /media/v3/download` requests.
+pub struct MediaDownloadEndpoint;
+
+impl<'a> MockEndpoint<'a, MediaDownloadEndpoint> {
+    /// Returns a successful response with a plain text content.
+    pub fn ok_plain_text(self) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_string("Hello, World!"))
+    }
+
+    /// Returns a successful response with a fake image content.
+    pub fn ok_image(self) -> MatrixMock<'a> {
+        self.respond_with(
+            ResponseTemplate::new(200).set_body_raw(b"binaryjpegfullimagedata", "image/jpeg"),
+        )
+    }
+}
+
+/// A prebuilt mock for `GET /media/v3/thumbnail` requests.
+pub struct MediaThumbnailEndpoint;
+
+impl<'a> MockEndpoint<'a, MediaThumbnailEndpoint> {
+    /// Returns a successful response with a fake image content.
+    pub fn ok(self) -> MatrixMock<'a> {
+        self.respond_with(
+            ResponseTemplate::new(200).set_body_raw(b"binaryjpegthumbnaildata", "image/jpeg"),
+        )
+    }
+}
+
+/// A prebuilt mock for `GET /client/v1/media/download` requests.
+pub struct AuthedMediaDownloadEndpoint;
+
+impl<'a> MockEndpoint<'a, AuthedMediaDownloadEndpoint> {
+    /// Returns a successful response with a plain text content.
+    pub fn ok_plain_text(self) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_string("Hello, World!"))
+    }
+
+    /// Returns a successful response with a fake image content.
+    pub fn ok_image(self) -> MatrixMock<'a> {
+        self.respond_with(
+            ResponseTemplate::new(200).set_body_raw(b"binaryjpegfullimagedata", "image/jpeg"),
+        )
+    }
+}
+
+/// A prebuilt mock for `GET /client/v1/media/thumbnail` requests.
+pub struct AuthedMediaThumbnailEndpoint;
+
+impl<'a> MockEndpoint<'a, AuthedMediaThumbnailEndpoint> {
+    /// Returns a successful response with a fake image content.
+    pub fn ok(self) -> MatrixMock<'a> {
+        self.respond_with(
+            ResponseTemplate::new(200).set_body_raw(b"binaryjpegthumbnaildata", "image/jpeg"),
+        )
+    }
+}