spikard 0.3.5 → 0.5.0

data/vendor/crates/spikard-http/src/testing/test_client.rs

@@ -1,285 +1,283 @@
-//! Core test client for Spikard applications
-//!
-//! This module provides a language-agnostic TestClient that can be wrapped by
-//! language bindings (PyO3, napi-rs, magnus) to provide Pythonic, JavaScripty, and
-//! Ruby-like APIs respectively.
-//!
-//! The core client handles all HTTP method dispatch, query params, header management,
-//! body encoding (JSON, form-data, multipart), and response snapshot capture.
-
-use super::{ResponseSnapshot, SnapshotError, snapshot_response};
-use axum::http::{HeaderName, HeaderValue, Method};
-use axum_test::TestServer;
-use bytes::Bytes;
-use serde_json::Value;
-use std::sync::Arc;
-use urlencoding::encode;
-
-type MultipartPayload = Option<(Vec<(String, String)>, Vec<super::MultipartFilePart>)>;
-
-/// Core test client for making HTTP requests to a Spikard application.
-///
-/// This struct wraps axum-test's TestServer and provides a language-agnostic
-/// interface for making HTTP requests, sending WebSocket connections, and
-/// handling Server-Sent Events. Language bindings wrap this to provide
-/// native API surfaces.
-pub struct TestClient {
-    server: Arc<TestServer>,
-}
-
-impl TestClient {
-    /// Create a new test client from an Axum router
-    pub fn from_router(router: axum::Router) -> Result<Self, String> {
-        let server = TestServer::new(router).map_err(|e| format!("Failed to create test server: {}", e))?;
-
-        Ok(Self {
-            server: Arc::new(server),
-        })
-    }
-
-    /// Get the underlying test server (for WebSocket and SSE connections)
-    pub fn server(&self) -> &TestServer {
-        &self.server
-    }
-
-    /// Make a GET request
-    pub async fn get(
-        &self,
-        path: &str,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.get(&full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a POST request
-    pub async fn post(
-        &self,
-        path: &str,
-        json: Option<Value>,
-        form_data: Option<Vec<(String, String)>>,
-        multipart: MultipartPayload,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.post(&full_path);
-
-        // Apply headers first
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec.clone())?;
-        }
-
-        // Determine body and content-type
-        if let Some((form_fields, files)) = multipart {
-            let (body, boundary) = super::build_multipart_body(&form_fields, &files);
-            let content_type = format!("multipart/form-data; boundary={}", boundary);
-            request = request.add_header("content-type", &content_type);
-            request = request.bytes(Bytes::from(body));
-        } else if let Some(form_fields) = form_data {
-            let encoded = super::encode_urlencoded_body(&serde_json::to_value(&form_fields).unwrap_or(Value::Null))
-                .map_err(|e| SnapshotError::Decompression(format!("Form encoding failed: {}", e)))?;
-            request = request.add_header("content-type", "application/x-www-form-urlencoded");
-            request = request.bytes(Bytes::from(encoded));
-        } else if let Some(json_value) = json {
-            request = request.json(&json_value);
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a PUT request
-    pub async fn put(
-        &self,
-        path: &str,
-        json: Option<Value>,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.put(&full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        if let Some(json_value) = json {
-            request = request.json(&json_value);
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a PATCH request
-    pub async fn patch(
-        &self,
-        path: &str,
-        json: Option<Value>,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.patch(&full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        if let Some(json_value) = json {
-            request = request.json(&json_value);
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a DELETE request
-    pub async fn delete(
-        &self,
-        path: &str,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.delete(&full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make an OPTIONS request
-    pub async fn options(
-        &self,
-        path: &str,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.method(Method::OPTIONS, &full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a HEAD request
-    pub async fn head(
-        &self,
-        path: &str,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.method(Method::HEAD, &full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Make a TRACE request
-    pub async fn trace(
-        &self,
-        path: &str,
-        query_params: Option<Vec<(String, String)>>,
-        headers: Option<Vec<(String, String)>>,
-    ) -> Result<ResponseSnapshot, SnapshotError> {
-        let full_path = build_full_path(path, query_params.as_deref());
-        let mut request = self.server.method(Method::TRACE, &full_path);
-
-        if let Some(headers_vec) = headers {
-            request = self.add_headers(request, headers_vec)?;
-        }
-
-        let response = request.await;
-        snapshot_response(response).await
-    }
-
-    /// Add headers to a test request builder
-    fn add_headers(
-        &self,
-        mut request: axum_test::TestRequest,
-        headers: Vec<(String, String)>,
-    ) -> Result<axum_test::TestRequest, SnapshotError> {
-        for (key, value) in headers {
-            let header_name = HeaderName::from_bytes(key.as_bytes())
-                .map_err(|e| SnapshotError::InvalidHeader(format!("Invalid header name: {}", e)))?;
-            let header_value = HeaderValue::from_str(&value)
-                .map_err(|e| SnapshotError::InvalidHeader(format!("Invalid header value: {}", e)))?;
-            request = request.add_header(header_name, header_value);
-        }
-        Ok(request)
-    }
-}
-
-/// Build a full path with query parameters
-fn build_full_path(path: &str, query_params: Option<&[(String, String)]>) -> String {
-    match query_params {
-        None | Some(&[]) => path.to_string(),
-        Some(params) => {
-            let query_string: Vec<String> = params
-                .iter()
-                .map(|(k, v)| format!("{}={}", encode(k), encode(v)))
-                .collect();
-
-            if path.contains('?') {
-                format!("{}&{}", path, query_string.join("&"))
-            } else {
-                format!("{}?{}", path, query_string.join("&"))
-            }
-        }
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn build_full_path_no_params() {
-        let path = "/users";
-        assert_eq!(build_full_path(path, None), "/users");
-        assert_eq!(build_full_path(path, Some(&[])), "/users");
-    }
-
-    #[test]
-    fn build_full_path_with_params() {
-        let path = "/users";
-        let params = vec![
-            ("id".to_string(), "123".to_string()),
-            ("name".to_string(), "test user".to_string()),
-        ];
-        let result = build_full_path(path, Some(&params));
-        assert!(result.starts_with("/users?"));
-        assert!(result.contains("id=123"));
-        assert!(result.contains("name=test%20user"));
-    }
-
-    #[test]
-    fn build_full_path_existing_query() {
-        let path = "/users?active=true";
-        let params = vec![("id".to_string(), "123".to_string())];
-        let result = build_full_path(path, Some(&params));
-        assert_eq!(result, "/users?active=true&id=123");
-    }
-}
+//! Core test client for Spikard applications
+//!
+//! This module provides a language-agnostic TestClient that can be wrapped by
+//! language bindings (PyO3, napi-rs, magnus) to provide Pythonic, JavaScripty, and
+//! Ruby-like APIs respectively.
+//!
+//! The core client handles all HTTP method dispatch, query params, header management,
+//! body encoding (JSON, form-data, multipart), and response snapshot capture.
+
+use super::{ResponseSnapshot, SnapshotError, snapshot_response};
+use axum::http::{HeaderName, HeaderValue, Method};
+use axum_test::TestServer;
+use bytes::Bytes;
+use serde_json::Value;
+use std::sync::Arc;
+use urlencoding::encode;
+
+type MultipartPayload = Option<(Vec<(String, String)>, Vec<super::MultipartFilePart>)>;
+
+/// Core test client for making HTTP requests to a Spikard application.
+///
+/// This struct wraps axum-test's TestServer and provides a language-agnostic
+/// interface for making HTTP requests, sending WebSocket connections, and
+/// handling Server-Sent Events. Language bindings wrap this to provide
+/// native API surfaces.
+pub struct TestClient {
+    server: Arc<TestServer>,
+}
+
+impl TestClient {
+    /// Create a new test client from an Axum router
+    pub fn from_router(router: axum::Router) -> Result<Self, String> {
+        let server = TestServer::new(router).map_err(|e| format!("Failed to create test server: {}", e))?;
+
+        Ok(Self {
+            server: Arc::new(server),
+        })
+    }
+
+    /// Get the underlying test server (for WebSocket and SSE connections)
+    pub fn server(&self) -> &TestServer {
+        &self.server
+    }
+
+    /// Make a GET request
+    pub async fn get(
+        &self,
+        path: &str,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.get(&full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a POST request
+    pub async fn post(
+        &self,
+        path: &str,
+        json: Option<Value>,
+        form_data: Option<Vec<(String, String)>>,
+        multipart: MultipartPayload,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.post(&full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec.clone())?;
+        }
+
+        if let Some((form_fields, files)) = multipart {
+            let (body, boundary) = super::build_multipart_body(&form_fields, &files);
+            let content_type = format!("multipart/form-data; boundary={}", boundary);
+            request = request.add_header("content-type", &content_type);
+            request = request.bytes(Bytes::from(body));
+        } else if let Some(form_fields) = form_data {
+            let encoded = super::encode_urlencoded_body(&serde_json::to_value(&form_fields).unwrap_or(Value::Null))
+                .map_err(|e| SnapshotError::Decompression(format!("Form encoding failed: {}", e)))?;
+            request = request.add_header("content-type", "application/x-www-form-urlencoded");
+            request = request.bytes(Bytes::from(encoded));
+        } else if let Some(json_value) = json {
+            request = request.json(&json_value);
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a PUT request
+    pub async fn put(
+        &self,
+        path: &str,
+        json: Option<Value>,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.put(&full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        if let Some(json_value) = json {
+            request = request.json(&json_value);
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a PATCH request
+    pub async fn patch(
+        &self,
+        path: &str,
+        json: Option<Value>,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.patch(&full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        if let Some(json_value) = json {
+            request = request.json(&json_value);
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a DELETE request
+    pub async fn delete(
+        &self,
+        path: &str,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.delete(&full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make an OPTIONS request
+    pub async fn options(
+        &self,
+        path: &str,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.method(Method::OPTIONS, &full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a HEAD request
+    pub async fn head(
+        &self,
+        path: &str,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.method(Method::HEAD, &full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Make a TRACE request
+    pub async fn trace(
+        &self,
+        path: &str,
+        query_params: Option<Vec<(String, String)>>,
+        headers: Option<Vec<(String, String)>>,
+    ) -> Result<ResponseSnapshot, SnapshotError> {
+        let full_path = build_full_path(path, query_params.as_deref());
+        let mut request = self.server.method(Method::TRACE, &full_path);
+
+        if let Some(headers_vec) = headers {
+            request = self.add_headers(request, headers_vec)?;
+        }
+
+        let response = request.await;
+        snapshot_response(response).await
+    }
+
+    /// Add headers to a test request builder
+    fn add_headers(
+        &self,
+        mut request: axum_test::TestRequest,
+        headers: Vec<(String, String)>,
+    ) -> Result<axum_test::TestRequest, SnapshotError> {
+        for (key, value) in headers {
+            let header_name = HeaderName::from_bytes(key.as_bytes())
+                .map_err(|e| SnapshotError::InvalidHeader(format!("Invalid header name: {}", e)))?;
+            let header_value = HeaderValue::from_str(&value)
+                .map_err(|e| SnapshotError::InvalidHeader(format!("Invalid header value: {}", e)))?;
+            request = request.add_header(header_name, header_value);
+        }
+        Ok(request)
+    }
+}
+
+/// Build a full path with query parameters
+fn build_full_path(path: &str, query_params: Option<&[(String, String)]>) -> String {
+    match query_params {
+        None | Some(&[]) => path.to_string(),
+        Some(params) => {
+            let query_string: Vec<String> = params
+                .iter()
+                .map(|(k, v)| format!("{}={}", encode(k), encode(v)))
+                .collect();
+
+            if path.contains('?') {
+                format!("{}&{}", path, query_string.join("&"))
+            } else {
+                format!("{}?{}", path, query_string.join("&"))
+            }
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn build_full_path_no_params() {
+        let path = "/users";
+        assert_eq!(build_full_path(path, None), "/users");
+        assert_eq!(build_full_path(path, Some(&[])), "/users");
+    }
+
+    #[test]
+    fn build_full_path_with_params() {
+        let path = "/users";
+        let params = vec![
+            ("id".to_string(), "123".to_string()),
+            ("name".to_string(), "test user".to_string()),
+        ];
+        let result = build_full_path(path, Some(&params));
+        assert!(result.starts_with("/users?"));
+        assert!(result.contains("id=123"));
+        assert!(result.contains("name=test%20user"));
+    }
+
+    #[test]
+    fn build_full_path_existing_query() {
+        let path = "/users?active=true";
+        let params = vec![("id".to_string(), "123".to_string())];
+        let result = build_full_path(path, Some(&params));
+        assert_eq!(result, "/users?active=true&id=123");
+    }
+}