From 99d30bea0fdea9f5dc9220f5502134d640fa365a Mon Sep 17 00:00:00 2001 From: Daniel Van Der Maden Date: Tue, 4 Feb 2020 14:39:08 -0800 Subject: [PATCH] [cli] Refactor stored address logic --- pyhmy/_version.py | 2 +- pyhmy/cli.py | 47 ++++++++++++++++++++++--------------- tests/cli-pyhmy/test_cli.py | 16 ------------- 3 files changed, 29 insertions(+), 36 deletions(-) diff --git a/pyhmy/_version.py b/pyhmy/_version.py index cfc86a3..407848e 100644 --- a/pyhmy/_version.py +++ b/pyhmy/_version.py @@ -7,5 +7,5 @@ Provides pyhmy version information. from incremental import Version -__version__ = Version('pyhmy', 20, 1, 16) +__version__ = Version('pyhmy', 20, 1, 19) __all__ = ["__version__"] diff --git a/pyhmy/cli.py b/pyhmy/cli.py index 7c01d28..5363cc8 100644 --- a/pyhmy/cli.py +++ b/pyhmy/cli.py @@ -22,20 +22,6 @@ Example: This module refers to `accounts` as the NAME/ALIAS of an `address` given to by the CLI's account keystore. -Example: - Below is a demo of how to set the CLI binary used by the module:: - >>> import os - >>> env = cli.download("./bin/test", replace=False) - >>> cli.environment.update(env) - >>> new_path = os.getcwd() + "/bin/test" - >>> new_path - '/Users/danielvdm/go/src/github.com/harmony-one/pyhmy/bin/test' - >>> from pyhmy import cli - >>> cli.set_binary(new_path) - True - >>> cli.get_binary_path() - '/Users/danielvdm/go/src/github.com/harmony-one/pyhmy/bin/test' - For more details, reference the documentation here: TODO gitbook docs """ @@ -60,11 +46,37 @@ else: _accounts = {} # Internal accounts keystore, make sure to sync when needed. _account_keystore_path = "~/.hmy/account-keys" # Internal path to account keystore, will match the current binary. _binary_path = "hmy" # Internal binary path. -_keystore_lock = Lock() +_keystore_cache_lock = Lock() environment = os.environ.copy() # The environment for the CLI to execute in. +def _cache_and_lock_accounts_keystore(fn): + """ + Internal decorator to cache the accounts keystore and + prevent concurrent accesses with locks. + """ + cached_accounts = {} + last_mod = None + + def wrap(*args): + nonlocal last_mod + _keystore_cache_lock.acquire() + files_in_dir = str(os.listdir(_account_keystore_path)) + dir_mod_time = str(os.path.getmtime(_account_keystore_path)) + curr_mod = hash(files_in_dir + dir_mod_time + _binary_path) + if curr_mod != last_mod: + cached_accounts.clear() + cached_accounts.update(fn(*args)) + last_mod = curr_mod + accounts = cached_accounts.copy() + _keystore_cache_lock.release() + return accounts + + return wrap + + +@_cache_and_lock_accounts_keystore def _get_current_accounts_keystore(): """ Internal function that gets the current keystore from the CLI. @@ -72,10 +84,8 @@ def _get_current_accounts_keystore(): :returns A dictionary where the keys are the account names/aliases and the values are their 'one1...' addresses. """ - _keystore_lock.acquire() curr_addresses = {} response = single_call("hmy keys list") - _keystore_lock.release() lines = response.split("\n") if "NAME" not in lines[0] or "ADDRESS" not in lines[0]: raise ValueError("Name or Address not found on first line of key list") @@ -105,8 +115,7 @@ def _sync_accounts(): """ Internal function that UPDATES the accounts keystore with the CLI's keystore. """ - _accounts.clear() - _accounts.update(_get_current_accounts_keystore()) + _accounts = _get_current_accounts_keystore() def get_accounts_keystore(): diff --git a/tests/cli-pyhmy/test_cli.py b/tests/cli-pyhmy/test_cli.py index 1cb9802..6a8b009 100644 --- a/tests/cli-pyhmy/test_cli.py +++ b/tests/cli-pyhmy/test_cli.py @@ -52,19 +52,3 @@ def test_bin_set(): cli_binary_path = cli.get_binary_path() assert os.path.realpath(cli_binary_path) == os.path.realpath(BINARY_FILE_PATH) - -def test_update_keystore(): - cli.single_call("hmy keys add test1") - addrs = cli.get_accounts_keystore() - assert "test1" in addrs.keys() - check_addr = addrs["test1"] - accounts_list = cli.get_accounts(check_addr) - check_acc = accounts_list[0] - assert check_acc == "test1" - raw_cli_keys_list_print = cli.single_call("hmy keys list", timeout=2) - assert check_addr in raw_cli_keys_list_print - assert check_acc in raw_cli_keys_list_print - assert addrs[check_acc] == check_addr - cli.remove_address(check_addr) - assert check_addr not in addrs.values() - assert "test1" not in addrs.keys()