- tor-commits - lists.torproject.org

[stem/master] Moving descriptor contructor to mocking module
by atagar＠torproject.org 04 Aug '12

04 Aug '12

commit ff43d9e7ad306499dce6e20909d0ce2e842541b4 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 4 10:48:06 2012 -0700 Moving descriptor contructor to mocking module We'll need to construct server descriptors in both their unit tests and when testing the exporter. The mocking module is both for function mocking and creating mock objects so this is the perfect place for it. I might move the extrainfo descriptor constructer here later if it seems useful. Personally I'm finding the current exporter tests and mocking changes very confusing so reverting the mocking changes and writing some simpler tests. --- test/mocking.py | 104 +++++++++++++++++------ test/unit/descriptor/server_descriptor.py | 129 ++++++++--------------------- 2 files changed, 110 insertions(+), 123 deletions(-) diff --git a/test/mocking.py b/test/mocking.py index 49b8c14..1deaf57 100644 --- a/test/mocking.py +++ b/test/mocking.py @@ -23,6 +23,7 @@ calling :func:`test.mocking.revert_mocking`. Instance Constructors get_message - stem.socket.ControlMessage get_protocolinfo_response - stem.response.protocolinfo.ProtocolInfoResponse + get_server_descriptor - text for a tor server descriptor """ import inspect @@ -45,54 +46,63 @@ MOCK_STATE = {} BUILTIN_TYPE = type(open) +CRYPTO_BLOB = """ +MIGJAoGBAJv5IIWQ+WDWYUdyA/0L8qbIkEVH/cwryZWoIaPAzINfrw1WfNZGtBmg +skFtXhOHHqTRN4GPPrZsAIUOQGzQtGb66IQgT4tO/pj+P6QmSCCdTfhvGfgTCsC+ +WPi4Fl2qryzTb3QO5r5x7T8OsG2IBUET1bLQzmtbC560SYR49IvVAgMBAAE= +""" + +RELAY_DESCRIPTOR_ATTR = ( + ("router", "caerSidi 71.35.133.197 9001 0 0"), + ("published", "2012-03-01 17:15:27"), + ("bandwidth", "153600 256000 104590"), + ("reject", "*:*"), + ("onion-key", "\n-----BEGIN RSA PUBLIC KEY-----%s-----END RSA PUBLIC KEY-----" % CRYPTO_BLOB), + ("signing-key", "\n-----BEGIN RSA PUBLIC KEY-----%s-----END RSA PUBLIC KEY-----" % CRYPTO_BLOB), + ("router-signature", "\n-----BEGIN SIGNATURE-----%s-----END SIGNATURE-----" % CRYPTO_BLOB), +) + +BRIDGE_DESCRIPTOR_ATTR = ( + ("router", "Unnamed 10.45.227.253 9001 0 0"), + ("router-digest", "006FD96BA35E7785A6A3B8B75FE2E2435A13BDB4"), + ("published", "2012-03-22 17:34:38"), + ("bandwidth", "409600 819200 5120"), + ("reject", "*:*"), +) + def no_op(): def _no_op(*args): pass return _no_op def return_value(value): - def _return_value(*args, **kwargs): - return value + def _return_value(*args): return value return _return_value def return_true(): return return_value(True) def return_false(): return return_value(False) def return_none(): return return_value(None) -def return_for_args(args_to_return_value, kwarg_type=None, default=None): +def return_for_args(args_to_return_value, default = None): """ Returns a value if the arguments to it match something in a given - 'argument => return value' mapping. In the case of keyword arguments, - a type must be specified so _return_value can check these arguments as - well. Otherwise, a default function is called with the arguments. + 'argument => return value' mapping. Otherwise, a default function + is called with the arguments. :param dict args_to_return_value: mapping of arguments to the value we should provide - :param object kwarg_type: type of kwarg mapping to be used in unwraping these arguments. - Though a dictionary would be the obvious choice, mapping expected keyword - arguments and their values in the keys of args_to_return_value would result - in unhashable types. Instead, a named tuple may be used and kwarg_type - provides the type of the named tuple so it may be parsed. - See test/unit/descriptor/export.py for an example. :param functor default: returns the value of this function if the args don't match something that we have, we raise a ValueError by default """ - def _return_value(*args, **kwargs): - # First handle the case in which we aren't expecting keyword args. - if kwarg_type == None: - argument = args + def _return_value(*args): + if args in args_to_return_value: + return args_to_return_value[args] + elif default is None: + arg_label = ", ".join([str(v) for v in args]) + raise ValueError("Unrecognized argument sent for return_for_args(): %s" % arg_label) else: - argument = args + (kwarg_type(**kwargs),) - - try: - return args_to_return_value[argument] - except KeyError: - if default is None: - arg_label = ", ".join(map(str, argument)) - raise ValueError("Unrecognized argument sent for return_for_args(): %s" % arg_label) - else: - return default(args) + return default(args) return _return_value - + def raise_exception(exception): def _raise(*args): raise exception return _raise @@ -135,7 +145,7 @@ def mock(target, mock_call, target_module=None): target_function = target.__name__ MOCK_STATE[mocking_id] = (target_module, target_function, target) - mock_wrapper = lambda *args, **kwargs: mock_call(*args, **kwargs) + mock_wrapper = lambda *args: mock_call(*args) mock_wrapper.__dict__["mock_id"] = mocking_id # mocks the function with this wrapper @@ -292,3 +302,41 @@ def get_protocolinfo_response(**attributes): return protocolinfo_response +def get_server_descriptor(attr = None, exclude = None, is_bridge = False): + """ + Constructs a minimal server descriptor with the given attributes. + + :param dict attr: keyword/value mappings to be included in the descriptor + :param list exclude: mandatory keywords to exclude from the descriptor + :param bool is_bridge: minimal descriptor is for a bridge if True, relay otherwise + + :returns: str with customized descriptor content + """ + + descriptor_lines = [] + if attr is None: attr = {} + if exclude is None: exclude = [] + desc_attr = BRIDGE_DESCRIPTOR_ATTR if is_bridge else RELAY_DESCRIPTOR_ATTR + attr = dict(attr) # shallow copy since we're destructive + + for keyword, value in desc_attr: + if keyword in exclude: continue + elif keyword in attr: + value = attr[keyword] + del attr[keyword] + + # if this is the last entry then we should dump in any unused attributes + if not is_bridge and keyword == "router-signature": + for attr_keyword, attr_value in attr.items(): + descriptor_lines.append("%s %s" % (attr_keyword, attr_value)) + + descriptor_lines.append("%s %s" % (keyword, value)) + + # bridges don't have a router-signature so simply append any extra attributes + # to the end + if is_bridge: + for attr_keyword, attr_value in attr.items(): + descriptor_lines.append("%s %s" % (attr_keyword, attr_value)) + + return "\n".join(descriptor_lines) + diff --git a/test/unit/descriptor/server_descriptor.py b/test/unit/descriptor/server_descriptor.py index 2e642af..902154d 100644 --- a/test/unit/descriptor/server_descriptor.py +++ b/test/unit/descriptor/server_descriptor.py @@ -10,68 +10,7 @@ import stem.prereq import stem.descriptor.server_descriptor from stem.descriptor.server_descriptor import RelayDescriptor, BridgeDescriptor import test.runner - -CRYPTO_BLOB = """ -MIGJAoGBAJv5IIWQ+WDWYUdyA/0L8qbIkEVH/cwryZWoIaPAzINfrw1WfNZGtBmg -skFtXhOHHqTRN4GPPrZsAIUOQGzQtGb66IQgT4tO/pj+P6QmSCCdTfhvGfgTCsC+ -WPi4Fl2qryzTb3QO5r5x7T8OsG2IBUET1bLQzmtbC560SYR49IvVAgMBAAE= -""" - -RELAY_DESCRIPTOR_ATTR = ( - ("router", "caerSidi 71.35.133.197 9001 0 0"), - ("published", "2012-03-01 17:15:27"), - ("bandwidth", "153600 256000 104590"), - ("reject", "*:*"), - ("onion-key", "\n-----BEGIN RSA PUBLIC KEY-----%s-----END RSA PUBLIC KEY-----" % CRYPTO_BLOB), - ("signing-key", "\n-----BEGIN RSA PUBLIC KEY-----%s-----END RSA PUBLIC KEY-----" % CRYPTO_BLOB), - ("router-signature", "\n-----BEGIN SIGNATURE-----%s-----END SIGNATURE-----" % CRYPTO_BLOB), -) - -BRIDGE_DESCRIPTOR_ATTR = ( - ("router", "Unnamed 10.45.227.253 9001 0 0"), - ("router-digest", "006FD96BA35E7785A6A3B8B75FE2E2435A13BDB4"), - ("published", "2012-03-22 17:34:38"), - ("bandwidth", "409600 819200 5120"), - ("reject", "*:*"), -) - -def _make_descriptor(attr = None, exclude = None, is_bridge = False): - """ - Constructs a minimal server descriptor with the given attributes. - - :param dict attr: keyword/value mappings to be included in the descriptor - :param list exclude: mandatory keywords to exclude from the descriptor - :param bool is_bridge: minimal descriptor is for a bridge if True, relay otherwise - - :returns: str with customized descriptor content - """ - - descriptor_lines = [] - if attr is None: attr = {} - if exclude is None: exclude = [] - desc_attr = BRIDGE_DESCRIPTOR_ATTR if is_bridge else RELAY_DESCRIPTOR_ATTR - attr = dict(attr) # shallow copy since we're destructive - - for keyword, value in desc_attr: - if keyword in exclude: continue - elif keyword in attr: - value = attr[keyword] - del attr[keyword] - - # if this is the last entry then we should dump in any unused attributes - if not is_bridge and keyword == "router-signature": - for attr_keyword, attr_value in attr.items(): - descriptor_lines.append("%s %s" % (attr_keyword, attr_value)) - - descriptor_lines.append("%s %s" % (keyword, value)) - - # bridges don't have a router-signature so simply append any extra attributes - # to the end - if is_bridge: - for attr_keyword, attr_value in attr.items(): - descriptor_lines.append("%s %s" % (attr_keyword, attr_value)) - - return "\n".join(descriptor_lines) +from test.mocking import get_server_descriptor, CRYPTO_BLOB class TestServerDescriptor(unittest.TestCase): def test_minimal_relay_descriptor(self): @@ -80,7 +19,7 @@ class TestServerDescriptor(unittest.TestCase): attributes. """ - desc_text = _make_descriptor() + desc_text = get_server_descriptor() desc = RelayDescriptor(desc_text) self.assertEquals("caerSidi", desc.nickname) @@ -95,7 +34,7 @@ class TestServerDescriptor(unittest.TestCase): Includes an 'opt <keyword> <value>' entry. """ - desc_text = _make_descriptor({"opt": "contact www.atagar.com/contact/"}) + desc_text = get_server_descriptor({"opt": "contact www.atagar.com/contact/"}) desc = RelayDescriptor(desc_text) self.assertEquals("www.atagar.com/contact/", desc.contact) @@ -104,7 +43,7 @@ class TestServerDescriptor(unittest.TestCase): Includes unrecognized content in the descriptor. """ - desc_text = _make_descriptor({"pepperjack": "is oh so tasty!"}) + desc_text = get_server_descriptor({"pepperjack": "is oh so tasty!"}) desc = RelayDescriptor(desc_text) self.assertEquals(["pepperjack is oh so tasty!"], desc.get_unrecognized_lines()) @@ -113,7 +52,7 @@ class TestServerDescriptor(unittest.TestCase): Includes a line prior to the 'router' entry. """ - desc_text = "hibernate 1\n" + _make_descriptor() + desc_text = "hibernate 1\n" + get_server_descriptor() self._expect_invalid_attr(desc_text) def test_trailing_line(self): @@ -121,7 +60,7 @@ class TestServerDescriptor(unittest.TestCase): Includes a line after the 'router-signature' entry. """ - desc_text = _make_descriptor() + "\nhibernate 1" + desc_text = get_server_descriptor() + "\nhibernate 1" self._expect_invalid_attr(desc_text) def test_nickname_missing(self): @@ -129,7 +68,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a malformed router entry. """ - desc_text = _make_descriptor({"router": " 71.35.133.197 9001 0 0"}) + desc_text = get_server_descriptor({"router": " 71.35.133.197 9001 0 0"}) self._expect_invalid_attr(desc_text, "nickname") def test_nickname_too_long(self): @@ -137,7 +76,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a nickname that is an invalid length. """ - desc_text = _make_descriptor({"router": "saberrider2008ReallyLongNickname 71.35.133.197 9001 0 0"}) + desc_text = get_server_descriptor({"router": "saberrider2008ReallyLongNickname 71.35.133.197 9001 0 0"}) self._expect_invalid_attr(desc_text, "nickname", "saberrider2008ReallyLongNickname") def test_nickname_invalid_char(self): @@ -145,7 +84,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with an invalid relay nickname. """ - desc_text = _make_descriptor({"router": "$aberrider2008 71.35.133.197 9001 0 0"}) + desc_text = get_server_descriptor({"router": "$aberrider2008 71.35.133.197 9001 0 0"}) self._expect_invalid_attr(desc_text, "nickname", "$aberrider2008") def test_address_malformed(self): @@ -153,7 +92,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with an invalid ip address. """ - desc_text = _make_descriptor({"router": "caerSidi 371.35.133.197 9001 0 0"}) + desc_text = get_server_descriptor({"router": "caerSidi 371.35.133.197 9001 0 0"}) self._expect_invalid_attr(desc_text, "address", "371.35.133.197") def test_port_too_high(self): @@ -161,7 +100,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with an ORPort that is too large. """ - desc_text = _make_descriptor({"router": "caerSidi 71.35.133.197 900001 0 0"}) + desc_text = get_server_descriptor({"router": "caerSidi 71.35.133.197 900001 0 0"}) self._expect_invalid_attr(desc_text, "or_port", 900001) def test_port_malformed(self): @@ -169,7 +108,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with an ORPort that isn't numeric. """ - desc_text = _make_descriptor({"router": "caerSidi 71.35.133.197 900a1 0 0"}) + desc_text = get_server_descriptor({"router": "caerSidi 71.35.133.197 900a1 0 0"}) self._expect_invalid_attr(desc_text, "or_port") def test_port_newline(self): @@ -177,7 +116,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a newline replacing the ORPort. """ - desc_text = _make_descriptor({"router": "caerSidi 71.35.133.197 \n 0 0"}) + desc_text = get_server_descriptor({"router": "caerSidi 71.35.133.197 \n 0 0"}) self._expect_invalid_attr(desc_text, "or_port") def test_platform_empty(self): @@ -185,7 +124,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with an empty platform entry. """ - desc_text = _make_descriptor({"platform": ""}) + desc_text = get_server_descriptor({"platform": ""}) desc = RelayDescriptor(desc_text, validate = False) self.assertEquals("", desc.platform) @@ -199,7 +138,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a protocols line without circuit versions. """ - desc_text = _make_descriptor({"opt": "protocols Link 1 2"}) + desc_text = get_server_descriptor({"opt": "protocols Link 1 2"}) self._expect_invalid_attr(desc_text, "circuit_protocols") def test_published_leap_year(self): @@ -208,10 +147,10 @@ class TestServerDescriptor(unittest.TestCase): invalid. """ - desc_text = _make_descriptor({"published": "2011-02-29 04:03:19"}) + desc_text = get_server_descriptor({"published": "2011-02-29 04:03:19"}) self._expect_invalid_attr(desc_text, "published") - desc_text = _make_descriptor({"published": "2012-02-29 04:03:19"}) + desc_text = get_server_descriptor({"published": "2012-02-29 04:03:19"}) expected_published = datetime.datetime(2012, 2, 29, 4, 3, 19) self.assertEquals(expected_published, RelayDescriptor(desc_text).published) @@ -220,7 +159,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a published entry without a time component. """ - desc_text = _make_descriptor({"published": "2012-01-01"}) + desc_text = get_server_descriptor({"published": "2012-01-01"}) self._expect_invalid_attr(desc_text, "published") def test_read_and_write_history(self): @@ -232,7 +171,7 @@ class TestServerDescriptor(unittest.TestCase): for field in ("read-history", "write-history"): value = "2005-12-16 18:00:48 (900 s) 81,8848,8927,8927,83,8848" - desc_text = _make_descriptor({"opt %s" % field: value}) + desc_text = get_server_descriptor({"opt %s" % field: value}) desc = RelayDescriptor(desc_text) if field == "read-history": @@ -253,7 +192,7 @@ class TestServerDescriptor(unittest.TestCase): """ value = "2005-12-17 01:23:11 (900 s) " - desc_text = _make_descriptor({"opt read-history": value}) + desc_text = get_server_descriptor({"opt read-history": value}) desc = RelayDescriptor(desc_text) self.assertEquals(datetime.datetime(2005, 12, 17, 1, 23, 11), desc.read_history_end) self.assertEquals(900, desc.read_history_interval) @@ -265,7 +204,7 @@ class TestServerDescriptor(unittest.TestCase): """ desc_text = "@pepperjack very tasty\n@mushrooms not so much\n" - desc_text += _make_descriptor() + desc_text += get_server_descriptor() desc_text += "\ntrailing text that should be ignored, ho hum" # running parse_file should provide an iterator with a single descriptor @@ -285,7 +224,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs with a field appearing twice. """ - desc_text = _make_descriptor({"<replace>": ""}) + desc_text = get_server_descriptor({"<replace>": ""}) desc_text = desc_text.replace("<replace>", "contact foo\ncontact bar") self._expect_invalid_attr(desc_text, "contact", "foo") @@ -295,7 +234,7 @@ class TestServerDescriptor(unittest.TestCase): """ for attr in stem.descriptor.server_descriptor.REQUIRED_FIELDS: - desc_text = _make_descriptor(exclude = [attr]) + desc_text = get_server_descriptor(exclude = [attr]) self.assertRaises(ValueError, RelayDescriptor, desc_text) # check that we can still construct it without validation @@ -319,7 +258,7 @@ class TestServerDescriptor(unittest.TestCase): return fingerprint = "4F0C 867D F0EF 6816 0568 C826 838F 482C EA7C FE44" - desc_text = _make_descriptor({"opt fingerprint": fingerprint}) + desc_text = get_server_descriptor({"opt fingerprint": fingerprint}) desc = RelayDescriptor(desc_text) self.assertEquals(fingerprint.replace(" ", ""), desc.fingerprint) @@ -334,7 +273,7 @@ class TestServerDescriptor(unittest.TestCase): return fingerprint = "4F0C 867D F0EF 6816 0568 C826 838F 482C EA7C FE45" - desc_text = _make_descriptor({"opt fingerprint": fingerprint}) + desc_text = get_server_descriptor({"opt fingerprint": fingerprint}) self._expect_invalid_attr(desc_text, "fingerprint", fingerprint.replace(" ", "")) def test_minimal_bridge_descriptor(self): @@ -342,7 +281,7 @@ class TestServerDescriptor(unittest.TestCase): Basic sanity check that we can parse a descriptor with minimal attributes. """ - desc_text = _make_descriptor(is_bridge = True) + desc_text = get_server_descriptor(is_bridge = True) desc = BridgeDescriptor(desc_text) self.assertEquals("Unnamed", desc.nickname) @@ -371,7 +310,7 @@ class TestServerDescriptor(unittest.TestCase): ] for attr in unsanitized_attr: - desc_text = _make_descriptor(attr, is_bridge = True) + desc_text = get_server_descriptor(attr, is_bridge = True) desc = BridgeDescriptor(desc_text) self.assertFalse(desc.is_scrubbed()) @@ -381,7 +320,7 @@ class TestServerDescriptor(unittest.TestCase): its unsanatized content. """ - desc_text = _make_descriptor({"router-digest": "006FD96BA35E7785A6A3B8B75FE2E2435A13BDB4"}) + desc_text = get_server_descriptor({"router-digest": "006FD96BA35E7785A6A3B8B75FE2E2435A13BDB4"}) desc = BridgeDescriptor(desc_text) self.assertFalse(desc.is_scrubbed()) @@ -393,13 +332,13 @@ class TestServerDescriptor(unittest.TestCase): # checks with valid content router_digest = "068A2E28D4C934D9490303B7A645BA068DCA0504" - desc_text = _make_descriptor({"router-digest": router_digest}, is_bridge = True) + desc_text = get_server_descriptor({"router-digest": router_digest}, is_bridge = True) desc = BridgeDescriptor(desc_text) self.assertEquals(router_digest, desc.digest()) # checks when missing - desc_text = _make_descriptor(exclude = ["router-digest"], is_bridge = True) + desc_text = get_server_descriptor(exclude = ["router-digest"], is_bridge = True) self.assertRaises(ValueError, BridgeDescriptor, desc_text) # check that we can still construct it without validation @@ -416,7 +355,7 @@ class TestServerDescriptor(unittest.TestCase): ) for value in test_values: - desc_text = _make_descriptor({"router-digest": value}, is_bridge = True) + desc_text = get_server_descriptor({"router-digest": value}, is_bridge = True) self.assertRaises(ValueError, BridgeDescriptor, desc_text) desc = BridgeDescriptor(desc_text, validate = False) @@ -427,7 +366,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs a bridge descriptor with a sanatized IPv4 or-address entry. """ - desc_text = _make_descriptor({"or-address": "10.45.227.253:9001"}, is_bridge = True) + desc_text = get_server_descriptor({"or-address": "10.45.227.253:9001"}, is_bridge = True) desc = BridgeDescriptor(desc_text) self.assertEquals([("10.45.227.253", 9001, False)], desc.address_alt) @@ -436,7 +375,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs a bridge descriptor with a sanatized IPv6 or-address entry. """ - desc_text = _make_descriptor({"or-address": "[fd9f:2e19:3bcf::02:9970]:9001"}, is_bridge = True) + desc_text = get_server_descriptor({"or-address": "[fd9f:2e19:3bcf::02:9970]:9001"}, is_bridge = True) desc = BridgeDescriptor(desc_text) self.assertEquals([("fd9f:2e19:3bcf::02:9970", 9001, True)], desc.address_alt) @@ -445,7 +384,7 @@ class TestServerDescriptor(unittest.TestCase): Constructs a bridge descriptor with multiple or-address entries and multiple ports. """ - desc_text = "\n".join((_make_descriptor(is_bridge = True), + desc_text = "\n".join((get_server_descriptor(is_bridge = True), "or-address 10.45.227.253:9001,9005,80", "or-address [fd9f:2e19:3bcf::02:9970]:443"))

