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

[stem/master] Parsing network-status-version attribute
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 5e12da0a50ee60577f3a571eea0ef3350e146d10 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 12:15:34 2012 -0700 Parsing network-status-version attribute I don't like our assumption that this is a v3 network status document, but I'll need to think more about how to handle other versions later. For now keeping the validation assertion that parsed documents are v3. --- stem/descriptor/networkstatus.py | 56 +++++++++++++++--------- test/integ/descriptor/networkstatus.py | 4 +- test/unit/descriptor/networkstatus/document.py | 16 ++++++- 3 files changed, 50 insertions(+), 26 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 2140b4d..d554d42 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -198,7 +198,7 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): :var tuple routers: RouterStatusEntry contained in the document - :var str network_status_version: **\*** document version + :var str version: **\*** document version :var str vote_status: **\*** status of the vote (is either "vote" or "consensus") :var int consensus_method: **~** consensus method used to generate a consensus :var list consensus_methods: **^** A list of supported consensus generation methods (integers) @@ -236,7 +236,7 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): self.directory_authorities = [] self.directory_signatures = [] - self.network_status_version = None + self.version = None self.vote_status = None self.consensus_methods = [] self.published = None @@ -255,8 +255,8 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): document_file = StringIO(raw_content) header, footer, routers_end = _get_document_content(document_file, validate) - self._parse_old(header + footer, validate) self._parse(header, footer, validate) + self._parse_old(header + footer, validate) if document_file.tell() < routers_end: self.routers = tuple(_get_routers(document_file, validate, self, routers_end, self._get_router_type())) @@ -266,9 +266,6 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): def _get_router_type(self): return RouterStatusEntry - def _validate_network_status_version(self): - return self.network_status_version == "3" - def get_unrecognized_lines(self): """ Returns any unrecognized trailing lines. @@ -292,23 +289,27 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): header_entries = stem.descriptor._get_descriptor_components(header, validate)[0] footer_entries = stem.descriptor._get_descriptor_components(footer, validate)[0] - if validate: - if not 'vote-status' in header_entries: - raise ValueError("Network status documents must have a 'vote-status' line to say if they're a vote or consensus") - + all_entries = dict() + all_entries.update(header_entries) + all_entries.update(footer_entries) + + if 'vote-status' in header_entries: is_consensus = header_entries['vote-status'][0][0] == "consensus" is_vote = not is_consensus + else: + if validate: + raise ValueError("Network status documents must have a 'vote-status' line to say if they're a vote or consensus") + + is_consensus, is_vote = True, False + + if validate: self._check_for_missing_and_disallowed_fields(is_consensus, header_entries, footer_entries) self._check_for_misordered_fields(is_consensus, header_entries, footer_entries) known_fields = [attr[0] for attr in HEADER_STATUS_DOCUMENT_FIELDS + FOOTER_STATUS_DOCUMENT_FIELDS] content = header + '\n' + footer - entries = dict() - entries.update(header_entries) - entries.update(footer_entries) - - for keyword, values in entries.items(): + for keyword, values in all_entries.items(): value, block_contents = values[0] line = "%s %s" % (keyword, value) @@ -318,15 +319,28 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): if validate and len(values) > 1 and keyword in known_fields: if not (keyword == 'directory-signature' and is_consensus): raise ValueError("Network status documents can only have a single '%s' line, got %i:\n%s" % (keyword, len(values), content)) + + if keyword == 'network-status-version': + # "network-status-version" version + + self.version = value + + # TODO: Obviously not right when we extend this to parse v2 documents, + # but we'll cross that bridge when we come to it. + + if validate and self.version != "3": + raise ValueError("Expected a version 3 network status documents, got version '%s' instead" % self.version) def _parse_old(self, raw_content, validate): # preamble content = StringIO(raw_content) read_keyword_line = lambda keyword, optional = False: setattr(self, keyword.replace("-", "_"), _read_keyword_line(keyword, content, validate, optional)) - map(read_keyword_line, ["network-status-version", "vote-status"]) - if validate and not self._validate_network_status_version(): - raise ValueError("Invalid network-status-version: %s" % self.network_status_version) + # ignore things the parse() method handles + _read_keyword_line("network-status-version", content, False, True) + + + map(read_keyword_line, ["vote-status"]) vote = False if self.vote_status == "vote": vote = True @@ -479,7 +493,7 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): if actual != expected: actual_label = ', '.join(actual) expected_label = ', '.join(expected) - raise ValueError("The fields in the document's %s are misordered. It should be '%s' but was '%s'" % (lable, actual_label, expected_label)) + raise ValueError("The fields in the document's %s are misordered. It should be '%s' but was '%s'" % (label, actual_label, expected_label)) class DirectoryAuthority(stem.descriptor.Descriptor): """ @@ -855,7 +869,7 @@ class MicrodescriptorConsensus(NetworkStatusDocument): """ A v3 microdescriptor consensus. - :var str network_status_version: **\*** a document format version. For v3 microdescriptor consensuses this is "3 microdesc" + :var str version: **\*** a document format version. For v3 microdescriptor consensuses this is "3 microdesc" :var str vote_status: **\*** status of the vote (is "consensus") :var int consensus_method: **~** consensus method used to generate a consensus :var datetime valid_after: **\*** time when the consensus becomes valid @@ -879,7 +893,7 @@ class MicrodescriptorConsensus(NetworkStatusDocument): return RouterMicrodescriptor def _validate_network_status_version(self): - return self.network_status_version == "3 microdesc" + return self.version == "3 microdesc" class RouterMicrodescriptor(RouterStatusEntry): """ diff --git a/test/integ/descriptor/networkstatus.py b/test/integ/descriptor/networkstatus.py index 4ca8e5c..1777828 100644 --- a/test/integ/descriptor/networkstatus.py +++ b/test/integ/descriptor/networkstatus.py @@ -85,7 +85,7 @@ class TestNetworkStatus(unittest.TestCase): router1 = desc.routers[0] descriptor_file.close() - self.assertEquals("3", desc.network_status_version) + self.assertEquals("3", desc.version) self.assertEquals("consensus", desc.vote_status) self.assertEquals([], desc.consensus_methods) self.assertEquals(None, desc.published) @@ -177,7 +177,7 @@ I/TJmV928na7RLZe2mGHCAW3VQOvV+QkCfj05VZ8CsY= router1 = desc.routers[0] descriptor_file.close() - self.assertEquals("3", desc.network_status_version) + self.assertEquals("3", desc.version) self.assertEquals("vote", desc.vote_status) self.assertEquals(range(1, 13), desc.consensus_methods) self.assertEquals(_strptime("2012-07-11 23:50:01"), desc.published) diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index ef77391..a099fa9 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -100,7 +100,7 @@ class TestNetworkStatusDocument(unittest.TestCase): sig = DirectorySignature("directory-signature " + NETWORK_STATUS_DOCUMENT_ATTR["directory-signature"]) self.assertEqual((), document.routers) - self.assertEqual("3", document.network_status_version) + self.assertEqual("3", document.version) self.assertEqual("consensus", document.vote_status) self.assertEqual(9, document.consensus_method) self.assertEqual([], document.consensus_methods) @@ -133,7 +133,7 @@ class TestNetworkStatusDocument(unittest.TestCase): sig = DirectorySignature("directory-signature " + NETWORK_STATUS_DOCUMENT_ATTR["directory-signature"]) self.assertEqual((), document.routers) - self.assertEqual("3", document.network_status_version) + self.assertEqual("3", document.version) self.assertEqual("vote", document.vote_status) self.assertEqual(None, document.consensus_method) self.assertEqual([9], document.consensus_methods) @@ -213,5 +213,15 @@ class TestNetworkStatusDocument(unittest.TestCase): content = "\n".join(test_lines) self.assertRaises(ValueError, NetworkStatusDocument, content) NetworkStatusDocument(content, False) # constructs without validation - + + def test_invalid_version(self): + """ + Try parsing a different document version with the v3 parser. + """ + + content = get_network_status_document({"network-status-version": "4"}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals("4", document.version)

