Merge #3416

3416: Add tests on the index resource r=Kerollmops a=irevoire

Fix part of https://github.com/meilisearch/meilisearch/issues/3325

Co-authored-by: Tamo <tamo@meilisearch.com>

meilisearch/tests/common/index.rs

@@ -63,6 +63,11 @@ impl Index<'_> {
         self.service.post_encoded("/indexes", body, self.encoder).await
     }
 
+    pub async fn update_raw(&self, body: Value) -> (Value, StatusCode) {
+        let url = format!("/indexes/{}", urlencode(self.uid.as_ref()));
+        self.service.patch_encoded(url, body, self.encoder).await
+    }
+
     pub async fn update(&self, primary_key: Option<&str>) -> (Value, StatusCode) {
         let body = json!({
             "primaryKey": primary_key,

meilisearch/tests/common/server.rs

@@ -95,10 +95,18 @@ impl Server {
         self.index_with_encoder(uid, Encoder::Plain)
     }
 
+    pub async fn create_index(&self, body: Value) -> (Value, StatusCode) {
+        self.service.post("/indexes", body).await
+    }
+
     pub fn index_with_encoder(&self, uid: impl AsRef<str>, encoder: Encoder) -> Index<'_> {
         Index { uid: uid.as_ref().to_string(), service: &self.service, encoder }
     }
 
+    pub async fn list_indexes_raw(&self, parameters: &str) -> (Value, StatusCode) {
+        self.service.get(format!("/indexes{parameters}")).await
+    }
+
     pub async fn list_indexes(
         &self,
         offset: Option<usize>,

meilisearch/tests/index/errors.rs

@@ -0,0 +1,265 @@
+use meili_snap::*;
+use serde_json::json;
+
+use crate::common::Server;
+
+#[actix_rt::test]
+async fn get_indexes_bad_offset() {
+    let server = Server::new().await;
+
+    let (response, code) = server.list_indexes_raw("?offset=doggo").await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value in parameter `offset`: could not parse `doggo` as a positive integer",
+      "code": "invalid_index_offset",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_offset"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn get_indexes_bad_limit() {
+    let server = Server::new().await;
+
+    let (response, code) = server.list_indexes_raw("?limit=doggo").await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value in parameter `limit`: could not parse `doggo` as a positive integer",
+      "code": "invalid_index_limit",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_limit"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn get_indexes_unknown_field() {
+    let server = Server::new().await;
+
+    let (response, code) = server.list_indexes_raw("?doggo=nolimit").await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Unknown parameter `doggo`: expected one of `offset`, `limit`",
+      "code": "bad_request",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#bad_request"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn create_index_missing_uid() {
+    let server = Server::new().await;
+
+    let (response, code) = server.create_index(json!({ "primaryKey": "doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Missing field `uid`",
+      "code": "missing_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#missing_index_uid"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn create_index_bad_uid() {
+    let server = Server::new().await;
+
+    let (response, code) = server.create_index(json!({ "uid": "the best doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value at `.uid`: `the best doggo` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+      "code": "invalid_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
+    }
+    "###);
+
+    let (response, code) = server.create_index(json!({ "uid": true })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value type at `.uid`: expected a string, but found a boolean: `true`",
+      "code": "invalid_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn create_index_bad_primary_key() {
+    let server = Server::new().await;
+
+    let (response, code) = server
+        .create_index(json!({ "uid": "doggo", "primaryKey": ["the", "best", "doggo"] }))
+        .await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value type at `.primaryKey`: expected a string, but found an array: `[\"the\",\"best\",\"doggo\"]`",
+      "code": "invalid_index_primary_key",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_primary_key"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn create_index_unknown_field() {
+    let server = Server::new().await;
+
+    let (response, code) = server.create_index(json!({ "uid": "doggo", "doggo": "bernese" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Unknown field `doggo`: expected one of `uid`, `primaryKey`",
+      "code": "bad_request",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#bad_request"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn get_index_bad_uid() {
+    let server = Server::new().await;
+    let index = server.index("the good doggo");
+
+    let (response, code) = index.get().await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "`the good doggo` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+      "code": "invalid_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_bad_primary_key() {
+    let server = Server::new().await;
+    let index = server.index("doggo");
+
+    let (response, code) = index.update_raw(json!({ "primaryKey": ["doggo"] })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Invalid value type at `.primaryKey`: expected a string, but found an array: `[\"doggo\"]`",
+      "code": "invalid_index_primary_key",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_primary_key"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_immutable_uid() {
+    let server = Server::new().await;
+    let index = server.index("doggo");
+
+    let (response, code) = index.update_raw(json!({ "uid": "doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Immutable field `uid`: expected one of `primaryKey`",
+      "code": "immutable_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#immutable_index_uid"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_immutable_created_at() {
+    let server = Server::new().await;
+    let index = server.index("doggo");
+
+    let (response, code) = index.update_raw(json!({ "createdAt": "doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Immutable field `createdAt`: expected one of `primaryKey`",
+      "code": "immutable_index_created_at",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#immutable_index_created_at"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_immutable_updated_at() {
+    let server = Server::new().await;
+    let index = server.index("doggo");
+
+    let (response, code) = index.update_raw(json!({ "updatedAt": "doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Immutable field `updatedAt`: expected one of `primaryKey`",
+      "code": "immutable_index_updated_at",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#immutable_index_updated_at"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_unknown_field() {
+    let server = Server::new().await;
+    let index = server.index("doggo");
+
+    let (response, code) = index.update_raw(json!({ "doggo": "bork" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "Unknown field `doggo`: expected one of `primaryKey`",
+      "code": "bad_request",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#bad_request"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn update_index_bad_uid() {
+    let server = Server::new().await;
+    let index = server.index("the good doggo");
+
+    let (response, code) = index.update_raw(json!({ "primaryKey": "doggo" })).await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "`the good doggo` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+      "code": "invalid_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
+    }
+    "###);
+}
+
+#[actix_rt::test]
+async fn delete_index_bad_uid() {
+    let server = Server::new().await;
+    let index = server.index("the good doggo");
+
+    let (response, code) = index.delete().await;
+    snapshot!(code, @"400 Bad Request");
+    snapshot!(json_string!(response), @r###"
+    {
+      "message": "`the good doggo` is not a valid index uid. Index uid can be an integer or a string containing only alphanumeric characters, hyphens (-) and underscores (_).",
+      "code": "invalid_index_uid",
+      "type": "invalid_request",
+      "link": "https://docs.meilisearch.com/errors#invalid_index_uid"
+    }
+    "###);
+}

meilisearch/tests/index/mod.rs

@@ -1,5 +1,6 @@
 mod create_index;
 mod delete_index;
+mod errors;
 mod get_index;
 mod stats;
 mod update_index;