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