1 0

[stem/master] Validating that fields aren't duplicated
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit db87c88965806ec13f9888c220879af45fc65e44 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 11:54:33 2012 -0700 Validating that fields aren't duplicated Almost all of the fields in a network status document can only appear once. Checking that this is a case. This also includes a unit test for the validation. I'm a little surprised that the old parser doesn't choke on duplicated content, but I'm about to replace it so probably not worth investigating. --- stem/descriptor/networkstatus.py | 19 ++++++++++++++++ test/unit/descriptor/networkstatus/document.py | 28 ++++++++++++++++++++++++ 2 files changed, 47 insertions(+), 0 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 5676c16..2140b4d 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -297,8 +297,27 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): raise ValueError("Network status documents must have a 'vote-status' line to say if they're a vote or consensus") is_consensus = header_entries['vote-status'][0][0] == "consensus" + is_vote = not is_consensus self._check_for_missing_and_disallowed_fields(is_consensus, header_entries, footer_entries) self._check_for_misordered_fields(is_consensus, header_entries, footer_entries) + + known_fields = [attr[0] for attr in HEADER_STATUS_DOCUMENT_FIELDS + FOOTER_STATUS_DOCUMENT_FIELDS] + content = header + '\n' + footer + + entries = dict() + entries.update(header_entries) + entries.update(footer_entries) + + for keyword, values in entries.items(): + value, block_contents = values[0] + line = "%s %s" % (keyword, value) + + # All known fields can only appear once except... + # * 'directory-signature' in a consensus + + if validate and len(values) > 1 and keyword in known_fields: + if not (keyword == 'directory-signature' and is_consensus): + raise ValueError("Network status documents can only have a single '%s' line, got %i:\n%s" % (keyword, len(values), content)) def _parse_old(self, raw_content, validate): # preamble diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index d2bbe90..ef77391 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -186,4 +186,32 @@ class TestNetworkStatusDocument(unittest.TestCase): content = "\n".join(test_lines) self.assertRaises(ValueError, NetworkStatusDocument, content) NetworkStatusDocument(content, False) # constructs without validation + + def test_duplicate_fields(self): + """ + Almost all fields can only appear once. Checking that duplicates cause + validation errors. + """ + + for is_consensus in (True, False): + attr = {"vote-status": "consensus"} if is_consensus else {"vote-status": "vote"} + lines = get_network_status_document(attr).split("\n") + + for i in xrange(len(lines)): + # Stop when we hit the 'directory-signature' for a couple reasons... + # - that is the one field that can validly appear multiple times + # - after it is a crypto blob, which won't trigger this kind of + # validation failure + + test_lines = list(lines) + if test_lines[i].startswith("directory-signature "): + break + + # duplicates the line + test_lines.insert(i, test_lines[i]) + + content = "\n".join(test_lines) + self.assertRaises(ValueError, NetworkStatusDocument, content) + NetworkStatusDocument(content, False) # constructs without validation +

1 0

