4 from twisted.internet import defer, reactor
5 from twisted.internet.abstract import isIPAddress
6 from twisted.python import log
7 from twisted.trial import unittest
8 from zope.interface import implements
10 from apt_dht.interfaces import IDHT
11 from khashmir import Khashmir
13 class DHTError(Exception):
14 """Represents errors that occur in the DHT."""
24 self.bootstrap_node = False
27 self.outstandingJoins = 0
33 def loadConfig(self, config, section):
34 """See L{apt_dht.interfaces.IDHT}."""
35 self.config_parser = config
36 self.section = section
38 self.cache_dir = self.config_parser.get(section, 'cache_dir')
39 self.bootstrap = self.config_parser.getstringlist(section, 'BOOTSTRAP')
40 self.bootstrap_node = self.config_parser.getboolean(section, 'BOOTSTRAP_NODE')
41 for k in self.config_parser.options(section):
42 if k in ['K', 'HASH_LENGTH', 'CONCURRENT_REQS', 'STORE_REDUNDANCY',
43 'MAX_FAILURES', 'PORT']:
44 self.config[k] = self.config_parser.getint(section, k)
45 elif k in ['CHECKPOINT_INTERVAL', 'MIN_PING_INTERVAL',
46 'BUCKET_STALENESS', 'KEINITIAL_DELAY', 'KE_DELAY', 'KE_AGE']:
47 self.config[k] = self.config_parser.gettime(section, k)
49 self.config[k] = self.config_parser.getboolean(section, k)
51 self.config[k] = self.config_parser.get(section, k)
54 """See L{apt_dht.interfaces.IDHT}."""
55 if self.config is None:
56 raise DHTError, "configuration not loaded"
58 raise DHTError, "a join is already in progress"
60 self.khashmir = Khashmir(self.config, self.cache_dir)
62 self.joining = defer.Deferred()
63 for node in self.bootstrap:
64 host, port = node.rsplit(':', 1)
67 self._join_gotIP(host, port)
69 reactor.resolve(host).addCallback(self._join_gotIP, port)
73 def _join_gotIP(self, ip, port):
74 """Called after an IP address has been found for a single bootstrap node."""
75 self.outstandingJoins += 1
76 self.khashmir.addContact(ip, port, self._join_single, self._join_error)
78 def _join_single(self, addr):
79 """Called when a single bootstrap node has been added."""
80 self.outstandingJoins -= 1
82 self.foundAddrs.append(addr)
83 if addr or self.outstandingJoins <= 0:
84 self.khashmir.findCloseNodes(self._join_complete, self._join_complete)
85 log.msg('Got back from bootstrap node: %r' % (addr,))
87 def _join_error(self, failure = None):
88 """Called when a single bootstrap node has failed."""
89 self.outstandingJoins -= 1
90 log.msg("bootstrap node could not be reached")
91 if self.outstandingJoins <= 0:
92 self.khashmir.findCloseNodes(self._join_complete, self._join_complete)
94 def _join_complete(self, result):
95 """Called when the tables have been initialized with nodes."""
96 if not self.joined and len(result) > 0:
98 if self.joining and self.outstandingJoins <= 0:
101 if self.joined or self.bootstrap_node:
103 df.callback(self.foundAddrs)
105 df.errback(DHTError('could not find any nodes to bootstrap to'))
108 return self.foundAddrs
111 """See L{apt_dht.interfaces.IDHT}."""
112 if self.config is None:
113 raise DHTError, "configuration not loaded"
115 if self.joined or self.joining:
117 self.joining.errback(DHTError('still joining when leave was called'))
120 self.khashmir.shutdown()
122 def getValue(self, key):
123 """See L{apt_dht.interfaces.IDHT}."""
124 if self.config is None:
125 raise DHTError, "configuration not loaded"
127 raise DHTError, "have not joined a network yet"
130 if key not in self.retrieving:
131 self.khashmir.valueForKey(key, self._getValue)
132 self.retrieving.setdefault(key, []).append(d)
135 def _getValue(self, key, result):
137 self.retrieved.setdefault(key, []).extend(result)
140 if key in self.retrieved:
141 final_result = self.retrieved[key]
142 del self.retrieved[key]
143 for i in range(len(self.retrieving[key])):
144 d = self.retrieving[key].pop(0)
145 d.callback(final_result)
146 del self.retrieving[key]
148 def storeValue(self, key, value):
149 """See L{apt_dht.interfaces.IDHT}."""
150 if self.config is None:
151 raise DHTError, "configuration not loaded"
153 raise DHTError, "have not joined a network yet"
155 if key in self.storing and value in self.storing[key]:
156 raise DHTError, "already storing that key with the same value"
159 self.khashmir.storeValueForKey(key, value, self._storeValue)
160 self.storing.setdefault(key, {})[value] = d
163 def _storeValue(self, key, value, result):
164 if key in self.storing and value in self.storing[key]:
166 self.storing[key][value].callback(result)
168 self.storing[key][value].errback(DHTError('could not store value %s in key %s' % (value, key)))
169 del self.storing[key][value]
170 if len(self.storing[key].keys()) == 0:
171 del self.storing[key]
173 class TestSimpleDHT(unittest.TestCase):
174 """Unit tests for the DHT."""
177 DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
178 'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
179 'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
180 'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
181 'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
182 'KE_AGE': 3600, 'SPEW': False, }
187 self.a.config = self.DHT_DEFAULTS.copy()
188 self.a.config['PORT'] = 4044
189 self.a.bootstrap = ["127.0.0.1:4044"]
190 self.a.bootstrap_node = True
191 self.a.cache_dir = '/tmp'
192 self.b.config = self.DHT_DEFAULTS.copy()
193 self.b.config['PORT'] = 4045
194 self.b.bootstrap = ["127.0.0.1:4044"]
195 self.b.cache_dir = '/tmp'
197 def test_bootstrap_join(self):
201 def node_join(self, result):
206 self.lastDefer = defer.Deferred()
208 d.addCallback(self.node_join)
209 d.addCallback(self.lastDefer.callback)
210 return self.lastDefer
212 def value_stored(self, result, value):
217 def store_values(self, result):
219 d = self.a.storeValue(sha.new('4045').digest(), str(4045*3))
220 d.addCallback(self.value_stored, 4045)
221 d = self.a.storeValue(sha.new('4044').digest(), str(4044*2))
222 d.addCallback(self.value_stored, 4044)
223 d = self.b.storeValue(sha.new('4045').digest(), str(4045*2))
224 d.addCallback(self.value_stored, 4045)
226 def check_values(self, result, values):
228 self.failUnless(len(result) == len(values))
230 self.failUnless(v in values)
231 if self.checked == 0:
232 self.lastDefer.callback(1)
234 def get_values(self):
236 d = self.a.getValue(sha.new('4044').digest())
237 d.addCallback(self.check_values, [str(4044*2)])
238 d = self.b.getValue(sha.new('4044').digest())
239 d.addCallback(self.check_values, [str(4044*2)])
240 d = self.a.getValue(sha.new('4045').digest())
241 d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
242 d = self.b.getValue(sha.new('4045').digest())
243 d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
245 def test_store(self):
246 from twisted.internet.base import DelayedCall
247 DelayedCall.debug = True
248 self.lastDefer = defer.Deferred()
250 d.addCallback(self.node_join)
251 d.addCallback(self.store_values)
252 return self.lastDefer
257 os.unlink(self.a.khashmir.store.db)
262 os.unlink(self.b.khashmir.store.db)
266 class TestMultiDHT(unittest.TestCase):
270 DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
271 'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
272 'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
273 'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
274 'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
275 'KE_AGE': 3600, 'SPEW': False, }
279 self.startport = 4081
280 for i in range(self.num):
282 self.l[i].config = self.DHT_DEFAULTS.copy()
283 self.l[i].config['PORT'] = self.startport + i
284 self.l[i].bootstrap = ["127.0.0.1:" + str(self.startport)]
285 self.l[i].cache_dir = '/tmp'
286 self.l[0].bootstrap_node = True
288 def node_join(self, result, next_node):
289 d = self.l[next_node].join()
290 if next_node + 1 < len(self.l):
291 d.addCallback(self.node_join, next_node + 1)
293 d.addCallback(self.lastDefer.callback)
297 self.lastDefer = defer.Deferred()
299 d.addCallback(self.node_join, 1)
300 return self.lastDefer
302 def store_values(self, result, i = 0, j = 0):
309 d = self.l[j].storeValue(sha.new(str(self.startport+i)).digest(), str((self.startport+i)*(j+1)))
310 d.addCallback(self.store_values, i, j+1)
312 def get_values(self, result = None, check = None, i = 0, j = 0):
313 if result is not None:
314 self.failUnless(len(result) == len(check))
316 self.failUnless(v in check)
321 self.lastDefer.callback(1)
323 d = self.l[i].getValue(sha.new(str(self.startport+j)).digest())
325 for k in range(self.startport+j, (self.startport+j)*(j+1)+1, self.startport+j):
327 d.addCallback(self.get_values, check, i, j + random.randrange(1, min(len(self.l), 10)))
329 def store_join(self, result, next_node):
330 d = self.l[next_node].join()
331 if next_node + 1 < len(self.l):
332 d.addCallback(self.store_join, next_node + 1)
334 d.addCallback(self.store_values)
336 def test_store(self):
337 from twisted.internet.base import DelayedCall
338 DelayedCall.debug = True
339 self.lastDefer = defer.Deferred()
341 d.addCallback(self.store_join, 1)
342 return self.lastDefer
348 os.unlink(i.khashmir.store.db)