Merge pull request #133 from quicknode/claude/anchor-v2-testing-harness

Move every example onto Anchor v2's LiteSVM test harness

Author: mikemaccana

.github/workflows/anchor.yml

@@ -309,8 +309,10 @@ jobs:
               return 1
             fi
 
-            # Run anchor test
-            if ! anchor test; then
+            # Run anchor test. It regenerates the IDL too, so the skip above
+            # has to apply here as well or the projects it exempts fail at the
+            # test step instead of the build step.
+            if ! anchor test $idl_flag; then
               echo "::error::anchor test failed for $project"
               echo "$project: anchor test failed" >> $GITHUB_WORKSPACE/failed_projects.txt
               rm -rf target node_modules

basics/account-data/anchor/programs/anchor-program-example/Cargo.toml

@@ -18,6 +18,8 @@ idl-build = ["anchor-lang/idl-build"]
 anchor-debug = []
 custom-heap = []
 custom-panic = []
+# Forwards to the harness so `anchor test --profile` can turn tracing on.
+profile = ["anchor-v2-testing/profile"]
 
 [dependencies]
 anchor-lang = "2.0.0-rc.1"
@@ -26,9 +28,16 @@ anchor-lang = "2.0.0-rc.1"
 wincode = { version = "0.5", features = ["derive"] }
 
 [dev-dependencies]
-litesvm = "0.13.1"
-solana-signer = "3.0.0"
-solana-keypair = "3.0.1"
+# Anchor v2's own LiteSVM harness. `svm()` is `LiteSVM::new()` until the
+# `profile` feature is on, when it also records the SBF register traces that
+# `anchor test --profile`, `anchor debugger` and `anchor coverage` read. Tests
+# that call `LiteSVM::new()` directly still pass but produce no traces, so
+# those three tools see nothing.
+#
+# Published only from git: crates.io has no `anchor-v2-testing`. Pinned to a
+# revision rather than tracking `anchor-next`, so a CI run cannot change
+# behaviour because upstream moved between builds.
+anchor-v2-testing = { git = "https://github.com/otter-sec/anchor.git", rev = "3e38a121b969d1a77230baeb0056baf5cc9b3c1a" }
 borsh = "1.6.1"
 solana-kite = "0.4.0"
 

basics/account-data/anchor/programs/anchor-program-example/tests/test_account_data.rs

@@ -2,11 +2,9 @@ use {
     anchor_lang::{
         solana_program::instruction::Instruction, system_program, InstructionData, ToAccountMetas,
     },
+    anchor_v2_testing::{Keypair, LiteSVM, Signer},
     borsh::BorshDeserialize,
-    litesvm::LiteSVM,
-    solana_keypair::Keypair,
     solana_kite::{create_wallet, send_transaction_from_instructions},
-    solana_signer::Signer,
 };
 
 /// Deserialize the AddressInfo account (8-byte discriminator + fields).
