September 2013 - tor-commits - lists.torproject.org

[arm/master] Alternate function for parsing arguments
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 435de196896e5b170777edfc1b2331e733997172 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 14:06:50 2013 -0700 Alternate function for parsing arguments Adding a _get_args() function for parsing commandline arguments and providing back a named tuple. This is similar to what I'm doing for stem's run_tests.py argument parsing, and allows for much cleaner code than the present config mess. This also includes unit tests for the new function. My plan is to add tests as I incrementally rewrite arm, but being a curses app I'm not sure if we'll be able to achieve too much coverage. Still, any bit helps. The _get_args() function is not yet used. It's gonna take a bit of work to untangle the present config starter parameters. --- arm/starter.py | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++---- run_tests.py | 14 ++++++++++ test/starter.py | 66 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 157 insertions(+), 5 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 0131e97..7fe8d92 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -6,10 +6,14 @@ information. This is the starter for the application, handling and validating command line parameters. """ +import collections +import getopt + +import stem.util.connection + import os import sys import time -import getopt import getpass import locale import logging @@ -46,13 +50,9 @@ CONFIG = stem.util.conf.config_dict("arm", { "features.config.descriptions.persist": True, }) -OPT = "gi:s:c:dbe:vh" -OPT_EXPANDED = ["interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] - HELP_MSG = """Usage arm [OPTION] Terminal status monitor for Tor relays. - -p, --prompt only start the control interpretor -i, --interface [ADDRESS:]PORT change control interface from %s:%i -s, --socket SOCKET_PATH attach using unix domain socket if present, SOCKET_PATH defaults to: %s @@ -99,6 +99,78 @@ ARM_ROOT_NOTICE = "Arm is currently running with root permissions. This is not a os.putenv("LANG", "C") +# Our default arguments. The _get_args() function provides a named tuple of +# this merged with our argv. + +ARGS = { + 'control_address': '127.0.0.1', + 'control_port': 9051, + 'control_socket': '/var/run/tor/control', + 'config': None, + 'debug': False, + 'blind': False, + 'logged_events': 'N3', + 'print_version': False, + 'print_help': False, +} + +OPT = "gi:s:c:dbe:vh" +OPT_EXPANDED = ["interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"] + + +def _get_args(argv): + """ + Parses our arguments, providing a named tuple with their values. + + :param list argv: input arguments to be parsed + + :returns: a **named tuple** with our parsed arguments + + :raises: **ValueError** if we got an invalid argument + :raises: **getopt.GetoptError** if the arguments don't conform with what we + accept + """ + + args = dict(ARGS) + + for opt, arg in getopt.getopt(argv, OPT, OPT_EXPANDED)[0]: + if opt in ("-i", "--interface"): + if ':' in arg: + address, port = arg.split(':', 1) + else: + address, port = None, arg + + if address is not None: + if not stem.util.connection.is_valid_ipv4_address(address): + raise ValueError("'%s' isn't a valid IPv4 address" % address) + + args['control_address'] = address + + if not stem.util.connection.is_valid_port(port): + raise ValueError("'%s' isn't a valid port number" % port) + + args['control_port'] = int(port) + elif opt in ("-s", "--socket"): + args['control_socket'] = arg + elif opt in ("-c", "--config"): + args['config'] = arg + elif opt in ("-d", "--debug"): + args['debug'] = True + elif opt in ("-b", "--blind"): + args['blind'] = True + elif opt in ("-e", "--event"): + args['logged_events'] = arg + elif opt in ("-v", "--version"): + args['print_version'] = True + elif opt in ("-h", "--help"): + args['print_help'] = True + + # translates our args dict into a named tuple + + Args = collections.namedtuple('Args', args.keys()) + return Args(**args) + + def allowConnectionTypes(): """ This provides a tuple with booleans indicating if we should or shouldn't diff --git a/run_tests.py b/run_tests.py new file mode 100755 index 0000000..2fb88de --- /dev/null +++ b/run_tests.py @@ -0,0 +1,14 @@ +#!/usr/bin/env python +# Copyright 2013, Damian Johnson and The Tor Project +# See LICENSE for licensing information + +""" +Runs arm's unit tests. This is a curses application so we're pretty limited on +the test coverage we can achieve, but exercising what we can. +""" + +import unittest + +tests = unittest.defaultTestLoader.discover('test', pattern='*.py') +test_runner = unittest.TextTestRunner() +test_runner.run(tests) diff --git a/test/starter.py b/test/starter.py new file mode 100644 index 0000000..d4720b1 --- /dev/null +++ b/test/starter.py @@ -0,0 +1,66 @@ +""" +Unit tests for arm's initialization module. +""" + +import unittest + +from arm.starter import _get_args, ARGS + +class TestArgumentParsing(unittest.TestCase): + def test_that_we_get_default_values(self): + args = _get_args([]) + + for attr in ARGS: + self.assertEqual(ARGS[attr], getattr(args, attr)) + + def test_that_we_load_arguments(self): + args = _get_args(['--interface', '10.0.0.25:80']) + self.assertEqual('10.0.0.25', args.control_address) + self.assertEqual(80, args.control_port) + + args = _get_args(['--interface', '80']) + self.assertEqual(ARGS['control_address'], args.control_address) + self.assertEqual(80, args.control_port) + + args = _get_args(['--socket', '/tmp/my_socket', '--config', '/tmp/my_config']) + self.assertEqual('/tmp/my_socket', args.control_socket) + self.assertEqual('/tmp/my_config', args.config) + + args = _get_args(['--debug', '--blind']) + self.assertEqual(True, args.debug) + self.assertEqual(True, args.blind) + + args = _get_args(['--event', 'D1']) + self.assertEqual('D1', args.logged_events) + + args = _get_args(['--version']) + self.assertEqual(True, args.print_version) + + args = _get_args(['--help']) + self.assertEqual(True, args.print_help) + + def test_examples(self): + args = _get_args(['-b', '-i', '1643']) + self.assertEqual(True, args.blind) + self.assertEqual(1643, args.control_port) + + args = _get_args(['-e', 'we', '-c', '/tmp/cfg']) + self.assertEqual('we', args.logged_events) + self.assertEqual('/tmp/cfg', args.config) + + def test_that_we_reject_invalid_interfaces(self): + invalid_inputs = ( + '', + ' ', + 'blarg', + '127.0.0.1', + '127.0.0.1:', + ':80', + '400.0.0.1:80', + '127.0.0.1:-5', + '127.0.0.1:500000', + ) + + for invalid_input in invalid_inputs: + self.assertRaises(ValueError, _get_args, ['--interface', invalid_input]) +

1 0

[arm/master] Don't crash when 'man tor' is unavailable
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 3864b64edf3406d1221ff308cc80fbd7330b9b14 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 14:27:52 2013 -0700 Don't crash when 'man tor' is unavailable Oops, forgot to suppress exceptions here... Traceback (most recent call last): File "runner.py", line 3, in <module> arm.starter.main() File "/home/atagar/Desktop/arm/arm/starter.py", line 505, in main _loadConfigurationDescriptions(pathPrefix) File "/home/atagar/Desktop/arm/arm/starter.py", line 211, in _loadConfigurationDescriptions arm.util.torConfig.loadOptionDescriptions() File "/home/atagar/Desktop/arm/arm/util/torConfig.py", line 179, in loadOptionDescriptions manCallResults = system.call("man tor") File "/usr/lib/python2.7/stem/util/system.py", line 860, in call raise exc OSError: man tor returned exit status 16 --- arm/util/torConfig.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/arm/util/torConfig.py b/arm/util/torConfig.py index b9992ae..b7289ad 100644 --- a/arm/util/torConfig.py +++ b/arm/util/torConfig.py @@ -176,7 +176,7 @@ def loadOptionDescriptions(loadPath = None, checkVersion = True): CONFIG_DESCRIPTIONS.clear() raise IOError("input file format is invalid") else: - manCallResults = system.call("man tor") + manCallResults = system.call("man tor", None) if not manCallResults: raise IOError("man page not found")

1 0

[arm/master] Testing that we reject unrecognized arguments
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit bf8a33f8470d328d7728483bd3107ba0cf4466b0 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 14:21:44 2013 -0700 Testing that we reject unrecognized arguments Oops, test case I forgot to add. --- test/starter.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/test/starter.py b/test/starter.py index d4720b1..a4e6fdf 100644 --- a/test/starter.py +++ b/test/starter.py @@ -2,6 +2,7 @@ Unit tests for arm's initialization module. """ +import getopt import unittest from arm.starter import _get_args, ARGS @@ -48,6 +49,9 @@ class TestArgumentParsing(unittest.TestCase): self.assertEqual('we', args.logged_events) self.assertEqual('/tmp/cfg', args.config) + def test_that_we_reject_unrecognized_arguments(self): + self.assertRaises(getopt.GetoptError, _get_args, ['--blarg', 'stuff']) + def test_that_we_reject_invalid_interfaces(self): invalid_inputs = ( '',

1 0

[arm/master] Moving --help output to settings.cfg
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit c1f1602c9f9c8b426d078751cf2e9d2af0f471d5 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 14:42:58 2013 -0700 Moving --help output to settings.cfg Big blocks of text like our --help output belong in our configuration. While moving it there I realized that we actually weren't loading our settings.cfg *at all*. Nice. :P --- arm/settings.cfg | 20 ++++++++++++++++++++ arm/starter.py | 48 +++++++++++++++--------------------------------- 2 files changed, 35 insertions(+), 33 deletions(-) diff --git a/arm/settings.cfg b/arm/settings.cfg index 8cd92c1..c73a16f 100644 --- a/arm/settings.cfg +++ b/arm/settings.cfg @@ -1,3 +1,23 @@ +msg.help +|Usage arm [OPTION] +|Terminal status monitor for Tor relays. +| +| -i, --interface [ADDRESS:]PORT change control interface from %s:%i +| -s, --socket SOCKET_PATH attach using unix domain socket if present, +| SOCKET_PATH defaults to: %s +| -c, --config CONFIG_PATH loaded configuration options, CONFIG_PATH +| defaults to: %s +| -d, --debug writes all arm logs to %s +| -b, --blind disable connection lookups +| -e, --event EVENT_FLAGS event types in message log (default: %s) +|%s +| -v, --version provides version information +| -h, --help presents this help +| +|Example: +|arm -b -i 1643 hide connection data, attaching to control port 1643 +|arm -e we -c /tmp/cfg use this configuration file with 'WARN'/'ERR' events + # Important tor configuration options (shown by default) config.important BandwidthRate config.important BandwidthBurst diff --git a/arm/starter.py b/arm/starter.py index 37c048d..09fa088 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -48,28 +48,9 @@ CONFIG = stem.util.conf.config_dict("arm", { "startup.dataDirectory": "~/.arm", "features.config.descriptions.enabled": True, "features.config.descriptions.persist": True, + "msg.help": "", }) -HELP_MSG = """Usage arm [OPTION] -Terminal status monitor for Tor relays. - - -i, --interface [ADDRESS:]PORT change control interface from %s:%i - -s, --socket SOCKET_PATH attach using unix domain socket if present, - SOCKET_PATH defaults to: %s - -c, --config CONFIG_PATH loaded configuration options, CONFIG_PATH - defaults to: %s - -d, --debug writes all arm logs to %s - -b, --blind disable connection lookups - -e, --event EVENT_FLAGS event types in message log (default: %s) -%s - -v, --version provides version information - -h, --help presents this help - -Example: -arm -b -i 1643 hide connection data, attaching to control port 1643 -arm -e we -c /tmp/cfg use this configuration file with 'WARN'/'ERR' events -""" % (CONFIG["startup.interface.ipAddress"], CONFIG["startup.interface.port"], CONFIG["startup.interface.socket"], DEFAULT_CONFIG, LOG_DUMP_PATH, CONFIG["startup.events"], arm.logPanel.EVENT_LISTING) - # filename used for cached tor config descriptions CONFIG_DESC_FILENAME = "torConfigDesc.txt" @@ -332,6 +313,19 @@ def main(): print str(exc) + " (for usage provide --help)" sys.exit() + # attempts to fetch attributes for parsing tor's logs, configuration, etc + + config = stem.util.conf.get_config("arm") + + pathPrefix = os.path.dirname(sys.argv[0]) + if pathPrefix and not pathPrefix.endswith("/"): + pathPrefix = pathPrefix + "/" + + try: + config.load("%sarm/settings.cfg" % pathPrefix) + except IOError, exc: + stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) + for opt, arg in opts: if opt in ("-i", "--interface"): # defines control interface address/port @@ -362,7 +356,7 @@ def main(): print "arm version %s (released %s)\n" % (__version__, __release_date__) sys.exit() elif opt in ("-h", "--help"): - print HELP_MSG + print CONFIG['msg.help'] % (ARGS['control_address'], ARGS['control_port'], ARGS['control_socket'], DEFAULT_CONFIG, LOG_DUMP_PATH, ARGS['logged_events'], arm.logPanel.EVENT_LISTING) sys.exit() if isDebugMode: @@ -388,18 +382,6 @@ def main(): except (OSError, IOError), exc: print "Unable to write to debug log file: %s" % arm.util.sysTools.getFileErrorMsg(exc) - config = stem.util.conf.get_config("arm") - - # attempts to fetch attributes for parsing tor's logs, configuration, etc - pathPrefix = os.path.dirname(sys.argv[0]) - if pathPrefix and not pathPrefix.endswith("/"): - pathPrefix = pathPrefix + "/" - - try: - config.load("%ssettings.cfg" % pathPrefix) - except IOError, exc: - stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - # loads user's personal armrc if available if os.path.exists(configPath): try:

