src/allmydata/test/test_dirnode.py

   1
   2 import time
   3 from zope.interface import implements
   4 from twisted.trial import unittest
   5 from twisted.internet import defer
   6 from allmydata import uri, dirnode
   7 from allmydata.client import Client
   8 from allmydata.immutable import upload
   9 from allmydata.interfaces import IImmutableFileNode, IMutableFileNode, \
  10      ExistingChildError, NoSuchChildError, NotDeepImmutableError, \
  11      IDeepCheckResults, IDeepCheckAndRepairResults, CannotPackUnknownNodeError
  12 from allmydata.mutable.filenode import MutableFileNode
  13 from allmydata.mutable.common import UncoordinatedWriteError
  14 from allmydata.util import hashutil, base32
  15 from allmydata.monitor import Monitor
  16 from allmydata.test.common import make_chk_file_uri, make_mutable_file_uri, \
  17      ErrorMixin
  18 from allmydata.test.no_network import GridTestMixin
  19 from allmydata.unknown import UnknownNode
  20 from allmydata.nodemaker import NodeMaker
  21 from base64 import b32decode
  22 import common_util as testutil
  23
  24 class Dirnode(GridTestMixin, unittest.TestCase,
  25               testutil.ShouldFailMixin, testutil.StallMixin, ErrorMixin):
  26     timeout = 240 # It takes longer than 120 seconds on Francois's arm box.
  27
  28     def test_basic(self):
  29         self.basedir = "dirnode/Dirnode/test_basic"
  30         self.set_up_grid()
  31         c = self.g.clients[0]
  32         d = c.create_dirnode()
  33         def _done(res):
  34             self.failUnless(isinstance(res, dirnode.DirectoryNode))
  35             rep = str(res)
  36             self.failUnless("RW-MUT" in rep)
  37         d.addCallback(_done)
  38         return d
  39
  40     def test_initial_children(self):
  41         self.basedir = "dirnode/Dirnode/test_initial_children"
  42         self.set_up_grid()
  43         c = self.g.clients[0]
  44         nm = c.nodemaker
  45         setup_py_uri = "URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861"
  46         one_uri = "URI:LIT:n5xgk" # LIT for "one"
  47         kids = {u"one": (nm.create_from_cap(one_uri), {}),
  48                 u"two": (nm.create_from_cap(setup_py_uri),
  49                          {"metakey": "metavalue"}),
  50                 }
  51         d = c.create_dirnode(kids)
  52         def _created(dn):
  53             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
  54             rep = str(dn)
  55             self.failUnless("RW-MUT" in rep)
  56             return dn.list()
  57         d.addCallback(_created)
  58         def _check_kids(children):
  59             self.failUnlessEqual(sorted(children.keys()), [u"one", u"two"])
  60             one_node, one_metadata = children[u"one"]
  61             two_node, two_metadata = children[u"two"]
  62             self.failUnlessEqual(one_node.get_size(), 3)
  63             self.failUnlessEqual(two_node.get_size(), 14861)
  64             self.failUnless(isinstance(one_metadata, dict), one_metadata)
  65             self.failUnlessEqual(two_metadata["metakey"], "metavalue")
  66         d.addCallback(_check_kids)
  67         d.addCallback(lambda ign: nm.create_new_mutable_directory(kids))
  68         d.addCallback(lambda dn: dn.list())
  69         d.addCallback(_check_kids)
  70         future_writecap = "x-tahoe-crazy://I_am_from_the_future."
  71         future_readcap = "x-tahoe-crazy-readonly://I_am_from_the_future."
  72         future_node = UnknownNode(future_writecap, future_readcap)
  73         bad_kids1 = {u"one": (future_node, {})}
  74         d.addCallback(lambda ign:
  75                       self.shouldFail(AssertionError, "bad_kids1",
  76                                       "does not accept UnknownNode",
  77                                       nm.create_new_mutable_directory,
  78                                       bad_kids1))
  79         bad_kids2 = {u"one": (nm.create_from_cap(one_uri), None)}
  80         d.addCallback(lambda ign:
  81                       self.shouldFail(AssertionError, "bad_kids2",
  82                                       "requires metadata to be a dict",
  83                                       nm.create_new_mutable_directory,
  84                                       bad_kids2))
  85         return d
  86
  87     def test_immutable(self):
  88         self.basedir = "dirnode/Dirnode/test_immutable"
  89         self.set_up_grid()
  90         c = self.g.clients[0]
  91         nm = c.nodemaker
  92         setup_py_uri = "URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861"
  93         one_uri = "URI:LIT:n5xgk" # LIT for "one"
  94         mut_readcap = "URI:SSK-RO:e3mdrzfwhoq42hy5ubcz6rp3o4:ybyibhnp3vvwuq2vaw2ckjmesgkklfs6ghxleztqidihjyofgw7q"
  95         mut_writecap = "URI:SSK:vfvcbdfbszyrsaxchgevhmmlii:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq"
  96         kids = {u"one": (nm.create_from_cap(one_uri), {}),
  97                 u"two": (nm.create_from_cap(setup_py_uri),
  98                          {"metakey": "metavalue"}),
  99                 }
 100         d = c.create_immutable_dirnode(kids)
 101         def _created(dn):
 102             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 103             self.failIf(dn.is_mutable())
 104             self.failUnless(dn.is_readonly())
 105             rep = str(dn)
 106             self.failUnless("RO-IMM" in rep)
 107             cap = dn.get_cap()
 108             self.failUnlessIn("CHK", cap.to_string())
 109             self.cap = cap
 110             return dn.list()
 111         d.addCallback(_created)
 112         def _check_kids(children):
 113             self.failUnlessEqual(sorted(children.keys()), [u"one", u"two"])
 114             one_node, one_metadata = children[u"one"]
 115             two_node, two_metadata = children[u"two"]
 116             self.failUnlessEqual(one_node.get_size(), 3)
 117             self.failUnlessEqual(two_node.get_size(), 14861)
 118             self.failUnless(isinstance(one_metadata, dict), one_metadata)
 119             self.failUnlessEqual(two_metadata["metakey"], "metavalue")
 120         d.addCallback(_check_kids)
 121         d.addCallback(lambda ign: nm.create_from_cap(self.cap.to_string()))
 122         d.addCallback(lambda dn: dn.list())
 123         d.addCallback(_check_kids)
 124         future_writecap = "x-tahoe-crazy://I_am_from_the_future."
 125         future_readcap = "x-tahoe-crazy-readonly://I_am_from_the_future."
 126         future_node = UnknownNode(future_writecap, future_readcap)
 127         bad_kids1 = {u"one": (future_node, {})}
 128         d.addCallback(lambda ign:
 129                       self.shouldFail(AssertionError, "bad_kids1",
 130                                       "does not accept UnknownNode",
 131                                       c.create_immutable_dirnode,
 132                                       bad_kids1))
 133         bad_kids2 = {u"one": (nm.create_from_cap(one_uri), None)}
 134         d.addCallback(lambda ign:
 135                       self.shouldFail(AssertionError, "bad_kids2",
 136                                       "requires metadata to be a dict",
 137                                       c.create_immutable_dirnode,
 138                                       bad_kids2))
 139         bad_kids3 = {u"one": (nm.create_from_cap(mut_writecap), {})}
 140         d.addCallback(lambda ign:
 141                       self.shouldFail(NotDeepImmutableError, "bad_kids3",
 142                                       "is not immutable",
 143                                       c.create_immutable_dirnode,
 144                                       bad_kids3))
 145         bad_kids4 = {u"one": (nm.create_from_cap(mut_readcap), {})}
 146         d.addCallback(lambda ign:
 147                       self.shouldFail(NotDeepImmutableError, "bad_kids4",
 148                                       "is not immutable",
 149                                       c.create_immutable_dirnode,
 150                                       bad_kids4))
 151         d.addCallback(lambda ign: c.create_immutable_dirnode({}))
 152         def _created_empty(dn):
 153             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 154             self.failIf(dn.is_mutable())
 155             self.failUnless(dn.is_readonly())
 156             rep = str(dn)
 157             self.failUnless("RO-IMM" in rep)
 158             cap = dn.get_cap()
 159             self.failUnlessIn("LIT", cap.to_string())
 160             self.failUnlessEqual(cap.to_string(), "URI:DIR2-LIT:")
 161             self.cap = cap
 162             return dn.list()
 163         d.addCallback(_created_empty)
 164         d.addCallback(lambda kids: self.failUnlessEqual(kids, {}))
 165         smallkids = {u"o": (nm.create_from_cap(one_uri), {})}
 166         d.addCallback(lambda ign: c.create_immutable_dirnode(smallkids))
 167         def _created_small(dn):
 168             self.failUnless(isinstance(dn, dirnode.DirectoryNode))
 169             self.failIf(dn.is_mutable())
 170             self.failUnless(dn.is_readonly())
 171             rep = str(dn)
 172             self.failUnless("RO-IMM" in rep)
 173             cap = dn.get_cap()
 174             self.failUnlessIn("LIT", cap.to_string())
 175             self.failUnlessEqual(cap.to_string(),
 176                                  "URI:DIR2-LIT:gi4tumj2n4wdcmz2kvjesosmjfkdu3rvpbtwwlbqhiwdeot3puwcy")
 177             self.cap = cap
 178             return dn.list()
 179         d.addCallback(_created_small)
 180         d.addCallback(lambda kids: self.failUnlessEqual(kids.keys(), [u"o"]))
 181
 182         # now test n.create_subdirectory(mutable=False)
 183         d.addCallback(lambda ign: c.create_dirnode())
 184         def _made_parent(n):
 185             d = n.create_subdirectory(u"subdir", kids, mutable=False)
 186             d.addCallback(lambda sd: sd.list())
 187             d.addCallback(_check_kids)
 188             d.addCallback(lambda ign: n.list())
 189             d.addCallback(lambda children:
 190                           self.failUnlessEqual(children.keys(), [u"subdir"]))
 191             d.addCallback(lambda ign: n.get(u"subdir"))
 192             d.addCallback(lambda sd: sd.list())
 193             d.addCallback(_check_kids)
 194             d.addCallback(lambda ign: n.get(u"subdir"))
 195             d.addCallback(lambda sd: self.failIf(sd.is_mutable()))
 196             bad_kids = {u"one": (nm.create_from_cap(mut_writecap), {})}
 197             d.addCallback(lambda ign:
 198                           self.shouldFail(NotDeepImmutableError, "YZ",
 199                                           "is not immutable",
 200                                           n.create_subdirectory,
 201                                           u"sub2", bad_kids, mutable=False))
 202             return d
 203         d.addCallback(_made_parent)
 204         return d
 205
 206
 207     def test_check(self):
 208         self.basedir = "dirnode/Dirnode/test_check"
 209         self.set_up_grid()
 210         c = self.g.clients[0]
 211         d = c.create_dirnode()
 212         d.addCallback(lambda dn: dn.check(Monitor()))
 213         def _done(res):
 214             self.failUnless(res.is_healthy())
 215         d.addCallback(_done)
 216         return d
 217
 218     def _test_deepcheck_create(self):
 219         # create a small tree with a loop, and some non-directories
 220         #  root/
 221         #  root/subdir/
 222         #  root/subdir/file1
 223         #  root/subdir/link -> root
 224         #  root/rodir
 225         c = self.g.clients[0]
 226         d = c.create_dirnode()
 227         def _created_root(rootnode):
 228             self._rootnode = rootnode
 229             return rootnode.create_subdirectory(u"subdir")
 230         d.addCallback(_created_root)
 231         def _created_subdir(subdir):
 232             self._subdir = subdir
 233             d = subdir.add_file(u"file1", upload.Data("data"*100, None))
 234             d.addCallback(lambda res: subdir.set_node(u"link", self._rootnode))
 235             d.addCallback(lambda res: c.create_dirnode())
 236             d.addCallback(lambda dn:
 237                           self._rootnode.set_uri(u"rodir",
 238                                                  dn.get_uri(),
 239                                                  dn.get_readonly_uri()))
 240             return d
 241         d.addCallback(_created_subdir)
 242         def _done(res):
 243             return self._rootnode
 244         d.addCallback(_done)
 245         return d
 246
 247     def test_deepcheck(self):
 248         self.basedir = "dirnode/Dirnode/test_deepcheck"
 249         self.set_up_grid()
 250         d = self._test_deepcheck_create()
 251         d.addCallback(lambda rootnode: rootnode.start_deep_check().when_done())
 252         def _check_results(r):
 253             self.failUnless(IDeepCheckResults.providedBy(r))
 254             c = r.get_counters()
 255             self.failUnlessEqual(c,
 256                                  {"count-objects-checked": 4,
 257                                   "count-objects-healthy": 4,
 258                                   "count-objects-unhealthy": 0,
 259                                   "count-objects-unrecoverable": 0,
 260                                   "count-corrupt-shares": 0,
 261                                   })
 262             self.failIf(r.get_corrupt_shares())
 263             self.failUnlessEqual(len(r.get_all_results()), 4)
 264         d.addCallback(_check_results)
 265         return d
 266
 267     def test_deepcheck_and_repair(self):
 268         self.basedir = "dirnode/Dirnode/test_deepcheck_and_repair"
 269         self.set_up_grid()
 270         d = self._test_deepcheck_create()
 271         d.addCallback(lambda rootnode:
 272                       rootnode.start_deep_check_and_repair().when_done())
 273         def _check_results(r):
 274             self.failUnless(IDeepCheckAndRepairResults.providedBy(r))
 275             c = r.get_counters()
 276             self.failUnlessEqual(c,
 277                                  {"count-objects-checked": 4,
 278                                   "count-objects-healthy-pre-repair": 4,
 279                                   "count-objects-unhealthy-pre-repair": 0,
 280                                   "count-objects-unrecoverable-pre-repair": 0,
 281                                   "count-corrupt-shares-pre-repair": 0,
 282                                   "count-objects-healthy-post-repair": 4,
 283                                   "count-objects-unhealthy-post-repair": 0,
 284                                   "count-objects-unrecoverable-post-repair": 0,
 285                                   "count-corrupt-shares-post-repair": 0,
 286                                   "count-repairs-attempted": 0,
 287                                   "count-repairs-successful": 0,
 288                                   "count-repairs-unsuccessful": 0,
 289                                   })
 290             self.failIf(r.get_corrupt_shares())
 291             self.failIf(r.get_remaining_corrupt_shares())
 292             self.failUnlessEqual(len(r.get_all_results()), 4)
 293         d.addCallback(_check_results)
 294         return d
 295
 296     def _mark_file_bad(self, rootnode):
 297         self.delete_shares_numbered(rootnode.get_uri(), [0])
 298         return rootnode
 299
 300     def test_deepcheck_problems(self):
 301         self.basedir = "dirnode/Dirnode/test_deepcheck_problems"
 302         self.set_up_grid()
 303         d = self._test_deepcheck_create()
 304         d.addCallback(lambda rootnode: self._mark_file_bad(rootnode))
 305         d.addCallback(lambda rootnode: rootnode.start_deep_check().when_done())
 306         def _check_results(r):
 307             c = r.get_counters()
 308             self.failUnlessEqual(c,
 309                                  {"count-objects-checked": 4,
 310                                   "count-objects-healthy": 3,
 311                                   "count-objects-unhealthy": 1,
 312                                   "count-objects-unrecoverable": 0,
 313                                   "count-corrupt-shares": 0,
 314                                   })
 315             #self.failUnlessEqual(len(r.get_problems()), 1) # TODO
 316         d.addCallback(_check_results)
 317         return d
 318
 319     def test_readonly(self):
 320         self.basedir = "dirnode/Dirnode/test_readonly"
 321         self.set_up_grid()
 322         c = self.g.clients[0]
 323         nm = c.nodemaker
 324         filecap = make_chk_file_uri(1234)
 325         filenode = nm.create_from_cap(filecap)
 326         uploadable = upload.Data("some data", convergence="some convergence string")
 327
 328         d = c.create_dirnode()
 329         def _created(rw_dn):
 330             d2 = rw_dn.set_uri(u"child", filecap, filecap)
 331             d2.addCallback(lambda res: rw_dn)
 332             return d2
 333         d.addCallback(_created)
 334
 335         def _ready(rw_dn):
 336             ro_uri = rw_dn.get_readonly_uri()
 337             ro_dn = c.create_node_from_uri(ro_uri)
 338             self.failUnless(ro_dn.is_readonly())
 339             self.failUnless(ro_dn.is_mutable())
 340
 341             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 342                             ro_dn.set_uri, u"newchild", filecap, filecap)
 343             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 344                             ro_dn.set_node, u"newchild", filenode)
 345             self.shouldFail(dirnode.NotMutableError, "set_nodes ro", None,
 346                             ro_dn.set_nodes, { u"newchild": (filenode, None) })
 347             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 348                             ro_dn.add_file, u"newchild", uploadable)
 349             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 350                             ro_dn.delete, u"child")
 351             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 352                             ro_dn.create_subdirectory, u"newchild")
 353             self.shouldFail(dirnode.NotMutableError, "set_metadata_for ro", None,
 354                             ro_dn.set_metadata_for, u"child", {})
 355             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 356                             ro_dn.move_child_to, u"child", rw_dn)
 357             self.shouldFail(dirnode.NotMutableError, "set_uri ro", None,
 358                             rw_dn.move_child_to, u"child", ro_dn)
 359             return ro_dn.list()
 360         d.addCallback(_ready)
 361         def _listed(children):
 362             self.failUnless(u"child" in children)
 363         d.addCallback(_listed)
 364         return d
 365
 366     def failUnlessGreaterThan(self, a, b):
 367         self.failUnless(a > b, "%r should be > %r" % (a, b))
 368
 369     def failUnlessGreaterOrEqualThan(self, a, b):
 370         self.failUnless(a >= b, "%r should be >= %r" % (a, b))
 371
 372     def test_create(self):
 373         self.basedir = "dirnode/Dirnode/test_create"
 374         self.set_up_grid()
 375         c = self.g.clients[0]
 376
 377         self.expected_manifest = []
 378         self.expected_verifycaps = set()
 379         self.expected_storage_indexes = set()
 380
 381         d = c.create_dirnode()
 382         def _then(n):
 383             # /
 384             self.rootnode = n
 385             self.failUnless(n.is_mutable())
 386             u = n.get_uri()
 387             self.failUnless(u)
 388             self.failUnless(u.startswith("URI:DIR2:"), u)
 389             u_ro = n.get_readonly_uri()
 390             self.failUnless(u_ro.startswith("URI:DIR2-RO:"), u_ro)
 391             u_v = n.get_verify_cap().to_string()
 392             self.failUnless(u_v.startswith("URI:DIR2-Verifier:"), u_v)
 393             u_r = n.get_repair_cap().to_string()
 394             self.failUnlessEqual(u_r, u)
 395             self.expected_manifest.append( ((), u) )
 396             self.expected_verifycaps.add(u_v)
 397             si = n.get_storage_index()
 398             self.expected_storage_indexes.add(base32.b2a(si))
 399             expected_si = n._uri._filenode_uri.storage_index
 400             self.failUnlessEqual(si, expected_si)
 401
 402             d = n.list()
 403             d.addCallback(lambda res: self.failUnlessEqual(res, {}))
 404             d.addCallback(lambda res: n.has_child(u"missing"))
 405             d.addCallback(lambda res: self.failIf(res))
 406
 407             fake_file_uri = make_mutable_file_uri()
 408             other_file_uri = make_mutable_file_uri()
 409             m = c.nodemaker.create_from_cap(fake_file_uri)
 410             ffu_v = m.get_verify_cap().to_string()
 411             self.expected_manifest.append( ((u"child",) , m.get_uri()) )
 412             self.expected_verifycaps.add(ffu_v)
 413             self.expected_storage_indexes.add(base32.b2a(m.get_storage_index()))
 414             d.addCallback(lambda res: n.set_uri(u"child",
 415                                                 fake_file_uri, fake_file_uri))
 416             d.addCallback(lambda res:
 417                           self.shouldFail(ExistingChildError, "set_uri-no",
 418                                           "child 'child' already exists",
 419                                           n.set_uri, u"child",
 420                                           other_file_uri, other_file_uri,
 421                                           overwrite=False))
 422             # /
 423             # /child = mutable
 424
 425             d.addCallback(lambda res: n.create_subdirectory(u"subdir"))
 426
 427             # /
 428             # /child = mutable
 429             # /subdir = directory
 430             def _created(subdir):
 431                 self.failUnless(isinstance(subdir, dirnode.DirectoryNode))
 432                 self.subdir = subdir
 433                 new_v = subdir.get_verify_cap().to_string()
 434                 assert isinstance(new_v, str)
 435                 self.expected_manifest.append( ((u"subdir",), subdir.get_uri()) )
 436                 self.expected_verifycaps.add(new_v)
 437                 si = subdir.get_storage_index()
 438                 self.expected_storage_indexes.add(base32.b2a(si))
 439             d.addCallback(_created)
 440
 441             d.addCallback(lambda res:
 442                           self.shouldFail(ExistingChildError, "mkdir-no",
 443                                           "child 'subdir' already exists",
 444                                           n.create_subdirectory, u"subdir",
 445                                           overwrite=False))
 446
 447             d.addCallback(lambda res: n.list())
 448             d.addCallback(lambda children:
 449                           self.failUnlessEqual(sorted(children.keys()),
 450                                                sorted([u"child", u"subdir"])))
 451
 452             d.addCallback(lambda res: n.start_deep_stats().when_done())
 453             def _check_deepstats(stats):
 454                 self.failUnless(isinstance(stats, dict))
 455                 expected = {"count-immutable-files": 0,
 456                             "count-mutable-files": 1,
 457                             "count-literal-files": 0,
 458                             "count-files": 1,
 459                             "count-directories": 2,
 460                             "size-immutable-files": 0,
 461                             "size-literal-files": 0,
 462                             #"size-directories": 616, # varies
 463                             #"largest-directory": 616,
 464                             "largest-directory-children": 2,
 465                             "largest-immutable-file": 0,
 466                             }
 467                 for k,v in expected.iteritems():
 468                     self.failUnlessEqual(stats[k], v,
 469                                          "stats[%s] was %s, not %s" %
 470                                          (k, stats[k], v))
 471                 self.failUnless(stats["size-directories"] > 500,
 472                                 stats["size-directories"])
 473                 self.failUnless(stats["largest-directory"] > 500,
 474                                 stats["largest-directory"])
 475                 self.failUnlessEqual(stats["size-files-histogram"], [])
 476             d.addCallback(_check_deepstats)
 477
 478             d.addCallback(lambda res: n.build_manifest().when_done())
 479             def _check_manifest(res):
 480                 manifest = res["manifest"]
 481                 self.failUnlessEqual(sorted(manifest),
 482                                      sorted(self.expected_manifest))
 483                 stats = res["stats"]
 484                 _check_deepstats(stats)
 485                 self.failUnlessEqual(self.expected_verifycaps,
 486                                      res["verifycaps"])
 487                 self.failUnlessEqual(self.expected_storage_indexes,
 488                                      res["storage-index"])
 489             d.addCallback(_check_manifest)
 490
 491             def _add_subsubdir(res):
 492                 return self.subdir.create_subdirectory(u"subsubdir")
 493             d.addCallback(_add_subsubdir)
 494             # /
 495             # /child = mutable
 496             # /subdir = directory
 497             # /subdir/subsubdir = directory
 498             d.addCallback(lambda res: n.get_child_at_path(u"subdir/subsubdir"))
 499             d.addCallback(lambda subsubdir:
 500                           self.failUnless(isinstance(subsubdir,
 501                                                      dirnode.DirectoryNode)))
 502             d.addCallback(lambda res: n.get_child_at_path(u""))
 503             d.addCallback(lambda res: self.failUnlessEqual(res.get_uri(),
 504                                                            n.get_uri()))
 505
 506             d.addCallback(lambda res: n.get_metadata_for(u"child"))
 507             d.addCallback(lambda metadata:
 508                           self.failUnlessEqual(set(metadata.keys()),
 509                                                set(["tahoe", "ctime", "mtime"])))
 510
 511             d.addCallback(lambda res:
 512                           self.shouldFail(NoSuchChildError, "gcamap-no",
 513                                           "nope",
 514                                           n.get_child_and_metadata_at_path,
 515                                           u"subdir/nope"))
 516             d.addCallback(lambda res:
 517                           n.get_child_and_metadata_at_path(u""))
 518             def _check_child_and_metadata1(res):
 519                 child, metadata = res
 520                 self.failUnless(isinstance(child, dirnode.DirectoryNode))
 521                 # edge-metadata needs at least one path segment
 522                 self.failUnlessEqual(sorted(metadata.keys()), [])
 523             d.addCallback(_check_child_and_metadata1)
 524             d.addCallback(lambda res:
 525                           n.get_child_and_metadata_at_path(u"child"))
 526
 527             def _check_child_and_metadata2(res):
 528                 child, metadata = res
 529                 self.failUnlessEqual(child.get_uri(),
 530                                      fake_file_uri)
 531                 self.failUnlessEqual(set(metadata.keys()),
 532                                      set(["tahoe", "ctime", "mtime"]))
 533             d.addCallback(_check_child_and_metadata2)
 534
 535             d.addCallback(lambda res:
 536                           n.get_child_and_metadata_at_path(u"subdir/subsubdir"))
 537             def _check_child_and_metadata3(res):
 538                 child, metadata = res
 539                 self.failUnless(isinstance(child, dirnode.DirectoryNode))
 540                 self.failUnlessEqual(set(metadata.keys()),
 541                                      set(["tahoe", "ctime", "mtime"]))
 542             d.addCallback(_check_child_and_metadata3)
 543
 544             # set_uri + metadata
 545             # it should be possible to add a child without any metadata
 546             d.addCallback(lambda res: n.set_uri(u"c2",
 547                                                 fake_file_uri, fake_file_uri,
 548                                                 {}))
 549             d.addCallback(lambda res: n.get_metadata_for(u"c2"))
 550             d.addCallback(lambda metadata: self.failUnlessEqual(metadata.keys(), ['tahoe']))
 551
 552             # You can't override the link timestamps.
 553             d.addCallback(lambda res: n.set_uri(u"c2",
 554                                                 fake_file_uri, fake_file_uri,
 555                                                 { 'tahoe': {'linkcrtime': "bogus"}}))
 556             d.addCallback(lambda res: n.get_metadata_for(u"c2"))
 557             def _has_good_linkcrtime(metadata):
 558                 self.failUnless(metadata.has_key('tahoe'))
 559                 self.failUnless(metadata['tahoe'].has_key('linkcrtime'))
 560                 self.failIfEqual(metadata['tahoe']['linkcrtime'], 'bogus')
 561             d.addCallback(_has_good_linkcrtime)
 562
 563             # if we don't set any defaults, the child should get timestamps
 564             d.addCallback(lambda res: n.set_uri(u"c3",
 565                                                 fake_file_uri, fake_file_uri))
 566             d.addCallback(lambda res: n.get_metadata_for(u"c3"))
 567             d.addCallback(lambda metadata:
 568                           self.failUnlessEqual(set(metadata.keys()),
 569                                                set(["tahoe", "ctime", "mtime"])))
 570
 571             # or we can add specific metadata at set_uri() time, which
 572             # overrides the timestamps
 573             d.addCallback(lambda res: n.set_uri(u"c4",
 574                                                 fake_file_uri, fake_file_uri,
 575                                                 {"key": "value"}))
 576             d.addCallback(lambda res: n.get_metadata_for(u"c4"))
 577             d.addCallback(lambda metadata:
 578                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 579                                               (metadata['key'] == "value"), metadata))
 580
 581             d.addCallback(lambda res: n.delete(u"c2"))
 582             d.addCallback(lambda res: n.delete(u"c3"))
 583             d.addCallback(lambda res: n.delete(u"c4"))
 584
 585             # set_node + metadata
 586             # it should be possible to add a child without any metadata
 587             d.addCallback(lambda res: n.set_node(u"d2", n, {}))
 588             d.addCallback(lambda res: c.create_dirnode())
 589             d.addCallback(lambda n2:
 590                           self.shouldFail(ExistingChildError, "set_node-no",
 591                                           "child 'd2' already exists",
 592                                           n.set_node, u"d2", n2,
 593                                           overwrite=False))
 594             d.addCallback(lambda res: n.get_metadata_for(u"d2"))
 595             d.addCallback(lambda metadata: self.failUnlessEqual(metadata.keys(), ['tahoe']))
 596
 597             # if we don't set any defaults, the child should get timestamps
 598             d.addCallback(lambda res: n.set_node(u"d3", n))
 599             d.addCallback(lambda res: n.get_metadata_for(u"d3"))
 600             d.addCallback(lambda metadata:
 601                           self.failUnlessEqual(set(metadata.keys()),
 602                                                set(["tahoe", "ctime", "mtime"])))
 603
 604             # or we can add specific metadata at set_node() time, which
 605             # overrides the timestamps
 606             d.addCallback(lambda res: n.set_node(u"d4", n,
 607                                                 {"key": "value"}))
 608             d.addCallback(lambda res: n.get_metadata_for(u"d4"))
 609             d.addCallback(lambda metadata:
 610                           self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 611                                           (metadata['key'] == "value"), metadata))
 612
 613             d.addCallback(lambda res: n.delete(u"d2"))
 614             d.addCallback(lambda res: n.delete(u"d3"))
 615             d.addCallback(lambda res: n.delete(u"d4"))
 616
 617             # metadata through set_children()
 618             d.addCallback(lambda res:
 619                           n.set_children({
 620                               u"e1": (fake_file_uri, fake_file_uri),
 621                               u"e2": (fake_file_uri, fake_file_uri, {}),
 622                               u"e3": (fake_file_uri, fake_file_uri,
 623                                       {"key": "value"}),
 624                               }))
 625             d.addCallback(lambda n2: self.failUnlessIdentical(n2, n))
 626             d.addCallback(lambda res:
 627                           self.shouldFail(ExistingChildError, "set_children-no",
 628                                           "child 'e1' already exists",
 629                                           n.set_children,
 630                                           { u"e1": (other_file_uri,
 631                                                     other_file_uri),
 632                                             u"new": (other_file_uri,
 633                                                      other_file_uri),
 634                                             },
 635                                           overwrite=False))
 636             # and 'new' should not have been created
 637             d.addCallback(lambda res: n.list())
 638             d.addCallback(lambda children: self.failIf(u"new" in children))
 639             d.addCallback(lambda res: n.get_metadata_for(u"e1"))
 640             d.addCallback(lambda metadata:
 641                           self.failUnlessEqual(set(metadata.keys()),
 642                                                set(["tahoe", "ctime", "mtime"])))
 643             d.addCallback(lambda res: n.get_metadata_for(u"e2"))
 644             d.addCallback(lambda metadata:
 645                           self.failUnlessEqual(set(metadata.keys()), set(['tahoe'])))
 646             d.addCallback(lambda res: n.get_metadata_for(u"e3"))
 647             d.addCallback(lambda metadata:
 648                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"]))
 649                                               and (metadata['key'] == "value"), metadata))
 650
 651             d.addCallback(lambda res: n.delete(u"e1"))
 652             d.addCallback(lambda res: n.delete(u"e2"))
 653             d.addCallback(lambda res: n.delete(u"e3"))
 654
 655             # metadata through set_nodes()
 656             d.addCallback(lambda res:
 657                           n.set_nodes({ u"f1": (n, None),
 658                                         u"f2": (n, {}),
 659                                         u"f3": (n, {"key": "value"}),
 660                                         }))
 661             d.addCallback(lambda n2: self.failUnlessIdentical(n2, n))
 662             d.addCallback(lambda res:
 663                           self.shouldFail(ExistingChildError, "set_nodes-no",
 664                                           "child 'f1' already exists",
 665                                           n.set_nodes, { u"f1": (n, None),
 666                                                          u"new": (n, None), },
 667                                           overwrite=False))
 668             # and 'new' should not have been created
 669             d.addCallback(lambda res: n.list())
 670             d.addCallback(lambda children: self.failIf(u"new" in children))
 671             d.addCallback(lambda res: n.get_metadata_for(u"f1"))
 672             d.addCallback(lambda metadata:
 673                           self.failUnlessEqual(set(metadata.keys()),
 674                                                set(["tahoe", "ctime", "mtime"])))
 675             d.addCallback(lambda res: n.get_metadata_for(u"f2"))
 676             d.addCallback(
 677                 lambda metadata: self.failUnlessEqual(set(metadata.keys()), set(['tahoe'])))
 678             d.addCallback(lambda res: n.get_metadata_for(u"f3"))
 679             d.addCallback(lambda metadata:
 680                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 681                                               (metadata['key'] == "value"), metadata))
 682
 683             d.addCallback(lambda res: n.delete(u"f1"))
 684             d.addCallback(lambda res: n.delete(u"f2"))
 685             d.addCallback(lambda res: n.delete(u"f3"))
 686
 687
 688             d.addCallback(lambda res:
 689                           n.set_metadata_for(u"child",
 690                                              {"tags": ["web2.0-compatible"]}))
 691             d.addCallback(lambda n1: n1.get_metadata_for(u"child"))
 692             d.addCallback(lambda metadata:
 693                           self.failUnlessEqual(metadata,
 694                                                {"tags": ["web2.0-compatible"]}))
 695
 696             def _start(res):
 697                 self._start_timestamp = time.time()
 698             d.addCallback(_start)
 699             # simplejson-1.7.1 (as shipped on Ubuntu 'gutsy') rounds all
 700             # floats to hundredeths (it uses str(num) instead of repr(num)).
 701             # simplejson-1.7.3 does not have this bug. To prevent this bug
 702             # from causing the test to fail, stall for more than a few
 703             # hundrededths of a second.
 704             d.addCallback(self.stall, 0.1)
 705             d.addCallback(lambda res: n.add_file(u"timestamps",
 706                                                  upload.Data("stamp me", convergence="some convergence string")))
 707             d.addCallback(self.stall, 0.1)
 708             def _stop(res):
 709                 self._stop_timestamp = time.time()
 710             d.addCallback(_stop)
 711
 712             d.addCallback(lambda res: n.get_metadata_for(u"timestamps"))
 713             def _check_timestamp1(metadata):
 714                 self.failUnless("ctime" in metadata)
 715                 self.failUnless("mtime" in metadata)
 716                 self.failUnlessGreaterOrEqualThan(metadata["ctime"],
 717                                                   self._start_timestamp)
 718                 self.failUnlessGreaterOrEqualThan(self._stop_timestamp,
 719                                                   metadata["ctime"])
 720                 self.failUnlessGreaterOrEqualThan(metadata["mtime"],
 721                                                   self._start_timestamp)
 722                 self.failUnlessGreaterOrEqualThan(self._stop_timestamp,
 723                                                   metadata["mtime"])
 724                 # Our current timestamp rules say that replacing an existing
 725                 # child should preserve the 'ctime' but update the mtime
 726                 self._old_ctime = metadata["ctime"]
 727                 self._old_mtime = metadata["mtime"]
 728             d.addCallback(_check_timestamp1)
 729             d.addCallback(self.stall, 2.0) # accomodate low-res timestamps
 730             d.addCallback(lambda res: n.set_node(u"timestamps", n))
 731             d.addCallback(lambda res: n.get_metadata_for(u"timestamps"))
 732             def _check_timestamp2(metadata):
 733                 self.failUnlessEqual(metadata["ctime"], self._old_ctime,
 734                                      "%s != %s" % (metadata["ctime"],
 735                                                    self._old_ctime))
 736                 self.failUnlessGreaterThan(metadata["mtime"], self._old_mtime)
 737                 return n.delete(u"timestamps")
 738             d.addCallback(_check_timestamp2)
 739
 740             # also make sure we can add/update timestamps on a
 741             # previously-existing child that didn't have any, since there are
 742             # a lot of 0.7.0-generated edges around out there
 743             d.addCallback(lambda res: n.set_node(u"no_timestamps", n, {}))
 744             d.addCallback(lambda res: n.set_node(u"no_timestamps", n))
 745             d.addCallback(lambda res: n.get_metadata_for(u"no_timestamps"))
 746             d.addCallback(lambda metadata:
 747                           self.failUnlessEqual(set(metadata.keys()),
 748                                                set(["tahoe", "ctime", "mtime"])))
 749             d.addCallback(lambda res: n.delete(u"no_timestamps"))
 750
 751             d.addCallback(lambda res: n.delete(u"subdir"))
 752             d.addCallback(lambda old_child:
 753                           self.failUnlessEqual(old_child.get_uri(),
 754                                                self.subdir.get_uri()))
 755
 756             d.addCallback(lambda res: n.list())
 757             d.addCallback(lambda children:
 758                           self.failUnlessEqual(sorted(children.keys()),
 759                                                sorted([u"child"])))
 760
 761             uploadable1 = upload.Data("some data", convergence="converge")
 762             d.addCallback(lambda res: n.add_file(u"newfile", uploadable1))
 763             d.addCallback(lambda newnode:
 764                           self.failUnless(IImmutableFileNode.providedBy(newnode)))
 765             uploadable2 = upload.Data("some data", convergence="stuff")
 766             d.addCallback(lambda res:
 767                           self.shouldFail(ExistingChildError, "add_file-no",
 768                                           "child 'newfile' already exists",
 769                                           n.add_file, u"newfile",
 770                                           uploadable2,
 771                                           overwrite=False))
 772             d.addCallback(lambda res: n.list())
 773             d.addCallback(lambda children:
 774                           self.failUnlessEqual(sorted(children.keys()),
 775                                                sorted([u"child", u"newfile"])))
 776             d.addCallback(lambda res: n.get_metadata_for(u"newfile"))
 777             d.addCallback(lambda metadata:
 778                           self.failUnlessEqual(set(metadata.keys()),
 779                                                set(["tahoe", "ctime", "mtime"])))
 780
 781             uploadable3 = upload.Data("some data", convergence="converge")
 782             d.addCallback(lambda res: n.add_file(u"newfile-metadata",
 783                                                  uploadable3,
 784                                                  {"key": "value"}))
 785             d.addCallback(lambda newnode:
 786                           self.failUnless(IImmutableFileNode.providedBy(newnode)))
 787             d.addCallback(lambda res: n.get_metadata_for(u"newfile-metadata"))
 788             d.addCallback(lambda metadata:
 789                               self.failUnless((set(metadata.keys()) == set(["key", "tahoe"])) and
 790                                               (metadata['key'] == "value"), metadata))
 791             d.addCallback(lambda res: n.delete(u"newfile-metadata"))
 792
 793             d.addCallback(lambda res: n.create_subdirectory(u"subdir2"))
 794             def _created2(subdir2):
 795                 self.subdir2 = subdir2
 796                 # put something in the way, to make sure it gets overwritten
 797                 return subdir2.add_file(u"child", upload.Data("overwrite me",
 798                                                               "converge"))
 799             d.addCallback(_created2)
 800
 801             d.addCallback(lambda res:
 802                           n.move_child_to(u"child", self.subdir2))
 803             d.addCallback(lambda res: n.list())
 804             d.addCallback(lambda children:
 805                           self.failUnlessEqual(sorted(children.keys()),
 806                                                sorted([u"newfile", u"subdir2"])))
 807             d.addCallback(lambda res: self.subdir2.list())
 808             d.addCallback(lambda children:
 809                           self.failUnlessEqual(sorted(children.keys()),
 810                                                sorted([u"child"])))
 811             d.addCallback(lambda res: self.subdir2.get(u"child"))
 812             d.addCallback(lambda child:
 813                           self.failUnlessEqual(child.get_uri(),
 814                                                fake_file_uri))
 815
 816             # move it back, using new_child_name=
 817             d.addCallback(lambda res:
 818                           self.subdir2.move_child_to(u"child", n, u"newchild"))
 819             d.addCallback(lambda res: n.list())
 820             d.addCallback(lambda children:
 821                           self.failUnlessEqual(sorted(children.keys()),
 822                                                sorted([u"newchild", u"newfile",
 823                                                        u"subdir2"])))
 824             d.addCallback(lambda res: self.subdir2.list())
 825             d.addCallback(lambda children:
 826                           self.failUnlessEqual(sorted(children.keys()), []))
 827
 828             # now make sure that we honor overwrite=False
 829             d.addCallback(lambda res:
 830                           self.subdir2.set_uri(u"newchild",
 831                                                other_file_uri, other_file_uri))
 832
 833             d.addCallback(lambda res:
 834                           self.shouldFail(ExistingChildError, "move_child_to-no",
 835                                           "child 'newchild' already exists",
 836                                           n.move_child_to, u"newchild",
 837                                           self.subdir2,
 838                                           overwrite=False))
 839             d.addCallback(lambda res: self.subdir2.get(u"newchild"))
 840             d.addCallback(lambda child:
 841                           self.failUnlessEqual(child.get_uri(),
 842                                                other_file_uri))
 843
 844             return d
 845
 846         d.addCallback(_then)
 847
 848         d.addErrback(self.explain_error)
 849         return d
 850
 851     def test_create_subdirectory(self):
 852         self.basedir = "dirnode/Dirnode/test_create_subdirectory"
 853         self.set_up_grid()
 854         c = self.g.clients[0]
 855         nm = c.nodemaker
 856
 857         d = c.create_dirnode()
 858         def _then(n):
 859             # /
 860             self.rootnode = n
 861             fake_file_uri = make_mutable_file_uri()
 862             other_file_uri = make_mutable_file_uri()
 863             md = {"metakey": "metavalue"}
 864             kids = {u"kid1": (nm.create_from_cap(fake_file_uri), {}),
 865                     u"kid2": (nm.create_from_cap(other_file_uri), md),
 866                     }
 867             d = n.create_subdirectory(u"subdir", kids)
 868             def _check(sub):
 869                 d = n.get_child_at_path(u"subdir")
 870                 d.addCallback(lambda sub2: self.failUnlessEqual(sub2.get_uri(),
 871                                                                 sub.get_uri()))
 872                 d.addCallback(lambda ign: sub.list())
 873                 return d
 874             d.addCallback(_check)
 875             def _check_kids(kids2):
 876                 self.failUnlessEqual(sorted(kids.keys()), sorted(kids2.keys()))
 877                 self.failUnlessEqual(kids2[u"kid2"][1]["metakey"], "metavalue")
 878             d.addCallback(_check_kids)
 879             return d
 880         d.addCallback(_then)
 881         return d
 882
 883 class MinimalFakeMutableFile:
 884     def get_writekey(self):
 885         return "writekey"
 886
 887 class Packing(unittest.TestCase):
 888     # This is a base32-encoded representation of the directory tree
 889     # root/file1
 890     # root/file2
 891     # root/file3
 892     # as represented after being fed to _pack_contents.
 893     # We have it here so we can decode it, feed it to
 894     # _unpack_contents, and verify that _unpack_contents
 895     # works correctly.
 896
 897     known_tree = "GM4TOORVHJTGS3DFGEWDSNJ2KVJESOSDJBFTU33MPB2GS3LZNVYG6N3GGI3WU5TIORTXC3DOMJ2G4NB2MVWXUZDONBVTE5LNGRZWK2LYN55GY23XGNYXQMTOMZUWU5TENN4DG23ZG5UTO2L2NQ2DO6LFMRWDMZJWGRQTUMZ2GEYDUMJQFQYTIMZ22XZKZORX5XS7CAQCSK3URR6QOHISHRCMGER5LRFSZRNAS5ZSALCS6TWFQAE754IVOIKJVK73WZPP3VUUEDTX3WHTBBZ5YX3CEKHCPG3ZWQLYA4QM6LDRCF7TJQYWLIZHKGN5ROA3AUZPXESBNLQQ6JTC2DBJU2D47IZJTLR3PKZ4RVF57XLPWY7FX7SZV3T6IJ3ORFW37FXUPGOE3ROPFNUX5DCGMAQJ3PGGULBRGM3TU6ZCMN2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGI3TKNRWGEWCAITUMFUG6ZJCHIQHWITMNFXGW3LPORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBSG42TMNRRFQQCE3DJNZVWG4TUNFWWKIR2EAYTENBWGY3DGOBZG4XDIMRXGU3DMML5FQQCE3LUNFWWKIR2EAYTENBWGY3DGOBZG4XDIMRXGU3DMML5FQWDGOJRHI2TUZTJNRSTELBZGQ5FKUSJHJBUQSZ2MFYGKZ3SOBSWQ43IO52WO23CNAZWU3DUGVSWSNTIOE5DK33POVTW4ZLNMNWDK6DHPA2GS2THNF2W25DEN5VGY2LQNFRGG5DKNNRHO5TZPFTWI6LNMRYGQ2LCGJTHM4J2GM5DCMB2GQWDCNBSHKVVQBGRYMACKJ27CVQ6O6B4QPR72RFVTGOZUI76XUSWAX73JRV5PYRHMIFYZIA25MXDPGUGML6M2NMRSG4YD4W4K37ZDYSXHMJ3IUVT4F64YTQQVBJFFFOUC7J7LAB2VFCL5UKKGMR2D3F4EPOYC7UYWQZNR5KXHBSNXLCNBX2SNF22DCXJIHSMEKWEWOG5XCJEVVZ7UW5IB6I64XXQSJ34B5CAYZGZIIMR6LBRGMZTU6ZCMN2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMYDEMJYFQQCE5DBNBXWKIR2EB5SE3DJNZVW233UNFWWKIR2EAYTENBWGY3DGOBZG4XDIMZQGIYTQLBAEJWGS3TLMNZHI2LNMURDUIBRGI2DMNRWGM4DSNZOGQZTAMRRHB6SYIBCNV2GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMYDEMJYPUWCYMZZGU5DKOTGNFWGKMZMHE2DUVKSJE5EGSCLHJRW25DDPBYTO2DXPB3GM6DBNYZTI6LJMV3DM2LWNB4TU4LWMNSWW3LKORXWK5DEMN3TI23NNE3WEM3SORRGY5THPA3TKNBUMNZG453BOF2GSZLXMVWWI3DJOFZW623RHIZTUMJQHI2SYMJUGI5BOSHWDPG3WKPAVXCF3XMKA7QVIWPRMWJHDTQHD27AHDCPJWDQENQ5H5ZZILTXQNIXXCIW4LKQABU2GCFRG5FHQN7CHD7HF4EKNRZFIV2ZYQIBM7IQU7F4RGB3XCX3FREPBKQ7UCICHVWPCYFGA6OLH3J45LXQ6GWWICJ3PGWJNLZ7PCRNLAPNYUGU6BENS7OXMBEOOFRIZV3PF2FFWZ5WHDPKXERYP7GNHKRMGEZTOOT3EJRXI2LNMURDUIBRGI2DMNRWGM4DSNZOGQZTGNRSGY4SYIBCORQWQ33FEI5CA6ZCNRUW423NN52GS3LFEI5CAMJSGQ3DMNRTHA4TOLRUGMZTMMRWHEWCAITMNFXGWY3SORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBTGM3DENRZPUWCAITNORUW2ZJCHIQDCMRUGY3DMMZYHE3S4NBTGM3DENRZPUWCY==="
 898
 899     def test_unpack_and_pack_behavior(self):
 900         known_tree = b32decode(self.known_tree)
 901         nodemaker = NodeMaker(None, None, None,
 902                               None, None, None,
 903                               {"k": 3, "n": 10}, None)
 904         writecap = "URI:SSK-RO:e3mdrzfwhoq42hy5ubcz6rp3o4:ybyibhnp3vvwuq2vaw2ckjmesgkklfs6ghxleztqidihjyofgw7q"
 905         filenode = nodemaker.create_from_cap(writecap)
 906         node = dirnode.DirectoryNode(filenode, nodemaker, None)
 907         children = node._unpack_contents(known_tree)
 908         self._check_children(children)
 909
 910         packed_children = node._pack_contents(children)
 911         children = node._unpack_contents(packed_children)
 912         self._check_children(children)
 913
 914     def _check_children(self, children):
 915         # Are all the expected child nodes there?
 916         self.failUnless(children.has_key(u'file1'))
 917         self.failUnless(children.has_key(u'file2'))
 918         self.failUnless(children.has_key(u'file3'))
 919
 920         # Are the metadata for child 3 right?
 921         file3_rocap = "URI:CHK:cmtcxq7hwxvfxan34yiev6ivhy:qvcekmjtoetdcw4kmi7b3rtblvgx7544crnwaqtiewemdliqsokq:3:10:5"
 922         file3_rwcap = "URI:CHK:cmtcxq7hwxvfxan34yiev6ivhy:qvcekmjtoetdcw4kmi7b3rtblvgx7544crnwaqtiewemdliqsokq:3:10:5"
 923         file3_metadata = {'ctime': 1246663897.4336269, 'tahoe': {'linkmotime': 1246663897.4336269, 'linkcrtime': 1246663897.4336269}, 'mtime': 1246663897.4336269}
 924         self.failUnlessEqual(file3_metadata, children[u'file3'][1])
 925         self.failUnlessEqual(file3_rocap,
 926                              children[u'file3'][0].get_readonly_uri())
 927         self.failUnlessEqual(file3_rwcap,
 928                              children[u'file3'][0].get_uri())
 929
 930         # Are the metadata for child 2 right?
 931         file2_rocap = "URI:CHK:apegrpehshwugkbh3jlt5ei6hq:5oougnemcl5xgx4ijgiumtdojlipibctjkbwvyygdymdphib2fvq:3:10:4"
 932         file2_rwcap = "URI:CHK:apegrpehshwugkbh3jlt5ei6hq:5oougnemcl5xgx4ijgiumtdojlipibctjkbwvyygdymdphib2fvq:3:10:4"
 933         file2_metadata = {'ctime': 1246663897.430218, 'tahoe': {'linkmotime': 1246663897.430218, 'linkcrtime': 1246663897.430218}, 'mtime': 1246663897.430218}
 934         self.failUnlessEqual(file2_metadata, children[u'file2'][1])
 935         self.failUnlessEqual(file2_rocap,
 936                              children[u'file2'][0].get_readonly_uri())
 937         self.failUnlessEqual(file2_rwcap,
 938                              children[u'file2'][0].get_uri())
 939
 940         # Are the metadata for child 1 right?
 941         file1_rocap = "URI:CHK:olxtimympo7f27jvhtgqlnbtn4:emzdnhk2um4seixozlkw3qx2nfijvdkx3ky7i7izl47yedl6e64a:3:10:10"
 942         file1_rwcap = "URI:CHK:olxtimympo7f27jvhtgqlnbtn4:emzdnhk2um4seixozlkw3qx2nfijvdkx3ky7i7izl47yedl6e64a:3:10:10"
 943         file1_metadata = {'ctime': 1246663897.4275661, 'tahoe': {'linkmotime': 1246663897.4275661, 'linkcrtime': 1246663897.4275661}, 'mtime': 1246663897.4275661}
 944         self.failUnlessEqual(file1_metadata, children[u'file1'][1])
 945         self.failUnlessEqual(file1_rocap,
 946                              children[u'file1'][0].get_readonly_uri())
 947         self.failUnlessEqual(file1_rwcap,
 948                              children[u'file1'][0].get_uri())
 949
 950     def _make_kids(self, nm, which):
 951         caps = {"imm": "URI:CHK:n7r3m6wmomelk4sep3kw5cvduq:os7ijw5c3maek7pg65e5254k2fzjflavtpejjyhshpsxuqzhcwwq:3:20:14861",
 952                 "lit": "URI:LIT:n5xgk", # LIT for "one"
 953                 "write": "URI:SSK:vfvcbdfbszyrsaxchgevhmmlii:euw4iw7bbnkrrwpzuburbhppuxhc3gwxv26f6imekhz7zyw2ojnq",
 954                 "read": "URI:SSK-RO:e3mdrzfwhoq42hy5ubcz6rp3o4:ybyibhnp3vvwuq2vaw2ckjmesgkklfs6ghxleztqidihjyofgw7q",
 955                 "dirwrite": "URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq",
 956                 "dirread":  "URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq",
 957                 }
 958         kids = {}
 959         for name in which:
 960             kids[unicode(name)] = (nm.create_from_cap(caps[name]), {})
 961         return kids
 962
 963     def test_deep_immutable(self):
 964         nm = NodeMaker(None, None, None, None, None, None, {"k": 3, "n": 10},
 965                        None)
 966         fn = MinimalFakeMutableFile()
 967
 968         kids = self._make_kids(nm, ["imm", "lit", "write", "read",
 969                                     "dirwrite", "dirread"])
 970         packed = dirnode.pack_children(fn, kids, deep_immutable=False)
 971         self.failUnlessIn("lit", packed)
 972
 973         kids = self._make_kids(nm, ["imm", "lit"])
 974         packed = dirnode.pack_children(fn, kids, deep_immutable=True)
 975         self.failUnlessIn("lit", packed)
 976
 977         kids = self._make_kids(nm, ["imm", "lit", "write"])
 978         self.failUnlessRaises(dirnode.MustBeDeepImmutable,
 979                               dirnode.pack_children,
 980                               fn, kids, deep_immutable=True)
 981
 982         # read-only is not enough: all children must be immutable
 983         kids = self._make_kids(nm, ["imm", "lit", "read"])
 984         self.failUnlessRaises(dirnode.MustBeDeepImmutable,
 985                               dirnode.pack_children,
 986                               fn, kids, deep_immutable=True)
 987
 988         kids = self._make_kids(nm, ["imm", "lit", "dirwrite"])
 989         self.failUnlessRaises(dirnode.MustBeDeepImmutable,
 990                               dirnode.pack_children,
 991                               fn, kids, deep_immutable=True)
 992
 993         kids = self._make_kids(nm, ["imm", "lit", "dirread"])
 994         self.failUnlessRaises(dirnode.MustBeDeepImmutable,
 995                               dirnode.pack_children,
 996                               fn, kids, deep_immutable=True)
 997
 998 class FakeMutableFile:
 999     implements(IMutableFileNode)