[stem/master] Parsing consensus-methods attribute
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 65e92e80711999591441abbdf23a21321e4d9271 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 18:18:38 2012 -0700 Parsing consensus-methods attribute Only noteworthy bit is that the spec says 'Method "1" MUST be included.' so checking for that. --- stem/descriptor/networkstatus.py | 19 +++++++++++------ test/unit/descriptor/networkstatus/document.py | 25 ++++++++++++++++++++++- 2 files changed, 35 insertions(+), 9 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index f4c3b40..7e7907f 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -328,6 +328,17 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): self.is_consensus, self.is_vote = False, True elif validate: raise ValueError("A network status document's vote-status line can only be 'consensus' or 'vote', got '%s' instead" % value) + elif keyword == 'consensus-methods': + # "consensus-methods" IntegerList + + for entry in value.split(" "): + if entry.isdigit(): + self.consensus_methods.append(int(entry)) + elif validate: + raise ValueError("A network status document's consensus-methods must be a list of integer values, but was '%s'" % value) + + if validate and not (1 in self.consensus_methods): + raise ValueError("Network status votes must include consensus-method version 1") # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -344,17 +355,11 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): # ignore things the parse() method handles _read_keyword_line("network-status-version", content, False, True) _read_keyword_line("vote-status", content, False, True) + _read_keyword_line("consensus-methods", content, False, True) vote = self.is_vote if vote: - read_keyword_line("consensus-methods", True) - - if self.consensus_methods: - self.consensus_methods = [int(method) for method in self.consensus_methods.split(" ")] - else: - self.consensus_methods = [] - line = _read_keyword_line("published", content, validate, True) if line: diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 9b24a00..9301cce 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -10,7 +10,7 @@ from stem.descriptor.networkstatus import HEADER_STATUS_DOCUMENT_FIELDS, FOOTER_ NETWORK_STATUS_DOCUMENT_ATTR = { "network-status-version": "3", "vote-status": "consensus", - "consensus-methods": "9", + "consensus-methods": "1 9", "consensus-method": "9", "published": "2012-09-02 22:00:00", "valid-after": "2012-09-02 22:00:00", @@ -138,7 +138,7 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertEqual(False, document.is_consensus) self.assertEqual(True, document.is_vote) self.assertEqual(None, document.consensus_method) - self.assertEqual([9], document.consensus_methods) + self.assertEqual([1, 9], document.consensus_methods) self.assertEqual(datetime.datetime(2012, 9, 2, 22, 0, 0), document.published) self.assertEqual(datetime.datetime(2012, 9, 2, 22, 0, 0), document.valid_after) self.assertEqual(datetime.datetime(2012, 9, 2, 22, 0, 0), document.fresh_until) @@ -245,4 +245,25 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(True, document.is_consensus) self.assertEquals(False, document.is_vote) + + def test_invalid_consensus_methods(self): + """ + Parses an invalid consensus-methods field. + """ + + test_values = ( + ("", []), + (" ", []), + ("1 2 3 a 5", [1, 2, 3, 5]), + ("1 2 3 4.0 5", [1, 2, 3, 5]), + ("2 3 4", [2, 3, 4]), # spec says version one must be included + ) + + for test_value, expected_consensus_methods in test_values: + content = get_network_status_document({"vote-status": "vote", "consensus-methods": test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals(expected_consensus_methods, document.consensus_methods) +

1 0

[stem/master] Parsing consensus-method and datetime attributes
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit cb96c3e094719b096e5425faeadc01a15dfcb388 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 18:42:29 2012 -0700 Parsing consensus-method and datetime attributes Handling the published, valid-after, fresh-until, and valid-until fields. Doing them as a batch since they're all simply datetime fields without any other constraints. --- stem/descriptor/networkstatus.py | 54 ++++++++++++------------ test/unit/descriptor/networkstatus/document.py | 45 +++++++++++++++++++- 2 files changed, 71 insertions(+), 28 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 7e7907f..039222b 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -339,6 +339,28 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): if validate and not (1 in self.consensus_methods): raise ValueError("Network status votes must include consensus-method version 1") + elif keyword == 'consensus-method': + # "consensus-method" Integer + + if value.isdigit(): + self.consensus_method = int(value) + elif validate: + raise ValueError("A network status document's consensus-method must be an integer, but was '%s'" % value) + elif keyword in ('published', 'valid-after', 'fresh-until', 'valid-until'): + try: + date_value = datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S") + + if keyword == 'published': + self.published = date_value + elif keyword == 'valid-after': + self.valid_after = date_value + elif keyword == 'fresh-until': + self.fresh_until = date_value + elif keyword == 'valid-until': + self.valid_until = date_value + except ValueError: + if validate: + raise ValueError("Network status document's '%s' time wasn't parseable: %s" % (keyword, value)) # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -356,36 +378,14 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): _read_keyword_line("network-status-version", content, False, True) _read_keyword_line("vote-status", content, False, True) _read_keyword_line("consensus-methods", content, False, True) + _read_keyword_line("consensus-method", content, False, True) + _read_keyword_line("published", content, False, True) + _read_keyword_line("valid-after", content, False, True) + _read_keyword_line("fresh-until", content, False, True) + _read_keyword_line("valid-until", content, False, True) vote = self.is_vote - if vote: - line = _read_keyword_line("published", content, validate, True) - - if line: - self.published = _strptime(line, validate, True) - else: - read_keyword_line("consensus-method", True) - if self.consensus_method != None: - self.consensus_method = int(self.consensus_method) - - map(read_keyword_line, ["valid-after", "fresh-until", "valid-until"]) - - if self.valid_after: - self.valid_after = _strptime(self.valid_after, validate) - elif validate: - raise ValueError("Missing the 'valid-after' field") - - if self.fresh_until: - self.fresh_until = _strptime(self.fresh_until, validate) - elif validate: - raise ValueError("Missing the 'fresh-until' field") - - if self.valid_until: - self.valid_until = _strptime(self.valid_until, validate) - elif validate: - raise ValueError("Missing the 'valid-until' field") - voting_delay = _read_keyword_line("voting-delay", content, validate) if voting_delay: diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 9301cce..91796a3 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -265,5 +265,48 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(expected_consensus_methods, document.consensus_methods) - + + def test_invalid_consensus_method(self): + """ + Parses an invalid consensus-method field. + """ + + test_values = ( + "", + " ", + "a", + "1 2", + "2.0", + ) + + for test_value in test_values: + content = get_network_status_document({"consensus-method": test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals(None, document.consensus_method) + + def test_invalid_time_fields(self): + """ + Parses invalid published, valid-after, fresh-until, and valid-until fields. + All are simply datetime values. + """ + + test_values = ( + "", + " ", + "2012-12-12", + "2012-12-12 01:01:", + "2012-12-12 01:a1:01", + ) + + for field in ('published', 'valid-after', 'fresh-until', 'valid-until'): + attr = field.replace('-', '_') + + for test_value in test_values: + content = get_network_status_document({"vote-status": "vote", field: test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals(None, getattr(document, attr))