1 0

[arm/master] Using new args for --version and --help
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 3adf87ff5b0a443c50d9efc6e5cfb51ed9edf1dc Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 15:26:37 2013 -0700 Using new args for --version and --help Using the arguments provided by _get_args() for a couple of the simplest arguments. --- arm/starter.py | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 09fa088..42f325a 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -297,6 +297,19 @@ def main(): isDebugMode = False configPath = DEFAULT_CONFIG # path used for customized configuration + # attempts to fetch attributes for parsing tor's logs, configuration, etc + + config = stem.util.conf.get_config("arm") + + pathPrefix = os.path.dirname(sys.argv[0]) + if pathPrefix and not pathPrefix.endswith("/"): + pathPrefix = pathPrefix + "/" + + try: + config.load("%sarm/settings.cfg" % pathPrefix) + except IOError, exc: + stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) + try: args = _get_args(sys.argv[1:]) except getopt.GetoptError as exc: @@ -306,6 +319,14 @@ def main(): print exc sys.exit(1) + if args.print_version: + print "arm version %s (released %s)\n" % (__version__, __release_date__) + sys.exit() + + if args.print_help: + print CONFIG['msg.help'] % (ARGS['control_address'], ARGS['control_port'], ARGS['control_socket'], DEFAULT_CONFIG, LOG_DUMP_PATH, ARGS['logged_events'], arm.logPanel.EVENT_LISTING) + sys.exit() + # parses user input, noting any issues try: opts, _ = getopt.getopt(sys.argv[1:], OPT, OPT_EXPANDED) @@ -313,19 +334,6 @@ def main(): print str(exc) + " (for usage provide --help)" sys.exit() - # attempts to fetch attributes for parsing tor's logs, configuration, etc - - config = stem.util.conf.get_config("arm") - - pathPrefix = os.path.dirname(sys.argv[0]) - if pathPrefix and not pathPrefix.endswith("/"): - pathPrefix = pathPrefix + "/" - - try: - config.load("%sarm/settings.cfg" % pathPrefix) - except IOError, exc: - stem.util.log.warn(NO_INTERNAL_CFG_MSG % arm.util.sysTools.getFileErrorMsg(exc)) - for opt, arg in opts: if opt in ("-i", "--interface"): # defines control interface address/port @@ -352,12 +360,6 @@ def main(): param["startup.blindModeEnabled"] = True # prevents connection lookups elif opt in ("-e", "--event"): param["startup.events"] = arg # set event flags - elif opt in ("-v", "--version"): - print "arm version %s (released %s)\n" % (__version__, __release_date__) - sys.exit() - elif opt in ("-h", "--help"): - print CONFIG['msg.help'] % (ARGS['control_address'], ARGS['control_port'], ARGS['control_socket'], DEFAULT_CONFIG, LOG_DUMP_PATH, ARGS['logged_events'], arm.logPanel.EVENT_LISTING) - sys.exit() if isDebugMode: try:

