- tor-commits - lists.torproject.org

[stem/master] Bumping runtime of async event test by a second
by atagar＠torproject.org 14 May '12

14 May '12

commit bd1d3f345f25835a52813449f4bb45bdddf32eaf Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 7 08:37:34 2012 -0700 Bumping runtime of async event test by a second Testing for asynchronous events relies on BW events happening every second by checking that we get two of them. This is not reliable since we don't have a hard assurance about its rate. Giving the test an extra second to make it more reliable. --- test/integ/control/base_controller.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/test/integ/control/base_controller.py b/test/integ/control/base_controller.py index cb5eaf2..4a8033a 100644 --- a/test/integ/control/base_controller.py +++ b/test/integ/control/base_controller.py @@ -167,7 +167,7 @@ class TestBaseController(unittest.TestCase): start_time = time.time() - while (time.time() - start_time) < 2: + while (time.time() - start_time) < 3: test.runner.exercise_controller(self, controller) # Concurrently shut down the controller. We need to do this in another

1 0

[stem/master] Helper function for getting descriptor resource paths
by atagar＠torproject.org 14 May '12

14 May '12

commit 02451060cf8d5fcc8834d455e0c12a24b08b876b Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 9 09:02:51 2012 -0700 Helper function for getting descriptor resource paths Making a common helper function for getting the paths of resources in the descriptor data directory rather than making everyone figure out a DESCRIPTOR_TEST_DATA constant. --- test/integ/descriptor/__init__.py | 11 +++++++++++ test/integ/descriptor/extrainfo_descriptor.py | 6 ++---- test/integ/descriptor/server_descriptor.py | 16 +++++++--------- 3 files changed, 20 insertions(+), 13 deletions(-) diff --git a/test/integ/descriptor/__init__.py b/test/integ/descriptor/__init__.py index ec61ba7..eb8da22 100644 --- a/test/integ/descriptor/__init__.py +++ b/test/integ/descriptor/__init__.py @@ -4,3 +4,14 @@ Integration tests for stem.descriptor.* contents. __all__ = ["reader", "extrainfo_descriptor", "server_descriptor"] +import os + +DESCRIPTOR_TEST_DATA = os.path.join(os.path.dirname(__file__), "data") + +def get_resource(filename): + """ + Provides the path for a file in our descriptor data directory. + """ + + return os.path.join(DESCRIPTOR_TEST_DATA, filename) + diff --git a/test/integ/descriptor/extrainfo_descriptor.py b/test/integ/descriptor/extrainfo_descriptor.py index 8b59844..ec94d7c 100644 --- a/test/integ/descriptor/extrainfo_descriptor.py +++ b/test/integ/descriptor/extrainfo_descriptor.py @@ -8,9 +8,7 @@ import unittest import stem.descriptor.extrainfo_descriptor import test.runner - -my_dir = os.path.dirname(__file__) -DESCRIPTOR_TEST_DATA = os.path.join(my_dir, "data") +import test.integ.descriptor # 'test_cached_descriptor' is a lengthy test and uneffected by testing targets, # so including a flag to prevent it from being ran multiple times @@ -30,7 +28,7 @@ class TestExtraInfoDescriptor(unittest.TestCase): Parses and checks our results against an extrainfo descriptor from metrics. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "extrainfo_descriptor") + descriptor_path = test.integ.descriptor.get_resource("extrainfo_descriptor") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() diff --git a/test/integ/descriptor/server_descriptor.py b/test/integ/descriptor/server_descriptor.py index c94c709..b43d1ee 100644 --- a/test/integ/descriptor/server_descriptor.py +++ b/test/integ/descriptor/server_descriptor.py @@ -10,9 +10,7 @@ import stem.control import stem.version import stem.descriptor.server_descriptor import test.runner - -my_dir = os.path.dirname(__file__) -DESCRIPTOR_TEST_DATA = os.path.join(my_dir, "data") +import test.integ.descriptor # 'test_cached_descriptor' is a lengthy test and uneffected by testing targets, # so including a flag to prevent it from being ran multiple times @@ -36,7 +34,7 @@ class TestServerDescriptor(unittest.TestCase): Parses and checks our results against a server descriptor from metrics. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "example_descriptor") + descriptor_path = test.integ.descriptor.get_resource("example_descriptor") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() @@ -107,7 +105,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= Parses a relay server descriptor from 2005. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "old_descriptor") + descriptor_path = test.integ.descriptor.get_resource("old_descriptor") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() @@ -202,7 +200,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= Parses a descriptor with non-ascii content. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "non-ascii_descriptor") + descriptor_path = test.integ.descriptor.get_resource("non-ascii_descriptor") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() @@ -243,7 +241,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= returns ('\r' entries). """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "cr_in_contact_line") + descriptor_path = test.integ.descriptor.get_resource("cr_in_contact_line") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() @@ -270,7 +268,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= where we shouldn't be. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "negative_uptime") + descriptor_path = test.integ.descriptor.get_resource("negative_uptime") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read() @@ -293,7 +291,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= Parses a bridge descriptor. """ - descriptor_path = os.path.join(DESCRIPTOR_TEST_DATA, "bridge_descriptor") + descriptor_path = test.integ.descriptor.get_resource("bridge_descriptor") descriptor_file = open(descriptor_path) descriptor_contents = descriptor_file.read()

1 0

[stem/master] Only checking cached descriptor existance when needed
by atagar＠torproject.org 14 May '12

14 May '12