1 0

[stem/master] Parsing the voting-delay attribute
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit fb808fde025a8c4f7f04d243f6e679f2f8b5e255 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 18:52:58 2012 -0700 Parsing the voting-delay attribute Nothing special here. Simply a pair of integer fields. --- stem/descriptor/networkstatus.py | 16 +++++++++++----- test/unit/descriptor/networkstatus/document.py | 21 +++++++++++++++++++++ 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 039222b..2b30249 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -361,6 +361,16 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): except ValueError: if validate: raise ValueError("Network status document's '%s' time wasn't parseable: %s" % (keyword, value)) + elif keyword == "voting-delay": + # "voting-delay" VoteSeconds DistSeconds + + value_comp = value.split(' ') + + if len(value_comp) == 2 and value_comp[0].isdigit() and value_comp[1].isdigit(): + self.vote_delay = int(value_comp[0]) + self.dist_delay = int(value_comp[1]) + elif validate: + raise ValueError("A network status document's 'voting-delay' line must be a pair of integer values, but was '%s'" % value) # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -383,14 +393,10 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): _read_keyword_line("valid-after", content, False, True) _read_keyword_line("fresh-until", content, False, True) _read_keyword_line("valid-until", content, False, True) + _read_keyword_line("voting-delay", content, False, True) vote = self.is_vote - voting_delay = _read_keyword_line("voting-delay", content, validate) - - if voting_delay: - self.vote_delay, self.dist_delay = [int(delay) for delay in voting_delay.split(" ")] - client_versions = _read_keyword_line("client-versions", content, validate, True) if client_versions: self.client_versions = [stem.version.Version(version_string) for version_string in client_versions.split(",")] diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 91796a3..c16e054 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -309,4 +309,25 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(None, getattr(document, attr)) + + def test_invalid_voting_delay(self): + """ + Parses an invalid voting-delay field. + """ + + test_values = ( + "", + " ", + "1 a", + "1\t2", + "1 2.0", + ) + + for test_value in test_values: + content = get_network_status_document({"voting-delay": test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals(None, document.vote_delay) + self.assertEquals(None, document.dist_delay)

1 0

[stem/master] Parsing tor version list attributes
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit fd0deb96f30fc691019e0d2a09068a4787d80e97 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Sep 8 19:11:13 2012 -0700 Parsing tor version list attributes Handling the 'client-versions' and 'server-versions' lines, comma separated lists of tor versions. --- stem/descriptor/networkstatus.py | 27 +++++++++++++++-------- test/unit/descriptor/networkstatus/document.py | 24 +++++++++++++++++++++ 2 files changed, 41 insertions(+), 10 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 2b30249..eca3b71 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -208,9 +208,9 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): :var datetime fresh_until: **\*** time until when the consensus is considered to be fresh :var datetime valid_until: **\*** time until when the consensus is valid :var int vote_delay: **\*** number of seconds allowed for collecting votes from all authorities - :var int dist_delay: number of seconds allowed for collecting signatures from all authorities - :var list client_versions: list of recommended Tor client versions - :var list server_versions: list of recommended Tor server versions + :var int dist_delay: **\*** number of seconds allowed for collecting signatures from all authorities + :var list client_versions: list of recommended client tor versions + :var list server_versions: list of recommended server tor versions :var list known_flags: **\*** list of known router flags :var list params: dict of parameter(str) => value(int) mappings :var list directory_authorities: **\*** list of DirectoryAuthority objects that have generated this document @@ -371,6 +371,18 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): self.dist_delay = int(value_comp[1]) elif validate: raise ValueError("A network status document's 'voting-delay' line must be a pair of integer values, but was '%s'" % value) + elif keyword in ("client-versions", "server-versions"): + for entry in value.split(","): + try: + version_value = stem.version.Version(entry) + + if keyword == 'client-versions': + self.client_versions.append(version_value) + elif keyword == 'server-versions': + self.server_versions.append(version_value) + except ValueError: + if validate: + raise ValueError("Network status document's '%s' line had '%s', which isn't a parseable tor version: %s" % (keyword, entry, line)) # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -394,16 +406,11 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): _read_keyword_line("fresh-until", content, False, True) _read_keyword_line("valid-until", content, False, True) _read_keyword_line("voting-delay", content, False, True) + _read_keyword_line("client-versions", content, False, True) + _read_keyword_line("server-versions", content, False, True) vote = self.is_vote - client_versions = _read_keyword_line("client-versions", content, validate, True) - if client_versions: - self.client_versions = [stem.version.Version(version_string) for version_string in client_versions.split(",")] - server_versions = _read_keyword_line("server-versions", content, validate, True) - if server_versions: - self.server_versions = [stem.version.Version(version_string) for version_string in server_versions.split(",")] - flags_content = _read_keyword_line("known-flags", content, validate) if flags_content: diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index c16e054..032c095 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -5,6 +5,7 @@ Unit tests for the NetworkStatusDocument of stem.descriptor.networkstatus. import datetime import unittest +import stem.version from stem.descriptor.networkstatus import HEADER_STATUS_DOCUMENT_FIELDS, FOOTER_STATUS_DOCUMENT_FIELDS, Flag, NetworkStatusDocument, DirectorySignature NETWORK_STATUS_DOCUMENT_ATTR = { @@ -330,4 +331,27 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(None, document.vote_delay) self.assertEquals(None, document.dist_delay) + + def test_invalid_version_lists(self): + """ + Parses invalid client-versions and server-versions fields. Both are comma + separated lists of tor versions. + """ + + test_values = ( + ("", []), + (" ", []), + ("1.2.3.4,", [stem.version.Version("1.2.3.4")]), + ("1.2.3.4,1.2.3.a", [stem.version.Version("1.2.3.4")]), + ) + + for field in ('client-versions', 'server-versions'): + attr = field.replace('-', '_') + + for test_value, expected_value in test_values: + content = get_network_status_document({field: test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals(expected_value, getattr(document, attr))

