Add tmux test harness.

This commit is contained in:
jholdstock 2020-06-03 11:04:22 +01:00 committed by David Hill
parent 381cf9e5a2
commit fb6ea54f15
2 changed files with 151 additions and 0 deletions

View File

@ -59,6 +59,23 @@ requests, and a number of remote servers which host voting wallets. For more
information about deploying vspd, check out
[deployment.md](./docs/deployment.md).
## Development
### Test Harness
A test harness is provided in `harness.sh`. The test harness uses tmux to start
a testnet instance of dcrd, multiple dcrwallets, and finally vspd. Further
documentation can be found in [harness.sh](./harness.sh).
### Web server debug mode
The config option `--webserverdebug` will:
- Force HTML templates to be reloaded on every web request.
- Reload the cached homepage data every second rather than every 5 minutes.
- Enable detailed webserver logging to the terminal (does not get written to log
file).
## Issue Tracker
The [integrated GitHub issue tracker](https://github.com/decred/vspd/issues)

134
harness.sh Executable file
View File

@ -0,0 +1,134 @@
#!/bin/bash
# To use this test harness simply run `./harness.sh` from the repo root.
#
# This harness makes a few assumptions about the system it is running on:
# - tmux is installed
# - dcrd, dcrwallet and vspd are available on $PATH
# - Decred testnet chain is already downloaded and sync'd
# - dcrd transaction index is already built
# - The following files exist:
# - ${HOME}/.dcrd/rpc.cert
# - ${HOME}/.dcrd/rpc.key
# - ${HOME}/.dcrwallet/rpc.cert
# - ${HOME}/.dcrwallet/rpc.key
set -e
TMUX_SESSION="harness"
HARNESS_ROOT=~/harness
RPC_USER="user"
RPC_PASS="pass"
NUMBER_OF_WALLETS=3
DCRD_RPC_CERT="${HOME}/.dcrd/rpc.cert"
DCRD_RPC_KEY="${HOME}/.dcrd/rpc.key"
WALLET_PASS="12345"
WALLET_RPC_CERT="${HOME}/.dcrwallet/rpc.cert"
WALLET_RPC_KEY="${HOME}/.dcrwallet/rpc.key"
VSPD_FEE_XPUB="tpubVppjaMjp8GEWzpMGHdXNhkjqof8baKGkUzneNEiocnnjnjY9hQPe6mxzZQyzyKYS3u5yxLp8KrJvibqDzc75RGqzkv2JMPYDXmCRR1a39jg"
if [ -d "${HARNESS_ROOT}" ]; then
rm -R "${HARNESS_ROOT}"
fi
tmux new-session -d -s $TMUX_SESSION
#################################################
# Setup dcrd.
#################################################
tmux rename-window -t $TMUX_SESSION 'dcrd'
echo "Writing config for dcrd"
mkdir -p "${HARNESS_ROOT}/dcrd"
cat > "${HARNESS_ROOT}/dcrd/dcrd.conf" <<EOF
rpcuser=${RPC_USER}
rpcpass=${RPC_PASS}
rpccert=${DCRD_RPC_CERT}
rpckey=${DCRD_RPC_KEY}
logdir=${HARNESS_ROOT}/dcrd/log
testnet=true
debuglevel=info
txindex=true
EOF
echo "Starting dcrd"
tmux send-keys "dcrd -C ${HARNESS_ROOT}/dcrd/dcrd.conf" C-m
sleep 1 # Give dcrd time to start
#################################################
# Setup multiple dcrwallets.
#################################################
for ((i = 1; i <= $NUMBER_OF_WALLETS; i++)); do
WALLET_RPC_LISTEN="127.0.0.1:2011${i}"
ALL_WALLETS="${ALL_WALLETS}"$'\n'wallethost="${WALLET_RPC_LISTEN}"
echo ""
echo "Writing config for dcrwallet-${i}"
mkdir -p "${HARNESS_ROOT}/dcrwallet-${i}"
cat > "${HARNESS_ROOT}/dcrwallet-${i}/dcrwallet.conf" <<EOF
username=${RPC_USER}
password=${RPC_PASS}
rpccert=${WALLET_RPC_CERT}
rpckey=${WALLET_RPC_KEY}
logdir=${HARNESS_ROOT}/dcrwallet-${i}/log
appdata=${HARNESS_ROOT}/dcrwallet-${i}
pass=${WALLET_PASS}
grpclisten=127.0.0.1:2010${i}
rpclisten=${WALLET_RPC_LISTEN}
enablevoting=true
testnet=true
debuglevel=info
EOF
echo "Starting dcrwallet-${i}"
tmux new-window -t $TMUX_SESSION -n "dcrwallet-${i}"
tmux send-keys "dcrwallet -C ${HARNESS_ROOT}/dcrwallet-${i}/dcrwallet.conf --create" C-m
sleep 1 # wait for dcrwallet process to start before sending input
tmux send-keys "${WALLET_PASS}" C-m "${WALLET_PASS}" C-m "n" C-m "n" C-m "ok" C-m
sleep 2 # wait for wallet to be created
tmux send-keys "dcrwallet -C ${HARNESS_ROOT}/dcrwallet-${i}/dcrwallet.conf " C-m
done
#################################################
# Setup vspd.
#################################################
echo ""
echo "Writing config for vspd"
mkdir -p "${HARNESS_ROOT}/vspd"
cat > "${HARNESS_ROOT}/vspd/vspd.conf" <<EOF
dcrduser = ${RPC_USER}
dcrdpass = ${RPC_PASS}
dcrdcert = ${DCRD_RPC_CERT}
${ALL_WALLETS}
walletuser = ${RPC_USER}
walletpass = ${RPC_PASS}
walletcert = ${WALLET_RPC_CERT}
loglevel = debug
network = testnet
webserverdebug = false
supportemail = example@test.com
backupinterval = 3m0s
vspclosed = false
EOF
tmux new-window -t $TMUX_SESSION -n "vspd"
echo "Creating vspd database"
tmux send-keys "vspd --configfile=${HARNESS_ROOT}/vspd/vspd.conf --homedir=${HARNESS_ROOT}/vspd --feexpub=${VSPD_FEE_XPUB}" C-m
sleep 3 # wait for database creation and ensure dcrwallet rpc listeners are started
echo "Starting vspd"
tmux send-keys "vspd --configfile=${HARNESS_ROOT}/vspd/vspd.conf --homedir=${HARNESS_ROOT}/vspd" C-m
#################################################
# All done - attach to tmux session.
#################################################
tmux attach-session -t $TMUX_SESSION