// Tests common to all protocols and storage engines #[tokio::test] async fn connect() { let db = new_db().await; db.health().await.unwrap(); } #[tokio::test] async fn yuse() { let db = new_db().await; let item = Ulid::new().to_string(); match db.create(Resource::from(item.as_str())).await.unwrap_err() { // Local engines return this error Error::Db(DbError::NsEmpty) => {} // Remote engines return this error Error::Api(ApiError::Query(error)) if error.contains("Specify a namespace to use") => {} error => panic!("{:?}", error), } db.use_ns(NS).await.unwrap(); match db.create(Resource::from(item.as_str())).await.unwrap_err() { // Local engines return this error Error::Db(DbError::DbEmpty) => {} // Remote engines return this error Error::Api(ApiError::Query(error)) if error.contains("Specify a database to use") => {} error => panic!("{:?}", error), } db.use_db(item.as_str()).await.unwrap(); db.create(Resource::from(item)).await.unwrap(); } #[tokio::test] async fn invalidate() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); db.invalidate().await.unwrap(); let error = db.create::>(("user", "john")).await.unwrap_err(); assert!( error.to_string().contains("Not enough permissions to perform this action"), "Unexpected error: {:?}", error ); } #[tokio::test] async fn signup_scope() { let db = new_db().await; let database = Ulid::new().to_string(); db.use_ns(NS).use_db(&database).await.unwrap(); let scope = Ulid::new().to_string(); let sql = format!( " DEFINE SCOPE {scope} SESSION 1s SIGNUP ( CREATE user SET email = $email, pass = crypto::argon2::generate($pass) ) SIGNIN ( SELECT * FROM user WHERE email = $email AND crypto::argon2::compare(pass, $pass) ) " ); let response = db.query(sql).await.unwrap(); response.check().unwrap(); db.signup(Scope { namespace: NS, database: &database, scope: &scope, params: AuthParams { email: "john.doe@example.com", pass: "password123", }, }) .await .unwrap(); } #[tokio::test] async fn signin_ns() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let user = Ulid::new().to_string(); let pass = "password123"; let sql = format!("DEFINE USER {user} ON NAMESPACE PASSWORD '{pass}'"); let response = db.query(sql).await.unwrap(); response.check().unwrap(); db.signin(Namespace { namespace: NS, username: &user, password: pass, }) .await .unwrap(); } #[tokio::test] async fn signin_db() { let db = new_db().await; let database = Ulid::new().to_string(); db.use_ns(NS).use_db(&database).await.unwrap(); let user = Ulid::new().to_string(); let pass = "password123"; let sql = format!("DEFINE USER {user} ON DATABASE PASSWORD '{pass}'"); let response = db.query(sql).await.unwrap(); response.check().unwrap(); db.signin(Database { namespace: NS, database: &database, username: &user, password: pass, }) .await .unwrap(); } #[tokio::test] async fn signin_scope() { let db = new_db().await; let database = Ulid::new().to_string(); db.use_ns(NS).use_db(&database).await.unwrap(); let scope = Ulid::new().to_string(); let email = format!("{scope}@example.com"); let pass = "password123"; let sql = format!( " DEFINE SCOPE {scope} SESSION 1s SIGNUP ( CREATE user SET email = $email, pass = crypto::argon2::generate($pass) ) SIGNIN ( SELECT * FROM user WHERE email = $email AND crypto::argon2::compare(pass, $pass) ) " ); let response = db.query(sql).await.unwrap(); response.check().unwrap(); db.signup(Scope { namespace: NS, database: &database, scope: &scope, params: AuthParams { pass, email: &email, }, }) .await .unwrap(); db.signin(Scope { namespace: NS, database: &database, scope: &scope, params: AuthParams { pass, email: &email, }, }) .await .unwrap(); } #[tokio::test] async fn authenticate() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let user = Ulid::new().to_string(); let pass = "password123"; let sql = format!("DEFINE USER {user} ON NAMESPACE PASSWORD '{pass}'"); let response = db.query(sql).await.unwrap(); response.check().unwrap(); let token = db .signin(Namespace { namespace: NS, username: &user, password: pass, }) .await .unwrap(); db.authenticate(token).await.unwrap(); } #[tokio::test] async fn query() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let _ = db .query( " CREATE user:john SET name = 'John Doe' ", ) .await .unwrap() .check() .unwrap(); let mut response = db.query("SELECT name FROM user:john").await.unwrap().check().unwrap(); let Some(name): Option = response.take("name").unwrap() else { panic!("query returned no record"); }; assert_eq!(name, "John Doe"); } #[tokio::test] async fn query_binds() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let mut response = db.query("CREATE user:john SET name = $name").bind(("name", "John Doe")).await.unwrap(); let Some(record): Option = response.take(0).unwrap() else { panic!("query returned no record"); }; assert_eq!(record.name, "John Doe"); let mut response = db .query("SELECT * FROM $record_id") .bind(("record_id", thing("user:john").unwrap())) .await .unwrap(); let Some(record): Option = response.take(0).unwrap() else { panic!("query returned no record"); }; assert_eq!(record.name, "John Doe"); let mut response = db .query("CREATE user SET name = $name") .bind(Record { name: "John Doe", }) .await .unwrap(); let Some(record): Option = response.take(0).unwrap() else { panic!("query returned no record"); }; assert_eq!(record.name, "John Doe"); } #[tokio::test] async fn query_chaining() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let response = db .query(BeginStatement) .query("CREATE account:one SET balance = 135605.16") .query("CREATE account:two SET balance = 91031.31") .query("UPDATE account:one SET balance += 300.00") .query("UPDATE account:two SET balance -= 300.00") .query(CommitStatement) .await .unwrap(); response.check().unwrap(); } #[tokio::test] async fn mixed_results_query() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let sql = "CREATE bar SET baz = rand('a'); CREATE foo;"; let mut response = db.query(sql).await.unwrap(); response.take::(0).unwrap_err(); let _: Option = response.take(1).unwrap(); } #[tokio::test] async fn create_record_no_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let _: Vec = db.create("user").await.unwrap(); let _: Value = db.create(Resource::from("user")).await.unwrap(); } #[tokio::test] async fn create_record_with_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let _: Option = db.create(("user", "jane")).await.unwrap(); let _: Value = db.create(Resource::from(("user", "john"))).await.unwrap(); let _: Value = db.create(Resource::from("user:doe")).await.unwrap(); } #[tokio::test] async fn create_record_no_id_with_content() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let _: Vec = db .create("user") .content(Record { name: "John Doe", }) .await .unwrap(); let _: Value = db .create(Resource::from("user")) .content(Record { name: "John Doe", }) .await .unwrap(); } #[tokio::test] async fn create_record_with_id_with_content() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let record: Option = db .create(("user", "john")) .content(Record { name: "John Doe", }) .await .unwrap(); assert_eq!(record.unwrap().id, thing("user:john").unwrap()); let value: Value = db .create(Resource::from("user:jane")) .content(Record { name: "Jane Doe", }) .await .unwrap(); assert_eq!(value.record(), thing("user:jane").ok()); } #[tokio::test] async fn select_table() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let table = "user"; let _: Vec = db.create(table).await.unwrap(); let _: Vec = db.create(table).await.unwrap(); let _: Value = db.create(Resource::from(table)).await.unwrap(); let users: Vec = db.select(table).await.unwrap(); assert_eq!(users.len(), 3); } #[tokio::test] async fn select_record_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let record_id = ("user", "john"); let _: Option = db.create(record_id).await.unwrap(); let Some(record): Option = db.select(record_id).await.unwrap() else { panic!("record not found"); }; assert_eq!(record.id, thing("user:john").unwrap()); let value: Value = db.select(Resource::from(record_id)).await.unwrap(); assert_eq!(value.record(), thing("user:john").ok()); } #[tokio::test] async fn select_record_ranges() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let table = "user"; let _: Option = db.create((table, "amos")).await.unwrap(); let _: Option = db.create((table, "jane")).await.unwrap(); let _: Option = db.create((table, "john")).await.unwrap(); let _: Value = db.create(Resource::from((table, "zoey"))).await.unwrap(); let convert = |users: Vec| -> Vec { users.into_iter().map(|user| user.id.id.to_string()).collect() }; let users: Vec = db.select(table).range(..).await.unwrap(); assert_eq!(convert(users), vec!["amos", "jane", "john", "zoey"]); let users: Vec = db.select(table).range(.."john").await.unwrap(); assert_eq!(convert(users), vec!["amos", "jane"]); let users: Vec = db.select(table).range(..="john").await.unwrap(); assert_eq!(convert(users), vec!["amos", "jane", "john"]); let users: Vec = db.select(table).range("jane"..).await.unwrap(); assert_eq!(convert(users), vec!["jane", "john", "zoey"]); let users: Vec = db.select(table).range("jane".."john").await.unwrap(); assert_eq!(convert(users), vec!["jane"]); let users: Vec = db.select(table).range("jane"..="john").await.unwrap(); assert_eq!(convert(users), vec!["jane", "john"]); let Value::Array(array): Value = db.select(Resource::from(table)).range("jane"..="john").await.unwrap() else { unreachable!(); }; assert_eq!(array.len(), 2); let users: Vec = db.select(table).range((Bound::Excluded("jane"), Bound::Included("john"))).await.unwrap(); assert_eq!(convert(users), vec!["john"]); } #[tokio::test] async fn update_table() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let table = "user"; let _: Vec = db.create(table).await.unwrap(); let _: Vec = db.create(table).await.unwrap(); let _: Value = db.update(Resource::from(table)).await.unwrap(); let users: Vec = db.update(table).await.unwrap(); assert_eq!(users.len(), 2); } #[tokio::test] async fn update_record_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let table = "user"; let _: Option = db.create((table, "john")).await.unwrap(); let _: Option = db.create((table, "jane")).await.unwrap(); let users: Vec = db.update(table).await.unwrap(); assert_eq!(users.len(), 2); } #[tokio::test] async fn update_table_with_content() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let sql = " CREATE type::thing($table, 'amos') SET name = 'Amos'; CREATE type::thing($table, 'jane') SET name = 'Jane'; CREATE type::thing($table, 'john') SET name = 'John'; CREATE type::thing($table, 'zoey') SET name = 'Zoey'; "; let table = "user"; let response = db.query(sql).bind(("table", table)).await.unwrap(); response.check().unwrap(); let users: Vec = db .update(table) .content(Record { name: "Doe", }) .await .unwrap(); let expected = &[ RecordBuf { id: thing("user:amos").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:jane").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:john").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:zoey").unwrap(), name: "Doe".to_owned(), }, ]; assert_eq!(users, expected); let users: Vec = db.select(table).await.unwrap(); assert_eq!(users, expected); } #[tokio::test] async fn update_record_range_with_content() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let sql = " CREATE type::thing($table, 'amos') SET name = 'Amos'; CREATE type::thing($table, 'jane') SET name = 'Jane'; CREATE type::thing($table, 'john') SET name = 'John'; CREATE type::thing($table, 'zoey') SET name = 'Zoey'; "; let table = "user"; let response = db.query(sql).bind(("table", table)).await.unwrap(); response.check().unwrap(); let users: Vec = db .update(table) .range("jane".."zoey") .content(Record { name: "Doe", }) .await .unwrap(); assert_eq!( users, &[ RecordBuf { id: thing("user:jane").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:john").unwrap(), name: "Doe".to_owned(), }, ] ); let users: Vec = db.select(table).await.unwrap(); assert_eq!( users, &[ RecordBuf { id: thing("user:amos").unwrap(), name: "Amos".to_owned(), }, RecordBuf { id: thing("user:jane").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:john").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:zoey").unwrap(), name: "Zoey".to_owned(), }, ] ); } #[tokio::test] async fn update_record_id_with_content() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let record_id = ("user", "john"); let user: Option = db .create(record_id) .content(Record { name: "Jane Doe", }) .await .unwrap(); assert_eq!(user.unwrap().name, "Jane Doe"); let user: Option = db .update(record_id) .content(Record { name: "John Doe", }) .await .unwrap(); assert_eq!(user.unwrap().name, "John Doe"); let user: Option = db.select(record_id).await.unwrap(); assert_eq!(user.unwrap().name, "John Doe"); } #[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd)] struct Name { first: Cow<'static, str>, last: Cow<'static, str>, } #[derive(Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd)] struct Person { #[serde(skip_serializing)] id: Option, title: Cow<'static, str>, name: Name, marketing: bool, } #[tokio::test] async fn merge_record_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let record_id = ("person", "jaime"); let mut jaime: Option = db .create(record_id) .content(Person { id: None, title: "Founder & COO".into(), name: Name { first: "Jaime".into(), last: "Morgan Hitchcock".into(), }, marketing: false, }) .await .unwrap(); assert_eq!(jaime.unwrap().id.unwrap(), thing("person:jaime").unwrap()); jaime = db.update(record_id).merge(json!({ "marketing": true })).await.unwrap(); assert!(jaime.as_ref().unwrap().marketing); jaime = db.select(record_id).await.unwrap(); assert_eq!( jaime.unwrap(), Person { id: Some(thing("person:jaime").unwrap()), title: "Founder & COO".into(), name: Name { first: "Jaime".into(), last: "Morgan Hitchcock".into(), }, marketing: true, } ); } #[tokio::test] async fn patch_record_id() { #[derive(Debug, Deserialize, Eq, PartialEq)] struct Record { id: Thing, baz: String, hello: Vec, } let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let id = "john"; let _: Option = db .create(("user", id)) .content(json!({ "baz": "qux", "foo": "bar" })) .await .unwrap(); let _: Option = db .update(("user", id)) .patch(PatchOp::replace("/baz", "boo")) .patch(PatchOp::add("/hello", ["world"])) .patch(PatchOp::remove("/foo")) .await .unwrap(); let value: Option = db.select(("user", id)).await.unwrap(); assert_eq!( value, Some(Record { id: thing(&format!("user:{id}")).unwrap(), baz: "boo".to_owned(), hello: vec!["world".to_owned()], }) ); } #[tokio::test] async fn delete_table() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let table = "user"; let _: Vec = db.create(table).await.unwrap(); let _: Vec = db.create(table).await.unwrap(); let _: Vec = db.create(table).await.unwrap(); let users: Vec = db.select(table).await.unwrap(); assert_eq!(users.len(), 3); let users: Vec = db.delete(table).await.unwrap(); assert_eq!(users.len(), 3); let users: Vec = db.select(table).await.unwrap(); assert!(users.is_empty()); } #[tokio::test] async fn delete_record_id() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let record_id = ("user", "john"); let _: Option = db.create(record_id).await.unwrap(); let _: Option = db.select(record_id).await.unwrap(); let john: Option = db.delete(record_id).await.unwrap(); assert!(john.is_some()); let john: Option = db.select(record_id).await.unwrap(); assert!(john.is_none()); // non-existing user let jane: Option = db.delete(("user", "jane")).await.unwrap(); assert!(jane.is_none()); let value = db.delete(Resource::from(("user", "jane"))).await.unwrap(); assert_eq!(value, Value::None); } #[tokio::test] async fn delete_record_range() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let sql = " CREATE type::thing($table, 'amos') SET name = 'Amos'; CREATE type::thing($table, 'jane') SET name = 'Jane'; CREATE type::thing($table, 'john') SET name = 'John'; CREATE type::thing($table, 'zoey') SET name = 'Zoey'; "; let table = "user"; let response = db.query(sql).bind(("table", table)).await.unwrap(); response.check().unwrap(); let users: Vec = db.delete(table).range("jane".."zoey").await.unwrap(); assert_eq!( users, &[ RecordBuf { id: thing("user:jane").unwrap(), name: "Jane".to_owned(), }, RecordBuf { id: thing("user:john").unwrap(), name: "John".to_owned(), }, ] ); let users: Vec = db.select(table).await.unwrap(); assert_eq!( users, &[ RecordBuf { id: thing("user:amos").unwrap(), name: "Amos".to_owned(), }, RecordBuf { id: thing("user:zoey").unwrap(), name: "Zoey".to_owned(), }, ] ); } #[tokio::test] async fn changefeed() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); // Enable change feeds let sql = " DEFINE TABLE user CHANGEFEED 1h; "; let response = db.query(sql).await.unwrap(); response.check().unwrap(); // Create and update users let sql = " CREATE user:amos SET name = 'Amos'; CREATE user:jane SET name = 'Jane'; UPDATE user:amos SET name = 'AMOS'; "; let table = "user"; let response = db.query(sql).await.unwrap(); response.check().unwrap(); let users: Vec = db .update(table) .content(Record { name: "Doe", }) .await .unwrap(); let expected = &[ RecordBuf { id: thing("user:amos").unwrap(), name: "Doe".to_owned(), }, RecordBuf { id: thing("user:jane").unwrap(), name: "Doe".to_owned(), }, ]; assert_eq!(users, expected); let users: Vec = db.select(table).await.unwrap(); assert_eq!(users, expected); let sql = " SHOW CHANGES FOR TABLE user SINCE 0 LIMIT 10; "; let mut response = db.query(sql).await.unwrap(); let value: Value = response.take(0).unwrap(); let Value::Array(array) = value.clone() else { unreachable!() }; assert_eq!(array.len(), 4); // UPDATE user:amos let a = array.get(0).unwrap(); let Value::Object(a) = a else { unreachable!() }; let Value::Number(versionstamp1) = a.get("versionstamp").unwrap() else { unreachable!() }; let changes = a.get("changes").unwrap().to_owned(); assert_eq!( changes, surrealdb::sql::value( "[ { update: { id: user:amos, name: 'Amos' } } ]" ) .unwrap() ); // UPDATE user:jane let a = array.get(1).unwrap(); let Value::Object(a) = a else { unreachable!() }; let Value::Number(versionstamp2) = a.get("versionstamp").unwrap() else { unreachable!() }; assert!(versionstamp1 < versionstamp2); let changes = a.get("changes").unwrap().to_owned(); assert_eq!( changes, surrealdb::sql::value( "[ { update: { id: user:jane, name: 'Jane' } } ]" ) .unwrap() ); // UPDATE user:amos let a = array.get(2).unwrap(); let Value::Object(a) = a else { unreachable!() }; let Value::Number(versionstamp3) = a.get("versionstamp").unwrap() else { unreachable!() }; assert!(versionstamp2 < versionstamp3); let changes = a.get("changes").unwrap().to_owned(); assert_eq!( changes, surrealdb::sql::value( "[ { update: { id: user:amos, name: 'AMOS' } } ]" ) .unwrap() ); // UPDATE table let a = array.get(3).unwrap(); let Value::Object(a) = a else { unreachable!() }; let Value::Number(versionstamp4) = a.get("versionstamp").unwrap() else { unreachable!() }; assert!(versionstamp3 < versionstamp4); let changes = a.get("changes").unwrap().to_owned(); assert_eq!( changes, surrealdb::sql::value( "[ { update: { id: user:amos, name: 'Doe' } }, { update: { id: user:jane, name: 'Doe' } } ]" ) .unwrap() ); } #[tokio::test] async fn version() { let db = new_db().await; db.version().await.unwrap(); } #[tokio::test] async fn set_unset() { let db = new_db().await; db.use_ns(NS).use_db(Ulid::new().to_string()).await.unwrap(); let (key, value) = ("name", "Doe"); let sql = "RETURN $name"; db.set(key, value).await.unwrap(); let mut response = db.query(sql).await.unwrap(); let Some(name): Option = response.take(0).unwrap() else { panic!("record not found"); }; assert_eq!(name, value); db.unset(key).await.unwrap(); let mut response = db.query(sql).await.unwrap(); let name: Option = response.take(0).unwrap(); assert!(name.is_none()); } #[tokio::test] async fn return_bool() { let db = new_db().await; let mut response = db.query("RETURN true").await.unwrap(); let Some(boolean): Option = response.take(0).unwrap() else { panic!("record not found"); }; assert!(boolean); let mut response = db.query("RETURN false").await.unwrap(); let value: Value = response.take(0).unwrap(); assert_eq!(value, vec![Value::Bool(false)].into()); }