1000     counter = 0
1001     def __init__(self, initial_contents=""):
1002         self.data = self._get_initial_contents(initial_contents)
1003         counter = FakeMutableFile.counter
1004         FakeMutableFile.counter += 1
1005         writekey = hashutil.ssk_writekey_hash(str(counter))
1006         fingerprint = hashutil.ssk_pubkey_fingerprint_hash(str(counter))
1007         self.uri = uri.WriteableSSKFileURI(writekey, fingerprint)
1008
1009     def _get_initial_contents(self, contents):
1010         if isinstance(contents, str):
1011             return contents
1012         if contents is None:
1013             return ""
1014         assert callable(contents), "%s should be callable, not %s" % \
1015                (contents, type(contents))
1016         return contents(self)
1017
1018     def get_cap(self):
1019         return self.uri
1020     def get_uri(self):
1021         return self.uri.to_string()
1022     def download_best_version(self):
1023         return defer.succeed(self.data)
1024     def get_writekey(self):
1025         return "writekey"
1026     def is_readonly(self):
1027         return False
1028     def is_mutable(self):
1029         return True
1030     def modify(self, modifier):
1031         self.data = modifier(self.data, None, True)
1032         return defer.succeed(None)
1033
1034 class FakeNodeMaker(NodeMaker):
1035     def create_mutable_file(self, contents="", keysize=None):
1036         return defer.succeed(FakeMutableFile(contents))
1037
1038 class FakeClient2(Client):
1039     def __init__(self):
1040         self.nodemaker = FakeNodeMaker(None, None, None,
1041                                        None, None, None,
1042                                        {"k":3,"n":10}, None)
1043     def create_node_from_uri(self, rwcap, rocap):
1044         return self.nodemaker.create_from_cap(rwcap, rocap)
1045
1046 class Dirnode2(unittest.TestCase, testutil.ShouldFailMixin):
1047     def setUp(self):
1048         self.client = FakeClient2()
1049         self.nodemaker = self.client.nodemaker
1050
1051     def test_from_future(self):
1052         # create a dirnode that contains unknown URI types, and make sure we
1053         # tolerate them properly. Since dirnodes aren't allowed to add
1054         # unknown node types, we have to be tricky.
1055         d = self.nodemaker.create_new_mutable_directory()
1056         future_writecap = "x-tahoe-crazy://I_am_from_the_future."
1057         future_readcap = "x-tahoe-crazy-readonly://I_am_from_the_future."
1058         future_node = UnknownNode(future_writecap, future_readcap)
1059         def _then(n):
1060             self._node = n
1061             return n.set_node(u"future", future_node)
1062         d.addCallback(_then)
1063
1064         # we should be prohibited from adding an unknown URI to a directory,
1065         # since we don't know how to diminish the cap to a readcap (for the
1066         # dirnode's rocap slot), and we don't want to accidentally grant
1067         # write access to a holder of the dirnode's readcap.
1068         d.addCallback(lambda ign:
1069              self.shouldFail(CannotPackUnknownNodeError,
1070                              "copy unknown",
1071                              "cannot pack unknown node as child add",
1072                              self._node.set_uri, u"add",
1073                              future_writecap, future_readcap))
1074         d.addCallback(lambda ign: self._node.list())
1075         def _check(children):
1076             self.failUnlessEqual(len(children), 1)
1077             (fn, metadata) = children[u"future"]
1078             self.failUnless(isinstance(fn, UnknownNode), fn)
1079             self.failUnlessEqual(fn.get_uri(), future_writecap)
1080             self.failUnlessEqual(fn.get_readonly_uri(), future_readcap)
1081             # but we *should* be allowed to copy this node, because the
1082             # UnknownNode contains all the information that was in the
1083             # original directory (readcap and writecap), so we're preserving
1084             # everything.
1085             return self._node.set_node(u"copy", fn)
1086         d.addCallback(_check)
1087         d.addCallback(lambda ign: self._node.list())
1088         def _check2(children):
1089             self.failUnlessEqual(len(children), 2)
1090             (fn, metadata) = children[u"copy"]
1091             self.failUnless(isinstance(fn, UnknownNode), fn)
1092             self.failUnlessEqual(fn.get_uri(), future_writecap)
1093             self.failUnlessEqual(fn.get_readonly_uri(), future_readcap)
1094         return d
1095
1096 class DeepStats(unittest.TestCase):
1097     timeout = 240 # It takes longer than 120 seconds on Francois's arm box.
1098     def test_stats(self):
1099         ds = dirnode.DeepStats(None)
1100         ds.add("count-files")
1101         ds.add("size-immutable-files", 123)
1102         ds.histogram("size-files-histogram", 123)
1103         ds.max("largest-directory", 444)
1104
1105         s = ds.get_results()
1106         self.failUnlessEqual(s["count-files"], 1)
1107         self.failUnlessEqual(s["size-immutable-files"], 123)
1108         self.failUnlessEqual(s["largest-directory"], 444)
1109         self.failUnlessEqual(s["count-literal-files"], 0)
1110
1111         ds.add("count-files")
1112         ds.add("size-immutable-files", 321)
1113         ds.histogram("size-files-histogram", 321)
1114         ds.max("largest-directory", 2)
1115
1116         s = ds.get_results()
1117         self.failUnlessEqual(s["count-files"], 2)
1118         self.failUnlessEqual(s["size-immutable-files"], 444)
1119         self.failUnlessEqual(s["largest-directory"], 444)
1120         self.failUnlessEqual(s["count-literal-files"], 0)
1121         self.failUnlessEqual(s["size-files-histogram"],
1122                              [ (101, 316, 1), (317, 1000, 1) ])
1123
1124         ds = dirnode.DeepStats(None)
1125         for i in range(1, 1100):
1126             ds.histogram("size-files-histogram", i)
1127         ds.histogram("size-files-histogram", 4*1000*1000*1000*1000) # 4TB
1128         s = ds.get_results()
1129         self.failUnlessEqual(s["size-files-histogram"],
1130                              [ (1, 3, 3),
1131                                (4, 10, 7),
1132                                (11, 31, 21),
1133                                (32, 100, 69),
1134                                (101, 316, 216),
1135                                (317, 1000, 684),
1136                                (1001, 3162, 99),
1137                                (3162277660169L, 10000000000000L, 1),
1138                                ])
1139
1140 class UCWEingMutableFileNode(MutableFileNode):
1141     please_ucwe_after_next_upload = False
1142
1143     def _upload(self, new_contents, servermap):
1144         d = MutableFileNode._upload(self, new_contents, servermap)
1145         def _ucwe(res):
1146             if self.please_ucwe_after_next_upload:
1147                 self.please_ucwe_after_next_upload = False
1148                 raise UncoordinatedWriteError()
1149             return res
1150         d.addCallback(_ucwe)
1151         return d
1152
1153 class UCWEingNodeMaker(NodeMaker):
1154     def _create_mutable(self, cap):
1155         n = UCWEingMutableFileNode(self.storage_broker, self.secret_holder,
1156                                    self.default_encoding_parameters,
1157                                    self.history)
1158         return n.init_from_cap(cap)
1159
1160
1161 class Deleter(GridTestMixin, unittest.TestCase):
1162     timeout = 3600 # It takes longer than 433 seconds on Zandr's ARM box.
1163     def test_retry(self):
1164         # ticket #550, a dirnode.delete which experiences an
1165         # UncoordinatedWriteError will fail with an incorrect "you're
1166         # deleting something which isn't there" NoSuchChildError exception.
1167
1168         # to trigger this, we start by creating a directory with a single
1169         # file in it. Then we create a special dirnode that uses a modified
1170         # MutableFileNode which will raise UncoordinatedWriteError once on
1171         # demand. We then call dirnode.delete, which ought to retry and
1172         # succeed.
1173
1174         self.basedir = self.mktemp()
1175         self.set_up_grid()
1176         c0 = self.g.clients[0]
1177         d = c0.create_dirnode()
1178         small = upload.Data("Small enough for a LIT", None)
1179         def _created_dir(dn):
1180             self.root = dn
1181             self.root_uri = dn.get_uri()
1182             return dn.add_file(u"file", small)
1183         d.addCallback(_created_dir)
1184         def _do_delete(ignored):
1185             nm = UCWEingNodeMaker(c0.storage_broker, c0._secret_holder,
1186                                   c0.get_history(), c0.getServiceNamed("uploader"),
1187                                   c0.downloader,
1188                                   c0.download_cache_dirman,
1189                                   c0.get_encoding_parameters(),
1190                                   c0._key_generator)
1191             n = nm.create_from_cap(self.root_uri)
1192             assert n._node.please_ucwe_after_next_upload == False
1193             n._node.please_ucwe_after_next_upload = True
1194             # This should succeed, not raise an exception
1195             return n.delete(u"file")
1196         d.addCallback(_do_delete)
1197
1198         return d
1199
1200 class Adder(GridTestMixin, unittest.TestCase, testutil.ShouldFailMixin):
1201
1202     def test_overwrite(self):
1203         # note: This functionality could be tested without actually creating
1204         # several RSA keys. It would be faster without the GridTestMixin: use
1205         # dn.set_node(nodemaker.create_from_cap(make_chk_file_uri())) instead
1206         # of dn.add_file, and use a special NodeMaker that creates fake
1207         # mutable files.
1208         self.basedir = "dirnode/Adder/test_overwrite"
1209         self.set_up_grid()
1210         c = self.g.clients[0]
1211         fileuri = make_chk_file_uri(1234)
1212         filenode = c.nodemaker.create_from_cap(fileuri)
1213         d = c.create_dirnode()
1214
1215         def _create_directory_tree(root_node):
1216             # Build
1217             # root/file1
1218             # root/file2
1219             # root/dir1
1220             d = root_node.add_file(u'file1', upload.Data("Important Things",
1221                 None))
1222             d.addCallback(lambda res:
1223                 root_node.add_file(u'file2', upload.Data("Sekrit Codes", None)))
1224             d.addCallback(lambda res:
1225                 root_node.create_subdirectory(u"dir1"))
1226             d.addCallback(lambda res: root_node)
1227             return d
1228
1229         d.addCallback(_create_directory_tree)
1230
1231         def _test_adder(root_node):
1232             d = root_node.set_node(u'file1', filenode)
1233             # We've overwritten file1. Let's try it with a directory
1234             d.addCallback(lambda res:
1235                 root_node.create_subdirectory(u'dir2'))
1236             d.addCallback(lambda res:
1237                 root_node.set_node(u'dir2', filenode))
1238             # We try overwriting a file with a child while also specifying
1239             # overwrite=False. We should receive an ExistingChildError
1240             # when we do this.
1241             d.addCallback(lambda res:
1242                 self.shouldFail(ExistingChildError, "set_node",
1243                                 "child 'file1' already exists",
1244                                root_node.set_node, u"file1",
1245                                filenode, overwrite=False))
1246             # If we try with a directory, we should see the same thing
1247             d.addCallback(lambda res:
1248                 self.shouldFail(ExistingChildError, "set_node",
1249                                 "child 'dir1' already exists",
1250                                 root_node.set_node, u'dir1', filenode,
1251                                 overwrite=False))
1252             d.addCallback(lambda res:
1253                  root_node.set_node(u'file1', filenode,
1254                                     overwrite="only-files"))
1255             d.addCallback(lambda res:
1256                  self.shouldFail(ExistingChildError, "set_node",
1257                                 "child 'dir1' already exists",
1258                                 root_node.set_node, u'dir1', filenode,
1259                                 overwrite="only-files"))
1260             return d
1261
1262         d.addCallback(_test_adder)
1263         return d