4 from twisted.trial import unittest
5 from twisted.internet import defer
6 from twisted.internet import reactor
7 from twisted.python import usage
9 from allmydata.util import fileutil
10 from allmydata.util.fileutil import precondition_abspath
11 from allmydata.scripts.common import get_aliases
12 from allmydata.test.no_network import GridTestMixin
13 from .test_cli import CLITestMixin
14 from allmydata.scripts import magic_folder_cli
15 from allmydata.util.fileutil import abspath_expanduser_unicode
16 from allmydata.util.encodingutil import unicode_to_argv
17 from allmydata.frontends.magic_folder import MagicFolder
18 from allmydata import uri
21 class MagicFolderCLITestMixin(CLITestMixin, GridTestMixin):
22 def do_create_magic_folder(self, client_num):
23 d = self.do_cli("magic-folder", "create", "magic:", client_num=client_num)
24 def _done((rc,stdout,stderr)):
25 self.failUnlessEqual(rc, 0)
26 self.failUnlessIn("Alias 'magic' created", stdout)
27 self.failUnlessEqual(stderr, "")
28 aliases = get_aliases(self.get_clientdir(i=client_num))
29 self.failUnlessIn("magic", aliases)
30 self.failUnless(aliases["magic"].startswith("URI:DIR2:"))
34 def do_invite(self, client_num, nickname):
35 nickname_arg = unicode_to_argv(nickname)
36 d = self.do_cli("magic-folder", "invite", "magic:", nickname_arg, client_num=client_num)
37 def _done((rc, stdout, stderr)):
38 self.failUnlessEqual(rc, 0)
39 return (rc, stdout, stderr)
43 def do_join(self, client_num, local_dir, invite_code):
44 magic_readonly_cap, dmd_write_cap = invite_code.split(magic_folder_cli.INVITE_SEPARATOR)
45 d = self.do_cli("magic-folder", "join", invite_code, local_dir, client_num=client_num)
46 def _done((rc, stdout, stderr)):
47 self.failUnlessEqual(rc, 0)
48 return (rc, stdout, stderr)
52 def check_joined_config(self, client_num, upload_dircap):
53 """Tests that our collective directory has the readonly cap of
56 collective_readonly_cap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
57 d = self.do_cli("ls", "--json", collective_readonly_cap, client_num=client_num)
58 def _done((rc, stdout, stderr)):
59 self.failUnlessEqual(rc, 0)
60 return (rc, stdout, stderr)
62 def test_joined_magic_folder((rc,stdout,stderr)):
63 readonly_cap = unicode(uri.from_string(upload_dircap).get_readonly().to_string(), 'utf-8')
64 s = re.search(readonly_cap, stdout)
65 self.failUnless(s is not None)
67 d.addCallback(test_joined_magic_folder)
70 def get_caps_from_files(self, client_num):
71 collective_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
72 upload_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/magic_folder_dircap"))
73 self.failIf(collective_dircap is None or upload_dircap is None)
74 return collective_dircap, upload_dircap
76 def check_config(self, client_num, local_dir):
77 precondition_abspath(local_dir)
78 client_config = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "tahoe.cfg"))
79 local_dir_utf8 = local_dir.encode('utf-8')
80 ret = re.search("\[magic_folder\]\nenabled = True\nlocal.directory = %s" % (local_dir_utf8,), client_config)
81 self.failIf(ret is None)
83 def create_invite_join_magic_folder(self, nickname, local_dir):
84 nickname_arg = unicode_to_argv(nickname)
85 local_dir_arg = unicode_to_argv(local_dir)
86 d = self.do_cli("magic-folder", "create", "magic:", nickname_arg, local_dir_arg)
87 def _done((rc, stdout, stderr)):
88 self.failUnlessEqual(rc, 0)
90 client = self.get_client()
91 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
92 self.collective_dirnode = client.create_node_from_uri(self.collective_dircap)
93 self.upload_dirnode = client.create_node_from_uri(self.upload_dircap)
95 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
96 d.addCallback(lambda ign: self.check_config(0, local_dir))
99 def cleanup(self, res):
100 #print "cleanup", res
101 d = defer.succeed(None)
102 if self.magicfolder is not None:
103 d.addCallback(lambda ign: self.magicfolder.finish())
104 d.addCallback(lambda ign: res)
107 def init_magicfolder(self, client_num, upload_dircap, collective_dircap, local_magic_dir, clock):
108 dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.get_clientdir(i=client_num))
109 magicfolder = MagicFolder(self.get_client(client_num), upload_dircap, collective_dircap, local_magic_dir,
110 dbfile, pending_delay=0.2, clock=clock)
111 magicfolder.downloader._turn_delay = 0
113 orig = magicfolder.uploader._append_to_deque
114 # the _append_to_deque method queues a _turn_deque, so we
115 # immediately trigger it by wrapping _append_to_deque
116 def wrap(*args, **kw):
117 x = orig(*args, **kw)
118 clock.advance(0) # _turn_delay is always 0 for the tests
120 magicfolder.uploader._append_to_deque = wrap
122 magicfolder.setServiceParent(self.get_client(client_num))
126 def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
127 self.set_up_grid(num_clients=2)
129 self.alice_magicfolder = None
130 self.bob_magicfolder = None
132 alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
133 self.mkdir_nonascii(alice_magic_dir)
134 bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
135 self.mkdir_nonascii(bob_magic_dir)
137 # Alice creates a Magic Folder,
138 # invites herself then and joins.
139 d = self.do_create_magic_folder(0)
140 d.addCallback(lambda ign: self.do_invite(0, u"Alice\u00F8"))
141 def get_invite_code(result):
142 self.invite_code = result[1].strip()
143 d.addCallback(get_invite_code)
144 d.addCallback(lambda ign: self.do_join(0, alice_magic_dir, self.invite_code))
145 def get_alice_caps(ign):
146 self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
147 d.addCallback(get_alice_caps)
148 d.addCallback(lambda ign: self.check_joined_config(0, self.alice_upload_dircap))
149 d.addCallback(lambda ign: self.check_config(0, alice_magic_dir))
150 def get_Alice_magicfolder(result):
151 self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap,
152 self.alice_collective_dircap,
153 alice_magic_dir, alice_clock)
155 d.addCallback(get_Alice_magicfolder)
157 # Alice invites Bob. Bob joins.
158 d.addCallback(lambda ign: self.do_invite(0, u"Bob\u00F8"))
159 def get_invite_code(result):
160 self.invite_code = result[1].strip()
161 d.addCallback(get_invite_code)
162 d.addCallback(lambda ign: self.do_join(1, bob_magic_dir, self.invite_code))
163 def get_bob_caps(ign):
164 self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
165 d.addCallback(get_bob_caps)
166 d.addCallback(lambda ign: self.check_joined_config(1, self.bob_upload_dircap))
167 d.addCallback(lambda ign: self.check_config(1, bob_magic_dir))
168 def get_Bob_magicfolder(result):
169 self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap,
170 self.bob_collective_dircap,
171 bob_magic_dir, bob_clock)
173 d.addCallback(get_Bob_magicfolder)
177 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
178 def test_create_and_then_invite_join(self):
179 self.basedir = "cli/MagicFolder/create-and-then-invite-join"
181 local_dir = os.path.join(self.basedir, "magic")
183 d = self.do_create_magic_folder(0)
184 d.addCallback(lambda ign: self.do_invite(0, u"Alice"))
185 def get_invite_code_and_join((rc, stdout, stderr)):
186 invite_code = stdout.strip()
187 return self.do_join(0, local_dir, invite_code)
188 d.addCallback(get_invite_code_and_join)
190 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
191 d.addCallback(get_caps)
192 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
193 d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
196 def test_create_error(self):
197 self.basedir = "cli/MagicFolder/create-error"
200 d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
201 def _done((rc, stdout, stderr)):
202 self.failIfEqual(rc, 0)
203 self.failUnlessIn("Alias names cannot contain spaces.", stderr)
207 def test_create_invite_join(self):
208 self.basedir = "cli/MagicFolder/create-invite-join"
210 local_dir = os.path.join(self.basedir, "magic")
212 d = self.do_cli("magic-folder", "create", "magic:", "Alice", local_dir)
213 def _done((rc, stdout, stderr)):
214 self.failUnlessEqual(rc, 0)
215 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
217 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
218 d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
221 def test_create_invite_join_failure(self):
222 self.basedir = "cli/MagicFolder/create-invite-join-failure"
223 os.makedirs(self.basedir)
225 o = magic_folder_cli.CreateOptions()
226 o.parent = magic_folder_cli.MagicFolderCommand()
227 o.parent['node-directory'] = self.basedir
229 o.parseArgs("magic:", "Alice", "-foo")
230 except usage.UsageError as e:
231 self.failUnlessIn("cannot start with '-'", str(e))
233 self.fail("expected UsageError")
235 def test_join_failure(self):
236 self.basedir = "cli/MagicFolder/create-join-failure"
237 os.makedirs(self.basedir)
239 o = magic_folder_cli.JoinOptions()
240 o.parent = magic_folder_cli.MagicFolderCommand()
241 o.parent['node-directory'] = self.basedir
243 o.parseArgs("URI:invite+URI:code", "-foo")
244 except usage.UsageError as e:
245 self.failUnlessIn("cannot start with '-'", str(e))
247 self.fail("expected UsageError")