Changeset 325028c in trunk

Timestamp:

2016-08-31T08:50:13Z (9 years ago)

Author:

Brian Warner <warner@…>

Branches:

master

Children:

d47fc0f

Parents:

72f17afa

Message:

error if tcp=tor is requested but tor is unimportable

This only catches txtorcon not being installed (which should be fixed by
doing pip install tahoe-lafs[tor]). It doesn't notice that the Tor
daemon is not running (which we can't detect during startup, only
afterwards, when it's harder to notify the user), in which case Tor
connections (and all connections when "tcp = tor" is enabled) will just
fail silently.

Location:

src/allmydata

Files:

• node.py (modified) (4 diffs)
• test/test_connections.py (modified) (3 diffs)

src/allmydata/node.py ¶

@@ -14 +14 @@
 from allmydata.util.encodingutil import get_filesystem_encoding, quote_output
 from allmydata.util import configutil
+
+def _import_tor():
+    # this exists to be overridden by unit tests
+    try:
+        from foolscap.connections import tor
+        return tor
+    except ImportError: # pragma: no cover
+        return None
+
+def _import_i2p():
+    try:
+        from foolscap.connections import i2p
+        return i2p
+    except ImportError: # pragma: no cover
+        return None
 
 # Add our application versions to the data that Foolscap's LogPublisher
@@ -176 +191 @@
         if not enabled:
             return None
-        try:
-            from foolscap.connections import tor
-        except ImportError:
+        tor = _import_tor()
+        if not tor:
             return None
 
@@ -216 +230 @@
         if not enabled:
             return None
-        try:
-            from foolscap.connections import i2p
-        except ImportError:
+        i2p = _import_i2p()
+        if not i2p:
             return None
 
@@ -260 +273 @@
                              " uses unknown handler type '%s'"
                              % tcp_handler_name)
+        if not handlers[tcp_handler_name]:
+            raise ValueError("'tahoe.cfg [connections] tcp=' uses "
+                             "unavailable/unimportable handler type '%s'. "
+                             "Please pip install tahoe-lafs[%s] to fix."
+                             % (tcp_handler_name, tcp_handler_name))
         self._default_connection_handlers["tcp"] = tcp_handler_name
 

src/allmydata/test/test_connections.py ¶

@@ -30 +30 @@
         self.assertEqual(h, None)
 
+    def test_unimportable(self):
+        n = FakeNode(BASECONFIG)
+        with mock.patch("allmydata.node._import_tor", return_value=None):
+            h = n._make_tor_handler()
+        self.assertEqual(h, None)
+
     def test_default(self):
         n = FakeNode(BASECONFIG)
@@ -108 +114 @@
         n = FakeNode(BASECONFIG+"[i2p]\nenable = false\n")
         h = n._make_i2p_handler()
+        self.assertEqual(h, None)
+
+    def test_unimportable(self):
+        n = FakeNode(BASECONFIG)
+        with mock.patch("allmydata.node._import_i2p", return_value=None):
+            h = n._make_i2p_handler()
         self.assertEqual(h, None)
 
@@ -205 +217 @@
         self.assertEqual(n._default_connection_handlers["i2p"], "i2p")
 
+    def test_tor_unimportable(self):
+        n = FakeNode(BASECONFIG+"[connections]\ntcp = tor\n")
+        with mock.patch("allmydata.node._import_tor", return_value=None):
+            e = self.assertRaises(ValueError, n.init_connections)
+        self.assertEqual(str(e),
+                         "'tahoe.cfg [connections] tcp='"
+                         " uses unavailable/unimportable handler type 'tor'."
+                         " Please pip install tahoe-lafs[tor] to fix.")
+
     def test_unknown(self):
         n = FakeNode(BASECONFIG+"[connections]\ntcp = unknown\n")