commit 9d24a9090a00a8686b6eae3258bb6af84cd06087 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 9 09:11:46 2012 -0700 Only checking cached descriptor existance when needed Maybe once upon a time we had multiple tests that ran over the cached descriptors? I don't recall it, and we definitely don't right now so only checking for the existance of the cached-descriptor and cached-extrainfo files when we want to test against them. --- test/integ/descriptor/extrainfo_descriptor.py | 21 ++++----------------- test/integ/descriptor/server_descriptor.py | 22 ++++------------------ 2 files changed, 8 insertions(+), 35 deletions(-) diff --git a/test/integ/descriptor/extrainfo_descriptor.py b/test/integ/descriptor/extrainfo_descriptor.py index ec94d7c..d62a164 100644 --- a/test/integ/descriptor/extrainfo_descriptor.py +++ b/test/integ/descriptor/extrainfo_descriptor.py @@ -10,19 +10,9 @@ import stem.descriptor.extrainfo_descriptor import test.runner import test.integ.descriptor -# 'test_cached_descriptor' is a lengthy test and uneffected by testing targets, -# so including a flag to prevent it from being ran multiple times - RAN_CACHED_DESCRIPTOR_TEST = False class TestExtraInfoDescriptor(unittest.TestCase): - is_cached_descriptors_available = None - - def setUp(self): - if self.is_cached_descriptors_available is None: - descriptor_path = test.runner.get_runner().get_test_dir("cached-extrainfo") - self.is_cached_descriptors_available = os.path.exists(descriptor_path) - def test_metrics_descriptor(self): """ Parses and checks our results against an extrainfo descriptor from metrics. @@ -75,18 +65,15 @@ k0d2aofcVbHr4fPQOSST0LXDrhFl5Fqo5um296zpJGvRUeO6S44U/EfJAGShtqWw additions. """ - descriptor_path = test.runner.get_runner().get_test_dir("cached-extrainfo") - - if not self.is_cached_descriptors_available: - self.skipTest("(no cached descriptors)") - global RAN_CACHED_DESCRIPTOR_TEST + descriptor_path = test.runner.get_runner().get_test_dir("cached-extrainfo") if RAN_CACHED_DESCRIPTOR_TEST: self.skipTest("(already ran)") - else: - RAN_CACHED_DESCRIPTOR_TEST = True + elif not os.path.exists(descriptor_path): + self.skipTest("(no cached descriptors)") + RAN_CACHED_DESCRIPTOR_TEST = True with open(descriptor_path) as descriptor_file: for desc in stem.descriptor.extrainfo_descriptor.parse_file(descriptor_file): # TODO: uncomment when we're done implementing the ExtraInfoDescriptor class diff --git a/test/integ/descriptor/server_descriptor.py b/test/integ/descriptor/server_descriptor.py index b43d1ee..57f6879 100644 --- a/test/integ/descriptor/server_descriptor.py +++ b/test/integ/descriptor/server_descriptor.py @@ -18,17 +18,6 @@ import test.integ.descriptor RAN_CACHED_DESCRIPTOR_TEST = False class TestServerDescriptor(unittest.TestCase): - is_cached_descriptors_available = None - - def setUp(self): - # If this is our first time running the integ tests and we didn't wait for - # a full tor initialization then the cached descriptors won't exist yet. - # Noting if they exist or not since some tests need them. - - if self.is_cached_descriptors_available is None: - descriptor_path = test.runner.get_runner().get_test_dir("cached-descriptors") - self.is_cached_descriptors_available = os.path.exists(descriptor_path) - def test_metrics_descriptor(self): """ Parses and checks our results against a server descriptor from metrics. @@ -163,18 +152,15 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= additions. """ - descriptor_path = test.runner.get_runner().get_test_dir("cached-descriptors") - - if not self.is_cached_descriptors_available: - self.skipTest("(no cached descriptors)") - global RAN_CACHED_DESCRIPTOR_TEST + descriptor_path = test.runner.get_runner().get_test_dir("cached-descriptors") if RAN_CACHED_DESCRIPTOR_TEST: self.skipTest("(already ran)") - else: - RAN_CACHED_DESCRIPTOR_TEST = True + elif not os.path.exists(descriptor_path): + self.skipTest("(no cached descriptors)") + RAN_CACHED_DESCRIPTOR_TEST = True with open(descriptor_path) as descriptor_file: for desc in stem.descriptor.server_descriptor.parse_file(descriptor_file): # the following attributes should be deprecated, and not appear in the wild

1 0

[stem/master] Renaming read/write_history to read/write_history_line
by atagar＠torproject.org 14 May '12

14 May '12

