Merge pull request #1116

2e18e10 libwallet_api: simple documentation on testing environment (Ilya Kitaev)
69c9824 libwallet_api: tests: env variables for WALLETS_ROOT_DIR and TESTNET_DAEMON_ADDRESS (Ilya Kitaev)
1f8a70c libwallet_api: tests: changed testwallets path, uncommitted all tests (Ilya Kitaev)
d5d0856 wallet2_api: getter and setter for "refresh interval" (Ilya Kitaev)
cdb6c96 wallet2_api: fixed deadlock while closing wallet (Ilya Kitaev)
This commit is contained in:
Riccardo Spagni 2016-09-26 17:34:06 +02:00
commit cf74a137f3
No known key found for this signature in database
GPG key ID: 55432DF31CCD4FCD
6 changed files with 126 additions and 30 deletions

View file

@ -169,7 +169,9 @@ WalletImpl::WalletImpl(bool testnet)
m_wallet->callback(m_wallet2Callback); m_wallet->callback(m_wallet2Callback);
m_refreshThreadDone = false; m_refreshThreadDone = false;
m_refreshEnabled = false; m_refreshEnabled = false;
m_refreshIntervalSeconds = DEFAULT_REFRESH_INTERVAL_SECONDS; m_refreshIntervalSeconds = DEFAULT_REFRESH_INTERVAL_SECONDS;
m_refreshThread = boost::thread([this] () { m_refreshThread = boost::thread([this] () {
this->refreshThreadFunc(); this->refreshThreadFunc();
}); });
@ -272,14 +274,15 @@ bool WalletImpl::close()
{ {
bool result = false; bool result = false;
LOG_PRINT_L3("closing wallet...");
try { try {
// do not store wallet with invalid status // do not store wallet with invalid status
if (status() == Status_Ok) if (status() == Status_Ok)
m_wallet->store(); m_wallet->store();
// LOG_PRINT_L0("wallet::store done"); LOG_PRINT_L3("wallet::store done");
// LOG_PRINT_L0("Calling wallet::stop..."); LOG_PRINT_L3("Calling wallet::stop...");
m_wallet->stop(); m_wallet->stop();
// LOG_PRINT_L0("wallet::stop done"); LOG_PRINT_L3("wallet::stop done");
result = true; result = true;
clearStatus(); clearStatus();
} catch (const std::exception &e) { } catch (const std::exception &e) {
@ -425,6 +428,16 @@ void WalletImpl::refreshAsync()
m_refreshCV.notify_one(); m_refreshCV.notify_one();
} }
void WalletImpl::setAutoRefreshInterval(int seconds)
{
m_refreshIntervalSeconds = seconds;
}
int WalletImpl::autoRefreshInterval() const
{
return m_refreshIntervalSeconds;
}
// TODO: // TODO:
// 1 - properly handle payment id (add another menthod with explicit 'payment_id' param) // 1 - properly handle payment id (add another menthod with explicit 'payment_id' param)
// 2 - check / design how "Transaction" can be single interface // 2 - check / design how "Transaction" can be single interface
@ -637,7 +650,15 @@ void WalletImpl::refreshThreadFunc()
break; break;
} }
LOG_PRINT_L3(__FUNCTION__ << ": waiting for refresh..."); LOG_PRINT_L3(__FUNCTION__ << ": waiting for refresh...");
m_refreshCV.wait(lock); // if auto refresh enabled, we wait for the "m_refreshIntervalSeconds" interval.
// if not - we wait forever
if (m_refreshIntervalSeconds > 0) {
boost::posix_time::milliseconds wait_for_ms(m_refreshIntervalSeconds * 1000);
m_refreshCV.timed_wait(lock, wait_for_ms);
} else {
m_refreshCV.wait(lock);
}
LOG_PRINT_L3(__FUNCTION__ << ": refresh lock acquired..."); LOG_PRINT_L3(__FUNCTION__ << ": refresh lock acquired...");
LOG_PRINT_L3(__FUNCTION__ << ": m_refreshEnabled: " << m_refreshEnabled); LOG_PRINT_L3(__FUNCTION__ << ": m_refreshEnabled: " << m_refreshEnabled);
LOG_PRINT_L3(__FUNCTION__ << ": m_status: " << m_status); LOG_PRINT_L3(__FUNCTION__ << ": m_status: " << m_status);
@ -680,6 +701,7 @@ void WalletImpl::stopRefresh()
if (!m_refreshThreadDone) { if (!m_refreshThreadDone) {
m_refreshEnabled = false; m_refreshEnabled = false;
m_refreshThreadDone = true; m_refreshThreadDone = true;
m_refreshCV.notify_one();
m_refreshThread.join(); m_refreshThread.join();
} }
} }

