performed comprehensive tests on user-sign-up.

Author: arapsum

Cargo.lock

@@ -17,6 +17,7 @@ argon2 = "0.5.3"
 async-trait = "0.1.89"
 axum = { version = "0.8.8", features = ["json", "macros"] }
 axum-extra = { version = "0.12.5", features = ["cookie", "typed-header", "typed-routing"] }
+axum-test = { version = "19.1.1", features = ["typed-routing"] }
 chrono = { version = "0.4.44", features = ["serde"] }
 clap = { version = "4.5.60", features = ["derive"] }
 color-eyre = "0.6.5"
@@ -42,6 +43,8 @@ uuid = { version = "1.22.0", features = ["v4", "serde"] }
 validator = { version = "0.20.0", features = ["derive"] }
 
 [dev-dependencies]
+axum-test = { version = "19.1.1", features = ["typed-routing"] }
 insta = { version = "1.46.3", features = ["redactions", "filters"] }
+rstest = "0.26.1"
 serial = "0.4.0"
 serial_test = "3.4.0"

Cargo.toml

@@ -33,7 +33,7 @@ async fn register(
 
     let user = UserModel::register_user(ctx.db(), validated).await?;
 
-    Ok((StatusCode::OK, Json(UserResponse::new(&user))).into_response())
+    Ok((StatusCode::CREATED, Json(UserResponse::new(&user))).into_response())
 }
 
 #[debug_handler]

src/controllers/auth.rs

@@ -1,11 +1,18 @@
-use std::sync::{Arc, OnceLock};
+use std::{
+    future::Future,
+    sync::{Arc, OnceLock},
+};
 
 use auth::{
-    AppContext, Result,
+    App, AppContext, Result,
     config::{Config, Environment},
+    controllers,
 };
+use axum_test::{TestServer, TestServerConfig};
+use sqlx::PgPool;
 
 mod repository;
+mod requests;
 mod seed;
 
 pub async fn boot_test() -> Result<Arc<AppContext>> {
@@ -17,6 +24,28 @@ pub async fn boot_test() -> Result<Arc<AppContext>> {
     Ok(ctx)
 }
 
+pub async fn request<F, Fut>(f: F)
+where
+    F: FnOnce(TestServer, Arc<AppContext>) -> Fut,
+    Fut: Future<Output = ()>,
+{
+    let ctx = boot_test().await.unwrap();
+
+    let cfg = TestServerConfig {
+        default_content_type: Some("application/json".into()),
+        save_cookies: true,
+        ..Default::default()
+    };
+
+    let server = TestServer::new_with_config(controllers::router(&ctx), cfg);
+
+    f(server, ctx).await
+}
+
+pub async fn seed_data(db: &PgPool) -> Result<()> {
+    App::seed(db).await
+}
+
 static CLEANUP_UUID: OnceLock<Vec<(&'static str, &'static str)>> = OnceLock::new();
 static CLEANUP_DATE: OnceLock<Vec<(&'static str, &'static str)>> = OnceLock::new();
 static CLEANUP_PASSWORD: OnceLock<Vec<(&'static str, &'static str)>> = OnceLock::new();

tests/mod.rs

@@ -0,0 +1,111 @@
+use insta::{Settings, assert_debug_snapshot, with_settings};
+use rstest::rstest;
+use serial_test::serial;
+
+macro_rules! configure_insta {
+    ($(expr:expr),*) => {
+        let mut settings = Settings::clone_current();
+        settings.set_prepend_module_to_snapshot(false);
+        settings.set_snapshot_path("snapshots/auth");
+        settings.set_snapshot_suffix("auth");
+        let _guard = settings.bind_to_scope();
+    };
+}
+
+#[rstest]
+#[case(
+    "can_successfully_register_user",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test_user1",
+        "password": "SafePassWord11!",
+        "confirmPassword": "SafePassWord11!"
+    })
+)]
+#[case(
+    "when_passwords_do_not_match_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test_user1",
+        "password": "SafePassWord11!",
+        "confirmPassword": "SafePassWord11"
+    })
+)]
+#[case(
+    "when_password_is_under_eight_chars_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test_user1",
+        "password": "Safe",
+        "confirmPassword": "Safe"
+    })
+)]
+#[case(
+    "when_password_contains_whitespace_char_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test_user1",
+        "password": "ChangeMe 123!",
+        "confirmPassword": "ChangeMe 123!"
+    })
+)]
+#[case(
+    "when_password_contains_comma_char_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test_user1",
+        "password": "ChangeMe,123!",
+        "confirmPassword": "ChangeMe,123!"
+    })
+)]
+#[case(
+    "when_email_is_not_an_email_registration_fails",
+    serde_json::json!({
+        "email":  "test1:example.com",
+        "username": "test_user1",
+        "password": "Password123",
+        "confirmPassword": "Password123"
+    })
+)]
+#[case(
+    "when_username_is_under_six_chars_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test",
+        "password": "Password123",
+        "confirmPassword": "Password123"
+    })
+)]
+#[case(
+    "when_username_contains_non_alphanumeric_chars_registration_fails",
+    serde_json::json!({
+        "email":  "test1@example.com",
+        "username": "test user;+",
+        "password": "Password123",
+        "confirmPassword": "Password123"
+    })
+)]
+#[tokio::test]
+#[serial]
+async fn can_register_user(#[case] test_name: &str, #[case] params: serde_json::Value) {
+    crate::request(|server, ctx| async move {
+        configure_insta!();
+
+        crate::seed_data(ctx.db())
+            .await
+            .expect("Failed to seed data");
+
+        let response = server.post("/auth/sign-up").json(&params).await;
+
+        with_settings!({
+            filters => {
+                let mut filters = crate::cleanup_date().to_vec();
+               filters.extend(crate::cleanup_uuid().to_vec());
+               filters
+            }
+        },  {
+            assert_debug_snapshot!(test_name, (response.status_code(), response.text()))
+        })
+    })
+    .await;
+}

tests/requests/auth.rs

@@ -0,0 +1 @@
+mod auth;

tests/requests/mod.rs

@@ -0,0 +1,9 @@
+---
+source: tests/requests/auth.rs
+assertion_line: 55
+expression: "(response.status_code(), response.text())"
+---
+(
+    201,
+    "{\"id\":\"ID\",\"email\":\"test1@example.com\",\"username\":\"test_user1\",\"imageUrl\":null,\"verified\":false,\"createdAt\":\"DATEZ\",\"updatedAt\":\"DATEZ\"}",
+)

tests/requests/snapshots/auth/can_successfully_register_user@auth.snap

@@ -0,0 +1,9 @@
+---
+source: tests/requests/auth.rs
+assertion_line: 71
+expression: "(response.status_code(), response.text())"
+---
+(
+    422,
+    "{\"error\":\"{\\\"email\\\":\\\"Invalid email address\\\"}\"}",
+)

tests/requests/snapshots/auth/when_email_is_not_an_email_registration_fails@auth.snap

@@ -0,0 +1,9 @@
+---
+source: tests/requests/auth.rs
+assertion_line: 107
+expression: "(response.status_code(), response.text())"
+---
+(
+    422,
+    "{\"error\":\"{\\\"password\\\":\\\"password cannot have commas\\\"}\"}",
+)

tests/requests/snapshots/auth/when_password_contains_comma_char_registration_fails@auth.snap

@@ -0,0 +1,9 @@
+---
+source: tests/requests/auth.rs
+assertion_line: 107
+expression: "(response.status_code(), response.text())"
+---
+(
+    422,
+    "{\"error\":\"{\\\"password\\\":\\\"password cannot have spaces\\\"}\"}",
+)