January 2014 - tor-commits - lists.torproject.org

[bridgedb/master] Refactor scripts/bridgedb to use the new options and runner.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 831a778b054cf6425de953bb86eeae3be69ceac1 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Oct 15 14:08:14 2013 +0000 Refactor scripts/bridgedb to use the new options and runner. --- scripts/bridgedb | 54 +++++++++++++++++++++++++++++++++--------------------- 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/scripts/bridgedb b/scripts/bridgedb index 8e8800b..0e20cd9 100644 --- a/scripts/bridgedb +++ b/scripts/bridgedb @@ -1,31 +1,43 @@ #!/usr/bin/env python +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2013, The Tor Project, Inc. +# (c) 2007-2013, all entities within the AUTHORS file +# :license: 3-clause BSD, see included LICENSE for information + +from __future__ import print_function import bridgedb +import os import sys -if len(sys.argv) == 1: - from bridgedb import Main - Main.run() -else: - if sys.argv[1] in ('test', 'coverage'): - import os - from twisted.scripts import trial +from bridgedb import runner +from bridgedb import opt - if sys.argv[1] == 'coverage': - run_python_coverage = True - # Hack to set the PYTHONPATH: - sys.path[:] = map(os.path.abspath, sys.path) - sys.path.insert(0, os.path.abspath(os.getcwd())) +options = opt.parseOptions() - if run_python_coverage: - from coverage import coverage - cov = coverage() - cov.start() +if options.subCommand is not None: + # Hack to set the PYTHONPATH: + sys.path[:] = map(os.path.abspath, sys.path) + sys.path.insert(0, os.path.abspath(os.getcwd())) + sys.path.insert(0, os.path.abspath(os.path.join(os.getcwd(), '../lib'))) - sys.argv = ['trial', 'bridgedb'] - trial.run() + if 'descriptors' in options.subOptions: + runner.generateDescriptors(options.subOptions['descriptors']) - if run_python_coverage: - cov.stop() - cov.html_report('.coverage-results') + if options.subCommand == 'test': + if options.subOptions['trial']: + runner.runTrial(options.subOptions) + if options.subOptions['unittests']: + runner.runTests(options.subOptions) + sys.exit() + +# If no suboption was given, just run bridgedb: +else: + from bridgedb import Main + Main.run(options)

1 0

[bridgedb/master] Add runner module and descriptor generator.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit e7073caff67fa54da90c0570d093b7671a1a7f56 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Oct 15 14:00:01 2013 +0000 Add runner module and descriptor generator. * ADD lib/bridgedb/runner.py for running trial/unittest tests. * ADD scripts/gen_bridge_descriptors. * Fix lib/bridgedb/opt.py by coercing a commandline parameter to a string; it's sometimes None or an int. --- lib/bridgedb/runner.py | 98 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/lib/bridgedb/runner.py b/lib/bridgedb/runner.py new file mode 100644 index 0000000..62387c8 --- /dev/null +++ b/lib/bridgedb/runner.py @@ -0,0 +1,98 @@ +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2013, The Tor Project, Inc. +# (c) 2007-2013, all entities within the AUTHORS file +# :license: 3-clause BSD, see included LICENSE for information + +"""Classes for running components and servers, as well as daemonisation. + +** Module Overview: ** + +""" + +from __future__ import print_function + +import sys + + +def generateDescriptors(howmany): + """Run a script which creates fake bridge descriptors for testing purposes. + + This will run scripts/gen_bridge_descriptors to create a bridge router + descriptors, bridge extrainfo descriptors, a consensus document, and a + networkstatus document. + + :param integer howmany: Number of fake bridges to generate descriptor for. + :rtype: integer + :returns: The process returncode from the gen_bridge_descriptors script. + """ + import subprocess + + try: + print("Generating %s bridge descriptors..." % str(howmany)) + proc = subprocess.Popen(['gen_bridge_descriptors', str(howmany)], + stdout=sys.stdout, stderr=sys.stderr) + except Exception as exc: + print(exc) + print("There was an error generating bridge descriptors.") + else: + proc.wait() + if proc.returncode: + print("There was an error generating bridge descriptors. (%s: %d)" + % ("Returncode", proc.returncode)) + else: + print("Sucessfully bridge generated descriptors.") + finally: + del subprocess + return + +def runTrial(options): + """Run Twisted trial based unittests, optionally with coverage. + + :type options: :class:`~bridgedb.opt.TestOptions` + :param options: Parsed options for controlling the twisted.trial test + run. All unrecognised arguments after the known options will be passed + along to trial. + """ + from twisted.scripts import trial + + # Insert 'trial' as the first system cmdline argument: + sys.argv = ['trial'] + + if options['coverage']: + try: + from coverage import coverage + except ImportError as ie: + print(ie.message) + else: + cov = coverage() + cov.start() + sys.argv.append('--coverage') + sys.argv.append('--reporter=bwverbose') + + # Pass all arguments along to its options parser: + if 'test_args' in options: + for arg in options['test_args']: + sys.argv.append(arg) + # Tell trial to test the bridgedb package: + sys.argv.append('bridgedb.test') + trial.run() + + if options['coverage']: + cov.stop() + cov.html_report('_trial_temp/coverage/') + +def runTests(options): + """Run unittest based tests. + + :type options: :class:`~bridgedb.opt.TestOptions` + :param options: Parsed options for controlling the twisted.trial test + run. All unrecognised arguments after the known options will be passed + along to trial. + """ + testModule = __import__('bridgedb.Tests', globals(), '', []) + testModule.Tests.main()

