Merge rust-bitcoin/corepc#197: Update integration test feature gating

e9196806c87897bab2847911b21546f69323cd8f Update integration test feature gating (Jamil Lambert, PhD)

Pull request description:

  Change the version feature gates to be that version and below to make feature gating the tests easier.

  Closes #195

ACKs for top commit:
  tcharding:
    ACK e9196806c87897bab2847911b21546f69323cd8f

Tree-SHA512: af757de1adbc638c35e920057b5fd099488d3264f1a716beadabd6c16b1db8104f83a2f7bed74a646b67d3919b9b827170cdd7488c676ca4a24e4d37c45a0851

Author: blaze-smith470pm

integration_test/Cargo.toml

@@ -15,39 +15,41 @@ download = ["node/download"]
 
 # Enable the same feature in `node` and the version feature here.
 # All minor releases of the latest three versions.
-29_0 = ["v29", "node/29_0"]
-28_1 = ["v28", "node/28_1"]
-28_0 = ["v28", "node/28_0"]
-27_2 = ["v27", "node/27_2"]
-27_1 = ["v27", "node/27_1"]
-27_0 = ["v27", "node/27_0"]
+29_0 = ["v29_and_below", "node/29_0"]
+28_1 = ["v28_and_below", "node/28_1"]
+28_0 = ["v28_and_below", "node/28_0"]
+27_2 = ["v27_and_below", "node/27_2"]
+27_1 = ["v27_and_below", "node/27_1"]
+27_0 = ["v27_and_below", "node/27_0"]
 # Only the latest minor version for older versions.
-26_2 = ["v26", "node/26_2"]
-25_2 = ["v25", "node/25_2"]
-24_2 = ["v24", "node/24_2"]
-23_2 = ["v23", "node/23_2"]
-22_1 = ["v22", "node/22_1"]
-0_21_2 = ["v21", "node/0_21_2"]
-0_20_2 = ["v20", "node/0_20_2"]
-0_19_1 = ["v19", "node/0_19_1"]
-0_18_1 = ["v18", "node/0_18_1"]
+26_2 = ["v26_and_below", "node/26_2"]
+25_2 = ["v25_and_below", "node/25_2"]
+24_2 = ["v24_and_below", "node/24_2"]
+23_2 = ["v23_and_below", "node/23_2"]
+22_1 = ["v22_and_below", "node/22_1"]
+0_21_2 = ["v21_and_below", "node/0_21_2"]
+0_20_2 = ["v20_and_below", "node/0_20_2"]
+0_19_1 = ["v19_and_below", "node/0_19_1"]
+0_18_1 = ["v18_and_below", "node/0_18_1"]
 0_17_2 = ["v17", "node/0_17_2"]
 
 # These features are just for internal use (feature gating).
 # Each major version is tested with the same client.
-v29 = []
-v28 = []
-v27 = []
-v26 = []
-v25 = []
-v24 = []
-v23 = []
-v22 = []
-v21 = []
-v20 = []
-v19 = []
-v18 = []
-v17 = []
+# A specific range of versions can be specified e.g. for 24-26:
+# #[cfg(all(feature = "v26_and_below", not(feature = "v23_and_below")))]
+v29_and_below = []
+v28_and_below = ["v29_and_below"]
+v27_and_below = ["v28_and_below"]
+v26_and_below = ["v27_and_below"]
+v25_and_below = ["v26_and_below"]
+v24_and_below = ["v25_and_below"]
+v23_and_below = ["v24_and_below"]
+v22_and_below = ["v23_and_below"]
+v21_and_below = ["v22_and_below"]
+v20_and_below = ["v21_and_below"]
+v19_and_below = ["v20_and_below"]
+v18_and_below = ["v19_and_below"]
+v17 = ["v18_and_below"]
 
 TODO = []                       # This is a dirty hack while writing the tests.
 

integration_test/tests/blockchain.rs

@@ -54,8 +54,7 @@ fn blockchain__get_block_count__modelled() {
 }
 
 #[test]
