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.util.fileutil import precondition_abspath
  12 from allmydata.scripts.common import get_aliases
  13 from allmydata.test.no_network import GridTestMixin
  14 from .test_cli import CLITestMixin
  15 from allmydata.scripts import magic_folder_cli
  16 from allmydata.util.fileutil import abspath_expanduser_unicode
  17 from allmydata.util.encodingutil import unicode_to_argv
  18 from allmydata.frontends.magic_folder import MagicFolder
  19 from allmydata import uri
  20
  21
  22 class MagicFolderCLITestMixin(CLITestMixin, GridTestMixin):
  23     def do_create_magic_folder(self, client_num):
  24         d = self.do_cli("magic-folder", "create", "magic:", client_num=client_num)
  25         def _done((rc,stdout,stderr)):
  26             self.failUnlessEqual(rc, 0)
  27             self.failUnlessIn("Alias 'magic' created", stdout)
  28             self.failUnlessEqual(stderr, "")
  29             aliases = get_aliases(self.get_clientdir(i=client_num))
  30             self.failUnlessIn("magic", aliases)
  31             self.failUnless(aliases["magic"].startswith("URI:DIR2:"))
  32         d.addCallback(_done)
  33         return d
  34
  35     def do_invite(self, client_num, nickname):
  36         nickname_arg = unicode_to_argv(nickname)
  37         d = self.do_cli("magic-folder", "invite", "magic:", nickname_arg, client_num=client_num)
  38         def _done((rc, stdout, stderr)):
  39             self.failUnlessEqual(rc, 0)
  40             return (rc, stdout, stderr)
  41         d.addCallback(_done)
  42         return d
  43
  44     def do_join(self, client_num, local_dir, invite_code):
  45         precondition(isinstance(local_dir, unicode), local_dir=local_dir)
  46         precondition(isinstance(invite_code, str), invite_code=invite_code)
  47
  48         local_dir_arg = unicode_to_argv(local_dir)
  49         d = self.do_cli("magic-folder", "join", invite_code, local_dir_arg, client_num=client_num)
  50         def _done((rc, stdout, stderr)):
  51             self.failUnlessEqual(rc, 0)
  52             return (rc, stdout, stderr)
  53         d.addCallback(_done)
  54         return d
  55
  56     def check_joined_config(self, client_num, upload_dircap):
  57         """Tests that our collective directory has the readonly cap of
  58         our upload directory.
  59         """
  60         collective_readonly_cap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/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), "private/collective_dircap"))
  76         upload_dircap = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "private/magic_folder_dircap"))
  77         self.failIf(collective_dircap is None or upload_dircap is None)
  78         return collective_dircap, upload_dircap
  79
  80     def check_config(self, client_num, local_dir):
  81         precondition_abspath(local_dir)
  82         client_config = fileutil.read(os.path.join(self.get_clientdir(i=client_num), "tahoe.cfg"))
  83         local_dir_utf8 = local_dir.encode('utf-8')
  84         ret = re.search("\[magic_folder\]\nenabled = True\nlocal.directory = %s" % (local_dir_utf8,), client_config)
  85         self.failIf(ret is None)
  86
  87     def create_invite_join_magic_folder(self, nickname, local_dir):
  88         nickname_arg = unicode_to_argv(nickname)
  89         local_dir_arg = unicode_to_argv(local_dir)
  90         d = self.do_cli("magic-folder", "create", "magic:", nickname_arg, local_dir_arg)
  91         def _done((rc, stdout, stderr)):
  92             self.failUnlessEqual(rc, 0)
  93
  94             client = self.get_client()
  95             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
  96             self.collective_dirnode = client.create_node_from_uri(self.collective_dircap)
  97             self.upload_dirnode     = client.create_node_from_uri(self.upload_dircap)
  98         d.addCallback(_done)
  99         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 100         d.addCallback(lambda ign: self.check_config(0, local_dir))
 101         return d
 102
 103     def cleanup(self, res):
 104         #print "cleanup", res
 105         d = defer.succeed(None)
 106         if self.magicfolder is not None:
 107             d.addCallback(lambda ign: self.magicfolder.finish())
 108         d.addCallback(lambda ign: res)
 109         return d
 110
 111     def init_magicfolder(self, client_num, upload_dircap, collective_dircap, local_magic_dir, clock):
 112         dbfile = abspath_expanduser_unicode(u"magicfolderdb.sqlite", base=self.get_clientdir(i=client_num))
 113         magicfolder = MagicFolder(self.get_client(client_num), upload_dircap, collective_dircap, local_magic_dir,
 114                                        dbfile, pending_delay=0.2, clock=clock)
 115         magicfolder.downloader._turn_delay = 0
 116
 117         orig = magicfolder.uploader._append_to_deque
 118         # the _append_to_deque method queues a _turn_deque, so we
 119         # immediately trigger it by wrapping _append_to_deque
 120         def wrap(*args, **kw):
 121             x = orig(*args, **kw)
 122             clock.advance(0)  # _turn_delay is always 0 for the tests
 123             return x
 124         magicfolder.uploader._append_to_deque = wrap
 125
 126         magicfolder.setServiceParent(self.get_client(client_num))
 127         magicfolder.ready()
 128         return magicfolder
 129
 130     def setup_alice_and_bob(self, alice_clock=reactor, bob_clock=reactor):
 131         self.set_up_grid(num_clients=2)
 132
 133         self.alice_magicfolder = None
 134         self.bob_magicfolder = None
 135
 136         alice_magic_dir = abspath_expanduser_unicode(u"Alice-magic", base=self.basedir)
 137         self.mkdir_nonascii(alice_magic_dir)
 138         bob_magic_dir = abspath_expanduser_unicode(u"Bob-magic", base=self.basedir)
 139         self.mkdir_nonascii(bob_magic_dir)
 140
 141         # Alice creates a Magic Folder,
 142         # invites herself then and joins.
 143         d = self.do_create_magic_folder(0)
 144         d.addCallback(lambda ign: self.do_invite(0, u"Alice\u00F8"))
 145         def get_invite_code(result):
 146             self.invite_code = result[1].strip()
 147         d.addCallback(get_invite_code)
 148         d.addCallback(lambda ign: self.do_join(0, alice_magic_dir, self.invite_code))
 149         def get_alice_caps(ign):
 150             self.alice_collective_dircap, self.alice_upload_dircap = self.get_caps_from_files(0)
 151         d.addCallback(get_alice_caps)
 152         d.addCallback(lambda ign: self.check_joined_config(0, self.alice_upload_dircap))
 153         d.addCallback(lambda ign: self.check_config(0, alice_magic_dir))
 154         def get_Alice_magicfolder(result):
 155             self.alice_magicfolder = self.init_magicfolder(0, self.alice_upload_dircap,
 156                                                            self.alice_collective_dircap,
 157                                                            alice_magic_dir, alice_clock)
 158             return result
 159         d.addCallback(get_Alice_magicfolder)
 160
 161         # Alice invites Bob. Bob joins.
 162         d.addCallback(lambda ign: self.do_invite(0, u"Bob\u00F8"))
 163         def get_invite_code(result):
 164             self.invite_code = result[1].strip()
 165         d.addCallback(get_invite_code)
 166         d.addCallback(lambda ign: self.do_join(1, bob_magic_dir, self.invite_code))
 167         def get_bob_caps(ign):
 168             self.bob_collective_dircap, self.bob_upload_dircap = self.get_caps_from_files(1)
 169         d.addCallback(get_bob_caps)
 170         d.addCallback(lambda ign: self.check_joined_config(1, self.bob_upload_dircap))
 171         d.addCallback(lambda ign: self.check_config(1, bob_magic_dir))
 172         def get_Bob_magicfolder(result):
 173             self.bob_magicfolder = self.init_magicfolder(1, self.bob_upload_dircap,
 174                                                          self.bob_collective_dircap,
 175                                                          bob_magic_dir, bob_clock)
 176             return result
 177         d.addCallback(get_Bob_magicfolder)
 178         return d
 179
 180
 181 class CreateMagicFolder(MagicFolderCLITestMixin, unittest.TestCase):
 182     def test_create_and_then_invite_join(self):
 183         self.basedir = "cli/MagicFolder/create-and-then-invite-join"
 184         self.set_up_grid()
 185         local_dir = os.path.join(self.basedir, "magic")
 186
 187         d = self.do_create_magic_folder(0)
 188         d.addCallback(lambda ign: self.do_invite(0, u"Alice"))
 189         def get_invite_code_and_join((rc, stdout, stderr)):
 190             invite_code = stdout.strip()
 191             return self.do_join(0, unicode(local_dir), invite_code)
 192         d.addCallback(get_invite_code_and_join)
 193         def get_caps(ign):
 194             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 195         d.addCallback(get_caps)
 196         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 197         d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
 198         return d
 199
 200     def test_create_error(self):
 201         self.basedir = "cli/MagicFolder/create-error"
 202         self.set_up_grid()
 203
 204         d = self.do_cli("magic-folder", "create", "m a g i c:", client_num=0)
 205         def _done((rc, stdout, stderr)):
 206             self.failIfEqual(rc, 0)
 207             self.failUnlessIn("Alias names cannot contain spaces.", stderr)
 208         d.addCallback(_done)
 209         return d
 210
 211     def test_create_invite_join(self):
 212         self.basedir = "cli/MagicFolder/create-invite-join"
 213         self.set_up_grid()
 214         local_dir = os.path.join(self.basedir, "magic")
 215
 216         d = self.do_cli("magic-folder", "create", "magic:", "Alice", local_dir)
 217         def _done((rc, stdout, stderr)):
 218             self.failUnlessEqual(rc, 0)
 219             self.collective_dircap, self.upload_dircap = self.get_caps_from_files(0)
 220         d.addCallback(_done)
 221         d.addCallback(lambda ign: self.check_joined_config(0, self.upload_dircap))
 222         d.addCallback(lambda ign: self.check_config(0, abspath_expanduser_unicode(unicode(local_dir))))
 223         return d
 224
 225     def test_create_invite_join_failure(self):
 226         self.basedir = "cli/MagicFolder/create-invite-join-failure"
 227         os.makedirs(self.basedir)
 228
 229         o = magic_folder_cli.CreateOptions()
 230         o.parent = magic_folder_cli.MagicFolderCommand()
 231         o.parent['node-directory'] = self.basedir
 232         try:
 233             o.parseArgs("magic:", "Alice", "-foo")
 234         except usage.UsageError as e:
 235             self.failUnlessIn("cannot start with '-'", str(e))
 236         else:
 237             self.fail("expected UsageError")
 238
 239     def test_join_failure(self):
 240         self.basedir = "cli/MagicFolder/create-join-failure"
 241         os.makedirs(self.basedir)
 242
 243         o = magic_folder_cli.JoinOptions()
 244         o.parent = magic_folder_cli.MagicFolderCommand()
 245         o.parent['node-directory'] = self.basedir
 246         try:
 247             o.parseArgs("URI:invite+URI:code", "-foo")
 248         except usage.UsageError as e:
 249             self.failUnlessIn("cannot start with '-'", str(e))
 250         else:
 251             self.fail("expected UsageError")