1 0

[bridgedb/master] Refactor bridgedb.Main.run() and bridgedb.Main._reloadFn().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit afa265eb06a97831200389b18225f410b0927e55 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Oct 18 22:35:29 2013 +0000 Refactor bridgedb.Main.run() and bridgedb.Main._reloadFn(). The main entry point and server reload function are refactored to recieve the parsed options from the commandline script, scripts/bridgedb. It is necessary to pass *args to `_reloadFn()` (as well as its original stubbed lambda function), because the arguments are technically unknown to the scope of the `reload()` function embedded in `bridgedb.Main.startup()` when it is evaluated at compile time (they are not known until later when `bridgedb.Main.run()` is called via scripts/bridgedb). --- lib/bridgedb/Main.py | 60 ++++++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py index fd9fbda..76f0832 100644 --- a/lib/bridgedb/Main.py +++ b/lib/bridgedb/Main.py @@ -16,14 +16,16 @@ import gettext from twisted.internet import reactor +from bridgedb import options + import bridgedb.Bridges as Bridges import bridgedb.Dist as Dist import bridgedb.Time as Time import bridgedb.Storage -import bridgedb.Opt as Opt import bridgedb.Bucket as Bucket import bridgedb.Util as Util + class Conf: """A configuration object. Holds unvalidated attributes. """ @@ -278,10 +280,11 @@ def loadProxyList(cfg): f.close() return ipset -_reloadFn = lambda: True +_reloadFn = lambda x: True def _handleSIGHUP(*args): """Called when we receive a SIGHUP; invokes _reloadFn.""" - reactor.callLater(0, _reloadFn) + reactor.callLater(0, _reloadFn, *args) + class ProxyCategory: def __init__(self): @@ -291,7 +294,8 @@ class ProxyCategory: def replaceProxyList(self, ipset): self.ipset = ipset -def startup(cfg): + +def startup(cfg, options): """Parse bridges, """ # Expand any ~ characters in paths in the configuration. @@ -388,14 +392,13 @@ def startup(cfg): splitter.addPseudoRing(p) # Make the parse-bridges function get re-called on SIGHUP. - def reload(): + def reload(*args): logging.info("Caught SIGHUP") - # re open config file - options, arguments = Opt.parseOpts() + # reparse the config file configuration = {} - if options.configfile: - execfile(options.configfile, configuration) + if options['config']: + execfile(options['config'], configuration) cfg = Conf(**configuration) # update loglevel on (re)load level = getattr(cfg, 'LOGLEVEL', 'WARNING') @@ -438,7 +441,7 @@ def startup(cfg): signal.signal(signal.SIGHUP, _handleSIGHUP) # And actually load it to start. - reload() + reload(options) # Configure HTTP and/or HTTPS servers. if cfg.HTTPS_DIST and cfg.HTTPS_SHARE: @@ -457,34 +460,33 @@ def startup(cfg): if cfg.PIDFILE: os.unlink(cfg.PIDFILE) -def run(): - """Parse the command line to determine where the configuration is. - Parse the configuration, and start the servers. +def run(options): + """This is the main entry point into BridgeDB. + + Given the parsed commandline options, this function handles locating the + configuration file, loading and parsing it, and then either + starting/reloading the servers or dumping bridge assignments to files. + + :type options: :class:`bridgedb.opt.MainOptions` + :param options: A pre-parsed options class. """ - options, arguments = Opt.parseOpts() configuration = {} - if options.testing: - configuration = CONFIG - elif not options.configfile: - print "Syntax: %s -c CONFIGFILE" % sys.argv[0] + if not options['config']: + options.getUsage() sys.exit(1) - else: - configFile = options.configfile - execfile(configFile, configuration) - C = Conf(**configuration) - configuration = C + + configFile = options['config'] + execfile(configFile, configuration) + C = Conf(**configuration) + configuration = C # Change to the directory where we're supposed to run. if configuration.RUN_IN_DIR: os.chdir(os.path.expanduser(configuration.RUN_IN_DIR)) - - if options.dumpbridges: + if options['dump-bridges']: bucketManager = Bucket.BucketManager(configuration) bucketManager.assignBridgesToBuckets() bucketManager.dumpBridges() else: - startup(configuration) - -if __name__ == '__main__': - run() + startup(configuration, options)