View file

@ -77,6 +77,11 @@ public:
uint64_t unlockedBalance() const; uint64_t unlockedBalance() const;
bool refresh(); bool refresh();
void refreshAsync(); void refreshAsync();
void setAutoRefreshInterval(int seconds);
int autoRefreshInterval() const;
PendingTransaction * createTransaction(const std::string &dst_addr, const std::string &payment_id, PendingTransaction * createTransaction(const std::string &dst_addr, const std::string &payment_id,
uint64_t amount, uint32_t mixin_count, uint64_t amount, uint32_t mixin_count,
PendingTransaction::Priority priority = PendingTransaction::Priority_Low); PendingTransaction::Priority priority = PendingTransaction::Priority_Low);

View file

@ -223,10 +223,25 @@ struct Wallet
* @return - true if refreshed successfully; * @return - true if refreshed successfully;
*/ */
virtual bool refresh() = 0; virtual bool refresh() = 0;
/** /**
* @brief refreshAsync - refreshes wallet asynchronously. * @brief refreshAsync - refreshes wallet asynchronously.
*/ */
virtual void refreshAsync() = 0; virtual void refreshAsync() = 0;
/**
* @brief setAutoRefreshInterval - setup interval for automatic refresh.
* @param seconds - interval in seconds. if zero or less than zero - automatic refresh disabled;
*/
virtual void setAutoRefreshInterval(int seconds) = 0;
/**
* @brief autoRefreshInterval - returns automatic refresh interval in seconds
* @return
*/
virtual int autoRefreshInterval() const = 0;
/*! /*!
* \brief createTransaction creates transaction. if dst_addr is an integrated address, payment_id is ignored * \brief createTransaction creates transaction. if dst_addr is an integrated address, payment_id is ignored
* \param dst_addr destination address as string * \param dst_addr destination address as string

View file

@ -36,6 +36,8 @@
#include <boost/filesystem.hpp> #include <boost/filesystem.hpp>
#include <boost/algorithm/string.hpp> #include <boost/algorithm/string.hpp>
#include <boost/asio.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <iostream> #include <iostream>
#include <vector> #include <vector>
@ -63,29 +65,28 @@ const char * WALLET_PASS = "password";
const char * WALLET_PASS2 = "password22"; const char * WALLET_PASS2 = "password22";
const char * WALLET_LANG = "English"; const char * WALLET_LANG = "English";
// change this according your environment std::string WALLETS_ROOT_DIR = "/var/monero/testnet_pvt";
std::string TESTNET_WALLET1_NAME;
const std::string WALLETS_ROOT_DIR = "/home/mbg033/dev/monero/testnet/"; std::string TESTNET_WALLET2_NAME;
std::string TESTNET_WALLET3_NAME;
const std::string TESTNET_WALLET1_NAME = WALLETS_ROOT_DIR + "wallet_01.bin"; std::string TESTNET_WALLET4_NAME;
const std::string TESTNET_WALLET2_NAME = WALLETS_ROOT_DIR + "wallet_02.bin"; std::string TESTNET_WALLET5_NAME;
const std::string TESTNET_WALLET3_NAME = WALLETS_ROOT_DIR + "wallet_03.bin"; std::string TESTNET_WALLET6_NAME;
const std::string TESTNET_WALLET4_NAME = WALLETS_ROOT_DIR + "wallet_04.bin";
const std::string TESTNET_WALLET5_NAME = WALLETS_ROOT_DIR + "wallet_05.bin";
const std::string TESTNET_WALLET6_NAME = WALLETS_ROOT_DIR + "wallet_06.bin";
const char * TESTNET_WALLET_PASS = ""; const char * TESTNET_WALLET_PASS = "";
const std::string CURRENT_SRC_WALLET = TESTNET_WALLET1_NAME; std::string CURRENT_SRC_WALLET;
const std::string CURRENT_DST_WALLET = TESTNET_WALLET6_NAME; std::string CURRENT_DST_WALLET;
const char * TESTNET_DAEMON_ADDRESS = "localhost:38081";
const uint64_t AMOUNT_10XMR = 10000000000000L; const uint64_t AMOUNT_10XMR = 10000000000000L;
const uint64_t AMOUNT_5XMR = 5000000000000L; const uint64_t AMOUNT_5XMR = 5000000000000L;
const uint64_t AMOUNT_1XMR = 1000000000000L; const uint64_t AMOUNT_1XMR = 1000000000000L;
const std::string PAYMENT_ID_EMPTY = ""; const std::string PAYMENT_ID_EMPTY = "";
std::string TESTNET_DAEMON_ADDRESS = "localhost:38081";
} }
@ -179,10 +180,8 @@ struct WalletTest2 : public testing::Test
wmgr = Bitmonero::WalletManagerFactory::getWalletManager(); wmgr = Bitmonero::WalletManagerFactory::getWalletManager();
} }
}; };
TEST_F(WalletManagerTest, WalletManagerCreatesWallet) TEST_F(WalletManagerTest, WalletManagerCreatesWallet)
{ {
@ -220,6 +219,7 @@ TEST_F(WalletManagerTest, WalletMaxAmountAsString)
} }
TEST_F(WalletManagerTest, WalletAmountFromString) TEST_F(WalletManagerTest, WalletAmountFromString)
{ {
uint64_t amount = Bitmonero::Wallet::amountFromString("18446740"); uint64_t amount = Bitmonero::Wallet::amountFromString("18446740");
@ -394,6 +394,7 @@ TEST_F(WalletManagerTest, WalletManagerStoresWallet2)
ASSERT_TRUE(wmgr->closeWallet(wallet1)); ASSERT_TRUE(wmgr->closeWallet(wallet1));
} }
TEST_F(WalletManagerTest, WalletManagerStoresWallet3) TEST_F(WalletManagerTest, WalletManagerStoresWallet3)
{ {
Bitmonero::Wallet * wallet1 = wmgr->createWallet(WALLET_NAME, WALLET_PASS, WALLET_LANG); Bitmonero::Wallet * wallet1 = wmgr->createWallet(WALLET_NAME, WALLET_PASS, WALLET_LANG);
@ -406,7 +407,8 @@ TEST_F(WalletManagerTest, WalletManagerStoresWallet3)
wallet1 = wmgr->openWallet(WALLET_NAME_WITH_DIR_NON_WRITABLE, WALLET_PASS); wallet1 = wmgr->openWallet(WALLET_NAME_WITH_DIR_NON_WRITABLE, WALLET_PASS);
ASSERT_FALSE(wallet1->status() == Bitmonero::Wallet::Status_Ok); ASSERT_FALSE(wallet1->status() == Bitmonero::Wallet::Status_Ok);
ASSERT_FALSE(wmgr->closeWallet(wallet1)); // "close" always returns true;
ASSERT_TRUE(wmgr->closeWallet(wallet1));
wallet1 = wmgr->openWallet(WALLET_NAME, WALLET_PASS); wallet1 = wmgr->openWallet(WALLET_NAME, WALLET_PASS);
ASSERT_TRUE(wallet1->status() == Bitmonero::Wallet::Status_Ok); ASSERT_TRUE(wallet1->status() == Bitmonero::Wallet::Status_Ok);
@ -416,6 +418,7 @@ TEST_F(WalletManagerTest, WalletManagerStoresWallet3)
} }
TEST_F(WalletManagerTest, WalletManagerStoresWallet4) TEST_F(WalletManagerTest, WalletManagerStoresWallet4)
{ {
Bitmonero::Wallet * wallet1 = wmgr->createWallet(WALLET_NAME, WALLET_PASS, WALLET_LANG); Bitmonero::Wallet * wallet1 = wmgr->createWallet(WALLET_NAME, WALLET_PASS, WALLET_LANG);
@ -451,14 +454,14 @@ TEST_F(WalletManagerTest, WalletManagerFindsWallet)
} }
TEST_F(WalletManagerTest, WalletGeneratesPaymentId) TEST_F(WalletTest1, WalletGeneratesPaymentId)
{ {
std::string payment_id = Bitmonero::Wallet::genPaymentId(); std::string payment_id = Bitmonero::Wallet::genPaymentId();
ASSERT_TRUE(payment_id.length() == 16); ASSERT_TRUE(payment_id.length() == 16);
} }
TEST_F(WalletManagerTest, WalletGeneratesIntegratedAddress) TEST_F(WalletTest1, WalletGeneratesIntegratedAddress)
{ {
std::string payment_id = Bitmonero::Wallet::genPaymentId(); std::string payment_id = Bitmonero::Wallet::genPaymentId();
@ -490,6 +493,7 @@ TEST_F(WalletTest1, WalletShowsBalance)
TEST_F(WalletTest1, WalletRefresh) TEST_F(WalletTest1, WalletRefresh)
{ {
Bitmonero::Wallet * wallet1 = wmgr->openWallet(CURRENT_SRC_WALLET, TESTNET_WALLET_PASS, true); Bitmonero::Wallet * wallet1 = wmgr->openWallet(CURRENT_SRC_WALLET, TESTNET_WALLET_PASS, true);
// make sure testnet daemon is running // make sure testnet daemon is running
ASSERT_TRUE(wallet1->init(TESTNET_DAEMON_ADDRESS, 0)); ASSERT_TRUE(wallet1->init(TESTNET_DAEMON_ADDRESS, 0));
@ -497,7 +501,6 @@ TEST_F(WalletTest1, WalletRefresh)
ASSERT_TRUE(wmgr->closeWallet(wallet1)); ASSERT_TRUE(wmgr->closeWallet(wallet1));
} }
TEST_F(WalletTest1, WalletConvertsToString) TEST_F(WalletTest1, WalletConvertsToString)
{ {
std::string strAmount = Bitmonero::Wallet::displayAmount(AMOUNT_5XMR); std::string strAmount = Bitmonero::Wallet::displayAmount(AMOUNT_5XMR);
@ -512,6 +515,7 @@ TEST_F(WalletTest1, WalletConvertsToString)
TEST_F(WalletTest1, WalletTransaction) TEST_F(WalletTest1, WalletTransaction)
{ {
Bitmonero::Wallet * wallet1 = wmgr->openWallet(CURRENT_SRC_WALLET, TESTNET_WALLET_PASS, true); Bitmonero::Wallet * wallet1 = wmgr->openWallet(CURRENT_SRC_WALLET, TESTNET_WALLET_PASS, true);
// make sure testnet daemon is running // make sure testnet daemon is running
@ -538,6 +542,8 @@ TEST_F(WalletTest1, WalletTransaction)
ASSERT_TRUE(wmgr->closeWallet(wallet1)); ASSERT_TRUE(wmgr->closeWallet(wallet1));
} }
TEST_F(WalletTest1, WalletTransactionWithMixin) TEST_F(WalletTest1, WalletTransactionWithMixin)
{ {
@ -792,6 +798,8 @@ struct MyWalletListener : public Bitmonero::WalletListener
}; };
TEST_F(WalletTest2, WalletCallBackRefreshedSync) TEST_F(WalletTest2, WalletCallBackRefreshedSync)
{ {
@ -800,13 +808,15 @@ TEST_F(WalletTest2, WalletCallBackRefreshedSync)
ASSERT_TRUE(wallet_src->init(TESTNET_DAEMON_ADDRESS, 0)); ASSERT_TRUE(wallet_src->init(TESTNET_DAEMON_ADDRESS, 0));
ASSERT_TRUE(wallet_src_listener->refresh_triggered); ASSERT_TRUE(wallet_src_listener->refresh_triggered);
ASSERT_TRUE(wallet_src->connected()); ASSERT_TRUE(wallet_src->connected());
// std::chrono::seconds wait_for = std::chrono::seconds(60*3); std::chrono::seconds wait_for = std::chrono::seconds(60*3);
// std::unique_lock<std::mutex> lock (wallet_src_listener->mutex); std::unique_lock<std::mutex> lock (wallet_src_listener->mutex);
// wallet_src_listener->cv_refresh.wait_for(lock, wait_for); wallet_src_listener->cv_refresh.wait_for(lock, wait_for);
wmgr->closeWallet(wallet_src); wmgr->closeWallet(wallet_src);
} }
TEST_F(WalletTest2, WalletCallBackRefreshedAsync) TEST_F(WalletTest2, WalletCallBackRefreshedAsync)
{ {
@ -908,10 +918,32 @@ TEST_F(WalletTest2, WalletCallbackReceived)
} }
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
// we can override default values for "TESTNET_DAEMON_ADDRESS" and "WALLETS_ROOT_DIR"
const char * monero_daemon_addr = std::getenv("TESTNET_DAEMON_ADDRESS");
if (monero_daemon_addr) {
TESTNET_DAEMON_ADDRESS = monero_daemon_addr;
}
const char * wallets_root_dir = std::getenv("WALLETS_ROOT_DIR");
if (wallets_root_dir) {
WALLETS_ROOT_DIR = wallets_root_dir;
}
TESTNET_WALLET1_NAME = WALLETS_ROOT_DIR + "/wallet_01.bin";
TESTNET_WALLET2_NAME = WALLETS_ROOT_DIR + "/wallet_02.bin";
TESTNET_WALLET3_NAME = WALLETS_ROOT_DIR + "/wallet_03.bin";
TESTNET_WALLET4_NAME = WALLETS_ROOT_DIR + "/wallet_04.bin";
TESTNET_WALLET5_NAME = WALLETS_ROOT_DIR + "/wallet_05.bin";
TESTNET_WALLET6_NAME = WALLETS_ROOT_DIR + "/wallet_06.bin";
CURRENT_SRC_WALLET = TESTNET_WALLET6_NAME;
CURRENT_DST_WALLET = TESTNET_WALLET5_NAME;
::testing::InitGoogleTest(&argc, argv); ::testing::InitGoogleTest(&argc, argv);
// Bitmonero::WalletManagerFactory::setLogLevel(Bitmonero::WalletManagerFactory::LogLevel_Max);
return RUN_ALL_TESTS(); return RUN_ALL_TESTS();
} }

View file

@ -0,0 +1,24 @@
# Running libwallet_api tests
## Environment for the tests
* Running monero node, linked to private/public testnet.
By default, tests expect daemon running at ```localhost:38081```,
can we overriden with enviroment variable ```TESTNET_DAEMON_ADDRESS=<your_daemon_address>```
[Manual](https://github.com/moneroexamples/private-testnet) explaining how to run private testnet.
* Directory with pre-generated wallets
(wallet_01.bin, wallet_02.bin,...,wallet_06.bin, some of these wallets might not be used in the tests currently).
By default, tests expect these wallets to be in ```/var/monero/testnet_pvt```.
Directory can be overriden with environment variable ```WALLETS_ROOT_DIR=<your_directory_with_wallets>```.
Directory and files should be writable for the user running tests.
## Generating test wallets
* ```create_wallets.sh``` - this script will create wallets (wallet_01.bin, wallet_02.bin,...,wallet_06.bin) in current directory.
when running first time, please uncomment line ```#create_wallet wallet_m``` to create miner wallet as well.
This wallet should be used for mining and all test wallets supposed to be seed from this miner wallet
* ```mining_start.sh``` and ```mining_stop.sh``` - helper scripts to start and stop mining on miner waller
* ```send_funds.sh``` - script for seeding test wallets. Please run this script when you have ehough money on miner wallet

View file

@ -6,7 +6,6 @@ function create_wallet {
} }
create_wallet wallet_01.bin create_wallet wallet_01.bin
create_wallet wallet_02.bin create_wallet wallet_02.bin
create_wallet wallet_03.bin create_wallet wallet_03.bin
@ -14,7 +13,6 @@ create_wallet wallet_04.bin
create_wallet wallet_05.bin create_wallet wallet_05.bin
create_wallet wallet_06.bin create_wallet wallet_06.bin
# create_wallet wallet_m
#create_wallet wallet_m