ibapi 2.11.2

A Rust implementation of the Interactive Brokers TWS API, providing a reliable and user friendly interface for TWS and IB Gateway. Designed with a focus on simplicity and performance.
Documentation
//! Test utilities shared across all modules for testing

#[cfg(test)]
#[allow(dead_code)] // These utilities will be used by other modules
pub mod helpers {
    use crate::stubs::MessageBusStub;
    use crate::{server_versions, Client};
    use std::sync::{Arc, RwLock};

    /// Creates a test client with an empty message bus
    pub fn create_test_client() -> (Client, Arc<MessageBusStub>) {
        create_test_client_with_version(server_versions::SIZE_RULES)
    }

    /// Creates a test client with a specific server version
    pub fn create_test_client_with_version(server_version: i32) -> (Client, Arc<MessageBusStub>) {
        let message_bus = Arc::new(MessageBusStub {
            request_messages: RwLock::new(vec![]),
            response_messages: vec![],
        });
        let client = Client::stubbed(message_bus.clone(), server_version);
        (client, message_bus)
    }

    /// Creates a test client with specified response messages
    pub fn create_test_client_with_responses(responses: Vec<String>) -> (Client, Arc<MessageBusStub>) {
        let message_bus = Arc::new(MessageBusStub {
            request_messages: RwLock::new(vec![]),
            response_messages: responses,
        });
        let client = Client::stubbed(message_bus.clone(), server_versions::SIZE_RULES);
        (client, message_bus)
    }

    /// Creates a test client with specified response messages and server version
    pub fn create_test_client_with_responses_and_version(responses: Vec<String>, server_version: i32) -> (Client, Arc<MessageBusStub>) {
        let message_bus = Arc::new(MessageBusStub {
            request_messages: RwLock::new(vec![]),
            response_messages: responses,
        });
        let client = Client::stubbed(message_bus.clone(), server_version);
        (client, message_bus)
    }

    #[cfg(feature = "sync")]
    pub fn create_blocking_test_client() -> (crate::client::blocking::Client, Arc<MessageBusStub>) {
        create_blocking_test_client_with_version(server_versions::SIZE_RULES)
    }

    #[cfg(feature = "sync")]
    pub fn create_blocking_test_client_with_version(server_version: i32) -> (crate::client::blocking::Client, Arc<MessageBusStub>) {
        create_blocking_test_client_with_responses_and_version(vec![], server_version)
    }

    #[cfg(feature = "sync")]
    pub fn create_blocking_test_client_with_responses(responses: Vec<String>) -> (crate::client::blocking::Client, Arc<MessageBusStub>) {
        create_blocking_test_client_with_responses_and_version(responses, server_versions::SIZE_RULES)
    }

    #[cfg(feature = "sync")]
    pub fn create_blocking_test_client_with_responses_and_version(
        responses: Vec<String>,
        server_version: i32,
    ) -> (crate::client::blocking::Client, Arc<MessageBusStub>) {
        let message_bus = Arc::new(MessageBusStub {
            request_messages: RwLock::new(vec![]),
            response_messages: responses,
        });
        let client = crate::client::blocking::Client::stubbed(message_bus.clone(), server_version);
        (client, message_bus)
    }

    /// Asserts that the request messages match expected values
    pub fn assert_request_messages(message_bus: &MessageBusStub, expected: &[&str]) {
        let request_messages = message_bus.request_messages.read().unwrap();
        assert_eq!(
            request_messages.len(),
            expected.len(),
            "Expected {} request messages, got {}",
            expected.len(),
            request_messages.len()
        );

        for (i, expected_msg) in expected.iter().enumerate() {
            assert_eq!(request_messages[i].encode_simple(), *expected_msg, "Request message {} mismatch", i);
        }
    }

    /// Gets request messages from the message bus
    pub fn get_request_messages(message_bus: &MessageBusStub) -> Vec<String> {
        message_bus
            .request_messages
            .read()
            .unwrap()
            .iter()
            .map(|msg| msg.encode_simple())
            .collect()
    }

    /// Asserts that a request message contains a specific substring
    pub fn assert_request_contains(message_bus: &MessageBusStub, index: usize, substring: &str) {
        let request_messages = get_request_messages(message_bus);
        assert!(
            request_messages.len() > index,
            "Expected at least {} request messages, got {}",
            index + 1,
            request_messages.len()
        );
        assert!(
            request_messages[index].contains(substring),
            "Request message {} does not contain '{}'. Actual: '{}'",
            index,
            substring,
            request_messages[index]
        );
    }