@@ -22,7 +20,7 @@ struct AddressInfoAccount {
 #[test]
 fn test_create_address_info() {
     let program_id = account_data_anchor_program::id();
-    let mut svm = LiteSVM::new();
+    let mut svm = anchor_v2_testing::svm();
     let bytes = include_bytes!("../../../target/deploy/account_data_anchor_program.so");
     svm.add_program(program_id, bytes).unwrap();
     let payer = create_wallet(&mut svm, 10_000_000_000).unwrap();

basics/checking-accounts/anchor/programs/anchor-program-example/Cargo.toml

@@ -18,6 +18,8 @@ idl-build = ["anchor-lang/idl-build"]
 anchor-debug = []
 custom-heap = []
 custom-panic = []
+# Forwards to the harness so `anchor test --profile` can turn tracing on.
+profile = ["anchor-v2-testing/profile"]
 
 [dependencies]
 anchor-lang = "2.0.0-rc.1"
@@ -26,9 +28,16 @@ anchor-lang = "2.0.0-rc.1"
 wincode = { version = "0.5", features = ["derive"] }
 
 [dev-dependencies]
-litesvm = "0.13.1"
-solana-signer = "3.0.0"
-solana-keypair = "3.0.1"
+# Anchor v2's own LiteSVM harness. `svm()` is `LiteSVM::new()` until the
+# `profile` feature is on, when it also records the SBF register traces that
+# `anchor test --profile`, `anchor debugger` and `anchor coverage` read. Tests
+# that call `LiteSVM::new()` directly still pass but produce no traces, so
+# those three tools see nothing.
+#
+# Published only from git: crates.io has no `anchor-v2-testing`. Pinned to a
+# revision rather than tracking `anchor-next`, so a CI run cannot change
+# behaviour because upstream moved between builds.
+anchor-v2-testing = { git = "https://github.com/otter-sec/anchor.git", rev = "3e38a121b969d1a77230baeb0056baf5cc9b3c1a" }
 borsh = "1.6.1"
 solana-kite = "0.4.0"
 

basics/checking-accounts/anchor/programs/anchor-program-example/tests/test_checking_accounts.rs

@@ -3,16 +3,14 @@ use {
         solana_program::{instruction::Instruction, system_instruction},
         system_program, InstructionData, ToAccountMetas,
     },
-    litesvm::LiteSVM,
-    solana_keypair::Keypair,
+    anchor_v2_testing::{Keypair, LiteSVM, Signer},
     solana_kite::{create_wallet, send_transaction_from_instructions},
-    solana_signer::Signer,
 };
 
 #[test]
 fn test_check_accounts() {
     let program_id = checking_account_program::id();
-    let mut svm = LiteSVM::new();
+    let mut svm = anchor_v2_testing::svm();
     let bytes = include_bytes!("../../../target/deploy/checking_account_program.so");
     svm.add_program(program_id, bytes).unwrap();
     let payer = create_wallet(&mut svm, 10_000_000_000).unwrap();

basics/close-account/anchor/programs/close-account/Cargo.toml

@@ -18,6 +18,8 @@ idl-build = ["anchor-lang/idl-build"]
 anchor-debug = []
 custom-heap = []
 custom-panic = []
+# Forwards to the harness so `anchor test --profile` can turn tracing on.
+profile = ["anchor-v2-testing/profile"]
 
 [dependencies]
 anchor-lang = "2.0.0-rc.1"
@@ -32,9 +34,16 @@ wincode = { version = "0.5", features = ["derive"] }
 solana-address = ">=2.6, <2.7"
 
 [dev-dependencies]
-litesvm = "0.13.1"
-solana-signer = "3.0.0"
-solana-keypair = "3.0.1"
+# Anchor v2's own LiteSVM harness. `svm()` is `LiteSVM::new()` until the
+# `profile` feature is on, when it also records the SBF register traces that
+# `anchor test --profile`, `anchor debugger` and `anchor coverage` read. Tests
+# that call `LiteSVM::new()` directly still pass but produce no traces, so
+# those three tools see nothing.
+#
+# Published only from git: crates.io has no `anchor-v2-testing`. Pinned to a
+# revision rather than tracking `anchor-next`, so a CI run cannot change
+# behaviour because upstream moved between builds.
+anchor-v2-testing = { git = "https://github.com/otter-sec/anchor.git", rev = "3e38a121b969d1a77230baeb0056baf5cc9b3c1a" }
 solana-kite = "0.4.0"
 
 [lints.rust]

basics/close-account/anchor/programs/close-account/tests/test_close_account.rs

@@ -3,15 +3,13 @@ use {
         solana_program::instruction::Instruction, system_program, Address, InstructionData,
         ToAccountMetas,
     },
-    litesvm::LiteSVM,
-    solana_keypair::Keypair,
+    anchor_v2_testing::{Keypair, LiteSVM, Signer},
     solana_kite::{create_wallet, send_transaction_from_instructions},
-    solana_signer::Signer,
 };
 
 fn setup() -> (LiteSVM, Keypair) {
     let program_id = close_account_program::id();
-    let mut svm = LiteSVM::new();
+    let mut svm = anchor_v2_testing::svm();
     let bytes = include_bytes!("../../../target/deploy/close_account_program.so");
     svm.add_program(program_id, bytes).unwrap();
     let payer = create_wallet(&mut svm, 10_000_000_000).unwrap();

basics/counter/anchor/programs/counter_anchor/Cargo.toml

@@ -14,6 +14,8 @@ cpi = ["no-entrypoint"]
 no-entrypoint = []
 no-idl = []
 no-log-ix-name = []
+# Forwards to the harness so `anchor test --profile` can turn tracing on.
+profile = ["anchor-v2-testing/profile"]
 idl-build = ["anchor-lang/idl-build"]
 anchor-debug = []
 custom-heap = []
@@ -26,9 +28,16 @@ anchor-lang = "2.0.0-rc.1"
 wincode = { version = "0.5", features = ["derive"] }
 
 [dev-dependencies]
-litesvm = "0.13.1"
-solana-signer = "3.0.0"
-solana-keypair = "3.0.1"
+# Anchor v2's own LiteSVM harness. `svm()` is `LiteSVM::new()` until the
+# `profile` feature is on, when it also records the SBF register traces that
+# `anchor test --profile`, `anchor debugger` and `anchor coverage` read. Tests
+# that call `LiteSVM::new()` directly still pass but produce no traces, so
+# those three tools see nothing.
+#
+# It is published only from git: crates.io has no `anchor-v2-testing`. Pinned
+# to a revision rather than tracking `anchor-next`, so a CI run cannot change
+# behaviour because upstream moved between builds.
+anchor-v2-testing = { git = "https://github.com/otter-sec/anchor.git", rev = "3e38a121b969d1a77230baeb0056baf5cc9b3c1a" }
 borsh = "1.6.1"
 solana-kite = "0.4.0"
 

basics/counter/anchor/programs/counter_anchor/tests/test_counter.rs

@@ -2,11 +2,9 @@ use {
     anchor_lang::{
         solana_program::instruction::Instruction, system_program, InstructionData, ToAccountMetas,
     },
+    anchor_v2_testing::{Keypair, LiteSVM, Signer},
     borsh::BorshDeserialize,
-    litesvm::LiteSVM,
-    solana_keypair::Keypair,
     solana_kite::{create_wallet, send_transaction_from_instructions},
-    solana_signer::Signer,
 };
 
 /// Minimal deserialization of the Counter account (8-byte discriminator + u64).
@@ -18,7 +16,7 @@ struct CounterAccount {
 
 fn setup() -> (LiteSVM, anchor_lang::prelude::Address, Keypair) {
     let program_id = counter_anchor::id();
-    let mut svm = LiteSVM::new();
+    let mut svm = anchor_v2_testing::svm();
     let bytes = include_bytes!("../../../target/deploy/counter_anchor.so");
     svm.add_program(program_id, bytes).unwrap();
     let payer = create_wallet(&mut svm, 10_000_000_000).unwrap();

basics/create-account/anchor/programs/create-system-account/Cargo.toml

@@ -18,6 +18,8 @@ idl-build = ["anchor-lang/idl-build"]
 anchor-debug = []
 custom-heap = []
 custom-panic = []
+# Forwards to the harness so `anchor test --profile` can turn tracing on.
+profile = ["anchor-v2-testing/profile"]
 
 [dependencies]
 anchor-lang = "2.0.0-rc.1"
@@ -26,9 +28,16 @@ anchor-lang = "2.0.0-rc.1"
 wincode = { version = "0.5", features = ["derive"] }
 
 [dev-dependencies]
-litesvm = "0.13.1"
-solana-signer = "3.0.0"
-solana-keypair = "3.0.1"
+# Anchor v2's own LiteSVM harness. `svm()` is `LiteSVM::new()` until the
+# `profile` feature is on, when it also records the SBF register traces that
+# `anchor test --profile`, `anchor debugger` and `anchor coverage` read. Tests
+# that call `LiteSVM::new()` directly still pass but produce no traces, so
+# those three tools see nothing.
+#
+# Published only from git: crates.io has no `anchor-v2-testing`. Pinned to a
+# revision rather than tracking `anchor-next`, so a CI run cannot change
+# behaviour because upstream moved between builds.
+anchor-v2-testing = { git = "https://github.com/otter-sec/anchor.git", rev = "3e38a121b969d1a77230baeb0056baf5cc9b3c1a" }
 solana-kite = "0.4.0"
 
 [lints.rust]