Move hardcoded tor options to config file

Author: juga0

bwscanner/attacher.py

@@ -31,26 +31,16 @@ def got_newconsensus(event):
 
 
 @defer.inlineCallbacks
-def connect_to_tor(launch_tor, circuit_build_timeout, tor_dir=None, control_port=None,
+def connect_to_tor(launch_tor, circuit_build_timeout, tor_options,
+                   tor_dir=None, control_port=None,
                    tor_overrides=None):
     """
     Launch or connect to a Tor instance
 
     Configure Tor with the passed options and return a Deferred
     """
+    # FIXME: tor_overrides should probably be removed
     # Options for spawned or running Tor to load the correct descriptors.
-    tor_options = {
-        'LearnCircuitBuildTimeout': 0,  # Disable adaptive circuit timeouts.
-        'CircuitBuildTimeout': circuit_build_timeout,
-        'UseEntryGuards': 0,  # Disable UseEntryGuards to avoid PathBias warnings.
-        'UseMicroDescriptors': 0,
-        'FetchUselessDescriptors': 1,
-        'FetchDirInfoEarly': 1,
-        'FetchDirInfoExtraEarly': 1,
-        'SafeLogging': 0,
-        'LogTimeGranularity': 1,
-    }
-
     if tor_overrides:
         tor_options.update(tor_overrides)
 

bwscanner/config.py

@@ -0,0 +1,41 @@
+#
+""""""
+import os.path
+import click
+
+default = {
+    'data_dir': click.get_app_dir('bwscanner'),
+    'measurement_dir': os.path.join(click.get_app_dir('bwscanner'),
+                                    'measurements'),
+    'tor_dir': os.path.join(click.get_app_dir('bwscanner'),
+                            'tordata'),
+    'logfile': os.path.join(click.get_app_dir('bwscanner'),
+                            'bwscanner.log'),
+    'loglevel': 'debug',
+    'baseurl': 'https://siv.sunet.se/bwauth/',
+    'launch_tor': True,
+    'circuit_build_timeout': 20,
+    'partitions': 1,
+    'current_partition': 1,
+    'timeout': 120,
+    'request_limit': 10
+}
+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"),
+}
+TOR_OPTIONS = {
+    'LearnCircuitBuildTimeout': 0,  # Disable adaptive circuit timeouts.
+    'CircuitBuildTimeout': 20,
+    'UseEntryGuards': 0,  # Disable UseEntryGuards to avoid PathBias warnings.
+    'UseMicroDescriptors': 0,
+    'FetchUselessDescriptors': 1,
+    'FetchDirInfoEarly': 1,
+    'FetchDirInfoExtraEarly': 1,
+    'SafeLogging': 0,
+    'LogTimeGranularity': 1,
+}

bwscanner/scanner.py

@@ -9,6 +9,7 @@
 from bwscanner.logger import setup_logging, log
 from bwscanner.measurement import BwScan
 from bwscanner.aggregate import write_aggregate_data
+from bwscanner.config import TOR_OPTIONS
 from bwscanner import __version__
 
 
@@ -58,7 +59,7 @@ def cli(ctx, data_dir, loglevel, logfile, launch_tor, circuit_build_timeout):
 
     # Create a connection to a Tor instance
     ctx.obj.tor_state = connect_to_tor(launch_tor, circuit_build_timeout,
-                                       ctx.obj.tor_dir)
+                                       TOR_OPTIONS, ctx.obj.tor_dir)
 
     # Set up the logger to only output log lines of level `loglevel` and above.
     setup_logging(log_level=loglevel, log_name=logfile)

test/template.py

@@ -6,6 +6,7 @@
 
 from bwscanner import circuit
 from bwscanner.attacher import connect_to_tor
+from bwscanner.config import TOR_OPTIONS
 
 
 class TorTestCase(unittest.TestCase):
@@ -16,6 +17,7 @@ def setUp(self):
                 launch_tor=False,
                 control_port=int(os.environ.get('CHUTNEY_CONTROL_PORT')),
                 circuit_build_timeout=30,
+                tor_options=TOR_OPTIONS
         )
 
     @property