commit e2717284eb01826f2251a8f91f8f0d2a2b06ab35
parent 020702968230606c60564a4ec03fd2c53d65675f
Author: ThomasV <thomasv1@gmx.de>
Date: Thu, 10 Jul 2014 02:58:51 +0200
Merge pull request #749 from chrisglass/clean-tests-wallet
Add tests to the wallet.py module.
Diffstat:
3 files changed, 195 insertions(+), 17 deletions(-)
diff --git a/lib/tests/test_bitcoin.py b/lib/tests/test_bitcoin.py
@@ -13,6 +13,7 @@ try:
except ImportError:
sys.exit("Error: python-ecdsa does not seem to be installed. Try 'sudo pip install ecdsa'")
+
class Test_bitcoin(unittest.TestCase):
def test_crypto(self):
diff --git a/lib/tests/test_wallet.py b/lib/tests/test_wallet.py
@@ -0,0 +1,184 @@
+import shutil
+import tempfile
+import sys
+import unittest
+import os
+
+from StringIO import StringIO
+from lib.wallet import WalletStorage, NewWallet
+
+
+class FakeConfig(object):
+ """A stub config file to be used in tests"""
+ def __init__(self, path):
+ self.path = path
+ self.store = {}
+
+ def set(self, key, value):
+ self.store[key] = value
+
+ def get(self, key, default=None):
+ return self.store.get(key, default)
+
+
+class FakeSynchronizer(object):
+
+ def __init__(self):
+ self.store = []
+
+ def add(self, address):
+ self.store.append(address)
+
+
+class WalletTestCase(unittest.TestCase):
+
+ def setUp(self):
+ super(WalletTestCase, self).setUp()
+ self.user_dir = tempfile.mkdtemp()
+
+ self.fake_config = FakeConfig(self.user_dir)
+
+ self._saved_stdout = sys.stdout
+ self._stdout_buffer = StringIO()
+ sys.stdout = self._stdout_buffer
+
+ def tearDown(self):
+ super(WalletTestCase, self).tearDown()
+ shutil.rmtree(self.user_dir)
+ # Restore the "real" stdout
+ sys.stdout = self._saved_stdout
+
+
+class TestWalletStorage(WalletTestCase):
+
+ def test_init_wallet_default_path(self):
+ storage = WalletStorage(self.fake_config)
+ expected = os.path.join(self.user_dir, "wallets", "default_wallet")
+ self.assertEqual(expected, storage.path)
+
+ def test_init_wallet_explicit_path(self):
+ path = os.path.join(self.user_dir, "somewallet")
+ self.fake_config.set("wallet_path", path)
+
+ storage = WalletStorage(self.fake_config)
+ self.assertEqual(path, storage.path)
+
+ def test_init_wallet_default_wallet_path(self):
+ path = os.path.join(self.user_dir, "somewallet")
+ self.fake_config.set("default_wallet_path", path)
+
+ storage = WalletStorage(self.fake_config)
+ self.assertEqual(path, storage.path)
+
+ def test_read_dictionnary_from_file(self):
+ path = os.path.join(self.user_dir, "somewallet")
+ self.fake_config.set("wallet_path", path)
+
+ some_dict = {"a":"b", "c":"d"}
+ contents = repr(some_dict)
+ with open(path, "w") as f:
+ contents = f.write(contents)
+
+ storage = WalletStorage(self.fake_config)
+ self.assertEqual("b", storage.get("a"))
+ self.assertEqual("d", storage.get("c"))
+
+ def test_write_dictionnary_to_file(self):
+ path = os.path.join(self.user_dir, "somewallet")
+ self.fake_config.set("wallet_path", path)
+
+ storage = WalletStorage(self.fake_config)
+
+ some_dict = {"a":"b", "c":"d"}
+ storage.data = some_dict
+
+ storage.write()
+
+ contents = ""
+ with open(path, "r") as f:
+ contents = f.read()
+ self.assertEqual(repr(some_dict), contents)
+
+
+class TestNewWallet(WalletTestCase):
+
+ seed_text = "The seed will sprout and grow up tall."
+ password = "secret"
+
+ master_xpub = "xpub661MyMwAqRbcGEop5Rnp68oX1ikeFNVMtx1utwXZGRKMmeXVxwBM5UzkwU9nGB1EofZekLDRfi1w5F9P7Vac3PEuWdWHr2gHLW8vp5YyKJ1"
+ master_xpriv = "xprv9s21ZrQH143K3kjLyQFoizrnTgv9qumWXj6K6Z7wi5nNtrCMRPs6XggH6Bbgz9CUgPJnZnV74yUdRSr8qWVELr9QQTgU5aNL33ViMyD9nhs"
+
+ first_account_name = "account1"
+ first_account_first_address = "1Jv9pLCJ4Sqr7aDYLGX5QhET4ps5qRcB9V"
+ first_account_second_address = "14n9EsZsgTTc4eC4TxeP1ccP8bXgwxPMmL"
+
+ import_private_key = "L52XzL2cMkHxqxBXRyEpnPQZGUs3uKiL3R11XbAdHigRzDozKZeW"
+ import_key_address = "15mKKb2eos1hWa6tisdPwwDC1a5J1y9nma"
+
+ def setUp(self):
+ super(TestNewWallet, self).setUp()
+ self.storage = WalletStorage(self.fake_config)
+ self.wallet = NewWallet(self.storage)
+ # This cannot be constructed by electrum at random, it should be safe
+ # from eventual collisions.
+ self.wallet.add_seed(self.seed_text, self.password)
+
+ def test_wallet_with_seed_is_not_watching_only(self):
+ self.assertFalse(self.wallet.is_watching_only())
+
+ def test_wallet_without_seed_is_watching_only(self):
+ # We need a new storage , since the default storage was already seeded
+ # in setUp()
+ new_dir = tempfile.mkdtemp()
+ config = FakeConfig(new_dir)
+ wallet = NewWallet(config)
+ self.assertTrue(wallet.is_watching_only())
+ shutil.rmtree(new_dir) # Don't leave useless stuff in /tmp
+
+ def test_new_wallet_is_deterministic(self):
+ self.assertTrue(self.wallet.is_deterministic())
+
+ def test_get_seed_returns_correct_seed(self):
+ self.assertEqual(self.wallet.get_seed(self.password), self.seed_text)
+ self.assertEqual(0, len(self.wallet.addresses()))
+
+ def test_add_account(self):
+ self.wallet.create_account(self.first_account_name, self.password)
+ self.assertEqual(1, len(self.wallet.addresses()))
+ self.assertIn(self.first_account_first_address,
+ self.wallet.addresses())
+
+ def test_add_account_add_address(self):
+ self.wallet.create_account(self.first_account_name, self.password)
+ self.wallet.synchronizer = FakeSynchronizer()
+
+ self.wallet.create_new_address()
+ self.assertEqual(2, len(self.wallet.addresses()))
+ self.assertIn(self.first_account_first_address,
+ self.wallet.addresses())
+ self.assertIn(self.first_account_second_address,
+ self.wallet.addresses())
+
+ def test_key_import(self):
+ # Wallets have no imported keys by default.
+ self.wallet.create_account(self.first_account_name, self.password)
+ self.assertFalse(self.wallet.has_imported_keys())
+
+ # Importing a key works.
+ self.wallet.import_key(self.import_private_key, "")
+ self.assertEqual(2, len(self.wallet.addresses()))
+ self.assertIn(self.import_key_address, self.wallet.addresses())
+
+ self.assertTrue(self.wallet.has_imported_keys())
+
+ # Deleting the key works.
+ self.wallet.delete_imported_key(self.import_key_address)
+ self.assertFalse(self.wallet.has_imported_keys())
+ self.assertEqual(1, len(self.wallet.addresses()))
+ self.assertNotIn(self.import_key_address, self.wallet.addresses())
+
+ def test_update_password(self):
+ new_password = "secret2"
+ self.wallet.update_password(self.password, new_password)
+ self.wallet.create_account(self.first_account_name, new_password)
+ self.assertEqual(1, len(self.wallet.addresses()))
diff --git a/lib/wallet.py b/lib/wallet.py
@@ -43,11 +43,10 @@ DUST_THRESHOLD = 5430
IMPORTED_ACCOUNT = '/x'
-
-class WalletStorage:
+class WalletStorage(object):
def __init__(self, config):
- self.lock = threading.Lock()
+ self.lock = threading.RLock()
self.config = config
self.data = {}
self.file_exists = False
@@ -56,7 +55,6 @@ class WalletStorage:
if self.path:
self.read(self.path)
-
def init_path(self, config):
"""Set the path of the wallet."""
@@ -84,7 +82,6 @@ class WalletStorage:
return new_path
-
def read(self, path):
"""Read the contents of the wallet file."""
try:
@@ -100,12 +97,13 @@ class WalletStorage:
self.data = d
self.file_exists = True
-
def get(self, key, default=None):
- v = self.data.get(key)
- if v is None:
- v = default
- return v
+
+ with self.lock:
+ v = self.data.get(key)
+ if v is None:
+ v = default
+ return v
def put(self, key, value, save = True):
@@ -127,12 +125,11 @@ class WalletStorage:
os.chmod(self.path,stat.S_IREAD | stat.S_IWRITE)
-class Abstract_Wallet:
+class Abstract_Wallet(object):
"""
Wallet classes are created to handle various address generation methods.
Completion states (watching-only, single account, no seed, etc) are handled inside classes.
"""
-
def __init__(self, storage):
self.storage = storage
self.electrum_version = ELECTRUM_VERSION
@@ -150,13 +147,11 @@ class Abstract_Wallet:
self.history = storage.get('addr_history',{}) # address -> list(txid, height)
self.fee = int(storage.get('fee_per_kb', 10000))
-
self.master_public_keys = storage.get('master_public_keys',{})
self.master_private_keys = storage.get('master_private_keys', {})
self.next_addresses = storage.get('next_addresses',{})
-
# This attribute is set when wallet.start_threads is called.
self.synchronizer = None
@@ -179,8 +174,6 @@ class Abstract_Wallet:
print_error("removing unreferenced tx", h)
self.transactions.pop(h)
-
-
# not saved
self.prevout_values = {} # my own transaction outputs
self.spent_outputs = []
@@ -340,7 +333,6 @@ class Abstract_Wallet:
return s[0] == 1
def get_address_index(self, address):
-
for account in self.accounts.keys():
for for_change in [0,1]:
addresses = self.accounts[account].get_addresses(for_change)
@@ -1059,6 +1051,7 @@ class Imported_Wallet(Abstract_Wallet):
def is_beyond_limit(self, address, account, is_change):
return False
+
class Deterministic_Wallet(Abstract_Wallet):
def __init__(self, storage):