    /// Common test constants that can be used across modules
    pub mod constants {
        /// Test account identifiers
        pub const TEST_ACCOUNT: &str = "DU1234567";
        pub const TEST_ACCOUNT_2: &str = "DU7654321";
        pub const TEST_ACCOUNT_3: &str = "DU9876543";

        /// Test model codes
        pub const TEST_MODEL_CODE: &str = "TARGET2024";
        pub const TEST_MODEL_CODE_2: &str = "GROWTH2024";

        /// Test contract IDs
        pub const TEST_CONTRACT_ID: i32 = 1001;
        pub const TEST_CONTRACT_ID_2: i32 = 2002;

        /// Test order IDs
        pub const TEST_ORDER_ID: i32 = 5001;
        pub const TEST_ORDER_ID_2: i32 = 5002;

        /// Test ticker IDs
        pub const TEST_TICKER_ID: i32 = 100;
        pub const TEST_TICKER_ID_2: i32 = 200;
    }

    /// Re-export constants at module level for easier access
    pub use constants::*;
}

#[cfg(test)]
mod tests {
    use super::helpers::*;
    use crate::messages::RequestMessage;
    use crate::server_versions;

    #[test]
    fn test_create_test_client() {
        let (client, message_bus) = create_test_client();
        assert_eq!(client.server_version(), server_versions::SIZE_RULES);
        assert!(message_bus.request_messages.read().unwrap().is_empty());
        assert!(message_bus.response_messages.is_empty());
    }

    #[test]
    fn test_create_test_client_with_version() {
        let custom_version = 150;
        let (client, message_bus) = create_test_client_with_version(custom_version);
        assert_eq!(client.server_version(), custom_version);
        assert!(message_bus.request_messages.read().unwrap().is_empty());
        assert!(message_bus.response_messages.is_empty());
    }

    #[test]
    fn test_create_test_client_with_responses() {
        let responses = vec!["1|2|123|".to_string(), "2|2|456|".to_string()];
        let (client, message_bus) = create_test_client_with_responses(responses.clone());
        assert_eq!(client.server_version(), server_versions::SIZE_RULES);
        assert_eq!(message_bus.response_messages, responses);
    }

    #[test]
    fn test_assert_request_messages() {
        let (_client, message_bus) = create_test_client();

        // Add some test messages
        {
            let mut request_messages = message_bus.request_messages.write().unwrap();
            let mut msg1 = RequestMessage::new();
            msg1.push_field(&1);
            msg1.push_field(&"test1");
            request_messages.push(msg1);

            let mut msg2 = RequestMessage::new();
            msg2.push_field(&2);
            msg2.push_field(&"test2");
            request_messages.push(msg2);
        }

        assert_request_messages(&message_bus, &["1|test1|", "2|test2|"]);
    }

    #[test]
    fn test_get_request_messages() {
        let (_client, message_bus) = create_test_client();

        {
            let mut request_messages = message_bus.request_messages.write().unwrap();
            let mut msg1 = RequestMessage::new();
            msg1.push_field(&10);
            msg1.push_field(&"hello");
            request_messages.push(msg1);
        }

        let messages = get_request_messages(&message_bus);
        assert_eq!(messages.len(), 1);
        assert_eq!(messages[0], "10|hello|");
    }

    #[test]
    fn test_assert_request_contains() {
        let (_client, message_bus) = create_test_client();

        {
            let mut request_messages = message_bus.request_messages.write().unwrap();
            let mut msg = RequestMessage::new();
            msg.push_field(&1);
            msg.push_field(&"hello world");
            msg.push_field(&42);
            request_messages.push(msg);
        }

        assert_request_contains(&message_bus, 0, "hello");
        assert_request_contains(&message_bus, 0, "world");
        assert_request_contains(&message_bus, 0, "42");
    }

    #[test]
    fn test_constants() {
        // Test that constants are accessible and have expected values
        assert_eq!(TEST_ACCOUNT, "DU1234567");
        assert_eq!(TEST_CONTRACT_ID, 1001);
        assert_eq!(TEST_ORDER_ID, 5001);
        assert_eq!(TEST_TICKER_ID, 100);
    }
}