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.frontends.magic_folder import MagicFolder
15 from allmydata import uri
18 class MagicFolderCLITestMixin(CLITestMixin, GridTestMixin):
20 def do_create_magic_folder(self, client_num):
21 d = self.do_cli("magic-folder", "create", "magic:", client_num=client_num)
22 def _done((rc,stdout,stderr)):
23 self.failUnlessEqual(rc, 0)
24 self.failUnlessIn("Alias 'magic' created", stdout)
25 self.failUnlessEqual(stderr, "")
26 aliases = get_aliases(self.get_clientdir(i=client_num))
27 self.failUnlessIn("magic", aliases)
28 self.failUnless(aliases["magic"].startswith("URI:DIR2:"))
32 def do_invite(self, client_num, nickname):
33 d = self.do_cli("magic-folder", "invite", u"magic:", nickname, client_num=client_num)
34 def _done((rc,stdout,stderr)):
35 self.failUnless(rc == 0)
36 return (rc,stdout,stderr)
40 def do_join(self, client_num, local_dir, invite_code):
41 magic_readonly_cap, dmd_write_cap = invite_code.split(magic_folder_cli.INVITE_SEPARATOR)
42 d = self.do_cli("magic-folder", "join", invite_code, local_dir, client_num=client_num)
43 def _done((rc,stdout,stderr)):
44 self.failUnless(rc == 0)
45 return (rc,stdout,stderr)
49 def check_joined_config(self, client_num, upload_dircap):
50 """Tests that our collective directory has the readonly cap of
53 collective_readonly_cap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
54 d = self.do_cli("ls", "--json", collective_readonly_cap, client_num=client_num)
55 def _done((rc,stdout,stderr)):
56 self.failUnless(rc == 0)
57 return (rc,stdout,stderr)
59 def test_joined_magic_folder((rc,stdout,stderr)):
60 readonly_cap = unicode(uri.from_string(upload_dircap).get_readonly().to_string(), 'utf-8')
61 s = re.search(readonly_cap, stdout)
62 self.failUnless(s is not None)
64 d.addCallback(test_joined_magic_folder)
67 def get_caps_from_files(self, client_num):
68 collective_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/collective_dircap"))
69 upload_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/magic_folder_dircap"))
70 self.failIf(collective_dircap is None or upload_dircap is None)
71 return collective_dircap, upload_dircap
73 def check_config(self, client_num, local_dir):
74 client_config = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "tahoe.cfg"))
76 local_dir = local_dir.encode('utf-8')
77 ret = re.search("\[magic_folder\]\nenabled = True\nlocal.directory = %s" % (local_dir,), client_config)
78 self.failIf(ret is None)
80 def create_invite_join_magic_folder(self, nickname, local_dir):
81 d = self.do_cli("magic-folder", "create", u"magic:", nickname, local_dir)
82 def _done((rc,stdout,stderr)):
83 self.failUnless(rc == 0)
84 return (rc,stdout,stderr)
86 def get_alice_caps(x):
87 client = self.get_client()
88 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
89 self.collective_dirnode = client.create_node_from_uri(self.collective_dircap)
90 self.upload_dirnode = client.create_node_from_uri(self.upload_dircap)
91 d.addCallback(get_alice_caps)
92 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
93 d.addCallback(lambda x: self.check_config(0, local_dir))
96 def cleanup(self, res):
98 d = defer.succeed(None)
99 if self.magicfolder is not None:
100 d.addCallback(lambda ign: self.magicfolder.finish())
101 d.addCallback(lambda ign: res)
104 def init_magicfolder(self, client_num, upload_dircap, collective_dircap, local_magic_dir, clock):
105 dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.get_clientdir(i=client_num))
106 magicfolder = MagicFolder(self.get_client(client_num), upload_dircap, collective_dircap, local_magic_dir,
107 dbfile, pending_delay=0.2, clock=clock)
108 magicfolder.downloader._turn_delay = 0
110 orig = magicfolder.uploader._append_to_deque
111 # the _append_to_deque method queues a _turn_deque, so we
112 # immediately trigger it by wrapping _append_to_deque
113 def wrap(*args, **kw):
114 x = orig(*args, **kw)
115 clock.advance(0) # _turn_delay is always 0 for the tests
117 magicfolder.uploader._append_to_deque = wrap
119 magicfolder.setServiceParent(self.get_client(client_num))
123 def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
124 self.set_up_grid(num_clients=2)
126 alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
127 self.mkdir_nonascii(alice_magic_dir)
128 bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
129 self.mkdir_nonascii(bob_magic_dir)
131 # Alice creates a Magic Folder,
132 # invites herself then and joins.
133 d = self.do_create_magic_folder(0)
134 d.addCallback(lambda x: self.do_invite(0, u"Alice\u00F8"))
135 def get_invitecode(result):
136 self.invitecode = result[1].strip()
137 d.addCallback(get_invitecode)
138 d.addCallback(lambda x: self.do_join(0, alice_magic_dir, self.invitecode))
139 def get_alice_caps(x):
140 self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
141 d.addCallback(get_alice_caps)
142 d.addCallback(lambda x: self.check_joined_config(0, self.alice_upload_dircap))
143 d.addCallback(lambda x: self.check_config(0, alice_magic_dir))
144 def get_Alice_magicfolder(result):
145 self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap, self.alice_collective_dircap, alice_magic_dir, alice_clock)
147 d.addCallback(get_Alice_magicfolder)
149 # Alice invites Bob. Bob joins.
150 d.addCallback(lambda x: self.do_invite(0, u"Bob\u00F8"))
151 def get_invitecode(result):
152 self.invitecode = result[1].strip()
153 d.addCallback(get_invitecode)
154 d.addCallback(lambda x: self.do_join(1, bob_magic_dir, self.invitecode))
156 self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
157 d.addCallback(get_bob_caps)
158 d.addCallback(lambda x: self.check_joined_config(1, self.bob_upload_dircap))
159 d.addCallback(lambda x: self.check_config(1, bob_magic_dir))
160 def get_Bob_magicfolder(result):
161 self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap, self.bob_collective_dircap, bob_magic_dir, bob_clock)
163 d.addCallback(get_Bob_magicfolder)
165 def prepare_result(result):
167 return (self.alice_collective_dircap, self.alice_upload_dircap, self.alice_magicfolder,
168 self.bob_collective_dircap, self.bob_upload_dircap, self.bob_magicfolder)
169 d.addCallback(prepare_result)
173 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
175 def test_create_and_then_invite_join(self):
176 self.basedir = "cli/MagicFolder/create-and-then-invite-join"
178 self.local_dir = os.path.join(self.basedir, "magic")
179 d = self.do_create_magic_folder(0)
180 d.addCallback(lambda x: self.do_invite(0, u"Alice"))
181 def get_invite((rc,stdout,stderr)):
182 self.invite_code = stdout.strip()
183 d.addCallback(get_invite)
184 d.addCallback(lambda x: self.do_join(0, self.local_dir, self.invite_code))
186 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
187 d.addCallback(get_caps)
188 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
189 d.addCallback(lambda x: self.check_config(0, self.local_dir))
192 def test_create_error(self):
193 self.basedir = "cli/MagicFolder/create-error"
195 self.local_dir = os.path.join(self.basedir, "magic")
196 d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
197 def _done((rc,stdout,stderr)):
198 self.failIfEqual(rc, 0)
199 self.failUnlessIn("Alias names cannot contain spaces.", stderr)
203 def test_create_invite_join(self):
204 self.basedir = "cli/MagicFolder/create-invite-join"
206 self.local_dir = os.path.join(self.basedir, "magic")
207 d = self.do_cli("magic-folder", "create", u"magic:", u"Alice", self.local_dir)
208 def _done((rc,stdout,stderr)):
209 self.failUnless(rc == 0)
210 return (rc,stdout,stderr)
213 self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
214 d.addCallback(get_caps)
215 d.addCallback(lambda x: self.check_joined_config(0, self.upload_dircap))
216 d.addCallback(lambda x: self.check_config(0, self.local_dir))