1 0

[stem/master] Parsing the params attribute
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 355e474b3d62dceb09699f1be27b5b27b925e7fa Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Sep 10 09:12:19 2012 -0700 Parsing the params attribute Being a fair bit more anal about field validation, checking the following... * bounds on the value to be an 32 bit int * order of the values (keys should be ascending) * reject values like '+11' (the int() function accepts them) This also includes unit tests for these use cases and better error messaging. --- stem/descriptor/networkstatus.py | 50 ++++++++++++++-- test/unit/descriptor/networkstatus/document.py | 74 +++++++++++++++++++++++- 2 files changed, 117 insertions(+), 7 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index 1efcf58..d43c1d0 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -196,7 +196,7 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): :var list client_versions: list of recommended client tor versions :var list server_versions: list of recommended server tor versions :var list known_flags: **\*** list of known router flags - :var list params: dict of parameter(str) => value(int) mappings + :var list params: **\*** dict of parameter(str) => value(int) mappings :var list directory_authorities: **\*** list of DirectoryAuthority objects that have generated this document :var dict bandwidth_weights: **~** dict of weight(str) => value(int) mappings :var list directory_signatures: **\*** list of signatures this document has @@ -381,6 +381,49 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): # simply fetches the entries, excluding empty strings self.known_flags = [entry for entry in value.split(" ") if entry] + elif keyword == "params": + # "params" [Parameters] + # Parameter ::= Keyword '=' Int32 + # Int32 ::= A decimal integer between -2147483648 and 2147483647. + # Parameters ::= Parameter | Parameters SP Parameter + + # should only appear in consensus-method 7 or later + if validate and not (self.consensus_method >= 7 or filter(lambda x: x >= 7, self.consensus_methods)): + raise ValueError("A network status document's 'params' line should only appear in consensus-method 7 or later") + + # skip if this is a blank line + if value == "": continue + + for entry in value.split(" "): + try: + if not '=' in entry: + raise ValueError("must only have 'key=value' entries") + + entry_key, entry_value = entry.split("=", 1) + + try: + # the int() function accepts things like '+123', but we don't want to + if entry_value.startswith('+'): + raise ValueError() + + entry_value = int(entry_value) + except ValueError: + raise ValueError("'%s' is a non-numeric value" % entry_value) + + if validate: + # check int32 range + if entry_value < -2147483648 or entry_value > 2147483647: + raise ValueError("values must be between -2147483648 and 2147483647") + + # parameters should be in ascending order by their key + for prior_key in self.params: + if prior_key > entry_key: + raise ValueError("parameters must be sorted by their key") + + self.params[entry_key] = entry_value + except ValueError, exc: + if not validate: continue + raise ValueError("Unable to parse network status document's 'params' line (%s): %s'" % (exc, line)) # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -407,13 +450,10 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): _read_keyword_line("client-versions", content, False, True) _read_keyword_line("server-versions", content, False, True) _read_keyword_line("known-flags", content, False, True) + _read_keyword_line("params", content, False, True) vote = self.is_vote - read_keyword_line("params", True) - if self.params: - self.params = dict([(param.split("=")[0], int(param.split("=")[1])) for param in self.params.split(" ")]) - # authority section while _peek_keyword(content) == "dir-source": dirauth_data = _read_until_keywords(["dir-source", "r", "directory-footer", "directory-signature", "bandwidth-weights"], content, False, True) diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 97e239a..01f08bf 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -116,7 +116,7 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertEqual([], document.client_versions) self.assertEqual([], document.server_versions) self.assertEqual(expected_known_flags, document.known_flags) - self.assertEqual(None, document.params) + self.assertEqual({}, document.params) self.assertEqual([], document.directory_authorities) self.assertEqual(None, document.bandwidth_weights) self.assertEqual([sig], document.directory_signatures) @@ -150,7 +150,7 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertEqual([], document.client_versions) self.assertEqual([], document.server_versions) self.assertEqual(expected_known_flags, document.known_flags) - self.assertEqual(None, document.params) + self.assertEqual({}, document.params) self.assertEqual([], document.directory_authorities) self.assertEqual({}, document.bandwidth_weights) self.assertEqual([sig], document.directory_signatures) @@ -441,4 +441,74 @@ class TestNetworkStatusDocument(unittest.TestCase): content = get_network_status_document({"known-flags": test_value}) document = NetworkStatusDocument(content) self.assertEquals(expected_value, document.known_flags) + + def test_params(self): + """ + General testing for the 'params' line, exercising the happy cases. + """ + + content = get_network_status_document({"params": "CircuitPriorityHalflifeMsec=30000 bwauthpid=1 unrecognized=-122"}) + document = NetworkStatusDocument(content) + self.assertEquals(30000, document.params["CircuitPriorityHalflifeMsec"]) + self.assertEquals(1, document.params["bwauthpid"]) + self.assertEquals(-122, document.params["unrecognized"]) + + # empty params line + content = get_network_status_document({"params": ""}) + document = NetworkStatusDocument(content) + self.assertEquals({}, document.params) + + def test_params_malformed(self): + """ + Parses a 'params' line with malformed content. + """ + + test_values = ( + "foo=", + "foo=abc", + "foo=+123", + "foo=12\tbar=12", + ) + + for test_value in test_values: + content = get_network_status_document({"params": test_value}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals({}, document.params) + + def test_params_range(self): + """ + Check both the furthest valid 'params' values and values that are out of + bounds. + """ + + test_values = ( + ("foo=2147483648", {"foo": 2147483648}, False), + ("foo=-2147483649", {"foo": -2147483649}, False), + ("foo=2147483647", {"foo": 2147483647}, True), + ("foo=-2147483648", {"foo": -2147483648}, True), + ) + + for test_value, expected_value, is_ok in test_values: + content = get_network_status_document({"params": test_value}) + + if is_ok: + document = NetworkStatusDocument(content) + else: + self.assertRaises(ValueError, NetworkStatusDocument, content) + document = NetworkStatusDocument(content, False) + + self.assertEquals(expected_value, document.params) + + def test_params_misordered(self): + """ + Check that the 'params' line is rejected if out of order. + """ + + content = get_network_status_document({"params": "unrecognized=-122 bwauthpid=1"}) + self.assertRaises(ValueError, NetworkStatusDocument, content) + + document = NetworkStatusDocument(content, False) + self.assertEquals({"unrecognized": -122, "bwauthpid": 1}, document.params)

