331 lines
11 KiB
Python
331 lines
11 KiB
Python
"""Implementation of the `bigchaindb` command,
|
|
which is one of the commands in the BigchainDB
|
|
command-line interface.
|
|
"""
|
|
|
|
import os
|
|
import sys
|
|
import logging
|
|
import argparse
|
|
import copy
|
|
import json
|
|
import builtins
|
|
|
|
import logstats
|
|
|
|
from bigchaindb.common import crypto
|
|
from bigchaindb.common.exceptions import (StartupError,
|
|
DatabaseAlreadyExists,
|
|
KeypairNotFoundException)
|
|
import rethinkdb as r
|
|
|
|
import bigchaindb
|
|
import bigchaindb.config_utils
|
|
from bigchaindb.models import Transaction
|
|
from bigchaindb.util import ProcessGroup
|
|
from bigchaindb import db
|
|
from bigchaindb.commands import utils
|
|
from bigchaindb import processes
|
|
|
|
|
|
logging.basicConfig(level=logging.INFO)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
# We need this because `input` always prints on stdout, while it should print
|
|
# to stderr. It's a very old bug, check it out here:
|
|
# - https://bugs.python.org/issue1927
|
|
def input(prompt):
|
|
print(prompt, end='', file=sys.stderr)
|
|
return builtins.input()
|
|
|
|
|
|
def run_show_config(args):
|
|
"""Show the current configuration"""
|
|
# TODO Proposal: remove the "hidden" configuration. Only show config. If
|
|
# the system needs to be configured, then display information on how to
|
|
# configure the system.
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
config = copy.deepcopy(bigchaindb.config)
|
|
del config['CONFIGURED']
|
|
private_key = config['keypair']['private']
|
|
config['keypair']['private'] = 'x' * 45 if private_key else None
|
|
print(json.dumps(config, indent=4, sort_keys=True))
|
|
|
|
|
|
def run_configure(args, skip_if_exists=False):
|
|
"""Run a script to configure the current node.
|
|
|
|
Args:
|
|
skip_if_exists (bool): skip the function if a config file already exists
|
|
"""
|
|
config_path = args.config or bigchaindb.config_utils.CONFIG_DEFAULT_PATH
|
|
|
|
config_file_exists = False
|
|
# if the config path is `-` then it's stdout
|
|
if config_path != '-':
|
|
config_file_exists = os.path.exists(config_path)
|
|
|
|
if config_file_exists and skip_if_exists:
|
|
return
|
|
|
|
if config_file_exists and not args.yes:
|
|
want = input('Config file `{}` exists, do you want to override it? '
|
|
'(cannot be undone) [y/N]: '.format(config_path))
|
|
if want != 'y':
|
|
return
|
|
|
|
conf = copy.deepcopy(bigchaindb.config)
|
|
|
|
# Patch the default configuration with the new values
|
|
conf = bigchaindb.config_utils.update(
|
|
conf,
|
|
bigchaindb.config_utils.env_config(bigchaindb.config))
|
|
|
|
print('Generating keypair', file=sys.stderr)
|
|
conf['keypair']['private'], conf['keypair']['public'] = \
|
|
crypto.generate_key_pair()
|
|
|
|
if not args.yes:
|
|
for key in ('bind', ):
|
|
val = conf['server'][key]
|
|
conf['server'][key] = \
|
|
input('API Server {}? (default `{}`): '.format(key, val)) \
|
|
or val
|
|
|
|
for key in ('host', 'port', 'name'):
|
|
val = conf['database'][key]
|
|
conf['database'][key] = \
|
|
input('Database {}? (default `{}`): '.format(key, val)) \
|
|
or val
|
|
|
|
for key in ('host', 'port', 'rate'):
|
|
val = conf['statsd'][key]
|
|
conf['statsd'][key] = \
|
|
input('Statsd {}? (default `{}`): '.format(key, val)) \
|
|
or val
|
|
|
|
val = conf['backlog_reassign_delay']
|
|
conf['backlog_reassign_delay'] = \
|
|
input('Stale transaction reassignment delay (in seconds)? (default `{}`): '.format(val)) \
|
|
or val
|
|
|
|
if config_path != '-':
|
|
bigchaindb.config_utils.write_config(conf, config_path)
|
|
else:
|
|
print(json.dumps(conf, indent=4, sort_keys=True))
|
|
print('Configuration written to {}'.format(config_path), file=sys.stderr)
|
|
print('Ready to go!', file=sys.stderr)
|
|
|
|
|
|
def run_export_my_pubkey(args):
|
|
"""Export this node's public key to standard output
|
|
"""
|
|
logger.debug('bigchaindb args = {}'.format(args))
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
pubkey = bigchaindb.config['keypair']['public']
|
|
if pubkey is not None:
|
|
print(pubkey)
|
|
else:
|
|
sys.exit("This node's public key wasn't set anywhere "
|
|
"so it can't be exported")
|
|
# raises SystemExit exception
|
|
# message is sent to stderr
|
|
# exits with exit code 1 (signals tha an error happened)
|
|
|
|
|
|
def run_init(args):
|
|
"""Initialize the database"""
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
# TODO Provide mechanism to:
|
|
# 1. prompt the user to inquire whether they wish to drop the db
|
|
# 2. force the init, (e.g., via -f flag)
|
|
try:
|
|
db.init()
|
|
except DatabaseAlreadyExists:
|
|
print('The database already exists.', file=sys.stderr)
|
|
print('If you wish to re-initialize it, first drop it.', file=sys.stderr)
|
|
|
|
|
|
def run_drop(args):
|
|
"""Drop the database"""
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
db.drop(assume_yes=args.yes)
|
|
|
|
|
|
def run_start(args):
|
|
"""Start the processes to run the node"""
|
|
logger.info('BigchainDB Version {}'.format(bigchaindb.__version__))
|
|
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
|
|
if args.allow_temp_keypair:
|
|
if not (bigchaindb.config['keypair']['private'] or
|
|
bigchaindb.config['keypair']['public']):
|
|
|
|
private_key, public_key = crypto.generate_key_pair()
|
|
bigchaindb.config['keypair']['private'] = private_key
|
|
bigchaindb.config['keypair']['public'] = public_key
|
|
else:
|
|
logger.warning('Keypair found, no need to create one on the fly.')
|
|
|
|
if args.start_rethinkdb:
|
|
try:
|
|
proc = utils.start_rethinkdb()
|
|
except StartupError as e:
|
|
sys.exit('Error starting RethinkDB, reason is: {}'.format(e))
|
|
logger.info('RethinkDB started with PID %s' % proc.pid)
|
|
|
|
try:
|
|
db.init()
|
|
except DatabaseAlreadyExists:
|
|
pass
|
|
except KeypairNotFoundException:
|
|
sys.exit("Can't start BigchainDB, no keypair found. "
|
|
'Did you run `bigchaindb configure`?')
|
|
|
|
logger.info('Starting BigchainDB main process with public key %s',
|
|
bigchaindb.config['keypair']['public'])
|
|
processes.start()
|
|
|
|
|
|
def _run_load(tx_left, stats):
|
|
logstats.thread.start(stats)
|
|
b = bigchaindb.Bigchain()
|
|
|
|
while True:
|
|
tx = Transaction.create([b.me], [b.me])
|
|
tx = tx.sign([b.me_private])
|
|
b.write_transaction(tx)
|
|
|
|
stats['transactions'] += 1
|
|
|
|
if tx_left is not None:
|
|
tx_left -= 1
|
|
if tx_left == 0:
|
|
break
|
|
|
|
|
|
def run_load(args):
|
|
bigchaindb.config_utils.autoconfigure(filename=args.config, force=True)
|
|
logger.info('Starting %s processes', args.multiprocess)
|
|
stats = logstats.Logstats()
|
|
logstats.thread.start(stats)
|
|
|
|
tx_left = None
|
|
if args.count > 0:
|
|
tx_left = int(args.count / args.multiprocess)
|
|
|
|
workers = ProcessGroup(concurrency=args.multiprocess,
|
|
target=_run_load,
|
|
args=(tx_left, stats.get_child()))
|
|
workers.start()
|
|
|
|
|
|
def run_set_shards(args):
|
|
for table in ['bigchain', 'backlog', 'votes']:
|
|
# See https://www.rethinkdb.com/api/python/config/
|
|
table_config = r.table(table).config().run(db.get_conn())
|
|
num_replicas = len(table_config['shards'][0]['replicas'])
|
|
try:
|
|
r.table(table).reconfigure(shards=args.num_shards, replicas=num_replicas).run(db.get_conn())
|
|
except r.ReqlOpFailedError as e:
|
|
logger.warn(e)
|
|
|
|
|
|
def run_set_replicas(args):
|
|
for table in ['bigchain', 'backlog', 'votes']:
|
|
# See https://www.rethinkdb.com/api/python/config/
|
|
table_config = r.table(table).config().run(db.get_conn())
|
|
num_shards = len(table_config['shards'])
|
|
try:
|
|
r.table(table).reconfigure(shards=num_shards, replicas=args.num_replicas).run(db.get_conn())
|
|
except r.ReqlOpFailedError as e:
|
|
logger.warn(e)
|
|
|
|
|
|
def create_parser():
|
|
parser = argparse.ArgumentParser(
|
|
description='Control your BigchainDB node.',
|
|
parents=[utils.base_parser])
|
|
|
|
parser.add_argument('--dev-start-rethinkdb',
|
|
dest='start_rethinkdb',
|
|
action='store_true',
|
|
help='Run RethinkDB on start')
|
|
|
|
parser.add_argument('--dev-allow-temp-keypair',
|
|
dest='allow_temp_keypair',
|
|
action='store_true',
|
|
help='Generate a random keypair on start')
|
|
|
|
# all the commands are contained in the subparsers object,
|
|
# the command selected by the user will be stored in `args.command`
|
|
# that is used by the `main` function to select which other
|
|
# function to call.
|
|
subparsers = parser.add_subparsers(title='Commands',
|
|
dest='command')
|
|
|
|
# parser for writing a config file
|
|
subparsers.add_parser('configure',
|
|
help='Prepare the config file '
|
|
'and create the node keypair')
|
|
|
|
# parsers for showing/exporting config values
|
|
subparsers.add_parser('show-config',
|
|
help='Show the current configuration')
|
|
|
|
subparsers.add_parser('export-my-pubkey',
|
|
help="Export this node's public key")
|
|
|
|
# parser for database-level commands
|
|
subparsers.add_parser('init',
|
|
help='Init the database')
|
|
|
|
subparsers.add_parser('drop',
|
|
help='Drop the database')
|
|
|
|
# parser for starting BigchainDB
|
|
subparsers.add_parser('start',
|
|
help='Start BigchainDB')
|
|
|
|
# parser for configuring the number of shards
|
|
sharding_parser = subparsers.add_parser('set-shards',
|
|
help='Configure number of shards')
|
|
|
|
sharding_parser.add_argument('num_shards', metavar='num_shards',
|
|
type=int, default=1,
|
|
help='Number of shards')
|
|
|
|
# parser for configuring the number of replicas
|
|
replicas_parser = subparsers.add_parser('set-replicas',
|
|
help='Configure number of replicas')
|
|
|
|
replicas_parser.add_argument('num_replicas', metavar='num_replicas',
|
|
type=int, default=1,
|
|
help='Number of replicas (i.e. the replication factor)')
|
|
|
|
load_parser = subparsers.add_parser('load',
|
|
help='Write transactions to the backlog')
|
|
|
|
load_parser.add_argument('-m', '--multiprocess',
|
|
nargs='?',
|
|
type=int,
|
|
default=False,
|
|
help='Spawn multiple processes to run the command, '
|
|
'if no value is provided, the number of processes '
|
|
'is equal to the number of cores of the host machine')
|
|
|
|
load_parser.add_argument('-c', '--count',
|
|
default=0,
|
|
type=int,
|
|
help='Number of transactions to push. If the parameter -m '
|
|
'is set, the count is distributed equally to all the '
|
|
'processes')
|
|
|
|
return parser
|
|
|
|
|
|
def main():
|
|
utils.start(create_parser(), sys.argv[1:], globals())
|