Refactor setup into helpers using the wording 'given'

Author: davidsteiner

crates/hotfix/tests/common/setup.rs

@@ -1,14 +1,18 @@
 use crate::common::mock_application::MockApplication;
 use crate::common::mock_counterparty::MockCounterparty;
+use crate::common::session_assertions::SessionAssertions;
 use crate::common::test_messages::TestMessage;
 use hotfix::application::ApplicationRef;
 use hotfix::config::SessionConfig;
-use hotfix::session::SessionRef;
+use hotfix::session::{SessionRef, Status};
 use hotfix::store::in_memory::InMemoryMessageStore;
+use hotfix_message::Part;
+use hotfix_message::fix44::MSG_TYPE;
 
 pub const HEARTBEAT_INTERVAL: u64 = 30;
 
-pub async fn setup() -> (SessionRef<TestMessage>, MockCounterparty<TestMessage>) {
+pub async fn given_a_connected_session() -> (SessionRef<TestMessage>, MockCounterparty<TestMessage>)
+{
     let config = create_session_config();
     let counterparty_config = create_counterparty_session_config(config.clone());
 
@@ -21,6 +25,18 @@ pub async fn setup() -> (SessionRef<TestMessage>, MockCounterparty<TestMessage>)
     (session, mock_counterparty)
 }
 
+pub async fn given_an_active_session() -> (SessionRef<TestMessage>, MockCounterparty<TestMessage>) {
+    let (session, mut mock_counterparty) = given_a_connected_session().await;
+
+    mock_counterparty
+        .then_receives(|msg| assert_eq!(msg.header().get::<&str>(MSG_TYPE).unwrap(), "A"))
+        .await;
+    mock_counterparty.when_logon_is_sent().await;
+    session.then_status_changes_to(Status::Active).await;
+
+    (session, mock_counterparty)
+}
+
 pub fn create_session_config() -> SessionConfig {
     SessionConfig {
         begin_string: "FIX.4.4".to_string(),

crates/hotfix/tests/session_test_cases/heartbeat_tests.rs

@@ -1,7 +1,5 @@
 use crate::common::session_actions::SessionActions;
-use crate::common::session_assertions::SessionAssertions;
-use crate::common::setup::{HEARTBEAT_INTERVAL, setup};
-use hotfix::session::Status;
+use crate::common::setup::{HEARTBEAT_INTERVAL, given_an_active_session};
 use hotfix_message::Part;
 use hotfix_message::fix44::MSG_TYPE;
 use std::time::Duration;
@@ -17,15 +15,7 @@ use std::time::Duration;
 /// as required by the FIX protocol to prevent timeout disconnections.
 #[tokio::test(start_paused = true)]
 async fn test_heartbeats() {
-    let (session, mut mock_counterparty) = setup().await;
-
-    // assert that a logon message is received (type 'A')
-    mock_counterparty
-        .then_receives(|msg| assert_eq!(msg.header().get::<&str>(MSG_TYPE).unwrap(), "A"))
-        .await;
-    // counterparty responds with a logon to establish a happy session
-    mock_counterparty.when_logon_is_sent().await;
-    session.then_status_changes_to(Status::Active).await;
+    let (session, mut mock_counterparty) = given_an_active_session().await;
 
     // let's wait enough time for a heartbeat and assert that the heartbeat was sent
     when_time_elapses(Duration::from_secs(HEARTBEAT_INTERVAL + 1)).await;
@@ -48,18 +38,8 @@ async fn test_heartbeats() {
 /// if no response is received within the timeout period.
 #[tokio::test(start_paused = true)]
 async fn test_peer_timeout() {
-    let (session, mut mock_counterparty) = setup().await;
     let peer_interval = (1.2 * HEARTBEAT_INTERVAL as f64) as u64 + 1;
-
-    // assert that a logon message is received (type 'A')
-    mock_counterparty
-        .then_receives(|msg| assert_eq!(msg.header().get::<&str>(MSG_TYPE).unwrap(), "A"))
-        .await;
-    session.then_status_changes_to(Status::AwaitingLogon).await;
-
-    // counterparty responds with a logon to establish a happy session
-    mock_counterparty.when_logon_is_sent().await;
-    session.then_status_changes_to(Status::Active).await;
+    let (_session, mut mock_counterparty) = given_an_active_session().await;
 
     // let's wait enough time for a heartbeat and assert that the heartbeat was sent
     when_time_elapses(Duration::from_secs(HEARTBEAT_INTERVAL + 1)).await;

crates/hotfix/tests/session_test_cases/logon_tests.rs

@@ -1,6 +1,6 @@
 use crate::common::session_actions::SessionActions;
 use crate::common::session_assertions::SessionAssertions;
-use crate::common::setup::setup;
+use crate::common::setup::given_a_connected_session;
 use hotfix::session::Status;
 use hotfix_message::Part;
 use hotfix_message::fix44::MSG_TYPE;
@@ -10,12 +10,14 @@ use hotfix_message::fix44::MSG_TYPE;
 /// transitions to Active status, and disconnects cleanly.
 #[tokio::test]
 async fn test_happy_logon() {
-    let (session, mut mock_counterparty) = setup().await;
+    let (session, mut mock_counterparty) = given_a_connected_session().await;
 
     // assert that a logon message is received (type 'A')
     mock_counterparty
         .then_receives(|msg| assert_eq!(msg.header().get::<&str>(MSG_TYPE).unwrap(), "A"))
         .await;
+    session.then_status_changes_to(Status::AwaitingLogon).await;
+
     // counterparty responds with a logon to establish a happy session
     mock_counterparty.when_logon_is_sent().await;
     session.then_status_changes_to(Status::Active).await;