October 2020 - tor-commits - lists.torproject.org

[stem/master] Move running_hidden_service test
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 469a925991acdd3e99cc486215aac673a5f81062 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 27 17:11:24 2020 -0700 Move running_hidden_service test --- test/unit/examples.py | 37 +++++++++++++++++++++++-- test/unit/tutorial.py | 76 +-------------------------------------------------- 2 files changed, 36 insertions(+), 77 deletions(-) diff --git a/test/unit/examples.py b/test/unit/examples.py index cadf3048..ef1d9ed9 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -155,6 +155,14 @@ Checking for outdated relays... EXPECTED_PERSISTING_A_CONSENSUS = """\ A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB: caerSidi """ + +EXPECTED_RUNNING_HIDDEN_SERVICE = """\ + * Connecting to tor + * Creating our hidden service in /home/atagar/.tor/hello_world + * Our service is available at uxiuaxejc3sxrb6i.onion, press ctrl+c to quit + * Shutting down our hidden service +""" + EXPECTED_VOTES_BY_BANDWIDTH_AUTHORITIES = """\ Getting gabelmoo's vote from http://131.188.40.189:80/tor/status-vote/current/authority: 5935 measured entries and 1332 unmeasured @@ -570,8 +578,33 @@ class TestExamples(unittest.TestCase): def test_resuming_ephemeral_hidden_service(self): pass - def test_running_hidden_service(self): - pass + @patch('stem.control.Controller.from_port', spec = Controller) + @patch('shutil.rmtree') + @patch('sys.stdout', new_callable = io.StringIO) + def test_running_hidden_service(self, stdout_mock, rmtree_mock, from_port_mock): + original_modules = dict(sys.modules) + + try: + flask_mock = Mock() + + hidden_service_data = Mock() + hidden_service_data.hostname = 'uxiuaxejc3sxrb6i.onion' + + controller = from_port_mock().__enter__() + controller.get_conf.return_value = '/home/atagar/.tor' + controller.create_hidden_service.return_value = hidden_service_data + + sys.modules['flask'] = flask_mock + + import running_hidden_service + + controller.get_conf.assert_called_once_with('DataDirectory', '/tmp') + controller.create_hidden_service.assert_called_once_with('/home/atagar/.tor/hello_world', 80, target_port = 5000) + rmtree_mock.assert_called_once_with('/home/atagar/.tor/hello_world') + + self.assertEqual(EXPECTED_RUNNING_HIDDEN_SERVICE, stdout_mock.getvalue()) + finally: + sys.modules = original_modules def test_saving_and_loading_descriptors(self): pass diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index f35a6b6d..d6b6ee3b 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -7,20 +7,12 @@ import unittest import stem.descriptor.remote -from unittest.mock import Mock, patch +from unittest.mock import patch -from stem.control import Controller from stem.descriptor.router_status_entry import RouterStatusEntryV3 from stem.descriptor.networkstatus import NetworkStatusDocumentV3 from stem.descriptor.server_descriptor import RelayDescriptor -OVER_THE_RIVER_OUTPUT = """\ - * Connecting to tor - * Creating our hidden service in /home/atagar/.tor/hello_world - * Our service is available at uxiuaxejc3sxrb6i.onion, press ctrl+c to quit - * Shutting down our hidden service -""" - MIRROR_MIRROR_OUTPUT = """\ 1. speedyexit (102.13 KB/s) 2. speedyexit (102.13 KB/s) @@ -35,72 +27,6 @@ class TestTutorial(unittest.TestCase): stem.descriptor.remote.SINGLETON_DOWNLOADER = None - @patch('sys.stdout', new_callable = io.StringIO) - @patch('shutil.rmtree') - @patch('stem.control.Controller.from_port', spec = Controller) - def test_over_the_river(self, from_port_mock, rmtree_mock, stdout_mock): - def tutorial_example(app): - import os - import shutil - - from stem.control import Controller - - @app.route('/') - def index(): - return '<h1>Hi Grandma!</h1>' - - print(' * Connecting to tor') - - with Controller.from_port() as controller: - controller.authenticate() - - # All hidden services have a directory on disk. Lets put ours in tor's data - # directory. - - hidden_service_dir = os.path.join(controller.get_conf('DataDirectory', '/tmp'), 'hello_world') - - # Create a hidden service where visitors of port 80 get redirected to local - # port 5000 (this is where flask runs by default). - - print(' * Creating our hidden service in %s' % hidden_service_dir) - result = controller.create_hidden_service(hidden_service_dir, 80, target_port = 5000) - - # The hostname is only available we can read the hidden service directory. - # This requires us to be running with the same user as tor. - - if result.hostname: - print(' * Our service is available at %s, press ctrl+c to quit' % result.hostname) - else: - print(" * Unable to determine our service's hostname, probably due to being unable to read the hidden service directory") - - try: - app.run() - finally: - # Shut down the hidden service and clean it off disk. Note that you *don't* - # want to delete the hidden service directory if you'd like to have this - # same *.onion address in the future. - - print(' * Shutting down our hidden service') - controller.remove_hidden_service(hidden_service_dir) - shutil.rmtree(hidden_service_dir) - - flask_mock = Mock() - - hidden_service_data = Mock() - hidden_service_data.hostname = 'uxiuaxejc3sxrb6i.onion' - - controller = from_port_mock().__enter__() - controller.get_conf.return_value = '/home/atagar/.tor' - controller.create_hidden_service.return_value = hidden_service_data - - tutorial_example(flask_mock) - - controller.get_conf.assert_called_once_with('DataDirectory', '/tmp') - controller.create_hidden_service.assert_called_once_with('/home/atagar/.tor/hello_world', 80, target_port = 5000) - rmtree_mock.assert_called_once_with('/home/atagar/.tor/hello_world') - - self.assertEqual(OVER_THE_RIVER_OUTPUT, stdout_mock.getvalue()) - @patch('sys.stdout', new_callable = io.StringIO) @patch('%s.open' % __name__, create = True) def test_mirror_mirror_on_the_wall_3(self, open_mock, stdout_mock):

