test(message-buffer): refactor test util methods into MessageBufferTestContext for less duplication

Author: swimricky

message_buffer/programs/mock-cpi-caller/tests/cases/mod.rs

@@ -1,5 +1,7 @@
 pub use {
     super::program_test::*,
+    anchor_lang::prelude::ProgramError,
+    message_buffer::MessageBufferError,
     solana_program_test::*,
     solana_sdk::{
         pubkey::Pubkey,
@@ -10,7 +12,7 @@ pub use {
     },
 };
 
-mod test_create_msg_buffer;
+mod test_create_buffer;
 mod test_delete_buffer;
 mod test_initialize;
 mod test_put_all;

message_buffer/programs/mock-cpi-caller/tests/cases/test_create_buffer.rs

@@ -0,0 +1,106 @@
+use super::*;
+
+#[tokio::test]
+async fn test_create_buffer() {
+    let mut context =
+        MessageBufferTestContext::initialize_with_default_test_allowed_programs(false)
+            .await
+            .unwrap();
+
+    let space = 1024;
+
+    let (msg_buffer_pda, msg_buffer_bump) = context
+        .create_buffer(MessageBufferTestContext::DEFAULT_TEST_PRICE_ID, space)
+        .await
+        .unwrap();
+
+
+    let msg_buffer_account_data = context
+        .fetch_msg_buffer_account_data(&msg_buffer_pda)
+        .await
+        .unwrap();
+
+
+    assert_eq!(msg_buffer_account_data.len(), space as usize);
+
+    let (bump, _version, _header_len, end_offsets) =
+        deserialize_msg_buffer_header(&msg_buffer_account_data);
+
+    assert_eq!(bump, msg_buffer_bump);
+    assert_eq!(end_offsets, [0u16; 255]);
+}
+
+#[tokio::test]
+async fn create_buffer_with_invalid_admin_should_fail() {
+    let mut context =
+        MessageBufferTestContext::initialize_with_default_test_allowed_programs(false)
+            .await
+            .unwrap();
+
+    let pyth_price_acct = MessageBufferTestContext::get_mock_pyth_price_account(
+        MessageBufferTestContext::DEFAULT_TEST_PRICE_ID,
+    );
+    let cpi_caller_auth = MessageBufferTestContext::get_mock_cpi_auth();
+    let space = 1024;
+    let invalid_admin = Keypair::new();
+    let (msg_buffer_pda, _) = find_msg_buffer_pda(cpi_caller_auth, pyth_price_acct);
+    let invalid_create_buffer_ix = create_msg_buffer_ix(
+        cpi_caller_auth,
+        pyth_price_acct,
+        space,
+        context.whitelist(),
+        invalid_admin.pubkey(),
+        msg_buffer_pda,
+    );
+
+    let res = context
+        .process_ixs(&[invalid_create_buffer_ix], vec![&invalid_admin])
+        .await;
+
+    assert!(res.is_err());
+
+    let err: ProgramError = res.unwrap_err().into();
+    // violates the whitelist has_one = admin constraint
+    assert_eq!(
+        err,
+        ProgramError::Custom(anchor_lang::error::ErrorCode::ConstraintHasOne.into())
+    )
+}
+
+#[tokio::test]
+async fn create_buffer_with_invalid_size_should_fail() {
+    let mut context =
+        MessageBufferTestContext::initialize_with_default_test_allowed_programs(false)
+            .await
+            .unwrap();
+
+
+    let pyth_price_acct = MessageBufferTestContext::get_mock_pyth_price_account(
+        MessageBufferTestContext::DEFAULT_TEST_PRICE_ID,
+    );
+    let cpi_caller_auth = MessageBufferTestContext::get_mock_cpi_auth();
+    let _whitelist = context.whitelist();
+    let admin = context.default_admin();
+
+    let (msg_buffer_pda, _) = find_msg_buffer_pda(cpi_caller_auth, pyth_price_acct);
+    let invalid_create_buffer_ix = create_msg_buffer_ix(
+        cpi_caller_auth,
+        pyth_price_acct,
+        1,
+        context.whitelist(),
+        admin.pubkey(),
+        msg_buffer_pda,
+    );
+
+    let res = context
+        .process_ixs(&[invalid_create_buffer_ix], vec![&admin])
+        .await;
+
+    assert!(res.is_err());
+
+    let err: ProgramError = res.unwrap_err().into();
+    assert_eq!(
+        err,
+        ProgramError::Custom(MessageBufferError::MessageBufferTooSmall.into())
+    );
+}

message_buffer/programs/mock-cpi-caller/tests/cases/test_create_msg_buffer.rs

@@ -2,51 +2,27 @@ use super::*;
 
 #[tokio::test]
 async fn test_delete_buffer() {
-    let pt_ctxt = &mut setup_program_test(false).await;
+    let mut context = MessageBufferTestContext::initialize_with_default_test_buffer(
+        false,
+        MessageBufferTestContext::DEFAULT_TARGET_SIZE,
+    )
+    .await
+    .unwrap();
 
-    let banks_client = &mut pt_ctxt.banks_client;
-    let payer = &pt_ctxt.payer;
-    let (whitelist_pda, _) = send_initialize_whitelist(banks_client, payer.pubkey(), payer)
-        .await
-        .unwrap();
+    let payer = context.payer.pubkey();
+    let (msg_buffer_pda, _) = MessageBufferTestContext::default_msg_buffer();
 
-    let mock_cpi_caller_auth = get_mock_cpi_auth();
+    let payer_lamports_before = context.get_balance(payer).await;
 
-    let allowed_programs = vec![mock_cpi_caller_auth];
-    send_set_allowed_programs(banks_client, payer, &whitelist_pda, &allowed_programs)
+    context
+        .delete_buffer(MessageBufferTestContext::DEFAULT_TEST_PRICE_ID)
         .await
         .unwrap();
-    let pyth_price_acct_id = 0u64;
-    let mock_pyth_price_acct = get_mock_pyth_price_account(pyth_price_acct_id);
-    let target_size = 1024;
-    let (msg_buffer_pda, msg_buffer_bump) = send_create_msg_buffer(
-        banks_client,
-        payer,
-        payer,
-        whitelist_pda,
-        mock_cpi_caller_auth,
-        mock_pyth_price_acct,
-        target_size,
-    )
-    .await
-    .unwrap();
-
-    let payer_lamports_before = banks_client.get_balance(payer.pubkey()).await.unwrap();
 
-    send_delete_msg_buffer(
-        banks_client,
-        payer,
-        whitelist_pda,
-        mock_cpi_caller_auth,
-        mock_pyth_price_acct,
-        msg_buffer_bump,
-    )
-    .await
-    .unwrap();
+    let msg_buffer_account_data = context.fetch_msg_buffer_account_data(&msg_buffer_pda).await;
+    assert!(msg_buffer_account_data.is_none());
 
-    let msg_buffer_account = banks_client.get_account(msg_buffer_pda).await.unwrap();
-    assert!(msg_buffer_account.is_none());
-    let payer_lamports_after = banks_client.get_balance(payer.pubkey()).await.unwrap();
+    let payer_lamports_after = context.get_balance(payer).await;
     assert!(payer_lamports_before < payer_lamports_after);
 }
 

message_buffer/programs/mock-cpi-caller/tests/cases/test_delete_buffer.rs

@@ -2,22 +2,15 @@ use super::*;
 
 #[tokio::test]
 async fn test_initialize() {
-    let pt_ctxt = &mut setup_program_test(false).await;
-
-    // Initialize whitelist
-
-    let banks_client = &mut pt_ctxt.banks_client;
-    let payer = &pt_ctxt.payer;
-    let (whitelist_pda, whitelist_bump) =
-        send_initialize_whitelist(banks_client, payer.pubkey(), payer)
-            .await
-            .unwrap();
+    let context = &mut MessageBufferTestContext::initialize_context(false).await;
+    let admin = context.payer.insecure_clone();
+    let (_, whitelist_bump) = context.initialize(admin).await.unwrap();
 
     let (whitelist_acct_bump, admin_pubkey, allowed_programs_len, allowed_programs) =
-        fetch_whitelist(banks_client, &whitelist_pda).await;
+        context.fetch_whitelist().await.unwrap();
 
     assert_eq!(whitelist_bump, whitelist_acct_bump);
-    assert_eq!(payer.pubkey(), admin_pubkey);
+    assert_eq!(context.payer.pubkey(), admin_pubkey);
 
     assert_eq!(0, allowed_programs_len);
     assert_eq!(allowed_programs, vec![]);