-#[cfg(not(feature = "v17"))]
-#[cfg(not(feature = "v18"))]
+#[cfg(not(feature = "v18_and_below"))]
 fn blockchain__get_block_filter__modelled() {
     let node = Node::with_wallet(Wallet::Default, &["-blockfilterindex"]);
     node.mine_a_block();
@@ -93,15 +92,15 @@ fn blockchain__get_block_header__modelled() {
 
 #[test]
 fn blockchain__get_block_stats__modelled() {
-    // Version 18 cannot call `getblockstats` if `-txindex` is not enabled.
-    #[cfg(not(feature = "v18"))]
+    // Version 17 and 18 cannot call `getblockstats` if `-txindex` is not enabled.
+    #[cfg(not(feature = "v18_and_below"))]
     getblockstats();
 
-    // All versions including 18 can `getblockstats` if `-txindex` is enabled.
+    // All versions including 17 and 18 can `getblockstats` if `-txindex` is enabled.
     getblockstats_txindex();
 }
 
-#[cfg(not(feature = "v18"))]
+#[cfg(not(feature = "v18_and_below"))]
 fn getblockstats() {
     let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
@@ -149,7 +148,7 @@ fn blockchain__get_chain_tx_stats__modelled() {
 }
 
 #[test]
-#[cfg(feature = "v29")]
+#[cfg(not(feature = "v28_and_below"))]
 fn blockchain__get_descriptor_activity__modelled() {
     let node = Node::with_wallet(Wallet::None, &["-coinstatsindex=1", "-txindex=1"]);
 
@@ -292,26 +291,12 @@ fn blockchain__savemempool() {
     node.fund_wallet();
     let (_addr, _txid) = node.create_mempool_transaction();
 
-    #[cfg(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-    ))]
+    #[cfg(feature = "v22_and_below")]
     {
         node.client.save_mempool().expect("savemempool");
     }
 
-    #[cfg(not(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-    )))]
+    #[cfg(not(feature = "v22_and_below"))]
     {
         let _: Result<SaveMempool, _> = node.client.save_mempool();
     }

integration_test/tests/generating.rs

@@ -10,10 +10,7 @@ use node::mtype;
 
 #[test]
 // The `generate` method was deprecated in Core v18 and was removed in v19.
-#[cfg(all(
-    feature = "v17",
-    not(feature = "v18")        // We just need one `not` so that --all-features builds.
-))]
+#[cfg(feature = "v17")]
 fn generating__generate__modelled() {
     const NBLOCKS: usize = 10;
     let node = Node::with_wallet(Wallet::Default, &[]);

integration_test/tests/mining.rs

@@ -20,9 +20,9 @@ fn mining__get_block_template__modelled() {
     node3.mine_a_block();
 
     let options = match () {
-        #[cfg(not(feature = "v29"))]
+        #[cfg(feature = "v28_and_below")]
         () => TemplateRequest { rules: vec![TemplateRules::Segwit] },
-        #[cfg(feature = "v29")]
+        #[cfg(not(feature = "v28_and_below"))]
         () => TemplateRequest {
             rules: vec![TemplateRules::Segwit],
             mode: Some("template".to_string()),
@@ -41,38 +41,12 @@ fn mining__get_mining_info() {
 
     let json: GetMiningInfo = node.client.get_mining_info().expect("rpc");
 
-    // Upto v9 there is no error converting into model.
-    #[cfg(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-        feature = "v23",
-        feature = "v24",
-        feature = "v25",
-        feature = "v26",
-        feature = "v27",
-        feature = "v28",
-    ))]
+    // Up to v28 (i.e., not 29_0) there is no error converting into model.
+    #[cfg(feature = "v28_and_below")]
     let _: mtype::GetMiningInfo = json.into_model();
 
-    // v29 onwards - these feature gates are shit, we need a better way to do this.
-    #[cfg(not(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-        feature = "v23",
-        feature = "v24",
-        feature = "v25",
-        feature = "v26",
-        feature = "v27",
-        feature = "v28",
-    )))]
+    // v29 onwards
+    #[cfg(not(feature = "v28_and_below"))]
     {
         let model: Result<mtype::GetMiningInfo, GetMiningInfoError> = json.into_model();
         model.unwrap();
@@ -88,17 +62,7 @@ fn mining__get_network_hash_ps() {
 
 #[test]
 // Core version 26 onwards.
-#[cfg(all(
-    not(feature = "v17"),
-    not(feature = "v18"),
-    not(feature = "v19"),
-    not(feature = "v20"),
-    not(feature = "v21"),
-    not(feature = "v22"),
-    not(feature = "v23"),
-    not(feature = "v24"),
-    not(feature = "v25"),
-))]
+#[cfg(not(feature = "v25_and_below"))]
 fn mining__get_prioritised_transactions() {
     let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();

integration_test/tests/network.rs

@@ -12,25 +12,15 @@ use node::{AddNodeCommand, mtype};
 fn network__add_node() {
     let dummy_peer = "192.0.2.1:8333";
 
-    #[cfg(not(any(
-        feature = "v26",
-        feature = "v27",
-        feature = "v28",
-        feature = "v29",
-    )))]
+    #[cfg(feature = "v25_and_below")]
     {
         let node = Node::with_wallet(Wallet::None, &[]);
         node.client.add_node(dummy_peer, AddNodeCommand::OneTry).expect("addnode onetry");
         node.client.add_node(dummy_peer, AddNodeCommand::Add).expect("addnode add");
         node.client.add_node(dummy_peer, AddNodeCommand::Remove).expect("addnode remove");
     }
 
