Skip to content

Refactor testing logic from macros to pure functions #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rajarshimaitra wants to merge 5 commits into from
Closed

Refactor testing logic from macros to pure functions #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
338e38b
Accumulate test helpers into a single place
rajarshimaitra Aug 31, 2022
35964da
Apply new database test macro for testing
rajarshimaitra Aug 31, 2022
037d84d
Change Blockchain tests from macro to function
rajarshimaitra Aug 31, 2022
63dd109
Apply blockchain test changes
rajarshimaitra Aug 31, 2022
2e7612d
Update CHANGELOG
rajarshimaitra Aug 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Change the meaning of the `fee_amount` field inside `CoinSelectionResult`: from now on the `fee_amount` will represent only the fees asociated with the utxos in the `selected` field of `CoinSelectionResult`.
- New `RpcBlockchain` implementation with various fixes.
- Return balance in separate categories, namely `confirmed`, `trusted_pending`, `untrusted_pending` & `immature`.
- Transform testing macros into functions. For both Database and Blockchain tests.
- Move testing macros and functions into their own module inside `testutils/helpers.rs`.

## [v0.20.0] - [v0.19.0]

Expand Down
45 changes: 41 additions & 4 deletions src/blockchain/electrum.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,16 +337,53 @@ mod test {

use super::*;
use crate::database::MemoryDatabase;
use crate::make_blockchain_tests;
use crate::testutils::blockchain_tests::TestClient;
use crate::testutils::configurable_blockchain_tests::ConfigurableBlockchainTester;
use crate::wallet::{AddressIndex, Wallet};
use electrum_client::Client;

crate::bdk_blockchain_tests! {
fn test_instance(test_client: &TestClient) -> ElectrumBlockchain {
ElectrumBlockchain::from(Client::new(&test_client.electrsd.electrum_url).unwrap())
}
fn init_blockchain(test_client: &TestClient) -> ElectrumBlockchain {
ElectrumBlockchain::from(Client::new(&test_client.electrsd.electrum_url).unwrap())
}

make_blockchain_tests![
init_blockchain,
tests(
test_sync_simple,
test_sync_stop_gap_20,
test_sync_before_and_after_receive,
test_sync_multiple_outputs_same_tx,
test_sync_receive_multi,
test_sync_address_reuse,
test_sync_receive_rbf_replaced,
test_sync_reorg_block,
test_sync_after_send,
test_sync_address_index_should_not_decrement,
test_sync_address_index_should_increment,
test_sync_double_receive,
test_sync_many_sends_to_a_single_address,
test_update_confirmation_time_after_generate,
test_sync_outgoing_from_scratch,
test_sync_long_change_chain,
test_sync_bump_fee_basic,
test_sync_bump_fee_remove_change,
test_sync_bump_fee_add_input_simple,
test_sync_bump_fee_add_input_no_change,
test_add_data,
test_sync_receive_coinbase,
test_send_to_bech32m_addr,
test_tx_chain,
test_double_spend,
test_send_receive_pkh,
test_taproot_script_spend,
test_sign_taproot_core_keyspend_psbt,
test_sign_taproot_core_scriptspend2_psbt,
test_sign_taproot_core_scriptspend3_psbt,
test_get_block_hash,
)
];

fn get_factory() -> (TestClient, Arc<ElectrumBlockchain>) {
let test_client = TestClient::default();

Expand Down
61 changes: 52 additions & 9 deletions src/blockchain/esplora/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,20 +80,63 @@ impl From<esplora_client::BlockTime> for crate::BlockTime {
}
}

#[cfg(test)]
#[cfg(feature = "test-esplora")]
crate::bdk_blockchain_tests! {
fn test_instance(test_client: &TestClient) -> EsploraBlockchain {
EsploraBlockchain::new(&format!("http://{}",test_client.electrsd.esplora_url.as_ref().unwrap()), 20)
}
}

const DEFAULT_CONCURRENT_REQUESTS: u8 = 4;

#[cfg(feature = "test-esplora")]
#[cfg(test)]
mod test {
use super::*;
use crate::make_blockchain_tests;
use crate::testutils::blockchain_tests::TestClient;

fn init_blockchain(test_client: &TestClient) -> EsploraBlockchain {
EsploraBlockchain::new(
&format!(
"http://{}",
test_client.electrsd.esplora_url.as_ref().unwrap()
),
20,
)
}

make_blockchain_tests![
init_blockchain,
tests(
test_sync_simple,
test_sync_stop_gap_20,
test_sync_before_and_after_receive,
test_sync_multiple_outputs_same_tx,
test_sync_receive_multi,
test_sync_address_reuse,
test_sync_receive_rbf_replaced,
test_sync_after_send,
test_sync_address_index_should_not_decrement,
test_sync_address_index_should_increment,
test_sync_double_receive,
test_sync_many_sends_to_a_single_address,
test_update_confirmation_time_after_generate,
test_sync_outgoing_from_scratch,
test_sync_long_change_chain,
test_sync_bump_fee_basic,
test_sync_bump_fee_remove_change,
test_sync_bump_fee_add_input_simple,
test_sync_bump_fee_add_input_no_change,
test_add_data,
test_sync_receive_coinbase,
test_send_to_bech32m_addr,
test_tx_chain,
test_double_spend,
test_send_receive_pkh,
test_taproot_key_spend,
test_taproot_script_spend,
test_sign_taproot_core_keyspend_psbt,
test_sign_taproot_core_scriptspend2_psbt,
test_sign_taproot_core_scriptspend3_psbt,
test_get_block_hash,
)
];

#[test]
#[cfg(feature = "test-esplora")]
fn test_esplora_with_variable_configs() {
use super::*;

Expand Down
81 changes: 64 additions & 17 deletions src/blockchain/rpc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -870,32 +870,79 @@ impl BlockchainFactory for RpcBlockchainFactory {

#[cfg(test)]
#[cfg(any(feature = "test-rpc", feature = "test-rpc-legacy"))]
mod test {
pub mod test {
use super::*;
use crate::{
descriptor::{into_wallet_descriptor_checked, AsDerived},
testutils::blockchain_tests::TestClient,
wallet::utils::SecpCtx,
};
use crate::descriptor::into_wallet_descriptor_checked;
use crate::descriptor::AsDerived;
use crate::make_blockchain_tests;
use crate::testutils::blockchain_tests::TestClient;
use crate::wallet::utils::SecpCtx;

use bitcoin::{Address, Network};
use bitcoincore_rpc::RpcApi;
use log::LevelFilter;
use miniscript::DescriptorTrait;

crate::bdk_blockchain_tests! {
fn test_instance(test_client: &TestClient) -> RpcBlockchain {
let config = RpcConfig {
url: test_client.bitcoind.rpc_url(),
auth: Auth::Cookie { file: test_client.bitcoind.params.cookie_file.clone() },
network: Network::Regtest,
wallet_name: format!("client-wallet-test-{}", std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_nanos() ),
sync_params: None,
};
RpcBlockchain::from_config(&config).unwrap()
}
pub fn init_blockchain(test_client: &TestClient) -> RpcBlockchain {
let config = RpcConfig {
url: test_client.bitcoind.rpc_url(),
auth: Auth::Cookie {
file: test_client.bitcoind.params.cookie_file.clone(),
},
network: Network::Regtest,
wallet_name: format!(
"client-wallet-test-{}",
std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap()
.as_nanos()
),
sync_params: Some(RpcSyncParams::default()),
};
RpcBlockchain::from_config(&config).unwrap()
}

make_blockchain_tests![
init_blockchain,
tests(
test_sync_simple,
test_sync_stop_gap_20,
test_sync_before_and_after_receive,
test_sync_multiple_outputs_same_tx,
test_sync_receive_multi,
test_sync_address_reuse,
test_sync_receive_rbf_replaced,
test_sync_after_send,
test_sync_address_index_should_not_decrement,
test_sync_address_index_should_increment,
test_sync_double_receive,
test_sync_many_sends_to_a_single_address,
test_update_confirmation_time_after_generate,
test_sync_outgoing_from_scratch,
test_sync_long_change_chain,
test_sync_bump_fee_basic,
test_sync_bump_fee_add_input_simple,
test_sync_bump_fee_add_input_no_change,
test_sync_receive_coinbase,
test_double_spend,
test_tx_chain,
test_get_block_hash,
)
];

#[cfg(not(feature = "test-rpc-legacy"))]
Copy link
Member

@evanlinjin evanlinjin Sep 2, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: IMO writing this as #[cfg(feature = "test-rpc")] is better.

Copy link
Contributor Author

@rajarshimaitra rajarshimaitra Sep 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed..

Copy link
Contributor Author

@rajarshimaitra rajarshimaitra Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On further look, it seems the intention of test-rpc-legacy is a to be a feature to disable certain tests.. So making it test-rpc won't work, as all the rpc tests are by default in test-rpc. This not thing, makes these tests disabled when test-rpc-legacy is turned on.. Maybe there was an easier way to do, but I won't mess with it in this PR..

make_blockchain_tests![
init_blockchain,
tests(
test_send_to_bech32m_addr,
test_taproot_key_spend,
test_taproot_script_spend,
test_sign_taproot_core_keyspend_psbt,
test_sign_taproot_core_scriptspend2_psbt,
test_sign_taproot_core_scriptspend3_psbt,
)
];

fn get_factory() -> (TestClient, RpcBlockchainFactory) {
let test_client = TestClient::default();

Expand Down
108 changes: 24 additions & 84 deletions src/database/keyvalue.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,8 @@ mod test {

use sled::{Db, Tree};

use crate::run_tests_with_init;

static mut COUNT: usize = 0;

lazy_static! {
Expand Down Expand Up @@ -448,88 +450,26 @@ mod test {
}
}

#[test]
fn test_script_pubkey() {
crate::database::test::test_script_pubkey(get_tree());
}

#[test]
fn test_batch_script_pubkey() {
crate::database::test::test_batch_script_pubkey(get_tree());
}

#[test]
fn test_iter_script_pubkey() {
crate::database::test::test_iter_script_pubkey(get_tree());
}

#[test]
fn test_del_script_pubkey() {
crate::database::test::test_del_script_pubkey(get_tree());
}

#[test]
fn test_utxo() {
crate::database::test::test_utxo(get_tree());
}

#[test]
fn test_raw_tx() {
crate::database::test::test_raw_tx(get_tree());
}

#[test]
fn test_tx() {
crate::database::test::test_tx(get_tree());
}

#[test]
fn test_last_index() {
crate::database::test::test_last_index(get_tree());
}

#[test]
fn test_sync_time() {
crate::database::test::test_sync_time(get_tree());
}

#[test]
fn test_iter_raw_txs() {
crate::database::test::test_iter_raw_txs(get_tree());
}

#[test]
fn test_del_path_from_script_pubkey() {
crate::database::test::test_del_path_from_script_pubkey(get_tree());
}

#[test]
fn test_iter_script_pubkeys() {
crate::database::test::test_iter_script_pubkeys(get_tree());
}

#[test]
fn test_del_utxo() {
crate::database::test::test_del_utxo(get_tree());
}

#[test]
fn test_del_raw_tx() {
crate::database::test::test_del_raw_tx(get_tree());
}

#[test]
fn test_del_tx() {
crate::database::test::test_del_tx(get_tree());
}

#[test]
fn test_del_last_index() {
crate::database::test::test_del_last_index(get_tree());
}

#[test]
fn test_check_descriptor_checksum() {
crate::database::test::test_check_descriptor_checksum(get_tree());
}
run_tests_with_init![
@init get_tree(),
@tests(
test_script_pubkey,
test_batch_script_pubkey,
test_iter_script_pubkey,
test_del_script_pubkey,
test_utxo,
test_raw_tx,
test_tx,
test_last_index,
test_sync_time,
test_iter_raw_txs,
test_del_path_from_script_pubkey,
test_iter_script_pubkeys,
test_del_utxo,
test_del_raw_tx,
test_del_tx,
test_del_last_index,
test_check_descriptor_checksum
)
];
}
Loading