4 from twisted.internet import defer
5 from twisted.trial import unittest
6 from zope.interface import implements
8 from apt_dht.interfaces import IDHT
9 from khashmir import Khashmir
11 class DHTError(Exception):
12 """Represents errors that occur in the DHT."""
22 self.bootstrap_node = False
29 def loadConfig(self, config, section):
30 """See L{apt_dht.interfaces.IDHT}."""
31 self.config_parser = config
32 self.section = section
34 self.cache_dir = self.config_parser.get('DEFAULT', 'cache_dir')
35 self.bootstrap = self.config_parser.getstringlist(section, 'BOOTSTRAP')
36 self.bootstrap_node = self.config_parser.getboolean(section, 'BOOTSTRAP_NODE')
37 for k in self.config_parser.options(section):
38 if k in ['K', 'HASH_LENGTH', 'CONCURRENT_REQS', 'STORE_REDUNDANCY',
39 'MAX_FAILURES', 'PORT']:
40 self.config[k] = self.config_parser.getint(section, k)
41 elif k in ['CHECKPOINT_INTERVAL', 'MIN_PING_INTERVAL',
42 'BUCKET_STALENESS', 'KEINITIAL_DELAY', 'KE_DELAY', 'KE_AGE']:
43 self.config[k] = self.config_parser.gettime(section, k)
45 self.config[k] = self.config_parser.get(section, k)
46 if 'PORT' not in self.config:
47 self.config['PORT'] = self.config_parser.getint('DEFAULT', 'PORT')
50 """See L{apt_dht.interfaces.IDHT}."""
51 if self.config is None:
52 raise DHTError, "configuration not loaded"
54 raise DHTError, "a join is already in progress"
56 self.khashmir = Khashmir(self.config, self.cache_dir)
58 self.joining = defer.Deferred()
59 for node in self.bootstrap:
60 host, port = node.rsplit(':', 1)
62 self.khashmir.addContact(host, port, self._join_single)
66 def _join_single(self):
67 """Called when a single bootstrap node has been added."""
68 self.khashmir.findCloseNodes(self._join_complete)
70 def _join_complete(self, result):
71 """Called when the tables have been initialized with nodes."""
74 if len(result) > 0 or self.bootstrap_node:
81 df.errback(DHTError('could not find any nodes to bootstrap to'))
84 """See L{apt_dht.interfaces.IDHT}."""
85 if self.config is None:
86 raise DHTError, "configuration not loaded"
88 if self.joined or self.joining:
90 self.joining.errback(DHTError('still joining when leave was called'))
93 self.khashmir.shutdown()
95 def getValue(self, key):
96 """See L{apt_dht.interfaces.IDHT}."""
97 if self.config is None:
98 raise DHTError, "configuration not loaded"
100 raise DHTError, "have not joined a network yet"
103 if key not in self.retrieving:
104 self.khashmir.valueForKey(key, self._getValue)
105 self.retrieving.setdefault(key, []).append(d)
108 def _getValue(self, key, result = -1):
110 self.retrieved.setdefault(key, []).extend(result)
113 if key in self.retrieved:
114 final_result = self.retrieved[key]
115 del self.retrieved[key]
116 for i in range(len(self.retrieving[key])):
117 d = self.retrieving[key].pop(0)
118 d.callback(final_result)
119 del self.retrieving[key]
121 def storeValue(self, key, value):
122 """See L{apt_dht.interfaces.IDHT}."""
123 if self.config is None:
124 raise DHTError, "configuration not loaded"
126 raise DHTError, "have not joined a network yet"
128 if key in self.storing and value in self.storing[key]:
129 raise DHTError, "already storing that key with the same value"
132 self.khashmir.storeValueForKey(key, value, self._storeValue)
133 self.storing.setdefault(key, {})[value] = d
136 def _storeValue(self, key, value, result):
137 if key in self.storing and value in self.storing[key]:
139 self.storing[key][value].callback(result)
141 self.storing[key][value].errback(DHTError('could not store value %s in key %s' % (value, key)))
142 del self.storing[key][value]
143 if len(self.storing[key].keys()) == 0:
144 del self.storing[key]
146 class TestSimpleDHT(unittest.TestCase):
147 """Unit tests for the DHT."""
150 DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
151 'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
152 'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
153 'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
154 'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
160 self.a.config = self.DHT_DEFAULTS.copy()
161 self.a.config['PORT'] = 4044
162 self.a.bootstrap = ["127.0.0.1:4044"]
163 self.a.bootstrap_node = True
164 self.a.cache_dir = '/tmp'
165 self.b.config = self.DHT_DEFAULTS.copy()
166 self.b.config['PORT'] = 4045
167 self.b.bootstrap = ["127.0.0.1:4044"]
168 self.b.cache_dir = '/tmp'
170 def test_bootstrap_join(self):
174 def node_join(self, result):
179 self.lastDefer = defer.Deferred()
181 d.addCallback(self.node_join)
182 d.addCallback(self.lastDefer.callback)
183 return self.lastDefer
185 def value_stored(self, result, value):
190 def store_values(self, result):
192 d = self.a.storeValue(sha.new('4045').digest(), str(4045*3))
193 d.addCallback(self.value_stored, 4045)
194 d = self.a.storeValue(sha.new('4044').digest(), str(4044*2))
195 d.addCallback(self.value_stored, 4044)
196 d = self.b.storeValue(sha.new('4045').digest(), str(4045*2))
197 d.addCallback(self.value_stored, 4045)
199 def check_values(self, result, values):
201 self.failUnless(len(result) == len(values))
203 self.failUnless(v in values)
204 if self.checked == 0:
205 self.lastDefer.callback(1)
207 def get_values(self):
209 d = self.a.getValue(sha.new('4044').digest())
210 d.addCallback(self.check_values, [str(4044*2)])
211 d = self.b.getValue(sha.new('4044').digest())
212 d.addCallback(self.check_values, [str(4044*2)])
213 d = self.a.getValue(sha.new('4045').digest())
214 d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
215 d = self.b.getValue(sha.new('4045').digest())
216 d.addCallback(self.check_values, [str(4045*2), str(4045*3)])
218 def test_store(self):
219 from twisted.internet.base import DelayedCall
220 DelayedCall.debug = True
221 self.lastDefer = defer.Deferred()
223 d.addCallback(self.node_join)
224 d.addCallback(self.store_values)
225 return self.lastDefer
230 os.unlink(self.a.khashmir.db)
235 os.unlink(self.b.khashmir.db)
239 class TestMultiDHT(unittest.TestCase):
243 DHT_DEFAULTS = {'PORT': 9977, 'K': 8, 'HASH_LENGTH': 160,
244 'CHECKPOINT_INTERVAL': 900, 'CONCURRENT_REQS': 4,
245 'STORE_REDUNDANCY': 3, 'MAX_FAILURES': 3,
246 'MIN_PING_INTERVAL': 900,'BUCKET_STALENESS': 3600,
247 'KEINITIAL_DELAY': 15, 'KE_DELAY': 1200,
252 self.startport = 4081
253 for i in range(self.num):
255 self.l[i].config = self.DHT_DEFAULTS.copy()
256 self.l[i].config['PORT'] = self.startport + i
257 self.l[i].bootstrap = ["127.0.0.1:" + str(self.startport)]
258 self.l[i].cache_dir = '/tmp'
259 self.l[0].bootstrap_node = True
261 def node_join(self, result, next_node):
262 d = self.l[next_node].join()
263 if next_node + 1 < len(self.l):
264 d.addCallback(self.node_join, next_node + 1)
266 d.addCallback(self.lastDefer.callback)
270 self.lastDefer = defer.Deferred()
272 d.addCallback(self.node_join, 1)
273 return self.lastDefer
275 def value_stored(self, result, value):
280 def store_values(self, result):
282 for i in range(len(self.l)):
283 for j in range(0, i+1):
285 d = self.l[j].storeValue(sha.new(str(self.startport+i)).digest(), str((self.startport+i)*(j+1)))
286 d.addCallback(self.value_stored, self.startport+i)
288 def check_values(self, result, values):
290 self.failUnless(len(result) == len(values))
292 self.failUnless(v in values)
293 if self.checked == 0:
294 self.lastDefer.callback(1)
296 def get_values(self):
298 for i in range(len(self.l)):
299 for j in random.sample(xrange(len(self.l)), 4):
301 d = self.l[i].getValue(sha.new(str(self.startport+j)).digest())
303 for k in range(self.startport+j, (self.startport+j)*(j+1)+1, self.startport+j):
305 d.addCallback(self.check_values, check)
307 def store_join(self, result, next_node):
308 d = self.l[next_node].join()
309 if next_node + 1 < len(self.l):
310 d.addCallback(self.store_join, next_node + 1)
312 d.addCallback(self.store_values)
314 def test_store(self):
315 from twisted.internet.base import DelayedCall
316 DelayedCall.debug = True
317 self.lastDefer = defer.Deferred()
319 d.addCallback(self.store_join, 1)
320 return self.lastDefer
326 os.unlink(i.khashmir.db)