Merge pull request #1585 from nuttycom/debug/is_shielding

zcash_client_sqlite: Ensure that all shielded change outputs are correctly flagged.

zcash_client_backend/src/data_api/testing/pool.rs

@@ -1797,6 +1797,18 @@ where
     assert_eq!(tx.received_note_count(), 0);
     assert_eq!(tx.sent_note_count(), 0);
     assert!(tx.is_shielding());
+
+    // Generate and scan the block including the transaction
+    let (h, _) = st.generate_next_block_including(*txids.first());
+    st.scan_cached_blocks(h, 1);
+
+    // Ensure that the transaction metadata is still correct after the update produced by scanning.
+    let tx = st.get_tx_from_history(*txids.first()).unwrap().unwrap();
+    assert_eq!(tx.spent_note_count(), 1);
+    assert!(tx.has_change());
+    assert_eq!(tx.received_note_count(), 0);
+    assert_eq!(tx.sent_note_count(), 0);
+    assert!(tx.is_shielding());
 }
 
 // FIXME: This requires fixes to the test framework.

zcash_client_sqlite/src/lib.rs

@@ -1910,7 +1910,7 @@ mod tests {
     #[test]
     fn validate_seed() {
         let st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .with_account_from_sapling_activation(BlockHash([0; 32]))
             .build();
         let account = st.test_account().unwrap();
@@ -1940,7 +1940,7 @@ mod tests {
     #[test]
     pub(crate) fn get_next_available_address() {
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .with_account_from_sapling_activation(BlockHash([0; 32]))
             .build();
         let account = st.test_account().cloned().unwrap();
@@ -1962,7 +1962,7 @@ mod tests {
     #[test]
     pub(crate) fn import_account_hd_0() {
         let st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .with_account_from_sapling_activation(BlockHash([0; 32]))
             .set_account_index(zip32::AccountId::ZERO)
             .build();
@@ -1974,7 +1974,7 @@ mod tests {
     #[test]
     pub(crate) fn import_account_hd_1_then_2() {
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .build();
 
         let birthday = AccountBirthday::from_parts(
@@ -2065,7 +2065,7 @@ mod tests {
     #[test]
     pub(crate) fn import_account_hd_1_then_conflicts() {
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .build();
 
         let birthday = AccountBirthday::from_parts(
@@ -2097,7 +2097,7 @@ mod tests {
     #[test]
     pub(crate) fn import_account_ufvk_then_conflicts() {
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .build();
 
         let birthday = AccountBirthday::from_parts(
@@ -2142,7 +2142,7 @@ mod tests {
     #[test]
     pub(crate) fn create_account_then_conflicts() {
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .build();
 
         let birthday = AccountBirthday::from_parts(
@@ -2175,7 +2175,7 @@ mod tests {
 
         use crate::testing::BlockCache;
         let st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .with_block_cache(BlockCache::new())
             .with_account_from_sapling_activation(BlockHash([0; 32]))
             .build();
@@ -2208,7 +2208,7 @@ mod tests {
         use crate::testing::FsBlockCache;
 
         let mut st = TestBuilder::new()
-            .with_data_store_factory(TestDbFactory)
+            .with_data_store_factory(TestDbFactory::default())
             .with_block_cache(FsBlockCache::new())
             .build();
 

zcash_client_sqlite/src/testing/db.rs

@@ -2,6 +2,7 @@ use ambassador::Delegate;
 use rusqlite::Connection;
 use std::collections::HashMap;
 use std::num::NonZeroU32;
+use uuid::Uuid;
 
 use tempfile::NamedTempFile;
 
@@ -31,7 +32,11 @@ use zcash_primitives::{
 };
 use zcash_protocol::{consensus::BlockHeight, local_consensus::LocalNetwork, memo::Memo};
 
-use crate::{error::SqliteClientError, wallet::init::init_wallet_db, AccountId, WalletDb};
+use crate::{
+    error::SqliteClientError,
+    wallet::init::{init_wallet_db, init_wallet_db_internal},
+    AccountId, WalletDb,
+};
 
 #[cfg(feature = "transparent-inputs")]
 use {
@@ -142,7 +147,19 @@ unsafe fn run_sqlite3<S: AsRef<OsStr>>(db_path: S, command: &str) {
     eprintln!("------");
 }
 
-pub(crate) struct TestDbFactory;
+#[derive(Default)]
+pub(crate) struct TestDbFactory {
+    target_migrations: Option<Vec<Uuid>>,
+}
+
+impl TestDbFactory {
+    #[allow(dead_code)]
+    pub(crate) fn new(target_migrations: Vec<Uuid>) -> Self {
+        Self {
+            target_migrations: Some(target_migrations),
+        }
+    }
+}
 
 impl DataStoreFactory for TestDbFactory {
     type Error = ();
@@ -154,7 +171,11 @@ impl DataStoreFactory for TestDbFactory {
     fn new_data_store(&self, network: LocalNetwork) -> Result<Self::DataStore, Self::Error> {
         let data_file = NamedTempFile::new().unwrap();
         let mut db_data = WalletDb::for_path(data_file.path(), network).unwrap();
-        init_wallet_db(&mut db_data, None).unwrap();
+        if let Some(migrations) = &self.target_migrations {
+            init_wallet_db_internal(&mut db_data, None, migrations, true).unwrap();
+        } else {
+            init_wallet_db(&mut db_data, None).unwrap();
+        }
         Ok(TestDb::from_parts(db_data, data_file))
     }
 }
@@ -166,7 +187,7 @@ impl Reset for TestDb {
         let network = *st.network();
         let old_db = std::mem::replace(
             st.wallet_mut(),
-            TestDbFactory.new_data_store(network).unwrap(),
+            TestDbFactory::default().new_data_store(network).unwrap(),
         );
         old_db.take_data_file()
     }