text: #!/usr/bin/env python3
  # Copyright (c) 2017-2020 The Hiphopcoin Core developers
  # Distributed under the MIT software license, see the accompanying
  # file COPYING or http://www.opensource.org/licenses/mit-license.php.
  """Test multiwallet.
  
  Verify that a hiphopcoind node can load multiple wallet files
  """
  from decimal import Decimal
  from threading import Thread
  import os
  import shutil
  import stat
  import time
  
  from test_framework.authproxy import JSONRPCException
  from test_framework.test_framework import HiphopcoinTestFramework
  from test_framework.test_node import ErrorMatch
  from test_framework.util import (
      assert_equal,
      assert_raises_rpc_error,
      get_rpc_proxy,
  )
  
  got_loading_error = False
  def test_load_unload(node, name):
      global got_loading_error
      for _ in range(10):
          if got_loading_error:
              return
          try:
              node.loadwallet(name)
              node.unloadwallet(name)
          except JSONRPCException as e:
              if e.error['code'] == -4 and 'Wallet already being loading' in e.error['message']:
                  got_loading_error = True
                  return
  
  
  class MultiWalletTest(HiphopcoinTestFramework):
      def set_test_params(self):
          self.setup_clean_chain = True
          self.num_nodes = 2
          self.rpc_timeout = 120
          self.extra_args = [["-nowallet"], []]
  
      def skip_test_if_missing_module(self):
          self.skip_if_no_wallet()
  
      def add_options(self, parser):
          parser.add_argument(
              '--data_wallets_dir',
              default=os.path.join(os.path.dirname(os.path.realpath(__file__)), 'data/wallets/'),
              help='Test data with wallet directories (default: %(default)s)',
          )
  
      def run_test(self):
          node = self.nodes[0]
  
          data_dir = lambda *p: os.path.join(node.datadir, self.chain, *p)
          wallet_dir = lambda *p: data_dir('wallets', *p)
          wallet = lambda name: node.get_wallet_rpc(name)
  
          def wallet_file(name):
              if name == self.default_wallet_name:
                  return wallet_dir(self.default_wallet_name, self.wallet_data_filename)
              if os.path.isdir(wallet_dir(name)):
                  return wallet_dir(name, "wallet.dat")
              return wallet_dir(name)
  
          assert_equal(self.nodes[0].listwalletdir(), { 'wallets': [{ 'name': self.default_wallet_name }] })
  
          # check wallet.dat is created
          self.stop_nodes()
          assert_equal(os.path.isfile(wallet_dir(self.default_wallet_name, self.wallet_data_filename)), True)
  
          # create symlink to verify wallet directory path can be referenced
          # through symlink
          os.mkdir(wallet_dir('w7'))
          os.symlink('w7', wallet_dir('w7_symlink'))
  
          os.symlink('..', wallet_dir('recursive_dir_symlink'))
  
          os.mkdir(wallet_dir('self_walletdat_symlink'))
          os.symlink('wallet.dat', wallet_dir('self_walletdat_symlink/wallet.dat'))
  
          # rename wallet.dat to make sure plain wallet file paths (as opposed to
          # directory paths) can be loaded
          # create another dummy wallet for use in testing backups later
          self.start_node(0)
          node.createwallet("empty")
          node.createwallet("plain")
          node.createwallet("created")
          self.stop_nodes()
          empty_wallet = os.path.join(self.options.tmpdir, 'empty.dat')
          os.rename(wallet_file("empty"), empty_wallet)
          shutil.rmtree(wallet_dir("empty"))
          empty_created_wallet = os.path.join(self.options.tmpdir, 'empty.created.dat')
          os.rename(wallet_dir("created", self.wallet_data_filename), empty_created_wallet)
          shutil.rmtree(wallet_dir("created"))
          os.rename(wallet_file("plain"), wallet_dir("w8"))
          shutil.rmtree(wallet_dir("plain"))
  
          # restart node with a mix of wallet names:
          #   w1, w2, w3 - to verify new wallets created when non-existing paths specified
          #   w          - to verify wallet name matching works when one wallet path is prefix of another
          #   sub/w5     - to verify relative wallet path is created correctly
          #   extern/w6  - to verify absolute wallet path is created correctly
          #   w7_symlink - to verify symlinked wallet path is initialized correctly
          #   w8         - to verify existing wallet file is loaded correctly. Not tested for SQLite wallets as this is a deprecated BDB behavior.
          #   ''         - to verify default wallet file is created correctly
          to_create = ['w1', 'w2', 'w3', 'w', 'sub/w5', 'w7_symlink']
          in_wallet_dir = [w.replace('/', os.path.sep) for w in to_create]  # Wallets in the wallet dir
          in_wallet_dir.append('w7')  # w7 is not loaded or created, but will be listed by listwalletdir because w7_symlink
          to_create.append(os.path.join(self.options.tmpdir, 'extern/w6'))  # External, not in the wallet dir, so we need to avoid adding it to in_wallet_dir
          to_load = [self.default_wallet_name]
          if not self.options.descriptors:
              to_load.append('w8')
          wallet_names = to_create + to_load  # Wallet names loaded in the wallet
          in_wallet_dir += to_load  # The loaded wallets are also in the wallet dir
          self.start_node(0)
          for wallet_name in to_create:
              self.nodes[0].createwallet(wallet_name)
          for wallet_name in to_load:
              self.nodes[0].loadwallet(wallet_name)
  
          os.mkdir(wallet_dir('no_access'))
          os.chmod(wallet_dir('no_access'), 0)
          try:
              with self.nodes[0].assert_debug_log(expected_msgs=['Too many levels of symbolic links', 'Error scanning']):
                  walletlist = self.nodes[0].listwalletdir()['wallets']
          finally:
              # Need to ensure access is restored for cleanup
              os.chmod(wallet_dir('no_access'), stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR)
          assert_equal(sorted(map(lambda w: w['name'], walletlist)), sorted(in_wallet_dir))
  
          assert_equal(set(node.listwallets()), set(wallet_names))
  
          # should raise rpc error if wallet path can't be created
          err_code = -4 if self.options.descriptors else -1
          assert_raises_rpc_error(err_code, "boost::filesystem::create_directory:", self.nodes[0].createwallet, "w8/bad")
  
          # check that all requested wallets were created
          self.stop_node(0)
          for wallet_name in wallet_names:
              assert_equal(os.path.isfile(wallet_file(wallet_name)), True)
  
          self.nodes[0].assert_start_raises_init_error(['-walletdir=wallets'], 'Error: Specified -walletdir "wallets" does not exist')
          self.nodes[0].assert_start_raises_init_error(['-walletdir=wallets'], 'Error: Specified -walletdir "wallets" is a relative path', cwd=data_dir())
          self.nodes[0].assert_start_raises_init_error(['-walletdir=debug.log'], 'Error: Specified -walletdir "debug.log" is not a directory', cwd=data_dir())
  
          self.start_node(0, ['-wallet=w1', '-wallet=w1'])
          self.stop_node(0, 'Warning: Ignoring duplicate -wallet w1.')
  
          if not self.options.descriptors:
              # Only BDB doesn't open duplicate wallet files. SQLite does not have this limitation. While this may be desired in the future, it is not necessary
              # should not initialize if one wallet is a copy of another
              shutil.copyfile(wallet_dir('w8'), wallet_dir('w8_copy'))
              in_wallet_dir.append('w8_copy')
              exp_stderr = r"BerkeleyDatabase: Can't open database w8_copy \(duplicates fileid \w+ from w8\)"
              self.nodes[0].assert_start_raises_init_error(['-wallet=w8', '-wallet=w8_copy'], exp_stderr, match=ErrorMatch.PARTIAL_REGEX)
  
          # should not initialize if wallet file is a symlink
          os.symlink('w8', wallet_dir('w8_symlink'))
          self.nodes[0].assert_start_raises_init_error(['-wallet=w8_symlink'], r'Error: Invalid -wallet path \'w8_symlink\'\. .*', match=ErrorMatch.FULL_REGEX)
  
          # should not initialize if the specified walletdir does not exist
          self.nodes[0].assert_start_raises_init_error(['-walletdir=bad'], 'Error: Specified -walletdir "bad" does not exist')
          # should not initialize if the specified walletdir is not a directory
          not_a_dir = wallet_dir('notadir')
          open(not_a_dir, 'a', encoding="utf8").close()
          self.nodes[0].assert_start_raises_init_error(['-walletdir=' + not_a_dir], 'Error: Specified -walletdir "' + not_a_dir + '" is not a directory')
  
          self.log.info("Do not allow -upgradewallet with multiwallet")
          self.nodes[0].assert_start_raises_init_error(['-upgradewallet'], "Error: Error parsing command line arguments: Invalid parameter -upgradewallet")
  
          # if wallets/ doesn't exist, datadir should be the default wallet dir
          wallet_dir2 = data_dir('walletdir')
          os.rename(wallet_dir(), wallet_dir2)
          self.start_node(0)
          self.nodes[0].createwallet("w4")
          self.nodes[0].createwallet("w5")
          assert_equal(set(node.listwallets()), {"w4", "w5"})
          w5 = wallet("w5")
          node.generatetoaddress(nblocks=1, address=w5.getnewaddress())
  
          # now if wallets/ exists again, but the rootdir is specified as the walletdir, w4 and w5 should still be loaded
          os.rename(wallet_dir2, wallet_dir())
          self.restart_node(0, ['-nowallet', '-walletdir=' + data_dir()])
          self.nodes[0].loadwallet("w4")
          self.nodes[0].loadwallet("w5")
          assert_equal(set(node.listwallets()), {"w4", "w5"})
          w5 = wallet("w5")
          w5_info = w5.getwalletinfo()
          assert_equal(w5_info['immature_balance'], 50)
  
          competing_wallet_dir = os.path.join(self.options.tmpdir, 'competing_walletdir')
          os.mkdir(competing_wallet_dir)
          self.restart_node(0, ['-nowallet', '-walletdir=' + competing_wallet_dir])
          self.nodes[0].createwallet(self.default_wallet_name)
          if self.options.descriptors:
              exp_stderr = r"Error: SQLiteDatabase: Unable to obtain an exclusive lock on the database, is it being used by another hiphopcoind?"
          else:
              exp_stderr = r"Error: Error initializing wallet database environment \"\S+competing_walletdir\S*\"!"
          self.nodes[1].assert_start_raises_init_error(['-walletdir=' + competing_wallet_dir], exp_stderr, match=ErrorMatch.PARTIAL_REGEX)
  
          self.restart_node(0)
          for wallet_name in wallet_names:
              self.nodes[0].loadwallet(wallet_name)
  
          assert_equal(sorted(map(lambda w: w['name'], self.nodes[0].listwalletdir()['wallets'])), sorted(in_wallet_dir))
  
          wallets = [wallet(w) for w in wallet_names]
          wallet_bad = wallet("bad")
  
          # check wallet names and balances
          node.generatetoaddress(nblocks=1, address=wallets[0].getnewaddress())
          for wallet_name, wallet in zip(wallet_names, wallets):
              info = wallet.getwalletinfo()
              assert_equal(info['immature_balance'], 50 if wallet is wallets[0] else 0)
              assert_equal(info['walletname'], wallet_name)
  
          # accessing invalid wallet fails
          assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded", wallet_bad.getwalletinfo)
  
          # accessing wallet RPC without using wallet endpoint fails
          assert_raises_rpc_error(-19, "Wallet file not specified", node.getwalletinfo)
  
          w1, w2, w3, w4, *_ = wallets
          node.generatetoaddress(nblocks=101, address=w1.getnewaddress())
          assert_equal(w1.getbalance(), 100)
          assert_equal(w2.getbalance(), 0)
          assert_equal(w3.getbalance(), 0)
          assert_equal(w4.getbalance(), 0)
  
          w1.sendtoaddress(w2.getnewaddress(), 1)
          w1.sendtoaddress(w3.getnewaddress(), 2)
          w1.sendtoaddress(w4.getnewaddress(), 3)
          node.generatetoaddress(nblocks=1, address=w1.getnewaddress())
          assert_equal(w2.getbalance(), 1)
          assert_equal(w3.getbalance(), 2)
          assert_equal(w4.getbalance(), 3)
  
          batch = w1.batch([w1.getblockchaininfo.get_request(), w1.getwalletinfo.get_request()])
          assert_equal(batch[0]["result"]["chain"], self.chain)
          assert_equal(batch[1]["result"]["walletname"], "w1")
  
          self.log.info('Check for per-wallet settxfee call')
          assert_equal(w1.getwalletinfo()['paytxfee'], 0)
          assert_equal(w2.getwalletinfo()['paytxfee'], 0)
          w2.settxfee(0.001)
          assert_equal(w1.getwalletinfo()['paytxfee'], 0)
          assert_equal(w2.getwalletinfo()['paytxfee'], Decimal('0.00100000'))
  
          self.log.info("Test dynamic wallet loading")
  
          self.restart_node(0, ['-nowallet'])
          assert_equal(node.listwallets(), [])
          assert_raises_rpc_error(-18, "No wallet is loaded. Load a wallet using loadwallet or create a new one with createwallet. (Note: A default wallet is no longer automatically created)", node.getwalletinfo)
  
          self.log.info("Load first wallet")
          loadwallet_name = node.loadwallet(wallet_names[0])
          assert_equal(loadwallet_name['name'], wallet_names[0])
          assert_equal(node.listwallets(), wallet_names[0:1])
          node.getwalletinfo()
          w1 = node.get_wallet_rpc(wallet_names[0])
          w1.getwalletinfo()
  
          self.log.info("Load second wallet")
          loadwallet_name = node.loadwallet(wallet_names[1])
          assert_equal(loadwallet_name['name'], wallet_names[1])
          assert_equal(node.listwallets(), wallet_names[0:2])
          assert_raises_rpc_error(-19, "Wallet file not specified", node.getwalletinfo)
          w2 = node.get_wallet_rpc(wallet_names[1])
          w2.getwalletinfo()
  
          self.log.info("Concurrent wallet loading")
          threads = []
          for _ in range(3):
              n = node.cli if self.options.usecli else get_rpc_proxy(node.url, 1, timeout=600, coveragedir=node.coverage_dir)
              t = Thread(target=test_load_unload, args=(n, wallet_names[2], ))
              t.start()
              threads.append(t)
          for t in threads:
              t.join()
          global got_loading_error
          assert_equal(got_loading_error, True)
  
          self.log.info("Load remaining wallets")
          for wallet_name in wallet_names[2:]:
              loadwallet_name = self.nodes[0].loadwallet(wallet_name)
              assert_equal(loadwallet_name['name'], wallet_name)
  
          assert_equal(set(self.nodes[0].listwallets()), set(wallet_names))
  
          # Fail to load if wallet doesn't exist
          path = os.path.join(self.options.tmpdir, "node0", "regtest", "wallets", "wallets")
          assert_raises_rpc_error(-18, "Wallet file verification failed. Failed to load database path '{}'. Path does not exist.".format(path), self.nodes[0].loadwallet, 'wallets')
  
          # Fail to load duplicate wallets
          path = os.path.join(self.options.tmpdir, "node0", "regtest", "wallets", "w1", "wallet.dat")
          if self.options.descriptors:
              assert_raises_rpc_error(-4, "Wallet file verification failed. SQLiteDatabase: Unable to obtain an exclusive lock on the database, is it being used by another hiphopcoind?", self.nodes[0].loadwallet, wallet_names[0])
          else:
              assert_raises_rpc_error(-4, "Wallet file verification failed. Refusing to load database. Data file '{}' is already loaded.".format(path), self.nodes[0].loadwallet, wallet_names[0])
  
              # This tests the default wallet that BDB makes, so SQLite wallet doesn't need to test this
              # Fail to load duplicate wallets by different ways (directory and filepath)
              path = os.path.join(self.options.tmpdir, "node0", "regtest", "wallets", "wallet.dat")
              assert_raises_rpc_error(-4, "Wallet file verification failed. Refusing to load database. Data file '{}' is already loaded.".format(path), self.nodes[0].loadwallet, 'wallet.dat')
  
              # Only BDB doesn't open duplicate wallet files. SQLite does not have this limitation. While this may be desired in the future, it is not necessary
              # Fail to load if one wallet is a copy of another
              assert_raises_rpc_error(-4, "BerkeleyDatabase: Can't open database w8_copy (duplicates fileid", self.nodes[0].loadwallet, 'w8_copy')
  
              # Fail to load if one wallet is a copy of another, test this twice to make sure that we don't re-introduce #14304
              assert_raises_rpc_error(-4, "BerkeleyDatabase: Can't open database w8_copy (duplicates fileid", self.nodes[0].loadwallet, 'w8_copy')
  
          # Fail to load if wallet file is a symlink
          assert_raises_rpc_error(-4, "Wallet file verification failed. Invalid -wallet path 'w8_symlink'", self.nodes[0].loadwallet, 'w8_symlink')
  
          # Fail to load if a directory is specified that doesn't contain a wallet
          os.mkdir(wallet_dir('empty_wallet_dir'))
          path = os.path.join(self.options.tmpdir, "node0", "regtest", "wallets", "empty_wallet_dir")
          assert_raises_rpc_error(-18, "Wallet file verification failed. Failed to load database path '{}'. Data is not in recognized format.".format(path), self.nodes[0].loadwallet, 'empty_wallet_dir')
  
          self.log.info("Test dynamic wallet creation.")
  
          # Fail to create a wallet if it already exists.
          path = os.path.join(self.options.tmpdir, "node0", "regtest", "wallets", "w2")
          assert_raises_rpc_error(-4, "Failed to create database path '{}'. Database already exists.".format(path), self.nodes[0].createwallet, 'w2')
  
          # Successfully create a wallet with a new name
          loadwallet_name = self.nodes[0].createwallet('w9')
          in_wallet_dir.append('w9')
          assert_equal(loadwallet_name['name'], 'w9')
          w9 = node.get_wallet_rpc('w9')
          assert_equal(w9.getwalletinfo()['walletname'], 'w9')
  
          assert 'w9' in self.nodes[0].listwallets()
  
          # Successfully create a wallet using a full path
          new_wallet_dir = os.path.join(self.options.tmpdir, 'new_walletdir')
          new_wallet_name = os.path.join(new_wallet_dir, 'w10')
          loadwallet_name = self.nodes[0].createwallet(new_wallet_name)
          assert_equal(loadwallet_name['name'], new_wallet_name)
          w10 = node.get_wallet_rpc(new_wallet_name)
          assert_equal(w10.getwalletinfo()['walletname'], new_wallet_name)
  
          assert new_wallet_name in self.nodes[0].listwallets()
  
          self.log.info("Test dynamic wallet unloading")
  
          # Test `unloadwallet` errors
          assert_raises_rpc_error(-1, "JSON value is not a string as expected", self.nodes[0].unloadwallet)
          assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded", self.nodes[0].unloadwallet, "dummy")
          assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded", node.get_wallet_rpc("dummy").unloadwallet)
          assert_raises_rpc_error(-8, "Both the RPC endpoint wallet and wallet_name parameter were provided (only one allowed)", w1.unloadwallet, "w2"),
          assert_raises_rpc_error(-8, "Both the RPC endpoint wallet and wallet_name parameter were provided (only one allowed)", w1.unloadwallet, "w1"),
  
          # Successfully unload the specified wallet name
          self.nodes[0].unloadwallet("w1")
          assert 'w1' not in self.nodes[0].listwallets()
  
          # Successfully unload the wallet referenced by the request endpoint
          # Also ensure unload works during walletpassphrase timeout
          w2.encryptwallet('test')
          w2.walletpassphrase('test', 1)
          w2.unloadwallet()
          time.sleep(1.1)
          assert 'w2' not in self.nodes[0].listwallets()
  
          # Successfully unload all wallets
          for wallet_name in self.nodes[0].listwallets():
              self.nodes[0].unloadwallet(wallet_name)
          assert_equal(self.nodes[0].listwallets(), [])
          assert_raises_rpc_error(-18, "No wallet is loaded. Load a wallet using loadwallet or create a new one with createwallet. (Note: A default wallet is no longer automatically created)", self.nodes[0].getwalletinfo)
  
          # Successfully load a previously unloaded wallet
          self.nodes[0].loadwallet('w1')
          assert_equal(self.nodes[0].listwallets(), ['w1'])
          assert_equal(w1.getwalletinfo()['walletname'], 'w1')
  
          assert_equal(sorted(map(lambda w: w['name'], self.nodes[0].listwalletdir()['wallets'])), sorted(in_wallet_dir))
  
          # Test backing up and restoring wallets
          self.log.info("Test wallet backup")
          self.restart_node(0, ['-nowallet'])
          for wallet_name in wallet_names:
              self.nodes[0].loadwallet(wallet_name)
          for wallet_name in wallet_names:
              rpc = self.nodes[0].get_wallet_rpc(wallet_name)
              addr = rpc.getnewaddress()
              backup = os.path.join(self.options.tmpdir, 'backup.dat')
              if os.path.exists(backup):
                  os.unlink(backup)
              rpc.backupwallet(backup)
              self.nodes[0].unloadwallet(wallet_name)
              shutil.copyfile(empty_created_wallet if wallet_name == self.default_wallet_name else empty_wallet, wallet_file(wallet_name))
              self.nodes[0].loadwallet(wallet_name)
              assert_equal(rpc.getaddressinfo(addr)['ismine'], False)
              self.nodes[0].unloadwallet(wallet_name)
              shutil.copyfile(backup, wallet_file(wallet_name))
              self.nodes[0].loadwallet(wallet_name)
              assert_equal(rpc.getaddressinfo(addr)['ismine'], True)
  
          # Test .walletlock file is closed
          self.start_node(1)
          wallet = os.path.join(self.options.tmpdir, 'my_wallet')
          self.nodes[0].createwallet(wallet)
          if self.options.descriptors:
              assert_raises_rpc_error(-4, "Unable to obtain an exclusive lock", self.nodes[1].loadwallet, wallet)
          else:
              assert_raises_rpc_error(-4, "Error initializing wallet database environment", self.nodes[1].loadwallet, wallet)
          self.nodes[0].unloadwallet(wallet)
          self.nodes[1].loadwallet(wallet)
  
  
  if __name__ == '__main__':
      MultiWalletTest().main()
  