1 0

[bridgedb/master] Remove unnecessary requirements, make others explicitly versioned.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 27b438fdc240a5ee8ffc09f2d406a30b25cf1758 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Oct 26 07:11:33 2013 +0000 Remove unnecessary requirements, make others explicitly versioned. --- requirements.txt | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/requirements.txt b/requirements.txt index 5760060..e4cd59b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,15 +3,13 @@ BeautifulSoup==3.2.1 Mako==0.8.1 MarkupSafe==0.18 Twisted==13.1.0 -argparse>=1.2.1 coverage==3.6 -ipaddr>=2.1.10 -pyOpenSSL>=0.13 +ipaddr==2.1.10 +pyOpenSSL==0.13.1 pygeoip==0.2.7 pygpgme==0.3 -recaptcha>=1.0rc1 -recaptcha-client>=1.0.6 +recaptcha==1.0rc1 +recaptcha-client==1.0.6 sure==1.2.2 trialcoverage==0.3.12 -wsgiref>=0.1.2 zope.interface>=4.0.5

1 0

[bridgedb/master] Add script for killing the the server after N seconds; avoid running forever in CI.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 93ed9cc97060a6e70af0478984c2aa5d7b51c7b3 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Oct 15 14:22:49 2013 +0000 Add script for killing the the server after N seconds; avoid running forever in CI. --- scripts/executioner | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/scripts/executioner b/scripts/executioner new file mode 100755 index 0000000..085b74d --- /dev/null +++ b/scripts/executioner @@ -0,0 +1,35 @@ +#!/bin/bash +############################################################################## +# +# executioner +# ----------- +# Run $@ for $1 seconds and then kill the process. +# +# :authors: Isis Agora Lovecruft, 0x2cdb8b35 +# :date: 21 April 2013 +# :version: 0.0.1 +############################################################################## + +set -vx -- + +function killitwithfire () { + trap - ALRM + kill -ALRM $prog 2>/dev/null + kill -9 $! 2>/dev/null && exit 0 +} + +function waitforit () { + trap "killitwithfire" ALRM + sleep $1& wait + kill -ALRM $$ +} + +waitforit $1& prog=$! ; shift ; +trap "killitwithfire" ALRM INT +"$@"& wait $! +RET=$? +if [[ "$(ps -ef | awk -v pid=$prog '$2==pid{print}{}')" != "" ]]; then + kill -ALRM $prog + wait $prog +fi +exit $RET

1 0

