4 from twisted.trial import unittest
5 from twisted.internet import defer
6 from twisted.internet import reactor
8 from allmydata.util import fileutil
9 from allmydata.scripts.common import get_aliases
10 from allmydata.test.no_network import GridTestMixin
11 from .test_cli import CLITestMixin
12 from allmydata.scripts import magic_folder_cli
13 from allmydata.util.fileutil import abspath_expanduser_unicode
14 from allmydata.util.encodingutil import argv_to_abspath
15 from allmydata.frontends.magic_folder import MagicFolder
16 from allmydata import uri
19 class MagicFolderCLITestMixin(CLITestMixin, GridTestMixin):
21 def do_create_magic_folder(self, client_num):
22 d = self.do_cli("magic-folder", "create", "magic:", client_num=client_num)
23 def _done((rc,stdout,stderr)):
24 self.failUnlessEqual(rc, 0)
25 self.failUnlessIn("Alias 'magic' created", stdout)
26 self.failUnlessEqual(stderr, "")
27 aliases = get_aliases(self.get_clientdir(i=client_num))
28 self.failUnlessIn("magic", aliases)
29 self.failUnless(aliases["magic"].startswith("URI:DIR2:"))
33 def do_invite(self, client_num, nickname):
34 d = self.do_cli("magic-folder", "invite", u"magic:", nickname, client_num=client_num)
35 def _done((rc,stdout,stderr)):
36 self.failUnless(rc == 0)
37 return (rc,stdout,stderr)
41 def do_join(self, client_num, local_dir, invite_code):
42 magic_readonly_cap, dmd_write_cap = invite_code.split(magic_folder_cli.INVITE_SEPARATOR)
43 d = self.do_cli("magic-folder", "join", invite_code, local_dir, client_num=client_num)
44 def _done((rc,stdout,stderr)):
45 self.failUnless(rc == 0)
46 return (rc,stdout,stderr)
50 def check_joined_config(self, client_num, upload_dircap):
51 """Tests that our collective directory has the readonly cap of
54 collective_readonly_cap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
55 d = self.do_cli("ls", "--json", collective_readonly_cap, client_num=client_num)
56 def _done((rc,stdout,stderr)):
57 self.failUnless(rc == 0)
58 return (rc,stdout,stderr)
60 def test_joined_magic_folder((rc,stdout,stderr)):
61 readonly_cap = unicode(uri.from_string(upload_dircap).get_readonly().to_string(), 'utf-8')
62 s = re.search(readonly_cap, stdout)
63 self.failUnless(s is not None)
65 d.addCallback(test_joined_magic_folder)
68 def get_caps_from_files(self, client_num):
69 collective_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
70 upload_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/magic_folder_dircap"))
71 self.failIf(collective_dircap is None or upload_dircap is None)
72 return collective_dircap, upload_dircap
74 def check_config(self, client_num, local_dir):
75 client_config = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "tahoe.cfg"))
77 local_dir = local_dir.encode('utf-8')
78 ret = re.search("\[magic_folder\]\nenabled = True\nlocal.directory = %s" % (local_dir,), client_config)
79 self.failIf(ret is None)
81 def create_invite_join_magic_folder(self, nickname, local_dir):
82 d = self.do_cli("magic-folder", "create", u"magic:", nickname, local_dir)
83 def _done((rc,stdout,stderr)):
84 self.failUnless(rc == 0)
85 return (rc,stdout,stderr)
87 def get_alice_caps(x):
88 client = self.get_client()
89 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
90 self.collective_dirnode = client.create_node_from_uri(self.collective_dircap)
91 self.upload_dirnode = client.create_node_from_uri(self.upload_dircap)
92 d.addCallback(get_alice_caps)
93 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
94 d.addCallback(lambda x: self.check_config(0, local_dir))
97 def cleanup(self, res):
99 d = defer.succeed(None)
100 if self.magicfolder is not None:
101 d.addCallback(lambda ign: self.magicfolder.finish())
102 d.addCallback(lambda ign: res)
105 def init_magicfolder(self, client_num, upload_dircap, collective_dircap, local_magic_dir, clock):
106 dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.get_clientdir(i=client_num))
107 magicfolder = MagicFolder(self.get_client(client_num), upload_dircap, collective_dircap, local_magic_dir,
108 dbfile, pending_delay=0.2, clock=clock)
109 magicfolder.downloader._turn_delay = 0
111 orig = magicfolder.uploader._append_to_deque
112 # the _append_to_deque method queues a _turn_deque, so we
113 # immediately trigger it by wrapping _append_to_deque
114 def wrap(*args, **kw):
115 x = orig(*args, **kw)
116 clock.advance(0) # _turn_delay is always 0 for the tests
118 magicfolder.uploader._append_to_deque = wrap
120 magicfolder.setServiceParent(self.get_client(client_num))
124 def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
125 self.set_up_grid(num_clients=2)
127 alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
128 self.mkdir_nonascii(alice_magic_dir)
129 bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
130 self.mkdir_nonascii(bob_magic_dir)
132 # Alice creates a Magic Folder,
133 # invites herself then and joins.
134 d = self.do_create_magic_folder(0)
135 d.addCallback(lambda x: self.do_invite(0, u"Alice\u00F8"))
136 def get_invitecode(result):
137 self.invitecode = result[1].strip()
138 d.addCallback(get_invitecode)
139 d.addCallback(lambda x: self.do_join(0, alice_magic_dir, self.invitecode))
140 def get_alice_caps(x):
141 self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
142 d.addCallback(get_alice_caps)
143 d.addCallback(lambda x: self.check_joined_config(0, self.alice_upload_dircap))
144 d.addCallback(lambda x: self.check_config(0, alice_magic_dir))
145 def get_Alice_magicfolder(result):
146 self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap, self.alice_collective_dircap, alice_magic_dir, alice_clock)
148 d.addCallback(get_Alice_magicfolder)
150 # Alice invites Bob. Bob joins.
151 d.addCallback(lambda x: self.do_invite(0, u"Bob\u00F8"))
152 def get_invitecode(result):
153 self.invitecode = result[1].strip()
154 d.addCallback(get_invitecode)
155 d.addCallback(lambda x: self.do_join(1, bob_magic_dir, self.invitecode))
157 self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
158 d.addCallback(get_bob_caps)
159 d.addCallback(lambda x: self.check_joined_config(1, self.bob_upload_dircap))
160 d.addCallback(lambda x: self.check_config(1, bob_magic_dir))
161 def get_Bob_magicfolder(result):
162 self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap, self.bob_collective_dircap, bob_magic_dir, bob_clock)
164 d.addCallback(get_Bob_magicfolder)
166 def prepare_result(result):
168 return (self.alice_collective_dircap, self.alice_upload_dircap, self.alice_magicfolder,
169 self.bob_collective_dircap, self.bob_upload_dircap, self.bob_magicfolder)
170 d.addCallback(prepare_result)
174 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
176 def test_create_and_then_invite_join(self):
177 self.basedir = "cli/MagicFolder/create-and-then-invite-join"
179 self.local_dir = argv_to_abspath(os.path.join(self.basedir, "magic"))
180 d = self.do_create_magic_folder(0)
181 d.addCallback(lambda x: self.do_invite(0, u"Alice"))
182 def get_invite((rc,stdout,stderr)):
183 self.invite_code = stdout.strip()
184 d.addCallback(get_invite)
185 d.addCallback(lambda x: self.do_join(0, self.local_dir, self.invite_code))
187 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
188 d.addCallback(get_caps)
189 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
190 d.addCallback(lambda x: self.check_config(0, self.local_dir))
193 def test_create_error(self):
194 self.basedir = "cli/MagicFolder/create-error"
196 self.local_dir = os.path.join(self.basedir, "magic")
197 d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
198 def _done((rc,stdout,stderr)):
199 self.failIfEqual(rc, 0)
200 self.failUnlessIn("Alias names cannot contain spaces.", stderr)
204 def test_create_invite_join(self):
205 self.basedir = "cli/MagicFolder/create-invite-join"
207 self.local_dir = os.path.join(self.basedir, "magic")
208 d = self.do_cli("magic-folder", "create", u"magic:", u"Alice", self.local_dir)
209 def _done((rc,stdout,stderr)):
210 self.failUnless(rc == 0)
211 return (rc,stdout,stderr)
214 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
215 d.addCallback(get_caps)
216 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
217 d.addCallback(lambda x: self.check_config(0, self.local_dir))
220 def test_create_invite_join_failure(self):
221 self.basedir = "cli/MagicFolder/create-invite-join-failure"
223 self.local_dir = os.path.join(self.basedir, "magic")
224 self.local_dir = argv_to_abspath("-" + self.local_dir)
225 d = self.do_cli("magic-folder", "create", u"magic:", u"Alice", self.local_dir)
226 def _done((rc,stdout,stderr)):
227 print "rc %s" % (rc,)
228 print "stdout %s" % (stdout,)
229 print "stderr %s" % (stderr,)
230 self.failUnless(rc == 1)
231 return (rc,stdout,stderr)