1 0

[arm/master] Using new argument parsing in parallel with the old version
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit a4e399176efaa9c5ff379e1fe3142a01864ea15d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 14:32:02 2013 -0700 Using new argument parsing in parallel with the old version Calling our new arg parsing funciton, though for the moment ignoring its output. Functionally this adds the validation it does, and nothing more. Next I plan to replace the old arguments one by one... --- arm/starter.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index bae9a64..37c048d 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -315,10 +315,19 @@ def main(): param = dict([(key, None) for key in CONFIG.keys()]) isDebugMode = False configPath = DEFAULT_CONFIG # path used for customized configuration - + + try: + args = _get_args(sys.argv[1:]) + except getopt.GetoptError as exc: + print "%s (for usage provide --help)" % exc + sys.exit(1) + except ValueError as exc: + print exc + sys.exit(1) + # parses user input, noting any issues try: - opts, args = getopt.getopt(sys.argv[1:], OPT, OPT_EXPANDED) + opts, _ = getopt.getopt(sys.argv[1:], OPT, OPT_EXPANDED) except getopt.GetoptError, exc: print str(exc) + " (for usage provide --help)" sys.exit()

1 0

[arm/master] Using new argument parsing for interfaces
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 75c6cb920f6eb40dca4f5f11886de5e4f544e588 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 15:36:35 2013 -0700 Using new argument parsing for interfaces Replacing the startup.interface.* config attributes with our _get_args() results. --- arm/starter.py | 49 ++++++++++++------------------------------------- armrc.sample | 3 --- 2 files changed, 12 insertions(+), 40 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index 42f325a..ec074c1 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -40,9 +40,6 @@ DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = stem.util.conf.config_dict("arm", { "startup.controlPassword": None, - "startup.interface.ipAddress": "127.0.0.1", - "startup.interface.port": 9051, - "startup.interface.socket": "/var/run/tor/control", "startup.blindModeEnabled": False, "startup.events": "N3", "startup.dataDirectory": "~/.arm", @@ -86,7 +83,9 @@ os.putenv("LANG", "C") ARGS = { 'control_address': '127.0.0.1', 'control_port': 9051, + 'user_provided_port': False, 'control_socket': '/var/run/tor/control', + 'user_provided_socket': False, 'config': None, 'debug': False, 'blind': False, @@ -131,8 +130,10 @@ def _get_args(argv): raise ValueError("'%s' isn't a valid port number" % port) args['control_port'] = int(port) + args['user_provided_port'] = True elif opt in ("-s", "--socket"): args['control_socket'] = arg + args['user_provided_socket'] = True elif opt in ("-c", "--config"): args['config'] = arg elif opt in ("-d", "--debug"): @@ -335,26 +336,7 @@ def main(): sys.exit() for opt, arg in opts: - if opt in ("-i", "--interface"): - # defines control interface address/port - controlAddr, controlPort = None, None - divIndex = arg.find(":") - - try: - if divIndex == -1: - controlPort = int(arg) - else: - controlAddr = arg[0:divIndex] - controlPort = int(arg[divIndex + 1:]) - except ValueError: - print "'%s' isn't a valid port number" % arg - sys.exit() - - param["startup.interface.ipAddress"] = controlAddr - param["startup.interface.port"] = controlPort - elif opt in ("-s", "--socket"): - param["startup.interface.socket"] = arg - elif opt in ("-c", "--config"): configPath = arg # sets path of user's config + if opt in ("-c", "--config"): configPath = arg # sets path of user's config elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs elif opt in ("-b", "--blind"): param["startup.blindModeEnabled"] = True # prevents connection lookups @@ -401,8 +383,8 @@ def main(): else: config.set(key, str(param[key])) # validates that input has a valid ip address and port - controlAddr = param["startup.interface.ipAddress"] - controlPort = param["startup.interface.port"] + controlAddr = args.control_address + controlPort = args.control_port if not arm.util.connections.isValidIpAddress(controlAddr): print "'%s' isn't a valid IP address" % controlAddr @@ -425,15 +407,8 @@ def main(): controller = None - confKeys = stem.util.conf.get_config("arm").keys() - isPortArgPresent = "startup.interface.ipAddress" in confKeys or "startup.interface.port" in confKeys - isSocketArgPresent = "startup.interface.socket" in confKeys - - allowPortConnection = not (isSocketArgPresent and not isPortArgPresent) - allowSocketConnection = not (isPortArgPresent and not isSocketArgPresent) - - socketPath = param["startup.interface.socket"] - if os.path.exists(socketPath) and allowSocketConnection: + socketPath = args.control_socket + if os.path.exists(socketPath) and not args.user_provided_port: try: # TODO: um... what about passwords? # https://trac.torproject.org/6881 @@ -441,12 +416,12 @@ def main(): controller = Controller.from_socket_file(socketPath) controller.authenticate() except IOError, exc: - if not allowPortConnection: + if args.user_provided_socket: print "Unable to use socket '%s': %s" % (socketPath, exc) - elif not allowPortConnection: + elif args.user_provided_socket: print "Socket '%s' doesn't exist" % socketPath - if not controller and allowPortConnection: + if not controller and not args.user_provided_socket: # sets up stem connection, prompting for the passphrase if necessary and # sending problems to stdout if they arise authPassword = config.get("startup.controlPassword", CONFIG["startup.controlPassword"]) diff --git a/armrc.sample b/armrc.sample index 8c57d33..253da0d 100644 --- a/armrc.sample +++ b/armrc.sample @@ -1,8 +1,5 @@ # Startup options startup.controlPassword -startup.interface.ipAddress 127.0.0.1 -startup.interface.port 9051 -startup.interface.socket /var/run/tor/control startup.blindModeEnabled false startup.events N3 startup.dataDirectory ~/.arm

1 0

[arm/master] Using new argument parsing for debug mode
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit c0da0d10c5599310001055e58e046d6986361615 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 16:15:42 2013 -0700 Using new argument parsing for debug mode Another pretty direct replacement. --- arm/starter.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index e2bf175..c6c86c5 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -294,7 +294,6 @@ def _dumpConfig(): def main(): startTime = time.time() param = dict([(key, None) for key in CONFIG.keys()]) - isDebugMode = False # attempts to fetch attributes for parsing tor's logs, configuration, etc @@ -334,13 +333,12 @@ def main(): sys.exit() for opt, arg in opts: - if opt in ("-d", "--debug"): isDebugMode = True # dumps all logs - elif opt in ("-b", "--blind"): + if opt in ("-b", "--blind"): param["startup.blindModeEnabled"] = True # prevents connection lookups elif opt in ("-e", "--event"): param["startup.events"] = arg # set event flags - if isDebugMode: + if args.debug: try: stem_logger = stem.util.log.get_logger() @@ -470,7 +468,7 @@ def main(): _loadConfigurationDescriptions(pathPrefix) # dump tor and arm configuration when in debug mode - if isDebugMode: + if args.debug: stem.util.log.notice("Saving a debug log to '%s' (please check it for sensitive information before sharing)" % LOG_DUMP_PATH) _dumpConfig()

1 0

[arm/master] Changing getPathPrefix() to a function
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 4a2cdadd4bb4907b1e51b3ded03c5ab1cf36d6be Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 16:35:41 2013 -0700 Changing getPathPrefix() to a function The torTools' getPathPrefix() method only uses the self reference to prevent logging duplicate messages. Swapping this over to be a funciton instead. --- arm/graphing/bandwidthStats.py | 2 +- arm/logPanel.py | 2 +- arm/starter.py | 2 +- arm/util/torConfig.py | 2 +- arm/util/torTools.py | 69 +++++++++++++++++++++------------------- 5 files changed, 40 insertions(+), 37 deletions(-) diff --git a/arm/graphing/bandwidthStats.py b/arm/graphing/bandwidthStats.py index 40117dc..b6f5d5a 100644 --- a/arm/graphing/bandwidthStats.py +++ b/arm/graphing/bandwidthStats.py @@ -151,7 +151,7 @@ class BandwidthStats(graphPanel.GraphStats): return False # attempt to open the state file - try: stateFile = open("%s%s/state" % (conn.getPathPrefix(), dataDir), "r") + try: stateFile = open("%s%s/state" % (torTools.getPathPrefix(), dataDir), "r") except IOError: msg = PREPOPULATE_FAILURE_MSG % "unable to read the state file" log.notice(msg) diff --git a/arm/logPanel.py b/arm/logPanel.py index 98843c4..a1b0b87 100644 --- a/arm/logPanel.py +++ b/arm/logPanel.py @@ -218,7 +218,7 @@ def getLogFileEntries(runlevels, readLimit = None, addLimit = None): if not loggingLocation: return [] # includes the prefix for tor paths - loggingLocation = torTools.getConn().getPathPrefix() + loggingLocation + loggingLocation = torTools.getPathPrefix() + loggingLocation # if the runlevels argument is a superset of the log file then we can # limit the read contents to the addLimit diff --git a/arm/starter.py b/arm/starter.py index 53b28ff..67fc5a6 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -223,7 +223,7 @@ def _getController(controlAddr="127.0.0.1", controlPort=9051, passphrase=None, i controller = None try: - chroot = arm.util.torTools.getConn().getPathPrefix() + chroot = arm.util.torTools.getPathPrefix() controller = Controller.from_port(controlAddr, controlPort) try: diff --git a/arm/util/torConfig.py b/arm/util/torConfig.py index b7289ad..beb88b1 100644 --- a/arm/util/torConfig.py +++ b/arm/util/torConfig.py @@ -343,7 +343,7 @@ def getConfigLocation(): conn = torTools.getConn() configLocation = conn.getInfo("config-file", None) - torPid, torPrefix = conn.controller.get_pid(None), conn.getPathPrefix() + torPid, torPrefix = conn.controller.get_pid(None), torTools.getPathPrefix() if not configLocation: raise IOError("unable to query the torrc location") try: diff --git a/arm/util/torTools.py b/arm/util/torTools.py index dc95fd8..e7766e3 100644 --- a/arm/util/torTools.py +++ b/arm/util/torTools.py @@ -31,6 +31,12 @@ REQ_EVENTS = {"NEWDESC": "information related to descriptors will grow stale", "NS": "information related to the consensus will grow stale", "NEWCONSENSUS": "information related to the consensus will grow stale"} +# Logs issues and notices when fetching the path prefix if true. This is +# only done once for the duration of the application to avoid pointless +# messages. + +PATH_PREFIX_LOGGING = True + def getConn(): """ Singleton constructor for a Controller. Be aware that this starts as being @@ -41,6 +47,36 @@ def getConn(): if CONTROLLER == None: CONTROLLER = Controller() return CONTROLLER +def getPathPrefix(): + """ + Provides the path prefix that should be used for fetching tor resources. + If undefined and Tor is inside a jail under FreeBsd then this provides the + jail's path. + """ + + global PATH_PREFIX_LOGGING + + # make sure the path prefix is valid and exists (providing a notice if not) + prefixPath = CONFIG["features.pathPrefix"].strip() + + if not prefixPath and os.uname()[0] == "FreeBSD": + prefixPath = system.get_bsd_jail_path(getConn().controller.get_pid(0)) + + if prefixPath and PATH_PREFIX_LOGGING: + log.info("Adjusting paths to account for Tor running in a jail at: %s" % prefixPath) + + if prefixPath: + # strips off ending slash from the path + if prefixPath.endswith("/"): prefixPath = prefixPath[:-1] + + # avoid using paths that don't exist + if PATH_PREFIX_LOGGING and prefixPath and not os.path.exists(prefixPath): + log.notice("The prefix path set in your config (%s) doesn't exist." % prefixPath) + prefixPath = "" + + PATH_PREFIX_LOGGING = False # prevents logging if fetched again + return prefixPath + class Controller: """ Stem wrapper providing convenience functions (mostly from the days of using @@ -58,11 +94,6 @@ class Controller: self._consensusLookupCache = {} # lookup cache with network status entries self._descriptorLookupCache = {} # lookup cache with relay descriptors self._lastNewnym = 0 # time we last sent a NEWNYM signal - - # Logs issues and notices when fetching the path prefix if true. This is - # only done once for the duration of the application to avoid pointless - # messages. - self._pathPrefixLogging = True def init(self, controller): """ @@ -558,34 +589,6 @@ class Controller: return (None, None) - def getPathPrefix(self): - """ - Provides the path prefix that should be used for fetching tor resources. - If undefined and Tor is inside a jail under FreeBsd then this provides the - jail's path. - """ - - # make sure the path prefix is valid and exists (providing a notice if not) - prefixPath = CONFIG["features.pathPrefix"].strip() - - if not prefixPath and os.uname()[0] == "FreeBSD": - prefixPath = system.get_bsd_jail_path(getConn().controller.get_pid(0)) - - if prefixPath and self._pathPrefixLogging: - log.info("Adjusting paths to account for Tor running in a jail at: %s" % prefixPath) - - if prefixPath: - # strips off ending slash from the path - if prefixPath.endswith("/"): prefixPath = prefixPath[:-1] - - # avoid using paths that don't exist - if self._pathPrefixLogging and prefixPath and not os.path.exists(prefixPath): - log.notice("The prefix path set in your config (%s) doesn't exist." % prefixPath) - prefixPath = "" - - self._pathPrefixLogging = False # prevents logging if fetched again - return prefixPath - def getStartTime(self): """ Provides the unix time for when the tor process first started. If this

1 0

[arm/master] Using new argument parsing for the configuration path
by atagar＠torproject.org 16 Sep '13

16 Sep '13

commit 6db5f56c3dabbd8d704c9d1e3ff1f85105af6c92 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 8 16:13:42 2013 -0700 Using new argument parsing for the configuration path Using _get_args() results for the configuration location. --- arm/starter.py | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/arm/starter.py b/arm/starter.py index ec074c1..e2bf175 100644 --- a/arm/starter.py +++ b/arm/starter.py @@ -8,11 +8,11 @@ command line parameters. import collections import getopt +import os +import sys import stem.util.connection -import os -import sys import time import getpass import locale @@ -36,7 +36,6 @@ import stem.util.log import stem.util.system LOG_DUMP_PATH = os.path.expanduser("~/.arm/log") -DEFAULT_CONFIG = os.path.expanduser("~/.arm/armrc") CONFIG = stem.util.conf.config_dict("arm", { "startup.controlPassword": None, @@ -86,7 +85,7 @@ ARGS = { 'user_provided_port': False, 'control_socket': '/var/run/tor/control', 'user_provided_socket': False, - 'config': None, + 'config': os.path.expanduser("~/.arm/armrc"), 'debug': False, 'blind': False, 'logged_events': 'N3', @@ -296,7 +295,6 @@ def main(): startTime = time.time() param = dict([(key, None) for key in CONFIG.keys()]) isDebugMode = False - configPath = DEFAULT_CONFIG # path used for customized configuration # attempts to fetch attributes for parsing tor's logs, configuration, etc @@ -325,7 +323,7 @@ def main(): sys.exit() if args.print_help: - print CONFIG['msg.help'] % (ARGS['control_address'], ARGS['control_port'], ARGS['control_socket'], DEFAULT_CONFIG, LOG_DUMP_PATH, ARGS['logged_events'], arm.logPanel.EVENT_LISTING) + print CONFIG['msg.help'] % (ARGS['control_address'], ARGS['control_port'], ARGS['control_socket'], ARGS['config'], LOG_DUMP_PATH, ARGS['logged_events'], arm.logPanel.EVENT_LISTING) sys.exit() # parses user input, noting any issues @@ -336,8 +334,7 @@ def main(): sys.exit() for opt, arg in opts: - if opt in ("-c", "--config"): configPath = arg # sets path of user's config - elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs + if opt in ("-d", "--debug"): isDebugMode = True # dumps all logs elif opt in ("-b", "--blind"): param["startup.blindModeEnabled"] = True # prevents connection lookups elif opt in ("-e", "--event"): @@ -367,14 +364,14 @@ def main(): print "Unable to write to debug log file: %s" % arm.util.sysTools.getFileErrorMsg(exc) # loads user's personal armrc if available - if os.path.exists(configPath): + if os.path.exists(args.config): try: - config.load(configPath) + config.load(args.config) except IOError, exc: stem.util.log.warn(STANDARD_CFG_LOAD_FAILED_MSG % arm.util.sysTools.getFileErrorMsg(exc)) else: # no armrc found, falling back to the defaults in the source - stem.util.log.notice(STANDARD_CFG_NOT_FOUND_MSG % configPath) + stem.util.log.notice(STANDARD_CFG_NOT_FOUND_MSG % args.config) # syncs config and parameters, saving changed config options and overwriting # undefined parameters with defaults @@ -425,7 +422,7 @@ def main(): # sets up stem connection, prompting for the passphrase if necessary and # sending problems to stdout if they arise authPassword = config.get("startup.controlPassword", CONFIG["startup.controlPassword"]) - incorrectPasswordMsg = "Password found in '%s' was incorrect" % configPath + incorrectPasswordMsg = "Password found in '%s' was incorrect" % args.config controller = _getController(controlAddr, controlPort, authPassword, incorrectPasswordMsg) # removing references to the controller password so the memory can be freed

1 0