Struct ProgramTest

pub struct ProgramTest { /* private fields */ }

Implementations

impl ProgramTest

pub fn new( program_name: &str, program_id: Pubkey, builtin_function: Option<BuiltinFunctionWithContext>, ) -> Self

Create a ProgramTest.

This is a wrapper around default and add_program. See their documentation for more details.

pub fn prefer_bpf(&mut self, prefer_bpf: bool)

Override default SBF program selection

pub fn set_compute_max_units(&mut self, compute_max_units: u64)

Override the default maximum compute units

pub fn set_transaction_account_lock_limit( &mut self, transaction_account_lock_limit: usize, )

Override the default transaction account lock limit

pub fn set_bpf_compute_max_units(&mut self, bpf_compute_max_units: u64)

👎Deprecated since 1.8.0: please use set_compute_max_units instead

Override the SBF compute budget

pub fn add_account(&mut self, address: Pubkey, account: Account)

Add an account to the test environment

pub fn add_account_with_file_data( &mut self, address: Pubkey, lamports: u64, owner: Pubkey, filename: &str, )

Add an account to the test environment with the account data in the provided filename

pub fn add_account_with_base64_data( &mut self, address: Pubkey, lamports: u64, owner: Pubkey, data_base64: &str, )

Add an account to the test environment with the account data in the provided as a base 64 string

pub fn add_sysvar_account<S: Sysvar>(&mut self, address: Pubkey, sysvar: &S)

pub fn add_program( &mut self, program_name: &str, program_id: Pubkey, builtin_function: Option<BuiltinFunctionWithContext>, )

Add a SBF program to the test environment.

program_name will also be used to locate the SBF shared object in the current or fixtures directory.

If builtin_function is provided, the natively built-program may be used instead of the SBF shared object depending on the BPF_OUT_DIR environment variable.

pub fn add_builtin_program( &mut self, program_name: &str, program_id: Pubkey, builtin_function: BuiltinFunctionWithContext, )

Add a builtin program to the test environment.

Note that builtin programs are responsible for their own stable_log output.

pub fn deactivate_feature(&mut self, feature_id: Pubkey)

Deactivate a runtime feature.

Note that all features are activated by default.

pub async fn start(self) -> (BanksClient, Keypair, Hash)

pub async fn start_with_context(self) -> ProgramTestContext

Start the test client

Returns a BanksClient interface into the test environment as well as a payer Keypair with SOL for sending transactions

Trait Implementations

impl Default for ProgramTest

fn default() -> Self

Initialize a new ProgramTest

If the BPF_OUT_DIR environment variable is defined, BPF programs will be preferred over over a native instruction processor. The ProgramTest::prefer_bpf() method may be used to override this preference at runtime. cargo test-bpf will set BPF_OUT_DIR automatically.

SBF program shared objects and account data files are searched for in

• the value of the BPF_OUT_DIR environment variable
• the tests/fixtures sub-directory
• the current working directory