[bridgedb/master] Add scripts/make-ssl-cert and start using it in .travis.yml.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 6b731cb49f2c0fa73b70bd071d62f54a4e098107 Author: Isis Lovecruft <isis(a)torproject.org> Date: Tue Oct 15 14:18:24 2013 +0000 Add scripts/make-ssl-cert and start using it in .travis.yml. * ADD script for generating a self-signed SSL certificate for testing. * CHANGE dependency installs in .travis.yml to ignore suggestions and recommendations. --- .travis.yml | 16 ++++---------- scripts/make-ssl-cert | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 276c5d9..2149a23 100644 --- a/.travis.yml +++ b/.travis.yml @@ -23,19 +23,11 @@ install: script: - python setup.py test - test -d run || mkdir run - - openssl genrsa -des3 -passout pass:bridgedb -out privkey 4096 - - openssl req -batch -passin pass:bridgedb -new -key privkey -out server.csr - - cp privkey privkey.nopasswd - - openssl rsa -passin pass:bridgedb -in privkey.nopasswd -out privkey.pem - - openssl x509 -req -days 365 -in server.csr -signkey privkey.pem -out cert - - test -f "privkey.nopasswd" && rm -f privkey.nopasswd - - test -f "server.csr" && rm -f server.csr - - test -f "privkey" && rm -f privkey - - mv privkey.pem ./run/ - - mv cert ./run/ - - cp ./bridgedb.conf ./run/ - - chmod +x .travis.test.sh + - cp bridgedb.conf run/ + - chmod u+x scripts/make-ssl-cert + - chmod u+x scripts/executioner - cd run + - gen_bridge_descriptors 2000 - ../scripts/make-ssl-cert - ../scripts/executioner 60 bridgedb -c bridgedb.conf # add this when #9199's (or some other trial-based) tests are merged: diff --git a/scripts/make-ssl-cert b/scripts/make-ssl-cert new file mode 100755 index 0000000..6f4772c --- /dev/null +++ b/scripts/make-ssl-cert @@ -0,0 +1,56 @@ +#!/bin/bash +# -*- coding: utf-8 -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: Isis Lovecruft 0xA3ADB67A2CDB8B35 <isis(a)torproject.org> +# please also see AUTHORS file +# :copyright: (c) 2007-2013, The Tor Project, Inc. +# (c) 2007-2013, all entities within the AUTHORS file +# :license: 3-clause BSD, see included LICENSE for information + +#----------------------------------------------------------------------------- +# Don't touch anything below here unless you're fixing a bug. +#_____________________________________________________________________________ + +# Check for dependencies: +which openssl 2>&1 >/dev/null || \ + { printf "You must have openssl installed.\nExiting.\n"; exit 1 ;} + +# Find out where we are so that we can get to the run/ directory for testing: +THIS_FILE="${BASH_SOURCE[0]}" +NAME=$(basename $0) + +while [ -h "$THIS_FILE" ]; do + # resolve $THIS_FILE until the file is no longer a symlink: + THIS_PATH="$( cd -P "$( dirname "$THIS_FILE" )" && pwd )" + THIS_FILE="$(readlink "$THIS_FILE")" + # if $THIS_FILE was a relative symlink, we need to resolve it relative to + # the path where the symlink file was located: + [[ $THIS_FILE != /* ]] && THIS_FILE="$THIS_PATH/$THIS_FILE" +done + +THIS_PATH="$( cd -P "$( dirname "$THIS_FILE" )" && pwd )" +REPO_PATH=${THIS_PATH%%/maint} + +function usage () { + printf "Usage: %s\n\n" $NAME + printf "This script will create an SSL key and certificate ('privkey.pem' and 'cert'\n" + printf "respectively). The key has had it's password removed, and thus is suitable\n" + printf "for automation and CI tests." + printf "\n" +} +if test "$#" -gt "1" ; then usage ; fi + +# Go to the toplevel directory of the BridgeDB repo: +cd $REPO_PATH +#printf "%s: Current working directory:\n\t%s\n" $NAME $PWD + +openssl genrsa -des3 -passout pass:bridgedb -out privkey 4096 +openssl req -batch -passin pass:bridgedb -new -key privkey -out server.csr +cp privkey privkey.nopasswd +openssl rsa -passin pass:bridgedb -in privkey.nopasswd -out privkey.pem +openssl x509 -req -days 365 -in server.csr -signkey privkey.pem -out cert +test -f "privkey.nopasswd" && rm -f privkey.nopasswd +test -f "privkey" && rm -f privkey +test -f "server.csr" && rm -f server.csr