1 0

[stem/master] Defaulting to consensus-method 1
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 7218845d7bfce16b9ae4a0812cc74cd54b07f7c2 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 9 16:02:58 2012 -0700 Defaulting to consensus-method 1 As per the spec clarification in commit b829224, when the consensus-method or consensus-methods fields are missing we should default to method 1 (since in practice that's the only time the field doesn't appear). --- stem/descriptor/networkstatus.py | 11 ++++++++++- test/unit/descriptor/networkstatus/document.py | 14 +++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index beafe89..1efcf58 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -305,22 +305,31 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): raise ValueError("Expected a version 3 network status documents, got version '%s' instead" % self.version) elif keyword == 'vote-status': # "vote-status" type + # + # The consensus-method and consensus-methods fields are optional since + # they weren't included in version 1. Setting a default now that we + # know if we're a vote or not. if value == 'consensus': self.is_consensus, self.is_vote = True, False + self.consensus_method = 1 elif value == 'vote': self.is_consensus, self.is_vote = False, True + self.consensus_methods = [1] elif validate: raise ValueError("A network status document's vote-status line can only be 'consensus' or 'vote', got '%s' instead" % value) elif keyword == 'consensus-methods': # "consensus-methods" IntegerList + consensus_methods = [] for entry in value.split(" "): if entry.isdigit(): - self.consensus_methods.append(int(entry)) + consensus_methods.append(int(entry)) elif validate: raise ValueError("A network status document's consensus-methods must be a list of integer values, but was '%s'" % value) + self.consensus_methods = consensus_methods + if validate and not (1 in self.consensus_methods): raise ValueError("Network status votes must include consensus-method version 1") elif keyword == 'consensus-method': diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 5e3ec4b..2deeb35 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -267,6 +267,12 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(expected_consensus_methods, document.consensus_methods) + + # check that we default to including consensus-method 1 + content = get_network_status_document({"vote-status": "vote"}, ("consensus-methods",)) + document = NetworkStatusDocument(content) + self.assertEquals([1], document.consensus_methods) + self.assertEquals(None, document.consensus_method) def test_invalid_consensus_method(self): """ @@ -286,7 +292,13 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertRaises(ValueError, NetworkStatusDocument, content) document = NetworkStatusDocument(content, False) - self.assertEquals(None, document.consensus_method) + self.assertEquals(1, document.consensus_method) + + # check that we default to being consensus-method 1 + content = get_network_status_document(exclude = ("consensus-method",)) + document = NetworkStatusDocument(content) + self.assertEquals(1, document.consensus_method) + self.assertEquals([], document.consensus_methods) def test_invalid_time_fields(self): """

1 0