1 0

[stem/master] CSV export functionality for tor descriptors
by atagar＠torproject.org 04 Aug '12

04 Aug '12

commit f7157ae4f576acb1b90e458f479e2a820aefbe86 Merge: 051ed27 7022021 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 4 12:18:56 2012 -0700 CSV export functionality for tor descriptors run_tests.py | 2 + stem/descriptor/__init__.py | 2 +- stem/descriptor/export.py | 89 ++++++++++++++++++++ test/mocking.py | 63 ++++++++++++++ test/unit/descriptor/__init__.py | 2 +- test/unit/descriptor/export.py | 93 +++++++++++++++++++++ test/unit/descriptor/server_descriptor.py | 129 ++++++++--------------------- 7 files changed, 283 insertions(+), 97 deletions(-)

1 0

[stem/master] Submitting for code review.
by atagar＠torproject.org 04 Aug '12

04 Aug '12

commit bb0dcfc7fdf9303251dbe7304005d349f9956fd6 Author: Erik <eislo(a)wesleyan.edu> Date: Wed Aug 1 16:40:56 2012 -0400 Submitting for code review. --- stem/descriptor/export.py | 16 ++++++++-------- test/mocking.py | 5 +++++ test/unit/descriptor/export.py | 9 --------- 3 files changed, 13 insertions(+), 17 deletions(-) diff --git a/stem/descriptor/export.py b/stem/descriptor/export.py index 11b4918..89a5644 100644 --- a/stem/descriptor/export.py +++ b/stem/descriptor/export.py @@ -6,7 +6,7 @@ def export_csv(descriptor, include_fields=(), exclude_fields=()): Takes a single descriptor object, puts it in a list, and passes it to descriptors_csv_exp to build a csv. - :param object descriptor: single descriptor whose. + :param object descriptor: single descriptor whose attributes will be returned as a string. :param list include_fields: list of attribute fields to include in the csv string. :param list exclude_fields: list of attribute fields to exclude from csv string. @@ -25,8 +25,7 @@ def export_csvs(descriptors, include_fields=[], exclude_fields=[], header=False) :param list descrs: List of descriptor objects whose attributes will be written. :param list include_fields: list of attribute fields to include in the csv string. :param list exclude_fields: list of attribute fields to exclude from csv string. - :param bool header: whether or not a header is requested; probably won't be - needed outside of csv_file_exp's call of this function. + :param bool header: whether or not a header is requested. :returns: csv string with one descriptor per line and one attribute per cell. :raises: ValueError if more than one descriptor type (e.g. server_descriptor, @@ -39,7 +38,7 @@ def export_csvs(descriptors, include_fields=[], exclude_fields=[], header=False) first = True for desc in descriptors: - import sys + #umport sys attr = vars(desc) # Defining incl_fields and the dwriter object requires having access @@ -90,8 +89,9 @@ def export_csv_file(descriptors, document, include_fields=(), exclude_fields=(), :param list include_fields: list of attribute fields to include in the csv line. :param list exclude_fields: list of attribute fields to exclude from csv line. """ - if not hasattr(document, 'write'): - raise AttributeError("Provided %r object does not have a write method." % document) - else: - document.write(export_csvs(descriptors, include_fields=include_fields, exclude_fields=exclude_fields, header=header)) + try: + document.write(export_csvs(descriptors, include_fields=include_fields, exclude_fields=exclude_fields, header=header)) + except AttributeError: + print "Provided %r object does not have a write() method." % document + raise diff --git a/test/mocking.py b/test/mocking.py index 071514d..49b8c14 100644 --- a/test/mocking.py +++ b/test/mocking.py @@ -67,6 +67,11 @@ def return_for_args(args_to_return_value, kwarg_type=None, default=None): :param dict args_to_return_value: mapping of arguments to the value we should provide :param object kwarg_type: type of kwarg mapping to be used in unwraping these arguments. + Though a dictionary would be the obvious choice, mapping expected keyword + arguments and their values in the keys of args_to_return_value would result + in unhashable types. Instead, a named tuple may be used and kwarg_type + provides the type of the named tuple so it may be parsed. + See test/unit/descriptor/export.py for an example. :param functor default: returns the value of this function if the args don't match something that we have, we raise a ValueError by default """ diff --git a/test/unit/descriptor/export.py b/test/unit/descriptor/export.py index d006e85..12d5ed3 100644 --- a/test/unit/descriptor/export.py +++ b/test/unit/descriptor/export.py @@ -82,10 +82,6 @@ class TestExport(unittest.TestCase): """ # Single descriptor - #print "Type descriptor: %s" % type(descriptor) - #print "Type SINGLE_ALL: %s" % type(SINGLE_ALL) - #print SINGLE_ALL - #print "Type fn Call: %s" % type(export.export_csvs([descriptor])) self.assertEquals(SINGLE_ALL + "\r\n", export.export_csvs([descriptor])) self.assertEqual(SINGLE_PART + "\r\n", export.export_csvs([descriptor], include_fields=['address', 'exit_policy'])) @@ -95,14 +91,9 @@ class TestExport(unittest.TestCase): include_fields=['address', 'exit_policy', 'fingerprint'], exclude_fields=['fingerprint'])) # Multiple descriptors - #print "Sample Call: \n %s \n\n" % export.export_csvs([descriptor, descriptor2], header=True) - self.assertEqual(DOUBLE_ALL, export.export_csvs([descriptor, descriptor2])) self.assertEqual(DOUBLE_PART, export.export_csvs([descriptor, descriptor2], include_fields=['address', 'exit_policy'])) - #print export.export_csvs([descriptor, descriptor2], exclude_fields=['onion_key', 'fingerprint']) - #print "\n %s" % descriptor2.__dict__ - self.assertEqual(DOUBLE_PART2, export.export_csvs([descriptor, descriptor2], exclude_fields=['onion_key', 'fingerprint'])) self.assertEqual(DOUBLE_PART, export.export_csvs([descriptor, descriptor2],

1 0

[stem/master] Revising descriptor exporter and associated tests
by atagar＠torproject.org 04 Aug '12

04 Aug '12

commit 7022021c4207a0066cb93261629f2ba020d307f6 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 4 12:13:47 2012 -0700 Revising descriptor exporter and associated tests Several changes for the prior csv export functionality, especially its tests. Most notably this includes... * rewrite of the tests to be simpler and break down by test cases * newline breaks rather than windows style '\r\n' * excluding private attributes (attributes that start with an underscore) * writing directly to a file in export_csv_file() rather than buffering to a string first * general refactoring to hopefully improve readability --- run_tests.py | 6 +- stem/descriptor/__init__.py | 2 +- stem/descriptor/export.py | 148 ++++++++++++++---------------- test/unit/descriptor/__init__.py | 2 +- test/unit/descriptor/export.py | 189 ++++++++++++++------------------------ 5 files changed, 142 insertions(+), 205 deletions(-) diff --git a/run_tests.py b/run_tests.py index bed8e50..4ad551a 100755 --- a/run_tests.py +++ b/run_tests.py @@ -16,6 +16,7 @@ import test.output import test.runner import test.check_whitespace import test.unit.connection.authentication +import test.unit.descriptor.export import test.unit.descriptor.reader import test.unit.descriptor.server_descriptor import test.unit.descriptor.extrainfo_descriptor @@ -50,8 +51,6 @@ import test.integ.util.proc import test.integ.util.system import test.integ.process import test.integ.version -#TODO move this by other descriptor tests -import test.unit.descriptor.export import stem.prereq import stem.util.conf @@ -109,6 +108,7 @@ UNIT_TESTS = ( test.unit.util.proc.TestProc, test.unit.util.system.TestSystem, test.unit.util.tor_tools.TestTorTools, + test.unit.descriptor.export.TestExport, test.unit.descriptor.reader.TestDescriptorReader, test.unit.descriptor.server_descriptor.TestServerDescriptor, test.unit.descriptor.extrainfo_descriptor.TestExtraInfoDescriptor, @@ -123,9 +123,7 @@ UNIT_TESTS = ( test.unit.response.protocolinfo.TestProtocolInfoResponse, test.unit.response.authchallenge.TestAuthChallengeResponse, test.unit.connection.authentication.TestAuthenticate, - test.unit.descriptor.export.TestExport, ) -# TODO move export test to proper location INTEG_TESTS = ( test.integ.util.conf.TestConf, diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index bb6f874..45cd016 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -13,7 +13,7 @@ Package for parsing and processing descriptor data. """ __all__ = [ - "descriptor", + "export", "reader", "extrainfo_descriptor", "server_descriptor", diff --git a/stem/descriptor/export.py b/stem/descriptor/export.py index 89a5644..16a148d 100644 --- a/stem/descriptor/export.py +++ b/stem/descriptor/export.py @@ -1,97 +1,89 @@ -import os, csv, sets, cStringIO +""" +Utilities for exporting descriptors to other formats. +""" +import csv +import cStringIO -def export_csv(descriptor, include_fields=(), exclude_fields=()): +import stem.descriptor + +class _ExportDialect(csv.excel): + lineterminator = '\n' + +def export_csv(descriptors, included_fields = (), excluded_fields = (), header = True): """ - Takes a single descriptor object, puts it in a list, and passes it to - descriptors_csv_exp to build a csv. + Provides a newline separated CSV for one or more descriptors. If simply + provided with descriptors then the CSV contains all of its attributes, + labelled with a header row. Either 'included_fields' or 'excluded_fields' can + be used for more granular control over its attributes and the order. - :param object descriptor: single descriptor whose attributes will be returned as a string. - :param list include_fields: list of attribute fields to include in the csv string. - :param list exclude_fields: list of attribute fields to exclude from csv string. + :param Descriptor,list descriptors: descriptor or list of descriptors to be exported + :param list included_fields: attributes to include in the csv + :param list excluded_fields: attributes to exclude from the csv + :param bool header: if True then the first line will be a comma separated list of the attribute names - :returns: single csv line as a string with one descriptor attribute per cell. + :returns: str of the CSV for the descriptors, one per line + :raises: ValueError if descriptors contain more than one descriptor type """ - descr = (descriptor,) - return export_csvs(descr, include_fields=include_fields, exclude_fields=exclude_fields) + output_buffer = cStringIO.StringIO() + export_csv_file(output_buffer, descriptors, included_fields, excluded_fields, header) + return output_buffer.getvalue() - -def export_csvs(descriptors, include_fields=[], exclude_fields=[], header=False): +def export_csv_file(output_file, descriptors, included_fields = (), excluded_fields = (), header = True): """ - Takes an iterable of descriptors, returns a string with one line per descriptor - where each line is a comma separated list of descriptor attributes. + Similar to :func:`stem.descriptor.export.export_csv`, except that the CSV is + written directly to a file. - :param list descrs: List of descriptor objects whose attributes will be written. - :param list include_fields: list of attribute fields to include in the csv string. - :param list exclude_fields: list of attribute fields to exclude from csv string. - :param bool header: whether or not a header is requested. + :param file output_file: file to be written to + :param Descriptor,list descriptors: descriptor or list of descriptors to be exported + :param list included_fields: attributes to include in the csv + :param list excluded_fields: attributes to exclude from the csv + :param bool header: if True then the first line will be a comma separated list of the attribute names - :returns: csv string with one descriptor per line and one attribute per cell. - :raises: ValueError if more than one descriptor type (e.g. server_descriptor, - extrainfo_descriptor) is provided in the iterable. + :returns: str of the CSV for the descriptors, one per line + :raises: ValueError if descriptors contain more than one descriptor type """ - # Need a file object to write to with DictWriter. - temp_file = cStringIO.StringIO() + if isinstance(descriptors, stem.descriptor.Descriptor): + descriptors = (descriptors,) - first = True + if not descriptors: + return - for desc in descriptors: - #umport sys - attr = vars(desc) - - # Defining incl_fields and the dwriter object requires having access - # to a descriptor object. - if first: - # All descriptor objects should be of the same type - # (i.e. server_descriptor.RelayDesrciptor) - desc_type = type(desc) - - # define incl_fields, 4 cases where final case is incl_fields already - # defined and excl_fields left blank, so no action is necessary. - if not include_fields and exclude_fields: - incl = set(attr.keys()) - include_fields = list(incl.difference(exclude_fields)) - - elif not include_fields and not exclude_fields: - include_fields = attr.keys() - - elif include_fields and exclude_fields: - incl = set(include_fields) - include_fields = list(incl.difference(exclude_fields)) - - dwriter = csv.DictWriter(temp_file, include_fields, extrasaction='ignore') - - if header: - dwriter.writeheader() - first = False - - if desc_type == type(desc): - dwriter.writerow(attr) - else: - raise ValueError('More than one descriptor type provided. Started with a %s, and just got a %s' % (desc_type, type(desc))) + descriptor_type = type(descriptors[0]) + descriptor_type_label = descriptor_type.__name__ + included_fields = list(included_fields) - return temp_file.getvalue() - # cStringIO files are closed automatically when the current scope is exited. - -def export_csv_file(descriptors, document, include_fields=(), exclude_fields=(), header=True): - """ - Writes descriptor attributes to a csv file on disk. + # If the user didn't specify the fields to include then export everything, + # ordered alphabetically. If they did specify fields then make sure that + # they exist. - Calls get_csv_lines with the given argument, then writes the returned string - to a file location specified by document_location. - Precondition that param document has a 'write' attribute. + desc_attr = sorted(vars(descriptors[0]).keys()) - :param list descriptors: descriptor objects with attributes to export as csv file. - :param object document: File object to be written to. - :param bool header: defaults to true, determines if document will have a header row. - :param list include_fields: list of attribute fields to include in the csv line. - :param list exclude_fields: list of attribute fields to exclude from csv line. - """ + if included_fields: + for field in included_fields: + if not field in desc_attr: + raise ValueError("%s does not have a '%s' attribute, valid fields are: %s" % (descriptor_type_label, field, ", ".join(desc_attr))) + else: + included_fields = [attr for attr in desc_attr if not attr.startswith('_')] + + for field in excluded_fields: + try: + included_fields.remove(field) + except ValueError: + pass + + writer = csv.DictWriter(output_file, included_fields, dialect = _ExportDialect(), extrasaction='ignore') + + if header: + writer.writeheader() - try: - document.write(export_csvs(descriptors, include_fields=include_fields, exclude_fields=exclude_fields, header=header)) - except AttributeError: - print "Provided %r object does not have a write() method." % document - raise + for desc in descriptors: + if not isinstance(desc, stem.descriptor.Descriptor): + raise ValueError("Unable to export a descriptor CSV since %s is not a descriptor." % type(desc).__name__) + elif descriptor_type != type(desc): + raise ValueError("To export a descriptor CSV all of the descriptors must be of the same type. First descriptor was a %s but we later got a %s." % (descriptor_type_label, type(desc))) + + writer.writerow(vars(desc)) + diff --git a/test/unit/descriptor/__init__.py b/test/unit/descriptor/__init__.py index cf4fceb..1837a07 100644 --- a/test/unit/descriptor/__init__.py +++ b/test/unit/descriptor/__init__.py @@ -2,5 +2,5 @@ Unit tests for stem.descriptor. """ -__all__ = ["reader", "extrainfo_descriptor", "server_descriptor"] +__all__ = ["export", "reader", "extrainfo_descriptor", "server_descriptor"] diff --git a/test/unit/descriptor/export.py b/test/unit/descriptor/export.py index 12d5ed3..6ef52cb 100644 --- a/test/unit/descriptor/export.py +++ b/test/unit/descriptor/export.py @@ -1,146 +1,93 @@ """ -Unit testing code for the stem.descriptor.export module +Unit tests for stem.descriptor.export. """ -import unittest -import stem.descriptor.export as export -import test.mocking as mocking - -from collections import namedtuple -import stem.descriptor as desc -import cStringIO - -# Create descriptor objects. -DESCR_DICT = {'average_bandwidth': 5242880, 'onion_key': 'RSA PUB = JAIK', 'address': '79.139.135.90', '_digest': None, 'exit_policy': ['reject *:*'], 'fingerprint': 'AAAAAAAAAAAAAAAAAAA'} -DESCR2_DICT = {'average_bandwidth': 5555555, 'onion_key': 'RSA PUB = GOUS', 'address': '100.1.1.1', '_digest': None, 'exit_policy': ['reject *:*'], 'fingerprint': 'BBBBBBBBBBBBBBBBBBBBB'} -DESCR3_DICT = {'bandwidth':12345,'average_bandwidth': 6666666, 'address': '101.0.0.1','extra_info':None} -RAW = 'router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon' - -descriptor = desc.Descriptor(RAW) -descriptor.__dict__.update(DESCR_DICT) - -descriptor2 = desc.Descriptor(RAW) -descriptor2.__dict__.update(DESCR2_DICT) - -descriptor3 = desc.server_descriptor.RelayDescriptor(RAW, validate=False) -descriptor3.__dict__.update(DESCR3_DICT) - -# Expected return csv strings. -SINGLE_ALL = '5242880,RSA PUB = JAIK,AAAAAAAAAAAAAAAAAAA,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],79.139.135.90,' -SINGLE_PART = '79.139.135.90,[\'reject *:*\']' -SINGLE_PART2 = '5242880,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],79.139.135.90,' -SINGLE_PART3 = '79.139.135.90,AAAAAAAAAAAAAAAAAAA' -DOUBLE_ALL = '5242880,RSA PUB = JAIK,AAAAAAAAAAAAAAAAAAA,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],79.139.135.90,\r\n5555555,RSA PUB = GOUS,BBBBBBBBBBBBBBBBBBBBB,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],100.1.1.1,\r\n' -DOUBLE_PART = '79.139.135.90,[\'reject *:*\']\r\n100.1.1.1,[\'reject *:*\']\r\n' -DOUBLE_PART2 = '5242880,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],79.139.135.90,\r\n5555555,,router TORsinn3r 46.17.96.217 9001 0 0 platform Tor 0.2.3.19-rc on Linux bandwidth 4 5 6 ...andonandon,[\'reject *:*\'],100.1.1.1,\r\n' +import StringIO +import unittest -SINGLE_ALL_HEAD = 'average_bandwidth,onion_key,fingerprint,_digest,_raw_contents,exit_policy,address,_path\r\n' + SINGLE_ALL + '\r\n' -SINGLE_PART3_HEAD = 'address,fingerprint\r\n' + SINGLE_PART3 -DOUBLE_ALL_HEAD = 'average_bandwidth,onion_key,fingerprint,_digest,_raw_contents,exit_policy,address,_path\r\n' + DOUBLE_ALL -DOUBLE_PART_HEAD = 'address,exit_policy\r\n' + DOUBLE_PART -DOUBLE_PART2_HEAD = 'average_bandwidth,_digest,_raw_contents,exit_policy,address,_path\r\n' + DOUBLE_PART2 +from stem.descriptor.export import export_csv, export_csv_file +from stem.descriptor.server_descriptor import RelayDescriptor, BridgeDescriptor +from test.mocking import get_server_descriptor class TestExport(unittest.TestCase): - def tearDown(self): - mocking.revert_mocking() - - def test_export_csv(self): + def test_minimal_descriptor(self): """ - Tests the export_csv function which takes a single descriptor object. + Exports a single minimal tor server descriptor. """ - Fields = namedtuple('Fields', 'include_fields exclude_fields') - # Descriptors must be an iterable - # named tuples replace dictionaries as dict keys must immutable. - ret_vals = {((descriptor,), Fields(include_fields=(), exclude_fields=())):SINGLE_ALL, - ((descriptor,), Fields(include_fields=('address', 'exit_policy'), - exclude_fields=())):SINGLE_PART, - ((descriptor,), Fields(include_fields=(), - exclude_fields=('onion_key', 'fingerprint'))):SINGLE_PART2, - ((descriptor,), Fields(include_fields=('address', 'exit_policy', 'fingerprint'), - exclude_fields=('fingerprint',))):SINGLE_PART, - ((descriptor,), Fields(include_fields=('address', 'fingerprint'), - exclude_fields=('_digest',))):SINGLE_PART3 - } - mocking.mock(export.export_csvs, mocking.return_for_args(ret_vals, kwarg_type=Fields)) + desc = RelayDescriptor(get_server_descriptor()) - # Used tuples for incl/exclude_fields for parameter matching with ret_vals dict. - self.assertEqual(SINGLE_ALL, export.export_csv(descriptor)) - self.assertEqual(SINGLE_PART, export.export_csv(descriptor, - include_fields=('address', 'exit_policy'))) - self.assertEqual(SINGLE_PART2, export.export_csv(descriptor, - exclude_fields=('onion_key', 'fingerprint'))) - self.assertEqual(SINGLE_PART, export.export_csv(descriptor, - include_fields=('address', 'exit_policy', 'fingerprint'), exclude_fields=('fingerprint',))) - self.assertEqual(SINGLE_PART3, export.export_csv(descriptor, - include_fields=('address', 'fingerprint'), exclude_fields=('_digest',))) - + desc_csv = export_csv(desc, included_fields = ('nickname', 'address', 'published'), header = False) + expected = "caerSidi,71.35.133.197,2012-03-01 17:15:27\n" + self.assertEquals(expected, desc_csv) + + desc_csv = export_csv(desc, included_fields = ('nickname', 'address', 'published'), header = True) + expected = "nickname,address,published\n" + expected + self.assertEquals(expected, desc_csv) - def test_export_csvs(self): + def test_multiple_descriptors(self): """ - Test the export_csvs function which takes a list of descriptor objects. + Exports multiple descriptors, making sure that we get them back in the same + order. """ - # Single descriptor - self.assertEquals(SINGLE_ALL + "\r\n", export.export_csvs([descriptor])) - self.assertEqual(SINGLE_PART + "\r\n", export.export_csvs([descriptor], - include_fields=['address', 'exit_policy'])) - self.assertEqual(SINGLE_PART2 + "\r\n", export.export_csvs([descriptor], - exclude_fields=['onion_key', 'fingerprint'])) - self.assertEqual(SINGLE_PART + "\r\n", export.export_csvs([descriptor], - include_fields=['address', 'exit_policy', 'fingerprint'], exclude_fields=['fingerprint'])) - - # Multiple descriptors - self.assertEqual(DOUBLE_ALL, export.export_csvs([descriptor, descriptor2])) - self.assertEqual(DOUBLE_PART, export.export_csvs([descriptor, descriptor2], - include_fields=['address', 'exit_policy'])) - self.assertEqual(DOUBLE_PART2, export.export_csvs([descriptor, descriptor2], - exclude_fields=['onion_key', 'fingerprint'])) - self.assertEqual(DOUBLE_PART, export.export_csvs([descriptor, descriptor2], - include_fields=['address', 'exit_policy', 'fingerprint'], exclude_fields=['fingerprint'])) + nicknames = ('relay1', 'relay3', 'relay2', 'caerSidi', 'zeus') + descriptors = [] - # Tests with headers - self.assertEqual(SINGLE_ALL_HEAD, export.export_csvs([descriptor], header=True)) - self.assertEqual(SINGLE_PART3_HEAD + "\r\n", export.export_csvs([descriptor], - include_fields=['address', 'fingerprint'], exclude_fields=['_digest'], header=True)) - self.assertEqual(DOUBLE_ALL_HEAD, export.export_csvs([descriptor, descriptor2], header=True)) - self.assertEqual(DOUBLE_PART_HEAD, export.export_csvs([descriptor, descriptor2], - include_fields=['address', 'exit_policy'], header=True)) - self.assertEqual(DOUBLE_PART2_HEAD, export.export_csvs([descriptor, descriptor2], - exclude_fields=['onion_key', 'fingerprint'], header=True)) + for nickname in nicknames: + router_line = "%s 71.35.133.197 9001 0 0" % nickname + descriptors.append(RelayDescriptor(get_server_descriptor({'router': router_line}))) - # Other tests - self.assertRaises(ValueError, export.export_csvs, [descriptor, descriptor3]) - self.assertRaises(ValueError, export.export_csvs, [descriptor, descriptor3], - include_fields=['onion_key', 'address', 'fingerprint'], exclude_fields=['onion_key']) - + expected = "\n".join(nicknames) + "\n" + self.assertEqual(expected, export_csv(descriptors, included_fields = ('nickname',), header = False)) - - def test_export_csv_file(self): + def test_file_output(self): """ - Tests the export_csv_file function. + Basic test for the export_csv_file() function, checking that it provides + the same output as export_csv(). """ - sample_csv_string = 'This, is, a, sample, string.\r\nline, two.\r\n' - sample_csv_string2 = 'Another, sample\r\n,, second,\r\n' - sample_file = cStringIO.StringIO() - # Must use named tuples again for ret_vals dictionary. - Fields = namedtuple('Fields', 'include_fields exclude_fields header') + desc = RelayDescriptor(get_server_descriptor()) + desc_csv = export_csv(desc) - ret_vals = {((descriptor,), Fields(include_fields=(), exclude_fields=(), header=True)):sample_csv_string, - ((descriptor,), Fields(include_fields=('address', 'onion_key'), exclude_fields=('address',), header=False)):sample_csv_string2} - # TODO Ask Danner: mock it once then do both tests (not including assertRaises), or do separate mockings. - # the latter requires that we still include empty incl_fields and excl_fields parameters instead of - # letting them default to []. Same for header. - mocking.mock(export.export_csvs, mocking.return_for_args(ret_vals, kwarg_type=Fields)) + csv_buffer = StringIO.StringIO() + export_csv_file(csv_buffer, desc) - export.export_csv_file((descriptor,), sample_file) - self.assertEqual(sample_csv_string, sample_file.getvalue()) + self.assertEqual(desc_csv, csv_buffer.getvalue()) + + def test_excludes_private_attr(self): + """ + Checks that the default attributes for our csv output doesn't include private fields. + """ - sample_file = cStringIO.StringIO() + desc = RelayDescriptor(get_server_descriptor()) + desc_csv = export_csv(desc) - export.export_csv_file((descriptor,), sample_file, include_fields=('address', 'onion_key'), exclude_fields=('address',), header=False) - self.assertEqual(sample_csv_string2, sample_file.getvalue()) + self.assertTrue(',signature' in desc_csv) + self.assertFalse(',_digest' in desc_csv) + self.assertFalse(',_annotation_lines' in desc_csv) + + def test_empty_input(self): + """ + Exercises when we don't provide any descriptors. + """ - # Make sure error is Raised when necessary. - self.assertRaises(AttributeError, export.export_csv_file, (descriptor,), sample_csv_string) + self.assertEquals("", export_csv([])) + + def test_invalid_attributes(self): + """ + Attempts to make a csv with attributes that don't exist. + """ + + desc = RelayDescriptor(get_server_descriptor()) + self.assertRaises(ValueError, export_csv, desc, ('nickname', 'blarg!')) + + def test_multiple_descriptor_types(self): + """ + Attempts to make a csv with multiple descriptor types. + """ + + server_desc = RelayDescriptor(get_server_descriptor()) + bridge_desc = BridgeDescriptor(get_server_descriptor(is_bridge = True)) + self.assertRaises(ValueError, export_csv, (server_desc, bridge_desc)) +

1 0

[translation/vidalia_help] Update translations for vidalia_help
by translation＠torproject.org 04 Aug '12

04 Aug '12

commit 07abdee43d3a469c3cd973369cd2a9625808dd1c Author: Translation commit bot <translation(a)torproject.org> Date: Sat Aug 4 18:15:16 2012 +0000 Update translations for vidalia_help --- ko/running.po | 9 ++++----- 1 files changed, 4 insertions(+), 5 deletions(-) diff --git a/ko/running.po b/ko/running.po index 87e771a..4060607 100644 --- a/ko/running.po +++ b/ko/running.po @@ -1,12 +1,13 @@ # # Translators: +# <siwoochung(a)me.com>, 2012. msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2010-06-26 17:00+0200\n" -"PO-Revision-Date: 2010-11-30 05:03+0000\n" -"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" +"PO-Revision-Date: 2012-08-04 18:05+0000\n" +"Last-Translator: chungsiwoo <siwoochung(a)me.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -17,7 +18,7 @@ msgstr "" #. type: Content of: <html><body><h1> #: en/running.html:16 msgid "Running Tor" -msgstr "" +msgstr "Tor 작동" #. type: Content of: <html><body><p> #: en/running.html:20 @@ -147,5 +148,3 @@ msgid "" "You can also check the <a href=\"log.html\">message log</a> for details " "about any problems Tor encountered before it exited." msgstr "" - -

1 0

r25742: {website} minor touch-ups (website/trunk/about/en)
by Roger Dingledine 04 Aug '12

04 Aug '12

Author: arma Date: 2012-08-04 07:37:51 +0000 (Sat, 04 Aug 2012) New Revision: 25742 Modified: website/trunk/about/en/jobs-projectcoordinator.wml Log: minor touch-ups Modified: website/trunk/about/en/jobs-projectcoordinator.wml =================================================================== --- website/trunk/about/en/jobs-projectcoordinator.wml 2012-08-03 00:47:08 UTC (rev 25741) +++ website/trunk/about/en/jobs-projectcoordinator.wml 2012-08-04 07:37:51 UTC (rev 25742) @@ -2,7 +2,7 @@ # Revision: $Revision: 25666 $ # Translation-Priority: 3-low -#include "head.wmi" TITLE="Tor Project: Jobs (browser hacker)" CHARSET="UTF-8" +#include "head.wmi" TITLE="Tor Project: Jobs (project coordinator)" CHARSET="UTF-8" <div id="content" class="clearfix"> <div id="breadcrumbs"> <a href="<page index>">Home » </a> @@ -14,7 +14,7 @@ <p> A project coordinator is the person who coordinates and helps track -deliverables, progress, and provide metrics on past and current +deliverables, progress, and metrics on past and current performance of projects. </p> @@ -24,7 +24,7 @@ <li>Deriving deliverables, deadlines, and milestones for each active contract.</li> <li>Developing timelines and schedules for completion of milestones and - deliverables for each active, and occassionally proposed, contract.<li> + deliverables for each active, and occassionally proposed, contract.</li> <li>Collecting ideas and potential deliverables for the future.</li> <li>Raising concerns, timeline slips, and probability of missed deadlines to management.</li> @@ -42,7 +42,7 @@ <li>Helping to write the monthly progress reports required for contracts.</li> </ul> -<p>In general, you should be:</p> +<p>In general, you should:</p> <ul> <li>Be comfortable and experienced justifying and documenting technical decisions for a public, world-wide technical audience.</li>

1 0

[onionoo/master] Clarify protocol spec based on Norman's questions.
by karsten＠torproject.org 04 Aug '12

04 Aug '12

commit 0e0198f18af72b7b237661049b58e5f6dd1829d8 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Sat Aug 4 07:56:16 2012 +0200 Clarify protocol spec based on Norman's questions. --- web/index.html | 20 +++++++++++++------- 1 files changed, 13 insertions(+), 7 deletions(-) diff --git a/web/index.html b/web/index.html index a74feac..384bfd4 100755 --- a/web/index.html +++ b/web/index.html @@ -782,7 +782,11 @@ running or that have been running in the past week. </tr> </table> <p>Each of the methods above can be parameterized to select only a subset -of relay and/or bridge documents to be included in the response.</p> +of relay and/or bridge documents to be included in the response. +If multiple parameters are specified, they are combined using a logical +AND operation, meaning that only the intersection of relays and bridges +matching all parameters is returned. +</p> <table border="0" cellpadding="4" cellspacing="0" summary=""> <colgroup> <col width="150"> @@ -797,9 +801,9 @@ of relay and/or bridge documents to be included in the response.</p> <b>false</b>). </td></tr> <tr><td><b>search</b></td><td>Return only relays with the parameter value -matching the beginning of a nickname, (possibly $-prefixed) fingerprint, -or IP address, and bridges with the nickname or (possibly $-prefixed) -hashed fingerprint. +matching the beginning of a nickname, (possibly $-prefixed) beginning of a +fingerprint, or beginning of an IP address, and bridges with the beginning +of a nickname or (possibly $-prefixed) beginning of a hashed fingerprint. Searches are case-insensitive. If multiple search terms are given, separated by spaces, the intersection of all relays and bridges matching all search terms will be returned. @@ -827,13 +831,15 @@ limited by providing further parameters.</p> </colgroup> <tr><td><b>order</b></td><td>Re-order results by a comma-separated list of fields in ascending or descening order. -Results are first ordered by the second list element, then by the second, +Results are first ordered by the first list element, then by the second, and so on. Possible fields for ordering are: <b>consensus_weight</b>. Ascending order is the default; descending order is selected by prepending fields with a minus sign (<b>-</b>). -Relays which don't have any value for a field to be ordered by are always -appended to the end, regardless or sorting order. +Relays or bridges which don't have any value for a field to be ordered by +are always appended to the end, regardless or sorting order. +The ordering is defined independent of the requested document type and +does not require the ordering field to be contained in the document. If no <b>order</b> parameter is given, ordering of results is undefined. </td></tr>

1 0

[translation/whisperback] Update translations for whisperback
by translation＠torproject.org 04 Aug '12

04 Aug '12

commit bddc766032813969662588240bc51d1a365c2a98 Author: Translation commit bot <translation(a)torproject.org> Date: Sat Aug 4 04:45:29 2012 +0000 Update translations for whisperback --- zh_CN/zh_CN.po | 20 ++++++++++---------- 1 files changed, 10 insertions(+), 10 deletions(-) diff --git a/zh_CN/zh_CN.po b/zh_CN/zh_CN.po index 6ab5da9..e362ae4 100644 --- a/zh_CN/zh_CN.po +++ b/zh_CN/zh_CN.po @@ -10,7 +10,7 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2012-02-16 22:33+0100\n" -"PO-Revision-Date: 2012-08-04 04:14+0000\n" +"PO-Revision-Date: 2012-08-04 04:25+0000\n" "Last-Translator: xtoaster <zhazhenzhong(a)gmail.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" @@ -43,7 +43,7 @@ msgstr "没有发现密钥。" msgid "" "The variable %s was not found in any of the configuation " "files/etc/whisperback/config.py, ~/.whisperback/config.py, ./config.py" -msgstr "" +msgstr "变量 %s 在配置文件 /etc/whisperback/config.py, ~/.whisperback/config.py, ./config.py 中均不存在。" #: ../whisperBack/gui.py:114 msgid "Name of the affected software" @@ -81,7 +81,7 @@ msgid "" "<p>Anyone who can see this reply will probably infer you are\n" "a Tails user. Time to wonder how much you trust your\n" "Internet and mailbox providers?</p>\n" -msgstr "" +msgstr "<h1>Help us fix your bug!</h1>\n<p>Read <a href=\"%s\">our bug reporting instructions</a>.</p>\n<p><strong>Do not include more personal information than\nneeded!</strong></p>\n<h2>About giving us an email address</h2>\n<p>If you don't mind disclosing some bits of your identity\nto Tails developers, you can provide an email address to\nlet us ask more details about the bug. Additionally entering\na public PGP key enables us to encrypt such future\ncommunication.</p>\n<p>Anyone who can see this reply will probably infer you are\na Tails user. Time to wonder how much you trust your\nInternet and mailbox providers?</p>\n" #: ../whisperBack/gui.py:229 msgid "Sending mail..." @@ -98,7 +98,7 @@ msgstr "此操作可能需要一些时间..." #: ../whisperBack/gui.py:246 msgid "The contact email adress doesn't seem valid." -msgstr "邮件地址无效。" +msgstr "联系人邮件地址无效。" #: ../whisperBack/gui.py:263 msgid "Unable to send the mail: SMTP error." @@ -119,7 +119,7 @@ msgid "" "The bug report could not be sent, likely due to network problems. Please try to reconnect to the network and click send again.\n" "\n" "If it does not work, you will be offered to save the bug report." -msgstr "" +msgstr "\n\n错误报告无法发送，可能是网络问题，尝试重新连接网络，再点击发送。\n\n如果仍不管用，您可以选择保存错误报告。" #: ../whisperBack/gui.py:283 msgid "Your message has been sent." @@ -127,7 +127,7 @@ msgstr "您的信息已发送。" #: ../whisperBack/gui.py:289 msgid "Unable to find encryption key." -msgstr "" +msgstr "找不到加密密钥。" #: ../whisperBack/gui.py:293 msgid "An error occured during encryption." @@ -147,7 +147,7 @@ msgid "" "As a work-around you can save the bug report as a file on a USB drive and try to send it to us at %s from your email account using another system. Note that your bug report will not be anonymous when doing so unless you take further steps yourself (e.g. using Tor with a throw-away email account).\n" "\n" "Do you want to save the bug report to a file?" -msgstr "" +msgstr "可能由于网络原因，错误报告无法发送。\n\n为了绕过这一问题，您可以保存错误报告到U盘中，在其他系统中从您的邮箱将其发送给我们 %s 。注意这样您的错误报告将失去匿名性。除非您自行采取其他措施。 (例如，使用 Tor 和一次性邮箱 )。\n\n您是否要将错误报告保存至文件 ?" #: ../whisperBack/gui.py:401 ../data/whisperback.ui.h:11 msgid "WhisperBack" @@ -198,7 +198,7 @@ msgstr "如果您希望我们回复您时使用加密消息，添加您的密 #: ../data/whisperback.ui.h:6 msgid "Optional email address to contact you" -msgstr "用于联系您的Email地址(可选)" +msgstr "用于联系您的Email地址（可选）" #: ../data/whisperback.ui.h:7 msgid "Send" @@ -229,7 +229,7 @@ msgid "" "\n" "You should have received a copy of the GNU General Public License\n" "along with this program. If not, see <http://www.gnu.org/licenses/>.\n" -msgstr "" +msgstr "WhisperBack - Send feedback in an encrypted mail\nCopyright (C) 2009-2011 Tails developers <tails(a)boum.org>\n\nThis program is free software; you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation; either version 3 of the License, or (at\nyour option) any later version.\n\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\nGeneral Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <http://www.gnu.org/licenses/>.\n" #: ../data/whisperback.ui.h:28 msgid "debugging info" @@ -245,4 +245,4 @@ msgstr "https://tails.boum.org/" #: ../data/whisperback.ui.h:31 msgid "optional PGP key" -msgstr "PGP 密钥(可选 )" +msgstr "PGP 密钥（可选）"

1 0

[translation/vidalia_alpha] Update translations for vidalia_alpha
by translation＠torproject.org 04 Aug '12

04 Aug '12

commit 43363d7469b510764489753426194862628f9dd2 Author: Translation commit bot <translation(a)torproject.org> Date: Sat Aug 4 04:45:11 2012 +0000 Update translations for vidalia_alpha --- zh_CN/vidalia_zh_CN.po | 17 +++++++++-------- 1 files changed, 9 insertions(+), 8 deletions(-) diff --git a/zh_CN/vidalia_zh_CN.po b/zh_CN/vidalia_zh_CN.po index c8cb944..53531f4 100644 --- a/zh_CN/vidalia_zh_CN.po +++ b/zh_CN/vidalia_zh_CN.po @@ -2,13 +2,14 @@ # Translators: # <reg(a)8863.co.cc>, 2011. # runasand <runa.sandvik(a)gmail.com>, 2011. +# <zhazhenzhong(a)gmail.com>, 2012. msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2012-03-21 17:46+0000\n" -"PO-Revision-Date: 2012-03-22 09:01+0000\n" -"Last-Translator: s10010 <reg(a)8863.co.cc>\n" +"PO-Revision-Date: 2012-08-04 04:28+0000\n" +"Last-Translator: xtoaster <zhazhenzhong(a)gmail.com>\n" "Language-Team: translations(a)vidalia-project.net\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -140,11 +141,11 @@ msgstr "选择储存Tor软件数据的文件夹" msgctxt "AdvancedPage" msgid "Tor Control" -msgstr "" +msgstr "Tor 控制" msgctxt "AdvancedPage" msgid "Use TCP connection (ControlPort)" -msgstr "" +msgstr "使用TCP连接(ControlPort)" msgctxt "AdvancedPage" msgid "Path:" @@ -152,19 +153,19 @@ msgstr "路径：" msgctxt "AdvancedPage" msgid "Use Unix domain socket (ControlSocket)" -msgstr "" +msgstr "使用 Unix domain socket (ControlSocket)" msgctxt "AdvancedPage" msgid "Edit current torrc" -msgstr "" +msgstr "编辑当前的 torrc" msgctxt "AdvancedPage" msgid "NOTE: this will edit the currently loaded torrc" -msgstr "" +msgstr "注意: 这将编辑当前已载入的 torrc" msgctxt "AdvancedPage" msgid "ControlSocket path doesn't exist." -msgstr "" +msgstr "ControlSocket 路径不存在。" msgctxt "AdvancedPage" msgid ""

1 0

[translation/whisperback] Update translations for whisperback
by translation＠torproject.org 04 Aug '12

04 Aug '12

commit 626c1af3605208607464d40507592796a968c0d2 Author: Translation commit bot <translation(a)torproject.org> Date: Sat Aug 4 04:15:31 2012 +0000 Update translations for whisperback --- zh_CN/zh_CN.po | 67 ++++++++++++++++++++++++++++--------------------------- 1 files changed, 34 insertions(+), 33 deletions(-) diff --git a/zh_CN/zh_CN.po b/zh_CN/zh_CN.po index 58209d9..6ab5da9 100644 --- a/zh_CN/zh_CN.po +++ b/zh_CN/zh_CN.po @@ -4,13 +4,14 @@ # # Translators: # <hua5679(a)gmail.com>, 2012. +# <zhazhenzhong(a)gmail.com>, 2012. msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2012-02-16 22:33+0100\n" -"PO-Revision-Date: 2012-04-04 14:50+0000\n" -"Last-Translator: zhenghua1991 <hua5679(a)gmail.com>\n" +"PO-Revision-Date: 2012-08-04 04:14+0000\n" +"Last-Translator: xtoaster <zhazhenzhong(a)gmail.com>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -22,20 +23,20 @@ msgstr "" #: ../whisperBack/whisperback.py:63 #, python-format msgid "Invalid contact email: %s" -msgstr "" +msgstr "无效联系人邮件：%s" #: ../whisperBack/whisperback.py:80 #, python-format msgid "Invalid contact OpenPGP key: %s" -msgstr "" +msgstr "无效联系人OpenPGP密钥：%s" #: ../whisperBack/whisperback.py:82 msgid "Invalid contact OpenPGP public key block" -msgstr "" +msgstr "无效联系人OpenPGP公钥块" #: ../whisperBack/encryption.py:126 msgid "No keys found." -msgstr "" +msgstr "没有发现密钥。" #: ../whisperBack/exceptions.py:41 #, python-format @@ -46,23 +47,23 @@ msgstr "" #: ../whisperBack/gui.py:114 msgid "Name of the affected software" -msgstr "" +msgstr "受影响软件的名称" #: ../whisperBack/gui.py:115 msgid "Exact steps to reproduce the problem" -msgstr "" +msgstr "重现问题的步骤" #: ../whisperBack/gui.py:116 msgid "Actual result / the problem" -msgstr "" +msgstr "实际效果/问题" #: ../whisperBack/gui.py:117 msgid "Desired result" -msgstr "" +msgstr "预期效果" #: ../whisperBack/gui.py:155 msgid "Unable to load a valid configuration." -msgstr "" +msgstr "无法载入一个有效的配置。" #: ../whisperBack/gui.py:177 #, python-format @@ -84,32 +85,32 @@ msgstr "" #: ../whisperBack/gui.py:229 msgid "Sending mail..." -msgstr "" +msgstr "正在发送邮件..." #: ../whisperBack/gui.py:230 msgid "Sending mail" -msgstr "" +msgstr "正在发送邮件" #. pylint: disable=C0301 #: ../whisperBack/gui.py:232 msgid "This could take a while..." -msgstr "" +msgstr "此操作可能需要一些时间..." #: ../whisperBack/gui.py:246 msgid "The contact email adress doesn't seem valid." -msgstr "" +msgstr "邮件地址无效。" #: ../whisperBack/gui.py:263 msgid "Unable to send the mail: SMTP error." -msgstr "" +msgstr "无法发送邮件：SMTP错误。" #: ../whisperBack/gui.py:265 msgid "Unable to connect to the server." -msgstr "" +msgstr "无法连接服务器。" #: ../whisperBack/gui.py:267 msgid "Unable to create or to send the mail." -msgstr "" +msgstr "无法创建或发送邮件。" #: ../whisperBack/gui.py:270 msgid "" @@ -122,7 +123,7 @@ msgstr "" #: ../whisperBack/gui.py:283 msgid "Your message has been sent." -msgstr "" +msgstr "您的信息已发送。" #: ../whisperBack/gui.py:289 msgid "Unable to find encryption key." @@ -130,12 +131,12 @@ msgstr "" #: ../whisperBack/gui.py:293 msgid "An error occured during encryption." -msgstr "" +msgstr "加密中出现错误。" #: ../whisperBack/gui.py:313 #, python-format msgid "Unable to save %s." -msgstr "" +msgstr "无法保存 %s。" #. XXX: fix string #: ../whisperBack/gui.py:337 @@ -150,11 +151,11 @@ msgstr "" #: ../whisperBack/gui.py:401 ../data/whisperback.ui.h:11 msgid "WhisperBack" -msgstr "" +msgstr "WhisperBack" #: ../whisperBack/gui.py:402 ../data/whisperback.ui.h:8 msgid "Send feedback in an encrypted mail." -msgstr "" +msgstr "通过加密邮件发送用户反馈。" #: ../whisperBack/gui.py:405 msgid "Copyright © 2009-2011 Tails developpers (tails(a)boum.org)" @@ -170,16 +171,16 @@ msgstr "" #: ../whisperBack/gui.py:434 msgid "This doesn's seem to be a valid URL or OpenPGP key." -msgstr "" +msgstr "无效的链接或OpenPGP密钥。" #: ../data/whisperback.ui.h:1 msgid "" "Add a PGP key if you want us to encrypt messages when we respond to you." -msgstr "" +msgstr "如果您希望我们回复您时使用加密消息，请添加 PGP 密钥。" #: ../data/whisperback.ui.h:2 msgid "Bug description" -msgstr "" +msgstr "错误描述" #: ../data/whisperback.ui.h:3 msgid "Copyright © 2009-2011 tails(a)boum.org" @@ -193,23 +194,23 @@ msgstr "帮助" msgid "" "If you want us to encrypt messages when we respond to you, add your key ID, " "a link to your key, or the key as a public key block:" -msgstr "" +msgstr "如果您希望我们回复您时使用加密消息，添加您的密钥编号，下载密钥用的链接或公钥字符串:" #: ../data/whisperback.ui.h:6 msgid "Optional email address to contact you" -msgstr "" +msgstr "用于联系您的Email地址(可选)" #: ../data/whisperback.ui.h:7 msgid "Send" -msgstr "" +msgstr "发送" #: ../data/whisperback.ui.h:9 msgid "Summary" -msgstr "" +msgstr "概要" #: ../data/whisperback.ui.h:10 msgid "Technical details to include" -msgstr "" +msgstr "技术细节" #: ../data/whisperback.ui.h:12 msgid "" @@ -232,7 +233,7 @@ msgstr "" #: ../data/whisperback.ui.h:28 msgid "debugging info" -msgstr "" +msgstr "调试信息" #: ../data/whisperback.ui.h:29 msgid "headers" @@ -244,4 +245,4 @@ msgstr "https://tails.boum.org/" #: ../data/whisperback.ui.h:31 msgid "optional PGP key" -msgstr "" +msgstr "PGP 密钥(可选 )"

1 0