1 0

[bridgedb/master] Switch Travis-CI IRC notification to notices.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 8ff727bf5fa37e7deeb7c16a735abea762106fc8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Oct 26 07:15:21 2013 +0000 Switch Travis-CI IRC notification to notices. --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 2149a23..daec6d6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -5,6 +5,7 @@ notifications: - "irc.oftc.net#tor-bots" on_success: always on_failure: always + use_notice: true email: recipients: - isis(a)torproject.org

1 0

[bridgedb/master] Pass the entire set of main options to the runner.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit e7601924c5174e900aae59ca2e9ce24ba907fa73 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Oct 26 07:28:16 2013 +0000 Pass the entire set of main options to the runner. --- lib/bridgedb/runner.py | 7 ++++--- scripts/bridgedb | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/runner.py b/lib/bridgedb/runner.py index 62387c8..7f38e95 100644 --- a/lib/bridgedb/runner.py +++ b/lib/bridgedb/runner.py @@ -19,7 +19,7 @@ from __future__ import print_function import sys -def generateDescriptors(howmany): +def generateDescriptors(options): """Run a script which creates fake bridge descriptors for testing purposes. This will run scripts/gen_bridge_descriptors to create a bridge router @@ -32,10 +32,11 @@ def generateDescriptors(howmany): """ import subprocess + script = 'gen_bridge_descriptors' + count = options.subOptions['descriptors'] try: print("Generating %s bridge descriptors..." % str(howmany)) - proc = subprocess.Popen(['gen_bridge_descriptors', str(howmany)], - stdout=sys.stdout, stderr=sys.stderr) + proc = subprocess.Popen([script, str(count)]) except Exception as exc: print(exc) print("There was an error generating bridge descriptors.") diff --git a/scripts/bridgedb b/scripts/bridgedb index 0e20cd9..20c44b8 100644 --- a/scripts/bridgedb +++ b/scripts/bridgedb @@ -28,7 +28,7 @@ if options.subCommand is not None: sys.path.insert(0, os.path.abspath(os.path.join(os.getcwd(), '../lib'))) if 'descriptors' in options.subOptions: - runner.generateDescriptors(options.subOptions['descriptors']) + runner.generateDescriptors(options) if options.subCommand == 'test': if options.subOptions['trial']:

1 0

[bridgedb/master] Add commands for CouchDB testing to .travis.yml (innactive for now).
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 3d0b714fc440b8b2e121dc18ae4aca7e97874ca4 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Oct 26 07:16:06 2013 +0000 Add commands for CouchDB testing to .travis.yml (innactive for now). --- .travis.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.travis.yml b/.travis.yml index daec6d6..e9e6f31 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ language: python + notifications: irc: channels: @@ -11,15 +12,26 @@ notifications: - isis(a)torproject.org on_success: change on_failure: change + before_install: - sudo apt-get update - sudo apt-get install --no-install-suggests --no-install-recommends tor-geoipdb build-essential python-dev python-setuptools openssl sqlite3 libgpgme11-dev + python: - "2.6" - "2.7" + +#services: +# - couchdb + install: - pip install -r requirements.txt --use-mirrors - make install + +#before_script: +# # For testing with CouchDB +# - curl -X PUT localhost:5984/myapp_test + # command to run tests, e.g. python setup.py test script: - python setup.py test

1 0