1 0

[stem/master] Move descriptor_from_tor_data_directory test
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 68b57bfe7a9615a642ae98c0bcdb20ddf8e5051b Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 27 17:20:17 2020 -0700 Move descriptor_from_tor_data_directory test --- test/unit/examples.py | 12 ++++++++++-- test/unit/tutorial.py | 20 -------------------- 2 files changed, 10 insertions(+), 22 deletions(-) diff --git a/test/unit/examples.py b/test/unit/examples.py index ef1d9ed9..c972c7e9 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -420,8 +420,16 @@ class TestExamples(unittest.TestCase): self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) - def test_descriptor_from_tor_data_directory(self): - pass + @patch('stem.descriptor.parse_file') + @patch('sys.stdout', new_callable = io.StringIO) + def test_descriptor_from_tor_data_directory(self, stdout_mock, parse_file_mock): + parse_file_mock.return_value = [RouterStatusEntryV3.create({ + 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', + })] + + import descriptor_from_tor_data_directory + + self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) def test_download_descriptor(self): pass diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index d6b6ee3b..e2b621e8 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -9,8 +9,6 @@ import stem.descriptor.remote from unittest.mock import patch -from stem.descriptor.router_status_entry import RouterStatusEntryV3 -from stem.descriptor.networkstatus import NetworkStatusDocumentV3 from stem.descriptor.server_descriptor import RelayDescriptor MIRROR_MIRROR_OUTPUT = """\ @@ -27,24 +25,6 @@ class TestTutorial(unittest.TestCase): stem.descriptor.remote.SINGLETON_DOWNLOADER = None - @patch('sys.stdout', new_callable = io.StringIO) - @patch('%s.open' % __name__, create = True) - def test_mirror_mirror_on_the_wall_3(self, open_mock, stdout_mock): - def tutorial_example(): - from stem.descriptor import parse_file - - for desc in parse_file(open('/home/atagar/.tor/cached-consensus')): - print('found relay %s (%s)' % (desc.nickname, desc.fingerprint)) - - test_file = io.BytesIO(NetworkStatusDocumentV3.content(routers = [RouterStatusEntryV3.create({ - 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', - })])) - test_file.name = '/home/atagar/.tor/cached-consensus' - open_mock.return_value = test_file - - tutorial_example() - self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) - @patch('sys.stdout', new_callable = io.StringIO) @patch('stem.descriptor.remote.DescriptorDownloader') def test_mirror_mirror_on_the_wall_5(self, downloader_mock, stdout_mock):

1 0

[stem/master] Test create_descriptor example
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit a72cb09d271dd04b5f81b91272a0abfbbcdc867a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 28 16:06:02 2020 -0700 Test create_descriptor example --- docs/_static/example/create_descriptor_content.py | 2 +- test/unit/examples.py | 22 ++++++++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/_static/example/create_descriptor_content.py b/docs/_static/example/create_descriptor_content.py index e4a9f2b8..b69ea768 100644 --- a/docs/_static/example/create_descriptor_content.py +++ b/docs/_static/example/create_descriptor_content.py @@ -1,3 +1,3 @@ from stem.descriptor.server_descriptor import RelayDescriptor -print(RelayDescriptor.content({'router': 'demo 127.0.0.1 80 0 0'})) +print(RelayDescriptor.content({'router': 'demo 127.0.0.1 80 0 0'}).decode('utf-8')) diff --git a/test/unit/examples.py b/test/unit/examples.py index dc9fc242..1b85c297 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -396,11 +396,25 @@ class TestExamples(unittest.TestCase): self.assertEqual(EXPECTED_COMPARE_FLAGS, stdout_mock.getvalue()) - def test_create_descriptor(self): - pass + @patch('sys.stdout', new_callable = io.StringIO) + def test_create_descriptor(self, stdout_mock): + import create_descriptor - def test_create_descriptor_content(self): - pass + # First line is randomized, for example... + # + # Unnamed566296572314 (226.149.46.74:9001) + # demo (127.0.0.1:80) + + lines = stdout_mock.getvalue().splitlines() + + self.assertTrue(lines[0].startswith('Unnamed')) + self.assertEqual('demo (127.0.0.1:80)', lines[1]) + + @patch('sys.stdout', new_callable = io.StringIO) + def test_create_descriptor_content(self, stdout_mock): + import create_descriptor_content + + self.assertTrue(stdout_mock.getvalue().startswith('router demo 127.0.0.1 80 0 0\npublish')) @patch('stem.descriptor.remote.DescriptorDownloader') @patch('sys.stdout', new_callable = io.StringIO)