-    #[cfg(any(
-        feature = "v26",
-        feature = "v27",
-        feature = "v28",
-        feature = "v29",
-    ))]
+    #[cfg(not(feature = "v25_and_below"))]
     {
         let node = Node::with_wallet(Wallet::None, &["-v2transport"]);
         node.client.add_node(dummy_peer, AddNodeCommand::OneTry).expect("addnode onetry");

integration_test/tests/raw_transactions.rs

@@ -169,11 +169,10 @@ fn raw_transactions__decode_psbt__modelled() {
     let decoded = res.expect("DecodePsbt into model");
 
     // Before Core v23 global xpubs was not a known keypair.
-    #[cfg(feature = "v17")]
-    #[cfg(feature = "v22")]
+    #[cfg(feature = "v22_and_below")]
     assert_eq!(decoded.psbt.unknown.len(), 1);
 
-    #[cfg(feature = "v23")]
+    #[cfg(not(feature = "v22_and_below"))]
     assert_eq!(decoded.psbt.xpub.len(), 1);
 
     // TODO: Add a taproot field and test it with v24
@@ -360,14 +359,7 @@ fn raw_transactions__sign_raw_transaction__modelled() {
 
 // TODO: Work out how to test things without using dumpprivkey.
 #[test]
-#[cfg(any(
-    feature = "v17",
-    feature = "v18",
-    feature = "v19",
-    feature = "v20",
-    feature = "v21",
-    feature = "v22",
-))] // In v23 dumpprivkey no longer works.
+#[cfg(feature = "v22_and_below")] // In v23 dumpprivkey no longer works.
 fn raw_transactions__sign_raw_transaction_with_key__modelled() {
     let node = Node::with_wallet(Wallet::Default, &["-txindex"]);
     node.fund_wallet();
@@ -376,7 +368,7 @@ fn raw_transactions__sign_raw_transaction_with_key__modelled() {
 
 // FIXME: Doesn't work for v26 for some reason.
 #[test]
-#[cfg(all(feature = "v27", not(feature = "v28")))]
+#[cfg(all(feature = "v27_and_below", not(feature = "v26_and_below")))]
 fn raw_transactions__submit_package__modelled() {
     let node = Node::with_wallet(Wallet::Default, &["-txindex"]);
 
@@ -404,7 +396,7 @@ fn raw_transactions__submit_package__modelled() {
 
 // In Core v28 submitpackage has additional optional features.
 #[test]
-#[cfg(all(not(feature = "v27"), feature = "v28"))]
+#[cfg(not(feature = "v27_and_below"))]
 fn raw_transactions__submit_package__modelled() {
     let node = Node::with_wallet(Wallet::Default, &["-txindex"]);
 
@@ -499,14 +491,7 @@ fn create_sign_send(node: &Node) {
 // - send_raw_transaction
 //
 // TODO: Work out how to get a private key without using `dumpprivkey`.
-#[cfg(any(
-    feature = "v17",
-    feature = "v18",
-    feature = "v19",
-    feature = "v20",
-    feature = "v21",
-    feature = "v22",
-))] // In v23 dumpprivkey no longer works.
+#[cfg(feature = "v22_and_below")] // In v23 dumpprivkey no longer works.
 fn create_sign_with_key_send(node: &Node) {
     let (addr, _tx, txid, tx_out, vout) = create_utxo(node);
 

integration_test/tests/wallet.rs

@@ -58,11 +58,7 @@ fn wallet__create_wallet__modelled() {
 fn wallet__dump_priv_key__modelled() {
     // As of Core v23 the default wallet is an native descriptor wallet which does not
     // support dumping private keys. Legacy wallets are supported upto v25 it seems.
-    #[cfg(any(
-        feature = "v23",
-        feature = "v24",
-        feature = "v25",
-    ))]
+    #[cfg(all(feature = "v25_and_below", not(feature = "v22_and_below")))]
     {
         let node = Node::with_wallet(Wallet::None, &[]);
 
@@ -75,14 +71,7 @@ fn wallet__dump_priv_key__modelled() {
         model.unwrap();
     }
 
-    #[cfg(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-    ))]
+    #[cfg(feature = "v22_and_below")]
     {
         let node = Node::with_wallet(Wallet::Default, &[]);
         let address = node.client.new_address().expect("failed to get new address");
@@ -97,11 +86,7 @@ fn wallet__dump_priv_key__modelled() {
 fn wallet__dump_wallet() {
     // As of Core v23 the default wallet is an native descriptor wallet which does not
     // support dumping private keys. Legacy wallets are supported upto v25 it seems.
-    #[cfg(any(
-        feature = "v23",
-        feature = "v24",
-        feature = "v25",
-    ))]
+    #[cfg(all(feature = "v25_and_below", not(feature = "v22_and_below")))]
     {
         let node = Node::with_wallet(Wallet::None, &[]);
 
@@ -111,14 +96,7 @@ fn wallet__dump_wallet() {
         let _: DumpWallet = node.client.dump_wallet(&out).expect("dumpwallet");
     }
 
-    #[cfg(any(
-        feature = "v17",
-        feature = "v18",
-        feature = "v19",
-        feature = "v20",
-        feature = "v21",
-        feature = "v22",
-    ))]
+    #[cfg(feature = "v22_and_below")]
     {
         let node = Node::with_wallet(Wallet::Default, &[]);
         let out = integration_test::random_tmp_file();
@@ -169,7 +147,7 @@ fn wallet__get_balance__modelled() {
 }
 
 #[test]
-#[cfg(all(not(feature = "v17"), not(feature = "v18")))]
+#[cfg(not(feature = "v18_and_below"))]
 fn wallet__get_balances() {
     let node = Node::with_wallet(Wallet::Default, &[]);
     node.fund_wallet();
@@ -287,11 +265,11 @@ fn create_load_unload_wallet() {
     node.client.create_wallet(&wallet).expect("failed to create wallet");
 
     // Upto version 20 Core returns null for `unloadwallet`.
-    #[cfg(any(feature = "v17", feature = "v18", feature = "v19", feature = "v20"))]
+    #[cfg(feature = "v20_and_below")]
     let _ = node.client.unload_wallet(&wallet).expect("unloadwallet");
 
     // From version 21 Core returns warnings for `unloadwallet`.
-    #[cfg(all(not(feature = "v17"), not(feature = "v18"), not(feature = "v19"), not(feature = "v20")))]
+    #[cfg(not(feature = "v20_and_below"))]
     {
         let json: UnloadWallet = node.client.unload_wallet(&wallet).expect("unloadwallet");
         let _: mtype::UnloadWallet = json.into_model();