[stem/master] Parsing the known-flags attribute
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 0e4f8bfbdcf1bc9e427748dd37b53ad6b4a32d93 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 9 15:13:32 2012 -0700 Parsing the known-flags attribute Only changes are... * Moving the Flag enum to stem.descriptor.Flag since it's something that users will commonly use. As a rule of thumb I'd like users to only need 'stem.descriptor' unless they're doing something fancy. However, this is just a temporary move - I plan to move Flag to is own module, like Version. * Excluding empty strings from our known_flags attribute (our prior behavior was to parse things like " " into ['', '', '', '']). The spec doesn't set any constraints on what a flag can be so I suppose technically one could be the empty string, though this'll never be the case. Still waffling back and forth about if this should cause a validation error or not... --- stem/descriptor/__init__.py | 17 +++++++++++++++ stem/descriptor/networkstatus.py | 27 +++++------------------ test/integ/descriptor/networkstatus.py | 3 +- test/unit/descriptor/networkstatus/document.py | 24 ++++++++++++++++++++- test/unit/descriptor/networkstatus/entry.py | 3 +- 5 files changed, 50 insertions(+), 24 deletions(-) diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index 688e1b6..b921058 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -27,12 +27,29 @@ import re import datetime import collections +import stem.util.enum + KEYWORD_CHAR = "a-zA-Z0-9-" WHITESPACE = " \t" KEYWORD_LINE = re.compile("^([%s]+)(?:[%s]+(.*))?$" % (KEYWORD_CHAR, WHITESPACE)) PGP_BLOCK_START = re.compile("^-----BEGIN ([%s%s]+)-----$" % (KEYWORD_CHAR, WHITESPACE)) PGP_BLOCK_END = "-----END %s-----" +Flag = stem.util.enum.Enum( + ("AUTHORITY", "Authority"), + ("BADEXIT", "BadExit"), + ("EXIT", "Exit"), + ("FAST", "Fast"), + ("GUARD", "Guard"), + ("HSDIR", "HSDir"), + ("NAMED", "Named"), + ("RUNNING", "Running"), + ("STABLE", "Stable"), + ("UNNAMED", "Unnamed"), + ("V2DIR", "V2Dir"), + ("VALID", "Valid"), +) + def parse_file(path, descriptor_file): """ Provides an iterator for the descriptors within a given file. diff --git a/stem/descriptor/networkstatus.py b/stem/descriptor/networkstatus.py index eca3b71..beafe89 100644 --- a/stem/descriptor/networkstatus.py +++ b/stem/descriptor/networkstatus.py @@ -52,7 +52,6 @@ except: import stem.descriptor import stem.version import stem.exit_policy -import stem.util.enum import stem.util.tor_tools from stem.descriptor import _read_until_keywords, _peek_keyword, _strptime @@ -61,21 +60,6 @@ from stem.descriptor import _read_keyword_line, _read_keyword_line_str, _get_pse _bandwidth_weights_regex = re.compile(" ".join(["W%s=\d+" % weight for weight in ["bd", "be", "bg", "bm", "db", "eb", "ed", "ee", "eg", "em", "gb", "gd", "gg", "gm", "mb", "md", "me", "mg", "mm"]])) -Flag = stem.util.enum.Enum( - ("AUTHORITY", "Authority"), - ("BADEXIT", "BadExit"), - ("EXIT", "Exit"), - ("FAST", "Fast"), - ("GUARD", "Guard"), - ("HSDIR", "HSDir"), - ("NAMED", "Named"), - ("RUNNING", "Running"), - ("STABLE", "Stable"), - ("UNNAMED", "Unnamed"), - ("V2DIR", "V2Dir"), - ("VALID", "Valid"), -) - # Network status document are either a 'vote' or 'consensus', with different # mandatory fields for each. Both though require that their fields appear in a # specific order. This is an ordered listing of the following... @@ -383,6 +367,11 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): except ValueError: if validate: raise ValueError("Network status document's '%s' line had '%s', which isn't a parseable tor version: %s" % (keyword, entry, line)) + elif keyword == "known-flags": + # "known-flags" FlagList + + # simply fetches the entries, excluding empty strings + self.known_flags = [entry for entry in value.split(" ") if entry] # doing this validation afterward so we know our 'is_consensus' and # 'is_vote' attributes @@ -408,14 +397,10 @@ class NetworkStatusDocument(stem.descriptor.Descriptor): _read_keyword_line("voting-delay", content, False, True) _read_keyword_line("client-versions", content, False, True) _read_keyword_line("server-versions", content, False, True) + _read_keyword_line("known-flags", content, False, True) vote = self.is_vote - flags_content = _read_keyword_line("known-flags", content, validate) - - if flags_content: - self.known_flags = flags_content.split(" ") - read_keyword_line("params", True) if self.params: self.params = dict([(param.split("=")[0], int(param.split("=")[1])) for param in self.params.split(" ")]) diff --git a/test/integ/descriptor/networkstatus.py b/test/integ/descriptor/networkstatus.py index 9087b22..d77a36f 100644 --- a/test/integ/descriptor/networkstatus.py +++ b/test/integ/descriptor/networkstatus.py @@ -11,6 +11,7 @@ import unittest import stem.exit_policy import stem.version +import stem.descriptor import stem.descriptor.networkstatus import test.integ.descriptor @@ -47,7 +48,7 @@ class TestNetworkStatus(unittest.TestCase): # check if there's any unknown flags for flag in desc.flags: - if not flag in stem.descriptor.networkstatus.Flag: + if not flag in stem.descriptor.Flag: # TODO: this should be a special 'new capability' check later # rather than failing the tests raise ValueError("Unrecognized flag type: %s, found on relay %s (%s)" % (flag, desc.fingerprint, desc.nickname)) diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 032c095..5e3ec4b 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -6,7 +6,8 @@ import datetime import unittest import stem.version -from stem.descriptor.networkstatus import HEADER_STATUS_DOCUMENT_FIELDS, FOOTER_STATUS_DOCUMENT_FIELDS, Flag, NetworkStatusDocument, DirectorySignature +from stem.descriptor import Flag +from stem.descriptor.networkstatus import HEADER_STATUS_DOCUMENT_FIELDS, FOOTER_STATUS_DOCUMENT_FIELDS, NetworkStatusDocument, DirectorySignature NETWORK_STATUS_DOCUMENT_ATTR = { "network-status-version": "3", @@ -354,4 +355,25 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(expected_value, getattr(document, attr)) + + def test_known_flags(self): + """ + Parses some known-flag entries. Just exercising the field, there's not much + to test here. + """ + + test_values = ( + ("", []), + (" ", []), + ("BadExit", [Flag.BADEXIT]), + ("BadExit ", [Flag.BADEXIT]), + ("BadExit ", [Flag.BADEXIT]), + ("BadExit Fast", [Flag.BADEXIT, Flag.FAST]), + ("BadExit Unrecognized Fast", [Flag.BADEXIT, "Unrecognized", Flag.FAST]), + ) + + for test_value, expected_value in test_values: + content = get_network_status_document({"known-flags": test_value}) + document = NetworkStatusDocument(content) + self.assertEquals(expected_value, document.known_flags) diff --git a/test/unit/descriptor/networkstatus/entry.py b/test/unit/descriptor/networkstatus/entry.py index 195600c..7c9e051 100644 --- a/test/unit/descriptor/networkstatus/entry.py +++ b/test/unit/descriptor/networkstatus/entry.py @@ -5,7 +5,8 @@ Unit tests for the RouterStatusEntry of stem.descriptor.networkstatus. import datetime import unittest -from stem.descriptor.networkstatus import Flag, RouterStatusEntry, _decode_fingerprint +from stem.descriptor import Flag +from stem.descriptor.networkstatus import RouterStatusEntry, _decode_fingerprint from stem.version import Version from stem.exit_policy import MicrodescriptorExitPolicy

1 0

[stem/master] Basic validation attribute testing
by atagar＠torproject.org 13 Oct '12

13 Oct '12

