4 from twisted.trial import unittest
5 from twisted.internet import defer, task
7 from allmydata.interfaces import IDirectoryNode
8 from allmydata.util.assertutil import precondition
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
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
25 class MagicFolderTestMixin(MagicFolderCLITestMixin, ShouldFailMixin, ReallyEqualMixin, NonASCIIPathMixin):
27 These tests will be run both with a mock notifier, and (on platforms that support it)
28 with the real INotify.
32 GridTestMixin.setUp(self)
34 self.basedir = abspath_expanduser_unicode(temp.decode(get_filesystem_encoding()))
35 self.magicfolder = None
36 self.patch(Downloader, 'REMOTE_SCAN_INTERVAL', 0)
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)
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)
49 def _restart_client(self, ign):
50 #print "_restart_client"
51 d = self.restart_client()
52 d.addCallback(self._wait_until_started)
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()
60 def test_db_basic(self):
61 fileutil.make_dirs(self.basedir)
64 def test_db_persistence(self):
65 """Test that a file upload creates an entry in the database."""
67 fileutil.make_dirs(self.basedir)
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)
76 c.execute("SELECT size, mtime, ctime"
81 self.failUnlessEqual(row, (pathinfo.size, pathinfo.mtime, pathinfo.ctime))
83 # Second test uses magic_folder.is_new_file instead of SQL query directly
84 # to confirm the previous upload entry in the db.
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 db_entry = db.get_db_entry(relpath2)
91 self.failUnlessFalse(magic_folder.is_new_file(pathinfo, db_entry))
93 different_pathinfo = fileutil.PathInfo(isdir=False, isfile=True, islink=False,
94 exists=True, size=0, mtime=pathinfo.mtime, ctime=pathinfo.ctime)
95 self.failUnlessTrue(magic_folder.is_new_file(different_pathinfo, db_entry))
97 def test_magicfolder_start_service(self):
100 self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
102 self.mkdir_nonascii(self.local_dir)
104 d = defer.succeed(None)
105 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
107 d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
108 d.addCallback(self._restart_client)
110 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 1))
111 d.addBoth(self.cleanup)
112 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.dirs_monitored'), 0))
115 def test_move_tree(self):
118 self.local_dir = abspath_expanduser_unicode(self.unicode_or_fallback(u"l\u00F8cal_dir", u"local_dir"),
120 self.mkdir_nonascii(self.local_dir)
122 empty_tree_name = self.unicode_or_fallback(u"empty_tr\u00EAe", u"empty_tree")
123 empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.basedir)
124 new_empty_tree_dir = abspath_expanduser_unicode(empty_tree_name, base=self.local_dir)
126 small_tree_name = self.unicode_or_fallback(u"small_tr\u00EAe", u"empty_tree")
127 small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.basedir)
128 new_small_tree_dir = abspath_expanduser_unicode(small_tree_name, base=self.local_dir)
130 d = self.create_invite_join_magic_folder(u"Alice", self.local_dir)
131 d.addCallback(self._restart_client)
133 def _check_move_empty_tree(res):
134 print "_check_move_empty_tree"
135 uploaded_d = self.magicfolder.uploader.set_hook('processed')
136 self.mkdir_nonascii(empty_tree_dir)
137 os.rename(empty_tree_dir, new_empty_tree_dir)
138 self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_TO)
141 d.addCallback(_check_move_empty_tree)
142 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
143 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
144 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 0))
145 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
146 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 1))
148 def _check_move_small_tree(res):
149 print "_check_move_small_tree"
150 uploaded_d = self.magicfolder.uploader.set_hook('processed', ignore_count=1)
151 self.mkdir_nonascii(small_tree_dir)
152 what_path = abspath_expanduser_unicode(u"what", base=small_tree_dir)
153 fileutil.write(what_path, "say when")
154 os.rename(small_tree_dir, new_small_tree_dir)
155 self.notify(to_filepath(new_small_tree_dir), self.inotify.IN_MOVED_TO)
158 d.addCallback(_check_move_small_tree)
159 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
160 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 3))
161 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 1))
162 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
163 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
165 def _check_moved_tree_is_watched(res):
166 print "_check_moved_tree_is_watched"
167 uploaded_d = self.magicfolder.uploader.set_hook('processed')
168 another_path = abspath_expanduser_unicode(u"another", base=new_small_tree_dir)
169 fileutil.write(another_path, "file")
170 self.notify(to_filepath(another_path), self.inotify.IN_CLOSE_WRITE)
173 d.addCallback(_check_moved_tree_is_watched)
174 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
175 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
176 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
177 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
178 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
180 # Files that are moved out of the upload directory should no longer be watched.
181 #def _move_dir_away(ign):
182 # os.rename(new_empty_tree_dir, empty_tree_dir)
183 # # Wuh? Why don't we get this event for the real test?
184 # #self.notify(to_filepath(new_empty_tree_dir), self.inotify.IN_MOVED_FROM)
185 #d.addCallback(_move_dir_away)
186 #def create_file(val):
187 # test_file = abspath_expanduser_unicode(u"what", base=empty_tree_dir)
188 # fileutil.write(test_file, "meow")
191 #d.addCallback(create_file)
192 #d.addCallback(lambda ign: time.sleep(1)) # XXX ICK
193 #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
194 #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 4))
195 #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.files_uploaded'), 2))
196 #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
197 #d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.directories_created'), 2))
199 d.addBoth(self.cleanup)
202 def test_persistence(self):
204 Perform an upload of a given file and then stop the client.
205 Start a new client and magic-folder service... and verify that the file is NOT uploaded
206 a second time. This test is meant to test the database persistence along with
207 the startup and shutdown code paths of the magic-folder service.
210 self.local_dir = abspath_expanduser_unicode(u"test_persistence", base=self.basedir)
211 self.mkdir_nonascii(self.local_dir)
212 self.collective_dircap = ""
214 d = defer.succeed(None)
215 d.addCallback(lambda ign: self.create_invite_join_magic_folder(u"Alice", self.local_dir))
216 d.addCallback(self._restart_client)
218 def create_test_file(filename):
219 d2 = self.magicfolder.uploader.set_hook('processed')
220 test_file = abspath_expanduser_unicode(filename, base=self.local_dir)
221 fileutil.write(test_file, "meow %s" % filename)
222 self.notify(to_filepath(test_file), self.inotify.IN_CLOSE_WRITE)
224 d.addCallback(lambda ign: create_test_file(u"what1"))
225 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
226 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
227 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
228 d.addCallback(self.cleanup)
230 d.addCallback(self._restart_client)
231 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
232 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 1))
233 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
234 d.addCallback(lambda ign: create_test_file(u"what2"))
235 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
236 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'), 2))
237 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
238 d.addBoth(self.cleanup)
241 @defer.inlineCallbacks
242 def test_delete(self):
244 self.local_dir = os.path.join(self.basedir, u"local_dir")
245 self.mkdir_nonascii(self.local_dir)
247 yield self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
248 yield self._restart_client(None)
252 up_proc = self.magicfolder.uploader.set_hook('processed')
253 # down_proc = self.magicfolder.downloader.set_hook('processed')
254 path = os.path.join(self.local_dir, u'foo')
255 fileutil.write(path, 'foo\n')
256 self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
258 self.assertTrue(os.path.exists(path))
260 # the real test part: delete the file
261 up_proc = self.magicfolder.uploader.set_hook('processed')
263 self.notify(to_filepath(path), self.inotify.IN_DELETE)
265 self.assertFalse(os.path.exists(path))
267 # ensure we still have a DB entry, and that the version is 1
268 node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
269 self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
270 self.failUnlessEqual(metadata['version'], 1)
273 yield self.cleanup(None)
275 @defer.inlineCallbacks
276 def test_delete_and_restore(self):
278 self.local_dir = os.path.join(self.basedir, u"local_dir")
279 self.mkdir_nonascii(self.local_dir)
281 yield self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
282 yield self._restart_client(None)
286 up_proc = self.magicfolder.uploader.set_hook('processed')
287 # down_proc = self.magicfolder.downloader.set_hook('processed')
288 path = os.path.join(self.local_dir, u'foo')
289 fileutil.write(path, 'foo\n')
290 self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
292 self.assertTrue(os.path.exists(path))
295 up_proc = self.magicfolder.uploader.set_hook('processed')
297 self.notify(to_filepath(path), self.inotify.IN_DELETE)
299 self.assertFalse(os.path.exists(path))
301 # ensure we still have a DB entry, and that the version is 1
302 node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
303 self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
304 self.failUnlessEqual(metadata['version'], 1)
306 # restore the file, with different contents
307 up_proc = self.magicfolder.uploader.set_hook('processed')
308 path = os.path.join(self.local_dir, u'foo')
309 fileutil.write(path, 'bar\n')
310 self.notify(to_filepath(path), self.inotify.IN_CLOSE_WRITE)
313 # ensure we still have a DB entry, and that the version is 2
314 node, metadata = yield self.magicfolder.downloader._get_collective_latest_file(u'foo')
315 self.assertTrue(node is not None, "Failed to find %r in DMD" % (path,))
316 self.failUnlessEqual(metadata['version'], 2)
319 yield self.cleanup(None)
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')
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')
336 fileutil.write(alice_fname, 'contents0\n')
337 self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
339 alice_clock.advance(0)
340 yield alice_proc # alice uploads
343 yield bob_proc # bob downloads
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),
354 yield self.failUnlessReallyEqual(
355 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
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')
364 self.notify(to_filepath(bob_fname), self.inotify.IN_DELETE, magic=self.bob_magicfolder)
368 alice_clock.advance(0)
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)
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)
386 alice_clock.advance(0)
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)
401 d0 = self.alice_magicfolder.finish()
402 alice_clock.advance(0)
405 d1 = self.bob_magicfolder.finish()
409 @defer.inlineCallbacks
410 def test_alice_sees_bobs_delete_with_error(self):
411 # alice creates a file, bob deletes it -- and we also arrange
412 # for Alice's file to have "gone missing" as well.
413 alice_clock = task.Clock()
414 bob_clock = task.Clock()
415 yield self.setup_alice_and_bob(alice_clock, bob_clock)
416 alice_dir = self.alice_magicfolder.uploader._local_path_u
417 bob_dir = self.bob_magicfolder.uploader._local_path_u
418 alice_fname = os.path.join(alice_dir, 'blam')
419 bob_fname = os.path.join(bob_dir, 'blam')
422 # alice creates a file, bob downloads it
423 alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
424 bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
426 fileutil.write(alice_fname, 'contents0\n')
427 self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
429 alice_clock.advance(0)
430 yield alice_proc # alice uploads
433 yield bob_proc # bob downloads
436 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
437 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
438 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
439 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
440 yield self.failUnlessReallyEqual(
441 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
444 yield self.failUnlessReallyEqual(
445 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
449 # now bob deletes it (bob should upload, alice download)
450 bob_proc = self.bob_magicfolder.uploader.set_hook('processed')
451 alice_proc = self.alice_magicfolder.downloader.set_hook('processed')
453 self.notify(to_filepath(bob_fname), self.inotify.IN_DELETE, magic=self.bob_magicfolder)
454 # just after notifying bob, we also delete alice's,
455 # covering the 'except' flow in _rename_deleted_file()
456 os.unlink(alice_fname)
460 alice_clock.advance(0)
464 node, metadata = yield self.alice_magicfolder.downloader._get_collective_latest_file(u'blam')
465 self.assertTrue(metadata['deleted'])
466 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
467 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
468 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
469 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
473 d0 = self.alice_magicfolder.finish()
474 alice_clock.advance(0)
477 d1 = self.bob_magicfolder.finish()
481 @defer.inlineCallbacks
482 def test_alice_create_bob_update(self):
483 alice_clock = task.Clock()
484 bob_clock = task.Clock()
485 yield self.setup_alice_and_bob(alice_clock, bob_clock)
486 alice_dir = self.alice_magicfolder.uploader._local_path_u
487 bob_dir = self.bob_magicfolder.uploader._local_path_u
488 alice_fname = os.path.join(alice_dir, 'blam')
489 bob_fname = os.path.join(bob_dir, 'blam')
492 # alice creates a file, bob downloads it
493 alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
494 bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
496 fileutil.write(alice_fname, 'contents0\n')
497 self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
499 alice_clock.advance(0)
500 yield alice_proc # alice uploads
503 yield bob_proc # bob downloads
506 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
507 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
508 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
509 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
510 yield self.failUnlessReallyEqual(
511 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
514 yield self.failUnlessReallyEqual(
515 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
519 # now bob updates it (bob should upload, alice download)
520 bob_proc = self.bob_magicfolder.uploader.set_hook('processed')
521 alice_proc = self.alice_magicfolder.downloader.set_hook('processed')
522 fileutil.write(bob_fname, 'bob wuz here\n')
523 self.notify(to_filepath(bob_fname), self.inotify.IN_CLOSE_WRITE, magic=self.bob_magicfolder)
527 alice_clock.advance(0)
531 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
532 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
533 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
534 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
538 d0 = self.alice_magicfolder.finish()
539 alice_clock.advance(0)
542 d1 = self.bob_magicfolder.finish()
546 @defer.inlineCallbacks
547 def test_alice_delete_and_restore(self):
548 alice_clock = task.Clock()
549 bob_clock = task.Clock()
550 yield self.setup_alice_and_bob(alice_clock, bob_clock)
551 alice_dir = self.alice_magicfolder.uploader._local_path_u
552 bob_dir = self.bob_magicfolder.uploader._local_path_u
553 alice_fname = os.path.join(alice_dir, 'blam')
554 bob_fname = os.path.join(bob_dir, 'blam')
557 # alice creates a file, bob downloads it
558 alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
559 bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
561 fileutil.write(alice_fname, 'contents0\n')
562 self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
564 alice_clock.advance(0)
565 yield alice_proc # alice uploads
568 yield bob_proc # bob downloads
571 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
572 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 0)
573 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
574 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 0)
575 yield self.failUnlessReallyEqual(
576 self._get_count('downloader.objects_failed', client=self.bob_magicfolder._client),
579 yield self.failUnlessReallyEqual(
580 self._get_count('downloader.objects_downloaded', client=self.bob_magicfolder._client),
583 self.failUnless(os.path.exists(bob_fname))
585 # now alice deletes it (alice should upload, bob download)
586 alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
587 bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
588 os.unlink(alice_fname)
589 self.notify(to_filepath(alice_fname), self.inotify.IN_DELETE, magic=self.alice_magicfolder)
591 alice_clock.advance(0)
597 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 1)
598 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 1)
599 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 1)
600 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 1)
601 self.failIf(os.path.exists(bob_fname))
603 # now alice restores the file (with new contents)
604 alice_proc = self.alice_magicfolder.uploader.set_hook('processed')
605 bob_proc = self.bob_magicfolder.downloader.set_hook('processed')
606 fileutil.write(alice_fname, 'alice wuz here\n')
607 self.notify(to_filepath(alice_fname), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
609 alice_clock.advance(0)
615 yield self._check_version_in_dmd(self.bob_magicfolder, u"blam", 2)
616 yield self._check_version_in_local_db(self.bob_magicfolder, u"blam", 2)
617 yield self._check_version_in_dmd(self.alice_magicfolder, u"blam", 2)
618 yield self._check_version_in_local_db(self.alice_magicfolder, u"blam", 2)
619 self.failUnless(os.path.exists(bob_fname))
623 d0 = self.alice_magicfolder.finish()
624 alice_clock.advance(0)
627 d1 = self.bob_magicfolder.finish()
631 def test_magic_folder(self):
633 self.local_dir = os.path.join(self.basedir, self.unicode_or_fallback(u"loc\u0101l_dir", u"local_dir"))
634 self.mkdir_nonascii(self.local_dir)
636 d = self.create_invite_join_magic_folder(u"Alice\u0101", self.local_dir)
637 d.addCallback(self._restart_client)
639 # Write something short enough for a LIT file.
640 d.addCallback(lambda ign: self._check_file(u"short", "test"))
642 # Write to the same file again with different data.
643 d.addCallback(lambda ign: self._check_file(u"short", "different"))
645 # Test that temporary files are not uploaded.
646 d.addCallback(lambda ign: self._check_file(u"tempfile", "test", temporary=True))
648 # Test creation of a subdirectory.
649 d.addCallback(lambda ign: self._check_mkdir(u"directory"))
651 # Write something longer, and also try to test a Unicode name if the fs can represent it.
652 name_u = self.unicode_or_fallback(u"l\u00F8ng", u"long")
653 d.addCallback(lambda ign: self._check_file(name_u, "test"*100))
655 # TODO: test that causes an upload failure.
656 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
658 d.addBoth(self.cleanup)
661 def _check_mkdir(self, name_u):
662 return self._check_file(name_u + u"/", "", directory=True)
664 def _check_file(self, name_u, data, temporary=False, directory=False):
665 precondition(not (temporary and directory), temporary=temporary, directory=directory)
667 print "%r._check_file(%r, %r, temporary=%r, directory=%r)" % (self, name_u, data, temporary, directory)
668 previously_uploaded = self._get_count('uploader.objects_succeeded')
669 previously_disappeared = self._get_count('uploader.objects_disappeared')
671 d = self.magicfolder.uploader.set_hook('processed')
673 path_u = abspath_expanduser_unicode(name_u, base=self.local_dir)
674 path = to_filepath(path_u)
678 event_mask = self.inotify.IN_CREATE | self.inotify.IN_ISDIR
680 # We don't use FilePath.setContent() here because it creates a temporary file that
681 # is renamed into place, which causes events that the test is not expecting.
682 f = open(path_u, "wb")
684 if temporary and sys.platform != "win32":
689 if temporary and sys.platform == "win32":
691 self.notify(path, self.inotify.IN_DELETE, flush=False)
692 event_mask = self.inotify.IN_CLOSE_WRITE
694 self.notify(path, event_mask)
695 encoded_name_u = magicpath.path2magic(name_u)
697 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_failed'), 0))
699 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_disappeared'),
700 previously_disappeared + 1))
703 print "here %r %r" % (n, res)
706 d.addCallback(lambda ign: self.upload_dirnode.list())
707 d.addBoth(_here, 1.5)
708 d.addCallback(lambda ign: self.upload_dirnode.get(encoded_name_u))
710 d.addCallback(download_to_data)
712 d.addCallback(lambda actual_data: self.failUnlessReallyEqual(actual_data, data))
714 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_succeeded'),
715 previously_uploaded + 1))
717 d.addCallback(lambda ign: self.failUnlessReallyEqual(self._get_count('uploader.objects_queued'), 0))
720 def _check_version_in_dmd(self, magicfolder, relpath_u, expected_version):
721 encoded_name_u = magicpath.path2magic(relpath_u)
722 d = magicfolder.downloader._get_collective_latest_file(encoded_name_u)
723 def check_latest(result):
724 if result[0] is not None:
725 node, metadata = result
726 d.addCallback(lambda ign: self.failUnlessEqual(metadata['version'], expected_version))
727 d.addCallback(check_latest)
730 def _check_version_in_local_db(self, magicfolder, relpath_u, expected_version):
731 db_entry = magicfolder._db.get_db_entry(relpath_u)
732 if db_entry is not None:
733 #print "_check_version_in_local_db: %r has version %s" % (relpath_u, version)
734 self.failUnlessEqual(db_entry.version, expected_version)
736 def _check_file_gone(self, magicfolder, relpath_u):
737 path = os.path.join(magicfolder.uploader._local_path_u, relpath_u)
738 self.assertTrue(not os.path.exists(path))
740 def _check_uploader_count(self, name, expected, magic=None):
741 self.failUnlessReallyEqual(self._get_count('uploader.'+name, client=(magic or self.alice_magicfolder)._client),
744 def _check_downloader_count(self, name, expected, magic=None):
745 self.failUnlessReallyEqual(self._get_count('downloader.'+name, client=(magic or self.bob_magicfolder)._client),
748 def test_alice_bob(self):
749 alice_clock = task.Clock()
750 bob_clock = task.Clock()
751 d = self.setup_alice_and_bob(alice_clock, bob_clock)
753 def _wait_for_Alice(ign, downloaded_d):
754 print "Now waiting for Alice to download\n"
755 alice_clock.advance(0)
758 def _wait_for_Bob(ign, downloaded_d):
759 print "Now waiting for Bob to download\n"
763 def _wait_for(ign, something_to_do, alice=True):
765 downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
766 uploaded_d = self.alice_magicfolder.uploader.set_hook('processed')
768 downloaded_d = self.alice_magicfolder.downloader.set_hook('processed')
769 uploaded_d = self.bob_magicfolder.uploader.set_hook('processed')
772 print "Waiting for Alice to upload\n"
773 alice_clock.advance(0)
774 uploaded_d.addCallback(_wait_for_Bob, downloaded_d)
776 print "Waiting for Bob to upload\n"
778 uploaded_d.addCallback(_wait_for_Alice, downloaded_d)
781 def Alice_to_write_a_file():
782 print "Alice writes a file\n"
783 self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
784 fileutil.write(self.file_path, "meow, meow meow. meow? meow meow! meow.")
785 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
786 d.addCallback(_wait_for, Alice_to_write_a_file)
788 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 0))
789 d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 0))
790 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
791 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 1))
792 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 1))
793 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0))
794 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0))
795 d.addCallback(lambda ign: self._check_uploader_count('objects_conflicted', 0))
796 d.addCallback(lambda ign: self._check_uploader_count('objects_conflicted', 0, magic=self.bob_magicfolder))
798 d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 0))
799 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
800 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1))
801 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 0, magic=self.bob_magicfolder))
803 def Alice_to_delete_file():
804 print "Alice deletes the file!\n"
805 os.unlink(self.file_path)
806 self.notify(to_filepath(self.file_path), self.inotify.IN_DELETE, magic=self.alice_magicfolder)
807 d.addCallback(_wait_for, Alice_to_delete_file)
809 def notify_bob_moved(ign):
810 d0 = self.bob_magicfolder.uploader.set_hook('processed')
811 p = abspath_expanduser_unicode(u"file1", base=self.bob_magicfolder.uploader._local_path_u)
812 self.notify(to_filepath(p), self.inotify.IN_MOVED_FROM, magic=self.bob_magicfolder, flush=False)
813 self.notify(to_filepath(p + u'.backup'), self.inotify.IN_MOVED_TO, magic=self.bob_magicfolder)
816 d.addCallback(notify_bob_moved)
818 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 1))
819 d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 1))
820 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
821 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 2))
822 d.addCallback(lambda ign: self._check_uploader_count('objects_not_uploaded', 1, magic=self.bob_magicfolder))
823 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 1, magic=self.bob_magicfolder))
825 d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 1))
826 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 1))
827 d.addCallback(lambda ign: self._check_file_gone(self.bob_magicfolder, u"file1"))
828 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
829 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2))
831 def Alice_to_rewrite_file():
832 print "Alice rewrites file\n"
833 self.file_path = abspath_expanduser_unicode(u"file1", base=self.alice_magicfolder.uploader._local_path_u)
834 fileutil.write(self.file_path, "Alice suddenly sees the white rabbit running into the forest.")
835 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
836 d.addCallback(_wait_for, Alice_to_rewrite_file)
838 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 2))
839 d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 2))
840 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0))
841 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3))
842 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 3))
843 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0))
844 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0))
845 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
846 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
848 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 2))
849 d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 2))
850 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0))
851 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3))
853 path_u = u"/tmp/magic_folder_test"
854 encoded_path_u = magicpath.path2magic(u"/tmp/magic_folder_test")
856 def Alice_tries_to_p0wn_Bob(ign):
857 print "Alice tries to p0wn Bob\n"
858 processed_d = self.bob_magicfolder.downloader.set_hook('processed')
860 # upload a file that would provoke the security bug from #2506
861 uploadable = Data("", self.alice_magicfolder._client.convergence)
862 alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
864 d2 = alice_dmd.add_file(encoded_path_u, uploadable, metadata={"version": 0}, overwrite=True)
865 d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
866 d2.addCallback(_wait_for_Bob, processed_d)
868 d.addCallback(Alice_tries_to_p0wn_Bob)
870 d.addCallback(lambda ign: self.failIf(os.path.exists(path_u)))
871 d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, encoded_path_u, None))
872 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3))
873 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
874 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
876 def Bob_to_rewrite_file():
877 print "Bob rewrites file\n"
878 self.file_path = abspath_expanduser_unicode(u"file1", base=self.bob_magicfolder.uploader._local_path_u)
879 print "---- bob's file is %r" % (self.file_path,)
880 fileutil.write(self.file_path, "No white rabbit to be found.")
881 self.magicfolder = self.bob_magicfolder
882 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
883 d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file, alice=False))
885 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file1", 3))
886 d.addCallback(lambda ign: self._check_version_in_local_db(self.bob_magicfolder, u"file1", 3))
887 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
888 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 2, magic=self.bob_magicfolder))
889 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 1, magic=self.bob_magicfolder))
890 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
891 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
892 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0))
894 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file1", 3))
895 d.addCallback(lambda ign: self._check_version_in_local_db(self.alice_magicfolder, u"file1", 3))
896 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
897 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1, magic=self.alice_magicfolder))
898 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
900 def Alice_conflicts_with_Bobs_last_downloaded_uri():
901 print "Alice conflicts with Bob\n"
902 downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
903 uploadable = Data("do not follow the white rabbit", self.alice_magicfolder._client.convergence)
904 alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
905 d2 = alice_dmd.add_file(u"file1", uploadable,
906 metadata={"version": 5,
907 "last_downloaded_uri" : "URI:LIT:" },
909 print "Waiting for Alice to upload\n"
910 d2.addCallback(lambda ign: bob_clock.advance(6))
911 d2.addCallback(lambda ign: downloaded_d)
912 d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
915 d.addCallback(lambda ign: Alice_conflicts_with_Bobs_last_downloaded_uri())
916 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 4))
917 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
918 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 1, magic=self.alice_magicfolder))
919 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
920 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
922 # prepare to perform another conflict test
923 def Alice_to_write_file2():
924 print "Alice writes a file\n"
925 self.file_path = abspath_expanduser_unicode(u"file2", base=self.alice_magicfolder.uploader._local_path_u)
926 fileutil.write(self.file_path, "something")
927 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
928 d.addCallback(_wait_for, Alice_to_write_file2)
929 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file2", 0))
930 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
931 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
933 def Bob_to_rewrite_file2():
934 print "Bob rewrites file\n"
935 self.file_path = abspath_expanduser_unicode(u"file2", base=self.bob_magicfolder.uploader._local_path_u)
936 print "---- bob's file is %r" % (self.file_path,)
937 fileutil.write(self.file_path, "roger roger. what vector?")
938 self.magicfolder = self.bob_magicfolder
939 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
940 d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file2, alice=False))
941 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 1))
942 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 5))
943 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
944 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
945 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
946 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
947 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
948 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
949 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
950 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
951 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2, magic=self.alice_magicfolder))
953 # XXX here we advance the clock and then test again to make sure no values are monotonically increasing
954 # with each queue turn ;-p
955 alice_clock.advance(6)
957 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 1))
958 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 5))
959 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 1))
960 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
961 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
962 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
963 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
964 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
965 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
966 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
967 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2, magic=self.alice_magicfolder))
969 def Alice_conflicts_with_Bobs_last_uploaded_uri():
970 print "Alice conflicts with Bob\n"
971 encoded_path_u = magicpath.path2magic(u"file2")
972 downloaded_d = self.bob_magicfolder.downloader.set_hook('processed')
973 uploadable = Data("rabbits with sharp fangs", self.alice_magicfolder._client.convergence)
974 alice_dmd = self.alice_magicfolder.uploader._upload_dirnode
975 d2 = alice_dmd.add_file(u"file2", uploadable,
976 metadata={"version": 5,
977 "last_uploaded_uri" : "URI:LIT:" },
979 print "Waiting for Alice to upload\n"
980 d2.addCallback(lambda ign: bob_clock.advance(6))
981 d2.addCallback(lambda ign: downloaded_d)
982 d2.addCallback(lambda ign: self.failUnless(alice_dmd.has_child(encoded_path_u)))
984 d.addCallback(lambda ign: Alice_conflicts_with_Bobs_last_uploaded_uri())
985 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file2", 5))
986 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 6))
987 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
988 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
989 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 3, magic=self.bob_magicfolder))
990 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 2, magic=self.bob_magicfolder))
991 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
992 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
993 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
994 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
995 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2, magic=self.alice_magicfolder))
997 alice_clock.advance(6)
999 alice_clock.advance(6)
1000 bob_clock.advance(6)
1002 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2, magic=self.alice_magicfolder))
1003 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
1004 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
1005 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 6))
1007 # prepare to perform another conflict test
1008 def Alice_to_write_file3():
1009 print "Alice writes a file\n"
1010 self.file_path = abspath_expanduser_unicode(u"file3", base=self.alice_magicfolder.uploader._local_path_u)
1011 fileutil.write(self.file_path, "something")
1012 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE, magic=self.alice_magicfolder)
1013 d.addCallback(_wait_for, Alice_to_write_file3)
1014 d.addCallback(lambda ign: self._check_version_in_dmd(self.alice_magicfolder, u"file3", 0))
1015 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
1016 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 7))
1017 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 2, magic=self.alice_magicfolder))
1018 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
1019 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
1021 def Bob_to_rewrite_file3():
1022 print "Bob rewrites file\n"
1023 self.file_path = abspath_expanduser_unicode(u"file3", base=self.bob_magicfolder.uploader._local_path_u)
1024 print "---- bob's file is %r" % (self.file_path,)
1025 fileutil.write(self.file_path, "roger roger")
1026 self.magicfolder = self.bob_magicfolder
1027 self.notify(to_filepath(self.file_path), self.inotify.IN_CLOSE_WRITE)
1028 d.addCallback(lambda ign: _wait_for(None, Bob_to_rewrite_file3, alice=False))
1029 d.addCallback(lambda ign: self._check_version_in_dmd(self.bob_magicfolder, u"file3", 1))
1030 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 7))
1031 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 2))
1032 d.addCallback(lambda ign: self._check_uploader_count('objects_failed', 0, magic=self.bob_magicfolder))
1033 d.addCallback(lambda ign: self._check_uploader_count('objects_succeeded', 4, magic=self.bob_magicfolder))
1034 d.addCallback(lambda ign: self._check_uploader_count('files_uploaded', 3, magic=self.bob_magicfolder))
1035 d.addCallback(lambda ign: self._check_uploader_count('objects_queued', 0, magic=self.bob_magicfolder))
1036 d.addCallback(lambda ign: self._check_uploader_count('directories_created', 0, magic=self.bob_magicfolder))
1037 d.addCallback(lambda ign: self._check_downloader_count('objects_conflicted', 0, magic=self.alice_magicfolder))
1038 d.addCallback(lambda ign: self._check_downloader_count('objects_failed', 0, magic=self.alice_magicfolder))
1039 d.addCallback(lambda ign: self._check_downloader_count('objects_downloaded', 3, magic=self.alice_magicfolder))
1043 def _cleanup(ign, magicfolder, clock):
1044 if magicfolder is not None:
1045 d2 = magicfolder.finish()
1049 def cleanup_Alice_and_Bob(result):
1050 print "cleanup alice bob test\n"
1051 d = defer.succeed(None)
1052 d.addCallback(_cleanup, self.alice_magicfolder, alice_clock)
1053 d.addCallback(_cleanup, self.bob_magicfolder, bob_clock)
1054 d.addCallback(lambda ign: result)
1056 d.addBoth(cleanup_Alice_and_Bob)
1060 class MockTest(MagicFolderTestMixin, unittest.TestCase):
1061 """This can run on any platform, and even if twisted.internet.inotify can't be imported."""
1064 MagicFolderTestMixin.setUp(self)
1065 self.inotify = fake_inotify
1066 self.patch(magic_folder, 'get_inotify_module', lambda: self.inotify)
1068 def notify(self, path, mask, magic=None, flush=True):
1070 magic = self.magicfolder
1071 magic.uploader._notifier.event(path, mask)
1072 # no flush for the mock test.
1074 def test_errors(self):
1077 errors_dir = abspath_expanduser_unicode(u"errors_dir", base=self.basedir)
1078 os.mkdir(errors_dir)
1079 not_a_dir = abspath_expanduser_unicode(u"NOT_A_DIR", base=self.basedir)
1080 fileutil.write(not_a_dir, "")
1081 magicfolderdb = abspath_expanduser_unicode(u"magicfolderdb", base=self.basedir)
1082 doesnotexist = abspath_expanduser_unicode(u"doesnotexist", base=self.basedir)
1084 client = self.g.clients[0]
1085 d = client.create_dirnode()
1086 def _check_errors(n):
1087 self.failUnless(IDirectoryNode.providedBy(n))
1088 upload_dircap = n.get_uri()
1089 readonly_dircap = n.get_readonly_uri()
1091 self.shouldFail(AssertionError, 'nonexistent local.directory', 'there is no directory',
1092 MagicFolder, client, upload_dircap, '', doesnotexist, magicfolderdb)
1093 self.shouldFail(AssertionError, 'non-directory local.directory', 'is not a directory',
1094 MagicFolder, client, upload_dircap, '', not_a_dir, magicfolderdb)
1095 self.shouldFail(AssertionError, 'bad upload.dircap', 'does not refer to a directory',
1096 MagicFolder, client, 'bad', '', errors_dir, magicfolderdb)
1097 self.shouldFail(AssertionError, 'non-directory upload.dircap', 'does not refer to a directory',
1098 MagicFolder, client, 'URI:LIT:foo', '', errors_dir, magicfolderdb)
1099 self.shouldFail(AssertionError, 'readonly upload.dircap', 'is not a writecap to a directory',
1100 MagicFolder, client, readonly_dircap, '', errors_dir, magicfolderdb)
1101 self.shouldFail(AssertionError, 'collective dircap', 'is not a readonly cap to a directory',
1102 MagicFolder, client, upload_dircap, upload_dircap, errors_dir, magicfolderdb)
1104 def _not_implemented():
1105 raise NotImplementedError("blah")
1106 self.patch(magic_folder, 'get_inotify_module', _not_implemented)
1107 self.shouldFail(NotImplementedError, 'unsupported', 'blah',
1108 MagicFolder, client, upload_dircap, '', errors_dir, magicfolderdb)
1109 d.addCallback(_check_errors)
1112 def test_write_downloaded_file(self):
1113 workdir = u"cli/MagicFolder/write-downloaded-file"
1114 local_file = fileutil.abspath_expanduser_unicode(os.path.join(workdir, "foobar"))
1116 class TestWriteFileMixin(WriteFileMixin):
1117 def _log(self, msg):
1120 writefile = TestWriteFileMixin()
1122 # create a file with name "foobar" with content "foo"
1123 # write downloaded file content "bar" into "foobar" with is_conflict = False
1124 fileutil.make_dirs(workdir)
1125 fileutil.write(local_file, "foo")
1127 # if is_conflict is False, then the .conflict file shouldn't exist.
1128 writefile._write_downloaded_file(local_file, "bar", False, None)
1129 conflicted_path = local_file + u".conflict"
1130 self.failIf(os.path.exists(conflicted_path))
1132 # At this point, the backup file should exist with content "foo"
1133 backup_path = local_file + u".backup"
1134 self.failUnless(os.path.exists(backup_path))
1135 self.failUnlessEqual(fileutil.read(backup_path), "foo")
1137 # .tmp file shouldn't exist
1138 self.failIf(os.path.exists(local_file + u".tmp"))
1140 # .. and the original file should have the new content
1141 self.failUnlessEqual(fileutil.read(local_file), "bar")
1143 # now a test for conflicted case
1144 writefile._write_downloaded_file(local_file, "bar", True, None)
1145 self.failUnless(os.path.exists(conflicted_path))
1147 # .tmp file shouldn't exist
1148 self.failIf(os.path.exists(local_file + u".tmp"))
1151 class RealTest(MagicFolderTestMixin, unittest.TestCase):
1152 """This is skipped unless both Twisted and the platform support inotify."""
1155 MagicFolderTestMixin.setUp(self)
1156 self.inotify = magic_folder.get_inotify_module()
1158 def notify(self, path, mask, magic=None, flush=True):
1159 # Writing to the filesystem causes the notification.
1160 # However, flushing filesystem buffers may be necessary on Windows.
1162 fileutil.flush_volume(path.path)
1165 magic_folder.get_inotify_module()
1166 except NotImplementedError:
1167 RealTest.skip = "Magic Folder support can only be tested for-real on an OS that supports inotify or equivalent."