[tor-commits] [stem/master] Added test for list circuits example script

[atagar at torproject.org]

commit f28142dce4ee8f1035e0df5ec009725c641a8545
Author: Sambuddha Basu <sambuddhabasu1 at gmail.com>
Date:   Sun Dec 14 15:33:13 2014 +0400

    Added test for list circuits example script
    
    Made better use of functions
---
 test/settings.cfg              |    1 +
 test/unit/tutorial_examples.py |  111 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+)

diff --git a/test/settings.cfg b/test/settings.cfg
index 6ce27b8..96fa40d 100644
--- a/test/settings.cfg
+++ b/test/settings.cfg
@@ -172,6 +172,7 @@ test.unit_tests
 |test.unit.exit_policy.policy.TestExitPolicy
 |test.unit.version.TestVersion
 |test.unit.tutorial.TestTutorial
+|test.unit.tutorial_examples.TestTutorialExamples
 |test.unit.response.control_message.TestControlMessage
 |test.unit.response.control_line.TestControlLine
 |test.unit.response.events.TestEvents
diff --git a/test/unit/tutorial_examples.py b/test/unit/tutorial_examples.py
new file mode 100644
index 0000000..59be150
--- /dev/null
+++ b/test/unit/tutorial_examples.py
@@ -0,0 +1,111 @@
+"""
+Tests for the examples given in stem's tutorial.
+"""
+
+import StringIO
+import unittest
+
+import stem.response
+
+from stem.control import Controller
+from test import mocking
+from test.mocking import get_router_status_entry_v3
+from test.mocking import ROUTER_STATUS_ENTRY_V3_HEADER
+
+try:
+  # added in python 3.3
+  from unittest.mock import patch
+except ImportError:
+  from mock import patch
+
+CIRC_CONTENT = '650 CIRC %d %s \
+%s \
+PURPOSE=%s'
+
+PATH_CONTENT = '$%s=%s,$%s=%s,$%s=%s'
+
+LIST_CIRCUITS_OUTPUT = """\
+
+Circuit 4 (GENERAL)
+ |- B1FA7D51B8B6F0CB585D944F450E7C06EDE7E44C (ByTORAndTheSnowDog, 173.209.180.61)
+ |- 0DD9935C5E939CFA1E07B8DDA6D91C1A2A9D9338 (afo02, 87.238.194.176)
+ +- DB3B1CFBD3E4D97B84B548ADD5B9A31451EEC4CC (edwardsnowden3, 109.163.234.10)
+
+Circuit 6 (GENERAL)
+ |- B1FA7D51B8B6F0CB585D944F450E7C06EDE7E44C (ByTORAndTheSnowDog, 173.209.180.61)
+ |- EC01CB4766BADC1611678555CE793F2A7EB2D723 (sprockets, 46.165.197.96)
+ +- 9EA317EECA56BDF30CAEB208A253FB456EDAB1A0 (bolobolo1, 96.47.226.20)
+
+Circuit 10 (GENERAL)
+ |- B1FA7D51B8B6F0CB585D944F450E7C06EDE7E44C (ByTORAndTheSnowDog, 173.209.180.61)
+ |- 00C2C2A16AEDB51D5E5FB7D6168FC66B343D822F (ph3x, 86.59.119.83)
+ +- 65242C91BFF30F165DA4D132C81A9EBA94B71D62 (torexit16, 176.67.169.171)
+"""
+
+
+def _get_event(id, status, hop1, hop2, hop3, purpose):
+  path = PATH_CONTENT % (hop1[0], hop1[1], hop2[0], hop2[1], hop3[0], hop3[1])
+  content = CIRC_CONTENT % (id, status, path, purpose)
+  controller_event = mocking.get_message(content)
+  stem.response.convert('EVENT', controller_event)
+  return controller_event
+
+
+def _get_router_status(address):
+  r_line = ROUTER_STATUS_ENTRY_V3_HEADER[0][1].replace('71.35.150.29', address)
+  content = get_router_status_entry_v3({'r': r_line})
+  return content
+
+
+class TestTutorialExamples(unittest.TestCase):
+  @patch('sys.stdout', new_callable = StringIO.StringIO)
+  @patch('stem.control.Controller.from_port', spec = Controller)
+  def test_list_circuits(self, from_port_mock, stdout_mock):
+    def tutorial_example():
+      from stem import CircStatus
+      from stem.control import Controller
+
+      with Controller.from_port(port = 9051) as controller:
+        controller.authenticate()
+
+        for circ in sorted(controller.get_circuits()):
+          if circ.status != CircStatus.BUILT:
+            continue
+
+          print
+          print "Circuit %s (%s)" % (circ.id, circ.purpose)
+
+          for i, entry in enumerate(circ.path):
+            div = '+' if (i == len(circ.path) - 1) else '|'
+            fingerprint, nickname = entry
+
+            desc = controller.get_network_status(fingerprint, None)
+            address = desc.address if desc else 'unknown'
+
+            print " %s- %s (%s, %s)" % (div, fingerprint, nickname, address)
+
+    path_1 = ('B1FA7D51B8B6F0CB585D944F450E7C06EDE7E44C', 'ByTORAndTheSnowDog')
+    path_2 = ('0DD9935C5E939CFA1E07B8DDA6D91C1A2A9D9338', 'afo02')
+    path_3 = ('DB3B1CFBD3E4D97B84B548ADD5B9A31451EEC4CC', 'edwardsnowden3')
+    path_4 = ('EC01CB4766BADC1611678555CE793F2A7EB2D723', 'sprockets')
+    path_5 = ('9EA317EECA56BDF30CAEB208A253FB456EDAB1A0', 'bolobolo1')
+    path_6 = ('00C2C2A16AEDB51D5E5FB7D6168FC66B343D822F', 'ph3x')
+    path_7 = ('65242C91BFF30F165DA4D132C81A9EBA94B71D62', 'torexit16')
+
+    circuit_4 = _get_event(4, 'BUILT', path_1, path_2, path_3, 'GENERAL')
+    circuit_6 = _get_event(6, 'BUILT', path_1, path_4, path_5, 'GENERAL')
+    circuit_10 = _get_event(10, 'BUILT', path_1, path_6, path_7, 'GENERAL')
+
+    controller = from_port_mock().__enter__()
+    controller.get_circuits.return_value = [circuit_4, circuit_6, circuit_10]
+    controller.get_network_status.side_effect = lambda fingerprint, *args: {
+      path_1[0]: _get_router_status("173.209.180.61"),
+      path_2[0]: _get_router_status("87.238.194.176"),
+      path_3[0]: _get_router_status("109.163.234.10"),
+      path_4[0]: _get_router_status("46.165.197.96"),
+      path_5[0]: _get_router_status("96.47.226.20"),
+      path_6[0]: _get_router_status("86.59.119.83"),
+      path_7[0]: _get_router_status("176.67.169.171")
+    }[fingerprint]
+    tutorial_example()
+    self.assertEqual(LIST_CIRCUITS_OUTPUT, stdout_mock.getvalue())