[bridgedb/master] Add RUN_IN_DIR as a commandline option and cleanup the option explanations.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 50316521c08e216a760ba8bd89334f50b15e61e7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sat Oct 26 08:39:44 2013 +0000 Add RUN_IN_DIR as a commandline option and cleanup the option explanations. --- lib/bridgedb/Main.py | 18 +++++++++--------- lib/bridgedb/opt.py | 38 ++++++++++++++++++++++++++------------ 2 files changed, 35 insertions(+), 21 deletions(-) diff --git a/lib/bridgedb/Main.py b/lib/bridgedb/Main.py index 76f0832..e12c268 100644 --- a/lib/bridgedb/Main.py +++ b/lib/bridgedb/Main.py @@ -459,6 +459,7 @@ def startup(cfg, options): db.close() if cfg.PIDFILE: os.unlink(cfg.PIDFILE) + sys.exit() def run(options): """This is the main entry point into BridgeDB. @@ -476,17 +477,16 @@ def run(options): options.getUsage() sys.exit(1) - configFile = options['config'] - execfile(configFile, configuration) - C = Conf(**configuration) - configuration = C - # Change to the directory where we're supposed to run. - if configuration.RUN_IN_DIR: - os.chdir(os.path.expanduser(configuration.RUN_IN_DIR)) + if options['rundir']: + os.chdir(options['rundir']) + + execfile(options['config'], configuration) + config = Conf(**configuration) + if options['dump-bridges']: - bucketManager = Bucket.BucketManager(configuration) + bucketManager = Bucket.BucketManager(config) bucketManager.assignBridgesToBuckets() bucketManager.dumpBridges() else: - startup(configuration, options) + startup(config, options) diff --git a/lib/bridgedb/opt.py b/lib/bridgedb/opt.py index 8018544..bedfaec 100644 --- a/lib/bridgedb/opt.py +++ b/lib/bridgedb/opt.py @@ -15,15 +15,14 @@ """ from __future__ import print_function +from __future__ import unicode_literals import sys import textwrap +import os from twisted.python import usage -# from ._version import get_versions -# __version__ = get_versions()['version'] -# del get_versions from bridgedb import __version__ @@ -51,19 +50,34 @@ class BaseOptions(usage.Options): """Base options included in all main and sub options menus.""" longdesc = textwrap.dedent("""BridgeDB is a proxy distribution system for - private relays acting as bridges into the Tor network.""") + private relays acting as bridges into the Tor network. See `bridgedb + <command> --help` for addition help.""") optFlags = [['verbose', 'v', 'Log to stdout']] + def opt_rundir(self, rundir): + """Change to this directory""" + if not rundir: + rundir = os.path.join(os.getcwdu(), 'run') + else: + try: + rundir = os.path.abspath(os.path.expanduser(rundir)) + except Exception as error: + raise usage.UsageError(error.message) + if rundir and os.path.isdir(rundir): + self['rundir'] = rundir + opt_r = opt_rundir + def __init__(self): """Create an options parser. All flags, parameters, and attributes of this base options parser are inherited by all child classes. """ usage.Options.__init__(self) + self['rundir'] = os.path.join(os.getcwdu(), 'run') self['version'] = self.opt_version def opt_version(self): - """Display BridgeDB version and exit.""" + """Display BridgeDB's version and exit.""" print("%s-%s" % (__package__, __version__)) sys.exit() @@ -71,6 +85,9 @@ class BaseOptions(usage.Options): class TestOptions(BaseOptions): """Suboptions for running twisted.trial and unittest based tests.""" + longdesc = textwrap.dedent("""BridgeDB testing commands. + See the `bridgedb mock` command for generating testing environments.""") + optFlags = [['coverage', 'c', 'Generate coverage statistics']] optParameters = [ ['descriptors', 'n', 1000, 'Generate <N> fake bridge descriptors'], @@ -96,12 +113,9 @@ class MainOptions(BaseOptions): """Main commandline options parser for BridgeDB.""" optFlags = [ - ['reload', 'r', - 'Reload bridge descriptors by sending a SIGHUP to BridgeDB'], - ['dump-bridges', 'd', 'Dump bridges by hashring assignment into files']] + ['dump-bridges', 'd', 'Dump bridges by hashring assignment into files'], + ['reload', 'R', 'Reload bridge descriptors into running servers']] optParameters = [ - ['config', 'c', './bridgedb.conf', 'Configuration file']] - + ['config', 'c', 'bridgedb.conf', 'Configuration file']] subCommands = [ - ['test', None, TestOptions, - "Run twisted.trial tests or unittests (see `bridgedb test --help`)"]] + ['test', None, TestOptions, "Run twisted.trial tests or unittests"]]

1 0