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.assertutil import precondition
10 from allmydata.util import fileutil
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 precondition(isinstance(local_dir, unicode), local_dir=local_dir)
45 precondition(isinstance(invite_code, str), invite_code=invite_code)
47 local_dir_arg = unicode_to_argv(local_dir)
48 d = self.do_cli("magic-folder", "join", invite_code, local_dir_arg, client_num=client_num)
49 def _done((rc, stdout, stderr)):
50 self.failUnlessEqual(rc, 0)
51 return (rc, stdout, stderr)
55 def check_joined_config(self, client_num, upload_dircap):
56 """Tests that our collective directory has the readonly cap of
59 collective_readonly_cap = fileutil.read(os.path.join(self.get_clientdir(i=client_num),
60 u"private", u"collective_dircap"))
61 d = self.do_cli("ls", "--json", collective_readonly_cap, client_num=client_num)
62 def _done((rc, stdout, stderr)):
63 self.failUnlessEqual(rc, 0)
64 return (rc, stdout, stderr)
66 def test_joined_magic_folder((rc,stdout,stderr)):
67 readonly_cap = unicode(uri.from_string(upload_dircap).get_readonly().to_string(), 'utf-8')
68 s = re.search(readonly_cap, stdout)
69 self.failUnless(s is not None)
71 d.addCallback(test_joined_magic_folder)
74 def get_caps_from_files(self, client_num):
75 collective_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num),
76 u"private", u"collective_dircap"))
77 upload_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num),
78 u"private", u"magic_folder_dircap"))
79 self.failIf(collective_dircap is None or upload_dircap is None)
80 return collective_dircap, upload_dircap
82 def check_config(self, client_num, local_dir):
83 client_config = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "tahoe.cfg"))
84 local_dir_utf8 = local_dir.encode('utf-8')
85 magic_folder_config = "[magic_folder]\nenabled = True\nlocal.directory = %s" % (local_dir_utf8,)
86 self.failUnlessIn(magic_folder_config, client_config)
88 def create_invite_join_magic_folder(self, nickname, local_dir):
89 nickname_arg = unicode_to_argv(nickname)
90 local_dir_arg = unicode_to_argv(local_dir)
91 d = self.do_cli("magic-folder", "create", "magic:", nickname_arg, local_dir_arg)
92 def _done((rc, stdout, stderr)):
93 self.failUnlessEqual(rc, 0)
95 client = self.get_client()
96 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
97 self.collective_dirnode = client.create_node_from_uri(self.collective_dircap)
98 self.upload_dirnode = client.create_node_from_uri(self.upload_dircap)
100 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
101 d.addCallback(lambda ign: self.check_config(0, local_dir))
104 def cleanup(self, res):
105 #print "cleanup", res
106 d = defer.succeed(None)
107 if self.magicfolder is not None:
108 d.addCallback(lambda ign: self.magicfolder.finish())
109 d.addCallback(lambda ign: res)
112 def init_magicfolder(self, client_num, upload_dircap, collective_dircap, local_magic_dir, clock):
113 dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.get_clientdir(i=client_num))
114 magicfolder = MagicFolder(self.get_client(client_num), upload_dircap, collective_dircap, local_magic_dir,
115 dbfile, 0077, pending_delay=0.2, clock=clock)
116 magicfolder.downloader._turn_delay = 0
118 magicfolder.setServiceParent(self.get_client(client_num))
122 def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
123 self.set_up_grid(num_clients=2)
125 self.alice_magicfolder = None
126 self.bob_magicfolder = None
128 alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
129 self.mkdir_nonascii(alice_magic_dir)
130 bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
131 self.mkdir_nonascii(bob_magic_dir)
133 # Alice creates a Magic Folder,
134 # invites herself then and joins.
135 d = self.do_create_magic_folder(0)
136 d.addCallback(lambda ign: self.do_invite(0, u"Alice\u00F8"))
137 def get_invite_code(result):
138 self.invite_code = result[1].strip()
139 d.addCallback(get_invite_code)
140 d.addCallback(lambda ign: self.do_join(0, alice_magic_dir, self.invite_code))
141 def get_alice_caps(ign):
142 self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
143 d.addCallback(get_alice_caps)
144 d.addCallback(lambda ign: self.check_joined_config(0, self.alice_upload_dircap))
145 d.addCallback(lambda ign: self.check_config(0, alice_magic_dir))
146 def get_Alice_magicfolder(result):
147 self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap,
148 self.alice_collective_dircap,
149 alice_magic_dir, alice_clock)
151 d.addCallback(get_Alice_magicfolder)
153 # Alice invites Bob. Bob joins.
154 d.addCallback(lambda ign: self.do_invite(0, u"Bob\u00F8"))
155 def get_invite_code(result):
156 self.invite_code = result[1].strip()
157 d.addCallback(get_invite_code)
158 d.addCallback(lambda ign: self.do_join(1, bob_magic_dir, self.invite_code))
159 def get_bob_caps(ign):
160 self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
161 d.addCallback(get_bob_caps)
162 d.addCallback(lambda ign: self.check_joined_config(1, self.bob_upload_dircap))
163 d.addCallback(lambda ign: self.check_config(1, bob_magic_dir))
164 def get_Bob_magicfolder(result):
165 self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap,
166 self.bob_collective_dircap,
167 bob_magic_dir, bob_clock)
169 d.addCallback(get_Bob_magicfolder)
173 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
174 def test_create_and_then_invite_join(self):
175 self.basedir = "cli/MagicFolder/create-and-then-invite-join"
177 local_dir = os.path.join(self.basedir, "magic")
178 abs_local_dir_u = abspath_expanduser_unicode(unicode(local_dir), long_path=False)
180 d = self.do_create_magic_folder(0)
181 d.addCallback(lambda ign: self.do_invite(0, u"Alice"))
182 def get_invite_code_and_join((rc, stdout, stderr)):
183 invite_code = stdout.strip()
184 return self.do_join(0, unicode(local_dir), invite_code)
185 d.addCallback(get_invite_code_and_join)
187 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
188 d.addCallback(get_caps)
189 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
190 d.addCallback(lambda ign: self.check_config(0, abs_local_dir_u))
193 def test_create_error(self):
194 self.basedir = "cli/MagicFolder/create-error"
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 local_dir = os.path.join(self.basedir, "magic")
208 abs_local_dir_u = abspath_expanduser_unicode(unicode(local_dir), long_path=False)
210 d = self.do_cli("magic-folder", "create", "magic:", "Alice", local_dir)
211 def _done((rc, stdout, stderr)):
212 self.failUnlessEqual(rc, 0)
213 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
215 d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
216 d.addCallback(lambda ign: self.check_config(0, abs_local_dir_u))
219 def test_create_invite_join_failure(self):
220 self.basedir = "cli/MagicFolder/create-invite-join-failure"
221 os.makedirs(self.basedir)
223 o = magic_folder_cli.CreateOptions()
224 o.parent = magic_folder_cli.MagicFolderCommand()
225 o.parent['node-directory'] = self.basedir
227 o.parseArgs("magic:", "Alice", "-foo")
228 except usage.UsageError as e:
229 self.failUnlessIn("cannot start with '-'", str(e))
231 self.fail("expected UsageError")
233 def test_join_failure(self):
234 self.basedir = "cli/MagicFolder/create-join-failure"
235 os.makedirs(self.basedir)
237 o = magic_folder_cli.JoinOptions()
238 o.parent = magic_folder_cli.MagicFolderCommand()
239 o.parent['node-directory'] = self.basedir
241 o.parseArgs("URI:invite+URI:code", "-foo")
242 except usage.UsageError as e:
243 self.failUnlessIn("cannot start with '-'", str(e))
245 self.fail("expected UsageError")