Struct ProgramTest

pub struct ProgramTest { /* private fields */ }

Implementations

impl ProgramTest

pub fn new( program_name: &'static str, program_id: Pubkey, builtin_function: Option<fn(*mut EbpfVm<'_, InvokeContext<'static>>, u64, u64, u64, u64, u64)>, ) -> ProgramTest

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 add_genesis_account(&mut self, address: Pubkey, account: Account)

Add an account to the test environment’s genesis config.

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>(&mut self, address: Pubkey, sysvar: &S)

where S: Sysvar,

pub fn add_upgradeable_program_to_genesis( &mut self, program_name: &'static str, program_id: &Pubkey, )

Add a BPF Upgradeable program to the test environment’s genesis config.

When testing BPF programs using the program ID of a runtime builtin program - such as Core BPF programs - the program accounts must be added to the genesis config in order to make them available to the new Bank as it’s being initialized.

The presence of these program accounts will cause Bank to skip adding the builtin version of the program, allowing the provided BPF program to be used at the designated program ID instead.

See https://github.com/anza-xyz/agave/blob/c038908600b8a1b0080229dea015d7fc9939c418/runtime/src/bank.rs#L5109-L5126.

pub fn add_program( &mut self, program_name: &'static str, program_id: Pubkey, builtin_function: Option<fn(*mut EbpfVm<'_, InvokeContext<'static>>, u64, u64, u64, u64, u64)>, )

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: &'static str, program_id: Pubkey, builtin_function: fn(*mut EbpfVm<'_, InvokeContext<'static>>, u64, u64, u64, u64, u64), )

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() -> ProgramTest

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

impl ProgramTestExtension for ProgramTest

fn generate_accounts(&mut self, number_of_accounts: u8) -> Vec<Keypair>

Adds a requested number of account with initial balance of 1_000 SOL to the test environment

fn add_account_with_data( &mut self, pubkey: Pubkey, owner: Pubkey, data: &[u8], executable: bool, )

Add a rent-exempt account with some data to the test environment.

fn add_account_with_lamports( &mut self, pubkey: Pubkey, owner: Pubkey, lamports: u64, )

Adds an account with the given balance to the test environment.

fn add_account_with_packable<P: Pack>( &mut self, pubkey: Pubkey, owner: Pubkey, data: P, )

Adds a rent-exempt account with some Packable data to the test environment.

fn add_account_with_borsh<B: BorshSerialize>( &mut self, pubkey: Pubkey, owner: Pubkey, data: B, )

Adds a rent-exempt account with some Borsh-serializable to the test environment

fn add_token_mint( &mut self, pubkey: Pubkey, mint_authority: Option<Pubkey>, supply: u64, decimals: u8, freeze_authority: Option<Pubkey>, )

Adds an SPL Token Mint account to the test environment.

fn add_token_account( &mut self, pubkey: Pubkey, mint: Pubkey, owner: Pubkey, amount: u64, delegate: Option<Pubkey>, is_native: Option<u64>, delegated_amount: u64, close_authority: Option<Pubkey>, )

Adds an SPL Token account to the test environment.

fn add_associated_token_account( &mut self, mint: Pubkey, owner: Pubkey, amount: u64, delegate: Option<Pubkey>, is_native: Option<u64>, delegated_amount: u64, close_authority: Option<Pubkey>, ) -> Pubkey

Adds an associated token account to the test environment. Returns the address of the created account.

fn add_bpf_program( &mut self, program_name: &'static str, program_id: Pubkey, program_authority: Option<Pubkey>, process_instruction: Option<BuiltinFunctionWithContext>, )

Adds a BPF program to the test environment. The program is upgradeable if Some program_authority is provided.

fn add_bpf_program_with_program_data( &mut self, program_name: &'static str, program_id: Pubkey, program_authority: Option<Pubkey>, program_data_pubkey: Pubkey, process_instruction: Option<BuiltinFunctionWithContext>, )

Adds a BPF program to the test environment. The program is upgradeable if Some program_authority and then providing the program data account This is useful for those programs which the program data has to be a spefic one, if not, use ProgramTestExtension::add_bpf_program