src/allmydata/test/test_cli_magic_folder.py

   1 import os.path
   2 import re
   3
   4 from twisted.trial import unittest
   5 from twisted.internet import defer
   6 from twisted.internet import reactor
   7 from twisted.python import usage
   8
   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
  19
  20
  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:"))
  31         d.addCallback(_done)
  32         return d
  33
  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.failUnless(rc == 0)
  39             return (rc,stdout,stderr)
  40         d.addCallback(_done)
  41         return d
  42
  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.failUnless(rc == 0)
  48             return (rc,stdout,stderr)
  49         d.addCallback(_done)
  50         return d
  51
  52     def check_joined_config(self, client_num, upload_dircap):
  53         """Tests that our collective directory has the readonly cap of
  54         our upload directory.
  55         """
  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.failUnless(rc == 0)
  60             return (rc,stdout,stderr)
  61         d.addCallback(_done)
  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)
  66             return None
  67         d.addCallback(test_joined_magic_folder)
  68         return d
  69
  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
  75
  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)
  82
  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.failUnless(rc == 0)
  89
  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)
  94         d.addCallback(_done)
  95         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
  96         d.addCallback(lambda ign: self.check_config(0, local_dir))
  97         return d
  98
  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)
 105         return d
 106
 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
 112
 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
 119             return x
 120         magicfolder.uploader._append_to_deque = wrap
 121
 122         magicfolder.setServiceParent(self.get_client(client_num))
 123         magicfolder.ready()
 124         return magicfolder
 125
 126     def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
 127         self.set_up_grid(num_clients=2)
 128
 129         alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
 130         self.mkdir_nonascii(alice_magic_dir)
 131         bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
 132         self.mkdir_nonascii(bob_magic_dir)
 133
 134         # Alice creates a Magic Folder,
 135         # invites herself then and joins.
 136         d = self.do_create_magic_folder(0)
 137         d.addCallback(lambda ign: self.do_invite(0, u"Alice\u00F8"))
 138         def get_invitecode(result):
 139             self.invitecode = result[1].strip()
 140         d.addCallback(get_invitecode)
 141         d.addCallback(lambda ign: self.do_join(0, alice_magic_dir, self.invitecode))
 142         def get_alice_caps(ign):
 143             self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
 144         d.addCallback(get_alice_caps)
 145         d.addCallback(lambda ign: self.check_joined_config(0, self.alice_upload_dircap))
 146         d.addCallback(lambda ign: self.check_config(0, alice_magic_dir))
 147         def get_Alice_magicfolder(result):
 148             self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap,
 149                                                            self.alice_collective_dircap,
 150                                                            alice_magic_dir, alice_clock)
 151             return result
 152         d.addCallback(get_Alice_magicfolder)
 153
 154         # Alice invites Bob. Bob joins.
 155         d.addCallback(lambda ign: self.do_invite(0, u"Bob\u00F8"))
 156         def get_invitecode(result):
 157             self.invitecode = result[1].strip()
 158         d.addCallback(get_invitecode)
 159         d.addCallback(lambda ign: self.do_join(1, bob_magic_dir, self.invitecode))
 160         def get_bob_caps(ign):
 161             self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
 162         d.addCallback(get_bob_caps)
 163         d.addCallback(lambda ign: self.check_joined_config(1, self.bob_upload_dircap))
 164         d.addCallback(lambda ign: self.check_config(1, bob_magic_dir))
 165         def get_Bob_magicfolder(result):
 166             self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap,
 167                                                          self.bob_collective_dircap,
 168                                                          bob_magic_dir, bob_clock)
 169             return result
 170         d.addCallback(get_Bob_magicfolder)
 171
 172         def prepare_result(result):
 173             # XXX improve this
 174             return (self.alice_collective_dircap, self.alice_upload_dircap, self.alice_magicfolder,
 175                     self.bob_collective_dircap,   self.bob_upload_dircap,   self.bob_magicfolder)
 176         d.addCallback(prepare_result)
 177         return d
 178
 179
 180 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
 181     def test_create_and_then_invite_join(self):
 182         self.basedir = "cli/MagicFolder/create-and-then-invite-join"
 183         self.set_up_grid()
 184         local_dir = os.path.join(self.basedir, "magic")
 185
 186         d = self.do_create_magic_folder(0)
 187         d.addCallback(lambda ign: self.do_invite(0, u"Alice"))
 188         def get_invite_code_and_join((rc, stdout, stderr)):
 189             invite_code = stdout.strip()
 190             return self.do_join(0, local_dir, invite_code)
 191         d.addCallback(get_invite_code_and_join)
 192         def get_caps(ign):
 193             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 194         d.addCallback(get_caps)
 195         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 196         d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
 197         return d
 198
 199     def test_create_error(self):
 200         self.basedir = "cli/MagicFolder/create-error"
 201         self.set_up_grid()
 202
 203         d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
 204         def _done((rc, stdout, stderr)):
 205             self.failIfEqual(rc, 0)
 206             self.failUnlessIn("Alias names cannot contain spaces.", stderr)
 207         d.addCallback(_done)
 208         return d
 209
 210     def test_create_invite_join(self):
 211         self.basedir = "cli/MagicFolder/create-invite-join"
 212         self.set_up_grid()
 213         local_dir = os.path.join(self.basedir, "magic")
 214
 215         d = self.do_cli("magic-folder", "create", "magic:", "Alice", local_dir)
 216         def _done((rc, stdout, stderr)):
 217             self.failUnless(rc == 0)
 218         d.addCallback(_done)
 219         def get_caps(ign):
 220             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 221         d.addCallback(get_caps)
 222         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 223         d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
 224         return d
 225
 226     def test_create_invite_join_failure(self):
 227         self.basedir = "cli/MagicFolder/create-invite-join-failure"
 228         os.makedirs(self.basedir)
 229
 230         o = magic_folder_cli.CreateOptions()
 231         o.parent = magic_folder_cli.MagicFolderCommand()
 232         o.parent['node-directory'] = self.basedir
 233         try:
 234             o.parseArgs("magic:", "Alice", "-foo")
 235         except usage.UsageError as e:
 236             self.failUnlessIn("cannot start with '-'", str(e))
 237         else:
 238             self.fail("expected UsageError")
 239
 240     def test_join_failure(self):
 241         self.basedir = "cli/MagicFolder/create-join-failure"
 242         os.makedirs(self.basedir)
 243
 244         o = magic_folder_cli.JoinOptions()
 245         o.parent = magic_folder_cli.MagicFolderCommand()
 246         o.parent['node-directory'] = self.basedir
 247         try:
 248             o.parseArgs("URI:invite+URI:code", "-foo")
 249         except usage.UsageError as e:
 250             self.failUnlessIn("cannot start with '-'", str(e))
 251         else:
 252             self.fail("expected UsageError")