commit 7178c5cb0a831d217c969ad38453dfdc85630983 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 9 09:27:16 2012 -0700 Renaming read/write_history to read/write_history_line The 'read_history' variable name was a bit vague, and generally the attribute isn't useful unlike its read_history_* counterparts. Renaming the variables to make it clear that read_history_line is the raw content for the read-history line. --- stem/descriptor/extrainfo_descriptor.py | 12 ++++++------ stem/descriptor/server_descriptor.py | 12 ++++++------ test/integ/descriptor/extrainfo_descriptor.py | 4 ++-- test/integ/descriptor/server_descriptor.py | 8 ++++---- test/unit/descriptor/server_descriptor.py | 6 +++--- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index 2ea8829..1def09c 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -145,12 +145,12 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): geoip_db_digest (str) - sha1 of geoIP database file signature (str) - signature for this extrainfo descriptor (*) - read_history (str) - read-history line, always unset + read_history_line (str) - bytes read for relayed traffic read_history_end (datetime.datetime) - end of the sampling interval read_history_interval (int) - seconds per interval read_history_values (list) - bytes read during each interval (*) - write_history (str) - write-history line, always unset + write_history_line (str) - bytes written for relayed traffic write_history_end (datetime.datetime) - end of the sampling interval write_history_interval (int) - seconds per interval write_history_values (list) - bytes written during each interval (*) @@ -185,12 +185,12 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.geoip_db_digest = None self.signature = None - self.read_history = None + self.read_history_line = None self.read_history_end = None self.read_history_interval = None self.read_history_values = [] - self.write_history = None + self.write_history_line = None self.write_history_end = None self.write_history_interval = None self.write_history_values = [] @@ -276,12 +276,12 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): raise ValueError("%s line has non-numeric values: %s" % (keyword, line)) if keyword == "read-history": - self.read_history = value + self.read_history_line = value self.read_history_end = timestamp self.read_history_interval = interval self.read_history_values = history_values else: - self.write_history = value + self.write_history_line = value self.write_history_end = timestamp self.write_history_interval = interval self.write_history_values = history_values diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 2a9d72f..80f1538 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -167,12 +167,12 @@ class ServerDescriptor(stem.descriptor.Descriptor): observed_bandwidth (int) - estimated capacity of the relay based on usage in bytes/s (*) eventdns (bool) - (deprecated) always unset (*) - read_history (str) - (deprecated) read-history line, always unset + read_history_line (str) - (deprecated) bytes read for relayed traffic read_history_end (datetime.datetime) - (deprecated) end of the sampling interval read_history_interval (int) - (deprecated) seconds per interval read_history_values (list) - (deprecated) bytes read during each interval (*) - write_history (str) - (deprecated) write-history line, always unset + write_history_line (str) - (deprecated) bytes written for relayed traffic write_history_end (datetime.datetime) - (deprecated) end of the sampling interval write_history_interval (int) - (deprecated) seconds per interval write_history_values (list) - (deprecated) bytes written during each interval (*) @@ -227,12 +227,12 @@ class ServerDescriptor(stem.descriptor.Descriptor): self.observed_bandwidth = None self.eventdns = True - self.read_history = None + self.read_history_line = None self.read_history_end = None self.read_history_interval = None self.read_history_values = [] - self.write_history = None + self.write_history_line = None self.write_history_end = None self.write_history_interval = None self.write_history_values = [] @@ -481,12 +481,12 @@ class ServerDescriptor(stem.descriptor.Descriptor): raise ValueError("%s line has non-numeric values: %s" % (keyword, line)) if keyword == "read-history": - self.read_history = value + self.read_history_line = value self.read_history_end = timestamp self.read_history_interval = interval self.read_history_values = history_values else: - self.write_history = value + self.write_history_line = value self.write_history_end = timestamp self.write_history_interval = interval self.write_history_values = history_values diff --git a/test/integ/descriptor/extrainfo_descriptor.py b/test/integ/descriptor/extrainfo_descriptor.py index d62a164..51af571 100644 --- a/test/integ/descriptor/extrainfo_descriptor.py +++ b/test/integ/descriptor/extrainfo_descriptor.py @@ -47,13 +47,13 @@ k0d2aofcVbHr4fPQOSST0LXDrhFl5Fqo5um296zpJGvRUeO6S44U/EfJAGShtqWw # the initial contents for the line and parsed values. read_start = "2012-05-05 17:02:45 (900 s) 3309568,9216,41984" - self.assertTrue(desc.read_history.startswith(read_start)) + self.assertTrue(desc.read_history_line.startswith(read_start)) read_values_start = [3309568, 9216, 41984, 27648, 123904] self.assertEquals(read_values_start, desc.read_history_values[:5]) write_start = "2012-05-05 17:02:45 (900 s) 1082368,19456,50176,272384" - self.assertTrue(desc.write_history.startswith(write_start)) + self.assertTrue(desc.write_history_line.startswith(write_start)) write_values_start = [1082368, 19456, 50176, 272384, 485376] self.assertEquals(write_values_start, desc.write_history_values[:5]) diff --git a/test/integ/descriptor/server_descriptor.py b/test/integ/descriptor/server_descriptor.py index 57f6879..945d147 100644 --- a/test/integ/descriptor/server_descriptor.py +++ b/test/integ/descriptor/server_descriptor.py @@ -134,13 +134,13 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= # the initial contents for the line and parsed values. read_start = "2005-12-16 18:00:48 (900 s) 20774,489973,510022" - self.assertTrue(desc.read_history.startswith(read_start)) + self.assertTrue(desc.read_history_line.startswith(read_start)) read_values_start = [20774, 489973, 510022, 511163, 20949] self.assertEquals(read_values_start, desc.read_history_values[:5]) write_start = "2005-12-16 18:00:48 (900 s) 81,8848,8927,8927" - self.assertTrue(desc.write_history.startswith(write_start)) + self.assertTrue(desc.write_history_line.startswith(write_start)) write_values_start = [81, 8848, 8927, 8927, 83, 8848, 8931, 8929, 81, 8846] self.assertEquals(write_values_start, desc.write_history_values[:10]) @@ -164,8 +164,8 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= with open(descriptor_path) as descriptor_file: for desc in stem.descriptor.server_descriptor.parse_file(descriptor_file): # the following attributes should be deprecated, and not appear in the wild - self.assertEquals(None, desc.read_history) - self.assertEquals(None, desc.write_history) + self.assertEquals(None, desc.read_history_line) + self.assertEquals(None, desc.write_history_line) self.assertEquals(True, desc.eventdns) self.assertEquals(0, desc.socks_port) diff --git a/test/unit/descriptor/server_descriptor.py b/test/unit/descriptor/server_descriptor.py index e3b2ec6..63fd89d 100644 --- a/test/unit/descriptor/server_descriptor.py +++ b/test/unit/descriptor/server_descriptor.py @@ -235,10 +235,10 @@ class TestServerDescriptor(unittest.TestCase): desc = RelayDescriptor(desc_text) if field == "read-history": - attr = (desc.read_history, desc.read_history_end, + attr = (desc.read_history_line, desc.read_history_end, desc.read_history_interval, desc.read_history_values) else: - attr = (desc.write_history, desc.write_history_end, + attr = (desc.write_history_line, desc.write_history_end, desc.write_history_interval, desc.write_history_values) expected_end = datetime.datetime(2005, 12, 16, 18, 0, 48) @@ -257,7 +257,7 @@ class TestServerDescriptor(unittest.TestCase): value = "2005-12-17 01:23:11 (900 s) " desc_text = _make_descriptor({"opt read-history": value}) desc = RelayDescriptor(desc_text) - self.assertEquals(value, desc.read_history) + self.assertEquals(value, desc.read_history_line) self.assertEquals(datetime.datetime(2005, 12, 17, 1, 23, 11), desc.read_history_end) self.assertEquals(900, desc.read_history_interval) self.assertEquals([], desc.read_history_values)

1 0

[stem/master] Parsing dirreq-stats-end extrainfo lines
by atagar＠torproject.org 14 May '12

14 May '12

