Add config file parsing

bwscanner/configutil.py

@@ -0,0 +1,28 @@
+import os.path
+from shutil import copyfile
+from ConfigParser import SafeConfigParser
+
+from bwscanner.logger import log
+
+
+def read_config(cfg_path):
+    log.debug('reading config %s' % cfg_path)
+    if not config_exists(cfg_path):
+        copy_config(cfg_path)
+    parser = SafeConfigParser()
+    parser.read([cfg_path])
+    # FIXME: handle section names
+    section = 'default'
+    return dict(parser.items(section))
+
+
+def config_exists(cfg_path):
+    return os.path.isfile(cfg_path)
+
+
+def copy_config(cfg_path, cfg_default_path=None):
+    if cfg_default_path is None:
+        cfg_default_path = os.path.join(os.path.dirname(os.path.dirname(
+                os.path.abspath(__file__))), 'data', 'config.ini')
+    log.debug("cfg_default_path %s" % cfg_default_path)
+    copyfile(cfg_default_path, cfg_path)

bwscanner/scanner.py

@@ -6,12 +6,21 @@
 from twisted.internet import reactor
 
 from bwscanner.attacher import connect_to_tor
+from bwscanner.configutil import read_config
 from bwscanner.logger import setup_logging, log
 from bwscanner.measurement import BwScan
 from bwscanner.aggregate import write_aggregate_data
 
 
 BWSCAN_VERSION = '0.0.1'
+APP_NAME = 'bwscanner'
+DATA_DIR = os.environ.get("BWSCANNER_DATADIR", click.get_app_dir(APP_NAME))
+CONFIG_FILE = 'config.ini'
+LOG_FILE = 'bwscanner.log'
+
+CTX = dict(
+    default_map=read_config(os.path.join(DATA_DIR, CONFIG_FILE))
+)
 
 
 class ScanInstance(object):
@@ -30,18 +39,27 @@ def __repr__(self):
 pass_scan = click.make_pass_decorator(ScanInstance)
 
 
-@click.group()
+# FIXME: change all options to take defaults from CTX, ie config file?
+@click.group(context_settings=CTX)
 @click.option('--data-dir', type=click.Path(),
-              default=os.environ.get("BWSCANNER_DATADIR", click.get_app_dir('bwscanner')),
+              default=os.environ.get("BWSCANNER_DATADIR",
+                                     CTX.get('data_dir',
+                                             click.get_app_dir(APP_NAME))),
               help='Directory where bwscan should stores its measurements and '
               'other data.')
-@click.option('-l', '--loglevel', help='The logging level the scanner will use (default: info)',
-              default='info', type=click.Choice(['debug', 'info', 'warn', 'error', 'critical']))
-@click.option('-f', '--logfile', type=click.Path(), help='The file the log will be written to',
-              default=os.environ.get("BWSCANNER_LOGFILE", 'bwscanner.log'))
-@click.option('--launch-tor/--no-launch-tor', default=False,
+@click.option('-l', '--loglevel',
+              help='The logging level the scanner will use (default: info)',
+              default=CTX.get('loglevel', 'info'),
+              type=click.Choice(['debug', 'info', 'warn', 'error', 'critical']))
+@click.option('-f', '--logfile', type=click.Path(),
+              help='The file the log will be written to',
+              default=os.environ.get("BWSCANNER_LOGFILE",
+                                     CTX.get('logfile', LOG_FILE)))
+@click.option('--launch-tor/--no-launch-tor',
+              default=CTX.get('launch_tor', False),
               help='Launch Tor or try to connect to an existing Tor instance.')
-@click.option('--circuit-build-timeout', default=20,
+@click.option('--circuit-build-timeout',
+              default=CTX.get('circuit_build_timeout', 20),
               help='Option passed when launching Tor.')
 @click.version_option(BWSCAN_VERSION)
 @click.pass_context

data/config.ini

@@ -0,0 +1,33 @@
+[default]
+data_dir = $HOME/.config/bwscanner
+measurement_dir = $HOME/.config/bwscanner/measurements
+tor_dir = $HOME/.config/bwscanner/tordata
+loglevel = debug
+logfile = bwscanner.log
+baseurl = https://siv.sunet.se/bwauth/
+bw_files = {
+    64 * 1024: ("64M", "6258de4f4d602be75a3458117b29d2c580c4bcb7ba5b9d2c4135c7603109f554"),
+    32 * 1024: ("32M", "5a5d66d7865f09498d776f20c9e9791b055a4fff357185f84fb4ecfca7da93f0"),
+    16 * 1024: ("16M", "6258de4f4d602be75a3458117b29d2c580c4bcb7ba5b9d2c4135c7603109f554"),
+    8 * 1024: ("8M", "738c5604295b9377f7636ce0c2c116f093bb50372f589a6c2332a3bb6bba096a"),
+    4 * 1024: ("4M", "4daaa42377d3c87577797d44a8fa569038e7a9d6a5d417a09d8ba41a69456164"),
+    2 * 1024: ("2M", "3e39b0bb92912cf1ad6c01fb7c9d592e814a691c61de1f649416f6bba2d15082"),
+
+    # TODO: check whether files smaller than 2M should be provided
+    # TODO: are k size files key correct?
+    # 1024: ("1M", "daf6da82bc4a20567dcd5eb7e583f3137800c31eb31f5fed79f27a4278903780"),
+    # 512: ("512k", "20e1e9b44c3cb445a59138df8a03767356637ec751beee1f9233ca881121adc6"),
+    # 256: ("256k", "f3655613066fd0db916b0b00bde1a3905516584ea2c4ee4cac3a8ffb08f2f31c"),
+    # 128: ("128k", "072b052df2fba25a9578b69d49986024747ad9e43472db345a03ca6e22027ba6"),
+    # 64: ("64k", "73bee20c527362b18d4adb7e638a6513504954367379e7c61f7f45bdc71c5ddb"),
+    # 32: ("32k", "2ec95ff2c8beca72996161e2bd7831008baf2e012d12b6c84d51e9264fc50fdc"),
+    # 16: ("16k", "924bddcc93f8f76effd495c47b0d39451e34d8204029fe2b7f85905522255e7b"),
+}
+
+launch_tor = True
+circuit_build_timeout = 20
+
+partitions = 1
+current_partition = 1
+timeout = 120
+request_limit = 10