1 0

[stem/master] Test download_descriptor example
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit c8b543368352a013c17cfe41baf6e370ee475826 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 28 17:18:37 2020 -0700 Test download_descriptor example --- docs/_static/example/download_descriptor.py | 12 +++++------- test/unit/examples.py | 30 ++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 8 deletions(-) diff --git a/docs/_static/example/download_descriptor.py b/docs/_static/example/download_descriptor.py index 7e712ecf..89ea4a6c 100644 --- a/docs/_static/example/download_descriptor.py +++ b/docs/_static/example/download_descriptor.py @@ -57,9 +57,6 @@ def parse(argv): for opt, arg in recognized_args: if opt in ('-t', '--type'): - if arg not in VALID_TYPES: - raise ValueError("'%s' isn't a recognized decriptor type, options are: %s" % (arg, ', '.join(VALID_TYPES))) - args['descriptor_type'] = arg elif opt in ('-f', '--fingerprint'): if not stem.util.tor_tools.is_valid_fingerprint(arg): @@ -88,9 +85,9 @@ def parse(argv): return Args(**args) -def main(): +def main(argv): try: - args = parse(sys.argv[1:]) + args = parse(argv) except ValueError as exc: print(exc) sys.exit(1) @@ -125,7 +122,8 @@ def main(): print("'%s' is not a recognized descriptor type, options are: %s" % (args.descriptor_type, ', '.join(VALID_TYPES))) sys.exit(1) - print(desc) + if desc: + print(desc) if __name__ == '__main__': - main() + main(sys.argv[1:]) diff --git a/test/unit/examples.py b/test/unit/examples.py index af049f57..eb9bdb2a 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -115,6 +115,18 @@ moria1 has the Running flag but maatuska doesn't: DCAEC3D069DC39AAE43D13C8AF31B5 maatuska has the Running flag but moria1 doesn't: E2BB13AA2F6960CD93ABE5257A825687F3973C62 """ +EXPECTED_DOWNLOAD_DESCRIPTOR_UNKNOWN_TYPE = """\ +Downloading kaboom descriptor from 128.31.0.34:9131... + +'kaboom' is not a recognized descriptor type, options are: server, extrainfo, consensus +""" + +EXPECTED_DOWNLOAD_DESCRIPTOR_PREFIX = """\ +Downloading server descriptor from 1.2.3.4:443... + +router caerSidi 71.35.133.197 9001 0 0 +""" + EXPECTED_EXIT_USED = """\ Tracking requests for tor exits. Press 'enter' to end. @@ -484,8 +496,24 @@ class TestExamples(unittest.TestCase): self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) + @patch('sys.exit', Mock()) def test_download_descriptor(self): - pass + import download_descriptor + + with patch('sys.stdout', new_callable = io.StringIO) as stdout_mock: + download_descriptor.main(['--help']) + self.assertTrue(stdout_mock.getvalue().startswith("Downloads a descriptor through Tor's ORPort")) + + with patch('sys.stdout', new_callable = io.StringIO) as stdout_mock: + download_descriptor.main(['--type', 'kaboom']) + self.assertEqual(EXPECTED_DOWNLOAD_DESCRIPTOR_UNKNOWN_TYPE, stdout_mock.getvalue()) + + server_desc = RelayDescriptor.create({'router': 'caerSidi 71.35.133.197 9001 0 0'}) + + with patch('sys.stdout', new_callable = io.StringIO) as stdout_mock: + with patch('stem.descriptor.remote.get_server_descriptors', _download_of(server_desc)): + download_descriptor.main(['--dirport', '1.2.3.4:443']) + self.assertTrue(stdout_mock.getvalue().startswith(EXPECTED_DOWNLOAD_DESCRIPTOR_PREFIX)) def test_ephemeral_hidden_services(self): pass

1 0

