src/allmydata/test/test_magic_folder.py

   1
   2 import os, sys
   3
   4 from twisted.trial import unittest
   5 from twisted.internet import defer, task
   6
   7 from allmydata.interfaces import IDirectoryNode
   8 from allmydata.util.assertutil import precondition
   9
  10 from allmydata.util import fake_inotify, fileutil
  11 from allmydata.util.encodingutil import get_filesystem_encoding, to_filepath
  12 from allmydata.util.consumer import download_to_data
  13 from allmydata.test.no_network import GridTestMixin
  14 from allmydata.test.common_util import ReallyEqualMixin, NonASCIIPathMixin
  15 from allmydata.test.common import ShouldFailMixin
  16 from .test_cli_magic_folder import MagicFolderCLITestMixin
  17
  18 from allmydata.frontends import magic_folder
  19 from allmydata.frontends.magic_folder import MagicFolder, Downloader, WriteFileMixin
  20 from allmydata import magicfolderdb, magicpath
  21 from allmydata.util.fileutil import abspath_expanduser_unicode
  22 from allmydata.immutable.upload import Data
  23
  24
  25 class MagicFolderTestMixin(MagicFolderCLITestMixin, ShouldFailMixin, ReallyEqualMixin, NonASCIIPathMixin):
  26     """
  27     These tests will be run both with a mock notifier, and (on platforms that support it)
  28     with the real INotify.
  29     """
  30
  31     def setUp(self):
  32         GridTestMixin.setUp(self)
  33         temp = self.mktemp()
  34         self.basedir = abspath_expanduser_unicode(temp.decode(get_filesystem_encoding()))
  35         self.magicfolder = None
  36         self.patch(Downloader, 'REMOTE_SCAN_INTERVAL', 0)
  37
  38     def _get_count(self, name, client=None):
  39         counters = (client or self.get_client()).stats_provider.get_stats()["counters"]
  40         return counters.get('magic_folder.%s' % (name,), 0)
  41
  42     def _createdb(self):
  43         dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.basedir)
  44         mdb = magicfolderdb.get_magicfolderdb(dbfile, create_version=(magicfolderdb.SCHEMA_v1, 1))
  45         self.failUnless(mdb, "unable to create magicfolderdb from %r" % (dbfile,))
  46         self.failUnlessEqual(mdb.VERSION, 1)
  47         return mdb
  48
  49     def _restart_client(self, ign):
  50         #print "_restart_client"
  51         d = self.restart_client()
  52         d.addCallback(self._wait_until_started)
  53         return d
  54
  55     def _wait_until_started(self, ign):
  56         #print "_wait_until_started"
  57         self.magicfolder = self.get_client().getServiceNamed('magic-folder')
  58         return self.magicfolder.ready()
  59
  60     def test_db_basic(self):
  61         fileutil.make_dirs(self.basedir)
  62         self._createdb()
  63
  64     def test_db_persistence(self):
  65         """Test that a file upload creates an entry in the database."""
  66
  67         fileutil.make_dirs(self.basedir)
  68         db = self._createdb()
  69
  70         relpath1 = u"myFile1"
  71         pathinfo = fileutil.PathInfo(isdir=False, isfile=True, islink=False,
  72                                      exists=True, size=1, mtime=123, ctime=456)
  73         db.did_upload_version(relpath1, 0, 'URI:LIT:1', 'URI:LIT:0', 0, pathinfo)
  74
  75         c = db.cursor
  76         c.execute("SELECT size, mtime, ctime"
  77                   " FROM local_files"
  78                   " WHERE path=?",
  79                   (relpath1,))
  80         row = c.fetchone()
  81         self.failUnlessEqual(row, (pathinfo.size, pathinfo.mtime, pathinfo.ctime))
  82
  83         # Second test uses db.is_new_file instead of SQL query directly
  84         # to confirm the previous upload entry in the db.
  85         relpath2 = u"myFile2"
  86         path2 = os.path.join(self.basedir, relpath2)
  87         fileutil.write(path2, "meow\n")
  88         pathinfo = fileutil.get_pathinfo(path2)
  89         db.did_upload_version(relpath2, 0, 'URI:LIT:2', 'URI:LIT:1', 0, pathinfo)
  90         self.failUnlessFalse(db.is_new_file(pathinfo, relpath2))
  91
  92         different_pathinfo = fileutil.PathInfo(isdir=False, isfile=True, islink=False,
  93                                                exists=True, size=0, mtime=pathinfo.mtime, ctime=pathinfo.ctime)
  94         self.failUnlessTrue(db.is_new_file(different_pathinfo, relpath2))
  95
  96     def test_magicfolder_start_service(self):
  97         self.set_up_grid()
  98
  99         self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
 100                                                     base=self.basedir)
 101         self.mkdir_nonascii(self.local_dir)
 102
 103         d = defer.succeed(None)
 104         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
 105
 106         d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
 107         d.addCallback(self._restart_client)
 108
 109         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 1))
 110         d.addBoth(self.cleanup)
 111         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
 112         return d
 113
 114     def test_move_tree(self):
 115         self.set_up_grid()
 116
 117         self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
 118                                                     base=self.basedir)
 119         self.mkdir_nonascii(self.local_dir)
 120
 121         empty_tree_name = self.unicode_or_fallback(u"empty_tr\u00EAe", u"empty_tree")
 122         empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.basedir)
 123         new_empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.local_dir)
 124
 125         small_tree_name = self.unicode_or_fallback(u"small_tr\u00EAe", u"empty_tree")
 126         small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.basedir)
 127         new_small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.local_dir)
 128
 129         d = self.create_invite_join_magic_folder(u"Alice", self.local_dir)
 130         d.addCallback(self._restart_client)
 131
 132         def _check_move_empty_tree(res):
 133             print "_check_move_empty_tree"
 134             uploaded_d = self.magicfolder.uploader.set_hook('processed')
 135             self.mkdir_nonascii(empty_tree_dir)
 136             os.rename(empty_tree_dir, new_empty_tree_dir)
 137             self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_TO)
 138
 139             return uploaded_d
 140         d.addCallback(_check_move_empty_tree)
 141         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 142         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 143         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 0))
 144         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 145         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 1))
 146
 147         def _check_move_small_tree(res):
 148             print "_check_move_small_tree"
 149             uploaded_d = self.magicfolder.uploader.set_hook('processed', ignore_count=1)
 150             self.mkdir_nonascii(small_tree_dir)
 151             what_path = abspath_expanduser_unicode(u"what", base=small_tree_dir)
 152             fileutil.write(what_path, "say when")
 153             os.rename(small_tree_dir, new_small_tree_dir)
 154             self.notify(to_filepath(new_small_tree_dir), self.inotify.IN_MOVED_TO)
 155
 156             return uploaded_d
 157         d.addCallback(_check_move_small_tree)
 158         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 159         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 3))
 160         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 1))
 161         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 162         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 163
 164         def _check_moved_tree_is_watched(res):
 165             print "_check_moved_tree_is_watched"
 166             uploaded_d = self.magicfolder.uploader.set_hook('processed')
 167             another_path = abspath_expanduser_unicode(u"another", base=new_small_tree_dir)
 168             fileutil.write(another_path, "file")
 169             self.notify(to_filepath(another_path), self.inotify.IN_CLOSE_WRITE)
 170
 171             return uploaded_d
 172         d.addCallback(_check_moved_tree_is_watched)
 173         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 174         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
 175         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
 176         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 177         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 178
 179         # Files that are moved out of the upload directory should no longer be watched.
 180         #def _move_dir_away(ign):
 181         #    os.rename(new_empty_tree_dir, empty_tree_dir)
 182         #    # Wuh? Why don't we get this event for the real test?
 183         #    #self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_FROM)
 184         #d.addCallback(_move_dir_away)
 185         #def create_file(val):
 186         #    test_file = abspath_expanduser_unicode(u"what", base=empty_tree_dir)
 187         #    fileutil.write(test_file, "meow")
 188         #    #self.notify(...)
 189         #    return
 190         #d.addCallback(create_file)
 191         #d.addCallback(lambda ign: time.sleep(1))  # XXX ICK
 192         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 193         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
 194         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
 195         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 196         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 197
 198         d.addBoth(self.cleanup)
 199         return d
 200
 201     def test_persistence(self):
 202         """
 203         Perform an upload of a given file and then stop the client.
 204         Start a new client and magic-folder service... and verify that the file is NOT uploaded
 205         a second time. This test is meant to test the database persistence along with
 206         the startup and shutdown code paths of the magic-folder service.
 207         """
 208         self.set_up_grid()
 209         self.local_dir = abspath_expanduser_unicode(u"test_persistence", base=self.basedir)
 210         self.mkdir_nonascii(self.local_dir)
 211         self.collective_dircap = ""
 212
 213         d = defer.succeed(None)
 214         d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
 215         d.addCallback(self._restart_client)
 216
 217         def create_test_file(filename):
 218             d2 = self.magicfolder.uploader.set_hook('processed')
 219             test_file = abspath_expanduser_unicode(filename, base=self.local_dir)
 220             fileutil.write(test_file, "meow %s" % filename)
 221             self.notify(to_filepath(test_file), self.inotify.IN_CLOSE_WRITE)
 222             return d2
 223         d.addCallback(lambda ign: create_test_file(u"what1"))
 224         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 225         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 226         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 227         d.addCallback(self.cleanup)
 228
 229         d.addCallback(self._restart_client)
 230         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 231         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 232         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 233         d.addCallback(lambda ign: create_test_file(u"what2"))
 234         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 235         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 2))
 236         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 237         d.addBoth(self.cleanup)
 238         return d
 239
 240     @defer.inlineCallbacks
 241     def test_delete(self):
 242         self.set_up_grid()
 243         self.local_dir = os.path.join(self.basedir, u"local_dir")
 244         self.mkdir_nonascii(self.local_dir)
 245
 246         yield self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
 247         yield self._restart_client(None)
 248
 249         try:
 250             # create a file
 251             up_proc = self.magicfolder.uploader.set_hook('processed')
 252             # down_proc = self.magicfolder.downloader.set_hook('processed')
 253             path = os.path.join(self.local_dir, u'foo')
 254             fileutil.write(path, 'foo\n')
 255             self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
 256             yield up_proc
 257             self.assertTrue(os.path.exists(path))
 258
 259             # the real test part: delete the file
 260             up_proc = self.magicfolder.uploader.set_hook('processed')
 261             os.unlink(path)
 262             self.notify(to_filepath(path), self.inotify.IN_DELETE)
 263             yield up_proc
 264             self.assertFalse(os.path.exists(path))
 265
 266             # ensure we still have a DB entry, and that the version is 1
 267             node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
 268             self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
 269             self.failUnlessEqual(metadata['version'], 1)
 270
 271         finally:
 272             yield self.cleanup(None)
 273
 274     @defer.inlineCallbacks
 275     def test_delete_and_restore(self):
 276         self.set_up_grid()
 277         self.local_dir = os.path.join(self.basedir, u"local_dir")
 278         self.mkdir_nonascii(self.local_dir)
 279
 280         yield self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
 281         yield self._restart_client(None)
 282
 283         try:
 284             # create a file
 285             up_proc = self.magicfolder.uploader.set_hook('processed')
 286             # down_proc = self.magicfolder.downloader.set_hook('processed')
 287             path = os.path.join(self.local_dir, u'foo')
 288             fileutil.write(path, 'foo\n')
 289             self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
 290             yield up_proc
 291             self.assertTrue(os.path.exists(path))
 292
 293             # delete the file
 294             up_proc = self.magicfolder.uploader.set_hook('processed')
 295             os.unlink(path)
 296             self.notify(to_filepath(path), self.inotify.IN_DELETE)
 297             yield up_proc
 298             self.assertFalse(os.path.exists(path))
 299
 300             # ensure we still have a DB entry, and that the version is 1
 301             node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
 302             self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
 303             self.failUnlessEqual(metadata['version'], 1)
 304
 305             # restore the file, with different contents
 306             up_proc = self.magicfolder.uploader.set_hook('processed')
 307             path = os.path.join(self.local_dir, u'foo')
 308             fileutil.write(path, 'bar\n')
 309             self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
 310             yield up_proc
 311
 312             # ensure we still have a DB entry, and that the version is 2
 313             node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
 314             self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
 315             self.failUnlessEqual(metadata['version'], 2)
 316
 317         finally:
 318             yield self.cleanup(None)
 319
 320
 321     @defer.inlineCallbacks
 322     def test_alice_delete_bob_restore(self):
 323         alice_clock = task.Clock()
 324         bob_clock = task.Clock()
 325         yield self.setup_alice_and_bob(alice_clock, bob_clock)
 326         alice_dir = self.alice_magicfolder.uploader._local_path_u
 327         bob_dir = self.bob_magicfolder.uploader._local_path_u
 328         alice_fname = os.path.join(alice_dir, 'blam')
 329         bob_fname = os.path.join(bob_dir, 'blam')
 330
 331         try:
 332             # alice creates a file, bob downloads it
 333             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 334             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 335
 336             fileutil.write(alice_fname, 'contents0\n')
 337             self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 338
 339             alice_clock.advance(0)
 340             yield alice_proc  # alice uploads
 341
 342             bob_clock.advance(0)
 343             yield bob_proc    # bob downloads
 344
 345             # check the state
 346             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 347             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
 348             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 349             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
 350             yield self.failUnlessReallyEqual(
 351                 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
 352                 0
 353             )
 354             yield self.failUnlessReallyEqual(
 355                 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
 356                 1
 357             )
 358
 359             print("BOB DELETE")
 360             # now bob deletes it (bob should upload, alice download)
 361             bob_proc = self.bob_magicfolder.uploader.set_hook('processed')
 362             alice_proc = self.alice_magicfolder.downloader.set_hook('processed')
 363             os.unlink(bob_fname)
 364             self.notify(to_filepath(bob_fname), self.inotify.IN_DELETE, magic=self.bob_magicfolder)
 365
 366             bob_clock.advance(0)
 367             yield bob_proc
 368             alice_clock.advance(0)
 369             yield alice_proc
 370
 371             # check versions
 372             node, metadata = yield self.alice_magicfolder.downloader._get_collective_latest_file(u'blam')
 373             self.assertTrue(metadata['deleted'])
 374             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 375             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
 376             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 377             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
 378
 379             print("ALICE RESTORE")
 380             # now alice restores it (alice should upload, bob download)
 381             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 382             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 383             fileutil.write(alice_fname, 'new contents\n')
 384             self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 385
 386             alice_clock.advance(0)
 387             yield alice_proc
 388             bob_clock.advance(0)
 389             yield bob_proc
 390
 391             # check versions
 392             node, metadata = yield self.alice_magicfolder.downloader._get_collective_latest_file(u'blam')
 393             self.assertTrue('deleted' not in metadata or not metadata['deleted'])
 394             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 2)
 395             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 2)
 396             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 2)
 397             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 2)
 398
 399         finally:
 400             # cleanup
 401             d0 = self.alice_magicfolder.finish()
 402             alice_clock.advance(0)
 403             yield d0
 404
 405             d1 = self.bob_magicfolder.finish()
 406             bob_clock.advance(0)
 407             yield d1
 408
 409     @defer.inlineCallbacks
 410     def test_alice_create_bob_update(self):
 411         alice_clock = task.Clock()
 412         bob_clock = task.Clock()
 413         yield self.setup_alice_and_bob(alice_clock, bob_clock)
 414         alice_dir = self.alice_magicfolder.uploader._local_path_u
 415         bob_dir = self.bob_magicfolder.uploader._local_path_u
 416         alice_fname = os.path.join(alice_dir, 'blam')
 417         bob_fname = os.path.join(bob_dir, 'blam')
 418
 419         try:
 420             # alice creates a file, bob downloads it
 421             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 422             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 423
 424             fileutil.write(alice_fname, 'contents0\n')
 425             self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 426
 427             alice_clock.advance(0)
 428             yield alice_proc  # alice uploads
 429
 430             bob_clock.advance(0)
 431             yield bob_proc    # bob downloads
 432
 433             # check the state
 434             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 435             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
 436             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 437             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
 438             yield self.failUnlessReallyEqual(
 439                 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
 440                 0
 441             )
 442             yield self.failUnlessReallyEqual(
 443                 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
 444                 1
 445             )
 446
 447             # now bob updates it (bob should upload, alice download)
 448             bob_proc = self.bob_magicfolder.uploader.set_hook('processed')
 449             alice_proc = self.alice_magicfolder.downloader.set_hook('processed')
 450             fileutil.write(bob_fname, 'bob wuz here\n')
 451             self.notify(to_filepath(bob_fname), self.inotify.IN_CLOSE_WRITE, magic=self.bob_magicfolder)
 452
 453             bob_clock.advance(0)
 454             yield bob_proc
 455             alice_clock.advance(0)
 456             yield alice_proc
 457
 458             # check the state
 459             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 460             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
 461             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 462             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
 463
 464         finally:
 465             # cleanup
 466             d0 = self.alice_magicfolder.finish()
 467             alice_clock.advance(0)
 468             yield d0
 469
 470             d1 = self.bob_magicfolder.finish()
 471             bob_clock.advance(0)
 472             yield d1
 473
 474     @defer.inlineCallbacks
 475     def test_alice_delete_and_restore(self):
 476         alice_clock = task.Clock()
 477         bob_clock = task.Clock()
 478         yield self.setup_alice_and_bob(alice_clock, bob_clock)
 479         alice_dir = self.alice_magicfolder.uploader._local_path_u
 480         bob_dir = self.bob_magicfolder.uploader._local_path_u
 481         alice_fname = os.path.join(alice_dir, 'blam')
 482         bob_fname = os.path.join(bob_dir, 'blam')
 483
 484         try:
 485             # alice creates a file, bob downloads it
 486             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 487             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 488
 489             fileutil.write(alice_fname, 'contents0\n')
 490             self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 491
 492             alice_clock.advance(0)
 493             yield alice_proc  # alice uploads
 494
 495             bob_clock.advance(0)
 496             yield bob_proc    # bob downloads
 497
 498             # check the state
 499             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 500             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
 501             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 502             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
 503             yield self.failUnlessReallyEqual(
 504                 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
 505                 0
 506             )
 507             yield self.failUnlessReallyEqual(
 508                 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
 509                 1
 510             )
 511             self.failUnless(os.path.exists(bob_fname))
 512
 513             # now alice deletes it (alice should upload, bob download)
 514             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 515             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 516             os.unlink(alice_fname)
 517             self.notify(to_filepath(alice_fname), self.inotify.IN_DELETE, magic=self.alice_magicfolder)
 518
 519             alice_clock.advance(0)
 520             yield alice_proc
 521             bob_clock.advance(0)
 522             yield bob_proc
 523
 524             # check the state
 525             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
 526             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
 527             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
 528             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
 529             self.failIf(os.path.exists(bob_fname))
 530
 531             # now alice restores the file (with new contents)
 532             alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
 533             bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
 534             fileutil.write(alice_fname, 'alice wuz here\n')
 535             self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 536
 537             alice_clock.advance(0)
 538             yield alice_proc
 539             bob_clock.advance(0)
 540             yield bob_proc
 541
 542             # check the state
 543             yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 2)
 544             yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 2)
 545             yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 2)
 546             yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 2)
 547             self.failUnless(os.path.exists(bob_fname))
 548
 549         finally:
 550             # cleanup
 551             d0 = self.alice_magicfolder.finish()
 552             alice_clock.advance(0)
 553             yield d0
 554
 555             d1 = self.bob_magicfolder.finish()
 556             bob_clock.advance(0)
 557             yield d1
 558
 559     def test_magic_folder(self):
 560         self.set_up_grid()
 561         self.local_dir = os.path.join(self.basedir, self.unicode_or_fallback(u"loc\u0101l_dir", u"local_dir"))
 562         self.mkdir_nonascii(self.local_dir)
 563
 564         d = self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
 565         d.addCallback(self._restart_client)
 566
 567         # Write something short enough for a LIT file.
 568         d.addCallback(lambda ign: self._check_file(u"short", "test"))
 569
 570         # Write to the same file again with different data.
 571         d.addCallback(lambda ign: self._check_file(u"short", "different"))
 572
 573         # Test that temporary files are not uploaded.
 574         d.addCallback(lambda ign: self._check_file(u"tempfile", "test", temporary=True))
 575
 576         # Test creation of a subdirectory.
 577         d.addCallback(lambda ign: self._check_mkdir(u"directory"))
 578
 579         # Write something longer, and also try to test a Unicode name if the fs can represent it.
 580         name_u = self.unicode_or_fallback(u"l\u00F8ng", u"long")
 581         d.addCallback(lambda ign: self._check_file(name_u, "test"*100))
 582
 583         # TODO: test that causes an upload failure.
 584         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 585
 586         d.addBoth(self.cleanup)
 587         return d
 588
 589     def _check_mkdir(self, name_u):
 590         return self._check_file(name_u + u"/", "", directory=True)
 591
 592     def _check_file(self, name_u, data, temporary=False, directory=False):
 593         precondition(not (temporary and directory), temporary=temporary, directory=directory)
 594
 595         print "%r._check_file(%r, %r, temporary=%r, directory=%r)" % (self, name_u, data, temporary, directory)
 596         previously_uploaded = self._get_count('uploader.objects_succeeded')
 597         previously_disappeared = self._get_count('uploader.objects_disappeared')
 598
 599         d = self.magicfolder.uploader.set_hook('processed')
 600
 601         path_u = abspath_expanduser_unicode(name_u, base=self.local_dir)
 602         path = to_filepath(path_u)
 603
 604         if directory:
 605             os.mkdir(path_u)
 606             event_mask = self.inotify.IN_CREATE | self.inotify.IN_ISDIR
 607         else:
 608             # We don't use FilePath.setContent() here because it creates a temporary file that
 609             # is renamed into place, which causes events that the test is not expecting.
 610             f = open(path_u, "wb")
 611             try:
 612                 if temporary and sys.platform != "win32":
 613                     os.unlink(path_u)
 614                 f.write(data)
 615             finally:
 616                 f.close()
 617             if temporary and sys.platform == "win32":
 618                 os.unlink(path_u)
 619                 self.notify(path, self.inotify.IN_DELETE, flush=False)
 620             event_mask = self.inotify.IN_CLOSE_WRITE
 621
 622         self.notify(path, event_mask)
 623         encoded_name_u = magicpath.path2magic(name_u)
 624
 625         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 626         if temporary:
 627             d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_disappeared'),
 628                                                                  previously_disappeared + 1))
 629         else:
 630             def _here(res, n):
 631                 print "here %r %r" % (n, res)
 632                 return res
 633             d.addBoth(_here, 1)
 634             d.addCallback(lambda ign: self.upload_dirnode.list())
 635             d.addBoth(_here, 1.5)
 636             d.addCallback(lambda ign: self.upload_dirnode.get(encoded_name_u))
 637             d.addBoth(_here, 2)
 638             d.addCallback(download_to_data)
 639             d.addBoth(_here, 3)
 640             d.addCallback(lambda actual_data: self.failUnlessReallyEqual(actual_data, data))
 641             d.addBoth(_here, 4)
 642             d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'),
 643                                                                  previously_uploaded + 1))
 644
 645         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 646         return d
 647
 648     def _check_version_in_dmd(self, magicfolder, relpath_u, expected_version):
 649         encoded_name_u = magicpath.path2magic(relpath_u)
 650         d = magicfolder.downloader._get_collective_latest_file(encoded_name_u)
 651         def check_latest(result):
 652             if result[0] is not None:
 653                 node, metadata = result
 654                 d.addCallback(lambda ign: self.failUnlessEqual(metadata['version'], expected_version))
 655         d.addCallback(check_latest)
 656         return d
 657
 658     def _check_version_in_local_db(self, magicfolder, relpath_u, expected_version):
 659         version = magicfolder._db.get_local_file_version(relpath_u)
 660         #print "_check_version_in_local_db: %r has version %s" % (relpath_u, version)
 661         self.failUnlessEqual(version, expected_version)
 662
 663     def _check_file_gone(self, magicfolder, relpath_u):
 664         path = os.path.join(magicfolder.uploader._local_path_u, relpath_u)
 665         self.assertTrue(not os.path.exists(path))
 666
 667     def _check_uploader_count(self, name, expected, magic=None):
 668         self.failUnlessReallyEqual(self._get_count('uploader.'+name, client=(magic or self.alice_magicfolder)._client),
 669                                    expected)
 670
 671     def _check_downloader_count(self, name, expected, magic=None):
 672         self.failUnlessReallyEqual(self._get_count('downloader.'+name, client=(magic or self.bob_magicfolder)._client),
 673                                    expected)
 674
 675     def test_alice_bob(self):
 676         alice_clock = task.Clock()
 677         bob_clock = task.Clock()
 678         d = self.setup_alice_and_bob(alice_clock, bob_clock)
 679
 680         def _wait_for_Alice(ign, downloaded_d):
 681             print "Now waiting for Alice to download\n"
 682             alice_clock.advance(0)
 683             return downloaded_d
 684
 685         def _wait_for_Bob(ign, downloaded_d):
 686             print "Now waiting for Bob to download\n"
 687             bob_clock.advance(0)
 688             return downloaded_d
 689
 690         def _wait_for(ign, something_to_do, alice=True):
 691             if alice:
 692                 downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
 693                 uploaded_d = self.alice_magicfolder.uploader.set_hook('processed')
 694             else:
 695                 downloaded_d = self.alice_magicfolder.downloader.set_hook('processed')
 696                 uploaded_d = self.bob_magicfolder.uploader.set_hook('processed')
 697             something_to_do()
 698             if alice:
 699                 print "Waiting for Alice to upload\n"
 700                 alice_clock.advance(0)
 701                 uploaded_d.addCallback(_wait_for_Bob, downloaded_d)
 702             else:
 703                 print "Waiting for Bob to upload\n"
 704                 bob_clock.advance(0)
 705                 uploaded_d.addCallback(_wait_for_Alice, downloaded_d)
 706             return uploaded_d
 707
 708         def Alice_to_write_a_file():
 709             print "Alice writes a file\n"
 710             self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
 711             fileutil.write(self.file_path, "meow, meow meow. meow? meow meow! meow.")
 712             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 713         d.addCallback(_wait_for, Alice_to_write_a_file)
 714
 715         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 0))
 716         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 0))
 717         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
 718         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 1))
 719         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 1))
 720         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0))
 721         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0))
 722         d.addCallback(lambda ign: self._check_uploader_count('objects_conflicted', 0))
 723         d.addCallback(lambda ign: self._check_uploader_count('objects_conflicted', 0, magic=self.bob_magicfolder))
 724
 725         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 0))
 726         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
 727         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1))
 728         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 0, magic=self.bob_magicfolder))
 729
 730         def Alice_to_delete_file():
 731             print "Alice deletes the file!\n"
 732             os.unlink(self.file_path)
 733             self.notify(to_filepath(self.file_path), self.inotify.IN_DELETE, magic=self.alice_magicfolder)
 734         d.addCallback(_wait_for, Alice_to_delete_file)
 735
 736         def notify_bob_moved(ign):
 737             d0 = self.bob_magicfolder.uploader.set_hook('processed')
 738             p = abspath_expanduser_unicode(u"file1", base=self.bob_magicfolder.uploader._local_path_u)
 739             self.notify(to_filepath(p), self.inotify.IN_MOVED_FROM, magic=self.bob_magicfolder, flush=False)
 740             self.notify(to_filepath(p + u'.backup'), self.inotify.IN_MOVED_TO, magic=self.bob_magicfolder)
 741             bob_clock.advance(0)
 742             return d0
 743         d.addCallback(notify_bob_moved)
 744
 745         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 1))
 746         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 1))
 747         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
 748         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 2))
 749         d.addCallback(lambda ign: self._check_uploader_count('objects_not_uploaded', 1, magic=self.bob_magicfolder))
 750         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 1, magic=self.bob_magicfolder))
 751
 752         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 1))
 753         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 1))
 754         d.addCallback(lambda ign: self._check_file_gone(self.bob_magicfolder, u"file1"))
 755         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
 756         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2))
 757
 758         def Alice_to_rewrite_file():
 759             print "Alice rewrites file\n"
 760             self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
 761             fileutil.write(self.file_path, "Alice suddenly sees the white rabbit running into the forest.")
 762             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 763         d.addCallback(_wait_for, Alice_to_rewrite_file)
 764
 765         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 2))
 766         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 2))
 767         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
 768         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3))
 769         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 3))
 770         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0))
 771         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0))
 772         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
 773         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
 774
 775         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 2))
 776         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 2))
 777         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
 778         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3))
 779
 780         path_u = u"/tmp/magic_folder_test"
 781         encoded_path_u = magicpath.path2magic(u"/tmp/magic_folder_test")
 782
 783         def Alice_tries_to_p0wn_Bob(ign):
 784             print "Alice tries to p0wn Bob\n"
 785             self.objects_excluded = self._get_count('downloader.objects_excluded', client=self.bob_magicfolder._client)
 786             processed_d = self.bob_magicfolder.downloader.set_hook('processed')
 787
 788             # upload a file that would provoke the security bug from #2506
 789             uploadable = Data("", self.alice_magicfolder._client.convergence)
 790             alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
 791
 792             d2 = alice_dmd.add_file(encoded_path_u, uploadable, metadata={"version": 0}, overwrite=True)
 793             d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
 794             d2.addCallback(_wait_for_Bob, processed_d)
 795             return d2
 796         d.addCallback(Alice_tries_to_p0wn_Bob)
 797
 798         d.addCallback(lambda ign: self.failIf(os.path.exists(path_u)))
 799         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, encoded_path_u, None))
 800         d.addCallback(lambda ign: self._check_downloader_count('objects_excluded', self.objects_excluded+1))
 801         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3))
 802         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
 803         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
 804
 805         def Bob_to_rewrite_file():
 806             print "Bob rewrites file\n"
 807             self.file_path = abspath_expanduser_unicode(u"file1", base=self.bob_magicfolder.uploader._local_path_u)
 808             print "---- bob's file is %r" % (self.file_path,)
 809             fileutil.write(self.file_path, "No white rabbit to be found.")
 810             self.magicfolder = self.bob_magicfolder
 811             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
 812         d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file, alice=False))
 813
 814         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 3))
 815         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 3))
 816         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
 817         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 2, magic=self.bob_magicfolder))
 818         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 1, magic=self.bob_magicfolder))
 819         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
 820         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
 821         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
 822
 823         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 3))
 824         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 3))
 825         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 826         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1, magic=self.alice_magicfolder))
 827         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
 828
 829         def Alice_conflicts_with_Bobs_last_downloaded_uri():
 830             print "Alice conflicts with Bob\n"
 831             downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
 832             uploadable = Data("do not follow the white rabbit", self.alice_magicfolder._client.convergence)
 833             alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
 834             d2 = alice_dmd.add_file(u"file1", uploadable,
 835                                     metadata={"version": 5,
 836                                               "last_downloaded_uri" : "URI:LIT:" },
 837                                     overwrite=True)
 838             print "Waiting for Alice to upload\n"
 839             d2.addCallback(lambda ign: bob_clock.advance(6))
 840             d2.addCallback(lambda ign: downloaded_d)
 841             d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
 842             return d2
 843
 844         d.addCallback(lambda ign: Alice_conflicts_with_Bobs_last_downloaded_uri())
 845         # XXX fix the code so that it doesn't increment objects_excluded each turn
 846         #d.addCallback(lambda ign: self._check_downloader_count('objects_excluded', 1))
 847         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 4))
 848         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
 849         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1, magic=self.alice_magicfolder))
 850         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 851
 852         # prepare to perform another conflict test
 853         def Alice_to_write_file2():
 854             print "Alice writes a file\n"
 855             self.file_path = abspath_expanduser_unicode(u"file2", base=self.alice_magicfolder.uploader._local_path_u)
 856             fileutil.write(self.file_path, "something")
 857             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 858         d.addCallback(_wait_for, Alice_to_write_file2)
 859         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file2", 0))
 860         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 861
 862         def Bob_to_rewrite_file2():
 863             print "Bob rewrites file\n"
 864             self.file_path = abspath_expanduser_unicode(u"file2", base=self.bob_magicfolder.uploader._local_path_u)
 865             print "---- bob's file is %r" % (self.file_path,)
 866             fileutil.write(self.file_path, "roger roger. what vector?")
 867             self.magicfolder = self.bob_magicfolder
 868             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
 869         d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file2, alice=False))
 870         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 1))
 871         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 5))
 872         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
 873         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
 874         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
 875         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
 876         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
 877         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
 878         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1, magic=self.alice_magicfolder))
 879         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 880         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3, magic=self.alice_magicfolder))
 881
 882         # XXX here we advance the clock and then test again to make sure no values are monotonically increasing
 883         # with each queue turn ;-p
 884         alice_clock.advance(6)
 885         bob_clock.advance(6)
 886         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 1))
 887         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 5))
 888         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
 889         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
 890         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
 891         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
 892         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
 893         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
 894         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1, magic=self.alice_magicfolder))
 895         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 896         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3, magic=self.alice_magicfolder))
 897
 898         def Alice_conflicts_with_Bobs_last_uploaded_uri():
 899             print "Alice conflicts with Bob\n"
 900             encoded_path_u = magicpath.path2magic(u"file2")
 901             downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
 902             uploadable = Data("rabbits with sharp fangs", self.alice_magicfolder._client.convergence)
 903             alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
 904             d2 = alice_dmd.add_file(u"file2", uploadable,
 905                                     metadata={"version": 5,
 906                                               "last_uploaded_uri" : "URI:LIT:" },
 907                                     overwrite=True)
 908             print "Waiting for Alice to upload\n"
 909             d2.addCallback(lambda ign: bob_clock.advance(6))
 910             d2.addCallback(lambda ign: downloaded_d)
 911             d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
 912             return d2
 913         d.addCallback(lambda ign: Alice_conflicts_with_Bobs_last_uploaded_uri())
 914         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 5))
 915         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 6))
 916         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
 917         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
 918         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
 919         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
 920         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
 921         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
 922         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1, magic=self.alice_magicfolder))
 923         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 924         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3, magic=self.alice_magicfolder))
 925
 926         alice_clock.advance(6)
 927         bob_clock.advance(6)
 928         alice_clock.advance(6)
 929         bob_clock.advance(6)
 930
 931         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3, magic=self.alice_magicfolder))
 932         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1, magic=self.alice_magicfolder))
 933         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
 934         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 6))
 935
 936         # prepare to perform another conflict test
 937         def Alice_to_write_file3():
 938             print "Alice writes a file\n"
 939             self.file_path = abspath_expanduser_unicode(u"file3", base=self.alice_magicfolder.uploader._local_path_u)
 940             fileutil.write(self.file_path, "something")
 941             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
 942         d.addCallback(_wait_for, Alice_to_write_file3)
 943         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file3", 0))
 944         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 945         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 7))
 946         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 4, magic=self.alice_magicfolder))
 947         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
 948         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2, magic=self.alice_magicfolder))
 949
 950         def Bob_to_rewrite_file3():
 951             print "Bob rewrites file\n"
 952             self.file_path = abspath_expanduser_unicode(u"file3", base=self.bob_magicfolder.uploader._local_path_u)
 953             print "---- bob's file is %r" % (self.file_path,)
 954             fileutil.write(self.file_path, "roger roger")
 955             self.magicfolder = self.bob_magicfolder
 956             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
 957         d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file3, alice=False))
 958         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file3", 1))
 959         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 7))
 960         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
 961         d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
 962         d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 4, magic=self.bob_magicfolder))
 963         d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 3, magic=self.bob_magicfolder))
 964         d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
 965         d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
 966         d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2, magic=self.alice_magicfolder))
 967         d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
 968         d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 5, magic=self.alice_magicfolder))
 969
 970
 971
 972         def _cleanup(ign, magicfolder, clock):
 973             if magicfolder is not None:
 974                 d2 = magicfolder.finish()
 975                 clock.advance(0)
 976                 return d2
 977
 978         def cleanup_Alice_and_Bob(result):
 979             print "cleanup alice bob test\n"
 980             d = defer.succeed(None)
 981             d.addCallback(_cleanup, self.alice_magicfolder, alice_clock)
 982             d.addCallback(_cleanup, self.bob_magicfolder, bob_clock)
 983             d.addCallback(lambda ign: result)
 984             return d
 985         d.addBoth(cleanup_Alice_and_Bob)
 986         return d
 987
 988
 989 class MockTest(MagicFolderTestMixin, unittest.TestCase):
 990     """This can run on any platform, and even if twisted.internet.inotify can't be imported."""
 991
 992     def setUp(self):
 993         MagicFolderTestMixin.setUp(self)
 994         self.inotify = fake_inotify
 995         self.patch(magic_folder, 'get_inotify_module', lambda: self.inotify)
 996
 997     def notify(self, path, mask, magic=None, flush=True):
 998         if magic is None:
 999             magic = self.magicfolder
