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
   9 from allmydata.util import fake_inotify, fileutil
  10 from allmydata.util.encodingutil import get_filesystem_encoding, to_filepath
  11 from allmydata.util.consumer import download_to_data
  12 from allmydata.test.no_network import GridTestMixin
  13 from allmydata.test.common_util import ReallyEqualMixin, NonASCIIPathMixin
  14 from allmydata.test.common import ShouldFailMixin
  15 from .test_cli_magic_folder import MagicFolderCLITestMixin
  16
  17 from allmydata.frontends import magic_folder
  18 from allmydata.frontends.magic_folder import MagicFolder, Downloader
  19 from allmydata import backupdb, magicpath
  20 from allmydata.util.fileutil import abspath_expanduser_unicode
  21
  22
  23 class MagicFolderTestMixin(MagicFolderCLITestMixin, ShouldFailMixin, ReallyEqualMixin, NonASCIIPathMixin):
  24     """
  25     These tests will be run both with a mock notifier, and (on platforms that support it)
  26     with the real INotify.
  27     """
  28
  29     def setUp(self):
  30         GridTestMixin.setUp(self)
  31         temp = self.mktemp()
  32         self.basedir = abspath_expanduser_unicode(temp.decode(get_filesystem_encoding()))
  33         self.magicfolder = None
  34         Downloader.REMOTE_SCAN_INTERVAL = 0
  35
  36     def _get_count(self, name, client=None):
  37         counters = (client or self.get_client()).stats_provider.get_stats()["counters"]
  38         return counters.get('magic_folder.%s' % (name,), 0)
  39
  40     def _createdb(self):
  41         dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.basedir)
  42         bdb = backupdb.get_backupdb(dbfile, create_version=(backupdb.SCHEMA_v3, 3))
  43         self.failUnless(bdb, "unable to create backupdb from %r" % (dbfile,))
  44         self.failUnlessEqual(bdb.VERSION, 3)
  45         return bdb
  46
  47     def _restart_client(self, ign):
  48         #print "_restart_client"
  49         d = self.restart_client()
  50         d.addCallback(self._wait_until_started)
  51         return d
  52
  53     def _wait_until_started(self, ign):
  54         #print "_wait_until_started"
  55         self.magicfolder = self.get_client().getServiceNamed('magic-folder')
  56         return self.magicfolder.ready()
  57
  58     def test_db_basic(self):
  59         fileutil.make_dirs(self.basedir)
  60         self._createdb()
  61
  62     def test_db_persistence(self):
  63         """Test that a file upload creates an entry in the database."""
  64
  65         fileutil.make_dirs(self.basedir)
  66         db = self._createdb()
  67
  68         relpath1 = u"myFile1"
  69         pathinfo = fileutil.PathInfo(isdir=False, isfile=True, islink=False,
  70                                      exists=True, size=1, mtime=123, ctime=456)
  71         db.did_upload_version('URI:LIT:1', relpath1, 0, pathinfo)
  72
  73         c = db.cursor
  74         c.execute("SELECT size, mtime, ctime"
  75                   " FROM local_files"
  76                   " WHERE path=?",
  77                   (relpath1,))
  78         row = c.fetchone()
  79         self.failUnlessEqual(row, (pathinfo.size, pathinfo.mtime, pathinfo.ctime))
  80
  81         # Second test uses db.is_new_file instead of SQL query directly
  82         # to confirm the previous upload entry in the db.
  83         relpath2 = u"myFile2"
  84         path2 = os.path.join(self.basedir, relpath2)
  85         fileutil.write(path2, "meow\n")
  86         pathinfo = fileutil.get_pathinfo(path2)
  87         db.did_upload_version('URI:LIT:2', relpath2, 0, pathinfo)
  88         self.failUnlessFalse(db.is_new_file(pathinfo, relpath2))
  89
  90         different_pathinfo = fileutil.PathInfo(isdir=False, isfile=True, islink=False,
  91                                                exists=True, size=0, mtime=pathinfo.mtime, ctime=pathinfo.ctime)
  92         self.failUnlessTrue(db.is_new_file(different_pathinfo, relpath2))
  93
  94     def test_magicfolder_start_service(self):
  95         self.set_up_grid()
  96
  97         self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
  98                                                     base=self.basedir)
  99         self.mkdir_nonascii(self.local_dir)
 100
 101         d = defer.succeed(None)
 102         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
 103
 104         d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
 105         d.addCallback(self._restart_client)
 106
 107         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 1))
 108         d.addBoth(self.cleanup)
 109         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
 110         return d
 111
 112     def test_move_tree(self):
 113         self.set_up_grid()
 114
 115         self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
 116                                                     base=self.basedir)
 117         self.mkdir_nonascii(self.local_dir)
 118
 119         empty_tree_name = self.unicode_or_fallback(u"empty_tr\u00EAe", u"empty_tree")
 120         empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.basedir)
 121         new_empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.local_dir)
 122
 123         small_tree_name = self.unicode_or_fallback(u"small_tr\u00EAe", u"empty_tree")
 124         small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.basedir)
 125         new_small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.local_dir)
 126
 127         d = self.create_invite_join_magic_folder(u"Alice", self.local_dir)
 128         d.addCallback(self._restart_client)
 129
 130         def _check_move_empty_tree(res):
 131             #print "_check_move_empty_tree"
 132             self.mkdir_nonascii(empty_tree_dir)
 133             d2 = self.magicfolder.uploader.set_hook('processed')
 134             os.rename(empty_tree_dir, new_empty_tree_dir)
 135             self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_TO)
 136             return d2
 137         d.addCallback(_check_move_empty_tree)
 138         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 139         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 140         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 0))
 141         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 142         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 1))
 143
 144         def _check_move_small_tree(res):
 145             #print "_check_move_small_tree"
 146             self.mkdir_nonascii(small_tree_dir)
 147             fileutil.write(abspath_expanduser_unicode(u"what", base=small_tree_dir), "say when")
 148             d2 = self.magicfolder.uploader.set_hook('processed', ignore_count=1)
 149             os.rename(small_tree_dir, new_small_tree_dir)
 150             self.notify(to_filepath(new_small_tree_dir), self.inotify.IN_MOVED_TO)
 151             return d2
 152         d.addCallback(_check_move_small_tree)
 153         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 154         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 3))
 155         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 1))
 156         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 157         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 158
 159         def _check_moved_tree_is_watched(res):
 160             #print "_check_moved_tree_is_watched"
 161             d2 = self.magicfolder.uploader.set_hook('processed')
 162             fileutil.write(abspath_expanduser_unicode(u"another", base=new_small_tree_dir), "file")
 163             self.notify(to_filepath(abspath_expanduser_unicode(u"another", base=new_small_tree_dir)), self.inotify.IN_CLOSE_WRITE)
 164             return d2
 165         d.addCallback(_check_moved_tree_is_watched)
 166         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 167         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
 168         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
 169         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 170         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 171
 172         # Files that are moved out of the upload directory should no longer be watched.
 173         #def _move_dir_away(ign):
 174         #    os.rename(new_empty_tree_dir, empty_tree_dir)
 175         #    # Wuh? Why don't we get this event for the real test?
 176         #    #self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_FROM)
 177         #d.addCallback(_move_dir_away)
 178         #def create_file(val):
 179         #    test_file = abspath_expanduser_unicode(u"what", base=empty_tree_dir)
 180         #    fileutil.write(test_file, "meow")
 181         #    #self.notify(...)
 182         #    return
 183         #d.addCallback(create_file)
 184         #d.addCallback(lambda ign: time.sleep(1))  # XXX ICK
 185         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 186         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
 187         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
 188         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 189         #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
 190
 191         d.addBoth(self.cleanup)
 192         return d
 193
 194     def test_persistence(self):
 195         """
 196         Perform an upload of a given file and then stop the client.
 197         Start a new client and magic-folder service... and verify that the file is NOT uploaded
 198         a second time. This test is meant to test the database persistence along with
 199         the startup and shutdown code paths of the magic-folder service.
 200         """
 201         self.set_up_grid()
 202         self.local_dir = abspath_expanduser_unicode(u"test_persistence", base=self.basedir)
 203         self.mkdir_nonascii(self.local_dir)
 204         self.collective_dircap = ""
 205
 206         d = defer.succeed(None)
 207         d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
 208         d.addCallback(self._restart_client)
 209
 210         def create_test_file(filename):
 211             d2 = self.magicfolder.uploader.set_hook('processed')
 212             test_file = abspath_expanduser_unicode(filename, base=self.local_dir)
 213             fileutil.write(test_file, "meow %s" % filename)
 214             self.notify(to_filepath(test_file), self.inotify.IN_CLOSE_WRITE)
 215             return d2
 216         d.addCallback(lambda ign: create_test_file(u"what1"))
 217         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 218         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 219         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 220         d.addCallback(self.cleanup)
 221
 222         d.addCallback(self._restart_client)
 223         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 224         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
 225         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 226         d.addCallback(lambda ign: create_test_file(u"what2"))
 227         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 228         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 2))
 229         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 230         d.addBoth(self.cleanup)
 231         return d
 232
 233     def test_magic_folder(self):
 234         self.set_up_grid()
 235         self.local_dir = os.path.join(self.basedir, self.unicode_or_fallback(u"loc\u0101l_dir", u"local_dir"))
 236         self.mkdir_nonascii(self.local_dir)
 237
 238         d = self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
 239         d.addCallback(self._restart_client)
 240
 241         # Write something short enough for a LIT file.
 242         d.addCallback(lambda ign: self._check_file(u"short", "test"))
 243
 244         # Write to the same file again with different data.
 245         d.addCallback(lambda ign: self._check_file(u"short", "different"))
 246
 247         # Test that temporary files are not uploaded.
 248         d.addCallback(lambda ign: self._check_file(u"tempfile", "test", temporary=True))
 249
 250         # Test that we tolerate creation of a subdirectory.
 251         d.addCallback(lambda ign: os.mkdir(os.path.join(self.local_dir, u"directory")))
 252
 253         # Write something longer, and also try to test a Unicode name if the fs can represent it.
 254         name_u = self.unicode_or_fallback(u"l\u00F8ng", u"long")
 255         d.addCallback(lambda ign: self._check_file(name_u, "test"*100))
 256
 257         # TODO: test that causes an upload failure.
 258         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 259
 260         d.addBoth(self.cleanup)
 261         return d
 262
 263     def _check_file(self, name_u, data, temporary=False):
 264         previously_uploaded = self._get_count('uploader.objects_succeeded')
 265         previously_disappeared = self._get_count('uploader.objects_disappeared')
 266
 267         d = self.magicfolder.uploader.set_hook('processed')
 268
 269         path_u = abspath_expanduser_unicode(name_u, base=self.local_dir)
 270         path = to_filepath(path_u)
 271
 272         # We don't use FilePath.setContent() here because it creates a temporary file that
 273         # is renamed into place, which causes events that the test is not expecting.
 274         f = open(path_u, "wb")
 275         try:
 276             if temporary and sys.platform != "win32":
 277                 os.unlink(path_u)
 278             f.write(data)
 279         finally:
 280             f.close()
 281         if temporary and sys.platform == "win32":
 282             os.unlink(path_u)
 283             self.notify(path, self.inotify.IN_DELETE)
 284         fileutil.flush_volume(path_u)
 285         self.notify(path, self.inotify.IN_CLOSE_WRITE)
 286
 287         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 288         if temporary:
 289             d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_disappeared'),
 290                                                                  previously_disappeared + 1))
 291         else:
 292             d.addCallback(lambda ign: self.upload_dirnode.get(name_u))
 293             d.addCallback(download_to_data)
 294             d.addCallback(lambda actual_data: self.failUnlessReallyEqual(actual_data, data))
 295             d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'),
 296                                                                  previously_uploaded + 1))
 297
 298         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
 299         return d
 300
 301     def _check_version_in_dmd(self, magicfolder, relpath_u, expected_version):
 302         encoded_name_u = magicpath.path2magic(relpath_u)
 303         d = magicfolder.downloader._get_collective_latest_file(encoded_name_u)
 304         def check_latest(result):
 305             if result[0] is not None:
 306                 node, metadata = result
 307                 d.addCallback(lambda ign: self.failUnlessEqual(metadata['version'], expected_version))
 308         d.addCallback(check_latest)
 309         return d
 310
 311     def _check_version_in_local_db(self, magicfolder, relpath_u, expected_version):
 312         version = magicfolder._db.get_local_file_version(relpath_u)
 313         #print "_check_version_in_local_db: %r has version %s" % (relpath_u, version)
 314         self.failUnlessEqual(version, expected_version)
 315
 316     def test_alice_bob(self):
 317         alice_clock = task.Clock()
 318         bob_clock = task.Clock()
 319         d = self.setup_alice_and_bob(alice_clock, bob_clock)
 320         def get_results(result):
 321             # XXX are these used?
 322             (self.alice_collective_dircap, self.alice_upload_dircap, self.alice_magicfolder,
 323              self.bob_collective_dircap,   self.bob_upload_dircap,   self.bob_magicfolder) = result
 324             #print "Alice magicfolderdb is at %r" % (self.alice_magicfolder._client.basedir)
 325             #print "Bob   magicfolderdb is at %r" % (self.bob_magicfolder._client.basedir)
 326         d.addCallback(get_results)
 327
 328         def Alice_write_a_file(result):
 329             print "Alice writes a file\n"
 330             self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
 331             fileutil.write(self.file_path, "meow, meow meow. meow? meow meow! meow.")
 332             self.magicfolder = self.alice_magicfolder
 333             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
 334
 335         d.addCallback(Alice_write_a_file)
 336
 337         def Alice_wait_for_upload(result):
 338             print "Alice waits for an upload\n"
 339             d2 = self.alice_magicfolder.uploader.set_hook('processed')
 340             alice_clock.advance(0)
 341             return d2
 342         d.addCallback(Alice_wait_for_upload)
 343         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 0))
 344         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 0))
 345
 346         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 347         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded', client=self.alice_magicfolder._client), 1))
 348         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded', client=self.alice_magicfolder._client), 1))
 349         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued', client=self.alice_magicfolder._client), 0))
 350         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created', client=self.alice_magicfolder._client), 0))
 351
 352         def Bob_wait_for_download(result):
 353             print "Bob waits for a download\n"
 354             d2 = self.bob_magicfolder.downloader.set_hook('processed')
 355             bob_clock.advance(0)
 356             return d2
 357         d.addCallback(Bob_wait_for_download)
 358         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 0))
 359         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 0)) # XXX prolly not needed
 360         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_failed'), 0))
 361         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client), 1))
 362
 363
 364         # test deletion of file behavior
 365         def Alice_delete_file(result):
 366             print "Alice deletes the file!\n"
 367             os.unlink(self.file_path)
 368             self.notify(to_filepath(self.file_path), self.inotify.IN_DELETE)
 369             alice_clock.advance(0)
 370             return None
 371         d.addCallback(Alice_delete_file)
 372         d.addCallback(Alice_wait_for_upload)
 373         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 374         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded', client=self.alice_magicfolder._client), 2))
 375         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 1))
 376         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 1))
 377
 378         d.addCallback(Bob_wait_for_download)
 379         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_failed'), 0))
 380         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client), 2))
 381         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 1))
 382         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 1))
 383
 384         def Alice_rewrite_file(result):
 385             print "Alice rewrites file\n"
 386             self.magicfolder = self.alice_magicfolder
 387             self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
 388             fileutil.write(self.file_path, "Alice suddenly sees the white rabbit running into the forest.")
 389             self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
 390
 391         d.addCallback(Alice_rewrite_file)
 392         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 1))
 393         d.addCallback(Alice_wait_for_upload)
 394
 395         d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 2))
 396         d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 2))
 397
 398         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
 399         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded', client=self.alice_magicfolder._client), 3))
 400         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded', client=self.alice_magicfolder._client), 3))
 401         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued', client=self.alice_magicfolder._client), 0))
 402         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created', client=self.alice_magicfolder._client), 0))
 403
 404         d.addCallback(Bob_wait_for_download)
 405         d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 2))
 406         d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 2))
 407         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_failed'), 0))
 408         d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client), 3))
 409
 410         def cleanup_Alice_and_Bob(result):
 411             print "cleanup alice bob test\n"
 412             d = defer.succeed(None)
 413             d.addCallback(lambda ign: self.alice_magicfolder.finish())
 414
 415             def clean_bob(_):
 416                 d2 = self.bob_magicfolder.finish()
 417                 d2.addCallback(lambda ign: result)
 418                 bob_clock.advance(0)
 419                 return d2
 420             d.addCallback(clean_bob)
 421             alice_clock.advance(0)
 422             return d
 423         d.addCallback(cleanup_Alice_and_Bob)
 424         return d
 425
 426 class MockTest(MagicFolderTestMixin, unittest.TestCase):
 427     """This can run on any platform, and even if twisted.internet.inotify can't be imported."""
 428
 429     def setUp(self):
 430         MagicFolderTestMixin.setUp(self)
 431         self.inotify = fake_inotify
 432         self.patch(magic_folder, 'get_inotify_module', lambda: self.inotify)
 433
 434     def notify(self, path, mask):
 435         self.magicfolder.uploader._notifier.event(path, mask)
 436
 437     def test_errors(self):
 438         self.set_up_grid()
 439
 440         errors_dir = abspath_expanduser_unicode(u"errors_dir", base=self.basedir)
 441         os.mkdir(errors_dir)
 442         not_a_dir = abspath_expanduser_unicode(u"NOT_A_DIR", base=self.basedir)
 443         fileutil.write(not_a_dir, "")
 444         magicfolderdb = abspath_expanduser_unicode(u"magicfolderdb", base=self.basedir)
 445         doesnotexist  = abspath_expanduser_unicode(u"doesnotexist", base=self.basedir)
 446
 447         client = self.g.clients[0]
 448         d = client.create_dirnode()
 449         def _check_errors(n):
 450             self.failUnless(IDirectoryNode.providedBy(n))
 451             upload_dircap = n.get_uri()
 452             readonly_dircap = n.get_readonly_uri()
 453
 454             self.shouldFail(AssertionError, 'nonexistent local.directory', 'there is no directory',
 455                             MagicFolder, client, upload_dircap, '', doesnotexist, magicfolderdb)
 456             self.shouldFail(AssertionError, 'non-directory local.directory', 'is not a directory',
 457                             MagicFolder, client, upload_dircap, '', not_a_dir, magicfolderdb)
 458             self.shouldFail(AssertionError, 'bad upload.dircap', 'does not refer to a directory',
 459                             MagicFolder, client, 'bad', '', errors_dir, magicfolderdb)
 460             self.shouldFail(AssertionError, 'non-directory upload.dircap', 'does not refer to a directory',
 461                             MagicFolder, client, 'URI:LIT:foo', '', errors_dir, magicfolderdb)
 462             self.shouldFail(AssertionError, 'readonly upload.dircap', 'is not a writecap to a directory',
 463                             MagicFolder, client, readonly_dircap, '', errors_dir, magicfolderdb,)
 464             self.shouldFail(AssertionError, 'collective dircap',
 465                             "The URI in 'private/collective_dircap' is not a readonly cap to a directory.",
 466                             MagicFolder, client, upload_dircap, upload_dircap, errors_dir, magicfolderdb)
 467
 468             def _not_implemented():
 469                 raise NotImplementedError("blah")
 470             self.patch(magic_folder, 'get_inotify_module', _not_implemented)
 471             self.shouldFail(NotImplementedError, 'unsupported', 'blah',
 472                             MagicFolder, client, upload_dircap, '', errors_dir, magicfolderdb)
 473         d.addCallback(_check_errors)
 474         return d
 475
 476     def test_write_downloaded_file(self):
 477         workdir = u"cli/MagicFolder/write-downloaded-file"
 478         local_file = fileutil.abspath_expanduser_unicode(os.path.join(workdir, "foobar"))
 479
 480         # create a file with name "foobar" with content "foo"
 481         # write downloaded file content "bar" into "foobar" with is_conflict = False
 482         fileutil.make_dirs(workdir)
 483         fileutil.write(local_file, "foo")
 484
 485         # if is_conflict is False, then the .conflict file shouldn't exist.
 486         Downloader._write_downloaded_file(local_file, "bar", False, None)
 487         conflicted_path = local_file + u".conflict"
 488         self.failIf(os.path.exists(conflicted_path))
 489
 490         # At this point, the backup file should exist with content "foo"
 491         backup_path = local_file + u".backup"
 492         self.failUnless(os.path.exists(backup_path))
 493         self.failUnlessEqual(fileutil.read(backup_path), "foo")
 494
 495         # .tmp file shouldn't exist
 496         self.failIf(os.path.exists(local_file + u".tmp"))
 497
 498         # .. and the original file should have the new content
 499         self.failUnlessEqual(fileutil.read(local_file), "bar")
 500
 501         # now a test for conflicted case
 502         Downloader._write_downloaded_file(local_file, "bar", True, None)
 503         self.failUnless(os.path.exists(conflicted_path))
 504
 505         # .tmp file shouldn't exist
 506         self.failIf(os.path.exists(local_file + u".tmp"))
 507
 508
 509 class RealTest(MagicFolderTestMixin, unittest.TestCase):
 510     """This is skipped unless both Twisted and the platform support inotify."""
 511
 512     def setUp(self):
 513         MagicFolderTestMixin.setUp(self)
 514         self.inotify = magic_folder.get_inotify_module()
 515
 516     def notify(self, path, mask):
 517         # Writing to the filesystem causes the notification.
 518         pass
 519
 520 try:
 521     magic_folder.get_inotify_module()
 522 except NotImplementedError:
 523     RealTest.skip = "Magic Folder support can only be tested for-real on an OS that supports inotify or equivalent."