crc: add unit test for BurnChain factory methods and nakamoto cycle boundaries, #5970

Author: fdefelici

stackslib/src/burnchains/burnchain.rs

@@ -1773,3 +1773,133 @@ impl Burnchain {
         Ok(block_header)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::burnchains::*;
+    use regex::Regex;
+
+    #[test]
+    fn test_creation_by_new_for_bitcoin_mainnet() {
+        let burn_chain = Burnchain::new("workdir/path", "bitcoin", "mainnet");
+        assert!(burn_chain.is_ok());
+
+        let burn_chain = burn_chain.unwrap();
+        let first_block_hash = BurnchainHeaderHash::from_hex(BITCOIN_MAINNET_FIRST_BLOCK_HASH).unwrap();
+        assert_eq!(PEER_VERSION_MAINNET, burn_chain.peer_version);
+        assert_eq!(BITCOIN_NETWORK_ID_MAINNET, burn_chain.network_id);
+        assert_eq!(BITCOIN_MAINNET_NAME, burn_chain.network_name);
+        assert_eq!("workdir/path", burn_chain.working_dir); 
+        assert_eq!(24, burn_chain.consensus_hash_lifetime);
+        assert_eq!(7, burn_chain.stable_confirmations);
+        assert_eq!(BITCOIN_MAINNET_FIRST_BLOCK_HEIGHT, burn_chain.first_block_height);
+        assert_eq!(first_block_hash, burn_chain.first_block_hash);
+        assert_eq!(BITCOIN_MAINNET_FIRST_BLOCK_TIMESTAMP, burn_chain.first_block_timestamp);
+        assert_eq!(PoxConstants::mainnet_default(), burn_chain.pox_constants);
+        assert_eq!(BITCOIN_MAINNET_INITIAL_REWARD_START_BLOCK, burn_chain.initial_reward_start_block);
+    }
+
+    #[test]
+    fn test_creation_by_new_for_bitcoin_testnet() {
+        let burn_chain = Burnchain::new("workdir/path", "bitcoin", "testnet");
+        assert!(burn_chain.is_ok());
+
+        let burn_chain = burn_chain.unwrap();
+        let first_block_hash = BurnchainHeaderHash::from_hex(BITCOIN_TESTNET_FIRST_BLOCK_HASH).unwrap();
+        assert_eq!(PEER_VERSION_TESTNET, burn_chain.peer_version);
+        assert_eq!(BITCOIN_NETWORK_ID_TESTNET, burn_chain.network_id);
+        assert_eq!(BITCOIN_TESTNET_NAME, burn_chain.network_name);
+        assert_eq!("workdir/path", burn_chain.working_dir); 
+        assert_eq!(24, burn_chain.consensus_hash_lifetime);
+        assert_eq!(7, burn_chain.stable_confirmations);
+        assert_eq!(BITCOIN_TESTNET_FIRST_BLOCK_HEIGHT, burn_chain.first_block_height);
+        assert_eq!(first_block_hash, burn_chain.first_block_hash);
+        assert_eq!(BITCOIN_TESTNET_FIRST_BLOCK_TIMESTAMP, burn_chain.first_block_timestamp);
+        assert_eq!(PoxConstants::testnet_default(), burn_chain.pox_constants);
+        assert_eq!(1_990_000, burn_chain.initial_reward_start_block);
+    }
+
+    #[test]
+    fn test_creation_by_new_for_bitcoin_regtest() {
+        let burn_chain = Burnchain::new("workdir/path", "bitcoin", "regtest");
+        assert!(burn_chain.is_ok());
+
+        let burn_chain = burn_chain.unwrap();
+        let first_block_hash = BurnchainHeaderHash::from_hex(BITCOIN_REGTEST_FIRST_BLOCK_HASH).unwrap();
+        assert_eq!(PEER_VERSION_TESTNET, burn_chain.peer_version);
+        assert_eq!(BITCOIN_NETWORK_ID_REGTEST, burn_chain.network_id);
+        assert_eq!(BITCOIN_REGTEST_NAME, burn_chain.network_name);
+        assert_eq!("workdir/path", burn_chain.working_dir); 
+        assert_eq!(24, burn_chain.consensus_hash_lifetime);
+        assert_eq!(1, burn_chain.stable_confirmations);
+        assert_eq!(BITCOIN_REGTEST_FIRST_BLOCK_HEIGHT, burn_chain.first_block_height);
+        assert_eq!(first_block_hash, burn_chain.first_block_hash);
+        assert_eq!(BITCOIN_REGTEST_FIRST_BLOCK_TIMESTAMP, burn_chain.first_block_timestamp);
+        assert_eq!(PoxConstants::regtest_default(), burn_chain.pox_constants);
+        assert_eq!(BITCOIN_REGTEST_FIRST_BLOCK_HEIGHT, burn_chain.initial_reward_start_block);
+    }
+
+    #[test]
+    fn test_creation_by_new_failure() {
+        //case: wrong chain name
+        let burn_chain = Burnchain::new("workdir/path", "wrong_chain_name", "regtest");
+        assert!(burn_chain.is_err());
+        assert!(matches!(burn_chain.unwrap_err(), burnchain_error::UnsupportedBurnchain));
+
+        //case: wrong network name
+        let burn_chain = Burnchain::new("workdir/path", "bitcoin", "wrong_net_name");
+        assert!(burn_chain.is_err());
+        assert!(matches!(burn_chain.unwrap_err(), burnchain_error::UnsupportedBurnchain));
+
+        //case: wrong chain name + wrong network name
+        let burn_chain = Burnchain::new("workdir/path", "wrong_chain_name", "wrong_net_name");
+        assert!(burn_chain.is_err());
+        assert!(matches!(burn_chain.unwrap_err(), burnchain_error::UnsupportedBurnchain));
+    }
+
+    #[test]
+    fn test_creation_by_default_unittest() {
+        let first_block_height = 0;
+        let first_block_hash = BurnchainHeaderHash([0u8; 32]);
+        let burn_chain = Burnchain::default_unittest(first_block_height, &first_block_hash);
+
+        let workdir_re = Regex::new(r"^/tmp/stacks-node-tests/unit-tests-[0-9a-f]{32}$").unwrap();
+
+        assert_eq!(PEER_VERSION_MAINNET, burn_chain.peer_version);
+        assert_eq!(BITCOIN_NETWORK_ID_MAINNET, burn_chain.network_id);
+        assert_eq!(BITCOIN_MAINNET_NAME, burn_chain.network_name);
+        assert!(workdir_re.is_match(&burn_chain.working_dir)); 
+        assert_eq!(24, burn_chain.consensus_hash_lifetime);
+        assert_eq!(7, burn_chain.stable_confirmations);
+        assert_eq!(first_block_height, burn_chain.first_block_height);
+        assert_eq!(first_block_hash, burn_chain.first_block_hash);
+        assert_eq!(BITCOIN_MAINNET_FIRST_BLOCK_TIMESTAMP, burn_chain.first_block_timestamp);
+        assert_eq!(PoxConstants::mainnet_default(), burn_chain.pox_constants);
+        assert_eq!(first_block_height, burn_chain.initial_reward_start_block);
+    }
+
+    #[test]
+    fn test_nakamoto_reward_cycle_boundaries() {
+        let first_block_height = 0;
+        let first_block_hash = BurnchainHeaderHash([0u8; 32]);
+        let burn_chain = Burnchain::default_unittest(first_block_height, &first_block_hash);
+
+        //making obvious the reward cycle length used
+        assert_eq!(2100, burn_chain.pox_constants.reward_cycle_length);
+
+        //Reward Cycle: 0
+        let rc = 0;
+        let rc_first_block = burn_chain.nakamoto_first_block_of_cycle(rc);
+        let rc_last_block = burn_chain.nakamoto_last_block_of_cycle(rc);
+        assert_eq!(0, rc_first_block);
+        assert_eq!(2099, rc_last_block);
+
+        //Reward Cycle: 1
+        let rc = 1;
+        let rc_first_block = burn_chain.nakamoto_first_block_of_cycle(rc);
+        let rc_last_block = burn_chain.nakamoto_last_block_of_cycle(rc);
+        assert_eq!(2100, rc_first_block);
+        assert_eq!(4199, rc_last_block);
+    }
+}