1000         magic.uploader._notifier.event(path, mask)
1001         # no flush for the mock test.
1002
1003     def test_errors(self):
1004         self.set_up_grid()
1005
1006         errors_dir = abspath_expanduser_unicode(u"errors_dir", base=self.basedir)
1007         os.mkdir(errors_dir)
1008         not_a_dir = abspath_expanduser_unicode(u"NOT_A_DIR", base=self.basedir)
1009         fileutil.write(not_a_dir, "")
1010         magicfolderdb = abspath_expanduser_unicode(u"magicfolderdb", base=self.basedir)
1011         doesnotexist  = abspath_expanduser_unicode(u"doesnotexist", base=self.basedir)
1012
1013         client = self.g.clients[0]
1014         d = client.create_dirnode()
1015         def _check_errors(n):
1016             self.failUnless(IDirectoryNode.providedBy(n))
1017             upload_dircap = n.get_uri()
1018             readonly_dircap = n.get_readonly_uri()
1019
1020             self.shouldFail(AssertionError, 'nonexistent local.directory', 'there is no directory',
1021                             MagicFolder, client, upload_dircap, '', doesnotexist, magicfolderdb)
1022             self.shouldFail(AssertionError, 'non-directory local.directory', 'is not a directory',
1023                             MagicFolder, client, upload_dircap, '', not_a_dir, magicfolderdb)
1024             self.shouldFail(AssertionError, 'bad upload.dircap', 'does not refer to a directory',
1025                             MagicFolder, client, 'bad', '', errors_dir, magicfolderdb)
1026             self.shouldFail(AssertionError, 'non-directory upload.dircap', 'does not refer to a directory',
1027                             MagicFolder, client, 'URI:LIT:foo', '', errors_dir, magicfolderdb)
1028             self.shouldFail(AssertionError, 'readonly upload.dircap', 'is not a writecap to a directory',
1029                             MagicFolder, client, readonly_dircap, '', errors_dir, magicfolderdb)
1030             self.shouldFail(AssertionError, 'collective dircap', 'is not a readonly cap to a directory',
1031                             MagicFolder, client, upload_dircap, upload_dircap, errors_dir, magicfolderdb)
1032
1033             def _not_implemented():
1034                 raise NotImplementedError("blah")
1035             self.patch(magic_folder, 'get_inotify_module', _not_implemented)
1036             self.shouldFail(NotImplementedError, 'unsupported', 'blah',
1037                             MagicFolder, client, upload_dircap, '', errors_dir, magicfolderdb)
1038         d.addCallback(_check_errors)
1039         return d
1040
1041     def test_write_downloaded_file(self):
1042         workdir = u"cli/MagicFolder/write-downloaded-file"
1043         local_file = fileutil.abspath_expanduser_unicode(os.path.join(workdir, "foobar"))
1044
1045         class TestWriteFileMixin(WriteFileMixin):
1046             def _log(self, msg):
1047                 pass
1048
1049         writefile = TestWriteFileMixin()
1050
1051         # create a file with name "foobar" with content "foo"
1052         # write downloaded file content "bar" into "foobar" with is_conflict = False
1053         fileutil.make_dirs(workdir)
1054         fileutil.write(local_file, "foo")
1055
1056         # if is_conflict is False, then the .conflict file shouldn't exist.
1057         writefile._write_downloaded_file(local_file, "bar", False, None)
1058         conflicted_path = local_file + u".conflict"
1059         self.failIf(os.path.exists(conflicted_path))
1060
1061         # At this point, the backup file should exist with content "foo"
1062         backup_path = local_file + u".backup"
1063         self.failUnless(os.path.exists(backup_path))
1064         self.failUnlessEqual(fileutil.read(backup_path), "foo")
1065
1066         # .tmp file shouldn't exist
1067         self.failIf(os.path.exists(local_file + u".tmp"))
1068
1069         # .. and the original file should have the new content
1070         self.failUnlessEqual(fileutil.read(local_file), "bar")
1071
1072         # now a test for conflicted case
1073         writefile._write_downloaded_file(local_file, "bar", True, None)
1074         self.failUnless(os.path.exists(conflicted_path))
1075
1076         # .tmp file shouldn't exist
1077         self.failIf(os.path.exists(local_file + u".tmp"))
1078
1079
1080 class RealTest(MagicFolderTestMixin, unittest.TestCase):
1081     """This is skipped unless both Twisted and the platform support inotify."""
1082
1083     def setUp(self):
1084         MagicFolderTestMixin.setUp(self)
1085         self.inotify = magic_folder.get_inotify_module()
1086
1087     def notify(self, path, mask, magic=None, flush=True):
1088         # Writing to the filesystem causes the notification.
1089         # However, flushing filesystem buffers may be necessary on Windows.
1090         if flush:
1091             fileutil.flush_volume(path.path)
1092
1093 try:
1094     magic_folder.get_inotify_module()
1095 except NotImplementedError:
1096     RealTest.skip = "Magic Folder support can only be tested for-real on an OS that supports inotify or equivalent."