mockforge-test 0.3.117

Test utilities for MockForge - easy integration with Playwright and Vitest
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! # MockForge Test Utilities
//!
//! Test utilities for MockForge to simplify integration with test frameworks like Playwright and Vitest.
//!
//! ## Features
//!
//! - **Easy Server Spawning**: Start and stop MockForge servers programmatically
//! - **Health Checks**: Wait for server readiness with configurable timeouts
//! - **Scenario Management**: Switch scenarios/workspaces per-test
//! - **Process Management**: Automatic cleanup of spawned processes
//! - **Profile Support**: Run with different MockForge profiles
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use mockforge_test::{MockForgeServer, ServerConfig};
//!
//! #[tokio::test]
//! async fn test_with_mockforge() {
//!     // Start MockForge server
//!     let server = MockForgeServer::builder()
//!         .http_port(3000)
//!         .build()
//!         .await
//!         .expect("Failed to start server");
//!
//!     // Server is ready - run your tests
//!     let response = reqwest::get("http://localhost:3000/health")
//!         .await
//!         .expect("Failed to get health");
//!
//!     assert!(response.status().is_success());
//!
//!     // Server automatically stops when dropped
//! }
//! ```
//!
//! ## Scenario Switching
//!
//! ```rust,no_run
//! use mockforge_test::MockForgeServer;
//!
//! #[tokio::test]
//! async fn test_scenario_switching() {
//!     let server = MockForgeServer::builder()
//!         .http_port(3000)
//!         .build()
//!         .await
//!         .expect("Failed to start server");
//!
//!     // Switch to a different scenario
//!     server.scenario("user-auth-success")
//!         .await
//!         .expect("Failed to switch scenario");
//!
//!     // Test with the new scenario
//!     // ...
//! }
//! ```

pub mod config;
pub mod error;
pub mod fixtures;
pub mod health;
pub mod process;
pub mod scenario;
pub mod server;

pub use config::{ServerConfig, ServerConfigBuilder};
pub use error::{Error, Result};
pub use fixtures::{
    minimal_openapi_spec, openapi_spec_crud, openapi_spec_with_get, write_spec_to, write_temp_spec,
};
pub use health::{HealthCheck, HealthStatus};
pub use scenario::ScenarioManager;
pub use server::MockForgeServer;

/// Re-export commonly used types
pub use reqwest;
pub use tokio;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_config_builder() {
        let config = ServerConfig::builder().http_port(3000).admin_port(3001).build();

        assert_eq!(config.http_port, 3000);
        assert_eq!(config.admin_port, Some(3001));
    }
}