[stem/master] Move persisting_a_consensus tests
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 1a8cff380c76b8a90a868472f92951cd08e35919 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 27 15:58:27 2020 -0700 Move persisting_a_consensus tests --- test/settings.cfg | 1 - test/unit/__init__.py | 11 ----- test/unit/examples.py | 54 +++++++++++++++++++------ test/unit/tutorial.py | 12 +++++- test/unit/tutorial_examples.py | 92 ------------------------------------------ 5 files changed, 51 insertions(+), 119 deletions(-) diff --git a/test/settings.cfg b/test/settings.cfg index 26561327..91f287cf 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -290,7 +290,6 @@ test.unit_tests |test.unit.directory.authority.TestAuthority |test.unit.directory.fallback.TestFallback |test.unit.tutorial.TestTutorial -|test.unit.tutorial_examples.TestTutorialExamples |test.unit.response.add_onion.TestAddOnionResponse |test.unit.response.control_message.TestControlMessage |test.unit.response.control_line.TestControlLine diff --git a/test/unit/__init__.py b/test/unit/__init__.py index 1b16bc99..7fb58a67 100644 --- a/test/unit/__init__.py +++ b/test/unit/__init__.py @@ -2,9 +2,6 @@ Unit tests for the stem library. """ -import os -import test - __all__ = [ 'client', 'connection', @@ -16,11 +13,3 @@ __all__ = [ 'util', 'version', ] - - -def exec_documentation_example(filename): - path = os.path.join(test.STEM_BASE, 'docs', '_static', 'example', filename) - - with open(path) as f: - code = compile(f.read(), path, 'exec') - exec(code) diff --git a/test/unit/examples.py b/test/unit/examples.py index 1b055628..3f528b80 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -152,6 +152,9 @@ Checking for outdated relays... 2 outdated relays found, 1 had contact information """ +EXPECTED_PERSISTING_A_CONSENSUS = """\ +A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB: caerSidi +""" EXPECTED_VOTES_BY_BANDWIDTH_AUTHORITIES = """\ Getting gabelmoo's vote from http://131.188.40.189:80/tor/status-vote/current/authority: 5935 measured entries and 1332 unmeasured @@ -168,6 +171,12 @@ def _make_circ_event(circ_id, hop1, hop2, hop3): return ControlMessage.from_str(content, 'EVENT', normalize = True) +def _download_of(desc): + query = Mock() + query.run.return_value = [desc] + return Mock(return_value = query) + + class TestExamples(unittest.TestCase): def setUp(self): self.original_path = list(sys.path) @@ -268,11 +277,6 @@ class TestExamples(unittest.TestCase): @test.require.cryptography def test_check_digests(self): - def download_of(desc): - query = Mock() - query.run.return_value = [desc] - return Mock(return_value = query) - import check_digests as module fingerprint = 'A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB' @@ -289,18 +293,18 @@ class TestExamples(unittest.TestCase): 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', }) - with patch('stem.descriptor.remote.get_server_descriptors', download_of(server_desc)): - with patch('stem.descriptor.remote.get_extrainfo_descriptors', download_of(extrainfo_desc)): + with patch('stem.descriptor.remote.get_server_descriptors', _download_of(server_desc)): + with patch('stem.descriptor.remote.get_extrainfo_descriptors', _download_of(extrainfo_desc)): # correctly signed descriptors - with patch('stem.descriptor.remote.get_consensus', download_of(consensus_desc)): + with patch('stem.descriptor.remote.get_consensus', _download_of(consensus_desc)): with patch('sys.stdout', new_callable = io.StringIO) as stdout_mock: module.validate_relay(fingerprint) self.assertEqual(EXPECTED_CHECK_DIGESTS_OK, stdout_mock.getvalue()) # incorrect server descriptor digest - with patch('stem.descriptor.remote.get_consensus', download_of(bad_consensus_desc)): + with patch('stem.descriptor.remote.get_consensus', _download_of(bad_consensus_desc)): with patch('sys.stdout', new_callable = io.StringIO) as stdout_mock: module.validate_relay(fingerprint) self.assertEqual(EXPECTED_CHECK_DIGESTS_BAD % server_desc.digest(), stdout_mock.getvalue()) @@ -494,11 +498,35 @@ class TestExamples(unittest.TestCase): self.assertEqual(EXPECTED_OUTDATED_RELAYS, stdout_mock.getvalue()) - def test_persisting_a_consensus(self): - pass + @patch('stem.descriptor.remote.DescriptorDownloader') + def test_persisting_a_consensus(self, downloader_mock): + consensus = NetworkStatusDocumentV3.create(routers = (RouterStatusEntryV3.create({ + 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', + }),)) - def test_persisting_a_consensus_with_parse_file(self): - pass + downloader_mock().get_consensus = _download_of(consensus) + + try: + import persisting_a_consensus + + with open('/tmp/descriptor_dump') as output_file: + self.assertEqual(str(consensus), output_file.read()) + finally: + if os.path.exists('/tmp/descriptor_dump'): + os.remove('/tmp/descriptor_dump') + + @patch('stem.descriptor.parse_file') + @patch('sys.stdout', new_callable = io.StringIO) + def test_persisting_a_consensus_with_parse_file(self, stdout_mock, parse_file_mock): + consensus = NetworkStatusDocumentV3.create(routers = (RouterStatusEntryV3.create({ + 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', + }),)) + + parse_file_mock.return_value = iter([consensus]) + + import persisting_a_consensus_with_parse_file + + self.assertEqual(EXPECTED_PERSISTING_A_CONSENSUS, stdout_mock.getvalue()) def test_queue_listener(self): pass diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index 35b2fe28..140bbba5 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -3,9 +3,11 @@ Tests for the examples given in stem's tutorial. """ import io +import os import unittest import stem.descriptor.remote +import test from unittest.mock import Mock, patch @@ -14,8 +16,6 @@ from stem.descriptor.router_status_entry import RouterStatusEntryV2, RouterStatu from stem.descriptor.networkstatus import NetworkStatusDocumentV3 from stem.descriptor.server_descriptor import RelayDescriptor from stem.exit_policy import ExitPolicy -from test.unit import exec_documentation_example - OVER_THE_RIVER_OUTPUT = """\ * Connecting to tor @@ -31,6 +31,14 @@ MIRROR_MIRROR_OUTPUT = """\ """ +def exec_documentation_example(filename): + path = os.path.join(test.STEM_BASE, 'docs', '_static', 'example', filename) + + with open(path) as f: + code = compile(f.read(), path, 'exec') + exec(code) + + class TestTutorial(unittest.TestCase): def tearDown(self): # Ensure we don't cache a Mock object as our downloader. Otherwise future diff --git a/test/unit/tutorial_examples.py b/test/unit/tutorial_examples.py deleted file mode 100644 index 451bb2aa..00000000 --- a/test/unit/tutorial_examples.py +++ /dev/null @@ -1,92 +0,0 @@ -""" -Tests for the examples given in stem's tutorial. -""" - -import io -import itertools -import os -import unittest - -from unittest.mock import patch - -from stem.descriptor.networkstatus import NetworkStatusDocumentV3 -from stem.descriptor.router_status_entry import RouterStatusEntryV3 -from stem.response import ControlMessage - -from test.unit import exec_documentation_example - -OPEN_FUNCTION = open # make a reference so mocking open() won't mess with us - -CIRC_CONTENT = '650 CIRC %d %s \ -%s \ -PURPOSE=%s' - -PATH_CONTENT = '$%s=%s,$%s=%s,$%s=%s' - -PERSISTING_A_CONSENSUS_OUTPUT = """\ -A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB: caerSidi -""" - - -def _get_event(content): - return ControlMessage.from_str(content, 'EVENT', normalize = True) - - -def _get_circ_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) - return _get_event(content) - - -def _get_router_status(address = None, port = None, nickname = None, fingerprint_base64 = None, s_line = None): - r_line = 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0' - - if address: - r_line = r_line.replace('71.35.150.29', address) - - if port: - r_line = r_line.replace('9001', port) - - if nickname: - r_line = r_line.replace('caerSidi', nickname) - - if fingerprint_base64: - r_line = r_line.replace('p1aag7VwarGxqctS7/fS0y5FU+s', fingerprint_base64) - - if s_line: - return RouterStatusEntryV3.create({'r': r_line, 's': s_line}) - else: - return RouterStatusEntryV3.create({'r': r_line}) - - -class TestTutorialExamples(unittest.TestCase): - @patch('sys.stdout', new_callable = io.StringIO) - @patch('stem.descriptor.parse_file') - @patch('stem.descriptor.remote.Query') - def test_persisting_a_consensus(self, query_mock, parse_file_mock, stdout_mock): - def tutorial_example_2(): - from stem.descriptor import DocumentHandler, parse_file - - consensus = next(parse_file( - '/tmp/descriptor_dump', - descriptor_type = 'network-status-consensus-3 1.0', - document_handler = DocumentHandler.DOCUMENT, - )) - - for fingerprint, relay in consensus.routers.items(): - print('%s: %s' % (fingerprint, relay.nickname)) - - network_status = NetworkStatusDocumentV3.create(routers = (RouterStatusEntryV3.create({ - 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', - }),)) - - query_mock().run.return_value = [network_status] - parse_file_mock.return_value = itertools.cycle([network_status]) - - exec_documentation_example('persisting_a_consensus.py') - exec_documentation_example('persisting_a_consensus_with_parse_file.py') - - self.assertEqual(PERSISTING_A_CONSENSUS_OUTPUT, stdout_mock.getvalue()) - - if os.path.exists('/tmp/descriptor_dump'): - os.remove('/tmp/descriptor_dump')

