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.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
  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.failUnlessEqual(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         precondition(isinstance(local_dir, unicode), local_dir=local_dir)
  45         precondition(isinstance(invite_code, str), invite_code=invite_code)
  46
  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)
  52         d.addCallback(_done)
  53         return d
  54
  55     def check_joined_config(self, client_num, upload_dircap):
  56         """Tests that our collective directory has the readonly cap of
  57         our upload directory.
  58         """
  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)
  65         d.addCallback(_done)
  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)
  70             return None
  71         d.addCallback(test_joined_magic_folder)
  72         return d
  73
  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
  81
  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)
  87
  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)
  94
  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)
  99         d.addCallback(_done)
 100         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 101         d.addCallback(lambda ign: self.check_config(0, local_dir))
 102         return d
 103
 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)
 110         return d
 111
 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, pending_delay=0.2, clock=clock)
 116         magicfolder.downloader._turn_delay = 0
 117
 118         orig = magicfolder.uploader._append_to_deque
 119         # the _append_to_deque method queues a _turn_deque, so we
 120         # immediately trigger it by wrapping _append_to_deque
 121         def wrap(*args, **kw):
 122             x = orig(*args, **kw)
 123             clock.advance(0)  # _turn_delay is always 0 for the tests
 124             return x
 125         magicfolder.uploader._append_to_deque = wrap
 126
 127         magicfolder.setServiceParent(self.get_client(client_num))
 128         magicfolder.ready()
 129         return magicfolder
 130
 131     def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
 132         self.set_up_grid(num_clients=2)
 133
 134         self.alice_magicfolder = None
 135         self.bob_magicfolder = None
 136
 137         alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
 138         self.mkdir_nonascii(alice_magic_dir)
 139         bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
 140         self.mkdir_nonascii(bob_magic_dir)
 141
 142         # Alice creates a Magic Folder,
 143         # invites herself then and joins.
 144         d = self.do_create_magic_folder(0)
 145         d.addCallback(lambda ign: self.do_invite(0, u"Alice\u00F8"))
 146         def get_invite_code(result):
 147             self.invite_code = result[1].strip()
 148         d.addCallback(get_invite_code)
 149         d.addCallback(lambda ign: self.do_join(0, alice_magic_dir, self.invite_code))
 150         def get_alice_caps(ign):
 151             self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
 152         d.addCallback(get_alice_caps)
 153         d.addCallback(lambda ign: self.check_joined_config(0, self.alice_upload_dircap))
 154         d.addCallback(lambda ign: self.check_config(0, alice_magic_dir))
 155         def get_Alice_magicfolder(result):
 156             self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap,
 157                                                            self.alice_collective_dircap,
 158                                                            alice_magic_dir, alice_clock)
 159             return result
 160         d.addCallback(get_Alice_magicfolder)
 161
 162         # Alice invites Bob. Bob joins.
 163         d.addCallback(lambda ign: self.do_invite(0, u"Bob\u00F8"))
 164         def get_invite_code(result):
 165             self.invite_code = result[1].strip()
 166         d.addCallback(get_invite_code)
 167         d.addCallback(lambda ign: self.do_join(1, bob_magic_dir, self.invite_code))
 168         def get_bob_caps(ign):
 169             self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
 170         d.addCallback(get_bob_caps)
 171         d.addCallback(lambda ign: self.check_joined_config(1, self.bob_upload_dircap))
 172         d.addCallback(lambda ign: self.check_config(1, bob_magic_dir))
 173         def get_Bob_magicfolder(result):
 174             self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap,
 175                                                          self.bob_collective_dircap,
 176                                                          bob_magic_dir, bob_clock)
 177             return result
 178         d.addCallback(get_Bob_magicfolder)
 179         return d
 180
 181
 182 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
 183     def test_create_and_then_invite_join(self):
 184         self.basedir = "cli/MagicFolder/create-and-then-invite-join"
 185         self.set_up_grid()
 186         local_dir = os.path.join(self.basedir, "magic")
 187         abs_local_dir_u = abspath_expanduser_unicode(unicode(local_dir), long_path=False)
 188
 189         d = self.do_create_magic_folder(0)
 190         d.addCallback(lambda ign: self.do_invite(0, u"Alice"))
 191         def get_invite_code_and_join((rc, stdout, stderr)):
 192             invite_code = stdout.strip()
 193             return self.do_join(0, unicode(local_dir), invite_code)
 194         d.addCallback(get_invite_code_and_join)
 195         def get_caps(ign):
 196             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 197         d.addCallback(get_caps)
 198         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 199         d.addCallback(lambda ign: self.check_config(0, abs_local_dir_u))
 200         return d
 201
 202     def test_create_error(self):
 203         self.basedir = "cli/MagicFolder/create-error"
 204         self.set_up_grid()
 205
 206         d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
 207         def _done((rc, stdout, stderr)):
 208             self.failIfEqual(rc, 0)
 209             self.failUnlessIn("Alias names cannot contain spaces.", stderr)
 210         d.addCallback(_done)
 211         return d
 212
 213     def test_create_invite_join(self):
 214         self.basedir = "cli/MagicFolder/create-invite-join"
 215         self.set_up_grid()
 216         local_dir = os.path.join(self.basedir, "magic")
 217         abs_local_dir_u = abspath_expanduser_unicode(unicode(local_dir), long_path=False)
 218
 219         d = self.do_cli("magic-folder", "create", "magic:", "Alice", local_dir)
 220         def _done((rc, stdout, stderr)):
 221             self.failUnlessEqual(rc, 0)
 222             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 223         d.addCallback(_done)
 224         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 225         d.addCallback(lambda ign: self.check_config(0, abs_local_dir_u))
 226         return d
 227
 228     def test_create_invite_join_failure(self):
 229         self.basedir = "cli/MagicFolder/create-invite-join-failure"
 230         os.makedirs(self.basedir)
 231
 232         o = magic_folder_cli.CreateOptions()
 233         o.parent = magic_folder_cli.MagicFolderCommand()
 234         o.parent['node-directory'] = self.basedir
 235         try:
 236             o.parseArgs("magic:", "Alice", "-foo")
 237         except usage.UsageError as e:
 238             self.failUnlessIn("cannot start with '-'", str(e))
 239         else:
 240             self.fail("expected UsageError")
 241
 242     def test_join_failure(self):
 243         self.basedir = "cli/MagicFolder/create-join-failure"
 244         os.makedirs(self.basedir)
 245
 246         o = magic_folder_cli.JoinOptions()
 247         o.parent = magic_folder_cli.MagicFolderCommand()
 248         o.parent['node-directory'] = self.basedir
 249         try:
 250             o.parseArgs("URI:invite+URI:code", "-foo")
 251         except usage.UsageError as e:
 252             self.failUnlessIn("cannot start with '-'", str(e))
 253         else:
 254             self.fail("expected UsageError")