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