src/allmydata/test/test_dirnode.py

   1
   2 import time
   3 import unicodedata
   4 from zope.interface import implements
   5 from twisted.trial import unittest
   6 from twisted.internet import defer
   7 from twisted.internet.interfaces import IConsumer
   8 from allmydata import uri, dirnode
   9 from allmydata.client import Client
  10 from allmydata.immutable import upload
  11 from allmydata.interfaces import IImmutableFileNode, IMutableFileNode, \
  12      ExistingChildError, NoSuchChildError, MustNotBeUnknownRWError, \
  13      MustBeDeepImmutableError, MustBeReadonlyError, \
  14      IDeepCheckResults, IDeepCheckAndRepairResults
  15 from allmydata.mutable.filenode import MutableFileNode
  16 from allmydata.mutable.common import UncoordinatedWriteError
  17 from allmydata.util import hashutil, base32
  18 from allmydata.util.netstring import split_netstring
  19 from allmydata.monitor import Monitor
  20 from allmydata.test.common import make_chk_file_uri, make_mutable_file_uri, \
  21      ErrorMixin
  22 from allmydata.test.no_network import GridTestMixin
  23 from allmydata.unknown import UnknownNode, strip_prefix_for_ro
  24 from allmydata.nodemaker import NodeMaker
  25 from base64 import b32decode
  26 import allmydata.test.common_util as testutil
  27
  28 class MemAccum:
  29     implements(IConsumer)
  30     def registerProducer(self, producer, streaming):
  31         self.producer = producer
  32         self.producer.resumeProducing()
  33         pass
  34     def unregisterProducer(self):
  35         pass
  36     def write(self, data):
  37         assert not hasattr(self, 'data')
  38         self.data = data
  39         self.producer.resumeProducing()
  40
  41 setup_py_uri = "URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861"
  42 one_uri = "URI:LIT:n5xgk" # LIT for "one"
  43 mut_write_uri = "URI:SSK:vfvcbdfbszyrsaxchgevhmmlii:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq"
  44 empty_litdir_uri = "URI:DIR2-LIT:"
  45 tiny_litdir_uri = "URI:DIR2-LIT:gqytunj2onug64tufqzdcosvkjetutcjkq5gw4tvm5vwszdgnz5hgyzufqydulbshj5x2lbm" # contains one child which is itself also LIT
  46 mut_read_uri = "URI:SSK-RO:jf6wkflosyvntwxqcdo7a54jvm:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq"
  47 future_write_uri = "x-tahoe-crazy://I_am_from_the_future."
  48 future_read_uri = "x-tahoe-crazy-readonly://I_am_from_the_future."
  49
  50 # 'o' 'n' 'e-macron'
  51 one_nfc = u"on\u0113"
  52 one_nfd = u"one\u0304"
  53
  54 class Dirnode(GridTestMixin, unittest.TestCase,
  55               testutil.ShouldFailMixin, testutil.StallMixin, ErrorMixin):
  56     timeout = 240 # It takes longer than 120 seconds on Francois's arm box.
  57
  58     def test_basic(self):
  59         self.basedir = "dirnode/Dirnode/test_basic"
  60         self.set_up_grid()
  61         c = self.g.clients[0]
  62         d = c.create_dirnode()
  63         def _done(res):
  64             self.failUnless(isinstance(res, dirnode.DirectoryNode))
  65             self.failUnless(res.is_mutable())
  66             self.failIf(res.is_readonly())
  67             self.failIf(res.is_unknown())
  68             self.failIf(res.is_allowed_in_immutable_directory())
  69             res.raise_error()
  70             rep = str(res)
  71             self.failUnless("RW-MUT" in rep)
  72         d.addCallback(_done)
  73         return d
  74
  75     def test_initial_children(self):
  76         self.basedir = "dirnode/Dirnode/test_initial_children"
  77         self.set_up_grid()
  78         c = self.g.clients[0]
  79         nm = c.nodemaker
  80
  81         kids = {one_nfd: (nm.create_from_cap(one_uri), {}),
  82                 u"two": (nm.create_from_cap(setup_py_uri),
  83                          {"metakey": "metavalue"}),
  84                 u"mut": (nm.create_from_cap(mut_write_uri, mut_read_uri), {}),
  85                 u"fut": (nm.create_from_cap(future_write_uri, future_read_uri), {}),
  86                 u"fro": (nm.create_from_cap(None, future_read_uri), {}),
  87                 u"empty_litdir": (nm.create_from_cap(empty_litdir_uri), {}),
  88                 u"tiny_litdir": (nm.create_from_cap(tiny_litdir_uri), {}),
  89                 }
  90         d = c.create_dirnode(kids)
  91
  92         def _created(dn):
  93             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
  94             self.failUnless(dn.is_mutable())
  95             self.failIf(dn.is_readonly())
  96             self.failIf(dn.is_unknown())
  97             self.failIf(dn.is_allowed_in_immutable_directory())
  98             dn.raise_error()
  99             rep = str(dn)
 100             self.failUnless("RW-MUT" in rep)
 101             return dn.list()
 102         d.addCallback(_created)
 103
 104         def _check_kids(children):
 105             self.failUnlessEqual(set(children.keys()),
 106                                  set([one_nfc, u"two", u"mut", u"fut", u"fro", u"empty_litdir", u"tiny_litdir"]))
 107             one_node, one_metadata = children[one_nfc]
 108             two_node, two_metadata = children[u"two"]
 109             mut_node, mut_metadata = children[u"mut"]
 110             fut_node, fut_metadata = children[u"fut"]
 111             fro_node, fro_metadata = children[u"fro"]
 112             emptylit_node, emptylit_metadata = children[u"empty_litdir"]
 113             tinylit_node, tinylit_metadata = children[u"tiny_litdir"]
 114
 115             self.failUnlessEqual(one_node.get_size(), 3)
 116             self.failUnlessEqual(one_node.get_uri(), one_uri)
 117             self.failUnlessEqual(one_node.get_readonly_uri(), one_uri)
 118             self.failUnless(isinstance(one_metadata, dict), one_metadata)
 119
 120             self.failUnlessEqual(two_node.get_size(), 14861)
 121             self.failUnlessEqual(two_node.get_uri(), setup_py_uri)
 122             self.failUnlessEqual(two_node.get_readonly_uri(), setup_py_uri)
 123             self.failUnlessEqual(two_metadata["metakey"], "metavalue")
 124
 125             self.failUnlessEqual(mut_node.get_uri(), mut_write_uri)
 126             self.failUnlessEqual(mut_node.get_readonly_uri(), mut_read_uri)
 127             self.failUnless(isinstance(mut_metadata, dict), mut_metadata)
 128
 129             self.failUnless(fut_node.is_unknown())
 130             self.failUnlessEqual(fut_node.get_uri(), future_write_uri)
 131             self.failUnlessEqual(fut_node.get_readonly_uri(), "ro." + future_read_uri)
 132             self.failUnless(isinstance(fut_metadata, dict), fut_metadata)
 133
 134             self.failUnless(fro_node.is_unknown())
 135             self.failUnlessEqual(fro_node.get_uri(), "ro." + future_read_uri)
 136             self.failUnlessEqual(fut_node.get_readonly_uri(), "ro." + future_read_uri)
 137             self.failUnless(isinstance(fro_metadata, dict), fro_metadata)
 138
 139             self.failIf(emptylit_node.is_unknown())
 140             self.failUnlessEqual(emptylit_node.get_storage_index(), None)
 141             self.failIf(tinylit_node.is_unknown())
 142             self.failUnlessEqual(tinylit_node.get_storage_index(), None)
 143
 144             d2 = defer.succeed(None)
 145             d2.addCallback(lambda ignored: emptylit_node.list())
 146             d2.addCallback(lambda children: self.failUnlessEqual(children, {}))
 147             d2.addCallback(lambda ignored: tinylit_node.list())
 148             d2.addCallback(lambda children: self.failUnlessEqual(set(children.keys()),
 149                                                                  set([u"short"])))
 150             d2.addCallback(lambda ignored: tinylit_node.list())
 151             d2.addCallback(lambda children: children[u"short"][0].read(MemAccum()))
 152             d2.addCallback(lambda accum: self.failUnlessEqual(accum.data, "The end."))
 153             return d2
 154
 155         d.addCallback(_check_kids)
 156
 157         d.addCallback(lambda ign: nm.create_new_mutable_directory(kids))
 158         d.addCallback(lambda dn: dn.list())
 159         d.addCallback(_check_kids)
 160
 161         bad_future_node = UnknownNode(future_write_uri, None)
 162         bad_kids1 = {one_nfd: (bad_future_node, {})}
 163         # This should fail because we don't know how to diminish the future_write_uri
 164         # cap (given in a write slot and not prefixed with "ro." or "imm.") to a readcap.
 165         d.addCallback(lambda ign:
 166                       self.shouldFail(MustNotBeUnknownRWError, "bad_kids1",
 167                                       "cannot attach unknown",
 168                                       nm.create_new_mutable_directory,
 169                                       bad_kids1))
 170         bad_kids2 = {one_nfd: (nm.create_from_cap(one_uri), None)}
 171         d.addCallback(lambda ign:
 172                       self.shouldFail(AssertionError, "bad_kids2",
 173                                       "requires metadata to be a dict",
 174                                       nm.create_new_mutable_directory,
 175                                       bad_kids2))
 176         return d
 177
 178     def test_immutable(self):
 179         self.basedir = "dirnode/Dirnode/test_immutable"
 180         self.set_up_grid()
 181         c = self.g.clients[0]
 182         nm = c.nodemaker
 183
 184         kids = {one_nfd: (nm.create_from_cap(one_uri), {}),
 185                 u"two": (nm.create_from_cap(setup_py_uri),
 186                          {"metakey": "metavalue"}),
 187                 u"fut": (nm.create_from_cap(None, future_read_uri), {}),
 188                 u"empty_litdir": (nm.create_from_cap(empty_litdir_uri), {}),
 189                 u"tiny_litdir": (nm.create_from_cap(tiny_litdir_uri), {}),
 190                 }
 191         d = c.create_immutable_dirnode(kids)
 192
 193         def _created(dn):
 194             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 195             self.failIf(dn.is_mutable())
 196             self.failUnless(dn.is_readonly())
 197             self.failIf(dn.is_unknown())
 198             self.failUnless(dn.is_allowed_in_immutable_directory())
 199             dn.raise_error()
 200             rep = str(dn)
 201             self.failUnless("RO-IMM" in rep)
 202             cap = dn.get_cap()
 203             self.failUnlessIn("CHK", cap.to_string())
 204             self.cap = cap
 205             return dn.list()
 206         d.addCallback(_created)
 207
 208         def _check_kids(children):
 209             self.failUnlessEqual(set(children.keys()),
 210                                  set([one_nfc, u"two", u"fut", u"empty_litdir", u"tiny_litdir"]))
 211             one_node, one_metadata = children[one_nfc]
 212             two_node, two_metadata = children[u"two"]
 213             fut_node, fut_metadata = children[u"fut"]
 214             emptylit_node, emptylit_metadata = children[u"empty_litdir"]
 215             tinylit_node, tinylit_metadata = children[u"tiny_litdir"]
 216
 217             self.failUnlessEqual(one_node.get_size(), 3)
 218             self.failUnlessEqual(one_node.get_uri(), one_uri)
 219             self.failUnlessEqual(one_node.get_readonly_uri(), one_uri)
 220             self.failUnless(isinstance(one_metadata, dict), one_metadata)
 221
 222             self.failUnlessEqual(two_node.get_size(), 14861)
 223             self.failUnlessEqual(two_node.get_uri(), setup_py_uri)
 224             self.failUnlessEqual(two_node.get_readonly_uri(), setup_py_uri)
 225             self.failUnlessEqual(two_metadata["metakey"], "metavalue")
 226
 227             self.failUnless(fut_node.is_unknown())
 228             self.failUnlessEqual(fut_node.get_uri(), "imm." + future_read_uri)
 229             self.failUnlessEqual(fut_node.get_readonly_uri(), "imm." + future_read_uri)
 230             self.failUnless(isinstance(fut_metadata, dict), fut_metadata)
 231
 232             self.failIf(emptylit_node.is_unknown())
 233             self.failUnlessEqual(emptylit_node.get_storage_index(), None)
 234             self.failIf(tinylit_node.is_unknown())
 235             self.failUnlessEqual(tinylit_node.get_storage_index(), None)
 236
 237             d2 = defer.succeed(None)
 238             d2.addCallback(lambda ignored: emptylit_node.list())
 239             d2.addCallback(lambda children: self.failUnlessEqual(children, {}))
 240             d2.addCallback(lambda ignored: tinylit_node.list())
 241             d2.addCallback(lambda children: self.failUnlessEqual(set(children.keys()),
 242                                                                  set([u"short"])))
 243             d2.addCallback(lambda ignored: tinylit_node.list())
 244             d2.addCallback(lambda children: children[u"short"][0].read(MemAccum()))
 245             d2.addCallback(lambda accum: self.failUnlessEqual(accum.data, "The end."))
 246             return d2
 247
 248         d.addCallback(_check_kids)
 249
 250         d.addCallback(lambda ign: nm.create_from_cap(self.cap.to_string()))
 251         d.addCallback(lambda dn: dn.list())
 252         d.addCallback(_check_kids)
 253
 254         bad_future_node1 = UnknownNode(future_write_uri, None)
 255         bad_kids1 = {one_nfd: (bad_future_node1, {})}
 256         d.addCallback(lambda ign:
 257                       self.shouldFail(MustNotBeUnknownRWError, "bad_kids1",
 258                                       "cannot attach unknown",
 259                                       c.create_immutable_dirnode,
 260                                       bad_kids1))
 261         bad_future_node2 = UnknownNode(future_write_uri, future_read_uri)
 262         bad_kids2 = {one_nfd: (bad_future_node2, {})}
 263         d.addCallback(lambda ign:
 264                       self.shouldFail(MustBeDeepImmutableError, "bad_kids2",
 265                                       "is not allowed in an immutable directory",
 266                                       c.create_immutable_dirnode,
 267                                       bad_kids2))
 268         bad_kids3 = {one_nfd: (nm.create_from_cap(one_uri), None)}
 269         d.addCallback(lambda ign:
 270                       self.shouldFail(AssertionError, "bad_kids3",
 271                                       "requires metadata to be a dict",
 272                                       c.create_immutable_dirnode,
 273                                       bad_kids3))
 274         bad_kids4 = {one_nfd: (nm.create_from_cap(mut_write_uri), {})}
 275         d.addCallback(lambda ign:
 276                       self.shouldFail(MustBeDeepImmutableError, "bad_kids4",
 277                                       "is not allowed in an immutable directory",
 278                                       c.create_immutable_dirnode,
 279                                       bad_kids4))
 280         bad_kids5 = {one_nfd: (nm.create_from_cap(mut_read_uri), {})}
 281         d.addCallback(lambda ign:
 282                       self.shouldFail(MustBeDeepImmutableError, "bad_kids5",
 283                                       "is not allowed in an immutable directory",
 284                                       c.create_immutable_dirnode,
 285                                       bad_kids5))
 286         d.addCallback(lambda ign: c.create_immutable_dirnode({}))
 287         def _created_empty(dn):
 288             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 289             self.failIf(dn.is_mutable())
 290             self.failUnless(dn.is_readonly())
 291             self.failIf(dn.is_unknown())
 292             self.failUnless(dn.is_allowed_in_immutable_directory())
 293             dn.raise_error()
 294             rep = str(dn)
 295             self.failUnless("RO-IMM" in rep)
 296             cap = dn.get_cap()
 297             self.failUnlessIn("LIT", cap.to_string())
 298             self.failUnlessEqual(cap.to_string(), "URI:DIR2-LIT:")
 299             self.cap = cap
 300             return dn.list()
 301         d.addCallback(_created_empty)
 302         d.addCallback(lambda kids: self.failUnlessEqual(kids, {}))
 303         smallkids = {u"o": (nm.create_from_cap(one_uri), {})}
 304         d.addCallback(lambda ign: c.create_immutable_dirnode(smallkids))
 305         def _created_small(dn):
 306             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 307             self.failIf(dn.is_mutable())
 308             self.failUnless(dn.is_readonly())
 309             self.failIf(dn.is_unknown())
 310             self.failUnless(dn.is_allowed_in_immutable_directory())
 311             dn.raise_error()
 312             rep = str(dn)
 313             self.failUnless("RO-IMM" in rep)
 314             cap = dn.get_cap()
 315             self.failUnlessIn("LIT", cap.to_string())
 316             self.failUnlessEqual(cap.to_string(),
 317                                  "URI:DIR2-LIT:gi4tumj2n4wdcmz2kvjesosmjfkdu3rvpbtwwlbqhiwdeot3puwcy")
 318             self.cap = cap
 319             return dn.list()
 320         d.addCallback(_created_small)
 321         d.addCallback(lambda kids: self.failUnlessEqual(kids.keys(), [u"o"]))
 322
 323         # now test n.create_subdirectory(mutable=False)
 324         d.addCallback(lambda ign: c.create_dirnode())
 325         def _made_parent(n):
 326             d = n.create_subdirectory(u"subdir", kids, mutable=False)
 327             d.addCallback(lambda sd: sd.list())
 328             d.addCallback(_check_kids)
 329             d.addCallback(lambda ign: n.list())
 330             d.addCallback(lambda children:
 331                           self.failUnlessEqual(children.keys(), [u"subdir"]))
 332             d.addCallback(lambda ign: n.get(u"subdir"))
 333             d.addCallback(lambda sd: sd.list())
 334             d.addCallback(_check_kids)
 335             d.addCallback(lambda ign: n.get(u"subdir"))
 336             d.addCallback(lambda sd: self.failIf(sd.is_mutable()))
 337             bad_kids = {one_nfd: (nm.create_from_cap(mut_write_uri), {})}
 338             d.addCallback(lambda ign:
 339                           self.shouldFail(MustBeDeepImmutableError, "YZ",
 340                                           "is not allowed in an immutable directory",
 341                                           n.create_subdirectory,
 342                                           u"sub2", bad_kids, mutable=False))
 343             return d
 344         d.addCallback(_made_parent)
 345         return d
 346
 347     def test_directory_representation(self):
 348         self.basedir = "dirnode/Dirnode/test_directory_representation"
 349         self.set_up_grid()
 350         c = self.g.clients[0]
 351         nm = c.nodemaker
 352
 353         # This test checks that any trailing spaces in URIs are retained in the
 354         # encoded directory, but stripped when we get them out of the directory.
 355         # See ticket #925 for why we want that.
 356         # It also tests that we store child names as UTF-8 NFC, and normalize
 357         # them again when retrieving them.
 358
 359         stripped_write_uri = "lafs://from_the_future\t"
 360         stripped_read_uri = "lafs://readonly_from_the_future\t"
 361         spacedout_write_uri = stripped_write_uri + "  "
 362         spacedout_read_uri = stripped_read_uri + "  "
 363
 364         child = nm.create_from_cap(spacedout_write_uri, spacedout_read_uri)
 365         self.failUnlessEqual(child.get_write_uri(), spacedout_write_uri)
 366         self.failUnlessEqual(child.get_readonly_uri(), "ro." + spacedout_read_uri)
 367
 368         child_dottedi = u"ch\u0131\u0307ld"
 369
 370         kids_in   = {child_dottedi: (child, {}), one_nfd: (child, {})}
 371         kids_out  = {child_dottedi: (child, {}), one_nfc: (child, {})}
 372         kids_norm = {u"child":      (child, {}), one_nfc: (child, {})}
 373         d = c.create_dirnode(kids_in)
 374
 375         def _created(dn):
 376             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 377             self.failUnless(dn.is_mutable())
 378             self.failIf(dn.is_readonly())
 379             dn.raise_error()
 380             self.cap = dn.get_cap()
 381             self.rootnode = dn
 382             return dn._node.download_best_version()
 383         d.addCallback(_created)
 384
 385         def _check_data(data):
 386             # Decode the netstring representation of the directory to check that the
 387             # spaces are retained when the URIs are stored, and that the names are stored
 388             # as NFC.
 389             position = 0
 390             numkids = 0
 391             while position < len(data):
 392                 entries, position = split_netstring(data, 1, position)
 393                 entry = entries[0]
 394                 (name_utf8, ro_uri, rwcapdata, metadata_s), subpos = split_netstring(entry, 4)
 395                 name = name_utf8.decode("utf-8")
 396                 rw_uri = self.rootnode._decrypt_rwcapdata(rwcapdata)
 397                 self.failUnlessIn(name, kids_out)
 398                 (expected_child, ign) = kids_out[name]
 399                 self.failUnlessEqual(rw_uri, expected_child.get_write_uri())
 400                 self.failUnlessEqual("ro." + ro_uri, expected_child.get_readonly_uri())
 401                 numkids += 1
 402
 403             self.failUnlessEqual(numkids, len(kids_out))
 404             return self.rootnode
 405         d.addCallback(_check_data)
 406
 407         # Mock up a hypothetical future version of Unicode that adds a canonical equivalence
 408         # between dotless-i + dot-above, and 'i'. That would actually be prohibited by the
 409         # stability rules, but similar additions involving currently-unassigned characters
 410         # would not be.
 411         old_normalize = unicodedata.normalize
 412         def future_normalize(form, s):
 413             assert form == 'NFC', form
 414             return old_normalize(form, s).replace(u"\u0131\u0307", u"i")
 415
 416         def _list(node):
 417             unicodedata.normalize = future_normalize
 418             d2 = node.list()
 419             def _undo_mock(res):
 420                 unicodedata.normalize = old_normalize
 421                 return res
 422             d2.addBoth(_undo_mock)
 423             return d2
 424         d.addCallback(_list)
 425
 426         def _check_kids(children):
 427             # Now when we use the real directory listing code, the trailing spaces
 428             # should have been stripped (and "ro." should have been prepended to the
 429             # ro_uri, since it's unknown). Also the dotless-i + dot-above should have been
 430             # normalized to 'i'.
 431
 432             self.failUnlessEqual(set(children.keys()), set(kids_norm.keys()))
 433             child_node, child_metadata = children[u"child"]
 434
 435             self.failUnlessEqual(child_node.get_write_uri(), stripped_write_uri)
 436             self.failUnlessEqual(child_node.get_readonly_uri(), "ro." + stripped_read_uri)
 437         d.addCallback(_check_kids)
 438
 439         d.addCallback(lambda ign: nm.create_from_cap(self.cap.to_string()))
 440         d.addCallback(_list)
 441         d.addCallback(_check_kids)  # again with dirnode recreated from cap
 442         return d
 443
 444     def test_check(self):
 445         self.basedir = "dirnode/Dirnode/test_check"
 446         self.set_up_grid()
 447         c = self.g.clients[0]
 448         d = c.create_dirnode()
 449         d.addCallback(lambda dn: dn.check(Monitor()))
 450         def _done(res):
 451             self.failUnless(res.is_healthy())
 452         d.addCallback(_done)
 453         return d
 454
 455     def _test_deepcheck_create(self):
 456         # create a small tree with a loop, and some non-directories
 457         #  root/
 458         #  root/subdir/
 459         #  root/subdir/file1
 460         #  root/subdir/link -> root
 461         #  root/rodir
 462         c = self.g.clients[0]
 463         d = c.create_dirnode()
 464         def _created_root(rootnode):
 465             self._rootnode = rootnode
 466             return rootnode.create_subdirectory(u"subdir")
 467         d.addCallback(_created_root)
 468         def _created_subdir(subdir):
 469             self._subdir = subdir
 470             d = subdir.add_file(u"file1", upload.Data("data"*100, None))
 471             d.addCallback(lambda res: subdir.set_node(u"link", self._rootnode))
 472             d.addCallback(lambda res: c.create_dirnode())
 473             d.addCallback(lambda dn:
 474                           self._rootnode.set_uri(u"rodir",
 475                                                  dn.get_uri(),
 476                                                  dn.get_readonly_uri()))
 477             return d
 478         d.addCallback(_created_subdir)
 479         def _done(res):
 480             return self._rootnode
 481         d.addCallback(_done)
 482         return d
 483
 484     def test_deepcheck(self):
 485         self.basedir = "dirnode/Dirnode/test_deepcheck"
 486         self.set_up_grid()
 487         d = self._test_deepcheck_create()
 488         d.addCallback(lambda rootnode: rootnode.start_deep_check().when_done())
 489         def _check_results(r):
 490             self.failUnless(IDeepCheckResults.providedBy(r))
 491             c = r.get_counters()
 492             self.failUnlessEqual(c,
 493                                  {"count-objects-checked": 4,
 494                                   "count-objects-healthy": 4,
 495                                   "count-objects-unhealthy": 0,
 496                                   "count-objects-unrecoverable": 0,
 497                                   "count-corrupt-shares": 0,
 498                                   })
 499             self.failIf(r.get_corrupt_shares())
 500             self.failUnlessEqual(len(r.get_all_results()), 4)
 501         d.addCallback(_check_results)
 502         return d
 503
 504     def test_deepcheck_and_repair(self):
 505         self.basedir = "dirnode/Dirnode/test_deepcheck_and_repair"
 506         self.set_up_grid()
 507         d = self._test_deepcheck_create()
 508         d.addCallback(lambda rootnode:
 509                       rootnode.start_deep_check_and_repair().when_done())
 510         def _check_results(r):
 511             self.failUnless(IDeepCheckAndRepairResults.providedBy(r))
 512             c = r.get_counters()
 513             self.failUnlessEqual(c,
 514                                  {"count-objects-checked": 4,
 515                                   "count-objects-healthy-pre-repair": 4,
 516                                   "count-objects-unhealthy-pre-repair": 0,
 517                                   "count-objects-unrecoverable-pre-repair": 0,
 518                                   "count-corrupt-shares-pre-repair": 0,
 519                                   "count-objects-healthy-post-repair": 4,
 520                                   "count-objects-unhealthy-post-repair": 0,
 521                                   "count-objects-unrecoverable-post-repair": 0,
 522                                   "count-corrupt-shares-post-repair": 0,
 523                                   "count-repairs-attempted": 0,
 524                                   "count-repairs-successful": 0,
 525                                   "count-repairs-unsuccessful": 0,
 526                                   })
 527             self.failIf(r.get_corrupt_shares())
 528             self.failIf(r.get_remaining_corrupt_shares())
 529             self.failUnlessEqual(len(r.get_all_results()), 4)
 530         d.addCallback(_check_results)
 531         return d
 532
 533     def _mark_file_bad(self, rootnode):
 534         self.delete_shares_numbered(rootnode.get_uri(), [0])
 535         return rootnode
 536
 537     def test_deepcheck_problems(self):
 538         self.basedir = "dirnode/Dirnode/test_deepcheck_problems"
 539         self.set_up_grid()
 540         d = self._test_deepcheck_create()
 541         d.addCallback(lambda rootnode: self._mark_file_bad(rootnode))
 542         d.addCallback(lambda rootnode: rootnode.start_deep_check().when_done())
 543         def _check_results(r):
 544             c = r.get_counters()
 545             self.failUnlessEqual(c,
 546                                  {"count-objects-checked": 4,
 547                                   "count-objects-healthy": 3,
 548                                   "count-objects-unhealthy": 1,
 549                                   "count-objects-unrecoverable": 0,
 550                                   "count-corrupt-shares": 0,
 551                                   })
 552             #self.failUnlessEqual(len(r.get_problems()), 1) # TODO
 553         d.addCallback(_check_results)
 554         return d
 555
 556     def test_readonly(self):
 557         self.basedir = "dirnode/Dirnode/test_readonly"
 558         self.set_up_grid()
 559         c = self.g.clients[0]
 560         nm = c.nodemaker
 561         filecap = make_chk_file_uri(1234)
 562         filenode = nm.create_from_cap(filecap)
 563         uploadable = upload.Data("some data", convergence="some convergence string")
 564
 565         d = c.create_dirnode()
 566         def _created(rw_dn):
 567             d2 = rw_dn.set_uri(u"child", filecap, filecap)
 568             d2.addCallback(lambda res: rw_dn)
 569             return d2
 570         d.addCallback(_created)
 571
 572         def _ready(rw_dn):
 573             ro_uri = rw_dn.get_readonly_uri()
 574             ro_dn = c.create_node_from_uri(ro_uri)
 575             self.failUnless(ro_dn.is_readonly())
 576             self.failUnless(ro_dn.is_mutable())
 577             self.failIf(ro_dn.is_unknown())
 578             self.failIf(ro_dn.is_allowed_in_immutable_directory())
 579             ro_dn.raise_error()
 580
 581             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 582                             ro_dn.set_uri, u"newchild", filecap, filecap)
 583             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 584                             ro_dn.set_node, u"newchild", filenode)
 585             self.shouldFail(dirnode.NotWriteableError, "set_nodes ro", None,
 586                             ro_dn.set_nodes, { u"newchild": (filenode, None) })
 587             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 588                             ro_dn.add_file, u"newchild", uploadable)
 589             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 590                             ro_dn.delete, u"child")
 591             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 592                             ro_dn.create_subdirectory, u"newchild")
 593             self.shouldFail(dirnode.NotWriteableError, "set_metadata_for ro", None,
 594                             ro_dn.set_metadata_for, u"child", {})
 595             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 596                             ro_dn.move_child_to, u"child", rw_dn)
 597             self.shouldFail(dirnode.NotWriteableError, "set_uri ro", None,
 598                             rw_dn.move_child_to, u"child", ro_dn)
 599             return ro_dn.list()
 600         d.addCallback(_ready)
 601         def _listed(children):
 602             self.failUnless(u"child" in children)
 603         d.addCallback(_listed)
 604         return d
 605
 606     def failUnlessGreaterThan(self, a, b):
 607         self.failUnless(a > b, "%r should be > %r" % (a, b))
 608
 609     def failUnlessGreaterOrEqualThan(self, a, b):
 610         self.failUnless(a >= b, "%r should be >= %r" % (a, b))
 611
 612     def test_create(self):
 613         self.basedir = "dirnode/Dirnode/test_create"
 614         self.set_up_grid()
 615         c = self.g.clients[0]
 616
 617         self.expected_manifest = []
 618         self.expected_verifycaps = set()
 619         self.expected_storage_indexes = set()
 620
 621         d = c.create_dirnode()
 622         def _then(n):
 623             # /
 624             self.rootnode = n
 625             self.failUnless(n.is_mutable())
 626             u = n.get_uri()
 627             self.failUnless(u)
 628             self.failUnless(u.startswith("URI:DIR2:"), u)
 629             u_ro = n.get_readonly_uri()
 630             self.failUnless(u_ro.startswith("URI:DIR2-RO:"), u_ro)
 631             u_v = n.get_verify_cap().to_string()
 632             self.failUnless(u_v.startswith("URI:DIR2-Verifier:"), u_v)
 633             u_r = n.get_repair_cap().to_string()
 634             self.failUnlessEqual(u_r, u)
 635             self.expected_manifest.append( ((), u) )
 636             self.expected_verifycaps.add(u_v)
 637             si = n.get_storage_index()
 638             self.expected_storage_indexes.add(base32.b2a(si))
 639             expected_si = n._uri.get_storage_index()
 640             self.failUnlessEqual(si, expected_si)
 641
 642             d = n.list()
 643             d.addCallback(lambda res: self.failUnlessEqual(res, {}))
 644             d.addCallback(lambda res: n.has_child(u"missing"))
 645             d.addCallback(lambda res: self.failIf(res))
 646
 647             fake_file_uri = make_mutable_file_uri()
 648             other_file_uri = make_mutable_file_uri()
 649             m = c.nodemaker.create_from_cap(fake_file_uri)
 650             ffu_v = m.get_verify_cap().to_string()
 651             self.expected_manifest.append( ((u"child",) , m.get_uri()) )
 652             self.expected_verifycaps.add(ffu_v)
 653             self.expected_storage_indexes.add(base32.b2a(m.get_storage_index()))
 654             d.addCallback(lambda res: n.set_uri(u"child",
 655                                                 fake_file_uri, fake_file_uri))
 656             d.addCallback(lambda res:
 657                           self.shouldFail(ExistingChildError, "set_uri-no",
 658                                           "child 'child' already exists",
 659                                           n.set_uri, u"child",
 660                                           other_file_uri, other_file_uri,
 661                                           overwrite=False))
 662             # /
 663             # /child = mutable
 664
 665             d.addCallback(lambda res: n.create_subdirectory(u"subdir"))
 666
 667             # /
 668             # /child = mutable
 669             # /subdir = directory
 670             def _created(subdir):
 671                 self.failUnless(isinstance(subdir, dirnode.DirectoryNode))
 672                 self.subdir = subdir
 673                 new_v = subdir.get_verify_cap().to_string()
 674                 assert isinstance(new_v, str)
 675                 self.expected_manifest.append( ((u"subdir",), subdir.get_uri()) )
 676                 self.expected_verifycaps.add(new_v)
 677                 si = subdir.get_storage_index()
 678                 self.expected_storage_indexes.add(base32.b2a(si))
 679             d.addCallback(_created)
 680
 681             d.addCallback(lambda res:
 682                           self.shouldFail(ExistingChildError, "mkdir-no",
 683                                           "child 'subdir' already exists",
 684                                           n.create_subdirectory, u"subdir",
 685                                           overwrite=False))
 686
 687             d.addCallback(lambda res: n.list())
 688             d.addCallback(lambda children:
 689                           self.failUnlessEqual(set(children.keys()),
 690                                                set([u"child", u"subdir"])))
 691
 692             d.addCallback(lambda res: n.start_deep_stats().when_done())
 693             def _check_deepstats(stats):
 694                 self.failUnless(isinstance(stats, dict))
 695                 expected = {"count-immutable-files": 0,
 696                             "count-mutable-files": 1,
 697                             "count-literal-files": 0,
 698                             "count-files": 1,
 699                             "count-directories": 2,
 700                             "size-immutable-files": 0,
 701                             "size-literal-files": 0,
 702                             #"size-directories": 616, # varies
 703                             #"largest-directory": 616,
 704                             "largest-directory-children": 2,
 705                             "largest-immutable-file": 0,
 706                             }
 707                 for k,v in expected.iteritems():
 708                     self.failUnlessEqual(stats[k], v,
 709                                          "stats[%s] was %s, not %s" %
 710                                          (k, stats[k], v))
 711                 self.failUnless(stats["size-directories"] > 500,
 712                                 stats["size-directories"])
 713                 self.failUnless(stats["largest-directory"] > 500,
 714                                 stats["largest-directory"])
 715                 self.failUnlessEqual(stats["size-files-histogram"], [])
 716             d.addCallback(_check_deepstats)
 717
 718             d.addCallback(lambda res: n.build_manifest().when_done())
 719             def _check_manifest(res):
 720                 manifest = res["manifest"]
 721                 self.failUnlessEqual(sorted(manifest),
 722                                      sorted(self.expected_manifest))
 723                 stats = res["stats"]
 724                 _check_deepstats(stats)
 725                 self.failUnlessEqual(self.expected_verifycaps,
 726                                      res["verifycaps"])
 727                 self.failUnlessEqual(self.expected_storage_indexes,
 728                                      res["storage-index"])
 729             d.addCallback(_check_manifest)
 730
 731             def _add_subsubdir(res):
 732                 return self.subdir.create_subdirectory(u"subsubdir")
 733             d.addCallback(_add_subsubdir)
 734             # /
 735             # /child = mutable
 736             # /subdir = directory
 737             # /subdir/subsubdir = directory
 738             d.addCallback(lambda res: n.get_child_at_path(u"subdir/subsubdir"))
 739             d.addCallback(lambda subsubdir:
 740                           self.failUnless(isinstance(subsubdir,
 741                                                      dirnode.DirectoryNode)))
 742             d.addCallback(lambda res: n.get_child_at_path(u""))
 743             d.addCallback(lambda res: self.failUnlessEqual(res.get_uri(),
 744                                                            n.get_uri()))
 745
 746             d.addCallback(lambda res: n.get_metadata_for(u"child"))
 747             d.addCallback(lambda metadata:
 748                           self.failUnlessEqual(set(metadata.keys()),
 749                                                set(["tahoe"])))
 750
 751             d.addCallback(lambda res:
 752                           self.shouldFail(NoSuchChildError, "gcamap-no",
 753                                           "nope",
 754                                           n.get_child_and_metadata_at_path,
 755                                           u"subdir/nope"))
 756             d.addCallback(lambda res:
 757                           n.get_child_and_metadata_at_path(u""))
 758             def _check_child_and_metadata1(res):
 759                 child, metadata = res
 760                 self.failUnless(isinstance(child, dirnode.DirectoryNode))
 761                 # edge-metadata needs at least one path segment
 762                 self.failUnlessEqual(set(metadata.keys()), set([]))
 763             d.addCallback(_check_child_and_metadata1)
 764             d.addCallback(lambda res:
 765                           n.get_child_and_metadata_at_path(u"child"))
 766
 767             def _check_child_and_metadata2(res):
 768                 child, metadata = res
 769                 self.failUnlessEqual(child.get_uri(),
 770                                      fake_file_uri)
 771                 self.failUnlessEqual(set(metadata.keys()), set(["tahoe"]))
 772             d.addCallback(_check_child_and_metadata2)
 773
 774             d.addCallback(lambda res:
 775                           n.get_child_and_metadata_at_path(u"subdir/subsubdir"))
 776             def _check_child_and_metadata3(res):
 777                 child, metadata = res
 778                 self.failUnless(isinstance(child, dirnode.DirectoryNode))
 779                 self.failUnlessEqual(set(metadata.keys()), set(["tahoe"]))
 780             d.addCallback(_check_child_and_metadata3)
 781
 782             # set_uri + metadata
 783             # it should be possible to add a child without any metadata
 784             d.addCallback(lambda res: n.set_uri(u"c2",
 785                                                 fake_file_uri, fake_file_uri,
 786                                                 {}))
 787             d.addCallback(lambda res: n.get_metadata_for(u"c2"))
 788             d.addCallback(lambda metadata:
 789                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 790
 791             # You can't override the link timestamps.
 792             d.addCallback(lambda res: n.set_uri(u"c2",
 793                                                 fake_file_uri, fake_file_uri,
 794                                                 { 'tahoe': {'linkcrtime': "bogus"}}))
 795             d.addCallback(lambda res: n.get_metadata_for(u"c2"))
 796             def _has_good_linkcrtime(metadata):
 797                 self.failUnless(metadata.has_key('tahoe'))
 798                 self.failUnless(metadata['tahoe'].has_key('linkcrtime'))
 799                 self.failIfEqual(metadata['tahoe']['linkcrtime'], 'bogus')
 800             d.addCallback(_has_good_linkcrtime)
 801
 802             # if we don't set any defaults, the child should get timestamps
 803             d.addCallback(lambda res: n.set_uri(u"c3",
 804                                                 fake_file_uri, fake_file_uri))
 805             d.addCallback(lambda res: n.get_metadata_for(u"c3"))
 806             d.addCallback(lambda metadata:
 807                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 808
 809             # we can also add specific metadata at set_uri() time
 810             d.addCallback(lambda res: n.set_uri(u"c4",
 811                                                 fake_file_uri, fake_file_uri,
 812                                                 {"key": "value"}))
 813             d.addCallback(lambda res: n.get_metadata_for(u"c4"))
 814             d.addCallback(lambda metadata:
 815                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 816                                               (metadata['key'] == "value"), metadata))
 817
 818             d.addCallback(lambda res: n.delete(u"c2"))
 819             d.addCallback(lambda res: n.delete(u"c3"))
 820             d.addCallback(lambda res: n.delete(u"c4"))
 821
 822             # set_node + metadata
 823             # it should be possible to add a child without any metadata except for timestamps
 824             d.addCallback(lambda res: n.set_node(u"d2", n, {}))
 825             d.addCallback(lambda res: c.create_dirnode())
 826             d.addCallback(lambda n2:
 827                           self.shouldFail(ExistingChildError, "set_node-no",
 828                                           "child 'd2' already exists",
 829                                           n.set_node, u"d2", n2,
 830                                           overwrite=False))
 831             d.addCallback(lambda res: n.get_metadata_for(u"d2"))
 832             d.addCallback(lambda metadata:
 833                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 834
 835             # if we don't set any defaults, the child should get timestamps
 836             d.addCallback(lambda res: n.set_node(u"d3", n))
 837             d.addCallback(lambda res: n.get_metadata_for(u"d3"))
 838             d.addCallback(lambda metadata:
 839                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 840
 841             # we can also add specific metadata at set_node() time
 842             d.addCallback(lambda res: n.set_node(u"d4", n,
 843                                                 {"key": "value"}))
 844             d.addCallback(lambda res: n.get_metadata_for(u"d4"))
 845             d.addCallback(lambda metadata:
 846                           self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 847                                           (metadata["key"] == "value"), metadata))
 848
 849             d.addCallback(lambda res: n.delete(u"d2"))
 850             d.addCallback(lambda res: n.delete(u"d3"))
 851             d.addCallback(lambda res: n.delete(u"d4"))
 852
 853             # metadata through set_children()
 854             d.addCallback(lambda res:
 855                           n.set_children({
 856                               u"e1": (fake_file_uri, fake_file_uri),
 857                               u"e2": (fake_file_uri, fake_file_uri, {}),
 858                               u"e3": (fake_file_uri, fake_file_uri,
 859                                       {"key": "value"}),
 860                               }))
 861             d.addCallback(lambda n2: self.failUnlessIdentical(n2, n))
 862             d.addCallback(lambda res:
 863                           self.shouldFail(ExistingChildError, "set_children-no",
 864                                           "child 'e1' already exists",
 865                                           n.set_children,
 866                                           { u"e1": (other_file_uri,
 867                                                     other_file_uri),
 868                                             u"new": (other_file_uri,
 869                                                      other_file_uri),
 870                                             },
 871                                           overwrite=False))
 872             # and 'new' should not have been created
 873             d.addCallback(lambda res: n.list())
 874             d.addCallback(lambda children: self.failIf(u"new" in children))
 875             d.addCallback(lambda res: n.get_metadata_for(u"e1"))
 876             d.addCallback(lambda metadata:
 877                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 878             d.addCallback(lambda res: n.get_metadata_for(u"e2"))
 879             d.addCallback(lambda metadata:
 880                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 881             d.addCallback(lambda res: n.get_metadata_for(u"e3"))
 882             d.addCallback(lambda metadata:
 883                           self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 884                                           (metadata["key"] == "value"), metadata))
 885
 886             d.addCallback(lambda res: n.delete(u"e1"))
 887             d.addCallback(lambda res: n.delete(u"e2"))
 888             d.addCallback(lambda res: n.delete(u"e3"))
 889
 890             # metadata through set_nodes()
 891             d.addCallback(lambda res:
 892                           n.set_nodes({ u"f1": (n, None),
 893                                         u"f2": (n, {}),
 894                                         u"f3": (n, {"key": "value"}),
 895                                         }))
 896             d.addCallback(lambda n2: self.failUnlessIdentical(n2, n))
 897             d.addCallback(lambda res:
 898                           self.shouldFail(ExistingChildError, "set_nodes-no",
 899                                           "child 'f1' already exists",
 900                                           n.set_nodes, { u"f1": (n, None),
 901                                                          u"new": (n, None), },
 902                                           overwrite=False))
 903             # and 'new' should not have been created
 904             d.addCallback(lambda res: n.list())
 905             d.addCallback(lambda children: self.failIf(u"new" in children))
 906             d.addCallback(lambda res: n.get_metadata_for(u"f1"))
 907             d.addCallback(lambda metadata:
 908                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 909             d.addCallback(lambda res: n.get_metadata_for(u"f2"))
 910             d.addCallback(lambda metadata:
 911                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
 912             d.addCallback(lambda res: n.get_metadata_for(u"f3"))
 913             d.addCallback(lambda metadata:
 914                           self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 915                                           (metadata["key"] == "value"), metadata))
 916
 917             d.addCallback(lambda res: n.delete(u"f1"))
 918             d.addCallback(lambda res: n.delete(u"f2"))
 919             d.addCallback(lambda res: n.delete(u"f3"))
 920
 921
 922             d.addCallback(lambda res:
 923                           n.set_metadata_for(u"child",
 924                                              {"tags": ["web2.0-compatible"], "tahoe": {"bad": "mojo"}}))
 925             d.addCallback(lambda n1: n1.get_metadata_for(u"child"))
 926             d.addCallback(lambda metadata:
 927                           self.failUnless((set(metadata.keys()) == set(["tags", "tahoe"])) and
 928                                           metadata["tags"] == ["web2.0-compatible"] and
 929                                           "bad" not in metadata["tahoe"], metadata))
 930
 931             d.addCallback(lambda res:
 932                           self.shouldFail(NoSuchChildError, "set_metadata_for-nosuch", "",
 933                                           n.set_metadata_for, u"nosuch", {}))
 934
 935
 936             def _start(res):
 937                 self._start_timestamp = time.time()
 938             d.addCallback(_start)
 939             # simplejson-1.7.1 (as shipped on Ubuntu 'gutsy') rounds all
 940             # floats to hundredeths (it uses str(num) instead of repr(num)).
 941             # simplejson-1.7.3 does not have this bug. To prevent this bug
 942             # from causing the test to fail, stall for more than a few
 943             # hundrededths of a second.
 944             d.addCallback(self.stall, 0.1)
 945             d.addCallback(lambda res: n.add_file(u"timestamps",
 946                                                  upload.Data("stamp me", convergence="some convergence string")))
 947             d.addCallback(self.stall, 0.1)
 948             def _stop(res):
 949                 self._stop_timestamp = time.time()
 950             d.addCallback(_stop)
 951
 952             d.addCallback(lambda res: n.get_metadata_for(u"timestamps"))
 953             def _check_timestamp1(metadata):
 954                 self.failUnlessEqual(set(metadata.keys()), set(["tahoe"]))
 955                 tahoe_md = metadata["tahoe"]
 956                 self.failUnlessEqual(set(tahoe_md.keys()), set(["linkcrtime", "linkmotime"]))
 957
 958                 self.failUnlessGreaterOrEqualThan(tahoe_md["linkcrtime"],
 959                                                   self._start_timestamp)
 960                 self.failUnlessGreaterOrEqualThan(self._stop_timestamp,
 961                                                   tahoe_md["linkcrtime"])
 962                 self.failUnlessGreaterOrEqualThan(tahoe_md["linkmotime"],
 963                                                   self._start_timestamp)
 964                 self.failUnlessGreaterOrEqualThan(self._stop_timestamp,
 965                                                   tahoe_md["linkmotime"])
 966                 # Our current timestamp rules say that replacing an existing
 967                 # child should preserve the 'linkcrtime' but update the
 968                 # 'linkmotime'
 969                 self._old_linkcrtime = tahoe_md["linkcrtime"]
 970                 self._old_linkmotime = tahoe_md["linkmotime"]
 971             d.addCallback(_check_timestamp1)
 972             d.addCallback(self.stall, 2.0) # accomodate low-res timestamps
 973             d.addCallback(lambda res: n.set_node(u"timestamps", n))
 974             d.addCallback(lambda res: n.get_metadata_for(u"timestamps"))
 975             def _check_timestamp2(metadata):
 976                 self.failUnlessIn("tahoe", metadata)
 977                 tahoe_md = metadata["tahoe"]
 978                 self.failUnlessEqual(set(tahoe_md.keys()), set(["linkcrtime", "linkmotime"]))
 979
 980                 self.failUnlessEqual(tahoe_md["linkcrtime"], self._old_linkcrtime)
 981                 self.failUnlessGreaterThan(tahoe_md["linkmotime"], self._old_linkmotime)
 982                 return n.delete(u"timestamps")
 983             d.addCallback(_check_timestamp2)
 984
 985             d.addCallback(lambda res: n.delete(u"subdir"))
 986             d.addCallback(lambda old_child:
 987                           self.failUnlessEqual(old_child.get_uri(),
 988                                                self.subdir.get_uri()))
 989
 990             d.addCallback(lambda res: n.list())
 991             d.addCallback(lambda children:
 992                           self.failUnlessEqual(set(children.keys()),
 993                                                set([u"child"])))
 994
 995             uploadable1 = upload.Data("some data", convergence="converge")
 996             d.addCallback(lambda res: n.add_file(u"newfile", uploadable1))
 997             d.addCallback(lambda newnode:
 998                           self.failUnless(IImmutableFileNode.providedBy(newnode)))
 999             uploadable2 = upload.Data("some data", convergence="stuff")
1000             d.addCallback(lambda res:
1001                           self.shouldFail(ExistingChildError, "add_file-no",
1002                                           "child 'newfile' already exists",
1003                                           n.add_file, u"newfile",
1004                                           uploadable2,
1005                                           overwrite=False))
1006             d.addCallback(lambda res: n.list())
1007             d.addCallback(lambda children:
1008                           self.failUnlessEqual(set(children.keys()),
1009                                                set([u"child", u"newfile"])))
1010             d.addCallback(lambda res: n.get_metadata_for(u"newfile"))
1011             d.addCallback(lambda metadata:
1012                           self.failUnlessEqual(set(metadata.keys()), set(["tahoe"])))
1013
1014             uploadable3 = upload.Data("some data", convergence="converge")
1015             d.addCallback(lambda res: n.add_file(u"newfile-metadata",
1016                                                  uploadable3,
1017                                                  {"key": "value"}))
1018             d.addCallback(lambda newnode:
1019                           self.failUnless(IImmutableFileNode.providedBy(newnode)))
1020             d.addCallback(lambda res: n.get_metadata_for(u"newfile-metadata"))
1021             d.addCallback(lambda metadata:
1022                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
1023                                               (metadata['key'] == "value"), metadata))
1024             d.addCallback(lambda res: n.delete(u"newfile-metadata"))
1025
1026             d.addCallback(lambda res: n.create_subdirectory(u"subdir2"))
1027             def _created2(subdir2):
1028                 self.subdir2 = subdir2
1029                 # put something in the way, to make sure it gets overwritten
1030                 return subdir2.add_file(u"child", upload.Data("overwrite me",
1031                                                               "converge"))
1032             d.addCallback(_created2)
1033
1034             d.addCallback(lambda res:
1035                           n.move_child_to(u"child", self.subdir2))
1036             d.addCallback(lambda res: n.list())
1037             d.addCallback(lambda children:
1038                           self.failUnlessEqual(set(children.keys()),
1039                                                set([u"newfile", u"subdir2"])))
1040             d.addCallback(lambda res: self.subdir2.list())
1041             d.addCallback(lambda children:
1042                           self.failUnlessEqual(set(children.keys()),
1043                                                set([u"child"])))
1044             d.addCallback(lambda res: self.subdir2.get(u"child"))
1045             d.addCallback(lambda child:
1046                           self.failUnlessEqual(child.get_uri(),
1047                                                fake_file_uri))
1048
1049             # move it back, using new_child_name=
1050             d.addCallback(lambda res:
1051                           self.subdir2.move_child_to(u"child", n, u"newchild"))
1052             d.addCallback(lambda res: n.list())
1053             d.addCallback(lambda children:
1054                           self.failUnlessEqual(set(children.keys()),
1055                                                set([u"newchild", u"newfile",
1056                                                     u"subdir2"])))
1057             d.addCallback(lambda res: self.subdir2.list())
1058             d.addCallback(lambda children:
1059                           self.failUnlessEqual(set(children.keys()), set([])))
1060
1061             # now make sure that we honor overwrite=False
1062             d.addCallback(lambda res:
1063                           self.subdir2.set_uri(u"newchild",
1064                                                other_file_uri, other_file_uri))
1065
1066             d.addCallback(lambda res:
1067                           self.shouldFail(ExistingChildError, "move_child_to-no",
1068                                           "child 'newchild' already exists",
1069                                           n.move_child_to, u"newchild",
1070                                           self.subdir2,
1071                                           overwrite=False))
1072             d.addCallback(lambda res: self.subdir2.get(u"newchild"))
1073             d.addCallback(lambda child:
1074                           self.failUnlessEqual(child.get_uri(),
1075                                                other_file_uri))
1076
1077
1078             # Setting the no-write field should diminish a mutable cap to read-only
1079             # (for both files and directories).
1080
1081             d.addCallback(lambda ign: n.set_uri(u"mutable", other_file_uri, other_file_uri))
1082             d.addCallback(lambda ign: n.get(u"mutable"))
1083             d.addCallback(lambda mutable: self.failIf(mutable.is_readonly(), mutable))
1084             d.addCallback(lambda ign: n.set_metadata_for(u"mutable", {"no-write": True}))
1085             d.addCallback(lambda ign: n.get(u"mutable"))
1086             d.addCallback(lambda mutable: self.failUnless(mutable.is_readonly(), mutable))
1087             d.addCallback(lambda ign: n.set_metadata_for(u"mutable", {"no-write": True}))
1088             d.addCallback(lambda ign: n.get(u"mutable"))
1089             d.addCallback(lambda mutable: self.failUnless(mutable.is_readonly(), mutable))
1090
1091             d.addCallback(lambda ign: n.get(u"subdir2"))
1092             d.addCallback(lambda subdir2: self.failIf(subdir2.is_readonly()))
1093             d.addCallback(lambda ign: n.set_metadata_for(u"subdir2", {"no-write": True}))
1094             d.addCallback(lambda ign: n.get(u"subdir2"))
1095             d.addCallback(lambda subdir2: self.failUnless(subdir2.is_readonly(), subdir2))
1096
1097             d.addCallback(lambda ign: n.set_uri(u"mutable_ro", other_file_uri, other_file_uri,
1098                                                 metadata={"no-write": True}))
1099             d.addCallback(lambda ign: n.get(u"mutable_ro"))
1100             d.addCallback(lambda mutable_ro: self.failUnless(mutable_ro.is_readonly(), mutable_ro))
1101
1102             d.addCallback(lambda ign: n.create_subdirectory(u"subdir_ro", metadata={"no-write": True}))
1103             d.addCallback(lambda ign: n.get(u"subdir_ro"))
1104             d.addCallback(lambda subdir_ro: self.failUnless(subdir_ro.is_readonly(), subdir_ro))
1105
1106             return d
1107
1108         d.addCallback(_then)
1109
1110         d.addErrback(self.explain_error)
1111         return d
1112
1113     def test_update_metadata(self):
1114         (t1, t2, t3) = (626644800.0, 634745640.0, 892226160.0)
1115
1116         md1 = dirnode.update_metadata({"ctime": t1}, {}, t2)
1117         self.failUnlessEqual(md1, {"tahoe":{"linkcrtime": t1, "linkmotime": t2}})
1118
1119         md2 = dirnode.update_metadata(md1, {"key": "value", "tahoe": {"bad": "mojo"}}, t3)
1120         self.failUnlessEqual(md2, {"key": "value",
1121                                    "tahoe":{"linkcrtime": t1, "linkmotime": t3}})
1122
1123         md3 = dirnode.update_metadata({}, None, t3)
1124         self.failUnlessEqual(md3, {"tahoe":{"linkcrtime": t3, "linkmotime": t3}})
1125
1126         md4 = dirnode.update_metadata({}, {"bool": True, "number": 42}, t1)
1127         self.failUnlessEqual(md4, {"bool": True, "number": 42,
1128                                    "tahoe":{"linkcrtime": t1, "linkmotime": t1}})
1129
1130     def test_create_subdirectory(self):
1131         self.basedir = "dirnode/Dirnode/test_create_subdirectory"
1132         self.set_up_grid()
1133         c = self.g.clients[0]
1134         nm = c.nodemaker
1135
1136         d = c.create_dirnode()
1137         def _then(n):
1138             # /
1139             self.rootnode = n
1140             fake_file_uri = make_mutable_file_uri()
1141             other_file_uri = make_mutable_file_uri()
1142             md = {"metakey": "metavalue"}
1143             kids = {u"kid1": (nm.create_from_cap(fake_file_uri), {}),
1144                     u"kid2": (nm.create_from_cap(other_file_uri), md),
1145                     }
1146             d = n.create_subdirectory(u"subdir", kids)
1147             def _check(sub):
1148                 d = n.get_child_at_path(u"subdir")
1149                 d.addCallback(lambda sub2: self.failUnlessEqual(sub2.get_uri(),
1150                                                                 sub.get_uri()))
1151                 d.addCallback(lambda ign: sub.list())
1152                 return d
1153             d.addCallback(_check)
1154             def _check_kids(kids2):
1155                 self.failUnlessEqual(set(kids.keys()), set(kids2.keys()))
1156                 self.failUnlessEqual(kids2[u"kid2"][1]["metakey"], "metavalue")
1157             d.addCallback(_check_kids)
1158             return d
1159         d.addCallback(_then)
1160         return d
1161
1162 class MinimalFakeMutableFile:
1163     def get_writekey(self):
1164         return "writekey"
1165
1166 class Packing(unittest.TestCase):
1167     # This is a base32-encoded representation of the directory tree
1168     # root/file1
1169     # root/file2
1170     # root/file3
1171     # as represented after being fed to _pack_contents.
1172     # We have it here so we can decode it, feed it to
1173     # _unpack_contents, and verify that _unpack_contents
1174     # works correctly.
1175
1176     known_tree = "GM4TOORVHJTGS3DFGEWDSNJ2KVJESOSDJBFTU33MPB2GS3LZNVYG6N3GGI3WU5TIORTXC3DOMJ2G4NB2MVWXUZDONBVTE5LNGRZWK2LYN55GY23XGNYXQMTOMZUWU5TENN4DG23ZG5UTO2L2NQ2DO6LFMRWDMZJWGRQTUMZ2GEYDUMJQFQYTIMZ22XZKZORX5XS7CAQCSK3URR6QOHISHRCMGER5LRFSZRNAS5ZSALCS6TWFQAE754IVOIKJVK73WZPP3VUUEDTX3WHTBBZ5YX3CEKHCPG3ZWQLYA4QM6LDRCF7TJQYWLIZHKGN5ROA3AUZPXESBNLQQ6JTC2DBJU2D47IZJTLR3PKZ4RVF57XLPWY7FX7SZV3T6IJ3ORFW37FXUPGOE3ROPFNUX5DCGMAQJ3PGGULBRGM3TU6ZCMN2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGI3TKNRWGEWCAITUMFUG6ZJCHIQHWITMNFXGW3LPORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBSG42TMNRRFQQCE3DJNZVWG4TUNFWWKIR2EAYTENBWGY3DGOBZG4XDIMRXGU3DMML5FQQCE3LUNFWWKIR2EAYTENBWGY3DGOBZG4XDIMRXGU3DMML5FQWDGOJRHI2TUZTJNRSTELBZGQ5FKUSJHJBUQSZ2MFYGKZ3SOBSWQ43IO52WO23CNAZWU3DUGVSWSNTIOE5DK33POVTW4ZLNMNWDK6DHPA2GS2THNF2W25DEN5VGY2LQNFRGG5DKNNRHO5TZPFTWI6LNMRYGQ2LCGJTHM4J2GM5DCMB2GQWDCNBSHKVVQBGRYMACKJ27CVQ6O6B4QPR72RFVTGOZUI76XUSWAX73JRV5PYRHMIFYZIA25MXDPGUGML6M2NMRSG4YD4W4K37ZDYSXHMJ3IUVT4F64YTQQVBJFFFOUC7J7LAB2VFCL5UKKGMR2D3F4EPOYC7UYWQZNR5KXHBSNXLCNBX2SNF22DCXJIHSMEKWEWOG5XCJEVVZ7UW5IB6I64XXQSJ34B5CAYZGZIIMR6LBRGMZTU6ZCMN2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMYDEMJYFQQCE5DBNBXWKIR2EB5SE3DJNZVW233UNFWWKIR2EAYTENBWGY3DGOBZG4XDIMZQGIYTQLBAEJWGS3TLMNZHI2LNMURDUIBRGI2DMNRWGM4DSNZOGQZTAMRRHB6SYIBCNV2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMYDEMJYPUWCYMZZGU5DKOTGNFWGKMZMHE2DUVKSJE5EGSCLHJRW25DDPBYTO2DXPB3GM6DBNYZTI6LJMV3DM2LWNB4TU4LWMNSWW3LKORXWK5DEMN3TI23NNE3WEM3SORRGY5THPA3TKNBUMNZG453BOF2GSZLXMVWWI3DJOFZW623RHIZTUMJQHI2SYMJUGI5BOSHWDPG3WKPAVXCF3XMKA7QVIWPRMWJHDTQHD27AHDCPJWDQENQ5H5ZZILTXQNIXXCIW4LKQABU2GCFRG5FHQN7CHD7HF4EKNRZFIV2ZYQIBM7IQU7F4RGB3XCX3FREPBKQ7UCICHVWPCYFGA6OLH3J45LXQ6GWWICJ3PGWJNLZ7PCRNLAPNYUGU6BENS7OXMBEOOFRIZV3PF2FFWZ5WHDPKXERYP7GNHKRMGEZTOOT3EJRXI2LNMURDUIBRGI2DMNRWGM4DSNZOGQZTGNRSGY4SYIBCORQWQ33FEI5CA6ZCNRUW423NN52GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMZTMMRWHEWCAITMNFXGWY3SORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBTGM3DENRZPUWCAITNORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBTGM3DENRZPUWCY==="
1177
1178     def test_unpack_and_pack_behavior(self):
1179         known_tree = b32decode(self.known_tree)
1180         nodemaker = NodeMaker(None, None, None,
1181                               None, None, None,
1182                               {"k": 3, "n": 10}, None)
1183         write_uri = "URI:SSK-RO:e3mdrzfwhoq42hy5ubcz6rp3o4:ybyibhnp3vvwuq2vaw2ckjmesgkklfs6ghxleztqidihjyofgw7q"
1184         filenode = nodemaker.create_from_cap(write_uri)
1185         node = dirnode.DirectoryNode(filenode, nodemaker, None)
1186         children = node._unpack_contents(known_tree)
1187         self._check_children(children)
1188
1189         packed_children = node._pack_contents(children)
1190         children = node._unpack_contents(packed_children)
1191         self._check_children(children)
1192
1193     def _check_children(self, children):
1194         # Are all the expected child nodes there?
1195         self.failUnless(children.has_key(u'file1'))
1196         self.failUnless(children.has_key(u'file2'))
1197         self.failUnless(children.has_key(u'file3'))
1198
1199         # Are the metadata for child 3 right?
1200         file3_rocap = "URI:CHK:cmtcxq7hwxvfxan34yiev6ivhy:qvcekmjtoetdcw4kmi7b3rtblvgx7544crnwaqtiewemdliqsokq:3:10:5"
1201         file3_rwcap = "URI:CHK:cmtcxq7hwxvfxan34yiev6ivhy:qvcekmjtoetdcw4kmi7b3rtblvgx7544crnwaqtiewemdliqsokq:3:10:5"
1202         file3_metadata = {'ctime': 1246663897.4336269, 'tahoe': {'linkmotime': 1246663897.4336269, 'linkcrtime': 1246663897.4336269}, 'mtime': 1246663897.4336269}
1203         self.failUnlessEqual(file3_metadata, children[u'file3'][1])
1204         self.failUnlessEqual(file3_rocap,
1205                              children[u'file3'][0].get_readonly_uri())
1206         self.failUnlessEqual(file3_rwcap,
1207                              children[u'file3'][0].get_uri())
1208
1209         # Are the metadata for child 2 right?
1210         file2_rocap = "URI:CHK:apegrpehshwugkbh3jlt5ei6hq:5oougnemcl5xgx4ijgiumtdojlipibctjkbwvyygdymdphib2fvq:3:10:4"
1211         file2_rwcap = "URI:CHK:apegrpehshwugkbh3jlt5ei6hq:5oougnemcl5xgx4ijgiumtdojlipibctjkbwvyygdymdphib2fvq:3:10:4"
1212         file2_metadata = {'ctime': 1246663897.430218, 'tahoe': {'linkmotime': 1246663897.430218, 'linkcrtime': 1246663897.430218}, 'mtime': 1246663897.430218}
1213         self.failUnlessEqual(file2_metadata, children[u'file2'][1])
1214         self.failUnlessEqual(file2_rocap,
1215                              children[u'file2'][0].get_readonly_uri())
1216         self.failUnlessEqual(file2_rwcap,
1217                              children[u'file2'][0].get_uri())
1218
1219         # Are the metadata for child 1 right?
1220         file1_rocap = "URI:CHK:olxtimympo7f27jvhtgqlnbtn4:emzdnhk2um4seixozlkw3qx2nfijvdkx3ky7i7izl47yedl6e64a:3:10:10"
1221         file1_rwcap = "URI:CHK:olxtimympo7f27jvhtgqlnbtn4:emzdnhk2um4seixozlkw3qx2nfijvdkx3ky7i7izl47yedl6e64a:3:10:10"
1222         file1_metadata = {'ctime': 1246663897.4275661, 'tahoe': {'linkmotime': 1246663897.4275661, 'linkcrtime': 1246663897.4275661}, 'mtime': 1246663897.4275661}
1223         self.failUnlessEqual(file1_metadata, children[u'file1'][1])
1224         self.failUnlessEqual(file1_rocap,
1225                              children[u'file1'][0].get_readonly_uri())
1226         self.failUnlessEqual(file1_rwcap,
1227                              children[u'file1'][0].get_uri())
1228
1229     def _make_kids(self, nm, which):
1230         caps = {"imm": "URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861",
1231                 "lit": "URI:LIT:n5xgk", # LIT for "one"
1232                 "write": "URI:SSK:vfvcbdfbszyrsaxchgevhmmlii:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq",
1233                 "read": "URI:SSK-RO:e3mdrzfwhoq42hy5ubcz6rp3o4:ybyibhnp3vvwuq2vaw2ckjmesgkklfs6ghxleztqidihjyofgw7q",
1234                 "dirwrite": "URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq",
1235                 "dirread":  "URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq",
1236                 }
1237         kids = {}
1238         for name in which:
1239             kids[unicode(name)] = (nm.create_from_cap(caps[name]), {})
1240         return kids
1241
1242     def test_deep_immutable(self):
1243         nm = NodeMaker(None, None, None, None, None, None, {"k": 3, "n": 10},
1244                        None)
1245         fn = MinimalFakeMutableFile()
1246
1247         kids = self._make_kids(nm, ["imm", "lit", "write", "read",
1248                                     "dirwrite", "dirread"])
1249         packed = dirnode.pack_children(fn, kids, deep_immutable=False)
1250         self.failUnlessIn("lit", packed)
1251
1252         kids = self._make_kids(nm, ["imm", "lit"])
1253         packed = dirnode.pack_children(fn, kids, deep_immutable=True)
1254         self.failUnlessIn("lit", packed)
1255
1256         kids = self._make_kids(nm, ["imm", "lit", "write"])
1257         self.failUnlessRaises(dirnode.MustBeDeepImmutableError,
1258                               dirnode.pack_children,
1259                               fn, kids, deep_immutable=True)
1260
1261         # read-only is not enough: all children must be immutable
1262         kids = self._make_kids(nm, ["imm", "lit", "read"])
1263         self.failUnlessRaises(dirnode.MustBeDeepImmutableError,
1264                               dirnode.pack_children,
1265                               fn, kids, deep_immutable=True)
1266
1267         kids = self._make_kids(nm, ["imm", "lit", "dirwrite"])
1268         self.failUnlessRaises(dirnode.MustBeDeepImmutableError,
1269                               dirnode.pack_children,
1270                               fn, kids, deep_immutable=True)
1271
1272         kids = self._make_kids(nm, ["imm", "lit", "dirread"])
1273         self.failUnlessRaises(dirnode.MustBeDeepImmutableError,
1274                               dirnode.pack_children,
1275                               fn, kids, deep_immutable=True)
1276
1277 class FakeMutableFile:
1278     implements(IMutableFileNode)
1279     counter = 0
1280     def __init__(self, initial_contents=""):
1281         self.data = self._get_initial_contents(initial_contents)
1282         counter = FakeMutableFile.counter
1283         FakeMutableFile.counter += 1
1284         writekey = hashutil.ssk_writekey_hash(str(counter))
1285         fingerprint = hashutil.ssk_pubkey_fingerprint_hash(str(counter))
1286         self.uri = uri.WriteableSSKFileURI(writekey, fingerprint)
1287
1288     def _get_initial_contents(self, contents):
1289         if isinstance(contents, str):
1290             return contents
1291         if contents is None:
1292             return ""
1293         assert callable(contents), "%s should be callable, not %s" % \
1294                (contents, type(contents))
1295         return contents(self)
1296
1297     def get_cap(self):
1298         return self.uri
1299
1300     def get_uri(self):
1301         return self.uri.to_string()
1302
1303     def get_write_uri(self):
1304         return self.uri.to_string()
1305
1306     def download_best_version(self):
1307         return defer.succeed(self.data)
1308
1309     def get_writekey(self):
1310         return "writekey"
1311
1312     def is_readonly(self):
1313         return False
1314
1315     def is_mutable(self):
1316         return True
1317
1318     def is_unknown(self):
1319         return False
1320
1321     def is_allowed_in_immutable_directory(self):
1322         return False
1323
1324     def raise_error(self):
1325         pass
1326
1327     def modify(self, modifier):
1328         self.data = modifier(self.data, None, True)
1329         return defer.succeed(None)
1330
1331 class FakeNodeMaker(NodeMaker):
1332     def create_mutable_file(self, contents="", keysize=None):
1333         return defer.succeed(FakeMutableFile(contents))
1334
1335 class FakeClient2(Client):
1336     def __init__(self):
1337         self.nodemaker = FakeNodeMaker(None, None, None,
1338                                        None, None, None,
1339                                        {"k":3,"n":10}, None)
1340     def create_node_from_uri(self, rwcap, rocap):
1341         return self.nodemaker.create_from_cap(rwcap, rocap)
1342
1343 class Dirnode2(unittest.TestCase, testutil.ShouldFailMixin):
1344     def setUp(self):
1345         client = FakeClient2()
1346         self.nodemaker = client.nodemaker
1347
1348     def test_from_future(self):
1349         # Create a mutable directory that contains unknown URI types, and make sure
1350         # we tolerate them properly.
1351         d = self.nodemaker.create_new_mutable_directory()
1352         future_write_uri = "x-tahoe-crazy://I_am_from_the_future."
1353         future_read_uri = "x-tahoe-crazy-readonly://I_am_from_the_future."
1354         future_imm_uri = "x-tahoe-crazy-immutable://I_am_from_the_future."
1355         future_node = UnknownNode(future_write_uri, future_read_uri)
1356         def _then(n):
1357             self._node = n
1358             return n.set_node(u"future", future_node)
1359         d.addCallback(_then)
1360
1361         # We should be prohibited from adding an unknown URI to a directory
1362         # just in the rw_uri slot, since we don't know how to diminish the cap
1363         # to a readcap (for the ro_uri slot).
1364         d.addCallback(lambda ign:
1365              self.shouldFail(MustNotBeUnknownRWError,
1366                              "copy unknown",
1367                              "cannot attach unknown rw cap as child",
1368                              self._node.set_uri, u"add",
1369                              future_write_uri, None))
1370
1371         # However, we should be able to add both rw_uri and ro_uri as a pair of
1372         # unknown URIs.
1373         d.addCallback(lambda ign: self._node.set_uri(u"add-pair",
1374                                                      future_write_uri, future_read_uri))
1375
1376         # and to add an URI prefixed with "ro." or "imm." when it is given in a
1377         # write slot (or URL parameter).
1378         d.addCallback(lambda ign: self._node.set_uri(u"add-ro",
1379                                                      "ro." + future_read_uri, None))
1380         d.addCallback(lambda ign: self._node.set_uri(u"add-imm",
1381                                                      "imm." + future_imm_uri, None))
1382
1383         d.addCallback(lambda ign: self._node.list())
1384         def _check(children):
1385             self.failUnlessEqual(len(children), 4)
1386             (fn, metadata) = children[u"future"]
1387             self.failUnless(isinstance(fn, UnknownNode), fn)
1388             self.failUnlessEqual(fn.get_uri(), future_write_uri)
1389             self.failUnlessEqual(fn.get_write_uri(), future_write_uri)
1390             self.failUnlessEqual(fn.get_readonly_uri(), "ro." + future_read_uri)
1391
1392             (fn2, metadata2) = children[u"add-pair"]
1393             self.failUnless(isinstance(fn2, UnknownNode), fn2)
1394             self.failUnlessEqual(fn2.get_uri(), future_write_uri)
1395             self.failUnlessEqual(fn2.get_write_uri(), future_write_uri)
1396             self.failUnlessEqual(fn2.get_readonly_uri(), "ro." + future_read_uri)
1397
1398             (fn3, metadata3) = children[u"add-ro"]
1399             self.failUnless(isinstance(fn3, UnknownNode), fn3)
1400             self.failUnlessEqual(fn3.get_uri(), "ro." + future_read_uri)
1401             self.failUnlessEqual(fn3.get_write_uri(), None)
1402             self.failUnlessEqual(fn3.get_readonly_uri(), "ro." + future_read_uri)
1403
1404             (fn4, metadata4) = children[u"add-imm"]
1405             self.failUnless(isinstance(fn4, UnknownNode), fn4)
1406             self.failUnlessEqual(fn4.get_uri(), "imm." + future_imm_uri)
1407             self.failUnlessEqual(fn4.get_write_uri(), None)
1408             self.failUnlessEqual(fn4.get_readonly_uri(), "imm." + future_imm_uri)
1409
1410             # We should also be allowed to copy the "future" UnknownNode, because
1411             # it contains all the information that was in the original directory
1412             # (readcap and writecap), so we're preserving everything.
1413             return self._node.set_node(u"copy", fn)
1414         d.addCallback(_check)
1415
1416         d.addCallback(lambda ign: self._node.list())
1417         def _check2(children):
1418             self.failUnlessEqual(len(children), 5)
1419             (fn, metadata) = children[u"copy"]
1420             self.failUnless(isinstance(fn, UnknownNode), fn)
1421             self.failUnlessEqual(fn.get_uri(), future_write_uri)
1422             self.failUnlessEqual(fn.get_write_uri(), future_write_uri)
1423             self.failUnlessEqual(fn.get_readonly_uri(), "ro." + future_read_uri)
1424         d.addCallback(_check2)
1425         return d
1426
1427     def test_unknown_strip_prefix_for_ro(self):
1428         self.failUnlessEqual(strip_prefix_for_ro("foo",     False), "foo")
1429         self.failUnlessEqual(strip_prefix_for_ro("ro.foo",  False), "foo")
1430         self.failUnlessEqual(strip_prefix_for_ro("imm.foo", False), "imm.foo")
1431         self.failUnlessEqual(strip_prefix_for_ro("foo",     True),  "foo")
1432         self.failUnlessEqual(strip_prefix_for_ro("ro.foo",  True),  "foo")
1433         self.failUnlessEqual(strip_prefix_for_ro("imm.foo", True),  "foo")
1434
1435     def test_unknownnode(self):
1436         mut_write_uri = "URI:SSK:vfvcbdfbszyrsaxchgevhmmlii:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq"
1437         mut_read_uri = "URI:SSK-RO:jf6wkflosyvntwxqcdo7a54jvm:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq"
1438         lit_uri = "URI:LIT:n5xgk"
1439
1440         # This does not attempt to be exhaustive.
1441         no_no        = [# Opaque node, but not an error.
1442                         ( 0, UnknownNode(None, None)),
1443                         ( 1, UnknownNode(None, None, deep_immutable=True)),
1444                        ]
1445         unknown_rw   = [# These are errors because we're only given a rw_uri, and we can't
1446                         # diminish it.
1447                         ( 2, UnknownNode("foo", None)),
1448                         ( 3, UnknownNode("foo", None, deep_immutable=True)),
1449                         ( 4, UnknownNode("ro.foo", None, deep_immutable=True)),
1450                         ( 5, UnknownNode("ro." + mut_read_uri, None, deep_immutable=True)),
1451                         ( 6, UnknownNode("URI:SSK-RO:foo", None, deep_immutable=True)),
1452                         ( 7, UnknownNode("URI:SSK:foo", None)),
1453                        ]
1454         must_be_ro   = [# These are errors because a readonly constraint is not met.
1455                         ( 8, UnknownNode("ro." + mut_write_uri, None)),
1456                         ( 9, UnknownNode(None, "ro." + mut_write_uri)),
1457                        ]
1458         must_be_imm  = [# These are errors because an immutable constraint is not met.
1459                         (10, UnknownNode(None, "ro.URI:SSK-RO:foo", deep_immutable=True)),
1460                         (11, UnknownNode(None, "imm.URI:SSK:foo")),
1461                         (12, UnknownNode(None, "imm.URI:SSK-RO:foo")),
1462                         (13, UnknownNode("bar", "ro.foo", deep_immutable=True)),
1463                         (14, UnknownNode("bar", "imm.foo", deep_immutable=True)),
1464                         (15, UnknownNode("bar", "imm." + lit_uri, deep_immutable=True)),
1465                         (16, UnknownNode("imm." + mut_write_uri, None)),
1466                         (17, UnknownNode("imm." + mut_read_uri, None)),
1467                         (18, UnknownNode("bar", "imm.foo")),
1468                        ]
1469         bad_uri      = [# These are errors because the URI is bad once we've stripped the prefix.
1470                         (19, UnknownNode("ro.URI:SSK-RO:foo", None)),
1471                         (20, UnknownNode("imm.URI:CHK:foo", None, deep_immutable=True)),
1472                         (21, UnknownNode(None, "URI:CHK:foo")),
1473                         (22, UnknownNode(None, "URI:CHK:foo", deep_immutable=True)),
1474                        ]
1475         ro_prefixed  = [# These are valid, and the readcap should end up with a ro. prefix.
1476                         (23, UnknownNode(None, "foo")),
1477                         (24, UnknownNode(None, "ro.foo")),
1478                         (25, UnknownNode(None, "ro." + lit_uri)),
1479                         (26, UnknownNode("bar", "foo")),
1480                         (27, UnknownNode("bar", "ro.foo")),
1481                         (28, UnknownNode("bar", "ro." + lit_uri)),
1482                         (29, UnknownNode("ro.foo", None)),
1483                         (30, UnknownNode("ro." + lit_uri, None)),
1484                        ]
1485         imm_prefixed = [# These are valid, and the readcap should end up with an imm. prefix.
1486                         (31, UnknownNode(None, "foo", deep_immutable=True)),
1487                         (32, UnknownNode(None, "ro.foo", deep_immutable=True)),
1488                         (33, UnknownNode(None, "imm.foo")),
1489                         (34, UnknownNode(None, "imm.foo", deep_immutable=True)),
1490                         (35, UnknownNode("imm." + lit_uri, None)),
1491                         (36, UnknownNode("imm." + lit_uri, None, deep_immutable=True)),
1492                         (37, UnknownNode(None, "imm." + lit_uri)),
1493                         (38, UnknownNode(None, "imm." + lit_uri, deep_immutable=True)),
1494                        ]
1495         error = unknown_rw + must_be_ro + must_be_imm + bad_uri
1496         ok = ro_prefixed + imm_prefixed
1497
1498         for (i, n) in no_no + error + ok:
1499             self.failUnless(n.is_unknown(), i)
1500
1501         for (i, n) in no_no + error:
1502             self.failUnless(n.get_uri() is None, i)
1503             self.failUnless(n.get_write_uri() is None, i)
1504             self.failUnless(n.get_readonly_uri() is None, i)
1505
1506         for (i, n) in no_no + ok:
1507             n.raise_error()
1508
1509         for (i, n) in unknown_rw:
1510             self.failUnlessRaises(MustNotBeUnknownRWError, lambda: n.raise_error())
1511
1512         for (i, n) in must_be_ro:
1513             self.failUnlessRaises(MustBeReadonlyError, lambda: n.raise_error())
1514
1515         for (i, n) in must_be_imm:
1516             self.failUnlessRaises(MustBeDeepImmutableError, lambda: n.raise_error())
1517
1518         for (i, n) in bad_uri:
1519             self.failUnlessRaises(uri.BadURIError, lambda: n.raise_error())
1520
1521         for (i, n) in ok:
1522             self.failIf(n.get_readonly_uri() is None, i)
1523
1524         for (i, n) in ro_prefixed:
1525             self.failUnless(n.get_readonly_uri().startswith("ro."), i)
1526
1527         for (i, n) in imm_prefixed:
1528             self.failUnless(n.get_readonly_uri().startswith("imm."), i)
1529
1530
1531 class DeepStats(unittest.TestCase):
1532     timeout = 240 # It takes longer than 120 seconds on Francois's arm box.
1533     def test_stats(self):
1534         ds = dirnode.DeepStats(None)
1535         ds.add("count-files")
1536         ds.add("size-immutable-files", 123)
1537         ds.histogram("size-files-histogram", 123)
1538         ds.max("largest-directory", 444)
1539
1540         s = ds.get_results()
1541         self.failUnlessEqual(s["count-files"], 1)
1542         self.failUnlessEqual(s["size-immutable-files"], 123)
1543         self.failUnlessEqual(s["largest-directory"], 444)
1544         self.failUnlessEqual(s["count-literal-files"], 0)
1545
1546         ds.add("count-files")
1547         ds.add("size-immutable-files", 321)
1548         ds.histogram("size-files-histogram", 321)
1549         ds.max("largest-directory", 2)
1550
1551         s = ds.get_results()
1552         self.failUnlessEqual(s["count-files"], 2)
1553         self.failUnlessEqual(s["size-immutable-files"], 444)
1554         self.failUnlessEqual(s["largest-directory"], 444)
1555         self.failUnlessEqual(s["count-literal-files"], 0)
1556         self.failUnlessEqual(s["size-files-histogram"],
1557                              [ (101, 316, 1), (317, 1000, 1) ])
1558
1559         ds = dirnode.DeepStats(None)
1560         for i in range(1, 1100):
1561             ds.histogram("size-files-histogram", i)
1562         ds.histogram("size-files-histogram", 4*1000*1000*1000*1000) # 4TB
1563         s = ds.get_results()
1564         self.failUnlessEqual(s["size-files-histogram"],
1565                              [ (1, 3, 3),
1566                                (4, 10, 7),
1567                                (11, 31, 21),
1568                                (32, 100, 69),
1569                                (101, 316, 216),
1570                                (317, 1000, 684),
1571                                (1001, 3162, 99),
1572                                (3162277660169L, 10000000000000L, 1),
1573                                ])
1574
1575 class UCWEingMutableFileNode(MutableFileNode):
1576     please_ucwe_after_next_upload = False
1577
1578     def _upload(self, new_contents, servermap):
1579         d = MutableFileNode._upload(self, new_contents, servermap)
1580         def _ucwe(res):
1581             if self.please_ucwe_after_next_upload:
1582                 self.please_ucwe_after_next_upload = False
1583                 raise UncoordinatedWriteError()
1584             return res
1585         d.addCallback(_ucwe)
1586         return d
1587
1588 class UCWEingNodeMaker(NodeMaker):
1589     def _create_mutable(self, cap):
1590         n = UCWEingMutableFileNode(self.storage_broker, self.secret_holder,
1591                                    self.default_encoding_parameters,
1592                                    self.history)
1593         return n.init_from_cap(cap)
1594
1595
1596 class Deleter(GridTestMixin, unittest.TestCase):
1597     timeout = 3600 # It takes longer than 433 seconds on Zandr's ARM box.
1598     def test_retry(self):
1599         # ticket #550, a dirnode.delete which experiences an
1600         # UncoordinatedWriteError will fail with an incorrect "you're
1601         # deleting something which isn't there" NoSuchChildError exception.
1602
1603         # to trigger this, we start by creating a directory with a single
1604         # file in it. Then we create a special dirnode that uses a modified
1605         # MutableFileNode which will raise UncoordinatedWriteError once on
1606         # demand. We then call dirnode.delete, which ought to retry and
1607         # succeed.
1608
1609         self.basedir = self.mktemp()
1610         self.set_up_grid()
1611         c0 = self.g.clients[0]
1612         d = c0.create_dirnode()
1613         small = upload.Data("Small enough for a LIT", None)
1614         def _created_dir(dn):
1615             self.root = dn
1616             self.root_uri = dn.get_uri()
1617             return dn.add_file(u"file", small)
1618         d.addCallback(_created_dir)
1619         def _do_delete(ignored):
1620             nm = UCWEingNodeMaker(c0.storage_broker, c0._secret_holder,
1621                                   c0.get_history(), c0.getServiceNamed("uploader"),
1622                                   c0.downloader,
1623                                   c0.download_cache_dirman,
1624                                   c0.get_encoding_parameters(),
1625                                   c0._key_generator)
1626             n = nm.create_from_cap(self.root_uri)
1627             assert n._node.please_ucwe_after_next_upload == False
1628             n._node.please_ucwe_after_next_upload = True
1629             # This should succeed, not raise an exception
1630             return n.delete(u"file")
1631         d.addCallback(_do_delete)
1632
1633         return d
1634
1635 class Adder(GridTestMixin, unittest.TestCase, testutil.ShouldFailMixin):
1636
1637     def test_overwrite(self):
1638         # note: This functionality could be tested without actually creating
1639         # several RSA keys. It would be faster without the GridTestMixin: use
1640         # dn.set_node(nodemaker.create_from_cap(make_chk_file_uri())) instead
1641         # of dn.add_file, and use a special NodeMaker that creates fake
1642         # mutable files.
1643         self.basedir = "dirnode/Adder/test_overwrite"
1644         self.set_up_grid()
1645         c = self.g.clients[0]
1646         fileuri = make_chk_file_uri(1234)
1647         filenode = c.nodemaker.create_from_cap(fileuri)
1648         d = c.create_dirnode()
1649
1650         def _create_directory_tree(root_node):
1651             # Build
1652             # root/file1
1653             # root/file2
1654             # root/dir1
1655             d = root_node.add_file(u'file1', upload.Data("Important Things",
1656                 None))
1657             d.addCallback(lambda res:
1658                 root_node.add_file(u'file2', upload.Data("Sekrit Codes", None)))
1659             d.addCallback(lambda res:
1660                 root_node.create_subdirectory(u"dir1"))
1661             d.addCallback(lambda res: root_node)
1662             return d
1663
1664         d.addCallback(_create_directory_tree)
1665
1666         def _test_adder(root_node):
1667             d = root_node.set_node(u'file1', filenode)
1668             # We've overwritten file1. Let's try it with a directory
1669             d.addCallback(lambda res:
1670                 root_node.create_subdirectory(u'dir2'))
1671             d.addCallback(lambda res:
1672                 root_node.set_node(u'dir2', filenode))
1673             # We try overwriting a file with a child while also specifying
1674             # overwrite=False. We should receive an ExistingChildError
1675             # when we do this.
1676             d.addCallback(lambda res:
1677                 self.shouldFail(ExistingChildError, "set_node",
1678                                 "child 'file1' already exists",
1679                                 root_node.set_node, u"file1",
1680                                 filenode, overwrite=False))
1681             # If we try with a directory, we should see the same thing
1682             d.addCallback(lambda res:
1683                 self.shouldFail(ExistingChildError, "set_node",
1684                                 "child 'dir1' already exists",
1685                                 root_node.set_node, u'dir1', filenode,
1686                                 overwrite=False))
1687             d.addCallback(lambda res:
1688                 root_node.set_node(u'file1', filenode,
1689                                    overwrite="only-files"))
1690             d.addCallback(lambda res:
1691                 self.shouldFail(ExistingChildError, "set_node",
1692                                 "child 'dir1' already exists",
1693                                 root_node.set_node, u'dir1', filenode,
1694                                 overwrite="only-files"))
1695             return d
1696
1697         d.addCallback(_test_adder)
1698         return d