1 0

[stem/master] Move tor_descriptors test
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit b8ab2cc30cad6850d5a011ecca129b35af47802a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 28 00:07:20 2020 -0700 Move tor_descriptors test --- test/settings.cfg | 1 - test/unit/examples.py | 29 ++++++++++++++++++-- test/unit/tutorial.py | 74 --------------------------------------------------- 3 files changed, 27 insertions(+), 77 deletions(-) diff --git a/test/settings.cfg b/test/settings.cfg index 91f287cf..853c4483 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -289,7 +289,6 @@ test.unit_tests |test.unit.manual.TestManual |test.unit.directory.authority.TestAuthority |test.unit.directory.fallback.TestFallback -|test.unit.tutorial.TestTutorial |test.unit.response.add_onion.TestAddOnionResponse |test.unit.response.control_message.TestControlMessage |test.unit.response.control_line.TestControlLine diff --git a/test/unit/examples.py b/test/unit/examples.py index c972c7e9..dc9fc242 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -163,6 +163,12 @@ EXPECTED_RUNNING_HIDDEN_SERVICE = """\ * Shutting down our hidden service """ +EXPECTED_TOR_DESCRIPTORS = """\ +1. speedyexit (102.13 KB/s) +2. speedyexit (102.13 KB/s) +3. speedyexit (102.13 KB/s) +""" + EXPECTED_VOTES_BY_BANDWIDTH_AUTHORITIES = """\ Getting gabelmoo's vote from http://131.188.40.189:80/tor/status-vote/current/authority: 5935 measured entries and 1332 unmeasured @@ -193,6 +199,11 @@ class TestExamples(unittest.TestCase): def tearDown(self): sys.path = self.original_path + # Ensure we don't cache a Mock object as our downloader. Otherwise future + # tests will understandably be very sad. :P + + stem.descriptor.remote.SINGLETON_DOWNLOADER = None + def test_runs_everything(self): """ Ensure we have tests for all our examples. @@ -620,8 +631,22 @@ class TestExamples(unittest.TestCase): def test_slow_listener(self): pass - def test_tor_descriptors(self): - pass + @patch('stem.descriptor.remote.DescriptorDownloader') + @patch('sys.stdout', new_callable = io.StringIO) + def test_tor_descriptors(self, stdout_mock, downloader_mock): + exit_descriptor = RelayDescriptor.content({'router': 'speedyexit 149.255.97.109 9001 0 0'}).replace(b'reject *:*', b'accept *:*') + exit_descriptor = RelayDescriptor(exit_descriptor) + + downloader_mock().get_server_descriptors().run.return_value = [ + exit_descriptor, + RelayDescriptor.create(), # non-exit + exit_descriptor, + exit_descriptor, + ] + + import tor_descriptors + + self.assertEqual(EXPECTED_TOR_DESCRIPTORS, stdout_mock.getvalue()) def test_utilities(self): pass diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py deleted file mode 100644 index e2b621e8..00000000 --- a/test/unit/tutorial.py +++ /dev/null @@ -1,74 +0,0 @@ -""" -Tests for the examples given in stem's tutorial. -""" - -import io -import unittest - -import stem.descriptor.remote - -from unittest.mock import patch - -from stem.descriptor.server_descriptor import RelayDescriptor - -MIRROR_MIRROR_OUTPUT = """\ -1. speedyexit (102.13 KB/s) -2. speedyexit (102.13 KB/s) -3. speedyexit (102.13 KB/s) -""" - - -class TestTutorial(unittest.TestCase): - def tearDown(self): - # Ensure we don't cache a Mock object as our downloader. Otherwise future - # tests will understandably be very sad. :P - - stem.descriptor.remote.SINGLETON_DOWNLOADER = None - - @patch('sys.stdout', new_callable = io.StringIO) - @patch('stem.descriptor.remote.DescriptorDownloader') - def test_mirror_mirror_on_the_wall_5(self, downloader_mock, stdout_mock): - def tutorial_example(): - from stem.descriptor.remote import DescriptorDownloader - from stem.util import str_tools - - # provides a mapping of observed bandwidth to the relay nicknames - def get_bw_to_relay(): - bw_to_relay = {} - - downloader = DescriptorDownloader() - - try: - for desc in downloader.get_server_descriptors().run(): - if desc.exit_policy.is_exiting_allowed(): - bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) - except Exception as exc: - print('Unable to retrieve the server descriptors: %s' % exc) - - return bw_to_relay - - # prints the top fifteen relays - - bw_to_relay = get_bw_to_relay() - count = 1 - - for bw_value in sorted(bw_to_relay.keys(), reverse = True): - for nickname in bw_to_relay[bw_value]: - print('%i. %s (%s/s)' % (count, nickname, str_tools.size_label(bw_value, 2))) - count += 1 - - if count > 15: - return - - exit_descriptor = RelayDescriptor.content({'router': 'speedyexit 149.255.97.109 9001 0 0'}).replace(b'reject *:*', b'accept *:*') - exit_descriptor = RelayDescriptor(exit_descriptor) - - downloader_mock().get_server_descriptors().run.return_value = [ - exit_descriptor, - RelayDescriptor.create(), # non-exit - exit_descriptor, - exit_descriptor, - ] - - tutorial_example() - self.assertEqual(MIRROR_MIRROR_OUTPUT, stdout_mock.getvalue())

1 0

[stem/master] Drop exec_documentation_example helper
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 8f5cf5bf4a4226bc6ff532ef7f642dc39ee942d2 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 27 16:16:45 2020 -0700 Drop exec_documentation_example helper Previously tests used compile() to run our examples rather than adjusting our path. Both approaches work but what we have now is a tad simpler. --- test/unit/tutorial.py | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index 472285ad..f35a6b6d 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -3,11 +3,9 @@ Tests for the examples given in stem's tutorial. """ import io -import os import unittest import stem.descriptor.remote -import test from unittest.mock import Mock, patch @@ -15,7 +13,6 @@ from stem.control import Controller from stem.descriptor.router_status_entry import RouterStatusEntryV3 from stem.descriptor.networkstatus import NetworkStatusDocumentV3 from stem.descriptor.server_descriptor import RelayDescriptor -from stem.exit_policy import ExitPolicy OVER_THE_RIVER_OUTPUT = """\ * Connecting to tor @@ -31,14 +28,6 @@ MIRROR_MIRROR_OUTPUT = """\ """ -def exec_documentation_example(filename): - path = os.path.join(test.STEM_BASE, 'docs', '_static', 'example', filename) - - with open(path) as f: - code = compile(f.read(), path, 'exec') - exec(code) - - class TestTutorial(unittest.TestCase): def tearDown(self): # Ensure we don't cache a Mock object as our downloader. Otherwise future

1 0

[stem/master] Test descriptor_from_orport example
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 02ac67ca0b46ec1dcff0c5b0e9dcf4712a4fc238 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 28 16:32:14 2020 -0700 Test descriptor_from_orport example --- test/unit/examples.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/test/unit/examples.py b/test/unit/examples.py index aa1c25ce..af049f57 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -448,8 +448,18 @@ class TestExamples(unittest.TestCase): finally: sys.modules = original_modules - def test_descriptor_from_orport(self): - pass + @patch('stem.descriptor.remote.DescriptorDownloader') + @patch('sys.stdout', new_callable = io.StringIO) + def test_descriptor_from_orport(self, stdout_mock, downloader_mock): + downloader_mock().get_consensus.return_value = [ + RouterStatusEntryV3.create({ + 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', + }) + ] + + import descriptor_from_orport + + self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) @patch('stem.control.Controller.from_port', spec = Controller) @patch('sys.stdout', new_callable = io.StringIO)

1 0

[stem/master] Test custom_path_selection example
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit c01daf3be5be2906a4dfd0d85464dee9667d2d1a Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 28 16:25:46 2020 -0700 Test custom_path_selection example --- docs/_static/example/custom_path_selection.py | 4 ++-- test/unit/examples.py | 22 ++++++++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/_static/example/custom_path_selection.py b/docs/_static/example/custom_path_selection.py index d63a2069..551f7b2f 100644 --- a/docs/_static/example/custom_path_selection.py +++ b/docs/_static/example/custom_path_selection.py @@ -1,4 +1,4 @@ -import StringIO +import io import time import pycurl @@ -20,7 +20,7 @@ def query(url): Uses pycurl to fetch a site using the proxy on the SOCKS_PORT. """ - output = StringIO.StringIO() + output = io.StringIO() query = pycurl.Curl() query.setopt(pycurl.URL, url) diff --git a/test/unit/examples.py b/test/unit/examples.py index 1b85c297..aa1c25ce 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -427,8 +427,26 @@ class TestExamples(unittest.TestCase): self.assertEqual('found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n', stdout_mock.getvalue()) - def test_custom_path_selection(self): - pass + @patch('stem.control.Controller.from_port', spec = Controller) + @patch('sys.stdout', new_callable = io.StringIO) + def test_custom_path_selection(self, stdout_mock, from_port_mock): + original_modules = dict(sys.modules) + + try: + # pycurl mocked out so its query method returns an empty string + + sys.modules['pycurl'] = Mock() + + controller = from_port_mock().__enter__() + controller.get_network_statuses.return_value = [RouterStatusEntryV2.create({ + 'r': 'caerSidi p1aag7VwarGxqctS7/fS0y5FU+s oQZFLYe9e4A7bOkWKR7TaNxb0JE 2012-08-06 11:19:31 71.35.150.29 9001 0', + })] + + import custom_path_selection + + self.assertEqual("A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB => Request didn't have the right content\n", stdout_mock.getvalue()) + finally: + sys.modules = original_modules def test_descriptor_from_orport(self): pass

1 0

[stem/master] Test event_listening example
by atagar＠torproject.org 02 Oct '20

02 Oct '20

commit 4da373ca6994bf9954755ba5821fd4e39c507619 Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Sep 29 14:05:17 2020 -0700 Test event_listening example --- docs/_static/example/event_listening.py | 42 ++++++++++++++++----------------- test/unit/examples.py | 18 ++++++++++++-- 2 files changed, 37 insertions(+), 23 deletions(-) diff --git a/docs/_static/example/event_listening.py b/docs/_static/example/event_listening.py index ff8c1469..b808a977 100644 --- a/docs/_static/example/event_listening.py +++ b/docs/_static/example/event_listening.py @@ -7,21 +7,21 @@ from stem.util import str_tools # colors that curses can handle COLOR_LIST = { - "red": curses.COLOR_RED, - "green": curses.COLOR_GREEN, - "yellow": curses.COLOR_YELLOW, - "blue": curses.COLOR_BLUE, - "cyan": curses.COLOR_CYAN, - "magenta": curses.COLOR_MAGENTA, - "black": curses.COLOR_BLACK, - "white": curses.COLOR_WHITE, + 'red': curses.COLOR_RED, + 'green': curses.COLOR_GREEN, + 'yellow': curses.COLOR_YELLOW, + 'blue': curses.COLOR_BLUE, + 'cyan': curses.COLOR_CYAN, + 'magenta': curses.COLOR_MAGENTA, + 'black': curses.COLOR_BLACK, + 'white': curses.COLOR_WHITE, } GRAPH_WIDTH = 40 GRAPH_HEIGHT = 8 -DOWNLOAD_COLOR = "green" -UPLOAD_COLOR = "blue" +DOWNLOAD_COLOR = 'green' +UPLOAD_COLOR = 'blue' def main(): with Controller.from_port(port = 9051) as controller: @@ -74,10 +74,10 @@ def _render_graph(window, bandwidth_rates): # show the latest values at the top - label = "Downloaded (%s/s):" % str_tools.size_label(download_rates[0], 1) + label = 'Downloaded (%s/s):' % str_tools.size_label(download_rates[0], 1) window.addstr(0, 1, label, DOWNLOAD_COLOR, curses.A_BOLD) - label = "Uploaded (%s/s):" % str_tools.size_label(upload_rates[0], 1) + label = 'Uploaded (%s/s):' % str_tools.size_label(upload_rates[0], 1) window.addstr(0, GRAPH_WIDTH + 7, label, UPLOAD_COLOR, curses.A_BOLD) # draw the graph bounds in KB @@ -85,24 +85,24 @@ def _render_graph(window, bandwidth_rates): max_download_rate = max(download_rates) max_upload_rate = max(upload_rates) - window.addstr(1, 1, "%4i" % (max_download_rate / 1024), DOWNLOAD_COLOR) - window.addstr(GRAPH_HEIGHT, 1, " 0", DOWNLOAD_COLOR) + window.addstr(1, 1, '%4i' % (max_download_rate / 1024), DOWNLOAD_COLOR) + window.addstr(GRAPH_HEIGHT, 1, ' 0', DOWNLOAD_COLOR) - window.addstr(1, GRAPH_WIDTH + 7, "%4i" % (max_upload_rate / 1024), UPLOAD_COLOR) - window.addstr(GRAPH_HEIGHT, GRAPH_WIDTH + 7, " 0", UPLOAD_COLOR) + window.addstr(1, GRAPH_WIDTH + 7, '%4i' % (max_upload_rate / 1024), UPLOAD_COLOR) + window.addstr(GRAPH_HEIGHT, GRAPH_WIDTH + 7, ' 0', UPLOAD_COLOR) # draw the graph for col in range(GRAPH_WIDTH): col_height = GRAPH_HEIGHT * download_rates[col] / max(max_download_rate, 1) - for row in range(col_height): - window.addstr(GRAPH_HEIGHT - row, col + 6, " ", DOWNLOAD_COLOR, curses.A_STANDOUT) + for row in range(int(col_height)): + window.addstr(GRAPH_HEIGHT - row, col + 6, ' ', DOWNLOAD_COLOR, curses.A_STANDOUT) col_height = GRAPH_HEIGHT * upload_rates[col] / max(max_upload_rate, 1) - for row in range(col_height): - window.addstr(GRAPH_HEIGHT - row, col + GRAPH_WIDTH + 12, " ", UPLOAD_COLOR, curses.A_STANDOUT) + for row in range(int(col_height)): + window.addstr(GRAPH_HEIGHT - row, col + GRAPH_WIDTH + 12, ' ', UPLOAD_COLOR, curses.A_STANDOUT) window.refresh() @@ -154,7 +154,7 @@ class Window(object): if color is not None: if color not in self._colors: - recognized_colors = ", ".join(self._colors.keys()) + recognized_colors = ', '.join(self._colors.keys()) raise ValueError("The '%s' color isn't recognized: %s" % (color, recognized_colors)) attr |= self._colors[color] diff --git a/test/unit/examples.py b/test/unit/examples.py index 35aa80bb..d9a3f6fa 100644 --- a/test/unit/examples.py +++ b/test/unit/examples.py @@ -539,8 +539,22 @@ class TestExamples(unittest.TestCase): finally: sys.modules = original_modules - def test_event_listening(self): - pass + @patch('stem.control.Controller.from_port', spec = Controller) + def test_event_listening(self, from_port_mock): + # This is a lengthy example that's mostly curses. This is just a surface + # level test to check for syntax issues and such. + + original_modules = dict(sys.modules) + + try: + sys.modules['curses'] = Mock() + + import event_listening + + event_listening.main() + event_listening._render_graph(Mock(), [(0, 0)] * event_listening.GRAPH_WIDTH) + finally: + sys.modules = original_modules @patch('stem.control.Controller.from_port', spec = Controller) @patch('sys.stdout', new_callable = io.StringIO)

1 0