integration_test: Remove constructors

Turns out it is easier to support various Bitcoin Core args if we just
have a single constructor and pass a slice of arg strings into it.

Author: tcharding

integration_test/src/lib.rs

@@ -8,14 +8,12 @@ use rand::Rng;
 #[rustfmt::skip]    // Keep public re-exports separate.
 pub use node::Node; // Re-export this to make test imports more terse.
 
-/// Number of blocks to generate when funding wallet.
-const NBLOCKS: usize = 101;
-
 /// Initialize a logger (configure with `RUST_LOG=trace cargo test`).
 #[allow(dead_code)] // Not all tests use this function.
 pub fn init_logger() { let _ = env_logger::try_init(); }
 
 /// Controls the loaded wallet.
+#[derive(Debug, PartialEq, Eq)]
 pub enum Wallet {
     /// Load the default wallet.
     Default,
@@ -27,27 +25,9 @@ pub enum Wallet {
 
 pub trait NodeExt {
     /// Returns a handle to a `bitcoind` instance after leading wallet if present.
-    fn _new(wallet: Wallet, txindex: bool) -> Node;
-
-    /// Returns a handle to a `bitcoind` instance with "default" wallet loaded.
-    fn new_with_default_wallet() -> Node { Self::_new(Wallet::Default, false) }
-
-    /// Returns a handle to a `bitcoind` instance with "default" wallet loaded and `-txindex` enabled.
-    fn new_with_default_wallet_txindex() -> Node { Self::_new(Wallet::Default, true) }
-
-    /// Returns a handle to a `bitcoind` instance with `wallet` loaded.
-    fn new_with_wallet(wallet: String) -> Node { Self::_new(Wallet::Load(wallet), false) }
-
-    /// Returns a handle to a `bitcoind` instance with `wallet` loaded and `-txindex` enabled.
-    fn new_with_wallet_txindex(wallet: String) -> Node { Self::_new(Wallet::Load(wallet), true) }
-
-    /// Returns a handle to a `bitcoind` instance without any wallet loaded.
-    fn new_no_wallet() -> Node { Self::_new(Wallet::None, false) }
-
-    /// Returns a handle to a `bitcoind` instance without any wallet loaded and `-txindex` enabled.
-    fn new_no_wallet_txindex() -> Node { Self::_new(Wallet::None, true) }
+    fn with_wallet(wallet: Wallet, args: &[&str]) -> Node;
 
-    /// Generates [`NBLOCKS`] to an address controlled by the loaded wallet.
+    /// Generates 101 blocks to an address controlled by the loaded wallet.
     fn fund_wallet(&self);
 
     /// Mines a block.
@@ -71,26 +51,26 @@ pub trait NodeExt {
 }
 
 impl NodeExt for Node {
-    fn _new(wallet: Wallet, txindex: bool) -> Node {
+    fn with_wallet(wallet: Wallet, args: &[&str]) -> Node {
         let exe = node::exe_path().expect("failed to get bitcoind executable");
 
         let mut conf = node::Conf::default();
         match wallet {
             Wallet::Default => {}, // conf.wallet = Some("default")
-            Wallet::Load(w) => conf.wallet = Some(w),
+            Wallet::Load(w) => conf.wallet = Some(w.to_owned()),
             Wallet::None => conf.wallet = None,
         }
 
-        if txindex {
-            conf.args.push("-txindex");
+        for arg in args {
+            conf.args.push(arg);
         }
 
         Node::with_conf(exe, &conf).expect("failed to create node")
     }
 
     fn fund_wallet(&self) {
         let address = self.client.new_address().expect("failed to get new address");
-        self.client.generate_to_address(NBLOCKS, &address).expect("failed to generate to address");
+        self.client.generate_to_address(101, &address).expect("failed to generate to address");
     }
 
     fn mine_a_block(&self) {

integration_test/tests/blockchain.rs

@@ -2,25 +2,25 @@
 
 //! Tests for methods found under the `== Blockchain ==` section of the API docs.
 
-use integration_test::{Node, NodeExt as _};
+use integration_test::{Node, NodeExt as _, Wallet};
 
 #[test]
 fn get_blockchain_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_blockchain_info().expect("getblockchaininfo");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_best_block_hash() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_best_block_hash().expect("getbestblockhash");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_block() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let block_hash = node.client.best_block_hash().expect("best_block_hash failed");
 
     let json = node.client.get_block_verbose_zero(block_hash).expect("getblock verbose=0");
@@ -36,29 +36,29 @@ fn get_block() {
 
 #[test]
 fn get_block_count() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_block_count().expect("getblockcount");
     let _ = json.into_model();
 }
 
 #[test]
 fn get_block_hash() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_block_hash(0).expect("getblockhash");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_block_header() { // verbose = false
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let block_hash = node.client.best_block_hash().expect("best_block_hash failed");
     let json = node.client.get_block_header(&block_hash).expect("getblockheader");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_block_header_verbose() { // verbose = true
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let block_hash = node.client.best_block_hash().expect("best_block_hash failed");
     let json = node.client.get_block_header_verbose(&block_hash).expect("getblockheader");
     assert!(json.into_model().is_ok());
@@ -75,7 +75,7 @@ fn get_block_stats() {
 }
 
 fn getblockstats() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
 
     let json = node.client.get_block_stats_by_height(1).expect("getblockstats");
@@ -87,7 +87,7 @@ fn getblockstats() {
 }
 
 fn getblockstats_txindex() {
-    let node = Node::new_with_default_wallet_txindex();
+    let node = Node::with_wallet(Wallet::Default, &["-txindex"]);
     node.fund_wallet();
 
     let json = node.client.get_block_stats_by_height(101).expect("getblockstats");
@@ -100,21 +100,21 @@ fn getblockstats_txindex() {
 
 #[test]
 fn get_chain_tips() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_chain_tips().expect("getchaintips");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_chain_tx_stats() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_chain_tx_stats().expect("getchaintxstats");
     assert!(json.into_model().is_ok());
 }
 
 #[test]
 fn get_difficulty() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_difficulty().expect("getdifficulty");
     let _ = json.into_model();
 }
@@ -135,7 +135,7 @@ fn get_mempool_descendants() {
 
 #[test]
 fn get_mempool_entry() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, txid) = node.create_mempool_transaction();
 
@@ -145,7 +145,7 @@ fn get_mempool_entry() {
 
 #[test]
 fn get_mempool_info() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, _txid) = node.create_mempool_transaction();
 
@@ -158,7 +158,7 @@ fn get_mempool_info() {
 
 #[test]
 fn get_raw_mempool() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, _txid) = node.create_mempool_transaction();
 
@@ -173,7 +173,7 @@ fn get_raw_mempool() {
 // FIXME: Fails with getrawmempool verbose: JsonRpc(Json(Error("invalid type: map, expected a sequence", line: 1, column: 0)))
 #[cfg(feature = "TODO")]
 fn get_raw_mempool_verbose() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, _txid) = node.create_mempool_transaction();
 
@@ -186,7 +186,7 @@ fn get_raw_mempool_verbose() {
 
 #[test]
 fn get_tx_out() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, tx) = node.create_mined_transaction();
     let txid = tx.compute_txid();
@@ -198,7 +198,7 @@ fn get_tx_out() {
 
 #[test]
 fn get_tx_out_proof() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, tx) = node.create_mined_transaction();
     let txid = tx.compute_txid();
@@ -208,19 +208,18 @@ fn get_tx_out_proof() {
 
 #[test]
 fn get_tx_out_set_info() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, _tx) = node.create_mined_transaction();
 
     // Test the type and into model conversion code.
     let json = node.client.get_tx_out_set_info().expect("gettxoutsetinfo");
     let _ = json.into_model().expect("into_model");
-
 }
 
 #[test]
 fn precious_block() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.mine_a_block();
     let hash = node.client.best_block_hash().expect("best_block_hash failed");
     node.mine_a_block();
@@ -231,7 +230,7 @@ fn precious_block() {
 // Implicitly tests the omitted method `gettxoutproof` as well.
 #[test]
 fn verify_tx_out_proof() {
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
     let (_address, tx) = node.create_mined_transaction();
     let txid = tx.compute_txid();

integration_test/tests/control.rs

@@ -2,43 +2,43 @@
 
 //! Tests for methods found under the `== Control ==` section of the API docs.
 
-use integration_test::{Node, NodeExt as _};
+use integration_test::{Node, NodeExt as _, Wallet};
 
 #[test]
 fn get_memory_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.get_memory_info().expect("getmemoryinfo");
 }
 
 #[cfg(not(feature = "v17"))]
 #[test]
 fn get_rpc_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.get_rpc_info().expect("getrpcinfo");
 }
 
 #[test]
 fn help() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     // There is no json object for `stop`, we just return a string.
     let _ = node.client.help().expect("help");
 }
 
 #[test]
 fn logging() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.logging().expect("logging");
 }
 
 #[test]
 fn stop() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     // There is no json object for `stop`, we just return a string.
     let _ = node.client.stop().expect("stop");
 }
 
 #[test]
 fn uptime() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.uptime().expect("uptime");
 }

integration_test/tests/generating.rs

@@ -2,13 +2,14 @@
 
 //! Tests for methods found under the `== Generating ==` section of the API docs.
 
-use integration_test::{Node, NodeExt as _};
+use integration_test::{Node, NodeExt as _, Wallet};
 
 #[test]
 fn generate_to_address() {
     const NBLOCKS: usize = 1;
 
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
+
     let address = node.client.new_address().expect("failed to get new address");
     let json = node.client.generate_to_address(NBLOCKS, &address).expect("generatetoaddress");
     json.into_model().unwrap();
@@ -18,7 +19,8 @@ fn generate_to_address() {
 fn invalidate_block() {
     const NBLOCKS: usize = 1;
 
-    let node = Node::new_with_default_wallet();
+    let node = Node::with_wallet(Wallet::Default, &[]);
+
     let address = node.client.new_address().expect("failed to get new address");
     let old_best_block = node.client.get_best_block_hash().expect("getbestblockhash").into_model().unwrap().0;
     node.client.generate_to_address(NBLOCKS, &address).expect("generatetoaddress").into_model().unwrap();
@@ -36,7 +38,7 @@ fn invalidate_block() {
 // fn generate() {
 //     const NBLOCKS: usize = 100;
 
-//     let node = Node::new_with_default_wallet();
+//     let node = Node::with_wallet_with_default_wallet();
 //     let json = node.client.generate(NBLOCKS).expect("generate");
 //     let model = json.into_model().unwrap();
 //     assert_eq!(model.len(), NBLOCKS);

integration_test/tests/network.rs

@@ -4,23 +4,23 @@
 
 #![cfg(any(feature = "0_17_1", feature = "0_18_1"))]
 
-use integration_test::{Node, NodeExt as _};
+use integration_test::{Node, NodeExt as _, Wallet};
 
 #[test]
 fn get_added_node_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.get_added_node_info().expect("getaddednodeinfo");
 }
 
 #[test]
 fn get_net_totals() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.get_net_totals().expect("getnettotals");
 }
 
 #[test]
 fn get_network_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let json = node.client.get_network_info().expect("getnetworkinfo");
     assert!(json.into_model().is_ok());
 
@@ -30,6 +30,6 @@ fn get_network_info() {
 
 #[test]
 fn get_peer_info() {
-    let node = Node::new_no_wallet();
+    let node = Node::with_wallet(Wallet::None, &[]);
     let _ = node.client.get_peer_info().expect("getpeerinfo");
 }