commit 6f40a5e87228ea8f0af76d2aeba859025ce468b2 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 12 12:32:09 2012 -0700 Parsing dirreq-stats-end extrainfo lines Parsing and test. This is the same format as bridge-stats-end so combining those tests. --- stem/descriptor/extrainfo_descriptor.py | 32 ++++++++++++++---- test/unit/descriptor/extrainfo_descriptor.py | 47 +++++++++++++++----------- 2 files changed, 52 insertions(+), 27 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index 380d022..a8f7961 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -154,6 +154,12 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): write_history_end (datetime.datetime) - end of the sampling interval write_history_interval (int) - seconds per interval write_history_values (list) - bytes written during each interval (*) + + Directory Mirror Attributes: + dirreq_stats_end (datetime.datetime) - end of the period where directory + mirroring stats were gathered + dirreq_stats_interval (int) - length in seconds of the interval where + directory stats were gathered dir_read_history_line (str) - bytes read for directory mirroring dir_read_history_end (datetime.datetime) - end of the sampling interval @@ -164,18 +170,18 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): dir_write_history_end (datetime.datetime) - end of the sampling interval dir_write_history_interval (int) - seconds per interval dir_write_history_values (list) - bytes read during each interval (*) - - Bridge-only Attributes: + + Bridge Attributes: bridge_stats_end (datetime.datetime) - end of the period when geoip statistics were gathered - bridge_stats_end_interval (int) - length in seconds of th interval where + bridge_stats_interval (int) - length in seconds of the interval where stats were gathered bridge_ips (dict) - mapping of country codes to a rounded number of unique ips from that region geoip_start_time (datetime.datetime) - replaced by bridge_stats_end geoip_client_origins (dict) - replaced by bridge_ips - - (*) required fields, others are left as None if undefined + + (*) required fields, others are left as None if undefined """ def __init__(self, raw_contents, validate = True, annotations = None): @@ -215,6 +221,9 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.write_history_interval = None self.write_history_values = [] + self.dirreq_stats_end = None + self.dirreq_stats_interval = None + self.dir_read_history_line = None self.dir_read_history_end = None self.dir_read_history_interval = None @@ -226,7 +235,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.dir_write_history_values = [] self.bridge_stats_end = None - self.bridge_stats_end_interval = None + self.bridge_stats_interval = None self.bridge_ips = None self.geoip_start_time = None self.geoip_client_origins = None @@ -320,7 +329,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): try: timestamp, interval, _ = _parse_timestamp_and_interval(keyword, value) self.bridge_stats_end = timestamp - self.bridge_stats_end_interval = interval + self.bridge_stats_interval = interval except ValueError, exc: if validate: raise exc elif keyword in ("geoip-client-origins", "bridge-ips"): @@ -345,6 +354,15 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.geoip_client_origins = locale_usage elif keyword == "bridge-ips": self.bridge_ips = locale_usage + elif keyword == "dirreq-stats-end": + # "dirreq-stats-end" YYYY-MM-DD HH:MM:SS (NSEC s) + + try: + timestamp, interval, _ = _parse_timestamp_and_interval(keyword, value) + self.dirreq_stats_end = timestamp + self.dirreq_stats_interval = interval + except ValueError, exc: + if validate: raise exc elif keyword in ("read-history", "write-history", "dirreq-read-history", "dirreq-write-history"): try: timestamp, interval, remainder = _parse_timestamp_and_interval(keyword, value) diff --git a/test/unit/descriptor/extrainfo_descriptor.py b/test/unit/descriptor/extrainfo_descriptor.py index 32732e3..b4c5fbe 100644 --- a/test/unit/descriptor/extrainfo_descriptor.py +++ b/test/unit/descriptor/extrainfo_descriptor.py @@ -151,29 +151,36 @@ class TestExtraInfoDescriptor(unittest.TestCase): desc_text = _make_descriptor({"geoip-start-time": entry}) desc = self._expect_invalid_attr(desc_text, "geoip_start_time") - def test_bridge_stats_end(self): + def test_stats_end(self): """ - Parses the bridge-stats-end line with valid and invalid data. + Parses the bridge-stats-end and dirreq-stats-end lines with valid and + invalid data. """ - desc_text = _make_descriptor({"bridge-stats-end": "2012-05-03 12:07:50 (500 s)"}) - desc = ExtraInfoDescriptor(desc_text) - self.assertEquals(datetime.datetime(2012, 5, 3, 12, 7, 50), desc.bridge_stats_end) - self.assertEquals(500, desc.bridge_stats_end_interval) - - test_entry = ( - "", - "2012-05-03 12:07:60 (500 s)", - "2012-05-03 12:07:50 (500s)", - "2012-05-03 12:07:50 (500 s", - "2012-05-03 12:07:50 (500 )", - "2012-05-03 ", - "2012-05-03", - ) - - for entry in test_entry: - desc_text = _make_descriptor({"bridge-stats-end": entry}) - desc = self._expect_invalid_attr(desc_text, "bridge_stats_end") + for keyword in ('bridge-stats-end', 'dirreq-stats-end'): + end_attr = keyword.replace('-', '_') + interval_attr = end_attr[:-4] + "_interval" + + desc_text = _make_descriptor({keyword: "2012-05-03 12:07:50 (500 s)"}) + desc = ExtraInfoDescriptor(desc_text) + self.assertEquals(datetime.datetime(2012, 5, 3, 12, 7, 50), getattr(desc, end_attr)) + self.assertEquals(500, getattr(desc, interval_attr)) + + test_entry = ( + "", + "2012-05-03 12:07:60 (500 s)", + "2012-05-03 12:07:50 (500s)", + "2012-05-03 12:07:50 (500 s", + "2012-05-03 12:07:50 (500 )", + "2012-05-03 ", + "2012-05-03", + ) + + for entry in test_entry: + desc_text = _make_descriptor({keyword: entry}) + desc = self._expect_invalid_attr(desc_text) + self.assertEquals(None, getattr(desc, end_attr)) + self.assertEquals(None, getattr(desc, interval_attr)) def test_bridge_ips(self): """

1 0

[stem/master] Accepting additional args on extra-info line
by atagar＠torproject.org 14 May '12

14 May '12

commit d3f7c00fa6cf2573f30551589338e4d42d61465a Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 10 08:00:36 2012 -0700 Accepting additional args on extra-info line Forgot that the spec says that extra arguments should be accepted and ignored. --- stem/descriptor/extrainfo_descriptor.py | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index aa02bc9..b0d7864 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -263,7 +263,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): # "extra-info" Nickname Fingerprint extra_info_comp = value.split() - if len(extra_info_comp) != 2: + if len(extra_info_comp) < 2: if not validate: continue raise ValueError("Extra-info line must have two values: %s" % line)

1 0

[stem/master] Parsing geoip-db-digest lines in extrainfo descriptors
by atagar＠torproject.org 14 May '12

14 May '12

commit 15a25f0b05eacfff21309715a4838d4ccd6f11f9 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 10 08:31:26 2012 -0700 Parsing geoip-db-digest lines in extrainfo descriptors --- stem/descriptor/extrainfo_descriptor.py | 7 ++++++ test/unit/descriptor/extrainfo_descriptor.py | 27 ++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 0 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index b0d7864..d2ee780 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -283,6 +283,13 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): except ValueError: if validate: raise ValueError("Published line's time wasn't parseable: %s" % line) + elif keyword == "geoip-db-digest": + # "geoip-db-digest" Digest + + if validate and not re.match("^[0-9a-fA-F]{40}$", value): + raise ValueError("Geoip digest line had an invalid sha1 digest: %s" % line) + + self.geoip_db_digest = value elif keyword in ("read-history", "write-history", "dirreq-read-history", "dirreq-write-history"): try: timestamp, interval, remainder = _parse_timestamp_and_interval(keyword, value) diff --git a/test/unit/descriptor/extrainfo_descriptor.py b/test/unit/descriptor/extrainfo_descriptor.py index 15ffe68..5a4a450 100644 --- a/test/unit/descriptor/extrainfo_descriptor.py +++ b/test/unit/descriptor/extrainfo_descriptor.py @@ -108,6 +108,33 @@ class TestExtraInfoDescriptor(unittest.TestCase): self.assertEquals(None, desc.nickname) self.assertEquals(None, desc.fingerprint) + def test_geoip_db_digest(self): + """ + Parses a geoip-db-digest line with valid data. + """ + + geoip_db_digest = "916A3CA8B7DF61473D5AE5B21711F35F301CE9E8" + desc_text = _make_descriptor({"geoip-db-digest": geoip_db_digest}) + desc = ExtraInfoDescriptor(desc_text) + self.assertEquals(geoip_db_digest, desc.geoip_db_digest) + + def test_geoip_db_digest_invalid(self): + """ + Parses the geoip-db-digest line with a variety of bad input. + """ + + test_entry = ( + "", + "916A3CA8B7DF61473D5AE5B21711F35F301CE9E", + "916A3CA8B7DF61473D5AE5B21711F35F301CE9E88", + "916A3CA8B7DF61473D5AE5B21711F35F301CE9EG", + "916A3CA8B7DF61473D5AE5B21711F35F301CE9E-", + ) + + for entry in test_entry: + desc_text = _make_descriptor({"geoip-db-digest": entry}) + desc = self._expect_invalid_attr(desc_text, "geoip_db_digest", entry) + def _expect_invalid_attr(self, desc_text, attr = None, expected_value = None): """ Asserts that construction will fail due to desc_text having a malformed