commit 634c8f1d32dab7717b518593225b43b9e0349285 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Sep 9 16:44:37 2012 -0700 Basic validation attribute testing The network status document's unit tests were mostly just checking invalid inputs. Changing the attribute unit tests to test some valid input too. --- test/unit/descriptor/networkstatus/document.py | 105 ++++++++++++++++++------ 1 files changed, 79 insertions(+), 26 deletions(-) diff --git a/test/unit/descriptor/networkstatus/document.py b/test/unit/descriptor/networkstatus/document.py index 2deeb35..97e239a 100644 --- a/test/unit/descriptor/networkstatus/document.py +++ b/test/unit/descriptor/networkstatus/document.py @@ -218,22 +218,37 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertRaises(ValueError, NetworkStatusDocument, content) NetworkStatusDocument(content, False) # constructs without validation - def test_invalid_version(self): + def test_version(self): """ - Parses a different document version with the v3 parser. + Parses the network-status-version field, including trying to handle a + different document version with the v3 parser. """ + content = get_network_status_document({"network-status-version": "3"}) + document = NetworkStatusDocument(content) + self.assertEquals("3", document.version) + content = get_network_status_document({"network-status-version": "4"}) self.assertRaises(ValueError, NetworkStatusDocument, content) document = NetworkStatusDocument(content, False) self.assertEquals("4", document.version) - def test_invalid_vote_status(self): + def test_vote_status(self): """ - Parses an invalid vote-status field. + Parses the vote-status field. """ + content = get_network_status_document({"vote-status": "vote"}) + document = NetworkStatusDocument(content) + self.assertEquals(False, document.is_consensus) + self.assertEquals(True, document.is_vote) + + content = get_network_status_document({"vote-status": "consensus"}) + document = NetworkStatusDocument(content) + self.assertEquals(True, document.is_consensus) + self.assertEquals(False, document.is_vote) + test_values = ( "", " ", @@ -248,11 +263,21 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertEquals(True, document.is_consensus) self.assertEquals(False, document.is_vote) - def test_invalid_consensus_methods(self): + def test_consensus_methods(self): """ - Parses an invalid consensus-methods field. + Parses the consensus-methods field. """ + content = get_network_status_document({"vote-status": "vote", "consensus-methods": "12 3 1 780"}) + document = NetworkStatusDocument(content) + self.assertEquals([12, 3, 1, 780], document.consensus_methods) + + # check that we default to including consensus-method 1 + content = get_network_status_document({"vote-status": "vote"}, ("consensus-methods",)) + document = NetworkStatusDocument(content) + self.assertEquals([1], document.consensus_methods) + self.assertEquals(None, document.consensus_method) + test_values = ( ("", []), (" ", []), @@ -267,18 +292,22 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(expected_consensus_methods, document.consensus_methods) - - # check that we default to including consensus-method 1 - content = get_network_status_document({"vote-status": "vote"}, ("consensus-methods",)) - document = NetworkStatusDocument(content) - self.assertEquals([1], document.consensus_methods) - self.assertEquals(None, document.consensus_method) - def test_invalid_consensus_method(self): + def test_consensus_method(self): """ - Parses an invalid consensus-method field. + Parses the consensus-method field. """ + content = get_network_status_document({"consensus-method": "12"}) + document = NetworkStatusDocument(content) + self.assertEquals(12, document.consensus_method) + + # check that we default to being consensus-method 1 + content = get_network_status_document(exclude = ("consensus-method",)) + document = NetworkStatusDocument(content) + self.assertEquals(1, document.consensus_method) + self.assertEquals([], document.consensus_methods) + test_values = ( "", " ", @@ -293,19 +322,30 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(1, document.consensus_method) - - # check that we default to being consensus-method 1 - content = get_network_status_document(exclude = ("consensus-method",)) - document = NetworkStatusDocument(content) - self.assertEquals(1, document.consensus_method) - self.assertEquals([], document.consensus_methods) - def test_invalid_time_fields(self): + def test_time_fields(self): """ Parses invalid published, valid-after, fresh-until, and valid-until fields. All are simply datetime values. """ + expected = datetime.datetime(2012, 9, 2, 22, 0, 0) + test_value = "2012-09-02 22:00:00" + + content = get_network_status_document({ + "vote-status": "vote", + "published": test_value, + "valid-after": test_value, + "fresh-until": test_value, + "valid-until": test_value, + }) + + document = NetworkStatusDocument(content) + self.assertEquals(expected, document.published) + self.assertEquals(expected, document.valid_after) + self.assertEquals(expected, document.fresh_until) + self.assertEquals(expected, document.valid_until) + test_values = ( "", " ", @@ -324,11 +364,16 @@ class TestNetworkStatusDocument(unittest.TestCase): document = NetworkStatusDocument(content, False) self.assertEquals(None, getattr(document, attr)) - def test_invalid_voting_delay(self): + def test_voting_delay(self): """ - Parses an invalid voting-delay field. + Parses the voting-delay field. """ + content = get_network_status_document({"voting-delay": "12 345"}) + document = NetworkStatusDocument(content) + self.assertEquals(12, document.vote_delay) + self.assertEquals(345, document.dist_delay) + test_values = ( "", " ", @@ -345,12 +390,20 @@ class TestNetworkStatusDocument(unittest.TestCase): self.assertEquals(None, document.vote_delay) self.assertEquals(None, document.dist_delay) - def test_invalid_version_lists(self): + def test_version_lists(self): """ - Parses invalid client-versions and server-versions fields. Both are comma - separated lists of tor versions. + Parses client-versions and server-versions fields. Both are comma separated + lists of tor versions. """ + expected = [stem.version.Version("1.2.3.4"), stem.version.Version("56.789.12.34-alpha")] + test_value = "1.2.3.4,56.789.12.34-alpha" + + content = get_network_status_document({"client-versions": test_value, "server-versions": test_value}) + document = NetworkStatusDocument(content) + self.assertEquals(expected, document.client_versions) + self.assertEquals(expected, document.server_versions) + test_values = ( ("", []), (" ", []),

1 0