2 from twisted.trial import unittest
3 from allmydata import uri
4 from allmydata.util import hashutil
5 from allmydata.interfaces import IURI, IFileURI, IDirnodeURI, IMutableFileURI, \
8 class Literal(unittest.TestCase):
9 def _help_test(self, data):
10 u = uri.LiteralFileURI(data)
11 self.failUnless(IURI.providedBy(u))
12 self.failUnless(IFileURI.providedBy(u))
13 self.failIf(IDirnodeURI.providedBy(u))
14 self.failUnlessEqual(u.data, data)
15 self.failUnlessEqual(u.get_size(), len(data))
16 self.failUnless(u.is_readonly())
17 self.failIf(u.is_mutable())
19 u2 = uri.from_string(u.to_string())
20 self.failUnless(IURI.providedBy(u2))
21 self.failUnless(IFileURI.providedBy(u2))
22 self.failIf(IDirnodeURI.providedBy(u2))
23 self.failUnlessEqual(u2.data, data)
24 self.failUnlessEqual(u2.get_size(), len(data))
25 self.failUnless(u.is_readonly())
26 self.failIf(u.is_mutable())
29 self.failUnlessIdentical(u, u3)
30 self.failUnlessEqual(u.get_verify_cap(), None)
32 he = u.to_human_encoding()
33 u_h = uri.LiteralFileURI.init_from_human_encoding(he)
34 self.failUnlessEqual(u, u_h)
37 data = "" # This data is some *very* small data!
38 return self._help_test(data)
41 data = "This is some small data"
42 return self._help_test(data)
44 def test_nonascii(self):
45 data = "This contains \x00 and URI:LIT: and \n, oh my."
46 return self._help_test(data)
48 class Compare(unittest.TestCase):
49 def test_compare(self):
50 lit1 = uri.LiteralFileURI("some data")
51 fileURI = 'URI:CHK:f5ahxa25t4qkktywz6teyfvcx4:opuioq7tj2y6idzfp6cazehtmgs5fdcebcz3cygrxyydvcozrmeq:3:10:345834'
52 chk1 = uri.CHKFileURI.init_from_string(fileURI)
53 chk2 = uri.CHKFileURI.init_from_string(fileURI)
54 self.failIfEqual(lit1, chk1)
55 self.failUnlessEqual(chk1, chk2)
56 self.failIfEqual(chk1, "not actually a URI")
57 # these should be hashable too
58 s = set([lit1, chk1, chk2])
59 self.failUnlessEqual(len(s), 2) # since chk1==chk2
61 def test_is_uri(self):
62 lit1 = uri.LiteralFileURI("some data").to_string()
63 self.failUnless(uri.is_uri(lit1))
64 self.failIf(uri.is_uri(None))
66 class CHKFile(unittest.TestCase):
68 key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
69 storage_index = hashutil.storage_index_hash(key)
70 uri_extension_hash = hashutil.uri_extension_hash("stuff")
74 u = uri.CHKFileURI(key=key,
75 uri_extension_hash=uri_extension_hash,
76 needed_shares=needed_shares,
77 total_shares=total_shares,
79 self.failUnlessEqual(u.storage_index, storage_index)
80 self.failUnlessEqual(u.key, key)
81 self.failUnlessEqual(u.uri_extension_hash, uri_extension_hash)
82 self.failUnlessEqual(u.needed_shares, needed_shares)
83 self.failUnlessEqual(u.total_shares, total_shares)
84 self.failUnlessEqual(u.size, size)
85 self.failUnless(u.is_readonly())
86 self.failIf(u.is_mutable())
87 self.failUnless(IURI.providedBy(u))
88 self.failUnless(IFileURI.providedBy(u))
89 self.failIf(IDirnodeURI.providedBy(u))
90 self.failUnlessEqual(u.get_size(), 1234)
91 self.failUnless(u.is_readonly())
92 self.failIf(u.is_mutable())
93 u_ro = u.get_readonly()
94 self.failUnlessIdentical(u, u_ro)
95 u1a = IFileURI(u.to_string())
96 self.failUnlessEqual(u1a, u)
97 he = u.to_human_encoding()
98 self.failUnlessEqual(he, "http://127.0.0.1:3456/uri/" + u.to_string())
99 self.failUnlessEqual(uri.CHKFileURI.init_from_human_encoding(he), u)
101 u2 = uri.from_string(u.to_string())
102 self.failUnlessEqual(u2.storage_index, storage_index)
103 self.failUnlessEqual(u2.key, key)
104 self.failUnlessEqual(u2.uri_extension_hash, uri_extension_hash)
105 self.failUnlessEqual(u2.needed_shares, needed_shares)
106 self.failUnlessEqual(u2.total_shares, total_shares)
107 self.failUnlessEqual(u2.size, size)
108 self.failUnless(u2.is_readonly())
109 self.failIf(u2.is_mutable())
110 self.failUnless(IURI.providedBy(u2))
111 self.failUnless(IFileURI.providedBy(u2))
112 self.failIf(IDirnodeURI.providedBy(u2))
113 self.failUnlessEqual(u2.get_size(), 1234)
114 self.failUnless(u2.is_readonly())
115 self.failIf(u2.is_mutable())
117 v = u.get_verify_cap()
118 self.failUnless(isinstance(v.to_string(), str))
119 v2 = uri.from_string(v.to_string())
120 self.failUnlessEqual(v, v2)
121 he = v.to_human_encoding()
122 v2_h = uri.CHKFileVerifierURI.init_from_human_encoding(he)
123 self.failUnlessEqual(v2, v2_h)
125 v3 = uri.CHKFileVerifierURI(storage_index="\x00"*16,
126 uri_extension_hash="\x00"*32,
130 self.failUnless(isinstance(v3.to_string(), str))
132 def test_pack_badly(self):
133 key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
134 storage_index = hashutil.storage_index_hash(key)
135 uri_extension_hash = hashutil.uri_extension_hash("stuff")
139 self.failUnlessRaises(TypeError,
142 uri_extension_hash=uri_extension_hash,
143 needed_shares=needed_shares,
144 total_shares=total_shares,
147 bogus_extra_argument="reject me",
149 self.failUnlessRaises(TypeError,
150 uri.CHKFileVerifierURI,
152 self.failUnlessRaises(TypeError,
153 uri.CHKFileVerifierURI,
154 storage_index=storage_index,
155 uri_extension_hash=uri_extension_hash,
158 # leave size= missing
162 class Extension(unittest.TestCase):
164 data = {"stuff": "value",
167 "big_hash": hashutil.tagged_hash("foo", "bar"),
169 ext = uri.pack_extension(data)
170 d = uri.unpack_extension(ext)
171 self.failUnlessEqual(d["stuff"], "value")
172 self.failUnlessEqual(d["size"], 12)
173 self.failUnlessEqual(d["big_hash"], hashutil.tagged_hash("foo", "bar"))
175 readable = uri.unpack_extension_readable(ext)
177 class Invalid(unittest.TestCase):
178 def test_from_future(self):
179 # any URI type that we don't recognize should be treated as unknown
180 future_uri = "I am a URI from the future. Whatever you do, don't "
181 u = uri.from_string(future_uri)
182 self.failUnless(isinstance(u, uri.UnknownURI))
183 self.failUnlessEqual(u.to_string(), future_uri)
185 class Constraint(unittest.TestCase):
186 def test_constraint(self):
187 good="http://127.0.0.1:3456/uri/URI%3ADIR2%3Agh3l5rbvnv2333mrfvalmjfr4i%3Alz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma/"
188 uri.DirectoryURI.init_from_human_encoding(good)
189 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_string, good)
191 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_human_encoding, bad)
192 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_string, bad)
193 fileURI = 'URI:CHK:gh3l5rbvnv2333mrfvalmjfr4i:lz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma:3:10:345834'
194 uri.CHKFileURI.init_from_string(fileURI)
196 class Mutable(unittest.TestCase):
198 writekey = "\x01" * 16
199 fingerprint = "\x02" * 32
201 u = uri.WriteableSSKFileURI(writekey, fingerprint)
202 self.failUnlessEqual(u.writekey, writekey)
203 self.failUnlessEqual(u.fingerprint, fingerprint)
204 self.failIf(u.is_readonly())
205 self.failUnless(u.is_mutable())
206 self.failUnless(IURI.providedBy(u))
207 self.failUnless(IMutableFileURI.providedBy(u))
208 self.failIf(IDirnodeURI.providedBy(u))
209 self.failUnless("WriteableSSKFileURI" in str(u))
210 u1a = IMutableFileURI(u.to_string())
211 self.failUnlessEqual(u1a, u)
213 he = u.to_human_encoding()
214 u_h = uri.WriteableSSKFileURI.init_from_human_encoding(he)
215 self.failUnlessEqual(u, u_h)
217 u2 = uri.from_string(u.to_string())
218 self.failUnlessEqual(u2.writekey, writekey)
219 self.failUnlessEqual(u2.fingerprint, fingerprint)
220 self.failIf(u2.is_readonly())
221 self.failUnless(u2.is_mutable())
222 self.failUnless(IURI.providedBy(u2))
223 self.failUnless(IMutableFileURI.providedBy(u2))
224 self.failIf(IDirnodeURI.providedBy(u2))
226 u3 = u2.get_readonly()
227 readkey = hashutil.ssk_readkey_hash(writekey)
228 self.failUnlessEqual(u3.fingerprint, fingerprint)
229 self.failUnlessEqual(u3.readkey, readkey)
230 self.failUnless(u3.is_readonly())
231 self.failUnless(u3.is_mutable())
232 self.failUnless(IURI.providedBy(u3))
233 self.failUnless(IMutableFileURI.providedBy(u3))
234 self.failIf(IDirnodeURI.providedBy(u3))
236 he = u3.to_human_encoding()
237 u3_h = uri.ReadonlySSKFileURI.init_from_human_encoding(he)
238 self.failUnlessEqual(u3, u3_h)
240 u4 = uri.ReadonlySSKFileURI(readkey, fingerprint)
241 self.failUnlessEqual(u4.fingerprint, fingerprint)
242 self.failUnlessEqual(u4.readkey, readkey)
243 self.failUnless(u4.is_readonly())
244 self.failUnless(u4.is_mutable())
245 self.failUnless(IURI.providedBy(u4))
246 self.failUnless(IMutableFileURI.providedBy(u4))
247 self.failIf(IDirnodeURI.providedBy(u4))
249 u4a = uri.from_string(u4.to_string())
250 self.failUnlessEqual(u4a, u4)
251 self.failUnless("ReadonlySSKFileURI" in str(u4a))
252 self.failUnlessIdentical(u4a.get_readonly(), u4a)
254 u5 = u4.get_verify_cap()
255 self.failUnless(IVerifierURI.providedBy(u5))
256 self.failUnlessEqual(u5.storage_index, u.storage_index)
257 u6 = IVerifierURI(u5.to_string())
258 self.failUnless(IVerifierURI.providedBy(u6))
259 self.failUnlessEqual(u6.storage_index, u.storage_index)
260 u7 = u.get_verify_cap()
261 self.failUnless(IVerifierURI.providedBy(u7))
262 self.failUnlessEqual(u7.storage_index, u.storage_index)
264 he = u5.to_human_encoding()
265 u5_h = uri.SSKVerifierURI.init_from_human_encoding(he)
266 self.failUnlessEqual(u5, u5_h)
269 class NewDirnode(unittest.TestCase):
271 writekey = "\x01" * 16
272 fingerprint = "\x02" * 32
274 n = uri.WriteableSSKFileURI(writekey, fingerprint)
275 u1 = uri.DirectoryURI(n)
276 self.failIf(u1.is_readonly())
277 self.failUnless(u1.is_mutable())
278 self.failUnless(IURI.providedBy(u1))
279 self.failIf(IFileURI.providedBy(u1))
280 self.failUnless(IDirnodeURI.providedBy(u1))
281 self.failUnless("DirectoryURI" in str(u1))
282 u1_filenode = u1.get_filenode_cap()
283 self.failUnless(u1_filenode.is_mutable())
284 self.failIf(u1_filenode.is_readonly())
285 u1a = IDirnodeURI(u1.to_string())
286 self.failUnlessEqual(u1a, u1)
288 u2 = uri.from_string(u1.to_string())
289 self.failUnlessEqual(u1.to_string(), u2.to_string())
290 self.failIf(u2.is_readonly())
291 self.failUnless(u2.is_mutable())
292 self.failUnless(IURI.providedBy(u2))
293 self.failIf(IFileURI.providedBy(u2))
294 self.failUnless(IDirnodeURI.providedBy(u2))
296 u3 = u2.get_readonly()
297 self.failUnless(u3.is_readonly())
298 self.failUnless(u3.is_mutable())
299 self.failUnless(IURI.providedBy(u3))
300 self.failIf(IFileURI.providedBy(u3))
301 self.failUnless(IDirnodeURI.providedBy(u3))
302 u3n = u3._filenode_uri
303 self.failUnless(u3n.is_readonly())
304 self.failUnless(u3n.is_mutable())
305 u3_filenode = u3.get_filenode_cap()
306 self.failUnless(u3_filenode.is_mutable())
307 self.failUnless(u3_filenode.is_readonly())
309 u3a = uri.from_string(u3.to_string())
310 self.failUnlessIdentical(u3a, u3a.get_readonly())
312 u4 = uri.ReadonlyDirectoryURI(u2._filenode_uri.get_readonly())
313 self.failUnlessEqual(u4.to_string(), u3.to_string())
314 self.failUnless(u4.is_readonly())
315 self.failUnless(u4.is_mutable())
316 self.failUnless(IURI.providedBy(u4))
317 self.failIf(IFileURI.providedBy(u4))
318 self.failUnless(IDirnodeURI.providedBy(u4))
320 u4_verifier = u4.get_verify_cap()
321 u4_verifier_filenode = u4_verifier.get_filenode_cap()
322 self.failUnless(isinstance(u4_verifier_filenode, uri.SSKVerifierURI))
324 verifiers = [u1.get_verify_cap(), u2.get_verify_cap(),
325 u3.get_verify_cap(), u4.get_verify_cap(),
326 IVerifierURI(u1.get_verify_cap().to_string()),
327 uri.DirectoryURIVerifier(n.get_verify_cap()),
328 uri.DirectoryURIVerifier(n.get_verify_cap().to_string()),
331 self.failUnless(IVerifierURI.providedBy(v))
332 self.failUnlessEqual(v._filenode_uri,
333 u1.get_verify_cap()._filenode_uri)
335 def test_immutable(self):
336 readkey = "\x01" * 16
337 uri_extension_hash = hashutil.uri_extension_hash("stuff")
342 fnuri = uri.CHKFileURI(key=readkey,
343 uri_extension_hash=uri_extension_hash,
344 needed_shares=needed_shares,
345 total_shares=total_shares,
347 fncap = fnuri.to_string()
348 self.failUnlessEqual(fncap, "URI:CHK:aeaqcaibaeaqcaibaeaqcaibae:nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa:3:10:1234")
349 u1 = uri.ImmutableDirectoryURI(fnuri)
350 self.failUnless(u1.is_readonly())
351 self.failIf(u1.is_mutable())
352 self.failUnless(IURI.providedBy(u1))
353 self.failIf(IFileURI.providedBy(u1))
354 self.failUnless(IDirnodeURI.providedBy(u1))
355 self.failUnless("DirectoryURI" in str(u1))
356 u1_filenode = u1.get_filenode_cap()
357 self.failIf(u1_filenode.is_mutable())
358 self.failUnless(u1_filenode.is_readonly())
359 self.failUnlessEqual(u1_filenode.to_string(), fncap)
360 self.failUnless(str(u1))
362 u2 = uri.from_string(u1.to_string())
363 self.failUnlessEqual(u1.to_string(), u2.to_string())
364 self.failUnless(u2.is_readonly())
365 self.failIf(u2.is_mutable())
366 self.failUnless(IURI.providedBy(u2))
367 self.failIf(IFileURI.providedBy(u2))
368 self.failUnless(IDirnodeURI.providedBy(u2))
370 u3 = u2.get_readonly()
371 self.failUnlessEqual(u3.to_string(), u2.to_string())
372 self.failUnless(str(u3))
374 u2_verifier = u2.get_verify_cap()
375 self.failUnless(isinstance(u2_verifier,
376 uri.ImmutableDirectoryURIVerifier), u2_verifier)
377 self.failUnless(IVerifierURI.providedBy(u2_verifier))
378 u2_verifier_fileuri = u2_verifier.get_filenode_cap()
379 self.failUnless(IVerifierURI.providedBy(u2_verifier_fileuri))
380 self.failUnlessEqual(u2_verifier_fileuri.to_string(),
381 fnuri.get_verify_cap().to_string())
382 self.failUnless(str(u2_verifier))
384 def test_literal(self):
385 u1 = uri.LiteralDirectoryURI("data")
386 self.failUnless(str(u1))
388 self.failUnlessEqual(u1.to_string(), "URI:DIR2-LIT:mrqxiyi")
389 self.failUnless(u1.is_readonly())
390 self.failIf(u1.is_mutable())
391 self.failUnless(IURI.providedBy(u1))
392 self.failIf(IFileURI.providedBy(u1))
393 self.failUnless(IDirnodeURI.providedBy(u1))
394 self.failUnlessEqual(u1.get_verify_cap(), None)