1 0

[stem/master] Parsing extrainfo dirreq-read/write-history lines
by atagar＠torproject.org 14 May '12

14 May '12

commit 0737bada04f71434e9169bc964257dffce8f90c3 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed May 9 10:01:32 2012 -0700 Parsing extrainfo dirreq-read/write-history lines Handling the dirreq-read-history and dirreq-write-history. These are almost identical to the read-history and write-history lines so tieing it into that parser. This is the last field I need to parse the metrics descriptor I'm using for an example in the integ tests. --- stem/descriptor/extrainfo_descriptor.py | 38 +++++++++++++++++++++++- test/integ/descriptor/extrainfo_descriptor.py | 23 ++++++++++++-- 2 files changed, 55 insertions(+), 6 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index 1def09c..aa02bc9 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -155,6 +155,16 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): write_history_interval (int) - seconds per interval write_history_values (list) - bytes written during each interval (*) + dir_read_history_line (str) - bytes read for directory mirroring + dir_read_history_end (datetime.datetime) - end of the sampling interval + dir_read_history_interval (int) - seconds per interval + dir_read_history_values (list) - bytes read during each interval (*) + + dir_write_history_line (str) - bytes written for directory mirroring + dir_write_history_end (datetime.datetime) - end of the sampling interval + dir_write_history_interval (int) - seconds per interval + dir_write_history_values (list) - bytes read during each interval (*) + (*) required fields, others are left as None if undefined """ @@ -195,6 +205,16 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.write_history_interval = None self.write_history_values = [] + self.dir_read_history_line = None + self.dir_read_history_end = None + self.dir_read_history_interval = None + self.dir_read_history_values = [] + + self.dir_write_history_line = None + self.dir_write_history_end = None + self.dir_write_history_interval = None + self.dir_write_history_values = [] + self._unrecognized_lines = [] entries, first_keyword, last_keyword, _ = \ @@ -263,7 +283,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): except ValueError: if validate: raise ValueError("Published line's time wasn't parseable: %s" % line) - elif keyword in ("read-history", "write-history"): + elif keyword in ("read-history", "write-history", "dirreq-read-history", "dirreq-write-history"): try: timestamp, interval, remainder = _parse_timestamp_and_interval(keyword, value) @@ -280,11 +300,25 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.read_history_end = timestamp self.read_history_interval = interval self.read_history_values = history_values - else: + elif keyword == "write-history": self.write_history_line = value self.write_history_end = timestamp self.write_history_interval = interval self.write_history_values = history_values + elif keyword == "dirreq-read-history": + self.dir_read_history_line = value + self.dir_read_history_end = timestamp + self.dir_read_history_interval = interval + self.dir_read_history_values = history_values + elif keyword == "dirreq-write-history": + self.dir_write_history_line = value + self.dir_write_history_end = timestamp + self.dir_write_history_interval = interval + self.dir_write_history_values = history_values + else: + # not gonna happen unless we change the main loop's conditional + # without fixing this one + raise ValueError("BUG: unrecognized keyword '%s'" % keyword) except ValueError, exc: if not validate: continue else: raise exc diff --git a/test/integ/descriptor/extrainfo_descriptor.py b/test/integ/descriptor/extrainfo_descriptor.py index 51af571..7a041d0 100644 --- a/test/integ/descriptor/extrainfo_descriptor.py +++ b/test/integ/descriptor/extrainfo_descriptor.py @@ -38,12 +38,15 @@ k0d2aofcVbHr4fPQOSST0LXDrhFl5Fqo5um296zpJGvRUeO6S44U/EfJAGShtqWw self.assertEquals(900, desc.read_history_interval) self.assertEquals(datetime.datetime(2012, 5, 5, 17, 2, 45), desc.write_history_end) self.assertEquals(900, desc.write_history_interval) + self.assertEquals(datetime.datetime(2012, 5, 5, 17, 2, 45), desc.dir_read_history_end) + self.assertEquals(900, desc.dir_read_history_interval) + self.assertEquals(datetime.datetime(2012, 5, 5, 17, 2, 45), desc.dir_write_history_end) + self.assertEquals(900, desc.dir_write_history_interval) self.assertEquals(expected_signature, desc.signature) + self.assertEquals([], desc.get_unrecognized_lines()) - # TODO: still missing dirreq-read-history and dirreq-write-history - #self.assertEquals([], desc.get_unrecognized_lines()) - - # The read-history and write-history lines are pretty long so just checking + # The read-history, write-history, dirreq-read-history, and + # dirreq-write-history lines are pretty long so just checking # the initial contents for the line and parsed values. read_start = "2012-05-05 17:02:45 (900 s) 3309568,9216,41984" @@ -57,6 +60,18 @@ k0d2aofcVbHr4fPQOSST0LXDrhFl5Fqo5um296zpJGvRUeO6S44U/EfJAGShtqWw write_values_start = [1082368, 19456, 50176, 272384, 485376] self.assertEquals(write_values_start, desc.write_history_values[:5]) + + dir_read_start = "2012-05-05 17:02:45 (900 s) 0,0,0,0,33792,27648,48128" + self.assertTrue(desc.dir_read_history_line.startswith(dir_read_start)) + + dir_read_values_start = [0, 0, 0, 0, 33792, 27648, 48128] + self.assertEquals(dir_read_values_start, desc.dir_read_history_values[:7]) + + dir_write_start = "2012-05-05 17:02:45 (900 s) 0,0,0,227328,349184" + self.assertTrue(desc.dir_write_history_line.startswith(dir_write_start)) + + dir_write_values_start = [0, 0, 0, 227328, 349184, 382976, 738304] + self.assertEquals(dir_write_values_start, desc.dir_write_history_values[:7]) def test_cached_descriptor(self): """

