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 he = u.to_human_encoding()
96 self.failUnlessEqual(he, "http://127.0.0.1:3456/uri/" + u.to_string())
97 self.failUnlessEqual(uri.CHKFileURI.init_from_human_encoding(he), u)
99 u2 = uri.from_string(u.to_string())
100 self.failUnlessEqual(u2.storage_index, storage_index)
101 self.failUnlessEqual(u2.key, key)
102 self.failUnlessEqual(u2.uri_extension_hash, uri_extension_hash)
103 self.failUnlessEqual(u2.needed_shares, needed_shares)
104 self.failUnlessEqual(u2.total_shares, total_shares)
105 self.failUnlessEqual(u2.size, size)
106 self.failUnless(u2.is_readonly())
107 self.failIf(u2.is_mutable())
108 self.failUnless(IURI.providedBy(u2))
109 self.failUnless(IFileURI.providedBy(u2))
110 self.failIf(IDirnodeURI.providedBy(u2))
111 self.failUnlessEqual(u2.get_size(), 1234)
112 self.failUnless(u2.is_readonly())
113 self.failIf(u2.is_mutable())
115 v = u.get_verify_cap()
116 self.failUnless(isinstance(v.to_string(), str))
117 v2 = uri.from_string(v.to_string())
118 self.failUnlessEqual(v, v2)
119 he = v.to_human_encoding()
120 v2_h = uri.CHKFileVerifierURI.init_from_human_encoding(he)
121 self.failUnlessEqual(v2, v2_h)
123 v3 = uri.CHKFileVerifierURI(storage_index="\x00"*16,
124 uri_extension_hash="\x00"*32,
128 self.failUnless(isinstance(v3.to_string(), str))
130 def test_pack_badly(self):
131 key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
132 storage_index = hashutil.storage_index_hash(key)
133 uri_extension_hash = hashutil.uri_extension_hash("stuff")
137 self.failUnlessRaises(TypeError,
140 uri_extension_hash=uri_extension_hash,
141 needed_shares=needed_shares,
142 total_shares=total_shares,
145 bogus_extra_argument="reject me",
147 self.failUnlessRaises(TypeError,
148 uri.CHKFileVerifierURI,
150 self.failUnlessRaises(TypeError,
151 uri.CHKFileVerifierURI,
152 storage_index=storage_index,
153 uri_extension_hash=uri_extension_hash,
156 # leave size= missing
160 class Extension(unittest.TestCase):
162 data = {"stuff": "value",
165 "big_hash": hashutil.tagged_hash("foo", "bar"),
167 ext = uri.pack_extension(data)
168 d = uri.unpack_extension(ext)
169 self.failUnlessEqual(d["stuff"], "value")
170 self.failUnlessEqual(d["size"], 12)
171 self.failUnlessEqual(d["big_hash"], hashutil.tagged_hash("foo", "bar"))
173 readable = uri.unpack_extension_readable(ext)
175 class Invalid(unittest.TestCase):
176 def test_from_future(self):
177 # any URI type that we don't recognize should be treated as unknown
178 future_uri = "I am a URI from the future. Whatever you do, don't "
179 u = uri.from_string(future_uri)
180 self.failUnless(isinstance(u, uri.UnknownURI))
181 self.failUnlessEqual(u.to_string(), future_uri)
183 class Constraint(unittest.TestCase):
184 def test_constraint(self):
185 good="http://127.0.0.1:3456/uri/URI%3ADIR2%3Agh3l5rbvnv2333mrfvalmjfr4i%3Alz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma/"
186 uri.DirectoryURI.init_from_human_encoding(good)
187 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_string, good)
189 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_human_encoding, bad)
190 self.failUnlessRaises(uri.BadURIError, uri.DirectoryURI.init_from_string, bad)
191 fileURI = 'URI:CHK:gh3l5rbvnv2333mrfvalmjfr4i:lz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma:3:10:345834'
192 uri.CHKFileURI.init_from_string(fileURI)
194 class Mutable(unittest.TestCase):
196 writekey = "\x01" * 16
197 fingerprint = "\x02" * 32
199 u = uri.WriteableSSKFileURI(writekey, fingerprint)
200 self.failUnlessEqual(u.writekey, writekey)
201 self.failUnlessEqual(u.fingerprint, fingerprint)
202 self.failIf(u.is_readonly())
203 self.failUnless(u.is_mutable())
204 self.failUnless(IURI.providedBy(u))
205 self.failUnless(IMutableFileURI.providedBy(u))
206 self.failIf(IDirnodeURI.providedBy(u))
207 self.failUnless("WriteableSSKFileURI" in str(u))
209 he = u.to_human_encoding()
210 u_h = uri.WriteableSSKFileURI.init_from_human_encoding(he)
211 self.failUnlessEqual(u, u_h)
213 u2 = uri.from_string(u.to_string())
214 self.failUnlessEqual(u2.writekey, writekey)
215 self.failUnlessEqual(u2.fingerprint, fingerprint)
216 self.failIf(u2.is_readonly())
217 self.failUnless(u2.is_mutable())
218 self.failUnless(IURI.providedBy(u2))
219 self.failUnless(IMutableFileURI.providedBy(u2))
220 self.failIf(IDirnodeURI.providedBy(u2))
222 u3 = u2.get_readonly()
223 readkey = hashutil.ssk_readkey_hash(writekey)
224 self.failUnlessEqual(u3.fingerprint, fingerprint)
225 self.failUnlessEqual(u3.readkey, readkey)
226 self.failUnless(u3.is_readonly())
227 self.failUnless(u3.is_mutable())
228 self.failUnless(IURI.providedBy(u3))
229 self.failUnless(IMutableFileURI.providedBy(u3))
230 self.failIf(IDirnodeURI.providedBy(u3))
232 he = u3.to_human_encoding()
233 u3_h = uri.ReadonlySSKFileURI.init_from_human_encoding(he)
234 self.failUnlessEqual(u3, u3_h)
236 u4 = uri.ReadonlySSKFileURI(readkey, fingerprint)
237 self.failUnlessEqual(u4.fingerprint, fingerprint)
238 self.failUnlessEqual(u4.readkey, readkey)
239 self.failUnless(u4.is_readonly())
240 self.failUnless(u4.is_mutable())
241 self.failUnless(IURI.providedBy(u4))
242 self.failUnless(IMutableFileURI.providedBy(u4))
243 self.failIf(IDirnodeURI.providedBy(u4))
245 u4a = uri.from_string(u4.to_string())
246 self.failUnlessEqual(u4a, u4)
247 self.failUnless("ReadonlySSKFileURI" in str(u4a))
248 self.failUnlessIdentical(u4a.get_readonly(), u4a)
250 u5 = u4.get_verify_cap()
251 self.failUnless(IVerifierURI.providedBy(u5))
252 self.failUnlessEqual(u5.storage_index, u.storage_index)
253 u7 = u.get_verify_cap()
254 self.failUnless(IVerifierURI.providedBy(u7))
255 self.failUnlessEqual(u7.storage_index, u.storage_index)
257 he = u5.to_human_encoding()
258 u5_h = uri.SSKVerifierURI.init_from_human_encoding(he)
259 self.failUnlessEqual(u5, u5_h)
262 class Dirnode(unittest.TestCase):
264 writekey = "\x01" * 16
265 fingerprint = "\x02" * 32
267 n = uri.WriteableSSKFileURI(writekey, fingerprint)
268 u1 = uri.DirectoryURI(n)
269 self.failIf(u1.is_readonly())
270 self.failUnless(u1.is_mutable())
271 self.failUnless(IURI.providedBy(u1))
272 self.failIf(IFileURI.providedBy(u1))
273 self.failUnless(IDirnodeURI.providedBy(u1))
274 self.failUnless("DirectoryURI" in str(u1))
275 u1_filenode = u1.get_filenode_cap()
276 self.failUnless(u1_filenode.is_mutable())
277 self.failIf(u1_filenode.is_readonly())
279 u2 = uri.from_string(u1.to_string())
280 self.failUnlessEqual(u1.to_string(), u2.to_string())
281 self.failIf(u2.is_readonly())
282 self.failUnless(u2.is_mutable())
283 self.failUnless(IURI.providedBy(u2))
284 self.failIf(IFileURI.providedBy(u2))
285 self.failUnless(IDirnodeURI.providedBy(u2))
287 u3 = u2.get_readonly()
288 self.failUnless(u3.is_readonly())
289 self.failUnless(u3.is_mutable())
290 self.failUnless(IURI.providedBy(u3))
291 self.failIf(IFileURI.providedBy(u3))
292 self.failUnless(IDirnodeURI.providedBy(u3))
293 u3n = u3._filenode_uri
294 self.failUnless(u3n.is_readonly())
295 self.failUnless(u3n.is_mutable())
296 u3_filenode = u3.get_filenode_cap()
297 self.failUnless(u3_filenode.is_mutable())
298 self.failUnless(u3_filenode.is_readonly())
300 u3a = uri.from_string(u3.to_string())
301 self.failUnlessIdentical(u3a, u3a.get_readonly())
303 u4 = uri.ReadonlyDirectoryURI(u2._filenode_uri.get_readonly())
304 self.failUnlessEqual(u4.to_string(), u3.to_string())
305 self.failUnless(u4.is_readonly())
306 self.failUnless(u4.is_mutable())
307 self.failUnless(IURI.providedBy(u4))
308 self.failIf(IFileURI.providedBy(u4))
309 self.failUnless(IDirnodeURI.providedBy(u4))
311 u4_verifier = u4.get_verify_cap()
312 u4_verifier_filenode = u4_verifier.get_filenode_cap()
313 self.failUnless(isinstance(u4_verifier_filenode, uri.SSKVerifierURI))
315 verifiers = [u1.get_verify_cap(), u2.get_verify_cap(),
316 u3.get_verify_cap(), u4.get_verify_cap(),
317 uri.DirectoryURIVerifier(n.get_verify_cap()),
320 self.failUnless(IVerifierURI.providedBy(v))
321 self.failUnlessEqual(v._filenode_uri,
322 u1.get_verify_cap()._filenode_uri)
324 def test_immutable(self):
325 readkey = "\x01" * 16
326 uri_extension_hash = hashutil.uri_extension_hash("stuff")
331 fnuri = uri.CHKFileURI(key=readkey,
332 uri_extension_hash=uri_extension_hash,
333 needed_shares=needed_shares,
334 total_shares=total_shares,
336 fncap = fnuri.to_string()
337 self.failUnlessEqual(fncap, "URI:CHK:aeaqcaibaeaqcaibaeaqcaibae:nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa:3:10:1234")
338 u1 = uri.ImmutableDirectoryURI(fnuri)
339 self.failUnless(u1.is_readonly())
340 self.failIf(u1.is_mutable())
341 self.failUnless(IURI.providedBy(u1))
342 self.failIf(IFileURI.providedBy(u1))
343 self.failUnless(IDirnodeURI.providedBy(u1))
344 self.failUnless("DirectoryURI" in str(u1))
345 u1_filenode = u1.get_filenode_cap()
346 self.failIf(u1_filenode.is_mutable())
347 self.failUnless(u1_filenode.is_readonly())
348 self.failUnlessEqual(u1_filenode.to_string(), fncap)
349 self.failUnless(str(u1))
351 u2 = uri.from_string(u1.to_string())
352 self.failUnlessEqual(u1.to_string(), u2.to_string())
353 self.failUnless(u2.is_readonly())
354 self.failIf(u2.is_mutable())
355 self.failUnless(IURI.providedBy(u2))
356 self.failIf(IFileURI.providedBy(u2))
357 self.failUnless(IDirnodeURI.providedBy(u2))
359 u3 = u2.get_readonly()
360 self.failUnlessEqual(u3.to_string(), u2.to_string())
361 self.failUnless(str(u3))
363 u2_verifier = u2.get_verify_cap()
364 self.failUnless(isinstance(u2_verifier,
365 uri.ImmutableDirectoryURIVerifier),
367 self.failUnless(IVerifierURI.providedBy(u2_verifier))
368 u2vs = u2_verifier.to_string()
369 # URI:DIR2-CHK-Verifier:$key:$ueb:$k:$n:$size
370 self.failUnless(u2vs.startswith("URI:DIR2-CHK-Verifier:"), u2vs)
371 u2_verifier_fileuri = u2_verifier.get_filenode_cap()
372 self.failUnless(IVerifierURI.providedBy(u2_verifier_fileuri))
373 u2vfs = u2_verifier_fileuri.to_string()
374 # URI:CHK-Verifier:$key:$ueb:$k:$n:$size
375 self.failUnlessEqual(u2vfs, fnuri.get_verify_cap().to_string())
376 self.failUnlessEqual(u2vs[len("URI:DIR2-"):], u2vfs[len("URI:"):])
377 self.failUnless(str(u2_verifier))
379 def test_literal(self):
380 u0 = uri.LiteralFileURI("data")
381 u1 = uri.LiteralDirectoryURI(u0)
382 self.failUnless(str(u1))
384 self.failUnlessEqual(u1.to_string(), "URI:DIR2-LIT:mrqxiyi")
385 self.failUnless(u1.is_readonly())
386 self.failIf(u1.is_mutable())
387 self.failUnless(IURI.providedBy(u1))
388 self.failIf(IFileURI.providedBy(u1))
389 self.failUnless(IDirnodeURI.providedBy(u1))
390 self.failUnlessEqual(u1.get_verify_cap(), None)