src/allmydata/test/test_cli.py

   1
   2 import os.path
   3 from twisted.trial import unittest
   4 from cStringIO import StringIO
   5 import urllib, re
   6 import simplejson
   7
   8 from mock import patch
   9
  10 from allmydata.util import fileutil, hashutil, base32
  11 from allmydata import uri
  12 from allmydata.immutable import upload
  13 from allmydata.dirnode import normalize
  14
  15 # Test that the scripts can be imported.
  16 from allmydata.scripts import create_node, debug, keygen, startstop_node, \
  17     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls, \
  18     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_unlink, tahoe_webopen
  19 _hush_pyflakes = [create_node, debug, keygen, startstop_node,
  20     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls,
  21     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_unlink, tahoe_webopen]
  22
  23 from allmydata.scripts import common
  24 from allmydata.scripts.common import DEFAULT_ALIAS, get_aliases, get_alias, \
  25      DefaultAliasMarker
  26
  27 from allmydata.scripts import cli, debug, runner, backupdb
  28 from allmydata.test.common_util import StallMixin, ReallyEqualMixin
  29 from allmydata.test.no_network import GridTestMixin
  30 from twisted.internet import threads # CLI tests use deferToThread
  31 from twisted.internet import defer # List uses a DeferredList in one place.
  32 from twisted.python import usage
  33
  34 from allmydata.util.assertutil import precondition
  35 from allmydata.util.encodingutil import listdir_unicode, unicode_platform, \
  36     quote_output, get_io_encoding, get_filesystem_encoding, \
  37     unicode_to_output, unicode_to_argv, to_str
  38 from allmydata.util.fileutil import abspath_expanduser_unicode
  39
  40 timeout = 480 # deep_check takes 360s on Zandr's linksys box, others take > 240s
  41
  42
  43 class CLITestMixin(ReallyEqualMixin):
  44     def do_cli(self, verb, *args, **kwargs):
  45         nodeargs = [
  46             "--node-directory", self.get_clientdir(),
  47             ]
  48         argv = [verb] + nodeargs + list(args)
  49         stdin = kwargs.get("stdin", "")
  50         stdout, stderr = StringIO(), StringIO()
  51         d = threads.deferToThread(runner.runner, argv, run_by_human=False,
  52                                   stdin=StringIO(stdin),
  53                                   stdout=stdout, stderr=stderr)
  54         def _done(rc):
  55             return rc, stdout.getvalue(), stderr.getvalue()
  56         d.addCallback(_done)
  57         return d
  58
  59     def skip_if_cannot_represent_filename(self, u):
  60         precondition(isinstance(u, unicode))
  61
  62         enc = get_filesystem_encoding()
  63         if not unicode_platform():
  64             try:
  65                 u.encode(enc)
  66             except UnicodeEncodeError:
  67                 raise unittest.SkipTest("A non-ASCII filename could not be encoded on this platform.")
  68
  69
  70 class CLI(CLITestMixin, unittest.TestCase):
  71     # this test case only looks at argument-processing and simple stuff.
  72     def test_options(self):
  73         fileutil.rm_dir("cli/test_options")
  74         fileutil.make_dirs("cli/test_options")
  75         fileutil.make_dirs("cli/test_options/private")
  76         fileutil.write("cli/test_options/node.url", "http://localhost:8080/\n")
  77         filenode_uri = uri.WriteableSSKFileURI(writekey="\x00"*16,
  78                                                fingerprint="\x00"*32)
  79         private_uri = uri.DirectoryURI(filenode_uri).to_string()
  80         fileutil.write("cli/test_options/private/root_dir.cap", private_uri + "\n")
  81         o = cli.ListOptions()
  82         o.parseOptions(["--node-directory", "cli/test_options"])
  83         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
  84         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], private_uri)
  85         self.failUnlessReallyEqual(o.where, u"")
  86
  87         o = cli.ListOptions()
  88         o.parseOptions(["--node-directory", "cli/test_options",
  89                         "--node-url", "http://example.org:8111/"])
  90         self.failUnlessReallyEqual(o['node-url'], "http://example.org:8111/")
  91         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], private_uri)
  92         self.failUnlessReallyEqual(o.where, u"")
  93
  94         o = cli.ListOptions()
  95         o.parseOptions(["--node-directory", "cli/test_options",
  96                         "--dir-cap", "root"])
  97         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
  98         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], "root")
  99         self.failUnlessReallyEqual(o.where, u"")
 100
 101         o = cli.ListOptions()
 102         other_filenode_uri = uri.WriteableSSKFileURI(writekey="\x11"*16,
 103                                                      fingerprint="\x11"*32)
 104         other_uri = uri.DirectoryURI(other_filenode_uri).to_string()
 105         o.parseOptions(["--node-directory", "cli/test_options",
 106                         "--dir-cap", other_uri])
 107         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
 108         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], other_uri)
 109         self.failUnlessReallyEqual(o.where, u"")
 110
 111         o = cli.ListOptions()
 112         o.parseOptions(["--node-directory", "cli/test_options",
 113                         "--dir-cap", other_uri, "subdir"])
 114         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
 115         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], other_uri)
 116         self.failUnlessReallyEqual(o.where, u"subdir")
 117
 118         o = cli.ListOptions()
 119         self.failUnlessRaises(usage.UsageError,
 120                               o.parseOptions,
 121                               ["--node-directory", "cli/test_options",
 122                                "--node-url", "NOT-A-URL"])
 123
 124         o = cli.ListOptions()
 125         o.parseOptions(["--node-directory", "cli/test_options",
 126                         "--node-url", "http://localhost:8080"])
 127         self.failUnlessReallyEqual(o["node-url"], "http://localhost:8080/")
 128
 129         o = cli.ListOptions()
 130         o.parseOptions(["--node-directory", "cli/test_options",
 131                         "--node-url", "https://localhost/"])
 132         self.failUnlessReallyEqual(o["node-url"], "https://localhost/")
 133
 134     def _dump_cap(self, *args):
 135         config = debug.DumpCapOptions()
 136         config.stdout,config.stderr = StringIO(), StringIO()
 137         config.parseOptions(args)
 138         debug.dump_cap(config)
 139         self.failIf(config.stderr.getvalue())
 140         output = config.stdout.getvalue()
 141         return output
 142
 143     def test_dump_cap_chk(self):
 144         key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
 145         uri_extension_hash = hashutil.uri_extension_hash("stuff")
 146         needed_shares = 25
 147         total_shares = 100
 148         size = 1234
 149         u = uri.CHKFileURI(key=key,
 150                            uri_extension_hash=uri_extension_hash,
 151                            needed_shares=needed_shares,
 152                            total_shares=total_shares,
 153                            size=size)
 154         output = self._dump_cap(u.to_string())
 155         self.failUnless("CHK File:" in output, output)
 156         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
 157         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 158         self.failUnless("size: 1234" in output, output)
 159         self.failUnless("k/N: 25/100" in output, output)
 160         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 161
 162         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 163                                 u.to_string())
 164         self.failUnless("client renewal secret: znxmki5zdibb5qlt46xbdvk2t55j7hibejq3i5ijyurkr6m6jkhq" in output, output)
 165
 166         output = self._dump_cap(u.get_verify_cap().to_string())
 167         self.failIf("key: " in output, output)
 168         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 169         self.failUnless("size: 1234" in output, output)
 170         self.failUnless("k/N: 25/100" in output, output)
 171         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 172
 173         prefixed_u = "http://127.0.0.1/uri/%s" % urllib.quote(u.to_string())
 174         output = self._dump_cap(prefixed_u)
 175         self.failUnless("CHK File:" in output, output)
 176         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
 177         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 178         self.failUnless("size: 1234" in output, output)
 179         self.failUnless("k/N: 25/100" in output, output)
 180         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 181
 182     def test_dump_cap_lit(self):
 183         u = uri.LiteralFileURI("this is some data")
 184         output = self._dump_cap(u.to_string())
 185         self.failUnless("Literal File URI:" in output, output)
 186         self.failUnless("data: 'this is some data'" in output, output)
 187
 188     def test_dump_cap_ssk(self):
 189         writekey = "\x01" * 16
 190         fingerprint = "\xfe" * 32
 191         u = uri.WriteableSSKFileURI(writekey, fingerprint)
 192
 193         output = self._dump_cap(u.to_string())
 194         self.failUnless("SSK Writeable URI:" in output, output)
 195         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output, output)
 196         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 197         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 198         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 199
 200         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 201                                 u.to_string())
 202         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 203
 204         fileutil.make_dirs("cli/test_dump_cap/private")
 205         fileutil.write("cli/test_dump_cap/private/secret", "5s33nk3qpvnj2fw3z4mnm2y6fa\n")
 206         output = self._dump_cap("--client-dir", "cli/test_dump_cap",
 207                                 u.to_string())
 208         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 209
 210         output = self._dump_cap("--client-dir", "cli/test_dump_cap_BOGUS",
 211                                 u.to_string())
 212         self.failIf("file renewal secret:" in output, output)
 213
 214         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 215                                 u.to_string())
 216         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 217         self.failIf("file renewal secret:" in output, output)
 218
 219         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 220                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 221                                 u.to_string())
 222         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 223         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 224         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 225
 226         u = u.get_readonly()
 227         output = self._dump_cap(u.to_string())
 228         self.failUnless("SSK Read-only URI:" in output, output)
 229         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 230         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 231         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 232
 233         u = u.get_verify_cap()
 234         output = self._dump_cap(u.to_string())
 235         self.failUnless("SSK Verifier URI:" in output, output)
 236         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 237         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 238
 239     def test_dump_cap_directory(self):
 240         writekey = "\x01" * 16
 241         fingerprint = "\xfe" * 32
 242         u1 = uri.WriteableSSKFileURI(writekey, fingerprint)
 243         u = uri.DirectoryURI(u1)
 244
 245         output = self._dump_cap(u.to_string())
 246         self.failUnless("Directory Writeable URI:" in output, output)
 247         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output,
 248                         output)
 249         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 250         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output,
 251                         output)
 252         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 253
 254         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 255                                 u.to_string())
 256         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 257
 258         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 259                                 u.to_string())
 260         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 261         self.failIf("file renewal secret:" in output, output)
 262
 263         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 264                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 265                                 u.to_string())
 266         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 267         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 268         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 269
 270         u = u.get_readonly()
 271         output = self._dump_cap(u.to_string())
 272         self.failUnless("Directory Read-only URI:" in output, output)
 273         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 274         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 275         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 276
 277         u = u.get_verify_cap()
 278         output = self._dump_cap(u.to_string())
 279         self.failUnless("Directory Verifier URI:" in output, output)
 280         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 281         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 282
 283     def _catalog_shares(self, *basedirs):
 284         o = debug.CatalogSharesOptions()
 285         o.stdout,o.stderr = StringIO(), StringIO()
 286         args = list(basedirs)
 287         o.parseOptions(args)
 288         debug.catalog_shares(o)
 289         out = o.stdout.getvalue()
 290         err = o.stderr.getvalue()
 291         return out, err
 292
 293     def test_catalog_shares_error(self):
 294         nodedir1 = "cli/test_catalog_shares/node1"
 295         sharedir = os.path.join(nodedir1, "storage", "shares", "mq", "mqfblse6m5a6dh45isu2cg7oji")
 296         fileutil.make_dirs(sharedir)
 297         fileutil.write("cli/test_catalog_shares/node1/storage/shares/mq/not-a-dir", "")
 298         # write a bogus share that looks a little bit like CHK
 299         fileutil.write(os.path.join(sharedir, "8"),
 300                        "\x00\x00\x00\x01" + "\xff" * 200) # this triggers an assert
 301
 302         nodedir2 = "cli/test_catalog_shares/node2"
 303         fileutil.make_dirs(nodedir2)
 304         fileutil.write("cli/test_catalog_shares/node1/storage/shares/not-a-dir", "")
 305
 306         # now make sure that the 'catalog-shares' commands survives the error
 307         out, err = self._catalog_shares(nodedir1, nodedir2)
 308         self.failUnlessReallyEqual(out, "", out)
 309         self.failUnless("Error processing " in err,
 310                         "didn't see 'error processing' in '%s'" % err)
 311         #self.failUnless(nodedir1 in err,
 312         #                "didn't see '%s' in '%s'" % (nodedir1, err))
 313         # windows mangles the path, and os.path.join isn't enough to make
 314         # up for it, so just look for individual strings
 315         self.failUnless("node1" in err,
 316                         "didn't see 'node1' in '%s'" % err)
 317         self.failUnless("mqfblse6m5a6dh45isu2cg7oji" in err,
 318                         "didn't see 'mqfblse6m5a6dh45isu2cg7oji' in '%s'" % err)
 319
 320     def test_alias(self):
 321         aliases = {"tahoe": "TA",
 322                    "work": "WA",
 323                    "c": "CA"}
 324         def ga1(path):
 325             return get_alias(aliases, path, u"tahoe")
 326         uses_lettercolon = common.platform_uses_lettercolon_drivename()
 327         self.failUnlessReallyEqual(ga1(u"bare"), ("TA", "bare"))
 328         self.failUnlessReallyEqual(ga1(u"baredir/file"), ("TA", "baredir/file"))
 329         self.failUnlessReallyEqual(ga1(u"baredir/file:7"), ("TA", "baredir/file:7"))
 330         self.failUnlessReallyEqual(ga1(u"tahoe:"), ("TA", ""))
 331         self.failUnlessReallyEqual(ga1(u"tahoe:file"), ("TA", "file"))
 332         self.failUnlessReallyEqual(ga1(u"tahoe:dir/file"), ("TA", "dir/file"))
 333         self.failUnlessReallyEqual(ga1(u"work:"), ("WA", ""))
 334         self.failUnlessReallyEqual(ga1(u"work:file"), ("WA", "file"))
 335         self.failUnlessReallyEqual(ga1(u"work:dir/file"), ("WA", "dir/file"))
 336         # default != None means we really expect a tahoe path, regardless of
 337         # whether we're on windows or not. This is what 'tahoe get' uses.
 338         self.failUnlessReallyEqual(ga1(u"c:"), ("CA", ""))
 339         self.failUnlessReallyEqual(ga1(u"c:file"), ("CA", "file"))
 340         self.failUnlessReallyEqual(ga1(u"c:dir/file"), ("CA", "dir/file"))
 341         self.failUnlessReallyEqual(ga1(u"URI:stuff"), ("URI:stuff", ""))
 342         self.failUnlessReallyEqual(ga1(u"URI:stuff/file"), ("URI:stuff", "file"))
 343         self.failUnlessReallyEqual(ga1(u"URI:stuff:./file"), ("URI:stuff", "file"))
 344         self.failUnlessReallyEqual(ga1(u"URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
 345         self.failUnlessReallyEqual(ga1(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 346         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:")
 347         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:dir")
 348         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:dir/file")
 349
 350         def ga2(path):
 351             return get_alias(aliases, path, None)
 352         self.failUnlessReallyEqual(ga2(u"bare"), (DefaultAliasMarker, "bare"))
 353         self.failUnlessReallyEqual(ga2(u"baredir/file"),
 354                              (DefaultAliasMarker, "baredir/file"))
 355         self.failUnlessReallyEqual(ga2(u"baredir/file:7"),
 356                              (DefaultAliasMarker, "baredir/file:7"))
 357         self.failUnlessReallyEqual(ga2(u"baredir/sub:1/file:7"),
 358                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
 359         self.failUnlessReallyEqual(ga2(u"tahoe:"), ("TA", ""))
 360         self.failUnlessReallyEqual(ga2(u"tahoe:file"), ("TA", "file"))
 361         self.failUnlessReallyEqual(ga2(u"tahoe:dir/file"), ("TA", "dir/file"))
 362         # on windows, we really want c:foo to indicate a local file.
 363         # default==None is what 'tahoe cp' uses.
 364         if uses_lettercolon:
 365             self.failUnlessReallyEqual(ga2(u"c:"), (DefaultAliasMarker, "c:"))
 366             self.failUnlessReallyEqual(ga2(u"c:file"), (DefaultAliasMarker, "c:file"))
 367             self.failUnlessReallyEqual(ga2(u"c:dir/file"),
 368                                  (DefaultAliasMarker, "c:dir/file"))
 369         else:
 370             self.failUnlessReallyEqual(ga2(u"c:"), ("CA", ""))
 371             self.failUnlessReallyEqual(ga2(u"c:file"), ("CA", "file"))
 372             self.failUnlessReallyEqual(ga2(u"c:dir/file"), ("CA", "dir/file"))
 373         self.failUnlessReallyEqual(ga2(u"work:"), ("WA", ""))
 374         self.failUnlessReallyEqual(ga2(u"work:file"), ("WA", "file"))
 375         self.failUnlessReallyEqual(ga2(u"work:dir/file"), ("WA", "dir/file"))
 376         self.failUnlessReallyEqual(ga2(u"URI:stuff"), ("URI:stuff", ""))
 377         self.failUnlessReallyEqual(ga2(u"URI:stuff/file"), ("URI:stuff", "file"))
 378         self.failUnlessReallyEqual(ga2(u"URI:stuff:./file"), ("URI:stuff", "file"))
 379         self.failUnlessReallyEqual(ga2(u"URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
 380         self.failUnlessReallyEqual(ga2(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 381         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:")
 382         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:dir")
 383         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:dir/file")
 384
 385         def ga3(path):
 386             old = common.pretend_platform_uses_lettercolon
 387             try:
 388                 common.pretend_platform_uses_lettercolon = True
 389                 retval = get_alias(aliases, path, None)
 390             finally:
 391                 common.pretend_platform_uses_lettercolon = old
 392             return retval
 393         self.failUnlessReallyEqual(ga3(u"bare"), (DefaultAliasMarker, "bare"))
 394         self.failUnlessReallyEqual(ga3(u"baredir/file"),
 395                              (DefaultAliasMarker, "baredir/file"))
 396         self.failUnlessReallyEqual(ga3(u"baredir/file:7"),
 397                              (DefaultAliasMarker, "baredir/file:7"))
 398         self.failUnlessReallyEqual(ga3(u"baredir/sub:1/file:7"),
 399                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
 400         self.failUnlessReallyEqual(ga3(u"tahoe:"), ("TA", ""))
 401         self.failUnlessReallyEqual(ga3(u"tahoe:file"), ("TA", "file"))
 402         self.failUnlessReallyEqual(ga3(u"tahoe:dir/file"), ("TA", "dir/file"))
 403         self.failUnlessReallyEqual(ga3(u"c:"), (DefaultAliasMarker, "c:"))
 404         self.failUnlessReallyEqual(ga3(u"c:file"), (DefaultAliasMarker, "c:file"))
 405         self.failUnlessReallyEqual(ga3(u"c:dir/file"),
 406                              (DefaultAliasMarker, "c:dir/file"))
 407         self.failUnlessReallyEqual(ga3(u"work:"), ("WA", ""))
 408         self.failUnlessReallyEqual(ga3(u"work:file"), ("WA", "file"))
 409         self.failUnlessReallyEqual(ga3(u"work:dir/file"), ("WA", "dir/file"))
 410         self.failUnlessReallyEqual(ga3(u"URI:stuff"), ("URI:stuff", ""))
 411         self.failUnlessReallyEqual(ga3(u"URI:stuff:./file"), ("URI:stuff", "file"))
 412         self.failUnlessReallyEqual(ga3(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 413         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:")
 414         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:dir")
 415         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:dir/file")
 416         # calling get_alias with a path that doesn't include an alias and
 417         # default set to something that isn't in the aliases argument should
 418         # raise an UnknownAliasError.
 419         def ga4(path):
 420             return get_alias(aliases, path, u"badddefault:")
 421         self.failUnlessRaises(common.UnknownAliasError, ga4, u"afile")
 422         self.failUnlessRaises(common.UnknownAliasError, ga4, u"a/dir/path/")
 423
 424         def ga5(path):
 425             old = common.pretend_platform_uses_lettercolon
 426             try:
 427                 common.pretend_platform_uses_lettercolon = True
 428                 retval = get_alias(aliases, path, u"baddefault:")
 429             finally:
 430                 common.pretend_platform_uses_lettercolon = old
 431             return retval
 432         self.failUnlessRaises(common.UnknownAliasError, ga5, u"C:\\Windows")
 433
 434     def test_listdir_unicode_good(self):
 435         filenames = [u'L\u00F4zane', u'Bern', u'Gen\u00E8ve']  # must be NFC
 436
 437         for name in filenames:
 438             self.skip_if_cannot_represent_filename(name)
 439
 440         basedir = "cli/common/listdir_unicode_good"
 441         fileutil.make_dirs(basedir)
 442
 443         for name in filenames:
 444             open(os.path.join(unicode(basedir), name), "wb").close()
 445
 446         for file in listdir_unicode(unicode(basedir)):
 447             self.failUnlessIn(normalize(file), filenames)
 448
 449
 450 class Help(unittest.TestCase):
 451     def test_get(self):
 452         help = str(cli.GetOptions())
 453         self.failUnlessIn(" get [options] REMOTE_FILE LOCAL_FILE", help)
 454         self.failUnlessIn("% tahoe get FOO |less", help)
 455
 456     def test_put(self):
 457         help = str(cli.PutOptions())
 458         self.failUnlessIn(" put [options] LOCAL_FILE REMOTE_FILE", help)
 459         self.failUnlessIn("% cat FILE | tahoe put", help)
 460
 461     def test_unlink(self):
 462         help = str(cli.UnlinkOptions())
 463         self.failUnlessIn(" unlink [options] REMOTE_FILE", help)
 464
 465     def test_rm(self):
 466         help = str(cli.RmOptions())
 467         self.failUnlessIn(" rm [options] REMOTE_FILE", help)
 468
 469     def test_mv(self):
 470         help = str(cli.MvOptions())
 471         self.failUnlessIn(" mv [options] FROM TO", help)
 472         self.failUnlessIn("Use 'tahoe mv' to move files", help)
 473
 474     def test_cp(self):
 475         help = str(cli.CpOptions())
 476         self.failUnlessIn(" cp [options] FROM.. TO", help)
 477         self.failUnlessIn("Use 'tahoe cp' to copy files", help)
 478
 479     def test_ln(self):
 480         help = str(cli.LnOptions())
 481         self.failUnlessIn(" ln [options] FROM_LINK TO_LINK", help)
 482         self.failUnlessIn("Use 'tahoe ln' to duplicate a link", help)
 483
 484     def test_mkdir(self):
 485         help = str(cli.MakeDirectoryOptions())
 486         self.failUnlessIn(" mkdir [options] [REMOTE_DIR]", help)
 487         self.failUnlessIn("Create a new directory", help)
 488
 489     def test_backup(self):
 490         help = str(cli.BackupOptions())
 491         self.failUnlessIn(" backup [options] FROM ALIAS:TO", help)
 492
 493     def test_webopen(self):
 494         help = str(cli.WebopenOptions())
 495         self.failUnlessIn(" webopen [options] [ALIAS:PATH]", help)
 496
 497     def test_manifest(self):
 498         help = str(cli.ManifestOptions())
 499         self.failUnlessIn(" manifest [options] [ALIAS:PATH]", help)
 500
 501     def test_stats(self):
 502         help = str(cli.StatsOptions())
 503         self.failUnlessIn(" stats [options] [ALIAS:PATH]", help)
 504
 505     def test_check(self):
 506         help = str(cli.CheckOptions())
 507         self.failUnlessIn(" check [options] [ALIAS:PATH]", help)
 508
 509     def test_deep_check(self):
 510         help = str(cli.DeepCheckOptions())
 511         self.failUnlessIn(" deep-check [options] [ALIAS:PATH]", help)
 512
 513     def test_create_alias(self):
 514         help = str(cli.CreateAliasOptions())
 515         self.failUnlessIn(" create-alias [options] ALIAS[:]", help)
 516
 517     def test_add_alias(self):
 518         help = str(cli.AddAliasOptions())
 519         self.failUnlessIn(" add-alias [options] ALIAS[:] DIRCAP", help)
 520
 521     def test_list_aliases(self):
 522         help = str(cli.ListAliasesOptions())
 523         self.failUnlessIn(" list-aliases [options]", help)
 524
 525     def test_start(self):
 526         help = str(startstop_node.StartOptions())
 527         self.failUnlessIn(" start [options] [NODEDIR]", help)
 528
 529     def test_stop(self):
 530         help = str(startstop_node.StopOptions())
 531         self.failUnlessIn(" stop [options] [NODEDIR]", help)
 532
 533     def test_restart(self):
 534         help = str(startstop_node.RestartOptions())
 535         self.failUnlessIn(" restart [options] [NODEDIR]", help)
 536
 537     def test_run(self):
 538         help = str(startstop_node.RunOptions())
 539         self.failUnlessIn(" run [options] [NODEDIR]", help)
 540
 541     def test_create_client(self):
 542         help = str(create_node.CreateClientOptions())
 543         self.failUnlessIn(" create-client [options] [NODEDIR]", help)
 544
 545     def test_create_node(self):
 546         help = str(create_node.CreateNodeOptions())
 547         self.failUnlessIn(" create-node [options] [NODEDIR]", help)
 548
 549     def test_create_introducer(self):
 550         help = str(create_node.CreateIntroducerOptions())
 551         self.failUnlessIn(" create-introducer [options] NODEDIR", help)
 552
 553     def test_debug_trial(self):
 554         help = str(debug.TrialOptions())
 555         self.failUnlessIn(" debug trial [options] [[file|package|module|TestCase|testmethod]...]", help)
 556         self.failUnlessIn("The 'tahoe debug trial' command uses the correct imports", help)
 557
 558
 559 class CreateAlias(GridTestMixin, CLITestMixin, unittest.TestCase):
 560
 561     def _test_webopen(self, args, expected_url):
 562         woo = cli.WebopenOptions()
 563         all_args = ["--node-directory", self.get_clientdir()] + list(args)
 564         woo.parseOptions(all_args)
 565         urls = []
 566         rc = cli.webopen(woo, urls.append)
 567         self.failUnlessReallyEqual(rc, 0)
 568         self.failUnlessReallyEqual(len(urls), 1)
 569         self.failUnlessReallyEqual(urls[0], expected_url)
 570
 571     def test_create(self):
 572         self.basedir = "cli/CreateAlias/create"
 573         self.set_up_grid()
 574         aliasfile = os.path.join(self.get_clientdir(), "private", "aliases")
 575
 576         d = self.do_cli("create-alias", "tahoe")
 577         def _done((rc,stdout,stderr)):
 578             self.failUnless("Alias 'tahoe' created" in stdout)
 579             self.failIf(stderr)
 580             aliases = get_aliases(self.get_clientdir())
 581             self.failUnless("tahoe" in aliases)
 582             self.failUnless(aliases["tahoe"].startswith("URI:DIR2:"))
 583         d.addCallback(_done)
 584         d.addCallback(lambda res: self.do_cli("create-alias", "two:"))
 585
 586         def _stash_urls(res):
 587             aliases = get_aliases(self.get_clientdir())
 588             node_url_file = os.path.join(self.get_clientdir(), "node.url")
 589             nodeurl = fileutil.read(node_url_file).strip()
 590             self.welcome_url = nodeurl
 591             uribase = nodeurl + "uri/"
 592             self.tahoe_url = uribase + urllib.quote(aliases["tahoe"])
 593             self.tahoe_subdir_url = self.tahoe_url + "/subdir"
 594             self.two_url = uribase + urllib.quote(aliases["two"])
 595             self.two_uri = aliases["two"]
 596         d.addCallback(_stash_urls)
 597
 598         d.addCallback(lambda res: self.do_cli("create-alias", "two")) # dup
 599         def _check_create_duplicate((rc,stdout,stderr)):
 600             self.failIfEqual(rc, 0)
 601             self.failUnless("Alias 'two' already exists!" in stderr)
 602             aliases = get_aliases(self.get_clientdir())
 603             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 604         d.addCallback(_check_create_duplicate)
 605
 606         d.addCallback(lambda res: self.do_cli("add-alias", "added", self.two_uri))
 607         def _check_add((rc,stdout,stderr)):
 608             self.failUnlessReallyEqual(rc, 0)
 609             self.failUnless("Alias 'added' added" in stdout)
 610         d.addCallback(_check_add)
 611
 612         # check add-alias with a duplicate
 613         d.addCallback(lambda res: self.do_cli("add-alias", "two", self.two_uri))
 614         def _check_add_duplicate((rc,stdout,stderr)):
 615             self.failIfEqual(rc, 0)
 616             self.failUnless("Alias 'two' already exists!" in stderr)
 617             aliases = get_aliases(self.get_clientdir())
 618             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 619         d.addCallback(_check_add_duplicate)
 620
 621         # check create-alias and add-alias with invalid aliases
 622         def _check_invalid((rc,stdout,stderr)):
 623             self.failIfEqual(rc, 0)
 624             self.failUnlessIn("cannot contain", stderr)
 625
 626         for invalid in ['foo:bar', 'foo bar', 'foobar::']:
 627             d.addCallback(lambda res: self.do_cli("create-alias", invalid))
 628             d.addCallback(_check_invalid)
 629             d.addCallback(lambda res: self.do_cli("add-alias", invalid, self.two_uri))
 630             d.addCallback(_check_invalid)
 631
 632         def _test_urls(junk):
 633             self._test_webopen([], self.welcome_url)
 634             self._test_webopen(["/"], self.tahoe_url)
 635             self._test_webopen(["tahoe:"], self.tahoe_url)
 636             self._test_webopen(["tahoe:/"], self.tahoe_url)
 637             self._test_webopen(["tahoe:subdir"], self.tahoe_subdir_url)
 638             self._test_webopen(["-i", "tahoe:subdir"],
 639                                self.tahoe_subdir_url+"?t=info")
 640             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
 641             self._test_webopen(["tahoe:subdir/file"],
 642                                self.tahoe_subdir_url + '/file')
 643             self._test_webopen(["--info", "tahoe:subdir/file"],
 644                                self.tahoe_subdir_url + '/file?t=info')
 645             # if "file" is indeed a file, then the url produced by webopen in
 646             # this case is disallowed by the webui. but by design, webopen
 647             # passes through the mistake from the user to the resultant
 648             # webopened url
 649             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
 650             self._test_webopen(["two:"], self.two_url)
 651         d.addCallback(_test_urls)
 652
 653         def _remove_trailing_newline_and_create_alias(ign):
 654             # ticket #741 is about a manually-edited alias file (which
 655             # doesn't end in a newline) being corrupted by a subsequent
 656             # "tahoe create-alias"
 657             old = fileutil.read(aliasfile)
 658             fileutil.write(aliasfile, old.rstrip())
 659             return self.do_cli("create-alias", "un-corrupted1")
 660         d.addCallback(_remove_trailing_newline_and_create_alias)
 661         def _check_not_corrupted1((rc,stdout,stderr)):
 662             self.failUnless("Alias 'un-corrupted1' created" in stdout, stdout)
 663             self.failIf(stderr)
 664             # the old behavior was to simply append the new record, causing a
 665             # line that looked like "NAME1: CAP1NAME2: CAP2". This won't look
 666             # like a valid dircap, so get_aliases() will raise an exception.
 667             aliases = get_aliases(self.get_clientdir())
 668             self.failUnless("added" in aliases)
 669             self.failUnless(aliases["added"].startswith("URI:DIR2:"))
 670             # to be safe, let's confirm that we don't see "NAME2:" in CAP1.
 671             # No chance of a false-negative, because the hyphen in
 672             # "un-corrupted1" is not a valid base32 character.
 673             self.failIfIn("un-corrupted1:", aliases["added"])
 674             self.failUnless("un-corrupted1" in aliases)
 675             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 676         d.addCallback(_check_not_corrupted1)
 677
 678         def _remove_trailing_newline_and_add_alias(ign):
 679             # same thing, but for "tahoe add-alias"
 680             old = fileutil.read(aliasfile)
 681             fileutil.write(aliasfile, old.rstrip())
 682             return self.do_cli("add-alias", "un-corrupted2", self.two_uri)
 683         d.addCallback(_remove_trailing_newline_and_add_alias)
 684         def _check_not_corrupted((rc,stdout,stderr)):
 685             self.failUnless("Alias 'un-corrupted2' added" in stdout, stdout)
 686             self.failIf(stderr)
 687             aliases = get_aliases(self.get_clientdir())
 688             self.failUnless("un-corrupted1" in aliases)
 689             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 690             self.failIfIn("un-corrupted2:", aliases["un-corrupted1"])
 691             self.failUnless("un-corrupted2" in aliases)
 692             self.failUnless(aliases["un-corrupted2"].startswith("URI:DIR2:"))
 693         d.addCallback(_check_not_corrupted)
 694
 695     def test_create_unicode(self):
 696         self.basedir = "cli/CreateAlias/create_unicode"
 697         self.set_up_grid()
 698
 699         try:
 700             etudes_arg = u"\u00E9tudes".encode(get_io_encoding())
 701             lumiere_arg = u"lumi\u00E8re.txt".encode(get_io_encoding())
 702         except UnicodeEncodeError:
 703             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
 704
 705         d = self.do_cli("create-alias", etudes_arg)
 706         def _check_create_unicode((rc, out, err)):
 707             self.failUnlessReallyEqual(rc, 0)
 708             self.failUnlessReallyEqual(err, "")
 709             self.failUnlessIn("Alias %s created" % quote_output(u"\u00E9tudes"), out)
 710
 711             aliases = get_aliases(self.get_clientdir())
 712             self.failUnless(aliases[u"\u00E9tudes"].startswith("URI:DIR2:"))
 713         d.addCallback(_check_create_unicode)
 714
 715         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 716         def _check_ls1((rc, out, err)):
 717             self.failUnlessReallyEqual(rc, 0)
 718             self.failUnlessReallyEqual(err, "")
 719             self.failUnlessReallyEqual(out, "")
 720         d.addCallback(_check_ls1)
 721
 722         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":uploaded.txt",
 723                                               stdin="Blah blah blah"))
 724
 725         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 726         def _check_ls2((rc, out, err)):
 727             self.failUnlessReallyEqual(rc, 0)
 728             self.failUnlessReallyEqual(err, "")
 729             self.failUnlessReallyEqual(out, "uploaded.txt\n")
 730         d.addCallback(_check_ls2)
 731
 732         d.addCallback(lambda res: self.do_cli("get", etudes_arg + ":uploaded.txt"))
 733         def _check_get((rc, out, err)):
 734             self.failUnlessReallyEqual(rc, 0)
 735             self.failUnlessReallyEqual(err, "")
 736             self.failUnlessReallyEqual(out, "Blah blah blah")
 737         d.addCallback(_check_get)
 738
 739         # Ensure that an Unicode filename in an Unicode alias works as expected
 740         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":" + lumiere_arg,
 741                                               stdin="Let the sunshine In!"))
 742
 743         d.addCallback(lambda res: self.do_cli("get",
 744                                               get_aliases(self.get_clientdir())[u"\u00E9tudes"] + "/" + lumiere_arg))
 745         def _check_get2((rc, out, err)):
 746             self.failUnlessReallyEqual(rc, 0)
 747             self.failUnlessReallyEqual(err, "")
 748             self.failUnlessReallyEqual(out, "Let the sunshine In!")
 749         d.addCallback(_check_get2)
 750
 751         return d
 752
 753     # TODO: test list-aliases, including Unicode
 754
 755
 756 class Ln(GridTestMixin, CLITestMixin, unittest.TestCase):
 757     def _create_test_file(self):
 758         data = "puppies" * 1000
 759         path = os.path.join(self.basedir, "datafile")
 760         fileutil.write(path, data)
 761         self.datafile = path
 762
 763     def test_ln_without_alias(self):
 764         # if invoked without an alias when the 'tahoe' alias doesn't
 765         # exist, 'tahoe ln' should output a useful error message and not
 766         # a stack trace
 767         self.basedir = "cli/Ln/ln_without_alias"
 768         self.set_up_grid()
 769         d = self.do_cli("ln", "from", "to")
 770         def _check((rc, out, err)):
 771             self.failUnlessReallyEqual(rc, 1)
 772             self.failUnlessIn("error:", err)
 773             self.failUnlessReallyEqual(out, "")
 774         d.addCallback(_check)
 775         # Make sure that validation extends to the "to" parameter
 776         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 777         d.addCallback(lambda ign: self._create_test_file())
 778         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 779                                               "havasu:from"))
 780         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "to"))
 781         d.addCallback(_check)
 782         return d
 783
 784     def test_ln_with_nonexistent_alias(self):
 785         # If invoked with aliases that don't exist, 'tahoe ln' should
 786         # output a useful error message and not a stack trace.
 787         self.basedir = "cli/Ln/ln_with_nonexistent_alias"
 788         self.set_up_grid()
 789         d = self.do_cli("ln", "havasu:from", "havasu:to")
 790         def _check((rc, out, err)):
 791             self.failUnlessReallyEqual(rc, 1)
 792             self.failUnlessIn("error:", err)
 793         d.addCallback(_check)
 794         # Make sure that validation occurs on the to parameter if the
 795         # from parameter passes.
 796         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 797         d.addCallback(lambda ign: self._create_test_file())
 798         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 799                                               "havasu:from"))
 800         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "huron:to"))
 801         d.addCallback(_check)
 802         return d
 803
 804
 805 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
 806
 807     def test_unlinked_immutable_stdin(self):
 808         # tahoe get `echo DATA | tahoe put`
 809         # tahoe get `echo DATA | tahoe put -`
 810         self.basedir = "cli/Put/unlinked_immutable_stdin"
 811         DATA = "data" * 100
 812         self.set_up_grid()
 813         d = self.do_cli("put", stdin=DATA)
 814         def _uploaded(res):
 815             (rc, out, err) = res
 816             self.failUnlessIn("waiting for file data on stdin..", err)
 817             self.failUnlessIn("200 OK", err)
 818             self.readcap = out
 819             self.failUnless(self.readcap.startswith("URI:CHK:"))
 820         d.addCallback(_uploaded)
 821         d.addCallback(lambda res: self.do_cli("get", self.readcap))
 822         def _downloaded(res):
 823             (rc, out, err) = res
 824             self.failUnlessReallyEqual(err, "")
 825             self.failUnlessReallyEqual(out, DATA)
 826         d.addCallback(_downloaded)
 827         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
 828         d.addCallback(lambda (rc, out, err):
 829                       self.failUnlessReallyEqual(out, self.readcap))
 830         return d
 831
 832     def test_unlinked_immutable_from_file(self):
 833         # tahoe put file.txt
 834         # tahoe put ./file.txt
 835         # tahoe put /tmp/file.txt
 836         # tahoe put ~/file.txt
 837         self.basedir = "cli/Put/unlinked_immutable_from_file"
 838         self.set_up_grid()
 839
 840         rel_fn = os.path.join(self.basedir, "DATAFILE")
 841         abs_fn = unicode_to_argv(abspath_expanduser_unicode(unicode(rel_fn)))
 842         # we make the file small enough to fit in a LIT file, for speed
 843         fileutil.write(rel_fn, "short file")
 844         d = self.do_cli("put", rel_fn)
 845         def _uploaded((rc, out, err)):
 846             readcap = out
 847             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 848             self.readcap = readcap
 849         d.addCallback(_uploaded)
 850         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
 851         d.addCallback(lambda (rc,stdout,stderr):
 852                       self.failUnlessReallyEqual(stdout, self.readcap))
 853         d.addCallback(lambda res: self.do_cli("put", abs_fn))
 854         d.addCallback(lambda (rc,stdout,stderr):
 855                       self.failUnlessReallyEqual(stdout, self.readcap))
 856         # we just have to assume that ~ is handled properly
 857         return d
 858
 859     def test_immutable_from_file(self):
 860         # tahoe put file.txt uploaded.txt
 861         # tahoe - uploaded.txt
 862         # tahoe put file.txt subdir/uploaded.txt
 863         # tahoe put file.txt tahoe:uploaded.txt
 864         # tahoe put file.txt tahoe:subdir/uploaded.txt
 865         # tahoe put file.txt DIRCAP:./uploaded.txt
 866         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
 867         self.basedir = "cli/Put/immutable_from_file"
 868         self.set_up_grid()
 869
 870         rel_fn = os.path.join(self.basedir, "DATAFILE")
 871         # we make the file small enough to fit in a LIT file, for speed
 872         DATA = "short file"
 873         DATA2 = "short file two"
 874         fileutil.write(rel_fn, DATA)
 875
 876         d = self.do_cli("create-alias", "tahoe")
 877
 878         d.addCallback(lambda res:
 879                       self.do_cli("put", rel_fn, "uploaded.txt"))
 880         def _uploaded((rc, out, err)):
 881             readcap = out.strip()
 882             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 883             self.failUnlessIn("201 Created", err)
 884             self.readcap = readcap
 885         d.addCallback(_uploaded)
 886         d.addCallback(lambda res:
 887                       self.do_cli("get", "tahoe:uploaded.txt"))
 888         d.addCallback(lambda (rc,stdout,stderr):
 889                       self.failUnlessReallyEqual(stdout, DATA))
 890
 891         d.addCallback(lambda res:
 892                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
 893         def _replaced((rc, out, err)):
 894             readcap = out.strip()
 895             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 896             self.failUnlessIn("200 OK", err)
 897         d.addCallback(_replaced)
 898
 899         d.addCallback(lambda res:
 900                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
 901         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
 902         d.addCallback(lambda (rc,stdout,stderr):
 903                       self.failUnlessReallyEqual(stdout, DATA))
 904
 905         d.addCallback(lambda res:
 906                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
 907         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
 908         d.addCallback(lambda (rc,stdout,stderr):
 909                       self.failUnlessReallyEqual(stdout, DATA))
 910
 911         d.addCallback(lambda res:
 912                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
 913         d.addCallback(lambda res:
 914                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
 915         d.addCallback(lambda (rc,stdout,stderr):
 916                       self.failUnlessReallyEqual(stdout, DATA))
 917
 918         def _get_dircap(res):
 919             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
 920         d.addCallback(_get_dircap)
 921
 922         d.addCallback(lambda res:
 923                       self.do_cli("put", rel_fn,
 924                                   self.dircap+":./uploaded5.txt"))
 925         d.addCallback(lambda res:
 926                       self.do_cli("get", "tahoe:uploaded5.txt"))
 927         d.addCallback(lambda (rc,stdout,stderr):
 928                       self.failUnlessReallyEqual(stdout, DATA))
 929
 930         d.addCallback(lambda res:
 931                       self.do_cli("put", rel_fn,
 932                                   self.dircap+":./subdir/uploaded6.txt"))
 933         d.addCallback(lambda res:
 934                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
 935         d.addCallback(lambda (rc,stdout,stderr):
 936                       self.failUnlessReallyEqual(stdout, DATA))
 937
 938         return d
 939
 940     def test_mutable_unlinked(self):
 941         # FILECAP = `echo DATA | tahoe put --mutable`
 942         # tahoe get FILECAP, compare against DATA
 943         # echo DATA2 | tahoe put - FILECAP
 944         # tahoe get FILECAP, compare against DATA2
 945         # tahoe put file.txt FILECAP
 946         self.basedir = "cli/Put/mutable_unlinked"
 947         self.set_up_grid()
 948
 949         DATA = "data" * 100
 950         DATA2 = "two" * 100
 951         rel_fn = os.path.join(self.basedir, "DATAFILE")
 952         DATA3 = "three" * 100
 953         fileutil.write(rel_fn, DATA3)
 954
 955         d = self.do_cli("put", "--mutable", stdin=DATA)
 956         def _created(res):
 957             (rc, out, err) = res
 958             self.failUnlessIn("waiting for file data on stdin..", err)
 959             self.failUnlessIn("200 OK", err)
 960             self.filecap = out
 961             self.failUnless(self.filecap.startswith("URI:SSK:"), self.filecap)
 962         d.addCallback(_created)
 963         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 964         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA))
 965
 966         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
 967         def _replaced(res):
 968             (rc, out, err) = res
 969             self.failUnlessIn("waiting for file data on stdin..", err)
 970             self.failUnlessIn("200 OK", err)
 971             self.failUnlessReallyEqual(self.filecap, out)
 972         d.addCallback(_replaced)
 973         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 974         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
 975
 976         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
 977         def _replaced2(res):
 978             (rc, out, err) = res
 979             self.failUnlessIn("200 OK", err)
 980             self.failUnlessReallyEqual(self.filecap, out)
 981         d.addCallback(_replaced2)
 982         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 983         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA3))
 984
 985         return d
 986
 987     def test_mutable(self):
 988         # echo DATA1 | tahoe put --mutable - uploaded.txt
 989         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
 990         # tahoe get uploaded.txt, compare against DATA2
 991
 992         self.basedir = "cli/Put/mutable"
 993         self.set_up_grid()
 994
 995         DATA1 = "data" * 100
 996         fn1 = os.path.join(self.basedir, "DATA1")
 997         fileutil.write(fn1, DATA1)
 998         DATA2 = "two" * 100
 999         fn2 = os.path.join(self.basedir, "DATA2")
1000         fileutil.write(fn2, DATA2)
1001
1002         d = self.do_cli("create-alias", "tahoe")
1003         d.addCallback(lambda res:
1004                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
1005         d.addCallback(lambda res:
1006                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
1007         d.addCallback(lambda res:
1008                       self.do_cli("get", "tahoe:uploaded.txt"))
1009         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1010         return d
1011
1012     def _check_mdmf_json(self, (rc, json, err)):
1013          self.failUnlessEqual(rc, 0)
1014          self.failUnlessEqual(err, "")
1015          self.failUnlessIn('"mutable-type": "mdmf"', json)
1016          # We also want a valid MDMF cap to be in the json.
1017          self.failUnlessIn("URI:MDMF", json)
1018          self.failUnlessIn("URI:MDMF-RO", json)
1019          self.failUnlessIn("URI:MDMF-Verifier", json)
1020
1021     def _check_sdmf_json(self, (rc, json, err)):
1022         self.failUnlessEqual(rc, 0)
1023         self.failUnlessEqual(err, "")
1024         self.failUnlessIn('"mutable-type": "sdmf"', json)
1025         # We also want to see the appropriate SDMF caps.
1026         self.failUnlessIn("URI:SSK", json)
1027         self.failUnlessIn("URI:SSK-RO", json)
1028         self.failUnlessIn("URI:SSK-Verifier", json)
1029
1030     def test_mutable_type(self):
1031         self.basedir = "cli/Put/mutable_type"
1032         self.set_up_grid()
1033         data = "data" * 100000
1034         fn1 = os.path.join(self.basedir, "data")
1035         fileutil.write(fn1, data)
1036         d = self.do_cli("create-alias", "tahoe")
1037         d.addCallback(lambda ignored:
1038             self.do_cli("put", "--mutable", "--mutable-type=mdmf",
1039                         fn1, "tahoe:uploaded.txt"))
1040         d.addCallback(lambda ignored:
1041             self.do_cli("ls", "--json", "tahoe:uploaded.txt"))
1042         d.addCallback(self._check_mdmf_json)
1043         d.addCallback(lambda ignored:
1044             self.do_cli("put", "--mutable", "--mutable-type=sdmf",
1045                         fn1, "tahoe:uploaded2.txt"))
1046         d.addCallback(lambda ignored:
1047             self.do_cli("ls", "--json", "tahoe:uploaded2.txt"))
1048         d.addCallback(self._check_sdmf_json)
1049         return d
1050
1051     def test_mutable_type_unlinked(self):
1052         self.basedir = "cli/Put/mutable_type_unlinked"
1053         self.set_up_grid()
1054         data = "data" * 100000
1055         fn1 = os.path.join(self.basedir, "data")
1056         fileutil.write(fn1, data)
1057         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1058         d.addCallback(lambda (rc, cap, err):
1059             self.do_cli("ls", "--json", cap))
1060         d.addCallback(self._check_mdmf_json)
1061         d.addCallback(lambda ignored:
1062             self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1))
1063         d.addCallback(lambda (rc, cap, err):
1064             self.do_cli("ls", "--json", cap))
1065         d.addCallback(self._check_sdmf_json)
1066         return d
1067
1068     def test_put_to_mdmf_cap(self):
1069         self.basedir = "cli/Put/put_to_mdmf_cap"
1070         self.set_up_grid()
1071         data = "data" * 100000
1072         fn1 = os.path.join(self.basedir, "data")
1073         fileutil.write(fn1, data)
1074         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1075         def _got_cap((rc, out, err)):
1076             self.failUnlessEqual(rc, 0)
1077             self.cap = out
1078         d.addCallback(_got_cap)
1079         # Now try to write something to the cap using put.
1080         data2 = "data2" * 100000
1081         fn2 = os.path.join(self.basedir, "data2")
1082         fileutil.write(fn2, data2)
1083         d.addCallback(lambda ignored:
1084             self.do_cli("put", fn2, self.cap))
1085         def _got_put((rc, out, err)):
1086             self.failUnlessEqual(rc, 0)
1087             self.failUnlessIn(self.cap, out)
1088         d.addCallback(_got_put)
1089         # Now get the cap. We should see the data we just put there.
1090         d.addCallback(lambda ignored:
1091             self.do_cli("get", self.cap))
1092         def _got_data((rc, out, err)):
1093             self.failUnlessEqual(rc, 0)
1094             self.failUnlessEqual(out, data2)
1095         d.addCallback(_got_data)
1096         # Now strip the extension information off of the cap and try
1097         # to put something to it.
1098         def _make_bare_cap(ignored):
1099             cap = self.cap.split(":")
1100             cap = ":".join(cap[:len(cap) - 2])
1101             self.cap = cap
1102         d.addCallback(_make_bare_cap)
1103         data3 = "data3" * 100000
1104         fn3 = os.path.join(self.basedir, "data3")
1105         fileutil.write(fn3, data3)
1106         d.addCallback(lambda ignored:
1107             self.do_cli("put", fn3, self.cap))
1108         d.addCallback(lambda ignored:
1109             self.do_cli("get", self.cap))
1110         def _got_data3((rc, out, err)):
1111             self.failUnlessEqual(rc, 0)
1112             self.failUnlessEqual(out, data3)
1113         d.addCallback(_got_data3)
1114         return d
1115
1116     def test_put_to_sdmf_cap(self):
1117         self.basedir = "cli/Put/put_to_sdmf_cap"
1118         self.set_up_grid()
1119         data = "data" * 100000
1120         fn1 = os.path.join(self.basedir, "data")
1121         fileutil.write(fn1, data)
1122         d = self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1)
1123         def _got_cap((rc, out, err)):
1124             self.failUnlessEqual(rc, 0)
1125             self.cap = out
1126         d.addCallback(_got_cap)
1127         # Now try to write something to the cap using put.
1128         data2 = "data2" * 100000
1129         fn2 = os.path.join(self.basedir, "data2")
1130         fileutil.write(fn2, data2)
1131         d.addCallback(lambda ignored:
1132             self.do_cli("put", fn2, self.cap))
1133         def _got_put((rc, out, err)):
1134             self.failUnlessEqual(rc, 0)
1135             self.failUnlessIn(self.cap, out)
1136         d.addCallback(_got_put)
1137         # Now get the cap. We should see the data we just put there.
1138         d.addCallback(lambda ignored:
1139             self.do_cli("get", self.cap))
1140         def _got_data((rc, out, err)):
1141             self.failUnlessEqual(rc, 0)
1142             self.failUnlessEqual(out, data2)
1143         d.addCallback(_got_data)
1144         return d
1145
1146     def test_mutable_type_invalid_format(self):
1147         o = cli.PutOptions()
1148         self.failUnlessRaises(usage.UsageError,
1149                               o.parseOptions,
1150                               ["--mutable", "--mutable-type=ldmf"])
1151
1152     def test_put_with_nonexistent_alias(self):
1153         # when invoked with an alias that doesn't exist, 'tahoe put'
1154         # should output a useful error message, not a stack trace
1155         self.basedir = "cli/Put/put_with_nonexistent_alias"
1156         self.set_up_grid()
1157         d = self.do_cli("put", "somefile", "fake:afile")
1158         def _check((rc, out, err)):
1159             self.failUnlessReallyEqual(rc, 1)
1160             self.failUnlessIn("error:", err)
1161             self.failUnlessReallyEqual(out, "")
1162         d.addCallback(_check)
1163         return d
1164
1165     def test_immutable_from_file_unicode(self):
1166         # tahoe put "\u00E0 trier.txt" "\u00E0 trier.txt"
1167
1168         try:
1169             a_trier_arg = u"\u00E0 trier.txt".encode(get_io_encoding())
1170         except UnicodeEncodeError:
1171             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1172
1173         self.skip_if_cannot_represent_filename(u"\u00E0 trier.txt")
1174
1175         self.basedir = "cli/Put/immutable_from_file_unicode"
1176         self.set_up_grid()
1177
1178         rel_fn = os.path.join(unicode(self.basedir), u"\u00E0 trier.txt")
1179         # we make the file small enough to fit in a LIT file, for speed
1180         DATA = "short file"
1181         fileutil.write(rel_fn, DATA)
1182
1183         d = self.do_cli("create-alias", "tahoe")
1184
1185         d.addCallback(lambda res:
1186                       self.do_cli("put", rel_fn.encode(get_io_encoding()), a_trier_arg))
1187         def _uploaded((rc, out, err)):
1188             readcap = out.strip()
1189             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
1190             self.failUnlessIn("201 Created", err)
1191             self.readcap = readcap
1192         d.addCallback(_uploaded)
1193
1194         d.addCallback(lambda res:
1195                       self.do_cli("get", "tahoe:" + a_trier_arg))
1196         d.addCallback(lambda (rc, out, err):
1197                       self.failUnlessReallyEqual(out, DATA))
1198
1199         return d
1200
1201 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
1202     def test_list(self):
1203         self.basedir = "cli/List/list"
1204         self.set_up_grid()
1205         c0 = self.g.clients[0]
1206         small = "small"
1207
1208         # u"g\u00F6\u00F6d" might not be representable in the argv and/or output encodings.
1209         # It is initially included in the directory in any case.
1210         try:
1211             good_arg = u"g\u00F6\u00F6d".encode(get_io_encoding())
1212         except UnicodeEncodeError:
1213             good_arg = None
1214
1215         try:
1216             good_out = u"g\u00F6\u00F6d".encode(get_io_encoding())
1217         except UnicodeEncodeError:
1218             good_out = None
1219
1220         d = c0.create_dirnode()
1221         def _stash_root_and_create_file(n):
1222             self.rootnode = n
1223             self.rooturi = n.get_uri()
1224             return n.add_file(u"g\u00F6\u00F6d", upload.Data(small, convergence=""))
1225         d.addCallback(_stash_root_and_create_file)
1226         def _stash_goodcap(n):
1227             self.goodcap = n.get_uri()
1228         d.addCallback(_stash_goodcap)
1229         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
1230         d.addCallback(lambda n:
1231                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
1232         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
1233         d.addCallback(lambda n:
1234                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
1235         d.addCallback(lambda ign:
1236                       self.do_cli("add-alias", "tahoe", self.rooturi))
1237         d.addCallback(lambda ign: self.do_cli("ls"))
1238         def _check1((rc,out,err)):
1239             if good_out is None:
1240                 self.failUnlessReallyEqual(rc, 1)
1241                 self.failUnlessIn("files whose names could not be converted", err)
1242                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1243                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share"]))
1244             else:
1245                 self.failUnlessReallyEqual(rc, 0)
1246                 self.failUnlessReallyEqual(err, "")
1247                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", good_out]))
1248         d.addCallback(_check1)
1249         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
1250         def _check2((rc,out,err)):
1251             self.failIfEqual(rc, 0)
1252             self.failUnlessReallyEqual(err.strip(), "No such file or directory")
1253             self.failUnlessReallyEqual(out, "")
1254         d.addCallback(_check2)
1255         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
1256         def _check3((rc,out,err)):
1257             self.failIfEqual(rc, 0)
1258             self.failUnlessIn("Error during GET: 410 Gone", err)
1259             self.failUnlessIn("UnrecoverableFileError:", err)
1260             self.failUnlessIn("could not be retrieved, because there were "
1261                               "insufficient good shares.", err)
1262             self.failUnlessReallyEqual(out, "")
1263         d.addCallback(_check3)
1264         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
1265         d.addCallback(_check3)
1266         def _check4((rc, out, err)):
1267             if good_out is None:
1268                 self.failUnlessReallyEqual(rc, 1)
1269                 self.failUnlessIn("files whose names could not be converted", err)
1270                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1271                 self.failUnlessReallyEqual(out, "")
1272             else:
1273                 # listing a file (as dir/filename) should have the edge metadata,
1274                 # including the filename
1275                 self.failUnlessReallyEqual(rc, 0)
1276                 self.failUnlessIn(good_out, out)
1277                 self.failIfIn("-r-- %d -" % len(small), out,
1278                               "trailing hyphen means unknown date")
1279
1280         if good_arg is not None:
1281             d.addCallback(lambda ign: self.do_cli("ls", "-l", good_arg))
1282             d.addCallback(_check4)
1283             # listing a file as $DIRCAP/filename should work just like dir/filename
1284             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/" + good_arg))
1285             d.addCallback(_check4)
1286             # and similarly for $DIRCAP:./filename
1287             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./" + good_arg))
1288             d.addCallback(_check4)
1289
1290         def _check5((rc, out, err)):
1291             # listing a raw filecap should not explode, but it will have no
1292             # metadata, just the size
1293             self.failUnlessReallyEqual(rc, 0)
1294             self.failUnlessReallyEqual("-r-- %d -" % len(small), out.strip())
1295         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
1296         d.addCallback(_check5)
1297
1298         # Now rename 'g\u00F6\u00F6d' to 'good' and repeat the tests that might have been skipped due
1299         # to encoding problems.
1300         d.addCallback(lambda ign: self.rootnode.move_child_to(u"g\u00F6\u00F6d", self.rootnode, u"good"))
1301
1302         d.addCallback(lambda ign: self.do_cli("ls"))
1303         def _check1_ascii((rc,out,err)):
1304             self.failUnlessReallyEqual(rc, 0)
1305             self.failUnlessReallyEqual(err, "")
1306             self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", "good"]))
1307         d.addCallback(_check1_ascii)
1308         def _check4_ascii((rc, out, err)):
1309             # listing a file (as dir/filename) should have the edge metadata,
1310             # including the filename
1311             self.failUnlessReallyEqual(rc, 0)
1312             self.failUnlessIn("good", out)
1313             self.failIfIn("-r-- %d -" % len(small), out,
1314                           "trailing hyphen means unknown date")
1315
1316         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
1317         d.addCallback(_check4_ascii)
1318         # listing a file as $DIRCAP/filename should work just like dir/filename
1319         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
1320         d.addCallback(_check4_ascii)
1321         # and similarly for $DIRCAP:./filename
1322         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
1323         d.addCallback(_check4_ascii)
1324
1325         unknown_immcap = "imm.URI:unknown"
1326         def _create_unknown(ign):
1327             nm = c0.nodemaker
1328             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
1329             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
1330                                                      mutable=False)
1331         d.addCallback(_create_unknown)
1332         def _check6((rc, out, err)):
1333             # listing a directory referencing an unknown object should print
1334             # an extra message to stderr
1335             self.failUnlessReallyEqual(rc, 0)
1336             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
1337             self.failUnlessIn("included unknown objects", err)
1338         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
1339         d.addCallback(_check6)
1340         def _check7((rc, out, err)):
1341             # listing an unknown cap directly should print an extra message
1342             # to stderr (currently this only works if the URI starts with 'URI:'
1343             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
1344             # with an alias).
1345             self.failUnlessReallyEqual(rc, 0)
1346             self.failUnlessIn("?r-- ? -\n", out)
1347             self.failUnlessIn("included unknown objects", err)
1348         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
1349         d.addCallback(_check7)
1350         return d
1351
1352     def test_list_without_alias(self):
1353         # doing just 'tahoe ls' without specifying an alias or first
1354         # doing 'tahoe create-alias tahoe' should fail gracefully.
1355         self.basedir = "cli/List/list_without_alias"
1356         self.set_up_grid()
1357         d = self.do_cli("ls")
1358         def _check((rc, out, err)):
1359             self.failUnlessReallyEqual(rc, 1)
1360             self.failUnlessIn("error:", err)
1361             self.failUnlessReallyEqual(out, "")
1362         d.addCallback(_check)
1363         return d
1364
1365     def test_list_with_nonexistent_alias(self):
1366         # doing 'tahoe ls' while specifying an alias that doesn't already
1367         # exist should fail with an informative error message
1368         self.basedir = "cli/List/list_with_nonexistent_alias"
1369         self.set_up_grid()
1370         d = self.do_cli("ls", "nonexistent:")
1371         def _check((rc, out, err)):
1372             self.failUnlessReallyEqual(rc, 1)
1373             self.failUnlessIn("error:", err)
1374             self.failUnlessIn("nonexistent", err)
1375             self.failUnlessReallyEqual(out, "")
1376         d.addCallback(_check)
1377         return d
1378
1379
1380 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
1381     def test_mv_behavior(self):
1382         self.basedir = "cli/Mv/mv_behavior"
1383         self.set_up_grid()
1384         fn1 = os.path.join(self.basedir, "file1")
1385         DATA1 = "Nuclear launch codes"
1386         fileutil.write(fn1, DATA1)
1387         fn2 = os.path.join(self.basedir, "file2")
1388         DATA2 = "UML diagrams"
1389         fileutil.write(fn2, DATA2)
1390         # copy both files to the grid
1391         d = self.do_cli("create-alias", "tahoe")
1392         d.addCallback(lambda res:
1393             self.do_cli("cp", fn1, "tahoe:"))
1394         d.addCallback(lambda res:
1395             self.do_cli("cp", fn2, "tahoe:"))
1396
1397         # do mv file1 file3
1398         # (we should be able to rename files)
1399         d.addCallback(lambda res:
1400             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1401         d.addCallback(lambda (rc, out, err):
1402             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1403
1404         # do mv file3 file2
1405         # (This should succeed without issue)
1406         d.addCallback(lambda res:
1407             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1408         # Out should contain "OK" to show that the transfer worked.
1409         d.addCallback(lambda (rc,out,err):
1410             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1411
1412         # Next, make a remote directory.
1413         d.addCallback(lambda res:
1414             self.do_cli("mkdir", "tahoe:directory"))
1415
1416         # mv file2 directory
1417         # (should fail with a descriptive error message; the CLI mv
1418         #  client should support this)
1419         d.addCallback(lambda res:
1420             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1421         d.addCallback(lambda (rc, out, err):
1422             self.failUnlessIn(
1423                 "Error: You can't overwrite a directory with a file", err,
1424                 "mv shouldn't overwrite directories" ))
1425
1426         # mv file2 directory/
1427         # (should succeed by making file2 a child node of directory)
1428         d.addCallback(lambda res:
1429             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1430         # We should see an "OK"...
1431         d.addCallback(lambda (rc, out, err):
1432             self.failUnlessIn("OK", out,
1433                             "mv didn't mv a file into a directory"))
1434         # ... and be able to GET the file
1435         d.addCallback(lambda res:
1436             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1437         d.addCallback(lambda (rc, out, err):
1438             self.failUnless(os.path.exists(self.basedir + "new"),
1439                             "mv didn't write the destination file"))
1440         # ... and not find the file where it was before.
1441         d.addCallback(lambda res:
1442             self.do_cli("get", "tahoe:file2", "file2"))
1443         d.addCallback(lambda (rc, out, err):
1444             self.failUnlessIn("404", err,
1445                             "mv left the source file intact"))
1446
1447         # Let's build:
1448         # directory/directory2/some_file
1449         # directory3
1450         d.addCallback(lambda res:
1451             self.do_cli("mkdir", "tahoe:directory/directory2"))
1452         d.addCallback(lambda res:
1453             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1454         d.addCallback(lambda res:
1455             self.do_cli("mkdir", "tahoe:directory3"))
1456
1457         # Let's now try to mv directory/directory2/some_file to
1458         # directory3/some_file
1459         d.addCallback(lambda res:
1460             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1461                         "tahoe:directory3/"))
1462         # We should have just some_file in tahoe:directory3
1463         d.addCallback(lambda res:
1464             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1465         d.addCallback(lambda (rc, out, err):
1466             self.failUnless("404" not in err,
1467                               "mv didn't handle nested directories correctly"))
1468         d.addCallback(lambda res:
1469             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1470         d.addCallback(lambda (rc, out, err):
1471             self.failUnlessIn("404", err,
1472                               "mv moved the wrong thing"))
1473         return d
1474
1475     def test_mv_error_if_DELETE_fails(self):
1476         self.basedir = "cli/Mv/mv_error_if_DELETE_fails"
1477         self.set_up_grid()
1478         fn1 = os.path.join(self.basedir, "file1")
1479         DATA1 = "Nuclear launch codes"
1480         fileutil.write(fn1, DATA1)
1481
1482         original_do_http = tahoe_mv.do_http
1483         def mock_do_http(method, url, body=""):
1484             if method == "DELETE":
1485                 class FakeResponse:
1486                     def read(self):
1487                         return "response"
1488                 resp = FakeResponse()
1489                 resp.status = '500 Something Went Wrong'
1490                 resp.reason = '*shrug*'
1491                 return resp
1492             else:
1493                 return original_do_http(method, url, body=body)
1494         tahoe_mv.do_http = mock_do_http
1495
1496         # copy file to the grid
1497         d = self.do_cli("create-alias", "tahoe")
1498         d.addCallback(lambda res:
1499             self.do_cli("cp", fn1, "tahoe:"))
1500
1501         # do mv file1 file2
1502         d.addCallback(lambda res:
1503             self.do_cli("mv", "tahoe:file1", "tahoe:file2"))
1504         def _check( (rc, out, err) ):
1505             self.failIfIn("OK", out, "mv printed 'OK' even though the DELETE failed")
1506             self.failUnlessEqual(rc, 2)
1507         d.addCallback(_check)
1508
1509         def _restore_do_http(res):
1510             tahoe_mv.do_http = original_do_http
1511             return res
1512         d.addBoth(_restore_do_http)
1513         return d
1514
1515     def test_mv_without_alias(self):
1516         # doing 'tahoe mv' without explicitly specifying an alias or
1517         # creating the default 'tahoe' alias should fail with a useful
1518         # error message.
1519         self.basedir = "cli/Mv/mv_without_alias"
1520         self.set_up_grid()
1521         d = self.do_cli("mv", "afile", "anotherfile")
1522         def _check((rc, out, err)):
1523             self.failUnlessReallyEqual(rc, 1)
1524             self.failUnlessIn("error:", err)
1525             self.failUnlessReallyEqual(out, "")
1526         d.addCallback(_check)
1527         # check to see that the validation extends to the
1528         # target argument by making an alias that will work with the first
1529         # one.
1530         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1531         def _create_a_test_file(ign):
1532             self.test_file_path = os.path.join(self.basedir, "afile")
1533             fileutil.write(self.test_file_path, "puppies" * 100)
1534         d.addCallback(_create_a_test_file)
1535         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1536                                               "havasu:afile"))
1537         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1538                                               "anotherfile"))
1539         d.addCallback(_check)
1540         return d
1541
1542     def test_mv_with_nonexistent_alias(self):
1543         # doing 'tahoe mv' with an alias that doesn't exist should fail
1544         # with an informative error message.
1545         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1546         self.set_up_grid()
1547         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1548         def _check((rc, out, err)):
1549             self.failUnlessReallyEqual(rc, 1)
1550             self.failUnlessIn("error:", err)
1551             self.failUnlessIn("fake", err)
1552             self.failUnlessReallyEqual(out, "")
1553         d.addCallback(_check)
1554         # check to see that the validation extends to the
1555         # target argument by making an alias that will work with the first
1556         # one.
1557         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1558         def _create_a_test_file(ign):
1559             self.test_file_path = os.path.join(self.basedir, "afile")
1560             fileutil.write(self.test_file_path, "puppies" * 100)
1561         d.addCallback(_create_a_test_file)
1562         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1563                                               "havasu:afile"))
1564         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1565                                               "fake:anotherfile"))
1566         d.addCallback(_check)
1567         return d
1568
1569
1570 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1571
1572     def test_not_enough_args(self):
1573         o = cli.CpOptions()
1574         self.failUnlessRaises(usage.UsageError,
1575                               o.parseOptions, ["onearg"])
1576
1577     def test_unicode_filename(self):
1578         self.basedir = "cli/Cp/unicode_filename"
1579
1580         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1581         try:
1582             fn1_arg = fn1.encode(get_io_encoding())
1583             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1584         except UnicodeEncodeError:
1585             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1586
1587         self.skip_if_cannot_represent_filename(fn1)
1588
1589         self.set_up_grid()
1590
1591         DATA1 = "unicode file content"
1592         fileutil.write(fn1, DATA1)
1593
1594         fn2 = os.path.join(self.basedir, "Metallica")
1595         DATA2 = "non-unicode file content"
1596         fileutil.write(fn2, DATA2)
1597
1598         d = self.do_cli("create-alias", "tahoe")
1599
1600         d.addCallback(lambda res: self.do_cli("cp", fn1_arg, "tahoe:"))
1601
1602         d.addCallback(lambda res: self.do_cli("get", "tahoe:" + artonwall_arg))
1603         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA1))
1604
1605         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1606
1607         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1608         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1609
1610         d.addCallback(lambda res: self.do_cli("ls", "tahoe:"))
1611         def _check((rc, out, err)):
1612             try:
1613                 unicode_to_output(u"\u00C4rtonwall")
1614             except UnicodeEncodeError:
1615                 self.failUnlessReallyEqual(rc, 1)
1616                 self.failUnlessReallyEqual(out, "Metallica\n")
1617                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1618                 self.failUnlessIn("files whose names could not be converted", err)
1619             else:
1620                 self.failUnlessReallyEqual(rc, 0)
1621                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"Metallica\n\u00C4rtonwall\n")
1622                 self.failUnlessReallyEqual(err, "")
1623         d.addCallback(_check)
1624
1625         return d
1626
1627     def test_dangling_symlink_vs_recursion(self):
1628         if not hasattr(os, 'symlink'):
1629             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
1630
1631         # cp -r on a directory containing a dangling symlink shouldn't assert
1632         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1633         self.set_up_grid()
1634         dn = os.path.join(self.basedir, "dir")
1635         os.mkdir(dn)
1636         fn = os.path.join(dn, "Fakebandica")
1637         ln = os.path.join(dn, "link")
1638         os.symlink(fn, ln)
1639
1640         d = self.do_cli("create-alias", "tahoe")
1641         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1642                                               dn, "tahoe:"))
1643         return d
1644
1645     def test_copy_using_filecap(self):
1646         self.basedir = "cli/Cp/test_copy_using_filecap"
1647         self.set_up_grid()
1648         outdir = os.path.join(self.basedir, "outdir")
1649         os.mkdir(outdir)
1650         fn1 = os.path.join(self.basedir, "Metallica")
1651         fn2 = os.path.join(outdir, "Not Metallica")
1652         fn3 = os.path.join(outdir, "test2")
1653         DATA1 = "puppies" * 10000
1654         fileutil.write(fn1, DATA1)
1655
1656         d = self.do_cli("create-alias", "tahoe")
1657         d.addCallback(lambda ign: self.do_cli("put", fn1))
1658         def _put_file((rc, out, err)):
1659             self.failUnlessReallyEqual(rc, 0)
1660             self.failUnlessIn("200 OK", err)
1661             # keep track of the filecap
1662             self.filecap = out.strip()
1663         d.addCallback(_put_file)
1664
1665         # Let's try copying this to the disk using the filecap
1666         #  cp FILECAP filename
1667         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1668         def _copy_file((rc, out, err)):
1669             self.failUnlessReallyEqual(rc, 0)
1670             results = fileutil.read(fn2)
1671             self.failUnlessReallyEqual(results, DATA1)
1672         d.addCallback(_copy_file)
1673
1674         # Test with ./ (see #761)
1675         #  cp FILECAP localdir
1676         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1677         def _resp((rc, out, err)):
1678             self.failUnlessReallyEqual(rc, 1)
1679             self.failUnlessIn("error: you must specify a destination filename",
1680                               err)
1681             self.failUnlessReallyEqual(out, "")
1682         d.addCallback(_resp)
1683
1684         # Create a directory, linked at tahoe:test
1685         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1686         def _get_dir((rc, out, err)):
1687             self.failUnlessReallyEqual(rc, 0)
1688             self.dircap = out.strip()
1689         d.addCallback(_get_dir)
1690
1691         # Upload a file to the directory
1692         d.addCallback(lambda ign:
1693                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1694         d.addCallback(lambda (rc, out, err): self.failUnlessReallyEqual(rc, 0))
1695
1696         #  cp DIRCAP/filename localdir
1697         d.addCallback(lambda ign:
1698                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1699         def _get_resp((rc, out, err)):
1700             self.failUnlessReallyEqual(rc, 0)
1701             results = fileutil.read(os.path.join(outdir, "test_file"))
1702             self.failUnlessReallyEqual(results, DATA1)
1703         d.addCallback(_get_resp)
1704
1705         #  cp -r DIRCAP/filename filename2
1706         d.addCallback(lambda ign:
1707                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1708         def _get_resp2((rc, out, err)):
1709             self.failUnlessReallyEqual(rc, 0)
1710             results = fileutil.read(fn3)
1711             self.failUnlessReallyEqual(results, DATA1)
1712         d.addCallback(_get_resp2)
1713         return d
1714
1715     def test_cp_with_nonexistent_alias(self):
1716         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1717         # should output a sensible error message rather than a stack trace.
1718         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1719         self.set_up_grid()
1720         d = self.do_cli("cp", "fake:file1", "fake:file2")
1721         def _check((rc, out, err)):
1722             self.failUnlessReallyEqual(rc, 1)
1723             self.failUnlessIn("error:", err)
1724         d.addCallback(_check)
1725         # 'tahoe cp' actually processes the target argument first, so we need
1726         # to check to make sure that validation extends to the source
1727         # argument.
1728         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1729         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1730                                               "tahoe:file2"))
1731         d.addCallback(_check)
1732         return d
1733
1734     def test_unicode_dirnames(self):
1735         self.basedir = "cli/Cp/unicode_dirnames"
1736
1737         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1738         try:
1739             fn1_arg = fn1.encode(get_io_encoding())
1740             del fn1_arg # hush pyflakes
1741             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1742         except UnicodeEncodeError:
1743             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1744
1745         self.skip_if_cannot_represent_filename(fn1)
1746
1747         self.set_up_grid()
1748
1749         d = self.do_cli("create-alias", "tahoe")
1750         d.addCallback(lambda res: self.do_cli("mkdir", "tahoe:test/" + artonwall_arg))
1751         d.addCallback(lambda res: self.do_cli("cp", "-r", "tahoe:test", "tahoe:test2"))
1752         d.addCallback(lambda res: self.do_cli("ls", "tahoe:test2"))
1753         def _check((rc, out, err)):
1754             try:
1755                 unicode_to_output(u"\u00C4rtonwall")
1756             except UnicodeEncodeError:
1757                 self.failUnlessReallyEqual(rc, 1)
1758                 self.failUnlessReallyEqual(out, "")
1759                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1760                 self.failUnlessIn("files whose names could not be converted", err)
1761             else:
1762                 self.failUnlessReallyEqual(rc, 0)
1763                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"\u00C4rtonwall\n")
1764                 self.failUnlessReallyEqual(err, "")
1765         d.addCallback(_check)
1766
1767         return d
1768
1769     def test_cp_replaces_mutable_file_contents(self):
1770         self.basedir = "cli/Cp/cp_replaces_mutable_file_contents"
1771         self.set_up_grid()
1772
1773         # Write a test file, which we'll copy to the grid.
1774         test_txt_path = os.path.join(self.basedir, "test.txt")
1775         test_txt_contents = "foo bar baz"
1776         f = open(test_txt_path, "w")
1777         f.write(test_txt_contents)
1778         f.close()
1779
1780         d = self.do_cli("create-alias", "tahoe")
1781         d.addCallback(lambda ignored:
1782             self.do_cli("mkdir", "tahoe:test"))
1783         # We have to use 'tahoe put' here because 'tahoe cp' doesn't
1784         # know how to make mutable files at the destination.
1785         d.addCallback(lambda ignored:
1786             self.do_cli("put", "--mutable", test_txt_path, "tahoe:test/test.txt"))
1787         d.addCallback(lambda ignored:
1788             self.do_cli("get", "tahoe:test/test.txt"))
1789         def _check((rc, out, err)):
1790             self.failUnlessEqual(rc, 0)
1791             self.failUnlessEqual(out, test_txt_contents)
1792         d.addCallback(_check)
1793
1794         # We'll do ls --json to get the read uri and write uri for the
1795         # file we've just uploaded.
1796         d.addCallback(lambda ignored:
1797             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
1798         def _get_test_txt_uris((rc, out, err)):
1799             self.failUnlessEqual(rc, 0)
1800             filetype, data = simplejson.loads(out)
1801
1802             self.failUnlessEqual(filetype, "filenode")
1803             self.failUnless(data['mutable'])
1804
1805             self.failUnlessIn("rw_uri", data)
1806             self.rw_uri = to_str(data["rw_uri"])
1807             self.failUnlessIn("ro_uri", data)
1808             self.ro_uri = to_str(data["ro_uri"])
1809         d.addCallback(_get_test_txt_uris)
1810
1811         # Now make a new file to copy in place of test.txt.
1812         new_txt_path = os.path.join(self.basedir, "new.txt")
1813         new_txt_contents = "baz bar foo" * 100000
1814         f = open(new_txt_path, "w")
1815         f.write(new_txt_contents)
1816         f.close()
1817
1818         # Copy the new file on top of the old file.
1819         d.addCallback(lambda ignored:
1820             self.do_cli("cp", new_txt_path, "tahoe:test/test.txt"))
1821
1822         # If we get test.txt now, we should see the new data.
1823         d.addCallback(lambda ignored:
1824             self.do_cli("get", "tahoe:test/test.txt"))
1825         d.addCallback(lambda (rc, out, err):
1826             self.failUnlessEqual(out, new_txt_contents))
1827         # If we get the json of the new file, we should see that the old
1828         # uri is there
1829         d.addCallback(lambda ignored:
1830             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
1831         def _check_json((rc, out, err)):
1832             self.failUnlessEqual(rc, 0)
1833             filetype, data = simplejson.loads(out)
1834
1835             self.failUnlessEqual(filetype, "filenode")
1836             self.failUnless(data['mutable'])
1837
1838             self.failUnlessIn("ro_uri", data)
1839             self.failUnlessEqual(to_str(data["ro_uri"]), self.ro_uri)
1840             self.failUnlessIn("rw_uri", data)
1841             self.failUnlessEqual(to_str(data["rw_uri"]), self.rw_uri)
1842         d.addCallback(_check_json)
1843
1844         # and, finally, doing a GET directly on one of the old uris
1845         # should give us the new contents.
1846         d.addCallback(lambda ignored:
1847             self.do_cli("get", self.rw_uri))
1848         d.addCallback(lambda (rc, out, err):
1849             self.failUnlessEqual(out, new_txt_contents))
1850         # Now copy the old test.txt without an explicit destination
1851         # file. tahoe cp will match it to the existing file and
1852         # overwrite it appropriately.
1853         d.addCallback(lambda ignored:
1854             self.do_cli("cp", test_txt_path, "tahoe:test"))
1855         d.addCallback(lambda ignored:
1856             self.do_cli("get", "tahoe:test/test.txt"))
1857         d.addCallback(lambda (rc, out, err):
1858             self.failUnlessEqual(out, test_txt_contents))
1859         d.addCallback(lambda ignored:
1860             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
1861         d.addCallback(_check_json)
1862         d.addCallback(lambda ignored:
1863             self.do_cli("get", self.rw_uri))
1864         d.addCallback(lambda (rc, out, err):
1865             self.failUnlessEqual(out, test_txt_contents))
1866
1867         # Now we'll make a more complicated directory structure.
1868         # test2/
1869         # test2/mutable1
1870         # test2/mutable2
1871         # test2/imm1
1872         # test2/imm2
1873         imm_test_txt_path = os.path.join(self.basedir, "imm_test.txt")
1874         imm_test_txt_contents = test_txt_contents * 10000
1875         fileutil.write(imm_test_txt_path, imm_test_txt_contents)
1876         d.addCallback(lambda ignored:
1877             self.do_cli("mkdir", "tahoe:test2"))
1878         d.addCallback(lambda ignored:
1879             self.do_cli("put", "--mutable", new_txt_path,
1880                         "tahoe:test2/mutable1"))
1881         d.addCallback(lambda ignored:
1882             self.do_cli("put", "--mutable", new_txt_path,
1883                         "tahoe:test2/mutable2"))
1884         d.addCallback(lambda ignored:
1885             self.do_cli('put', new_txt_path, "tahoe:test2/imm1"))
1886         d.addCallback(lambda ignored:
1887             self.do_cli("put", imm_test_txt_path, "tahoe:test2/imm2"))
1888         d.addCallback(lambda ignored:
1889             self.do_cli("ls", "--json", "tahoe:test2"))
1890         def _process_directory_json((rc, out, err)):
1891             self.failUnlessEqual(rc, 0)
1892
1893             filetype, data = simplejson.loads(out)
1894             self.failUnlessEqual(filetype, "dirnode")
1895             self.failUnless(data['mutable'])
1896             self.failUnlessIn("children", data)
1897             children = data['children']
1898
1899             # Store the URIs for later use.
1900             self.childuris = {}
1901             for k in ["mutable1", "mutable2", "imm1", "imm2"]:
1902                 self.failUnlessIn(k, children)
1903                 childtype, childdata = children[k]
1904                 self.failUnlessEqual(childtype, "filenode")
1905                 if "mutable" in k:
1906                     self.failUnless(childdata['mutable'])
1907                     self.failUnlessIn("rw_uri", childdata)
1908                     uri_key = "rw_uri"
1909                 else:
1910                     self.failIf(childdata['mutable'])
1911                     self.failUnlessIn("ro_uri", childdata)
1912                     uri_key = "ro_uri"
1913                 self.childuris[k] = to_str(childdata[uri_key])
1914         d.addCallback(_process_directory_json)
1915         # Now build a local directory to copy into place, like the following:
1916         # source1/
1917         # source1/mutable1
1918         # source1/mutable2
1919         # source1/imm1
1920         # source1/imm3
1921         def _build_local_directory(ignored):
1922             source1_path = os.path.join(self.basedir, "source1")
1923             fileutil.make_dirs(source1_path)
1924             for fn in ("mutable1", "mutable2", "imm1", "imm3"):
1925                 fileutil.write(os.path.join(source1_path, fn), fn * 1000)
1926             self.source1_path = source1_path
1927         d.addCallback(_build_local_directory)
1928         d.addCallback(lambda ignored:
1929             self.do_cli("cp", "-r", self.source1_path, "tahoe:test2"))
1930
1931         # We expect that mutable1 and mutable2 are overwritten in-place,
1932         # so they'll retain their URIs but have different content.
1933         def _process_file_json((rc, out, err), fn):
1934             self.failUnlessEqual(rc, 0)
1935             filetype, data = simplejson.loads(out)
1936             self.failUnlessEqual(filetype, "filenode")
1937
1938             if "mutable" in fn:
1939                 self.failUnless(data['mutable'])
1940                 self.failUnlessIn("rw_uri", data)
1941                 self.failUnlessEqual(to_str(data["rw_uri"]), self.childuris[fn])
1942             else:
1943                 self.failIf(data['mutable'])
1944                 self.failUnlessIn("ro_uri", data)
1945                 self.failIfEqual(to_str(data["ro_uri"]), self.childuris[fn])
1946
1947         for fn in ("mutable1", "mutable2"):
1948             d.addCallback(lambda ignored, fn=fn:
1949                 self.do_cli("get", "tahoe:test2/%s" % fn))
1950             d.addCallback(lambda (rc, out, err), fn=fn:
1951                 self.failUnlessEqual(out, fn * 1000))
1952             d.addCallback(lambda ignored, fn=fn:
1953                 self.do_cli("ls", "--json", "tahoe:test2/%s" % fn))
1954             d.addCallback(_process_file_json, fn=fn)
1955
1956         # imm1 should have been replaced, so both its uri and content
1957         # should be different.
1958         d.addCallback(lambda ignored:
1959             self.do_cli("get", "tahoe:test2/imm1"))
1960         d.addCallback(lambda (rc, out, err):
1961             self.failUnlessEqual(out, "imm1" * 1000))
1962         d.addCallback(lambda ignored:
1963             self.do_cli("ls", "--json", "tahoe:test2/imm1"))
1964         d.addCallback(_process_file_json, fn="imm1")
1965
1966         # imm3 should have been created.
1967         d.addCallback(lambda ignored:
1968             self.do_cli("get", "tahoe:test2/imm3"))
1969         d.addCallback(lambda (rc, out, err):
1970             self.failUnlessEqual(out, "imm3" * 1000))
1971
1972         # imm2 should be exactly as we left it, since our newly-copied
1973         # directory didn't contain an imm2 entry.
1974         d.addCallback(lambda ignored:
1975             self.do_cli("get", "tahoe:test2/imm2"))
1976         d.addCallback(lambda (rc, out, err):
1977             self.failUnlessEqual(out, imm_test_txt_contents))
1978         d.addCallback(lambda ignored:
1979             self.do_cli("ls", "--json", "tahoe:test2/imm2"))
1980         def _process_imm2_json((rc, out, err)):
1981             self.failUnlessEqual(rc, 0)
1982             filetype, data = simplejson.loads(out)
1983             self.failUnlessEqual(filetype, "filenode")
1984             self.failIf(data['mutable'])
1985             self.failUnlessIn("ro_uri", data)
1986             self.failUnlessEqual(to_str(data["ro_uri"]), self.childuris["imm2"])
1987         d.addCallback(_process_imm2_json)
1988         return d
1989
1990     def test_cp_overwrite_readonly_mutable_file(self):
1991         # tahoe cp should print an error when asked to overwrite a
1992         # mutable file that it can't overwrite.
1993         self.basedir = "cli/Cp/overwrite_readonly_mutable_file"
1994         self.set_up_grid()
1995
1996         # This is our initial file. We'll link its readcap into the
1997         # tahoe: alias.
1998         test_file_path = os.path.join(self.basedir, "test_file.txt")
1999         test_file_contents = "This is a test file."
2000         fileutil.write(test_file_path, test_file_contents)
2001
2002         # This is our replacement file. We'll try and fail to upload it
2003         # over the readcap that we linked into the tahoe: alias.
2004         replacement_file_path = os.path.join(self.basedir, "replacement.txt")
2005         replacement_file_contents = "These are new contents."
2006         fileutil.write(replacement_file_path, replacement_file_contents)
2007
2008         d = self.do_cli("create-alias", "tahoe:")
2009         d.addCallback(lambda ignored:
2010             self.do_cli("put", "--mutable", test_file_path))
2011         def _get_test_uri((rc, out, err)):
2012             self.failUnlessEqual(rc, 0)
2013             # this should be a write uri
2014             self._test_write_uri = out
2015         d.addCallback(_get_test_uri)
2016         d.addCallback(lambda ignored:
2017             self.do_cli("ls", "--json", self._test_write_uri))
2018         def _process_test_json((rc, out, err)):
2019             self.failUnlessEqual(rc, 0)
2020             filetype, data = simplejson.loads(out)
2021
2022             self.failUnlessEqual(filetype, "filenode")
2023             self.failUnless(data['mutable'])
2024             self.failUnlessIn("ro_uri", data)
2025             self._test_read_uri = to_str(data["ro_uri"])
2026         d.addCallback(_process_test_json)
2027         # Now we'll link the readonly URI into the tahoe: alias.
2028         d.addCallback(lambda ignored:
2029             self.do_cli("ln", self._test_read_uri, "tahoe:test_file.txt"))
2030         d.addCallback(lambda (rc, out, err):
2031             self.failUnlessEqual(rc, 0))
2032         # Let's grab the json of that to make sure that we did it right.
2033         d.addCallback(lambda ignored:
2034             self.do_cli("ls", "--json", "tahoe:"))
2035         def _process_tahoe_json((rc, out, err)):
2036             self.failUnlessEqual(rc, 0)
2037
2038             filetype, data = simplejson.loads(out)
2039             self.failUnlessEqual(filetype, "dirnode")
2040             self.failUnlessIn("children", data)
2041             kiddata = data['children']
2042
2043             self.failUnlessIn("test_file.txt", kiddata)
2044             testtype, testdata = kiddata['test_file.txt']
2045             self.failUnlessEqual(testtype, "filenode")
2046             self.failUnless(testdata['mutable'])
2047             self.failUnlessIn("ro_uri", testdata)
2048             self.failUnlessEqual(to_str(testdata["ro_uri"]), self._test_read_uri)
2049             self.failIfIn("rw_uri", testdata)
2050         d.addCallback(_process_tahoe_json)
2051         # Okay, now we're going to try uploading another mutable file in
2052         # place of that one. We should get an error.
2053         d.addCallback(lambda ignored:
2054             self.do_cli("cp", replacement_file_path, "tahoe:test_file.txt"))
2055         def _check_error_message((rc, out, err)):
2056             self.failUnlessEqual(rc, 1)
2057             self.failUnlessIn("need write capability to publish", err)
2058         d.addCallback(_check_error_message)
2059         # Make extra sure that that didn't work.
2060         d.addCallback(lambda ignored:
2061             self.do_cli("get", "tahoe:test_file.txt"))
2062         d.addCallback(lambda (rc, out, err):
2063             self.failUnlessEqual(out, test_file_contents))
2064         d.addCallback(lambda ignored:
2065             self.do_cli("get", self._test_read_uri))
2066         d.addCallback(lambda (rc, out, err):
2067             self.failUnlessEqual(out, test_file_contents))
2068         # Now we'll do it without an explicit destination.
2069         d.addCallback(lambda ignored:
2070             self.do_cli("cp", test_file_path, "tahoe:"))
2071         d.addCallback(_check_error_message)
2072         d.addCallback(lambda ignored:
2073             self.do_cli("get", "tahoe:test_file.txt"))
2074         d.addCallback(lambda (rc, out, err):
2075             self.failUnlessEqual(out, test_file_contents))
2076         d.addCallback(lambda ignored:
2077             self.do_cli("get", self._test_read_uri))
2078         d.addCallback(lambda (rc, out, err):
2079             self.failUnlessEqual(out, test_file_contents))
2080         # Now we'll link a readonly file into a subdirectory.
2081         d.addCallback(lambda ignored:
2082             self.do_cli("mkdir", "tahoe:testdir"))
2083         d.addCallback(lambda (rc, out, err):
2084             self.failUnlessEqual(rc, 0))
2085         d.addCallback(lambda ignored:
2086             self.do_cli("ln", self._test_read_uri, "tahoe:test/file2.txt"))
2087         d.addCallback(lambda (rc, out, err):
2088             self.failUnlessEqual(rc, 0))
2089
2090         test_dir_path = os.path.join(self.basedir, "test")
2091         fileutil.make_dirs(test_dir_path)
2092         for f in ("file1.txt", "file2.txt"):
2093             fileutil.write(os.path.join(test_dir_path, f), f * 10000)
2094
2095         d.addCallback(lambda ignored:
2096             self.do_cli("cp", "-r", test_dir_path, "tahoe:test"))
2097         d.addCallback(_check_error_message)
2098         d.addCallback(lambda ignored:
2099             self.do_cli("ls", "--json", "tahoe:test"))
2100         def _got_testdir_json((rc, out, err)):
2101             self.failUnlessEqual(rc, 0)
2102
2103             filetype, data = simplejson.loads(out)
2104             self.failUnlessEqual(filetype, "dirnode")
2105
2106             self.failUnlessIn("children", data)
2107             childdata = data['children']
2108
2109             self.failUnlessIn("file2.txt", childdata)
2110             file2type, file2data = childdata['file2.txt']
2111             self.failUnlessEqual(file2type, "filenode")
2112             self.failUnless(file2data['mutable'])
2113             self.failUnlessIn("ro_uri", file2data)
2114             self.failUnlessEqual(to_str(file2data["ro_uri"]), self._test_read_uri)
2115             self.failIfIn("rw_uri", file2data)
2116         d.addCallback(_got_testdir_json)
2117         return d
2118
2119
2120 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
2121
2122     def writeto(self, path, data):
2123         full_path = os.path.join(self.basedir, "home", path)
2124         fileutil.make_dirs(os.path.dirname(full_path))
2125         fileutil.write(full_path, data)
2126
2127     def count_output(self, out):
2128         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
2129                         "(\d)+ files skipped, "
2130                         "(\d+) directories created \((\d+) reused\), "
2131                         "(\d+) directories skipped", out)
2132         return [int(s) for s in mo.groups()]
2133
2134     def count_output2(self, out):
2135         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
2136         return [int(s) for s in mo.groups()]
2137
2138     def test_backup(self):
2139         self.basedir = "cli/Backup/backup"
2140         self.set_up_grid()
2141
2142         # is the backupdb available? If so, we test that a second backup does
2143         # not create new directories.
2144         hush = StringIO()
2145         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
2146                                          hush)
2147
2148         # create a small local directory with a couple of files
2149         source = os.path.join(self.basedir, "home")
2150         fileutil.make_dirs(os.path.join(source, "empty"))
2151         self.writeto("parent/subdir/foo.txt", "foo")
2152         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
2153         self.writeto("parent/blah.txt", "blah")
2154
2155         def do_backup(verbose=False):
2156             cmd = ["backup"]
2157             if verbose:
2158                 cmd.append("--verbose")
2159             cmd.append(source)
2160             cmd.append("tahoe:backups")
2161             return self.do_cli(*cmd)
2162
2163         d = self.do_cli("create-alias", "tahoe")
2164
2165         if not have_bdb:
2166             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
2167             def _should_complain((rc, out, err)):
2168                 self.failUnless("I was unable to import a python sqlite library" in err, err)
2169             d.addCallback(_should_complain)
2170             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
2171
2172         d.addCallback(lambda res: do_backup())
2173         def _check0((rc, out, err)):
2174             self.failUnlessReallyEqual(err, "")
2175             self.failUnlessReallyEqual(rc, 0)
2176             fu, fr, fs, dc, dr, ds = self.count_output(out)
2177             # foo.txt, bar.txt, blah.txt
2178             self.failUnlessReallyEqual(fu, 3)
2179             self.failUnlessReallyEqual(fr, 0)
2180             self.failUnlessReallyEqual(fs, 0)
2181             # empty, home, home/parent, home/parent/subdir
2182             self.failUnlessReallyEqual(dc, 4)
2183             self.failUnlessReallyEqual(dr, 0)
2184             self.failUnlessReallyEqual(ds, 0)
2185         d.addCallback(_check0)
2186
2187         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
2188         def _check1((rc, out, err)):
2189             self.failUnlessReallyEqual(err, "")
2190             self.failUnlessReallyEqual(rc, 0)
2191             lines = out.split("\n")
2192             children = dict([line.split() for line in lines if line])
2193             latest_uri = children["Latest"]
2194             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
2195             childnames = children.keys()
2196             self.failUnlessReallyEqual(sorted(childnames), ["Archives", "Latest"])
2197         d.addCallback(_check1)
2198         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
2199         def _check2((rc, out, err)):
2200             self.failUnlessReallyEqual(err, "")
2201             self.failUnlessReallyEqual(rc, 0)
2202             self.failUnlessReallyEqual(sorted(out.split()), ["empty", "parent"])
2203         d.addCallback(_check2)
2204         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
2205         def _check2a((rc, out, err)):
2206             self.failUnlessReallyEqual(err, "")
2207             self.failUnlessReallyEqual(rc, 0)
2208             self.failUnlessReallyEqual(out.strip(), "")
2209         d.addCallback(_check2a)
2210         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2211         def _check3((rc, out, err)):
2212             self.failUnlessReallyEqual(err, "")
2213             self.failUnlessReallyEqual(rc, 0)
2214             self.failUnlessReallyEqual(out, "foo")
2215         d.addCallback(_check3)
2216         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2217         def _check4((rc, out, err)):
2218             self.failUnlessReallyEqual(err, "")
2219             self.failUnlessReallyEqual(rc, 0)
2220             self.old_archives = out.split()
2221             self.failUnlessReallyEqual(len(self.old_archives), 1)
2222         d.addCallback(_check4)
2223
2224
2225         d.addCallback(self.stall, 1.1)
2226         d.addCallback(lambda res: do_backup())
2227         def _check4a((rc, out, err)):
2228             # second backup should reuse everything, if the backupdb is
2229             # available
2230             self.failUnlessReallyEqual(err, "")
2231             self.failUnlessReallyEqual(rc, 0)
2232             if have_bdb:
2233                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2234                 # foo.txt, bar.txt, blah.txt
2235                 self.failUnlessReallyEqual(fu, 0)
2236                 self.failUnlessReallyEqual(fr, 3)
2237                 self.failUnlessReallyEqual(fs, 0)
2238                 # empty, home, home/parent, home/parent/subdir
2239                 self.failUnlessReallyEqual(dc, 0)
2240                 self.failUnlessReallyEqual(dr, 4)
2241                 self.failUnlessReallyEqual(ds, 0)
2242         d.addCallback(_check4a)
2243
2244         if have_bdb:
2245             # sneak into the backupdb, crank back the "last checked"
2246             # timestamp to force a check on all files
2247             def _reset_last_checked(res):
2248                 dbfile = os.path.join(self.get_clientdir(),
2249                                       "private", "backupdb.sqlite")
2250                 self.failUnless(os.path.exists(dbfile), dbfile)
2251                 bdb = backupdb.get_backupdb(dbfile)
2252                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
2253                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
2254                 bdb.connection.commit()
2255
2256             d.addCallback(_reset_last_checked)
2257
2258             d.addCallback(self.stall, 1.1)
2259             d.addCallback(lambda res: do_backup(verbose=True))
2260             def _check4b((rc, out, err)):
2261                 # we should check all files, and re-use all of them. None of
2262                 # the directories should have been changed, so we should
2263                 # re-use all of them too.
2264                 self.failUnlessReallyEqual(err, "")
2265                 self.failUnlessReallyEqual(rc, 0)
2266                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2267                 fchecked, dchecked = self.count_output2(out)
2268                 self.failUnlessReallyEqual(fchecked, 3)
2269                 self.failUnlessReallyEqual(fu, 0)
2270                 self.failUnlessReallyEqual(fr, 3)
2271                 self.failUnlessReallyEqual(fs, 0)
2272                 self.failUnlessReallyEqual(dchecked, 4)
2273                 self.failUnlessReallyEqual(dc, 0)
2274                 self.failUnlessReallyEqual(dr, 4)
2275                 self.failUnlessReallyEqual(ds, 0)
2276             d.addCallback(_check4b)
2277
2278         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2279         def _check5((rc, out, err)):
2280             self.failUnlessReallyEqual(err, "")
2281             self.failUnlessReallyEqual(rc, 0)
2282             self.new_archives = out.split()
2283             expected_new = 2
2284             if have_bdb:
2285                 expected_new += 1
2286             self.failUnlessReallyEqual(len(self.new_archives), expected_new, out)
2287             # the original backup should still be the oldest (i.e. sorts
2288             # alphabetically towards the beginning)
2289             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2290                                  self.old_archives[0])
2291         d.addCallback(_check5)
2292
2293         d.addCallback(self.stall, 1.1)
2294         def _modify(res):
2295             self.writeto("parent/subdir/foo.txt", "FOOF!")
2296             # and turn a file into a directory
2297             os.unlink(os.path.join(source, "parent/blah.txt"))
2298             os.mkdir(os.path.join(source, "parent/blah.txt"))
2299             self.writeto("parent/blah.txt/surprise file", "surprise")
2300             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
2301             # turn a directory into a file
2302             os.rmdir(os.path.join(source, "empty"))
2303             self.writeto("empty", "imagine nothing being here")
2304             return do_backup()
2305         d.addCallback(_modify)
2306         def _check5a((rc, out, err)):
2307             # second backup should reuse bar.txt (if backupdb is available),
2308             # and upload the rest. None of the directories can be reused.
2309             self.failUnlessReallyEqual(err, "")
2310             self.failUnlessReallyEqual(rc, 0)
2311             if have_bdb:
2312                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2313                 # new foo.txt, surprise file, subfile, empty
2314                 self.failUnlessReallyEqual(fu, 4)
2315                 # old bar.txt
2316                 self.failUnlessReallyEqual(fr, 1)
2317                 self.failUnlessReallyEqual(fs, 0)
2318                 # home, parent, subdir, blah.txt, surprisedir
2319                 self.failUnlessReallyEqual(dc, 5)
2320                 self.failUnlessReallyEqual(dr, 0)
2321                 self.failUnlessReallyEqual(ds, 0)
2322         d.addCallback(_check5a)
2323         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2324         def _check6((rc, out, err)):
2325             self.failUnlessReallyEqual(err, "")
2326             self.failUnlessReallyEqual(rc, 0)
2327             self.new_archives = out.split()
2328             expected_new = 3
2329             if have_bdb:
2330                 expected_new += 1
2331             self.failUnlessReallyEqual(len(self.new_archives), expected_new)
2332             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2333                                  self.old_archives[0])
2334         d.addCallback(_check6)
2335         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2336         def _check7((rc, out, err)):
2337             self.failUnlessReallyEqual(err, "")
2338             self.failUnlessReallyEqual(rc, 0)
2339             self.failUnlessReallyEqual(out, "FOOF!")
2340             # the old snapshot should not be modified
2341             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
2342         d.addCallback(_check7)
2343         def _check8((rc, out, err)):
2344             self.failUnlessReallyEqual(err, "")
2345             self.failUnlessReallyEqual(rc, 0)
2346             self.failUnlessReallyEqual(out, "foo")
2347         d.addCallback(_check8)
2348
2349         return d
2350
2351     # on our old dapper buildslave, this test takes a long time (usually
2352     # 130s), so we have to bump up the default 120s timeout. The create-alias
2353     # and initial backup alone take 60s, probably because of the handful of
2354     # dirnodes being created (RSA key generation). The backup between check4
2355     # and check4a takes 6s, as does the backup before check4b.
2356     test_backup.timeout = 3000
2357
2358     def _check_filtering(self, filtered, all, included, excluded):
2359         filtered = set(filtered)
2360         all = set(all)
2361         included = set(included)
2362         excluded = set(excluded)
2363         self.failUnlessReallyEqual(filtered, included)
2364         self.failUnlessReallyEqual(all.difference(filtered), excluded)
2365
2366     def test_exclude_options(self):
2367         root_listdir = (u'lib.a', u'_darcs', u'subdir', u'nice_doc.lyx')
2368         subdir_listdir = (u'another_doc.lyx', u'run_snake_run.py', u'CVS', u'.svn', u'_darcs')
2369         basedir = "cli/Backup/exclude_options"
2370         fileutil.make_dirs(basedir)
2371         nodeurl_path = os.path.join(basedir, 'node.url')
2372         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2373
2374         # test simple exclude
2375         backup_options = cli.BackupOptions()
2376         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2377                                      basedir, 'from', 'to'])
2378         filtered = list(backup_options.filter_listdir(root_listdir))
2379         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2380                               (u'nice_doc.lyx',))
2381         # multiple exclude
2382         backup_options = cli.BackupOptions()
2383         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
2384                                      basedir, 'from', 'to'])
2385         filtered = list(backup_options.filter_listdir(root_listdir))
2386         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2387                               (u'nice_doc.lyx', u'lib.a'))
2388         # vcs metadata exclusion
2389         backup_options = cli.BackupOptions()
2390         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
2391                                      basedir, 'from', 'to'])
2392         filtered = list(backup_options.filter_listdir(subdir_listdir))
2393         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'run_snake_run.py',),
2394                               (u'CVS', u'.svn', u'_darcs'))
2395         # read exclude patterns from file
2396         exclusion_string = "_darcs\n*py\n.svn"
2397         excl_filepath = os.path.join(basedir, 'exclusion')
2398         fileutil.write(excl_filepath, exclusion_string)
2399         backup_options = cli.BackupOptions()
2400         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2401                                      basedir, 'from', 'to'])
2402         filtered = list(backup_options.filter_listdir(subdir_listdir))
2403         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'CVS'),
2404                               (u'.svn', u'_darcs', u'run_snake_run.py'))
2405         # test BackupConfigurationError
2406         self.failUnlessRaises(cli.BackupConfigurationError,
2407                               backup_options.parseOptions,
2408                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
2409                                basedir, 'from', 'to'])
2410
2411         # test that an iterator works too
2412         backup_options = cli.BackupOptions()
2413         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2414                                      basedir, 'from', 'to'])
2415         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2416         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2417                               (u'nice_doc.lyx',))
2418
2419     def test_exclude_options_unicode(self):
2420         nice_doc = u"nice_d\u00F8c.lyx"
2421         try:
2422             doc_pattern_arg = u"*d\u00F8c*".encode(get_io_encoding())
2423         except UnicodeEncodeError:
2424             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
2425
2426         root_listdir = (u'lib.a', u'_darcs', u'subdir', nice_doc)
2427         basedir = "cli/Backup/exclude_options_unicode"
2428         fileutil.make_dirs(basedir)
2429         nodeurl_path = os.path.join(basedir, 'node.url')
2430         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2431
2432         # test simple exclude
2433         backup_options = cli.BackupOptions()
2434         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2435                                      basedir, 'from', 'to'])
2436         filtered = list(backup_options.filter_listdir(root_listdir))
2437         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2438                               (nice_doc,))
2439         # multiple exclude
2440         backup_options = cli.BackupOptions()
2441         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--exclude', 'lib.?', '--node-directory',
2442                                      basedir, 'from', 'to'])
2443         filtered = list(backup_options.filter_listdir(root_listdir))
2444         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2445                              (nice_doc, u'lib.a'))
2446         # read exclude patterns from file
2447         exclusion_string = doc_pattern_arg + "\nlib.?"
2448         excl_filepath = os.path.join(basedir, 'exclusion')
2449         fileutil.write(excl_filepath, exclusion_string)
2450         backup_options = cli.BackupOptions()
2451         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2452                                      basedir, 'from', 'to'])
2453         filtered = list(backup_options.filter_listdir(root_listdir))
2454         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2455                              (nice_doc, u'lib.a'))
2456
2457         # test that an iterator works too
2458         backup_options = cli.BackupOptions()
2459         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2460                                      basedir, 'from', 'to'])
2461         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2462         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2463                               (nice_doc,))
2464
2465     @patch('__builtin__.file')
2466     def test_exclude_from_tilde_expansion(self, mock):
2467         basedir = "cli/Backup/exclude_from_tilde_expansion"
2468         fileutil.make_dirs(basedir)
2469         nodeurl_path = os.path.join(basedir, 'node.url')
2470         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2471
2472         # ensure that tilde expansion is performed on exclude-from argument
2473         exclude_file = u'~/.tahoe/excludes.dummy'
2474         backup_options = cli.BackupOptions()
2475
2476         mock.return_value = StringIO()
2477         backup_options.parseOptions(['--exclude-from', unicode_to_argv(exclude_file),
2478                                      '--node-directory', basedir, 'from', 'to'])
2479         self.failUnlessIn(((abspath_expanduser_unicode(exclude_file),), {}), mock.call_args_list)
2480
2481     def test_ignore_symlinks(self):
2482         if not hasattr(os, 'symlink'):
2483             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
2484
2485         self.basedir = os.path.dirname(self.mktemp())
2486         self.set_up_grid()
2487
2488         source = os.path.join(self.basedir, "home")
2489         self.writeto("foo.txt", "foo")
2490         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
2491
2492         d = self.do_cli("create-alias", "tahoe")
2493         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
2494
2495         def _check((rc, out, err)):
2496             self.failUnlessReallyEqual(rc, 2)
2497             foo2 = os.path.join(source, "foo2.txt")
2498             self.failUnlessReallyEqual(err, "WARNING: cannot backup symlink '%s'\n" % foo2)
2499
2500             fu, fr, fs, dc, dr, ds = self.count_output(out)
2501             # foo.txt
2502             self.failUnlessReallyEqual(fu, 1)
2503             self.failUnlessReallyEqual(fr, 0)
2504             # foo2.txt
2505             self.failUnlessReallyEqual(fs, 1)
2506             # home
2507             self.failUnlessReallyEqual(dc, 1)
2508             self.failUnlessReallyEqual(dr, 0)
2509             self.failUnlessReallyEqual(ds, 0)
2510
2511         d.addCallback(_check)
2512         return d
2513
2514     def test_ignore_unreadable_file(self):
2515         self.basedir = os.path.dirname(self.mktemp())
2516         self.set_up_grid()
2517
2518         source = os.path.join(self.basedir, "home")
2519         self.writeto("foo.txt", "foo")
2520         os.chmod(os.path.join(source, "foo.txt"), 0000)
2521
2522         d = self.do_cli("create-alias", "tahoe")
2523         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2524
2525         def _check((rc, out, err)):
2526             self.failUnlessReallyEqual(rc, 2)
2527             self.failUnlessReallyEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
2528
2529             fu, fr, fs, dc, dr, ds = self.count_output(out)
2530             self.failUnlessReallyEqual(fu, 0)
2531             self.failUnlessReallyEqual(fr, 0)
2532             # foo.txt
2533             self.failUnlessReallyEqual(fs, 1)
2534             # home
2535             self.failUnlessReallyEqual(dc, 1)
2536             self.failUnlessReallyEqual(dr, 0)
2537             self.failUnlessReallyEqual(ds, 0)
2538         d.addCallback(_check)
2539
2540         # This is necessary for the temp files to be correctly removed
2541         def _cleanup(self):
2542             os.chmod(os.path.join(source, "foo.txt"), 0644)
2543         d.addCallback(_cleanup)
2544         d.addErrback(_cleanup)
2545
2546         return d
2547
2548     def test_ignore_unreadable_directory(self):
2549         self.basedir = os.path.dirname(self.mktemp())
2550         self.set_up_grid()
2551
2552         source = os.path.join(self.basedir, "home")
2553         os.mkdir(source)
2554         os.mkdir(os.path.join(source, "test"))
2555         os.chmod(os.path.join(source, "test"), 0000)
2556
2557         d = self.do_cli("create-alias", "tahoe")
2558         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2559
2560         def _check((rc, out, err)):
2561             self.failUnlessReallyEqual(rc, 2)
2562             self.failUnlessReallyEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
2563
2564             fu, fr, fs, dc, dr, ds = self.count_output(out)
2565             self.failUnlessReallyEqual(fu, 0)
2566             self.failUnlessReallyEqual(fr, 0)
2567             self.failUnlessReallyEqual(fs, 0)
2568             # home, test
2569             self.failUnlessReallyEqual(dc, 2)
2570             self.failUnlessReallyEqual(dr, 0)
2571             # test
2572             self.failUnlessReallyEqual(ds, 1)
2573         d.addCallback(_check)
2574
2575         # This is necessary for the temp files to be correctly removed
2576         def _cleanup(self):
2577             os.chmod(os.path.join(source, "test"), 0655)
2578         d.addCallback(_cleanup)
2579         d.addErrback(_cleanup)
2580         return d
2581
2582     def test_backup_without_alias(self):
2583         # 'tahoe backup' should output a sensible error message when invoked
2584         # without an alias instead of a stack trace.
2585         self.basedir = os.path.dirname(self.mktemp())
2586         self.set_up_grid()
2587         source = os.path.join(self.basedir, "file1")
2588         d = self.do_cli('backup', source, source)
2589         def _check((rc, out, err)):
2590             self.failUnlessReallyEqual(rc, 1)
2591             self.failUnlessIn("error:", err)
2592             self.failUnlessReallyEqual(out, "")
2593         d.addCallback(_check)
2594         return d
2595
2596     def test_backup_with_nonexistent_alias(self):
2597         # 'tahoe backup' should output a sensible error message when invoked
2598         # with a nonexistent alias.
2599         self.basedir = os.path.dirname(self.mktemp())
2600         self.set_up_grid()
2601         source = os.path.join(self.basedir, "file1")
2602         d = self.do_cli("backup", source, "nonexistent:" + source)
2603         def _check((rc, out, err)):
2604             self.failUnlessReallyEqual(rc, 1)
2605             self.failUnlessIn("error:", err)
2606             self.failUnlessIn("nonexistent", err)
2607             self.failUnlessReallyEqual(out, "")
2608         d.addCallback(_check)
2609         return d
2610
2611
2612 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
2613
2614     def test_check(self):
2615         self.basedir = "cli/Check/check"
2616         self.set_up_grid()
2617         c0 = self.g.clients[0]
2618         DATA = "data" * 100
2619         d = c0.create_mutable_file(DATA)
2620         def _stash_uri(n):
2621             self.uri = n.get_uri()
2622         d.addCallback(_stash_uri)
2623
2624         d.addCallback(lambda ign: self.do_cli("check", self.uri))
2625         def _check1((rc, out, err)):
2626             self.failUnlessReallyEqual(err, "")
2627             self.failUnlessReallyEqual(rc, 0)
2628             lines = out.splitlines()
2629             self.failUnless("Summary: Healthy" in lines, out)
2630             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2631         d.addCallback(_check1)
2632
2633         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
2634         def _check2((rc, out, err)):
2635             self.failUnlessReallyEqual(err, "")
2636             self.failUnlessReallyEqual(rc, 0)
2637             data = simplejson.loads(out)
2638             self.failUnlessReallyEqual(to_str(data["summary"]), "Healthy")
2639         d.addCallback(_check2)
2640
2641         def _clobber_shares(ignored):
2642             # delete one, corrupt a second
2643             shares = self.find_uri_shares(self.uri)
2644             self.failUnlessReallyEqual(len(shares), 10)
2645             os.unlink(shares[0][2])
2646             cso = debug.CorruptShareOptions()
2647             cso.stdout = StringIO()
2648             cso.parseOptions([shares[1][2]])
2649             storage_index = uri.from_string(self.uri).get_storage_index()
2650             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
2651                                        (base32.b2a(shares[1][1]),
2652                                         base32.b2a(storage_index),
2653                                         shares[1][0])
2654             debug.corrupt_share(cso)
2655         d.addCallback(_clobber_shares)
2656
2657         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
2658         def _check3((rc, out, err)):
2659             self.failUnlessReallyEqual(err, "")
2660             self.failUnlessReallyEqual(rc, 0)
2661             lines = out.splitlines()
2662             summary = [l for l in lines if l.startswith("Summary")][0]
2663             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
2664                             in summary, summary)
2665             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2666             self.failUnless(" corrupt shares:" in lines, out)
2667             self.failUnless(self._corrupt_share_line in lines, out)
2668         d.addCallback(_check3)
2669
2670         d.addCallback(lambda ign:
2671                       self.do_cli("check", "--verify", "--repair", self.uri))
2672         def _check4((rc, out, err)):
2673             self.failUnlessReallyEqual(err, "")
2674             self.failUnlessReallyEqual(rc, 0)
2675             lines = out.splitlines()
2676             self.failUnless("Summary: not healthy" in lines, out)
2677             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2678             self.failUnless(" corrupt shares:" in lines, out)
2679             self.failUnless(self._corrupt_share_line in lines, out)
2680             self.failUnless(" repair successful" in lines, out)
2681         d.addCallback(_check4)
2682
2683         d.addCallback(lambda ign:
2684                       self.do_cli("check", "--verify", "--repair", self.uri))
2685         def _check5((rc, out, err)):
2686             self.failUnlessReallyEqual(err, "")
2687             self.failUnlessReallyEqual(rc, 0)
2688             lines = out.splitlines()
2689             self.failUnless("Summary: healthy" in lines, out)
2690             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2691             self.failIf(" corrupt shares:" in lines, out)
2692         d.addCallback(_check5)
2693
2694         return d
2695
2696     def test_deep_check(self):
2697         self.basedir = "cli/Check/deep_check"
2698         self.set_up_grid()
2699         c0 = self.g.clients[0]
2700         self.uris = {}
2701         self.fileurls = {}
2702         DATA = "data" * 100
2703         quoted_good = quote_output(u"g\u00F6\u00F6d")
2704
2705         d = c0.create_dirnode()
2706         def _stash_root_and_create_file(n):
2707             self.rootnode = n
2708             self.rooturi = n.get_uri()
2709             return n.add_file(u"g\u00F6\u00F6d", upload.Data(DATA, convergence=""))
2710         d.addCallback(_stash_root_and_create_file)
2711         def _stash_uri(fn, which):
2712             self.uris[which] = fn.get_uri()
2713             return fn
2714         d.addCallback(_stash_uri, u"g\u00F6\u00F6d")
2715         d.addCallback(lambda ign:
2716                       self.rootnode.add_file(u"small",
2717                                            upload.Data("literal",
2718                                                         convergence="")))
2719         d.addCallback(_stash_uri, "small")
2720         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
2721         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
2722         d.addCallback(_stash_uri, "mutable")
2723
2724         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2725         def _check1((rc, out, err)):
2726             self.failUnlessReallyEqual(err, "")
2727             self.failUnlessReallyEqual(rc, 0)
2728             lines = out.splitlines()
2729             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2730                             in lines, out)
2731         d.addCallback(_check1)
2732
2733         # root
2734         # root/g\u00F6\u00F6d
2735         # root/small
2736         # root/mutable
2737
2738         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
2739                                               self.rooturi))
2740         def _check2((rc, out, err)):
2741             self.failUnlessReallyEqual(err, "")
2742             self.failUnlessReallyEqual(rc, 0)
2743             lines = out.splitlines()
2744             self.failUnless("'<root>': Healthy" in lines, out)
2745             self.failUnless("'small': Healthy (LIT)" in lines, out)
2746             self.failUnless((quoted_good + ": Healthy") in lines, out)
2747             self.failUnless("'mutable': Healthy" in lines, out)
2748             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2749                             in lines, out)
2750         d.addCallback(_check2)
2751
2752         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2753         def _check_stats((rc, out, err)):
2754             self.failUnlessReallyEqual(err, "")
2755             self.failUnlessReallyEqual(rc, 0)
2756             lines = out.splitlines()
2757             self.failUnlessIn(" count-immutable-files: 1", lines)
2758             self.failUnlessIn("   count-mutable-files: 1", lines)
2759             self.failUnlessIn("   count-literal-files: 1", lines)
2760             self.failUnlessIn("     count-directories: 1", lines)
2761             self.failUnlessIn("  size-immutable-files: 400", lines)
2762             self.failUnlessIn("Size Histogram:", lines)
2763             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
2764             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
2765         d.addCallback(_check_stats)
2766
2767         def _clobber_shares(ignored):
2768             shares = self.find_uri_shares(self.uris[u"g\u00F6\u00F6d"])
2769             self.failUnlessReallyEqual(len(shares), 10)
2770             os.unlink(shares[0][2])
2771
2772             shares = self.find_uri_shares(self.uris["mutable"])
2773             cso = debug.CorruptShareOptions()
2774             cso.stdout = StringIO()
2775             cso.parseOptions([shares[1][2]])
2776             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
2777             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
2778                                        (base32.b2a(shares[1][1]),
2779                                         base32.b2a(storage_index),
2780                                         shares[1][0])
2781             debug.corrupt_share(cso)
2782         d.addCallback(_clobber_shares)
2783
2784         # root
2785         # root/g\u00F6\u00F6d  [9 shares]
2786         # root/small
2787         # root/mutable [1 corrupt share]
2788
2789         d.addCallback(lambda ign:
2790                       self.do_cli("deep-check", "--verbose", self.rooturi))
2791         def _check3((rc, out, err)):
2792             self.failUnlessReallyEqual(err, "")
2793             self.failUnlessReallyEqual(rc, 0)
2794             lines = out.splitlines()
2795             self.failUnless("'<root>': Healthy" in lines, out)
2796             self.failUnless("'small': Healthy (LIT)" in lines, out)
2797             self.failUnless("'mutable': Healthy" in lines, out) # needs verifier
2798             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
2799             self.failIf(self._corrupt_share_line in lines, out)
2800             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
2801                             in lines, out)
2802         d.addCallback(_check3)
2803
2804         d.addCallback(lambda ign:
2805                       self.do_cli("deep-check", "--verbose", "--verify",
2806                                   self.rooturi))
2807         def _check4((rc, out, err)):
2808             self.failUnlessReallyEqual(err, "")
2809             self.failUnlessReallyEqual(rc, 0)
2810             lines = out.splitlines()
2811             self.failUnless("'<root>': Healthy" in lines, out)
2812             self.failUnless("'small': Healthy (LIT)" in lines, out)
2813             mutable = [l for l in lines if l.startswith("'mutable'")][0]
2814             self.failUnless(mutable.startswith("'mutable': Unhealthy: 9 shares (enc 3-of-10)"),
2815                             mutable)
2816             self.failUnless(self._corrupt_share_line in lines, out)
2817             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
2818             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
2819                             in lines, out)
2820         d.addCallback(_check4)
2821
2822         d.addCallback(lambda ign:
2823                       self.do_cli("deep-check", "--raw",
2824                                   self.rooturi))
2825         def _check5((rc, out, err)):
2826             self.failUnlessReallyEqual(err, "")
2827             self.failUnlessReallyEqual(rc, 0)
2828             lines = out.splitlines()
2829             units = [simplejson.loads(line) for line in lines]
2830             # root, small, g\u00F6\u00F6d, mutable,  stats
2831             self.failUnlessReallyEqual(len(units), 4+1)
2832         d.addCallback(_check5)
2833
2834         d.addCallback(lambda ign:
2835                       self.do_cli("deep-check",
2836                                   "--verbose", "--verify", "--repair",
2837                                   self.rooturi))
2838         def _check6((rc, out, err)):
2839             self.failUnlessReallyEqual(err, "")
2840             self.failUnlessReallyEqual(rc, 0)
2841             lines = out.splitlines()
2842             self.failUnless("'<root>': healthy" in lines, out)
2843             self.failUnless("'small': healthy" in lines, out)
2844             self.failUnless("'mutable': not healthy" in lines, out)
2845             self.failUnless(self._corrupt_share_line in lines, out)
2846             self.failUnless((quoted_good + ": not healthy") in lines, out)
2847             self.failUnless("done: 4 objects checked" in lines, out)
2848             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
2849             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
2850                             in lines, out)
2851             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
2852         d.addCallback(_check6)
2853
2854         # now add a subdir, and a file below that, then make the subdir
2855         # unrecoverable
2856
2857         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
2858         d.addCallback(_stash_uri, "subdir")
2859         d.addCallback(lambda fn:
2860                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
2861         d.addCallback(lambda ign:
2862                       self.delete_shares_numbered(self.uris["subdir"],
2863                                                   range(10)))
2864
2865         # root
2866         # rootg\u00F6\u00F6d/
2867         # root/small
2868         # root/mutable
2869         # root/subdir [unrecoverable: 0 shares]
2870         # root/subfile
2871
2872         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
2873         def _manifest_failed((rc, out, err)):
2874             self.failIfEqual(rc, 0)
2875             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2876             # the fatal directory should still show up, as the last line
2877             self.failUnlessIn(" subdir\n", out)
2878         d.addCallback(_manifest_failed)
2879
2880         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2881         def _deep_check_failed((rc, out, err)):
2882             self.failIfEqual(rc, 0)
2883             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2884             # we want to make sure that the error indication is the last
2885             # thing that gets emitted
2886             self.failIf("done:" in out, out)
2887         d.addCallback(_deep_check_failed)
2888
2889         # this test is disabled until the deep-repair response to an
2890         # unrepairable directory is fixed. The failure-to-repair should not
2891         # throw an exception, but the failure-to-traverse that follows
2892         # should throw UnrecoverableFileError.
2893
2894         #d.addCallback(lambda ign:
2895         #              self.do_cli("deep-check", "--repair", self.rooturi))
2896         #def _deep_check_repair_failed((rc, out, err)):
2897         #    self.failIfEqual(rc, 0)
2898         #    print err
2899         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2900         #    self.failIf("done:" in out, out)
2901         #d.addCallback(_deep_check_repair_failed)
2902
2903         return d
2904
2905     def test_check_without_alias(self):
2906         # 'tahoe check' should output a sensible error message if it needs to
2907         # find the default alias and can't
2908         self.basedir = "cli/Check/check_without_alias"
2909         self.set_up_grid()
2910         d = self.do_cli("check")
2911         def _check((rc, out, err)):
2912             self.failUnlessReallyEqual(rc, 1)
2913             self.failUnlessIn("error:", err)
2914             self.failUnlessReallyEqual(out, "")
2915         d.addCallback(_check)
2916         d.addCallback(lambda ign: self.do_cli("deep-check"))
2917         d.addCallback(_check)
2918         return d
2919
2920     def test_check_with_nonexistent_alias(self):
2921         # 'tahoe check' should output a sensible error message if it needs to
2922         # find an alias and can't.
2923         self.basedir = "cli/Check/check_with_nonexistent_alias"
2924         self.set_up_grid()
2925         d = self.do_cli("check", "nonexistent:")
2926         def _check((rc, out, err)):
2927             self.failUnlessReallyEqual(rc, 1)
2928             self.failUnlessIn("error:", err)
2929             self.failUnlessIn("nonexistent", err)
2930             self.failUnlessReallyEqual(out, "")
2931         d.addCallback(_check)
2932         return d
2933
2934
2935 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
2936     def test_get(self):
2937         self.basedir = "cli/Errors/get"
2938         self.set_up_grid()
2939         c0 = self.g.clients[0]
2940         self.fileurls = {}
2941         DATA = "data" * 100
2942         d = c0.upload(upload.Data(DATA, convergence=""))
2943         def _stash_bad(ur):
2944             self.uri_1share = ur.uri
2945             self.delete_shares_numbered(ur.uri, range(1,10))
2946         d.addCallback(_stash_bad)
2947
2948         # the download is abandoned as soon as it's clear that we won't get
2949         # enough shares. The one remaining share might be in either the
2950         # COMPLETE or the PENDING state.
2951         in_complete_msg = "ran out of shares: complete=sh0 pending= overdue= unused= need 3"
2952         in_pending_msg = "ran out of shares: complete= pending=Share(sh0-on-fob7vqgd) overdue= unused= need 3"
2953
2954         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
2955         def _check1((rc, out, err)):
2956             self.failIfEqual(rc, 0)
2957             self.failUnless("410 Gone" in err, err)
2958             self.failUnlessIn("NotEnoughSharesError: ", err)
2959             self.failUnless(in_complete_msg in err or in_pending_msg in err,
2960                             err)
2961         d.addCallback(_check1)
2962
2963         targetf = os.path.join(self.basedir, "output")
2964         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
2965         def _check2((rc, out, err)):
2966             self.failIfEqual(rc, 0)
2967             self.failUnless("410 Gone" in err, err)
2968             self.failUnlessIn("NotEnoughSharesError: ", err)
2969             self.failUnless(in_complete_msg in err or in_pending_msg in err,
2970                             err)
2971             self.failIf(os.path.exists(targetf))
2972         d.addCallback(_check2)
2973
2974         return d
2975
2976
2977 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
2978     def test_get_without_alias(self):
2979         # 'tahoe get' should output a useful error message when invoked
2980         # without an explicit alias and when the default 'tahoe' alias
2981         # hasn't been created yet.
2982         self.basedir = "cli/Get/get_without_alias"
2983         self.set_up_grid()
2984         d = self.do_cli('get', 'file')
2985         def _check((rc, out, err)):
2986             self.failUnlessReallyEqual(rc, 1)
2987             self.failUnlessIn("error:", err)
2988             self.failUnlessReallyEqual(out, "")
2989         d.addCallback(_check)
2990         return d
2991
2992     def test_get_with_nonexistent_alias(self):
2993         # 'tahoe get' should output a useful error message when invoked with
2994         # an explicit alias that doesn't exist.
2995         self.basedir = "cli/Get/get_with_nonexistent_alias"
2996         self.set_up_grid()
2997         d = self.do_cli("get", "nonexistent:file")
2998         def _check((rc, out, err)):
2999             self.failUnlessReallyEqual(rc, 1)
3000             self.failUnlessIn("error:", err)
3001             self.failUnlessIn("nonexistent", err)
3002             self.failUnlessReallyEqual(out, "")
3003         d.addCallback(_check)
3004         return d
3005
3006
3007 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
3008     def test_manifest_without_alias(self):
3009         # 'tahoe manifest' should output a useful error message when invoked
3010         # without an explicit alias when the default 'tahoe' alias is
3011         # missing.
3012         self.basedir = "cli/Manifest/manifest_without_alias"
3013         self.set_up_grid()
3014         d = self.do_cli("manifest")
3015         def _check((rc, out, err)):
3016             self.failUnlessReallyEqual(rc, 1)
3017             self.failUnlessIn("error:", err)
3018             self.failUnlessReallyEqual(out, "")
3019         d.addCallback(_check)
3020         return d
3021
3022     def test_manifest_with_nonexistent_alias(self):
3023         # 'tahoe manifest' should output a useful error message when invoked
3024         # with an explicit alias that doesn't exist.
3025         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
3026         self.set_up_grid()
3027         d = self.do_cli("manifest", "nonexistent:")
3028         def _check((rc, out, err)):
3029             self.failUnlessReallyEqual(rc, 1)
3030             self.failUnlessIn("error:", err)
3031             self.failUnlessIn("nonexistent", err)
3032             self.failUnlessReallyEqual(out, "")
3033         d.addCallback(_check)
3034         return d
3035
3036
3037 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
3038     def test_mkdir(self):
3039         self.basedir = os.path.dirname(self.mktemp())
3040         self.set_up_grid()
3041
3042         d = self.do_cli("create-alias", "tahoe")
3043         d.addCallback(lambda res: self.do_cli("mkdir", "test"))
3044         def _check((rc, out, err)):
3045             self.failUnlessReallyEqual(rc, 0)
3046             self.failUnlessReallyEqual(err, "")
3047             self.failUnlessIn("URI:", out)
3048         d.addCallback(_check)
3049
3050         return d
3051
3052     def test_mkdir_mutable_type(self):
3053         self.basedir = os.path.dirname(self.mktemp())
3054         self.set_up_grid()
3055         d = self.do_cli("create-alias", "tahoe")
3056         d.addCallback(lambda ignored:
3057             self.do_cli("mkdir", "--mutable-type=sdmf", "tahoe:foo"))
3058         def _check((rc, out, err), st):
3059             self.failUnlessReallyEqual(rc, 0)
3060             self.failUnlessReallyEqual(err, "")
3061             self.failUnlessIn(st, out)
3062             return out
3063         def _stash_dircap(cap):
3064             self._dircap = cap
3065             u = uri.from_string(cap)
3066             fn_uri = u.get_filenode_cap()
3067             self._filecap = fn_uri.to_string()
3068         d.addCallback(_check, "URI:DIR2")
3069         d.addCallback(_stash_dircap)
3070         d.addCallback(lambda ignored:
3071             self.do_cli("ls", "--json", "tahoe:foo"))
3072         d.addCallback(_check, "URI:DIR2")
3073         d.addCallback(lambda ignored:
3074             self.do_cli("ls", "--json", self._filecap))
3075         d.addCallback(_check, '"mutable-type": "sdmf"')
3076         d.addCallback(lambda ignored:
3077             self.do_cli("mkdir", "--mutable-type=mdmf", "tahoe:bar"))
3078         d.addCallback(_check, "URI:DIR2-MDMF")
3079         d.addCallback(_stash_dircap)
3080         d.addCallback(lambda ignored:
3081             self.do_cli("ls", "--json", "tahoe:bar"))
3082         d.addCallback(_check, "URI:DIR2-MDMF")
3083         d.addCallback(lambda ignored:
3084             self.do_cli("ls", "--json", self._filecap))
3085         d.addCallback(_check, '"mutable-type": "mdmf"')
3086         return d
3087
3088     def test_mkdir_mutable_type_unlinked(self):
3089         self.basedir = os.path.dirname(self.mktemp())
3090         self.set_up_grid()
3091         d = self.do_cli("mkdir", "--mutable-type=sdmf")
3092         def _check((rc, out, err), st):
3093             self.failUnlessReallyEqual(rc, 0)
3094             self.failUnlessReallyEqual(err, "")
3095             self.failUnlessIn(st, out)
3096             return out
3097         d.addCallback(_check, "URI:DIR2")
3098         def _stash_dircap(cap):
3099             self._dircap = cap
3100             # Now we're going to feed the cap into uri.from_string...
3101             u = uri.from_string(cap)
3102             # ...grab the underlying filenode uri.
3103             fn_uri = u.get_filenode_cap()
3104             # ...and stash that.
3105             self._filecap = fn_uri.to_string()
3106         d.addCallback(_stash_dircap)
3107         d.addCallback(lambda res: self.do_cli("ls", "--json",
3108                                               self._filecap))
3109         d.addCallback(_check, '"mutable-type": "sdmf"')
3110         d.addCallback(lambda res: self.do_cli("mkdir", "--mutable-type=mdmf"))
3111         d.addCallback(_check, "URI:DIR2-MDMF")
3112         d.addCallback(_stash_dircap)
3113         d.addCallback(lambda res: self.do_cli("ls", "--json",
3114                                               self._filecap))
3115         d.addCallback(_check, '"mutable-type": "mdmf"')
3116         return d
3117
3118     def test_mkdir_bad_mutable_type(self):
3119         o = cli.MakeDirectoryOptions()
3120         self.failUnlessRaises(usage.UsageError,
3121                               o.parseOptions,
3122                               ["--mutable", "--mutable-type=ldmf"])
3123
3124     def test_mkdir_unicode(self):
3125         self.basedir = os.path.dirname(self.mktemp())
3126         self.set_up_grid()
3127
3128         try:
3129             motorhead_arg = u"tahoe:Mot\u00F6rhead".encode(get_io_encoding())
3130         except UnicodeEncodeError:
3131             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
3132
3133         d = self.do_cli("create-alias", "tahoe")
3134         d.addCallback(lambda res: self.do_cli("mkdir", motorhead_arg))
3135         def _check((rc, out, err)):
3136             self.failUnlessReallyEqual(rc, 0)
3137             self.failUnlessReallyEqual(err, "")
3138             self.failUnlessIn("URI:", out)
3139         d.addCallback(_check)
3140
3141         return d
3142
3143     def test_mkdir_with_nonexistent_alias(self):
3144         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
3145         # output a sensible error message rather than a stack trace.
3146         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
3147         self.set_up_grid()
3148         d = self.do_cli("mkdir", "havasu:")
3149         def _check((rc, out, err)):
3150             self.failUnlessReallyEqual(rc, 1)
3151             self.failUnlessIn("error:", err)
3152             self.failUnlessReallyEqual(out, "")
3153         d.addCallback(_check)
3154         return d
3155
3156
3157 class Unlink(GridTestMixin, CLITestMixin, unittest.TestCase):
3158     command = "unlink"
3159
3160     def _create_test_file(self):
3161         data = "puppies" * 1000
3162         path = os.path.join(self.basedir, "datafile")
3163         fileutil.write(path, data)
3164         self.datafile = path
3165
3166     def test_unlink_without_alias(self):
3167         # 'tahoe unlink' should behave sensibly when invoked without an explicit
3168         # alias before the default 'tahoe' alias has been created.
3169         self.basedir = "cli/Unlink/%s_without_alias" % (self.command,)
3170         self.set_up_grid()
3171         d = self.do_cli(self.command, "afile")
3172         def _check((rc, out, err)):
3173             self.failUnlessReallyEqual(rc, 1)
3174             self.failUnlessIn("error:", err)
3175             self.failUnlessReallyEqual(out, "")
3176         d.addCallback(_check)
3177
3178         d.addCallback(lambda ign: self.do_cli(self.command, "afile"))
3179         d.addCallback(_check)
3180         return d
3181
3182     def test_unlink_with_nonexistent_alias(self):
3183         # 'tahoe unlink' should behave sensibly when invoked with an explicit
3184         # alias that doesn't exist.
3185         self.basedir = "cli/Unlink/%s_with_nonexistent_alias" % (self.command,)
3186         self.set_up_grid()
3187         d = self.do_cli(self.command, "nonexistent:afile")
3188         def _check((rc, out, err)):
3189             self.failUnlessReallyEqual(rc, 1)
3190             self.failUnlessIn("error:", err)
3191             self.failUnlessIn("nonexistent", err)
3192             self.failUnlessReallyEqual(out, "")
3193         d.addCallback(_check)
3194
3195         d.addCallback(lambda ign: self.do_cli(self.command, "nonexistent:afile"))
3196         d.addCallback(_check)
3197         return d
3198
3199     def test_unlink_without_path(self):
3200         # 'tahoe unlink' should give a sensible error message when invoked without a path.
3201         self.basedir = "cli/Unlink/%s_without_path" % (self.command,)
3202         self.set_up_grid()
3203         self._create_test_file()
3204         d = self.do_cli("create-alias", "tahoe")
3205         d.addCallback(lambda ign: self.do_cli("put", self.datafile, "tahoe:test"))
3206         def _do_unlink((rc, out, err)):
3207             self.failUnlessReallyEqual(rc, 0)
3208             self.failUnless(out.startswith("URI:"), out)
3209             return self.do_cli(self.command, out.strip('\n'))
3210         d.addCallback(_do_unlink)
3211
3212         def _check((rc, out, err)):
3213             self.failUnlessReallyEqual(rc, 1)
3214             self.failUnlessIn("'tahoe %s'" % (self.command,), err)
3215             self.failUnlessIn("path must be given", err)
3216             self.failUnlessReallyEqual(out, "")
3217         d.addCallback(_check)
3218         return d
3219
3220
3221 class Rm(Unlink):
3222     """Test that 'tahoe rm' behaves in the same way as 'tahoe unlink'."""
3223     command = "rm"
3224
3225
3226 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
3227     def test_empty_directory(self):
3228         self.basedir = "cli/Stats/empty_directory"
3229         self.set_up_grid()
3230         c0 = self.g.clients[0]
3231         self.fileurls = {}
3232         d = c0.create_dirnode()
3233         def _stash_root(n):
3234             self.rootnode = n
3235             self.rooturi = n.get_uri()
3236         d.addCallback(_stash_root)
3237
3238         # make sure we can get stats on an empty directory too
3239         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
3240         def _check_stats((rc, out, err)):
3241             self.failUnlessReallyEqual(err, "")
3242             self.failUnlessReallyEqual(rc, 0)
3243             lines = out.splitlines()
3244             self.failUnlessIn(" count-immutable-files: 0", lines)
3245             self.failUnlessIn("   count-mutable-files: 0", lines)
3246             self.failUnlessIn("   count-literal-files: 0", lines)
3247             self.failUnlessIn("     count-directories: 1", lines)
3248             self.failUnlessIn("  size-immutable-files: 0", lines)
3249             self.failIfIn("Size Histogram:", lines)
3250         d.addCallback(_check_stats)
3251
3252         return d
3253
3254     def test_stats_without_alias(self):
3255         # when invoked with no explicit alias and before the default 'tahoe'
3256         # alias is created, 'tahoe stats' should output an informative error
3257         # message, not a stack trace.
3258         self.basedir = "cli/Stats/stats_without_alias"
3259         self.set_up_grid()
3260         d = self.do_cli("stats")
3261         def _check((rc, out, err)):
3262             self.failUnlessReallyEqual(rc, 1)
3263             self.failUnlessIn("error:", err)
3264             self.failUnlessReallyEqual(out, "")
3265         d.addCallback(_check)
3266         return d
3267
3268     def test_stats_with_nonexistent_alias(self):
3269         # when invoked with an explicit alias that doesn't exist,
3270         # 'tahoe stats' should output a useful error message.
3271         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
3272         self.set_up_grid()
3273         d = self.do_cli("stats", "havasu:")
3274         def _check((rc, out, err)):
3275             self.failUnlessReallyEqual(rc, 1)
3276             self.failUnlessIn("error:", err)
3277             self.failUnlessReallyEqual(out, "")
3278         d.addCallback(_check)
3279         return d
3280
3281
3282 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
3283     def test_webopen_with_nonexistent_alias(self):
3284         # when invoked with an alias that doesn't exist, 'tahoe webopen'
3285         # should output an informative error message instead of a stack
3286         # trace.
3287         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
3288         self.set_up_grid()
3289         d = self.do_cli("webopen", "fake:")
3290         def _check((rc, out, err)):
3291             self.failUnlessReallyEqual(rc, 1)
3292             self.failUnlessIn("error:", err)
3293             self.failUnlessReallyEqual(out, "")
3294         d.addCallback(_check)
3295         return d
3296
3297     def test_webopen(self):
3298         # TODO: replace with @patch that supports Deferreds.
3299         import webbrowser
3300         def call_webbrowser_open(url):
3301             self.failUnlessIn(self.alias_uri.replace(':', '%3A'), url)
3302             self.webbrowser_open_called = True
3303         def _cleanup(res):
3304             webbrowser.open = self.old_webbrowser_open
3305             return res
3306
3307         self.old_webbrowser_open = webbrowser.open
3308         try:
3309             webbrowser.open = call_webbrowser_open
3310
3311             self.basedir = "cli/Webopen/webopen"
3312             self.set_up_grid()
3313             d = self.do_cli("create-alias", "alias:")
3314             def _check_alias((rc, out, err)):
3315                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3316                 self.failUnlessIn("Alias 'alias' created", out)
3317                 self.failUnlessReallyEqual(err, "")
3318                 self.alias_uri = get_aliases(self.get_clientdir())["alias"]
3319             d.addCallback(_check_alias)
3320             d.addCallback(lambda res: self.do_cli("webopen", "alias:"))
3321             def _check_webopen((rc, out, err)):
3322                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3323                 self.failUnlessReallyEqual(out, "")
3324                 self.failUnlessReallyEqual(err, "")
3325                 self.failUnless(self.webbrowser_open_called)
3326             d.addCallback(_check_webopen)
3327             d.addBoth(_cleanup)
3328         except:
3329             _cleanup(None)
3330             raise
3331         return d