1 0

[stem/master] Parsing bridge specific extra-info params
by atagar＠torproject.org 14 May '12

14 May '12

commit c33c4a0f0e6b98898622d0929e531d12abdce72a Author: Damian Johnson <atagar(a)torproject.org> Date: Thu May 10 09:29:04 2012 -0700 Parsing bridge specific extra-info params Parsing, validation, and tests for bridge specific lines... - geoip-start-time - geoip-client-origins - bridge-stats-end - bridge-stats-ips I haven't yet seen an actual bridge descriptor, and I'd like to add one as an integ test but that can come later. --- stem/descriptor/extrainfo_descriptor.py | 58 ++++++++++++++++++- stem/descriptor/server_descriptor.py | 3 +- test/unit/descriptor/extrainfo_descriptor.py | 81 ++++++++++++++++++++++++-- 3 files changed, 132 insertions(+), 10 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index d2ee780..380d022 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -165,6 +165,16 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): dir_write_history_interval (int) - seconds per interval dir_write_history_values (list) - bytes read during each interval (*) + Bridge-only Attributes: + bridge_stats_end (datetime.datetime) - end of the period when geoip + statistics were gathered + bridge_stats_end_interval (int) - length in seconds of th interval where + stats were gathered + bridge_ips (dict) - mapping of country codes to a rounded number of unique + ips from that region + geoip_start_time (datetime.datetime) - replaced by bridge_stats_end + geoip_client_origins (dict) - replaced by bridge_ips + (*) required fields, others are left as None if undefined """ @@ -215,6 +225,12 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.dir_write_history_interval = None self.dir_write_history_values = [] + self.bridge_stats_end = None + self.bridge_stats_end_interval = None + self.bridge_ips = None + self.geoip_start_time = None + self.geoip_client_origins = None + self._unrecognized_lines = [] entries, first_keyword, last_keyword, _ = \ @@ -290,6 +306,45 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): raise ValueError("Geoip digest line had an invalid sha1 digest: %s" % line) self.geoip_db_digest = value + elif keyword == "geoip-start-time": + # "geoip-start-time" YYYY-MM-DD HH:MM:SS + + try: + self.geoip_start_time = datetime.datetime.strptime(value, "%Y-%m-%d %H:%M:%S") + except ValueError: + if validate: + raise ValueError("Geoip start time line's time wasn't parseable: %s" % line) + elif keyword == "bridge-stats-end": + # "bridge-stats-end" YYYY-MM-DD HH:MM:SS (NSEC s) + + try: + timestamp, interval, _ = _parse_timestamp_and_interval(keyword, value) + self.bridge_stats_end = timestamp + self.bridge_stats_end_interval = interval + except ValueError, exc: + if validate: raise exc + elif keyword in ("geoip-client-origins", "bridge-ips"): + # "geoip-client-origins" CC=N,CC=N,... + + locale_usage = {} + error_msg = "Entries in %s line should only be CC=N entries: %s" % (keyword, line) + + for entry in value.split(","): + if not "=" in entry: + if validate: raise ValueError(error_msg) + else: continue + + locale, count = entry.split("=", 1) + + if re.match("^[a-zA-Z]{2}$", locale) and count.isdigit(): + locale_usage[locale] = int(count) + elif validate: + raise ValueError(error_msg) + + if keyword == "geoip-client-origins": + self.geoip_client_origins = locale_usage + elif keyword == "bridge-ips": + self.bridge_ips = locale_usage elif keyword in ("read-history", "write-history", "dirreq-read-history", "dirreq-write-history"): try: timestamp, interval, remainder = _parse_timestamp_and_interval(keyword, value) @@ -327,8 +382,7 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): # without fixing this one raise ValueError("BUG: unrecognized keyword '%s'" % keyword) except ValueError, exc: - if not validate: continue - else: raise exc + if validate: raise exc elif keyword == "router-signature": if validate and not block_contents: raise ValueError("Router signature line must be followed by a signature block: %s" % line) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 80f1538..2963a53 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -491,8 +491,7 @@ class ServerDescriptor(stem.descriptor.Descriptor): self.write_history_interval = interval self.write_history_values = history_values except ValueError, exc: - if not validate: continue - else: raise exc + if validate: raise exc else: self._unrecognized_lines.append(line) diff --git a/test/unit/descriptor/extrainfo_descriptor.py b/test/unit/descriptor/extrainfo_descriptor.py index 5a4a450..32732e3 100644 --- a/test/unit/descriptor/extrainfo_descriptor.py +++ b/test/unit/descriptor/extrainfo_descriptor.py @@ -2,6 +2,7 @@ Unit tests for stem.descriptor.extrainfo_descriptor. """ +import datetime import unittest from stem.descriptor.extrainfo_descriptor import ExtraInfoDescriptor @@ -110,18 +111,13 @@ class TestExtraInfoDescriptor(unittest.TestCase): def test_geoip_db_digest(self): """ - Parses a geoip-db-digest line with valid data. + Parses the geoip-db-digest line with valid and invalid data. """ geoip_db_digest = "916A3CA8B7DF61473D5AE5B21711F35F301CE9E8" desc_text = _make_descriptor({"geoip-db-digest": geoip_db_digest}) desc = ExtraInfoDescriptor(desc_text) self.assertEquals(geoip_db_digest, desc.geoip_db_digest) - - def test_geoip_db_digest_invalid(self): - """ - Parses the geoip-db-digest line with a variety of bad input. - """ test_entry = ( "", @@ -135,6 +131,79 @@ class TestExtraInfoDescriptor(unittest.TestCase): desc_text = _make_descriptor({"geoip-db-digest": entry}) desc = self._expect_invalid_attr(desc_text, "geoip_db_digest", entry) + def test_geoip_start_time(self): + """ + Parses the geoip-start-time line with valid and invalid data. + """ + + desc_text = _make_descriptor({"geoip-start-time": "2012-05-03 12:07:50"}) + desc = ExtraInfoDescriptor(desc_text) + self.assertEquals(datetime.datetime(2012, 5, 3, 12, 7, 50), desc.geoip_start_time) + + test_entry = ( + "", + "2012-05-03 12:07:60", + "2012-05-03 ", + "2012-05-03", + ) + + for entry in test_entry: + desc_text = _make_descriptor({"geoip-start-time": entry}) + desc = self._expect_invalid_attr(desc_text, "geoip_start_time") + + def test_bridge_stats_end(self): + """ + Parses the bridge-stats-end line with valid and invalid data. + """ + + desc_text = _make_descriptor({"bridge-stats-end": "2012-05-03 12:07:50 (500 s)"}) + desc = ExtraInfoDescriptor(desc_text) + self.assertEquals(datetime.datetime(2012, 5, 3, 12, 7, 50), desc.bridge_stats_end) + self.assertEquals(500, desc.bridge_stats_end_interval) + + test_entry = ( + "", + "2012-05-03 12:07:60 (500 s)", + "2012-05-03 12:07:50 (500s)", + "2012-05-03 12:07:50 (500 s", + "2012-05-03 12:07:50 (500 )", + "2012-05-03 ", + "2012-05-03", + ) + + for entry in test_entry: + desc_text = _make_descriptor({"bridge-stats-end": entry}) + desc = self._expect_invalid_attr(desc_text, "bridge_stats_end") + + def test_bridge_ips(self): + """ + Parses both the bridge-ips and geoip-client-origins lines with valid and + invalid data. + """ + + # Testing both attributes since they contain the exact same data, + # geoip-client-origins was simply replaced by bridge-ips while adding an + # interval value for the period. + + for keyword in ('bridge-ips', 'geoip-client-origins'): + attr = keyword.replace('-', '_') + + desc_text = _make_descriptor({keyword: "uk=5,de=3,jp=2"}) + desc = ExtraInfoDescriptor(desc_text) + self.assertEquals({'uk': 5, 'de': 3, 'jp': 2}, getattr(desc, attr)) + + test_entry = ( + "", + "uk=-4", + "uki=4", + "uk:4", + "uk=4.de=3", + ) + + for entry in test_entry: + desc_text = _make_descriptor({keyword: entry}) + desc = self._expect_invalid_attr(desc_text, attr, {}) + def _expect_invalid_attr(self, desc_text, attr = None, expected_value = None): """ Asserts that construction will fail due to desc_text having a malformed

1 0

[stem/master] Revising descriptor pydocs
by atagar＠torproject.org 14 May '12

14 May '12

commit bff56e18ecde250eb9ad2eba7db5e29d1817bd8f Author: Damian Johnson <atagar(a)torproject.org> Date: Sat May 12 13:57:53 2012 -0700 Revising descriptor pydocs Revisited the ordering, defaults, and descriptions of descriptor attributes to be shorter and more user friendly. --- stem/descriptor/extrainfo_descriptor.py | 74 ++++++++++----------- stem/descriptor/server_descriptor.py | 96 +++++++++++++++------------- test/integ/descriptor/server_descriptor.py | 2 +- 3 files changed, 87 insertions(+), 85 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index a9bbfec..93b438c 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -139,47 +139,43 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): Extra-info descriptor document. Attributes: - nickname (str) - relay's nickname (*) - fingerprint (str) - fourty hex digits that make up the relay's fingerprint (*) - published (datetime.datetime) - time in GMT when the descriptor was generated (*) - geoip_db_digest (str) - sha1 of geoIP database file - signature (str) - signature for this extrainfo descriptor (*) + nickname (str) - relay's nickname (*) + fingerprint (str) - identity key fingerprint (*) + published (datetime) - time in GMT when this descriptor was made (*) + geoip_db_digest (str) - sha1 of geoIP database file + signature (str) - signature for this extrainfo descriptor (*) Bytes read/written for relayed traffic - read_history_end (datetime.datetime) - end of the sampling interval + read_history_end (datetime) - end of the sampling interval read_history_interval (int) - seconds per interval - read_history_values (list) - bytes read during each interval (*) + read_history_values (list) - bytes read during each interval - write_history_end (datetime.datetime) - end of the sampling interval + write_history_end (datetime) - end of the sampling interval write_history_interval (int) - seconds per interval - write_history_values (list) - bytes written during each interval (*) - - Directory Mirror Attributes: - dirreq_stats_end (datetime.datetime) - end of the period where directory - mirroring stats were gathered - dirreq_stats_interval (int) - length in seconds of the interval where - directory stats were gathered + write_history_values (list) - bytes written during each interval - Bytes read/written for directory mirroring - dir_read_history_end (datetime.datetime) - end of the sampling interval - dir_read_history_interval (int) - seconds per interval - dir_read_history_values (list) - bytes read during each interval (*) + Directory Mirror Attributes: + dirreq_stats_end (datetime) - end of the period when stats were gathered + dirreq_stats_interval (int) - length in seconds of the interval - dir_write_history_end (datetime.datetime) - end of the sampling interval - dir_write_history_interval (int) - seconds per interval - dir_write_history_values (list) - bytes read during each interval (*) - - Bridge Attributes: - bridge_stats_end (datetime.datetime) - end of the period when geoip - statistics were gathered - bridge_stats_interval (int) - length in seconds of the interval where - stats were gathered - bridge_ips (dict) - mapping of country codes to a rounded number of unique - ips from that region - geoip_start_time (datetime.datetime) - replaced by bridge_stats_end - geoip_client_origins (dict) - replaced by bridge_ips + Bytes read/written for directory mirroring + dir_read_history_end (datetime) - end of the sampling interval + dir_read_history_interval (int) - seconds per interval + dir_read_history_values (list) - bytes read during each interval + + dir_write_history_end (datetime) - end of the sampling interval + dir_write_history_interval (int) - seconds per interval + dir_write_history_values (list) - bytes read during each interval + + Bridge Attributes: + bridge_stats_end (datetime) - end of the period when stats were gathered + bridge_stats_interval (int) - length in seconds of the interval + bridge_ips (dict) - mapping of locales to rounded count of unique user ips + geoip_start_time (datetime) - (deprecated) replaced by bridge_stats_end + geoip_client_origins (dict) - (deprecated) replaced by bridge_ips - (*) required fields, others are left as None if undefined + (*) attribute is either required when we're parsed with validation or has a + default value, others are left as None if undefined """ def __init__(self, raw_contents, validate = True, annotations = None): @@ -211,22 +207,22 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): self.read_history_end = None self.read_history_interval = None - self.read_history_values = [] + self.read_history_values = None self.write_history_end = None self.write_history_interval = None - self.write_history_values = [] + self.write_history_values = None self.dirreq_stats_end = None self.dirreq_stats_interval = None self.dir_read_history_end = None self.dir_read_history_interval = None - self.dir_read_history_values = [] + self.dir_read_history_values = None self.dir_write_history_end = None self.dir_write_history_interval = None - self.dir_write_history_values = [] + self.dir_write_history_values = None self.bridge_stats_end = None self.bridge_stats_interval = None diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 7e16c77..d347b15 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -141,42 +141,47 @@ class ServerDescriptor(stem.descriptor.Descriptor): Common parent for server descriptors. Attributes: - nickname (str) - relay's nickname (*) - fingerprint (str) - fourty hex digits that make up the relay's fingerprint - address (str) - IPv4 address of the relay (*) - or_port (int) - port used for relaying (*) - socks_port (int) - (deprecated) always zero (*) - dir_port (int) - port used for descriptor mirroring (*) - platform (str) - operating system and tor version + nickname (str) - relay's nickname (*) + fingerprint (str) - identity key fingerprint + published (datetime) - time in GMT when this descriptor was made (*) + + address (str) - IPv4 address of the relay (*) + or_port (int) - port used for relaying (*) + socks_port (int) - (deprecated, always zero) port used as client (*) + dir_port (int) - port used for descriptor mirroring (*) + + platform (str) - line with operating system and tor version tor_version (stem.version.Version) - version of tor - operating_system (str) - relay's operating system - uptime (int) - relay's uptime when published in seconds - published (datetime.datetime) - time in GMT when the descriptor was generated (*) - contact (str) - relay's contact information - link_protocols (list) - link protocols supported by the relay - circuit_protocols (list) - circuit protocols supported by the relay - hibernating (bool) - flag to indicate if the relay was hibernating when published (*) - allow_single_hop_exits (bool) - flag to indicate if single hop exiting is allowed from it (*) - extra_info_cache (bool) - flag to indicate if it's a mirror for extra-info documents (*) - extra_info_digest (str) - hex encoded digest of our extra-info document - hidden_service_dir (list) - hidden service descriptor versions that it stores - exit_policy (stem.exit_policy.ExitPolicy) - relay's stated exit policy - family (list) - nicknames or fingerprints of relays it has a declared family with (*) - average_bandwidth (int) - rate of traffic relay is willing to relay in bytes/s (*) - burst_bandwidth (int) - rate of traffic relay is willing to burst to in bytes/s (*) - observed_bandwidth (int) - estimated capacity of the relay based on usage in bytes/s (*) - eventdns (bool) - (deprecated) always unset (*) + operating_system (str) - operating system + uptime (int) - uptime when published in seconds + contact (str) - contact information + exit_policy (stem.exit_policy.ExitPolicy) - stated exit policy (*) + family (list) - nicknames or fingerprints of declared family (*) + + average_bandwidth (int) - averate rate it's willing to relay in bytes/s (*) + burst_bandwidth (int) - burst rate it's willing to relay in bytes/s (*) + observed_bandwidth (int) - estimated capacity based on usage in bytes/s (*) + + link_protocols (list) - link protocols supported by the relay + circuit_protocols (list) - circuit protocols supported by the relay + hibernating (bool) - hibernating when published (*) + allow_single_hop_exits (bool) - flag if single hop exiting is allowed (*) + extra_info_cache (bool) - flag if a mirror for extra-info documents (*) + extra_info_digest (str) - hex encoded digest of our extra-info document + hidden_service_dir (list) - hidden service descriptor versions it stores + eventdns (bool) - (deprecated, always unset) flag for evdns backend Deprecated, moved to extra-info descriptor... - read_history_end (datetime.datetime) - end of the sampling interval + read_history_end (datetime) - end of the sampling interval read_history_interval (int) - seconds per interval - read_history_values (list) - bytes read during each interval (*) + read_history_values (list) - bytes read during each interval - write_history_end (datetime.datetime) - end of the sampling interval + write_history_end (datetime) - end of the sampling interval write_history_interval (int) - seconds per interval - write_history_values (list) - bytes written during each interval (*) - - (*) required fields, others are left as None if undefined + write_history_values (list) - bytes written during each interval + + (*) attribute is either required when we're parsed with validation or has a + default value, others are left as None if undefined """ def __init__(self, raw_contents, validate = True, annotations = None): @@ -203,16 +208,25 @@ class ServerDescriptor(stem.descriptor.Descriptor): self.nickname = None self.fingerprint = None + self.published = None + self.address = None self.or_port = None self.socks_port = None self.dir_port = None + self.platform = None self.tor_version = None self.operating_system = None self.uptime = None - self.published = None self.contact = None + self.exit_policy = [] # should be an ExitPolicy instance when we have the class... + self.family = [] + + self.average_bandwidth = None + self.burst_bandwidth = None + self.observed_bandwidth = None + self.link_protocols = None self.circuit_protocols = None self.hibernating = False @@ -220,30 +234,21 @@ class ServerDescriptor(stem.descriptor.Descriptor): self.extra_info_cache = False self.extra_info_digest = None self.hidden_service_dir = None - self.family = [] - self.average_bandwidth = None - self.burst_bandwidth = None - self.observed_bandwidth = None - self.eventdns = True + self.eventdns = None self.read_history_end = None self.read_history_interval = None - self.read_history_values = [] + self.read_history_values = None self.write_history_end = None self.write_history_interval = None - self.write_history_values = [] + self.write_history_values = None self._unrecognized_lines = [] self._annotation_lines = annotations if annotations else [] self._annotation_dict = None # cached breakdown of key/value mappings - # TODO: Until we have a proper ExitPolicy class this is just a list of the - # exit policy strings... - - self.exit_policy = [] - # A descriptor contains a series of 'keyword lines' which are simply a # keyword followed by an optional value. Lines can also be followed by a # signature block. @@ -551,8 +556,9 @@ class RelayDescriptor(ServerDescriptor): onion_key (str) - key used to encrypt EXTEND cells (*) signing_key (str) - relay's long-term identity key (*) signature (str) - signature for this descriptor (*) - - (*) required fields, others are left as None if undefined + + (*) attribute is either required when we're parsed with validation or has a + default value, others are left as None if undefined """ def __init__(self, raw_contents, validate = True, annotations = None): diff --git a/test/integ/descriptor/server_descriptor.py b/test/integ/descriptor/server_descriptor.py index d7b5c14..3c07364 100644 --- a/test/integ/descriptor/server_descriptor.py +++ b/test/integ/descriptor/server_descriptor.py @@ -160,7 +160,7 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= # the following attributes should be deprecated, and not appear in the wild self.assertEquals(None, desc.read_history_end) self.assertEquals(None, desc.write_history_end) - self.assertEquals(True, desc.eventdns) + self.assertEquals(None, desc.eventdns) self.assertEquals(0, desc.socks_port) unrecognized_lines = desc.get_unrecognized_lines()

1 0