src/allmydata/test/test_uri.py

   1
   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, \
   6     IVerifierURI
   7
   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())
  18
  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())
  27
  28         u3 = u.get_readonly()
  29         self.failUnlessIdentical(u, u3)
  30         self.failUnlessEqual(u.get_verifier(), None)
  31
  32         he = u.to_human_encoding()
  33         u_h = uri.LiteralFileURI.init_from_human_encoding(he)
  34         self.failUnlessEqual(u, u_h)
  35
  36     def test_empty(self):
  37         data = "" # This data is some *very* small data!
  38         return self._help_test(data)
  39
  40     def test_pack(self):
  41         data = "This is some small data"
  42         return self._help_test(data)
  43
  44     def test_nonascii(self):
  45         data = "This contains \x00 and URI:LIT: and \n, oh my."
  46         return self._help_test(data)
  47
  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
  60
  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("this is not a uri"))
  65
  66 class CHKFile(unittest.TestCase):
  67     def test_pack(self):
  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")
  71         needed_shares = 25
  72         total_shares = 100
  73         size = 1234
  74         u = uri.CHKFileURI(key=key,
  75                            uri_extension_hash=uri_extension_hash,
  76                            needed_shares=needed_shares,
  77                            total_shares=total_shares,
  78                            size=size)
  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:8123/uri/" + u.to_string())
  99         self.failUnlessEqual(uri.CHKFileURI.init_from_human_encoding(he), u)
 100
 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())
 116
 117         v = u.get_verifier()
 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)
 124
 125         v3 = uri.CHKFileVerifierURI(storage_index="\x00"*16,
 126                                     uri_extension_hash="\x00"*32,
 127                                     needed_shares=3,
 128                                     total_shares=10,
 129                                     size=1234)
 130         self.failUnless(isinstance(v3.to_string(), str))
 131
 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")
 136         needed_shares = 25
 137         total_shares = 100
 138         size = 1234
 139         self.failUnlessRaises(TypeError,
 140                               uri.CHKFileURI,
 141                               key=key,
 142                               uri_extension_hash=uri_extension_hash,
 143                               needed_shares=needed_shares,
 144                               total_shares=total_shares,
 145                               size=size,
 146
 147                               bogus_extra_argument="reject me",
 148                               )
 149         self.failUnlessRaises(TypeError,
 150                               uri.CHKFileVerifierURI,
 151                               bogus="bogus")
 152         self.failUnlessRaises(TypeError,
 153                               uri.CHKFileVerifierURI,
 154                               storage_index=storage_index,
 155                               uri_extension_hash=uri_extension_hash,
 156                               needed_shares=3,
 157                               total_shares=10,
 158                               # leave size= missing
 159                               )
 160
 161
 162 class Extension(unittest.TestCase):
 163     def test_pack(self):
 164         data = {"stuff": "value",
 165                 "size": 12,
 166                 "needed_shares": 3,
 167                 "big_hash": hashutil.tagged_hash("foo", "bar"),
 168                 }
 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"))
 174
 175         readable = uri.unpack_extension_readable(ext)
 176
 177 class Invalid(unittest.TestCase):
 178     def test_create_invalid(self):
 179         not_uri = "I am not a URI"
 180         self.failUnlessRaises(TypeError, uri.from_string, not_uri)
 181
 182
 183 class Constraint(unittest.TestCase):
 184     def test_constraint(self):
 185        good="http://127.0.0.1:8123/uri/URI%3ADIR2%3Agh3l5rbvnv2333mrfvalmjfr4i%3Alz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma/"
 186        uri.NewDirectoryURI.init_from_human_encoding(good)
 187        self.failUnlessRaises(AssertionError, uri.NewDirectoryURI.init_from_string, good)
 188        bad = good + '==='
 189        self.failUnlessRaises(AssertionError, uri.NewDirectoryURI.init_from_human_encoding, bad)
 190        self.failUnlessRaises(AssertionError, uri.NewDirectoryURI.init_from_string, bad)
 191        fileURI = 'URI:CHK:gh3l5rbvnv2333mrfvalmjfr4i:lz6l7u3z3b7g37s4zkdmfpx5ly4ib4m6thrpbusi6ys62qtc6mma:3:10:345834'
 192        uri.CHKFileURI.init_from_string(fileURI)
 193
 194 class Mutable(unittest.TestCase):
 195     def test_pack(self):
 196         writekey = "\x01" * 16
 197         fingerprint = "\x02" * 32
 198
 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))
 208         u1a = IMutableFileURI(u.to_string())
 209         self.failUnlessEqual(u1a, u)
 210
 211         he = u.to_human_encoding()
 212         u_h = uri.WriteableSSKFileURI.init_from_human_encoding(he)
 213         self.failUnlessEqual(u, u_h)
 214
 215         u2 = uri.from_string(u.to_string())
 216         self.failUnlessEqual(u2.writekey, writekey)
 217         self.failUnlessEqual(u2.fingerprint, fingerprint)
 218         self.failIf(u2.is_readonly())
 219         self.failUnless(u2.is_mutable())
 220         self.failUnless(IURI.providedBy(u2))
 221         self.failUnless(IMutableFileURI.providedBy(u2))
 222         self.failIf(IDirnodeURI.providedBy(u2))
 223
 224         u3 = u2.get_readonly()
 225         readkey = hashutil.ssk_readkey_hash(writekey)
 226         self.failUnlessEqual(u3.fingerprint, fingerprint)
 227         self.failUnlessEqual(u3.readkey, readkey)
 228         self.failUnless(u3.is_readonly())
 229         self.failUnless(u3.is_mutable())
 230         self.failUnless(IURI.providedBy(u3))
 231         self.failUnless(IMutableFileURI.providedBy(u3))
 232         self.failIf(IDirnodeURI.providedBy(u3))
 233
 234         he = u3.to_human_encoding()
 235         u3_h = uri.ReadonlySSKFileURI.init_from_human_encoding(he)
 236         self.failUnlessEqual(u3, u3_h)
 237
 238         u4 = uri.ReadonlySSKFileURI(readkey, fingerprint)
 239         self.failUnlessEqual(u4.fingerprint, fingerprint)
 240         self.failUnlessEqual(u4.readkey, readkey)
 241         self.failUnless(u4.is_readonly())
 242         self.failUnless(u4.is_mutable())
 243         self.failUnless(IURI.providedBy(u4))
 244         self.failUnless(IMutableFileURI.providedBy(u4))
 245         self.failIf(IDirnodeURI.providedBy(u4))
 246
 247         u4a = uri.from_string(u4.to_string())
 248         self.failUnlessEqual(u4a, u4)
 249         self.failUnless("ReadonlySSKFileURI" in str(u4a))
 250         self.failUnlessIdentical(u4a.get_readonly(), u4a)
 251
 252         u5 = u4.get_verifier()
 253         self.failUnless(IVerifierURI.providedBy(u5))
 254         self.failUnlessEqual(u5.storage_index, u.storage_index)
 255         u6 = IVerifierURI(u5.to_string())
 256         self.failUnless(IVerifierURI.providedBy(u6))
 257         self.failUnlessEqual(u6.storage_index, u.storage_index)
 258         u7 = u.get_verifier()
 259         self.failUnless(IVerifierURI.providedBy(u7))
 260         self.failUnlessEqual(u7.storage_index, u.storage_index)
 261
 262         he = u5.to_human_encoding()
 263         u5_h = uri.SSKVerifierURI.init_from_human_encoding(he)
 264         self.failUnlessEqual(u5, u5_h)
 265
 266
 267 class NewDirnode(unittest.TestCase):
 268     def test_pack(self):
 269         writekey = "\x01" * 16
 270         fingerprint = "\x02" * 32
 271
 272         n = uri.WriteableSSKFileURI(writekey, fingerprint)
 273         u1 = uri.NewDirectoryURI(n)
 274         self.failIf(u1.is_readonly())
 275         self.failUnless(u1.is_mutable())
 276         self.failUnless(IURI.providedBy(u1))
 277         self.failIf(IFileURI.providedBy(u1))
 278         self.failUnless(IDirnodeURI.providedBy(u1))
 279         self.failUnless("NewDirectoryURI" in str(u1))
 280         u1_filenode = u1.get_filenode_uri()
 281         self.failUnless(u1_filenode.is_mutable())
 282         self.failIf(u1_filenode.is_readonly())
 283         u1a = IDirnodeURI(u1.to_string())
 284         self.failUnlessEqual(u1a, u1)
 285
 286         u2 = uri.from_string(u1.to_string())
 287         self.failUnlessEqual(u1.to_string(), u2.to_string())
 288         self.failIf(u2.is_readonly())
 289         self.failUnless(u2.is_mutable())
 290         self.failUnless(IURI.providedBy(u2))
 291         self.failIf(IFileURI.providedBy(u2))
 292         self.failUnless(IDirnodeURI.providedBy(u2))
 293
 294         u3 = u2.get_readonly()
 295         self.failUnless(u3.is_readonly())
 296         self.failUnless(u3.is_mutable())
 297         self.failUnless(IURI.providedBy(u3))
 298         self.failIf(IFileURI.providedBy(u3))
 299         self.failUnless(IDirnodeURI.providedBy(u3))
 300         u3n = u3._filenode_uri
 301         self.failUnless(u3n.is_readonly())
 302         self.failUnless(u3n.is_mutable())
 303         u3_filenode = u3.get_filenode_uri()
 304         self.failUnless(u3_filenode.is_mutable())
 305         self.failUnless(u3_filenode.is_readonly())
 306
 307         u3a = uri.from_string(u3.to_string())
 308         self.failUnlessIdentical(u3a, u3a.get_readonly())
 309
 310         u4 = uri.ReadonlyNewDirectoryURI(u2._filenode_uri.get_readonly())
 311         self.failUnlessEqual(u4.to_string(), u3.to_string())
 312         self.failUnless(u4.is_readonly())
 313         self.failUnless(u4.is_mutable())
 314         self.failUnless(IURI.providedBy(u4))
 315         self.failIf(IFileURI.providedBy(u4))
 316         self.failUnless(IDirnodeURI.providedBy(u4))
 317
 318         u4_verifier = u4.get_verifier()
 319         u4_verifier_filenode = u4_verifier.get_filenode_uri()
 320         self.failUnless(isinstance(u4_verifier_filenode, uri.SSKVerifierURI))
 321
 322         verifiers = [u1.get_verifier(), u2.get_verifier(),
 323                      u3.get_verifier(), u4.get_verifier(),
 324                      IVerifierURI(u1.get_verifier().to_string()),
 325                      uri.NewDirectoryURIVerifier(n.get_verifier()),
 326                      uri.NewDirectoryURIVerifier(n.get_verifier().to_string()),
 327                      ]
 328         for v in verifiers:
 329             self.failUnless(IVerifierURI.providedBy(v))
 330             self.failUnlessEqual(v._filenode_uri,
 331                                  u1.get_verifier()._filenode_uri)