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 -- although the actual tests of their
  16 # functionality are done by invoking them in a subprocess.
  17 from allmydata.scripts import create_node, debug, keygen, startstop_node, \
  18     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls, \
  19     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_rm, tahoe_webopen
  20 _hush_pyflakes = [create_node, debug, keygen, startstop_node,
  21     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls,
  22     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_rm, tahoe_webopen]
  23
  24 from allmydata.scripts import common
  25 from allmydata.scripts.common import DEFAULT_ALIAS, get_aliases, get_alias, \
  26      DefaultAliasMarker
  27
  28 from allmydata.scripts import cli, debug, runner, backupdb
  29 from allmydata.test.common_util import StallMixin, ReallyEqualMixin
  30 from allmydata.test.no_network import GridTestMixin
  31 from twisted.internet import threads # CLI tests use deferToThread
  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_output_encoding, get_argv_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
 452     def test_get(self):
 453         help = str(cli.GetOptions())
 454         self.failUnless("get REMOTE_FILE LOCAL_FILE" in help, help)
 455         self.failUnless("% tahoe get FOO |less" in help, help)
 456
 457     def test_put(self):
 458         help = str(cli.PutOptions())
 459         self.failUnless("put LOCAL_FILE REMOTE_FILE" in help, help)
 460         self.failUnless("% cat FILE | tahoe put" in help, help)
 461
 462     def test_rm(self):
 463         help = str(cli.RmOptions())
 464         self.failUnless("rm REMOTE_FILE" in help, help)
 465
 466     def test_mv(self):
 467         help = str(cli.MvOptions())
 468         self.failUnless("mv FROM TO" in help, help)
 469         self.failUnless("Use 'tahoe mv' to move files" in help)
 470
 471     def test_ln(self):
 472         help = str(cli.LnOptions())
 473         self.failUnless("ln FROM TO" in help, help)
 474
 475     def test_backup(self):
 476         help = str(cli.BackupOptions())
 477         self.failUnless("backup FROM ALIAS:TO" in help, help)
 478
 479     def test_webopen(self):
 480         help = str(cli.WebopenOptions())
 481         self.failUnless("webopen [ALIAS:PATH]" in help, help)
 482
 483     def test_manifest(self):
 484         help = str(cli.ManifestOptions())
 485         self.failUnless("manifest [ALIAS:PATH]" in help, help)
 486
 487     def test_stats(self):
 488         help = str(cli.StatsOptions())
 489         self.failUnless("stats [ALIAS:PATH]" in help, help)
 490
 491     def test_check(self):
 492         help = str(cli.CheckOptions())
 493         self.failUnless("check [ALIAS:PATH]" in help, help)
 494
 495     def test_deep_check(self):
 496         help = str(cli.DeepCheckOptions())
 497         self.failUnless("deep-check [ALIAS:PATH]" in help, help)
 498
 499     def test_create_alias(self):
 500         help = str(cli.CreateAliasOptions())
 501         self.failUnless("create-alias ALIAS" in help, help)
 502
 503     def test_add_aliases(self):
 504         help = str(cli.AddAliasOptions())
 505         self.failUnless("add-alias ALIAS DIRCAP" in help, help)
 506
 507
 508 class CreateAlias(GridTestMixin, CLITestMixin, unittest.TestCase):
 509
 510     def _test_webopen(self, args, expected_url):
 511         woo = cli.WebopenOptions()
 512         all_args = ["--node-directory", self.get_clientdir()] + list(args)
 513         woo.parseOptions(all_args)
 514         urls = []
 515         rc = cli.webopen(woo, urls.append)
 516         self.failUnlessReallyEqual(rc, 0)
 517         self.failUnlessReallyEqual(len(urls), 1)
 518         self.failUnlessReallyEqual(urls[0], expected_url)
 519
 520     def test_create(self):
 521         self.basedir = "cli/CreateAlias/create"
 522         self.set_up_grid()
 523         aliasfile = os.path.join(self.get_clientdir(), "private", "aliases")
 524
 525         d = self.do_cli("create-alias", "tahoe")
 526         def _done((rc,stdout,stderr)):
 527             self.failUnless("Alias 'tahoe' created" in stdout)
 528             self.failIf(stderr)
 529             aliases = get_aliases(self.get_clientdir())
 530             self.failUnless("tahoe" in aliases)
 531             self.failUnless(aliases["tahoe"].startswith("URI:DIR2:"))
 532         d.addCallback(_done)
 533         d.addCallback(lambda res: self.do_cli("create-alias", "two"))
 534
 535         def _stash_urls(res):
 536             aliases = get_aliases(self.get_clientdir())
 537             node_url_file = os.path.join(self.get_clientdir(), "node.url")
 538             nodeurl = fileutil.read(node_url_file).strip()
 539             self.welcome_url = nodeurl
 540             uribase = nodeurl + "uri/"
 541             self.tahoe_url = uribase + urllib.quote(aliases["tahoe"])
 542             self.tahoe_subdir_url = self.tahoe_url + "/subdir"
 543             self.two_url = uribase + urllib.quote(aliases["two"])
 544             self.two_uri = aliases["two"]
 545         d.addCallback(_stash_urls)
 546
 547         d.addCallback(lambda res: self.do_cli("create-alias", "two")) # dup
 548         def _check_create_duplicate((rc,stdout,stderr)):
 549             self.failIfEqual(rc, 0)
 550             self.failUnless("Alias 'two' already exists!" in stderr)
 551             aliases = get_aliases(self.get_clientdir())
 552             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 553         d.addCallback(_check_create_duplicate)
 554
 555         d.addCallback(lambda res: self.do_cli("add-alias", "added", self.two_uri))
 556         def _check_add((rc,stdout,stderr)):
 557             self.failUnlessReallyEqual(rc, 0)
 558             self.failUnless("Alias 'added' added" in stdout)
 559         d.addCallback(_check_add)
 560
 561         # check add-alias with a duplicate
 562         d.addCallback(lambda res: self.do_cli("add-alias", "two", self.two_uri))
 563         def _check_add_duplicate((rc,stdout,stderr)):
 564             self.failIfEqual(rc, 0)
 565             self.failUnless("Alias 'two' already exists!" in stderr)
 566             aliases = get_aliases(self.get_clientdir())
 567             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 568         d.addCallback(_check_add_duplicate)
 569
 570         def _test_urls(junk):
 571             self._test_webopen([], self.welcome_url)
 572             self._test_webopen(["/"], self.tahoe_url)
 573             self._test_webopen(["tahoe:"], self.tahoe_url)
 574             self._test_webopen(["tahoe:/"], self.tahoe_url)
 575             self._test_webopen(["tahoe:subdir"], self.tahoe_subdir_url)
 576             self._test_webopen(["-i", "tahoe:subdir"],
 577                                self.tahoe_subdir_url+"?t=info")
 578             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
 579             self._test_webopen(["tahoe:subdir/file"],
 580                                self.tahoe_subdir_url + '/file')
 581             self._test_webopen(["--info", "tahoe:subdir/file"],
 582                                self.tahoe_subdir_url + '/file?t=info')
 583             # if "file" is indeed a file, then the url produced by webopen in
 584             # this case is disallowed by the webui. but by design, webopen
 585             # passes through the mistake from the user to the resultant
 586             # webopened url
 587             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
 588             self._test_webopen(["two:"], self.two_url)
 589         d.addCallback(_test_urls)
 590
 591         def _remove_trailing_newline_and_create_alias(ign):
 592             # ticket #741 is about a manually-edited alias file (which
 593             # doesn't end in a newline) being corrupted by a subsequent
 594             # "tahoe create-alias"
 595             old = fileutil.read(aliasfile)
 596             fileutil.write(aliasfile, old.rstrip())
 597             return self.do_cli("create-alias", "un-corrupted1")
 598         d.addCallback(_remove_trailing_newline_and_create_alias)
 599         def _check_not_corrupted1((rc,stdout,stderr)):
 600             self.failUnless("Alias 'un-corrupted1' created" in stdout, stdout)
 601             self.failIf(stderr)
 602             # the old behavior was to simply append the new record, causing a
 603             # line that looked like "NAME1: CAP1NAME2: CAP2". This won't look
 604             # like a valid dircap, so get_aliases() will raise an exception.
 605             aliases = get_aliases(self.get_clientdir())
 606             self.failUnless("added" in aliases)
 607             self.failUnless(aliases["added"].startswith("URI:DIR2:"))
 608             # to be safe, let's confirm that we don't see "NAME2:" in CAP1.
 609             # No chance of a false-negative, because the hyphen in
 610             # "un-corrupted1" is not a valid base32 character.
 611             self.failIfIn("un-corrupted1:", aliases["added"])
 612             self.failUnless("un-corrupted1" in aliases)
 613             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 614         d.addCallback(_check_not_corrupted1)
 615
 616         def _remove_trailing_newline_and_add_alias(ign):
 617             # same thing, but for "tahoe add-alias"
 618             old = fileutil.read(aliasfile)
 619             fileutil.write(aliasfile, old.rstrip())
 620             return self.do_cli("add-alias", "un-corrupted2", self.two_uri)
 621         d.addCallback(_remove_trailing_newline_and_add_alias)
 622         def _check_not_corrupted((rc,stdout,stderr)):
 623             self.failUnless("Alias 'un-corrupted2' added" in stdout, stdout)
 624             self.failIf(stderr)
 625             aliases = get_aliases(self.get_clientdir())
 626             self.failUnless("un-corrupted1" in aliases)
 627             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 628             self.failIfIn("un-corrupted2:", aliases["un-corrupted1"])
 629             self.failUnless("un-corrupted2" in aliases)
 630             self.failUnless(aliases["un-corrupted2"].startswith("URI:DIR2:"))
 631         d.addCallback(_check_not_corrupted)
 632
 633     def test_create_unicode(self):
 634         self.basedir = "cli/CreateAlias/create_unicode"
 635         self.set_up_grid()
 636
 637         try:
 638             etudes_arg = u"\u00E9tudes".encode(get_argv_encoding())
 639             lumiere_arg = u"lumi\u00E8re.txt".encode(get_argv_encoding())
 640         except UnicodeEncodeError:
 641             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
 642
 643         d = self.do_cli("create-alias", etudes_arg)
 644         def _check_create_unicode((rc, out, err)):
 645             self.failUnlessReallyEqual(rc, 0)
 646             self.failUnlessReallyEqual(err, "")
 647             self.failUnlessIn("Alias %s created" % quote_output(u"\u00E9tudes"), out)
 648
 649             aliases = get_aliases(self.get_clientdir())
 650             self.failUnless(aliases[u"\u00E9tudes"].startswith("URI:DIR2:"))
 651         d.addCallback(_check_create_unicode)
 652
 653         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 654         def _check_ls1((rc, out, err)):
 655             self.failUnlessReallyEqual(rc, 0)
 656             self.failUnlessReallyEqual(err, "")
 657             self.failUnlessReallyEqual(out, "")
 658         d.addCallback(_check_ls1)
 659
 660         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":uploaded.txt",
 661                                               stdin="Blah blah blah"))
 662
 663         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 664         def _check_ls2((rc, out, err)):
 665             self.failUnlessReallyEqual(rc, 0)
 666             self.failUnlessReallyEqual(err, "")
 667             self.failUnlessReallyEqual(out, "uploaded.txt\n")
 668         d.addCallback(_check_ls2)
 669
 670         d.addCallback(lambda res: self.do_cli("get", etudes_arg + ":uploaded.txt"))
 671         def _check_get((rc, out, err)):
 672             self.failUnlessReallyEqual(rc, 0)
 673             self.failUnlessReallyEqual(err, "")
 674             self.failUnlessReallyEqual(out, "Blah blah blah")
 675         d.addCallback(_check_get)
 676
 677         # Ensure that an Unicode filename in an Unicode alias works as expected
 678         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":" + lumiere_arg,
 679                                               stdin="Let the sunshine In!"))
 680
 681         d.addCallback(lambda res: self.do_cli("get",
 682                                               get_aliases(self.get_clientdir())[u"\u00E9tudes"] + "/" + lumiere_arg))
 683         def _check_get2((rc, out, err)):
 684             self.failUnlessReallyEqual(rc, 0)
 685             self.failUnlessReallyEqual(err, "")
 686             self.failUnlessReallyEqual(out, "Let the sunshine In!")
 687         d.addCallback(_check_get2)
 688
 689         return d
 690
 691     # TODO: test list-aliases, including Unicode
 692
 693
 694 class Ln(GridTestMixin, CLITestMixin, unittest.TestCase):
 695     def _create_test_file(self):
 696         data = "puppies" * 1000
 697         path = os.path.join(self.basedir, "datafile")
 698         fileutil.write(path, data)
 699         self.datafile = path
 700
 701     def test_ln_without_alias(self):
 702         # if invoked without an alias when the 'tahoe' alias doesn't
 703         # exist, 'tahoe ln' should output a useful error message and not
 704         # a stack trace
 705         self.basedir = "cli/Ln/ln_without_alias"
 706         self.set_up_grid()
 707         d = self.do_cli("ln", "from", "to")
 708         def _check((rc, out, err)):
 709             self.failUnlessReallyEqual(rc, 1)
 710             self.failUnlessIn("error:", err)
 711             self.failUnlessReallyEqual(out, "")
 712         d.addCallback(_check)
 713         # Make sure that validation extends to the "to" parameter
 714         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 715         d.addCallback(lambda ign: self._create_test_file())
 716         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 717                                               "havasu:from"))
 718         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "to"))
 719         d.addCallback(_check)
 720         return d
 721
 722     def test_ln_with_nonexistent_alias(self):
 723         # If invoked with aliases that don't exist, 'tahoe ln' should
 724         # output a useful error message and not a stack trace.
 725         self.basedir = "cli/Ln/ln_with_nonexistent_alias"
 726         self.set_up_grid()
 727         d = self.do_cli("ln", "havasu:from", "havasu:to")
 728         def _check((rc, out, err)):
 729             self.failUnlessReallyEqual(rc, 1)
 730             self.failUnlessIn("error:", err)
 731         d.addCallback(_check)
 732         # Make sure that validation occurs on the to parameter if the
 733         # from parameter passes.
 734         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 735         d.addCallback(lambda ign: self._create_test_file())
 736         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 737                                               "havasu:from"))
 738         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "huron:to"))
 739         d.addCallback(_check)
 740         return d
 741
 742
 743 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
 744
 745     def test_unlinked_immutable_stdin(self):
 746         # tahoe get `echo DATA | tahoe put`
 747         # tahoe get `echo DATA | tahoe put -`
 748         self.basedir = "cli/Put/unlinked_immutable_stdin"
 749         DATA = "data" * 100
 750         self.set_up_grid()
 751         d = self.do_cli("put", stdin=DATA)
 752         def _uploaded(res):
 753             (rc, out, err) = res
 754             self.failUnlessIn("waiting for file data on stdin..", err)
 755             self.failUnlessIn("200 OK", err)
 756             self.readcap = out
 757             self.failUnless(self.readcap.startswith("URI:CHK:"))
 758         d.addCallback(_uploaded)
 759         d.addCallback(lambda res: self.do_cli("get", self.readcap))
 760         def _downloaded(res):
 761             (rc, out, err) = res
 762             self.failUnlessReallyEqual(err, "")
 763             self.failUnlessReallyEqual(out, DATA)
 764         d.addCallback(_downloaded)
 765         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
 766         d.addCallback(lambda (rc, out, err):
 767                       self.failUnlessReallyEqual(out, self.readcap))
 768         return d
 769
 770     def test_unlinked_immutable_from_file(self):
 771         # tahoe put file.txt
 772         # tahoe put ./file.txt
 773         # tahoe put /tmp/file.txt
 774         # tahoe put ~/file.txt
 775         self.basedir = "cli/Put/unlinked_immutable_from_file"
 776         self.set_up_grid()
 777
 778         rel_fn = os.path.join(self.basedir, "DATAFILE")
 779         abs_fn = unicode_to_argv(abspath_expanduser_unicode(unicode(rel_fn)))
 780         # we make the file small enough to fit in a LIT file, for speed
 781         fileutil.write(rel_fn, "short file")
 782         d = self.do_cli("put", rel_fn)
 783         def _uploaded((rc, out, err)):
 784             readcap = out
 785             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 786             self.readcap = readcap
 787         d.addCallback(_uploaded)
 788         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
 789         d.addCallback(lambda (rc,stdout,stderr):
 790                       self.failUnlessReallyEqual(stdout, self.readcap))
 791         d.addCallback(lambda res: self.do_cli("put", abs_fn))
 792         d.addCallback(lambda (rc,stdout,stderr):
 793                       self.failUnlessReallyEqual(stdout, self.readcap))
 794         # we just have to assume that ~ is handled properly
 795         return d
 796
 797     def test_immutable_from_file(self):
 798         # tahoe put file.txt uploaded.txt
 799         # tahoe - uploaded.txt
 800         # tahoe put file.txt subdir/uploaded.txt
 801         # tahoe put file.txt tahoe:uploaded.txt
 802         # tahoe put file.txt tahoe:subdir/uploaded.txt
 803         # tahoe put file.txt DIRCAP:./uploaded.txt
 804         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
 805         self.basedir = "cli/Put/immutable_from_file"
 806         self.set_up_grid()
 807
 808         rel_fn = os.path.join(self.basedir, "DATAFILE")
 809         # we make the file small enough to fit in a LIT file, for speed
 810         DATA = "short file"
 811         DATA2 = "short file two"
 812         fileutil.write(rel_fn, DATA)
 813
 814         d = self.do_cli("create-alias", "tahoe")
 815
 816         d.addCallback(lambda res:
 817                       self.do_cli("put", rel_fn, "uploaded.txt"))
 818         def _uploaded((rc, out, err)):
 819             readcap = out.strip()
 820             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 821             self.failUnlessIn("201 Created", err)
 822             self.readcap = readcap
 823         d.addCallback(_uploaded)
 824         d.addCallback(lambda res:
 825                       self.do_cli("get", "tahoe:uploaded.txt"))
 826         d.addCallback(lambda (rc,stdout,stderr):
 827                       self.failUnlessReallyEqual(stdout, DATA))
 828
 829         d.addCallback(lambda res:
 830                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
 831         def _replaced((rc, out, err)):
 832             readcap = out.strip()
 833             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 834             self.failUnlessIn("200 OK", err)
 835         d.addCallback(_replaced)
 836
 837         d.addCallback(lambda res:
 838                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
 839         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
 840         d.addCallback(lambda (rc,stdout,stderr):
 841                       self.failUnlessReallyEqual(stdout, DATA))
 842
 843         d.addCallback(lambda res:
 844                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
 845         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
 846         d.addCallback(lambda (rc,stdout,stderr):
 847                       self.failUnlessReallyEqual(stdout, DATA))
 848
 849         d.addCallback(lambda res:
 850                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
 851         d.addCallback(lambda res:
 852                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
 853         d.addCallback(lambda (rc,stdout,stderr):
 854                       self.failUnlessReallyEqual(stdout, DATA))
 855
 856         def _get_dircap(res):
 857             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
 858         d.addCallback(_get_dircap)
 859
 860         d.addCallback(lambda res:
 861                       self.do_cli("put", rel_fn,
 862                                   self.dircap+":./uploaded5.txt"))
 863         d.addCallback(lambda res:
 864                       self.do_cli("get", "tahoe:uploaded5.txt"))
 865         d.addCallback(lambda (rc,stdout,stderr):
 866                       self.failUnlessReallyEqual(stdout, DATA))
 867
 868         d.addCallback(lambda res:
 869                       self.do_cli("put", rel_fn,
 870                                   self.dircap+":./subdir/uploaded6.txt"))
 871         d.addCallback(lambda res:
 872                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
 873         d.addCallback(lambda (rc,stdout,stderr):
 874                       self.failUnlessReallyEqual(stdout, DATA))
 875
 876         return d
 877
 878     def test_mutable_unlinked(self):
 879         # FILECAP = `echo DATA | tahoe put --mutable`
 880         # tahoe get FILECAP, compare against DATA
 881         # echo DATA2 | tahoe put - FILECAP
 882         # tahoe get FILECAP, compare against DATA2
 883         # tahoe put file.txt FILECAP
 884         self.basedir = "cli/Put/mutable_unlinked"
 885         self.set_up_grid()
 886
 887         DATA = "data" * 100
 888         DATA2 = "two" * 100
 889         rel_fn = os.path.join(self.basedir, "DATAFILE")
 890         DATA3 = "three" * 100
 891         fileutil.write(rel_fn, DATA3)
 892
 893         d = self.do_cli("put", "--mutable", stdin=DATA)
 894         def _created(res):
 895             (rc, out, err) = res
 896             self.failUnlessIn("waiting for file data on stdin..", err)
 897             self.failUnlessIn("200 OK", err)
 898             self.filecap = out
 899             self.failUnless(self.filecap.startswith("URI:SSK:"), self.filecap)
 900         d.addCallback(_created)
 901         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 902         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA))
 903
 904         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
 905         def _replaced(res):
 906             (rc, out, err) = res
 907             self.failUnlessIn("waiting for file data on stdin..", err)
 908             self.failUnlessIn("200 OK", err)
 909             self.failUnlessReallyEqual(self.filecap, out)
 910         d.addCallback(_replaced)
 911         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 912         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
 913
 914         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
 915         def _replaced2(res):
 916             (rc, out, err) = res
 917             self.failUnlessIn("200 OK", err)
 918             self.failUnlessReallyEqual(self.filecap, out)
 919         d.addCallback(_replaced2)
 920         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 921         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA3))
 922
 923         return d
 924
 925     def test_mutable(self):
 926         # echo DATA1 | tahoe put --mutable - uploaded.txt
 927         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
 928         # tahoe get uploaded.txt, compare against DATA2
 929
 930         self.basedir = "cli/Put/mutable"
 931         self.set_up_grid()
 932
 933         DATA1 = "data" * 100
 934         fn1 = os.path.join(self.basedir, "DATA1")
 935         fileutil.write(fn1, DATA1)
 936         DATA2 = "two" * 100
 937         fn2 = os.path.join(self.basedir, "DATA2")
 938         fileutil.write(fn2, DATA2)
 939
 940         d = self.do_cli("create-alias", "tahoe")
 941         d.addCallback(lambda res:
 942                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
 943         d.addCallback(lambda res:
 944                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
 945         d.addCallback(lambda res:
 946                       self.do_cli("get", "tahoe:uploaded.txt"))
 947         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
 948         return d
 949
 950     def test_put_with_nonexistent_alias(self):
 951         # when invoked with an alias that doesn't exist, 'tahoe put'
 952         # should output a useful error message, not a stack trace
 953         self.basedir = "cli/Put/put_with_nonexistent_alias"
 954         self.set_up_grid()
 955         d = self.do_cli("put", "somefile", "fake:afile")
 956         def _check((rc, out, err)):
 957             self.failUnlessReallyEqual(rc, 1)
 958             self.failUnlessIn("error:", err)
 959             self.failUnlessReallyEqual(out, "")
 960         d.addCallback(_check)
 961         return d
 962
 963     def test_immutable_from_file_unicode(self):
 964         # tahoe put "\u00E0 trier.txt" "\u00E0 trier.txt"
 965
 966         try:
 967             a_trier_arg = u"\u00E0 trier.txt".encode(get_argv_encoding())
 968         except UnicodeEncodeError:
 969             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
 970
 971         self.skip_if_cannot_represent_filename(u"\u00E0 trier.txt")
 972
 973         self.basedir = "cli/Put/immutable_from_file_unicode"
 974         self.set_up_grid()
 975
 976         rel_fn = os.path.join(unicode(self.basedir), u"\u00E0 trier.txt")
 977         # we make the file small enough to fit in a LIT file, for speed
 978         DATA = "short file"
 979         fileutil.write(rel_fn, DATA)
 980
 981         d = self.do_cli("create-alias", "tahoe")
 982
 983         d.addCallback(lambda res:
 984                       self.do_cli("put", rel_fn.encode(get_argv_encoding()), a_trier_arg))
 985         def _uploaded((rc, out, err)):
 986             readcap = out.strip()
 987             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 988             self.failUnlessIn("201 Created", err)
 989             self.readcap = readcap
 990         d.addCallback(_uploaded)
 991
 992         d.addCallback(lambda res:
 993                       self.do_cli("get", "tahoe:" + a_trier_arg))
 994         d.addCallback(lambda (rc, out, err):
 995                       self.failUnlessReallyEqual(out, DATA))
 996
 997         return d
 998
 999 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
1000     def test_list(self):
1001         self.basedir = "cli/List/list"
1002         self.set_up_grid()
1003         c0 = self.g.clients[0]
1004         small = "small"
1005
1006         # u"g\u00F6\u00F6d" might not be representable in the argv and/or output encodings.
1007         # It is initially included in the directory in any case.
1008         try:
1009             good_arg = u"g\u00F6\u00F6d".encode(get_argv_encoding())
1010         except UnicodeEncodeError:
1011             good_arg = None
1012
1013         try:
1014             good_out = u"g\u00F6\u00F6d".encode(get_output_encoding())
1015         except UnicodeEncodeError:
1016             good_out = None
1017
1018         d = c0.create_dirnode()
1019         def _stash_root_and_create_file(n):
1020             self.rootnode = n
1021             self.rooturi = n.get_uri()
1022             return n.add_file(u"g\u00F6\u00F6d", upload.Data(small, convergence=""))
1023         d.addCallback(_stash_root_and_create_file)
1024         def _stash_goodcap(n):
1025             self.goodcap = n.get_uri()
1026         d.addCallback(_stash_goodcap)
1027         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
1028         d.addCallback(lambda n:
1029                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
1030         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
1031         d.addCallback(lambda n:
1032                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
1033         d.addCallback(lambda ign:
1034                       self.do_cli("add-alias", "tahoe", self.rooturi))
1035         d.addCallback(lambda ign: self.do_cli("ls"))
1036         def _check1((rc,out,err)):
1037             if good_out is None:
1038                 self.failUnlessReallyEqual(rc, 1)
1039                 self.failUnlessIn("files whose names could not be converted", err)
1040                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1041                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share"]))
1042             else:
1043                 self.failUnlessReallyEqual(rc, 0)
1044                 self.failUnlessReallyEqual(err, "")
1045                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", good_out]))
1046         d.addCallback(_check1)
1047         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
1048         def _check2((rc,out,err)):
1049             self.failIfEqual(rc, 0)
1050             self.failUnlessReallyEqual(err.strip(), "No such file or directory")
1051             self.failUnlessReallyEqual(out, "")
1052         d.addCallback(_check2)
1053         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
1054         def _check3((rc,out,err)):
1055             self.failIfEqual(rc, 0)
1056             self.failUnlessIn("Error during GET: 410 Gone", err)
1057             self.failUnlessIn("UnrecoverableFileError:", err)
1058             self.failUnlessIn("could not be retrieved, because there were "
1059                               "insufficient good shares.", err)
1060             self.failUnlessReallyEqual(out, "")
1061         d.addCallback(_check3)
1062         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
1063         d.addCallback(_check3)
1064         def _check4((rc, out, err)):
1065             if good_out is None:
1066                 self.failUnlessReallyEqual(rc, 1)
1067                 self.failUnlessIn("files whose names could not be converted", err)
1068                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1069                 self.failUnlessReallyEqual(out, "")
1070             else:
1071                 # listing a file (as dir/filename) should have the edge metadata,
1072                 # including the filename
1073                 self.failUnlessReallyEqual(rc, 0)
1074                 self.failUnlessIn(good_out, out)
1075                 self.failIfIn("-r-- %d -" % len(small), out,
1076                               "trailing hyphen means unknown date")
1077
1078         if good_arg is not None:
1079             d.addCallback(lambda ign: self.do_cli("ls", "-l", good_arg))
1080             d.addCallback(_check4)
1081             # listing a file as $DIRCAP/filename should work just like dir/filename
1082             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/" + good_arg))
1083             d.addCallback(_check4)
1084             # and similarly for $DIRCAP:./filename
1085             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./" + good_arg))
1086             d.addCallback(_check4)
1087
1088         def _check5((rc, out, err)):
1089             # listing a raw filecap should not explode, but it will have no
1090             # metadata, just the size
1091             self.failUnlessReallyEqual(rc, 0)
1092             self.failUnlessReallyEqual("-r-- %d -" % len(small), out.strip())
1093         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
1094         d.addCallback(_check5)
1095
1096         # Now rename 'g\u00F6\u00F6d' to 'good' and repeat the tests that might have been skipped due
1097         # to encoding problems.
1098         d.addCallback(lambda ign: self.rootnode.move_child_to(u"g\u00F6\u00F6d", self.rootnode, u"good"))
1099
1100         d.addCallback(lambda ign: self.do_cli("ls"))
1101         def _check1_ascii((rc,out,err)):
1102             self.failUnlessReallyEqual(rc, 0)
1103             self.failUnlessReallyEqual(err, "")
1104             self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", "good"]))
1105         d.addCallback(_check1_ascii)
1106         def _check4_ascii((rc, out, err)):
1107             # listing a file (as dir/filename) should have the edge metadata,
1108             # including the filename
1109             self.failUnlessReallyEqual(rc, 0)
1110             self.failUnlessIn("good", out)
1111             self.failIfIn("-r-- %d -" % len(small), out,
1112                           "trailing hyphen means unknown date")
1113
1114         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
1115         d.addCallback(_check4_ascii)
1116         # listing a file as $DIRCAP/filename should work just like dir/filename
1117         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
1118         d.addCallback(_check4_ascii)
1119         # and similarly for $DIRCAP:./filename
1120         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
1121         d.addCallback(_check4_ascii)
1122
1123         unknown_immcap = "imm.URI:unknown"
1124         def _create_unknown(ign):
1125             nm = c0.nodemaker
1126             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
1127             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
1128                                                      mutable=False)
1129         d.addCallback(_create_unknown)
1130         def _check6((rc, out, err)):
1131             # listing a directory referencing an unknown object should print
1132             # an extra message to stderr
1133             self.failUnlessReallyEqual(rc, 0)
1134             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
1135             self.failUnlessIn("included unknown objects", err)
1136         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
1137         d.addCallback(_check6)
1138         def _check7((rc, out, err)):
1139             # listing an unknown cap directly should print an extra message
1140             # to stderr (currently this only works if the URI starts with 'URI:'
1141             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
1142             # with an alias).
1143             self.failUnlessReallyEqual(rc, 0)
1144             self.failUnlessIn("?r-- ? -\n", out)
1145             self.failUnlessIn("included unknown objects", err)
1146         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
1147         d.addCallback(_check7)
1148         return d
1149
1150     def test_list_without_alias(self):
1151         # doing just 'tahoe ls' without specifying an alias or first
1152         # doing 'tahoe create-alias tahoe' should fail gracefully.
1153         self.basedir = "cli/List/list_without_alias"
1154         self.set_up_grid()
1155         d = self.do_cli("ls")
1156         def _check((rc, out, err)):
1157             self.failUnlessReallyEqual(rc, 1)
1158             self.failUnlessIn("error:", err)
1159             self.failUnlessReallyEqual(out, "")
1160         d.addCallback(_check)
1161         return d
1162
1163     def test_list_with_nonexistent_alias(self):
1164         # doing 'tahoe ls' while specifying an alias that doesn't already
1165         # exist should fail with an informative error message
1166         self.basedir = "cli/List/list_with_nonexistent_alias"
1167         self.set_up_grid()
1168         d = self.do_cli("ls", "nonexistent:")
1169         def _check((rc, out, err)):
1170             self.failUnlessReallyEqual(rc, 1)
1171             self.failUnlessIn("error:", err)
1172             self.failUnlessIn("nonexistent", err)
1173             self.failUnlessReallyEqual(out, "")
1174         d.addCallback(_check)
1175         return d
1176
1177
1178 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
1179     def test_mv_behavior(self):
1180         self.basedir = "cli/Mv/mv_behavior"
1181         self.set_up_grid()
1182         fn1 = os.path.join(self.basedir, "file1")
1183         DATA1 = "Nuclear launch codes"
1184         fileutil.write(fn1, DATA1)
1185         fn2 = os.path.join(self.basedir, "file2")
1186         DATA2 = "UML diagrams"
1187         fileutil.write(fn2, DATA2)
1188         # copy both files to the grid
1189         d = self.do_cli("create-alias", "tahoe")
1190         d.addCallback(lambda res:
1191             self.do_cli("cp", fn1, "tahoe:"))
1192         d.addCallback(lambda res:
1193             self.do_cli("cp", fn2, "tahoe:"))
1194
1195         # do mv file1 file3
1196         # (we should be able to rename files)
1197         d.addCallback(lambda res:
1198             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1199         d.addCallback(lambda (rc, out, err):
1200             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1201
1202         # do mv file3 file2
1203         # (This should succeed without issue)
1204         d.addCallback(lambda res:
1205             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1206         # Out should contain "OK" to show that the transfer worked.
1207         d.addCallback(lambda (rc,out,err):
1208             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1209
1210         # Next, make a remote directory.
1211         d.addCallback(lambda res:
1212             self.do_cli("mkdir", "tahoe:directory"))
1213
1214         # mv file2 directory
1215         # (should fail with a descriptive error message; the CLI mv
1216         #  client should support this)
1217         d.addCallback(lambda res:
1218             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1219         d.addCallback(lambda (rc, out, err):
1220             self.failUnlessIn(
1221                 "Error: You can't overwrite a directory with a file", err,
1222                 "mv shouldn't overwrite directories" ))
1223
1224         # mv file2 directory/
1225         # (should succeed by making file2 a child node of directory)
1226         d.addCallback(lambda res:
1227             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1228         # We should see an "OK"...
1229         d.addCallback(lambda (rc, out, err):
1230             self.failUnlessIn("OK", out,
1231                             "mv didn't mv a file into a directory"))
1232         # ... and be able to GET the file
1233         d.addCallback(lambda res:
1234             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1235         d.addCallback(lambda (rc, out, err):
1236             self.failUnless(os.path.exists(self.basedir + "new"),
1237                             "mv didn't write the destination file"))
1238         # ... and not find the file where it was before.
1239         d.addCallback(lambda res:
1240             self.do_cli("get", "tahoe:file2", "file2"))
1241         d.addCallback(lambda (rc, out, err):
1242             self.failUnlessIn("404", err,
1243                             "mv left the source file intact"))
1244
1245         # Let's build:
1246         # directory/directory2/some_file
1247         # directory3
1248         d.addCallback(lambda res:
1249             self.do_cli("mkdir", "tahoe:directory/directory2"))
1250         d.addCallback(lambda res:
1251             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1252         d.addCallback(lambda res:
1253             self.do_cli("mkdir", "tahoe:directory3"))
1254
1255         # Let's now try to mv directory/directory2/some_file to
1256         # directory3/some_file
1257         d.addCallback(lambda res:
1258             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1259                         "tahoe:directory3/"))
1260         # We should have just some_file in tahoe:directory3
1261         d.addCallback(lambda res:
1262             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1263         d.addCallback(lambda (rc, out, err):
1264             self.failUnless("404" not in err,
1265                               "mv didn't handle nested directories correctly"))
1266         d.addCallback(lambda res:
1267             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1268         d.addCallback(lambda (rc, out, err):
1269             self.failUnlessIn("404", err,
1270                               "mv moved the wrong thing"))
1271         return d
1272
1273     def test_mv_without_alias(self):
1274         # doing 'tahoe mv' without explicitly specifying an alias or
1275         # creating the default 'tahoe' alias should fail with a useful
1276         # error message.
1277         self.basedir = "cli/Mv/mv_without_alias"
1278         self.set_up_grid()
1279         d = self.do_cli("mv", "afile", "anotherfile")
1280         def _check((rc, out, err)):
1281             self.failUnlessReallyEqual(rc, 1)
1282             self.failUnlessIn("error:", err)
1283             self.failUnlessReallyEqual(out, "")
1284         d.addCallback(_check)
1285         # check to see that the validation extends to the
1286         # target argument by making an alias that will work with the first
1287         # one.
1288         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1289         def _create_a_test_file(ign):
1290             self.test_file_path = os.path.join(self.basedir, "afile")
1291             fileutil.write(self.test_file_path, "puppies" * 100)
1292         d.addCallback(_create_a_test_file)
1293         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1294                                               "havasu:afile"))
1295         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1296                                               "anotherfile"))
1297         d.addCallback(_check)
1298         return d
1299
1300     def test_mv_with_nonexistent_alias(self):
1301         # doing 'tahoe mv' with an alias that doesn't exist should fail
1302         # with an informative error message.
1303         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1304         self.set_up_grid()
1305         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1306         def _check((rc, out, err)):
1307             self.failUnlessReallyEqual(rc, 1)
1308             self.failUnlessIn("error:", err)
1309             self.failUnlessIn("fake", err)
1310             self.failUnlessReallyEqual(out, "")
1311         d.addCallback(_check)
1312         # check to see that the validation extends to the
1313         # target argument by making an alias that will work with the first
1314         # one.
1315         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1316         def _create_a_test_file(ign):
1317             self.test_file_path = os.path.join(self.basedir, "afile")
1318             fileutil.write(self.test_file_path, "puppies" * 100)
1319         d.addCallback(_create_a_test_file)
1320         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1321                                               "havasu:afile"))
1322         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1323                                               "fake:anotherfile"))
1324         d.addCallback(_check)
1325         return d
1326
1327
1328 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1329
1330     def test_not_enough_args(self):
1331         o = cli.CpOptions()
1332         self.failUnlessRaises(usage.UsageError,
1333                               o.parseOptions, ["onearg"])
1334
1335     def test_unicode_filename(self):
1336         self.basedir = "cli/Cp/unicode_filename"
1337
1338         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1339         try:
1340             fn1_arg = fn1.encode(get_argv_encoding())
1341             artonwall_arg = u"\u00C4rtonwall".encode(get_argv_encoding())
1342         except UnicodeEncodeError:
1343             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1344
1345         self.skip_if_cannot_represent_filename(fn1)
1346
1347         self.set_up_grid()
1348
1349         DATA1 = "unicode file content"
1350         fileutil.write(fn1, DATA1)
1351
1352         fn2 = os.path.join(self.basedir, "Metallica")
1353         DATA2 = "non-unicode file content"
1354         fileutil.write(fn2, DATA2)
1355
1356         d = self.do_cli("create-alias", "tahoe")
1357
1358         d.addCallback(lambda res: self.do_cli("cp", fn1_arg, "tahoe:"))
1359
1360         d.addCallback(lambda res: self.do_cli("get", "tahoe:" + artonwall_arg))
1361         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA1))
1362
1363         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1364
1365         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1366         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1367
1368         d.addCallback(lambda res: self.do_cli("ls", "tahoe:"))
1369         def _check((rc, out, err)):
1370             try:
1371                 unicode_to_output(u"\u00C4rtonwall")
1372             except UnicodeEncodeError:
1373                 self.failUnlessReallyEqual(rc, 1)
1374                 self.failUnlessReallyEqual(out, "Metallica\n")
1375                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1376                 self.failUnlessIn("files whose names could not be converted", err)
1377             else:
1378                 self.failUnlessReallyEqual(rc, 0)
1379                 self.failUnlessReallyEqual(out.decode(get_output_encoding()), u"Metallica\n\u00C4rtonwall\n")
1380                 self.failUnlessReallyEqual(err, "")
1381         d.addCallback(_check)
1382
1383         return d
1384
1385     def test_dangling_symlink_vs_recursion(self):
1386         if not hasattr(os, 'symlink'):
1387             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
1388
1389         # cp -r on a directory containing a dangling symlink shouldn't assert
1390         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1391         self.set_up_grid()
1392         dn = os.path.join(self.basedir, "dir")
1393         os.mkdir(dn)
1394         fn = os.path.join(dn, "Fakebandica")
1395         ln = os.path.join(dn, "link")
1396         os.symlink(fn, ln)
1397
1398         d = self.do_cli("create-alias", "tahoe")
1399         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1400                                               dn, "tahoe:"))
1401         return d
1402
1403     def test_copy_using_filecap(self):
1404         self.basedir = "cli/Cp/test_copy_using_filecap"
1405         self.set_up_grid()
1406         outdir = os.path.join(self.basedir, "outdir")
1407         os.mkdir(outdir)
1408         fn1 = os.path.join(self.basedir, "Metallica")
1409         fn2 = os.path.join(outdir, "Not Metallica")
1410         fn3 = os.path.join(outdir, "test2")
1411         DATA1 = "puppies" * 10000
1412         fileutil.write(fn1, DATA1)
1413
1414         d = self.do_cli("create-alias", "tahoe")
1415         d.addCallback(lambda ign: self.do_cli("put", fn1))
1416         def _put_file((rc, out, err)):
1417             self.failUnlessReallyEqual(rc, 0)
1418             self.failUnlessIn("200 OK", err)
1419             # keep track of the filecap
1420             self.filecap = out.strip()
1421         d.addCallback(_put_file)
1422
1423         # Let's try copying this to the disk using the filecap
1424         #  cp FILECAP filename
1425         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1426         def _copy_file((rc, out, err)):
1427             self.failUnlessReallyEqual(rc, 0)
1428             results = fileutil.read(fn2)
1429             self.failUnlessReallyEqual(results, DATA1)
1430         d.addCallback(_copy_file)
1431
1432         # Test with ./ (see #761)
1433         #  cp FILECAP localdir
1434         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1435         def _resp((rc, out, err)):
1436             self.failUnlessReallyEqual(rc, 1)
1437             self.failUnlessIn("error: you must specify a destination filename",
1438                               err)
1439             self.failUnlessReallyEqual(out, "")
1440         d.addCallback(_resp)
1441
1442         # Create a directory, linked at tahoe:test
1443         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1444         def _get_dir((rc, out, err)):
1445             self.failUnlessReallyEqual(rc, 0)
1446             self.dircap = out.strip()
1447         d.addCallback(_get_dir)
1448
1449         # Upload a file to the directory
1450         d.addCallback(lambda ign:
1451                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1452         d.addCallback(lambda (rc, out, err): self.failUnlessReallyEqual(rc, 0))
1453
1454         #  cp DIRCAP/filename localdir
1455         d.addCallback(lambda ign:
1456                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1457         def _get_resp((rc, out, err)):
1458             self.failUnlessReallyEqual(rc, 0)
1459             results = fileutil.read(os.path.join(outdir, "test_file"))
1460             self.failUnlessReallyEqual(results, DATA1)
1461         d.addCallback(_get_resp)
1462
1463         #  cp -r DIRCAP/filename filename2
1464         d.addCallback(lambda ign:
1465                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1466         def _get_resp2((rc, out, err)):
1467             self.failUnlessReallyEqual(rc, 0)
1468             results = fileutil.read(fn3)
1469             self.failUnlessReallyEqual(results, DATA1)
1470         d.addCallback(_get_resp2)
1471         return d
1472
1473     def test_cp_with_nonexistent_alias(self):
1474         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1475         # should output a sensible error message rather than a stack trace.
1476         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1477         self.set_up_grid()
1478         d = self.do_cli("cp", "fake:file1", "fake:file2")
1479         def _check((rc, out, err)):
1480             self.failUnlessReallyEqual(rc, 1)
1481             self.failUnlessIn("error:", err)
1482         d.addCallback(_check)
1483         # 'tahoe cp' actually processes the target argument first, so we need
1484         # to check to make sure that validation extends to the source
1485         # argument.
1486         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1487         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1488                                               "tahoe:file2"))
1489         d.addCallback(_check)
1490         return d
1491
1492     def test_unicode_dirnames(self):
1493         self.basedir = "cli/Cp/unicode_dirnames"
1494
1495         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1496         try:
1497             fn1_arg = fn1.encode(get_argv_encoding())
1498             del fn1_arg # hush pyflakes
1499             artonwall_arg = u"\u00C4rtonwall".encode(get_argv_encoding())
1500         except UnicodeEncodeError:
1501             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1502
1503         self.skip_if_cannot_represent_filename(fn1)
1504
1505         self.set_up_grid()
1506
1507         d = self.do_cli("create-alias", "tahoe")
1508         d.addCallback(lambda res: self.do_cli("mkdir", "tahoe:test/" + artonwall_arg))
1509         d.addCallback(lambda res: self.do_cli("cp", "-r", "tahoe:test", "tahoe:test2"))
1510         d.addCallback(lambda res: self.do_cli("ls", "tahoe:test2"))
1511         def _check((rc, out, err)):
1512             try:
1513                 unicode_to_output(u"\u00C4rtonwall")
1514             except UnicodeEncodeError:
1515                 self.failUnlessReallyEqual(rc, 1)
1516                 self.failUnlessReallyEqual(out, "")
1517                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1518                 self.failUnlessIn("files whose names could not be converted", err)
1519             else:
1520                 self.failUnlessReallyEqual(rc, 0)
1521                 self.failUnlessReallyEqual(out.decode(get_output_encoding()), u"\u00C4rtonwall\n")
1522                 self.failUnlessReallyEqual(err, "")
1523         d.addCallback(_check)
1524
1525         return d
1526
1527 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
1528
1529     def writeto(self, path, data):
1530         full_path = os.path.join(self.basedir, "home", path)
1531         fileutil.make_dirs(os.path.dirname(full_path))
1532         fileutil.write(full_path, data)
1533
1534     def count_output(self, out):
1535         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
1536                         "(\d)+ files skipped, "
1537                         "(\d+) directories created \((\d+) reused\), "
1538                         "(\d+) directories skipped", out)
1539         return [int(s) for s in mo.groups()]
1540
1541     def count_output2(self, out):
1542         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
1543         return [int(s) for s in mo.groups()]
1544
1545     def test_backup(self):
1546         self.basedir = "cli/Backup/backup"
1547         self.set_up_grid()
1548
1549         # is the backupdb available? If so, we test that a second backup does
1550         # not create new directories.
1551         hush = StringIO()
1552         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
1553                                          hush)
1554
1555         # create a small local directory with a couple of files
1556         source = os.path.join(self.basedir, "home")
1557         fileutil.make_dirs(os.path.join(source, "empty"))
1558         self.writeto("parent/subdir/foo.txt", "foo")
1559         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
1560         self.writeto("parent/blah.txt", "blah")
1561
1562         def do_backup(verbose=False):
1563             cmd = ["backup"]
1564             if verbose:
1565                 cmd.append("--verbose")
1566             cmd.append(source)
1567             cmd.append("tahoe:backups")
1568             return self.do_cli(*cmd)
1569
1570         d = self.do_cli("create-alias", "tahoe")
1571
1572         if not have_bdb:
1573             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
1574             def _should_complain((rc, out, err)):
1575                 self.failUnless("I was unable to import a python sqlite library" in err, err)
1576             d.addCallback(_should_complain)
1577             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
1578
1579         d.addCallback(lambda res: do_backup())
1580         def _check0((rc, out, err)):
1581             self.failUnlessReallyEqual(err, "")
1582             self.failUnlessReallyEqual(rc, 0)
1583             fu, fr, fs, dc, dr, ds = self.count_output(out)
1584             # foo.txt, bar.txt, blah.txt
1585             self.failUnlessReallyEqual(fu, 3)
1586             self.failUnlessReallyEqual(fr, 0)
1587             self.failUnlessReallyEqual(fs, 0)
1588             # empty, home, home/parent, home/parent/subdir
1589             self.failUnlessReallyEqual(dc, 4)
1590             self.failUnlessReallyEqual(dr, 0)
1591             self.failUnlessReallyEqual(ds, 0)
1592         d.addCallback(_check0)
1593
1594         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
1595         def _check1((rc, out, err)):
1596             self.failUnlessReallyEqual(err, "")
1597             self.failUnlessReallyEqual(rc, 0)
1598             lines = out.split("\n")
1599             children = dict([line.split() for line in lines if line])
1600             latest_uri = children["Latest"]
1601             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
1602             childnames = children.keys()
1603             self.failUnlessReallyEqual(sorted(childnames), ["Archives", "Latest"])
1604         d.addCallback(_check1)
1605         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
1606         def _check2((rc, out, err)):
1607             self.failUnlessReallyEqual(err, "")
1608             self.failUnlessReallyEqual(rc, 0)
1609             self.failUnlessReallyEqual(sorted(out.split()), ["empty", "parent"])
1610         d.addCallback(_check2)
1611         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
1612         def _check2a((rc, out, err)):
1613             self.failUnlessReallyEqual(err, "")
1614             self.failUnlessReallyEqual(rc, 0)
1615             self.failUnlessReallyEqual(out.strip(), "")
1616         d.addCallback(_check2a)
1617         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1618         def _check3((rc, out, err)):
1619             self.failUnlessReallyEqual(err, "")
1620             self.failUnlessReallyEqual(rc, 0)
1621             self.failUnlessReallyEqual(out, "foo")
1622         d.addCallback(_check3)
1623         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1624         def _check4((rc, out, err)):
1625             self.failUnlessReallyEqual(err, "")
1626             self.failUnlessReallyEqual(rc, 0)
1627             self.old_archives = out.split()
1628             self.failUnlessReallyEqual(len(self.old_archives), 1)
1629         d.addCallback(_check4)
1630
1631
1632         d.addCallback(self.stall, 1.1)
1633         d.addCallback(lambda res: do_backup())
1634         def _check4a((rc, out, err)):
1635             # second backup should reuse everything, if the backupdb is
1636             # available
1637             self.failUnlessReallyEqual(err, "")
1638             self.failUnlessReallyEqual(rc, 0)
1639             if have_bdb:
1640                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1641                 # foo.txt, bar.txt, blah.txt
1642                 self.failUnlessReallyEqual(fu, 0)
1643                 self.failUnlessReallyEqual(fr, 3)
1644                 self.failUnlessReallyEqual(fs, 0)
1645                 # empty, home, home/parent, home/parent/subdir
1646                 self.failUnlessReallyEqual(dc, 0)
1647                 self.failUnlessReallyEqual(dr, 4)
1648                 self.failUnlessReallyEqual(ds, 0)
1649         d.addCallback(_check4a)
1650
1651         if have_bdb:
1652             # sneak into the backupdb, crank back the "last checked"
1653             # timestamp to force a check on all files
1654             def _reset_last_checked(res):
1655                 dbfile = os.path.join(self.get_clientdir(),
1656                                       "private", "backupdb.sqlite")
1657                 self.failUnless(os.path.exists(dbfile), dbfile)
1658                 bdb = backupdb.get_backupdb(dbfile)
1659                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
1660                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
1661                 bdb.connection.commit()
1662
1663             d.addCallback(_reset_last_checked)
1664
1665             d.addCallback(self.stall, 1.1)
1666             d.addCallback(lambda res: do_backup(verbose=True))
1667             def _check4b((rc, out, err)):
1668                 # we should check all files, and re-use all of them. None of
1669                 # the directories should have been changed, so we should
1670                 # re-use all of them too.
1671                 self.failUnlessReallyEqual(err, "")
1672                 self.failUnlessReallyEqual(rc, 0)
1673                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1674                 fchecked, dchecked = self.count_output2(out)
1675                 self.failUnlessReallyEqual(fchecked, 3)
1676                 self.failUnlessReallyEqual(fu, 0)
1677                 self.failUnlessReallyEqual(fr, 3)
1678                 self.failUnlessReallyEqual(fs, 0)
1679                 self.failUnlessReallyEqual(dchecked, 4)
1680                 self.failUnlessReallyEqual(dc, 0)
1681                 self.failUnlessReallyEqual(dr, 4)
1682                 self.failUnlessReallyEqual(ds, 0)
1683             d.addCallback(_check4b)
1684
1685         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1686         def _check5((rc, out, err)):
1687             self.failUnlessReallyEqual(err, "")
1688             self.failUnlessReallyEqual(rc, 0)
1689             self.new_archives = out.split()
1690             expected_new = 2
1691             if have_bdb:
1692                 expected_new += 1
1693             self.failUnlessReallyEqual(len(self.new_archives), expected_new, out)
1694             # the original backup should still be the oldest (i.e. sorts
1695             # alphabetically towards the beginning)
1696             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
1697                                  self.old_archives[0])
1698         d.addCallback(_check5)
1699
1700         d.addCallback(self.stall, 1.1)
1701         def _modify(res):
1702             self.writeto("parent/subdir/foo.txt", "FOOF!")
1703             # and turn a file into a directory
1704             os.unlink(os.path.join(source, "parent/blah.txt"))
1705             os.mkdir(os.path.join(source, "parent/blah.txt"))
1706             self.writeto("parent/blah.txt/surprise file", "surprise")
1707             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
1708             # turn a directory into a file
1709             os.rmdir(os.path.join(source, "empty"))
1710             self.writeto("empty", "imagine nothing being here")
1711             return do_backup()
1712         d.addCallback(_modify)
1713         def _check5a((rc, out, err)):
1714             # second backup should reuse bar.txt (if backupdb is available),
1715             # and upload the rest. None of the directories can be reused.
1716             self.failUnlessReallyEqual(err, "")
1717             self.failUnlessReallyEqual(rc, 0)
1718             if have_bdb:
1719                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1720                 # new foo.txt, surprise file, subfile, empty
1721                 self.failUnlessReallyEqual(fu, 4)
1722                 # old bar.txt
1723                 self.failUnlessReallyEqual(fr, 1)
1724                 self.failUnlessReallyEqual(fs, 0)
1725                 # home, parent, subdir, blah.txt, surprisedir
1726                 self.failUnlessReallyEqual(dc, 5)
1727                 self.failUnlessReallyEqual(dr, 0)
1728                 self.failUnlessReallyEqual(ds, 0)
1729         d.addCallback(_check5a)
1730         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1731         def _check6((rc, out, err)):
1732             self.failUnlessReallyEqual(err, "")
1733             self.failUnlessReallyEqual(rc, 0)
1734             self.new_archives = out.split()
1735             expected_new = 3
1736             if have_bdb:
1737                 expected_new += 1
1738             self.failUnlessReallyEqual(len(self.new_archives), expected_new)
1739             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
1740                                  self.old_archives[0])
1741         d.addCallback(_check6)
1742         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1743         def _check7((rc, out, err)):
1744             self.failUnlessReallyEqual(err, "")
1745             self.failUnlessReallyEqual(rc, 0)
1746             self.failUnlessReallyEqual(out, "FOOF!")
1747             # the old snapshot should not be modified
1748             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
1749         d.addCallback(_check7)
1750         def _check8((rc, out, err)):
1751             self.failUnlessReallyEqual(err, "")
1752             self.failUnlessReallyEqual(rc, 0)
1753             self.failUnlessReallyEqual(out, "foo")
1754         d.addCallback(_check8)
1755
1756         return d
1757
1758     # on our old dapper buildslave, this test takes a long time (usually
1759     # 130s), so we have to bump up the default 120s timeout. The create-alias
1760     # and initial backup alone take 60s, probably because of the handful of
1761     # dirnodes being created (RSA key generation). The backup between check4
1762     # and check4a takes 6s, as does the backup before check4b.
1763     test_backup.timeout = 3000
1764
1765     def _check_filtering(self, filtered, all, included, excluded):
1766         filtered = set(filtered)
1767         all = set(all)
1768         included = set(included)
1769         excluded = set(excluded)
1770         self.failUnlessReallyEqual(filtered, included)
1771         self.failUnlessReallyEqual(all.difference(filtered), excluded)
1772
1773     def test_exclude_options(self):
1774         root_listdir = (u'lib.a', u'_darcs', u'subdir', u'nice_doc.lyx')
1775         subdir_listdir = (u'another_doc.lyx', u'run_snake_run.py', u'CVS', u'.svn', u'_darcs')
1776         basedir = "cli/Backup/exclude_options"
1777         fileutil.make_dirs(basedir)
1778         nodeurl_path = os.path.join(basedir, 'node.url')
1779         fileutil.write(nodeurl_path, 'http://example.net:2357/')
1780
1781         # test simple exclude
1782         backup_options = cli.BackupOptions()
1783         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1784                                      basedir, 'from', 'to'])
1785         filtered = list(backup_options.filter_listdir(root_listdir))
1786         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
1787                               (u'nice_doc.lyx',))
1788         # multiple exclude
1789         backup_options = cli.BackupOptions()
1790         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
1791                                      basedir, 'from', 'to'])
1792         filtered = list(backup_options.filter_listdir(root_listdir))
1793         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
1794                               (u'nice_doc.lyx', u'lib.a'))
1795         # vcs metadata exclusion
1796         backup_options = cli.BackupOptions()
1797         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
1798                                      basedir, 'from', 'to'])
1799         filtered = list(backup_options.filter_listdir(subdir_listdir))
1800         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'run_snake_run.py',),
1801                               (u'CVS', u'.svn', u'_darcs'))
1802         # read exclude patterns from file
1803         exclusion_string = "_darcs\n*py\n.svn"
1804         excl_filepath = os.path.join(basedir, 'exclusion')
1805         fileutil.write(excl_filepath, exclusion_string)
1806         backup_options = cli.BackupOptions()
1807         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1808                                      basedir, 'from', 'to'])
1809         filtered = list(backup_options.filter_listdir(subdir_listdir))
1810         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'CVS'),
1811                               (u'.svn', u'_darcs', u'run_snake_run.py'))
1812         # test BackupConfigurationError
1813         self.failUnlessRaises(cli.BackupConfigurationError,
1814                               backup_options.parseOptions,
1815                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
1816                                basedir, 'from', 'to'])
1817
1818         # test that an iterator works too
1819         backup_options = cli.BackupOptions()
1820         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1821                                      basedir, 'from', 'to'])
1822         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1823         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
1824                               (u'nice_doc.lyx',))
1825
1826     def test_exclude_options_unicode(self):
1827         nice_doc = u"nice_d\u00F8c.lyx"
1828         try:
1829             doc_pattern_arg = u"*d\u00F8c*".encode(get_argv_encoding())
1830         except UnicodeEncodeError:
1831             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1832
1833         root_listdir = (u'lib.a', u'_darcs', u'subdir', nice_doc)
1834         basedir = "cli/Backup/exclude_options_unicode"
1835         fileutil.make_dirs(basedir)
1836         nodeurl_path = os.path.join(basedir, 'node.url')
1837         fileutil.write(nodeurl_path, 'http://example.net:2357/')
1838
1839         # test simple exclude
1840         backup_options = cli.BackupOptions()
1841         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
1842                                      basedir, 'from', 'to'])
1843         filtered = list(backup_options.filter_listdir(root_listdir))
1844         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
1845                               (nice_doc,))
1846         # multiple exclude
1847         backup_options = cli.BackupOptions()
1848         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--exclude', 'lib.?', '--node-directory',
1849                                      basedir, 'from', 'to'])
1850         filtered = list(backup_options.filter_listdir(root_listdir))
1851         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
1852                              (nice_doc, u'lib.a'))
1853         # read exclude patterns from file
1854         exclusion_string = doc_pattern_arg + "\nlib.?"
1855         excl_filepath = os.path.join(basedir, 'exclusion')
1856         fileutil.write(excl_filepath, exclusion_string)
1857         backup_options = cli.BackupOptions()
1858         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1859                                      basedir, 'from', 'to'])
1860         filtered = list(backup_options.filter_listdir(root_listdir))
1861         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
1862                              (nice_doc, u'lib.a'))
1863
1864         # test that an iterator works too
1865         backup_options = cli.BackupOptions()
1866         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
1867                                      basedir, 'from', 'to'])
1868         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1869         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
1870                               (nice_doc,))
1871
1872     @patch('__builtin__.file')
1873     def test_exclude_from_tilde_expansion(self, mock):
1874         basedir = "cli/Backup/exclude_from_tilde_expansion"
1875         fileutil.make_dirs(basedir)
1876         nodeurl_path = os.path.join(basedir, 'node.url')
1877         fileutil.write(nodeurl_path, 'http://example.net:2357/')
1878
1879         # ensure that tilde expansion is performed on exclude-from argument
1880         exclude_file = u'~/.tahoe/excludes.dummy'
1881         backup_options = cli.BackupOptions()
1882
1883         mock.return_value = StringIO()
1884         backup_options.parseOptions(['--exclude-from', unicode_to_argv(exclude_file),
1885                                      '--node-directory', basedir, 'from', 'to'])
1886         self.failUnlessIn(((abspath_expanduser_unicode(exclude_file),), {}), mock.call_args_list)
1887
1888     def test_ignore_symlinks(self):
1889         if not hasattr(os, 'symlink'):
1890             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
1891
1892         self.basedir = os.path.dirname(self.mktemp())
1893         self.set_up_grid()
1894
1895         source = os.path.join(self.basedir, "home")
1896         self.writeto("foo.txt", "foo")
1897         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
1898
1899         d = self.do_cli("create-alias", "tahoe")
1900         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
1901
1902         def _check((rc, out, err)):
1903             self.failUnlessReallyEqual(rc, 2)
1904             foo2 = os.path.join(source, "foo2.txt")
1905             self.failUnlessReallyEqual(err, "WARNING: cannot backup symlink '%s'\n" % foo2)
1906
1907             fu, fr, fs, dc, dr, ds = self.count_output(out)
1908             # foo.txt
1909             self.failUnlessReallyEqual(fu, 1)
1910             self.failUnlessReallyEqual(fr, 0)
1911             # foo2.txt
1912             self.failUnlessReallyEqual(fs, 1)
1913             # home
1914             self.failUnlessReallyEqual(dc, 1)
1915             self.failUnlessReallyEqual(dr, 0)
1916             self.failUnlessReallyEqual(ds, 0)
1917
1918         d.addCallback(_check)
1919         return d
1920
1921     def test_ignore_unreadable_file(self):
1922         self.basedir = os.path.dirname(self.mktemp())
1923         self.set_up_grid()
1924
1925         source = os.path.join(self.basedir, "home")
1926         self.writeto("foo.txt", "foo")
1927         os.chmod(os.path.join(source, "foo.txt"), 0000)
1928
1929         d = self.do_cli("create-alias", "tahoe")
1930         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1931
1932         def _check((rc, out, err)):
1933             self.failUnlessReallyEqual(rc, 2)
1934             self.failUnlessReallyEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
1935
1936             fu, fr, fs, dc, dr, ds = self.count_output(out)
1937             self.failUnlessReallyEqual(fu, 0)
1938             self.failUnlessReallyEqual(fr, 0)
1939             # foo.txt
1940             self.failUnlessReallyEqual(fs, 1)
1941             # home
1942             self.failUnlessReallyEqual(dc, 1)
1943             self.failUnlessReallyEqual(dr, 0)
1944             self.failUnlessReallyEqual(ds, 0)
1945         d.addCallback(_check)
1946
1947         # This is necessary for the temp files to be correctly removed
1948         def _cleanup(self):
1949             os.chmod(os.path.join(source, "foo.txt"), 0644)
1950         d.addCallback(_cleanup)
1951         d.addErrback(_cleanup)
1952
1953         return d
1954
1955     def test_ignore_unreadable_directory(self):
1956         self.basedir = os.path.dirname(self.mktemp())
1957         self.set_up_grid()
1958
1959         source = os.path.join(self.basedir, "home")
1960         os.mkdir(source)
1961         os.mkdir(os.path.join(source, "test"))
1962         os.chmod(os.path.join(source, "test"), 0000)
1963
1964         d = self.do_cli("create-alias", "tahoe")
1965         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1966
1967         def _check((rc, out, err)):
1968             self.failUnlessReallyEqual(rc, 2)
1969             self.failUnlessReallyEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
1970
1971             fu, fr, fs, dc, dr, ds = self.count_output(out)
1972             self.failUnlessReallyEqual(fu, 0)
1973             self.failUnlessReallyEqual(fr, 0)
1974             self.failUnlessReallyEqual(fs, 0)
1975             # home, test
1976             self.failUnlessReallyEqual(dc, 2)
1977             self.failUnlessReallyEqual(dr, 0)
1978             # test
1979             self.failUnlessReallyEqual(ds, 1)
1980         d.addCallback(_check)
1981
1982         # This is necessary for the temp files to be correctly removed
1983         def _cleanup(self):
1984             os.chmod(os.path.join(source, "test"), 0655)
1985         d.addCallback(_cleanup)
1986         d.addErrback(_cleanup)
1987         return d
1988
1989     def test_backup_without_alias(self):
1990         # 'tahoe backup' should output a sensible error message when invoked
1991         # without an alias instead of a stack trace.
1992         self.basedir = os.path.dirname(self.mktemp())
1993         self.set_up_grid()
1994         source = os.path.join(self.basedir, "file1")
1995         d = self.do_cli('backup', source, source)
1996         def _check((rc, out, err)):
1997             self.failUnlessReallyEqual(rc, 1)
1998             self.failUnlessIn("error:", err)
1999             self.failUnlessReallyEqual(out, "")
2000         d.addCallback(_check)
2001         return d
2002
2003     def test_backup_with_nonexistent_alias(self):
2004         # 'tahoe backup' should output a sensible error message when invoked
2005         # with a nonexistent alias.
2006         self.basedir = os.path.dirname(self.mktemp())
2007         self.set_up_grid()
2008         source = os.path.join(self.basedir, "file1")
2009         d = self.do_cli("backup", source, "nonexistent:" + source)
2010         def _check((rc, out, err)):
2011             self.failUnlessReallyEqual(rc, 1)
2012             self.failUnlessIn("error:", err)
2013             self.failUnlessIn("nonexistent", err)
2014             self.failUnlessReallyEqual(out, "")
2015         d.addCallback(_check)
2016         return d
2017
2018
2019 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
2020
2021     def test_check(self):
2022         self.basedir = "cli/Check/check"
2023         self.set_up_grid()
2024         c0 = self.g.clients[0]
2025         DATA = "data" * 100
2026         d = c0.create_mutable_file(DATA)
2027         def _stash_uri(n):
2028             self.uri = n.get_uri()
2029         d.addCallback(_stash_uri)
2030
2031         d.addCallback(lambda ign: self.do_cli("check", self.uri))
2032         def _check1((rc, out, err)):
2033             self.failUnlessReallyEqual(err, "")
2034             self.failUnlessReallyEqual(rc, 0)
2035             lines = out.splitlines()
2036             self.failUnless("Summary: Healthy" in lines, out)
2037             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2038         d.addCallback(_check1)
2039
2040         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
2041         def _check2((rc, out, err)):
2042             self.failUnlessReallyEqual(err, "")
2043             self.failUnlessReallyEqual(rc, 0)
2044             data = simplejson.loads(out)
2045             self.failUnlessReallyEqual(to_str(data["summary"]), "Healthy")
2046         d.addCallback(_check2)
2047
2048         def _clobber_shares(ignored):
2049             # delete one, corrupt a second
2050             shares = self.find_uri_shares(self.uri)
2051             self.failUnlessReallyEqual(len(shares), 10)
2052             os.unlink(shares[0][2])
2053             cso = debug.CorruptShareOptions()
2054             cso.stdout = StringIO()
2055             cso.parseOptions([shares[1][2]])
2056             storage_index = uri.from_string(self.uri).get_storage_index()
2057             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
2058                                        (base32.b2a(shares[1][1]),
2059                                         base32.b2a(storage_index),
2060                                         shares[1][0])
2061             debug.corrupt_share(cso)
2062         d.addCallback(_clobber_shares)
2063
2064         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
2065         def _check3((rc, out, err)):
2066             self.failUnlessReallyEqual(err, "")
2067             self.failUnlessReallyEqual(rc, 0)
2068             lines = out.splitlines()
2069             summary = [l for l in lines if l.startswith("Summary")][0]
2070             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
2071                             in summary, summary)
2072             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2073             self.failUnless(" corrupt shares:" in lines, out)
2074             self.failUnless(self._corrupt_share_line in lines, out)
2075         d.addCallback(_check3)
2076
2077         d.addCallback(lambda ign:
2078                       self.do_cli("check", "--verify", "--repair", self.uri))
2079         def _check4((rc, out, err)):
2080             self.failUnlessReallyEqual(err, "")
2081             self.failUnlessReallyEqual(rc, 0)
2082             lines = out.splitlines()
2083             self.failUnless("Summary: not healthy" in lines, out)
2084             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2085             self.failUnless(" corrupt shares:" in lines, out)
2086             self.failUnless(self._corrupt_share_line in lines, out)
2087             self.failUnless(" repair successful" in lines, out)
2088         d.addCallback(_check4)
2089
2090         d.addCallback(lambda ign:
2091                       self.do_cli("check", "--verify", "--repair", self.uri))
2092         def _check5((rc, out, err)):
2093             self.failUnlessReallyEqual(err, "")
2094             self.failUnlessReallyEqual(rc, 0)
2095             lines = out.splitlines()
2096             self.failUnless("Summary: healthy" in lines, out)
2097             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2098             self.failIf(" corrupt shares:" in lines, out)
2099         d.addCallback(_check5)
2100
2101         return d
2102
2103     def test_deep_check(self):
2104         self.basedir = "cli/Check/deep_check"
2105         self.set_up_grid()
2106         c0 = self.g.clients[0]
2107         self.uris = {}
2108         self.fileurls = {}
2109         DATA = "data" * 100
2110         quoted_good = quote_output(u"g\u00F6\u00F6d")
2111
2112         d = c0.create_dirnode()
2113         def _stash_root_and_create_file(n):
2114             self.rootnode = n
2115             self.rooturi = n.get_uri()
2116             return n.add_file(u"g\u00F6\u00F6d", upload.Data(DATA, convergence=""))
2117         d.addCallback(_stash_root_and_create_file)
2118         def _stash_uri(fn, which):
2119             self.uris[which] = fn.get_uri()
2120             return fn
2121         d.addCallback(_stash_uri, u"g\u00F6\u00F6d")
2122         d.addCallback(lambda ign:
2123                       self.rootnode.add_file(u"small",
2124                                            upload.Data("literal",
2125                                                         convergence="")))
2126         d.addCallback(_stash_uri, "small")
2127         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
2128         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
2129         d.addCallback(_stash_uri, "mutable")
2130
2131         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2132         def _check1((rc, out, err)):
2133             self.failUnlessReallyEqual(err, "")
2134             self.failUnlessReallyEqual(rc, 0)
2135             lines = out.splitlines()
2136             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2137                             in lines, out)
2138         d.addCallback(_check1)
2139
2140         # root
2141         # root/g\u00F6\u00F6d
2142         # root/small
2143         # root/mutable
2144
2145         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
2146                                               self.rooturi))
2147         def _check2((rc, out, err)):
2148             self.failUnlessReallyEqual(err, "")
2149             self.failUnlessReallyEqual(rc, 0)
2150             lines = out.splitlines()
2151             self.failUnless("'<root>': Healthy" in lines, out)
2152             self.failUnless("'small': Healthy (LIT)" in lines, out)
2153             self.failUnless((quoted_good + ": Healthy") in lines, out)
2154             self.failUnless("'mutable': Healthy" in lines, out)
2155             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2156                             in lines, out)
2157         d.addCallback(_check2)
2158
2159         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2160         def _check_stats((rc, out, err)):
2161             self.failUnlessReallyEqual(err, "")
2162             self.failUnlessReallyEqual(rc, 0)
2163             lines = out.splitlines()
2164             self.failUnlessIn(" count-immutable-files: 1", lines)
2165             self.failUnlessIn("   count-mutable-files: 1", lines)
2166             self.failUnlessIn("   count-literal-files: 1", lines)
2167             self.failUnlessIn("     count-directories: 1", lines)
2168             self.failUnlessIn("  size-immutable-files: 400", lines)
2169             self.failUnlessIn("Size Histogram:", lines)
2170             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
2171             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
2172         d.addCallback(_check_stats)
2173
2174         def _clobber_shares(ignored):
2175             shares = self.find_uri_shares(self.uris[u"g\u00F6\u00F6d"])
2176             self.failUnlessReallyEqual(len(shares), 10)
2177             os.unlink(shares[0][2])
2178
2179             shares = self.find_uri_shares(self.uris["mutable"])
2180             cso = debug.CorruptShareOptions()
2181             cso.stdout = StringIO()
2182             cso.parseOptions([shares[1][2]])
2183             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
2184             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
2185                                        (base32.b2a(shares[1][1]),
2186                                         base32.b2a(storage_index),
2187                                         shares[1][0])
2188             debug.corrupt_share(cso)
2189         d.addCallback(_clobber_shares)
2190
2191         # root
2192         # root/g\u00F6\u00F6d  [9 shares]
2193         # root/small
2194         # root/mutable [1 corrupt share]
2195
2196         d.addCallback(lambda ign:
2197                       self.do_cli("deep-check", "--verbose", self.rooturi))
2198         def _check3((rc, out, err)):
2199             self.failUnlessReallyEqual(err, "")
2200             self.failUnlessReallyEqual(rc, 0)
2201             lines = out.splitlines()
2202             self.failUnless("'<root>': Healthy" in lines, out)
2203             self.failUnless("'small': Healthy (LIT)" in lines, out)
2204             self.failUnless("'mutable': Healthy" in lines, out) # needs verifier
2205             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
2206             self.failIf(self._corrupt_share_line in lines, out)
2207             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
2208                             in lines, out)
2209         d.addCallback(_check3)
2210
2211         d.addCallback(lambda ign:
2212                       self.do_cli("deep-check", "--verbose", "--verify",
2213                                   self.rooturi))
2214         def _check4((rc, out, err)):
2215             self.failUnlessReallyEqual(err, "")
2216             self.failUnlessReallyEqual(rc, 0)
2217             lines = out.splitlines()
2218             self.failUnless("'<root>': Healthy" in lines, out)
2219             self.failUnless("'small': Healthy (LIT)" in lines, out)
2220             mutable = [l for l in lines if l.startswith("'mutable'")][0]
2221             self.failUnless(mutable.startswith("'mutable': Unhealthy: 9 shares (enc 3-of-10)"),
2222                             mutable)
2223             self.failUnless(self._corrupt_share_line in lines, out)
2224             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
2225             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
2226                             in lines, out)
2227         d.addCallback(_check4)
2228
2229         d.addCallback(lambda ign:
2230                       self.do_cli("deep-check", "--raw",
2231                                   self.rooturi))
2232         def _check5((rc, out, err)):
2233             self.failUnlessReallyEqual(err, "")
2234             self.failUnlessReallyEqual(rc, 0)
2235             lines = out.splitlines()
2236             units = [simplejson.loads(line) for line in lines]
2237             # root, small, g\u00F6\u00F6d, mutable,  stats
2238             self.failUnlessReallyEqual(len(units), 4+1)
2239         d.addCallback(_check5)
2240
2241         d.addCallback(lambda ign:
2242                       self.do_cli("deep-check",
2243                                   "--verbose", "--verify", "--repair",
2244                                   self.rooturi))
2245         def _check6((rc, out, err)):
2246             self.failUnlessReallyEqual(err, "")
2247             self.failUnlessReallyEqual(rc, 0)
2248             lines = out.splitlines()
2249             self.failUnless("'<root>': healthy" in lines, out)
2250             self.failUnless("'small': healthy" in lines, out)
2251             self.failUnless("'mutable': not healthy" in lines, out)
2252             self.failUnless(self._corrupt_share_line in lines, out)
2253             self.failUnless((quoted_good + ": not healthy") in lines, out)
2254             self.failUnless("done: 4 objects checked" in lines, out)
2255             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
2256             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
2257                             in lines, out)
2258             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
2259         d.addCallback(_check6)
2260
2261         # now add a subdir, and a file below that, then make the subdir
2262         # unrecoverable
2263
2264         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
2265         d.addCallback(_stash_uri, "subdir")
2266         d.addCallback(lambda fn:
2267                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
2268         d.addCallback(lambda ign:
2269                       self.delete_shares_numbered(self.uris["subdir"],
2270                                                   range(10)))
2271
2272         # root
2273         # rootg\u00F6\u00F6d/
2274         # root/small
2275         # root/mutable
2276         # root/subdir [unrecoverable: 0 shares]
2277         # root/subfile
2278
2279         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
2280         def _manifest_failed((rc, out, err)):
2281             self.failIfEqual(rc, 0)
2282             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2283             # the fatal directory should still show up, as the last line
2284             self.failUnlessIn(" subdir\n", out)
2285         d.addCallback(_manifest_failed)
2286
2287         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2288         def _deep_check_failed((rc, out, err)):
2289             self.failIfEqual(rc, 0)
2290             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2291             # we want to make sure that the error indication is the last
2292             # thing that gets emitted
2293             self.failIf("done:" in out, out)
2294         d.addCallback(_deep_check_failed)
2295
2296         # this test is disabled until the deep-repair response to an
2297         # unrepairable directory is fixed. The failure-to-repair should not
2298         # throw an exception, but the failure-to-traverse that follows
2299         # should throw UnrecoverableFileError.
2300
2301         #d.addCallback(lambda ign:
2302         #              self.do_cli("deep-check", "--repair", self.rooturi))
2303         #def _deep_check_repair_failed((rc, out, err)):
2304         #    self.failIfEqual(rc, 0)
2305         #    print err
2306         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
2307         #    self.failIf("done:" in out, out)
2308         #d.addCallback(_deep_check_repair_failed)
2309
2310         return d
2311
2312     def test_check_without_alias(self):
2313         # 'tahoe check' should output a sensible error message if it needs to
2314         # find the default alias and can't
2315         self.basedir = "cli/Check/check_without_alias"
2316         self.set_up_grid()
2317         d = self.do_cli("check")
2318         def _check((rc, out, err)):
2319             self.failUnlessReallyEqual(rc, 1)
2320             self.failUnlessIn("error:", err)
2321             self.failUnlessReallyEqual(out, "")
2322         d.addCallback(_check)
2323         d.addCallback(lambda ign: self.do_cli("deep-check"))
2324         d.addCallback(_check)
2325         return d
2326
2327     def test_check_with_nonexistent_alias(self):
2328         # 'tahoe check' should output a sensible error message if it needs to
2329         # find an alias and can't.
2330         self.basedir = "cli/Check/check_with_nonexistent_alias"
2331         self.set_up_grid()
2332         d = self.do_cli("check", "nonexistent:")
2333         def _check((rc, out, err)):
2334             self.failUnlessReallyEqual(rc, 1)
2335             self.failUnlessIn("error:", err)
2336             self.failUnlessIn("nonexistent", err)
2337             self.failUnlessReallyEqual(out, "")
2338         d.addCallback(_check)
2339         return d
2340
2341
2342 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
2343     def test_get(self):
2344         self.basedir = "cli/Errors/get"
2345         self.set_up_grid()
2346         c0 = self.g.clients[0]
2347         self.fileurls = {}
2348         DATA = "data" * 100
2349         d = c0.upload(upload.Data(DATA, convergence=""))
2350         def _stash_bad(ur):
2351             self.uri_1share = ur.uri
2352             self.delete_shares_numbered(ur.uri, range(1,10))
2353         d.addCallback(_stash_bad)
2354
2355         # the download is abandoned as soon as it's clear that we won't get
2356         # enough shares. The one remaining share might be in either the
2357         # COMPLETE or the PENDING state.
2358         in_complete_msg = "ran out of shares: complete=sh0 pending= overdue= unused= need 3"
2359         in_pending_msg = "ran out of shares: complete= pending=Share(sh0-on-fob7v) overdue= unused= need 3"
2360
2361         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
2362         def _check1((rc, out, err)):
2363             self.failIfEqual(rc, 0)
2364             self.failUnless("410 Gone" in err, err)
2365             self.failUnlessIn("NotEnoughSharesError: ", err)
2366             self.failUnless(in_complete_msg in err or in_pending_msg in err,
2367                             err)
2368         d.addCallback(_check1)
2369
2370         targetf = os.path.join(self.basedir, "output")
2371         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
2372         def _check2((rc, out, err)):
2373             self.failIfEqual(rc, 0)
2374             self.failUnless("410 Gone" in err, err)
2375             self.failUnlessIn("NotEnoughSharesError: ", err)
2376             self.failUnless(in_complete_msg in err or in_pending_msg in err,
2377                             err)
2378             self.failIf(os.path.exists(targetf))
2379         d.addCallback(_check2)
2380
2381         return d
2382
2383
2384 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
2385     def test_get_without_alias(self):
2386         # 'tahoe get' should output a useful error message when invoked
2387         # without an explicit alias and when the default 'tahoe' alias
2388         # hasn't been created yet.
2389         self.basedir = "cli/Get/get_without_alias"
2390         self.set_up_grid()
2391         d = self.do_cli('get', 'file')
2392         def _check((rc, out, err)):
2393             self.failUnlessReallyEqual(rc, 1)
2394             self.failUnlessIn("error:", err)
2395             self.failUnlessReallyEqual(out, "")
2396         d.addCallback(_check)
2397         return d
2398
2399     def test_get_with_nonexistent_alias(self):
2400         # 'tahoe get' should output a useful error message when invoked with
2401         # an explicit alias that doesn't exist.
2402         self.basedir = "cli/Get/get_with_nonexistent_alias"
2403         self.set_up_grid()
2404         d = self.do_cli("get", "nonexistent:file")
2405         def _check((rc, out, err)):
2406             self.failUnlessReallyEqual(rc, 1)
2407             self.failUnlessIn("error:", err)
2408             self.failUnlessIn("nonexistent", err)
2409             self.failUnlessReallyEqual(out, "")
2410         d.addCallback(_check)
2411         return d
2412
2413
2414 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
2415     def test_manifest_without_alias(self):
2416         # 'tahoe manifest' should output a useful error message when invoked
2417         # without an explicit alias when the default 'tahoe' alias is
2418         # missing.
2419         self.basedir = "cli/Manifest/manifest_without_alias"
2420         self.set_up_grid()
2421         d = self.do_cli("manifest")
2422         def _check((rc, out, err)):
2423             self.failUnlessReallyEqual(rc, 1)
2424             self.failUnlessIn("error:", err)
2425             self.failUnlessReallyEqual(out, "")
2426         d.addCallback(_check)
2427         return d
2428
2429     def test_manifest_with_nonexistent_alias(self):
2430         # 'tahoe manifest' should output a useful error message when invoked
2431         # with an explicit alias that doesn't exist.
2432         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
2433         self.set_up_grid()
2434         d = self.do_cli("manifest", "nonexistent:")
2435         def _check((rc, out, err)):
2436             self.failUnlessReallyEqual(rc, 1)
2437             self.failUnlessIn("error:", err)
2438             self.failUnlessIn("nonexistent", err)
2439             self.failUnlessReallyEqual(out, "")
2440         d.addCallback(_check)
2441         return d
2442
2443
2444 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
2445     def test_mkdir(self):
2446         self.basedir = os.path.dirname(self.mktemp())
2447         self.set_up_grid()
2448
2449         d = self.do_cli("create-alias", "tahoe")
2450         d.addCallback(lambda res: self.do_cli("mkdir", "test"))
2451         def _check((rc, out, err)):
2452             self.failUnlessReallyEqual(rc, 0)
2453             self.failUnlessReallyEqual(err, "")
2454             self.failUnlessIn("URI:", out)
2455         d.addCallback(_check)
2456
2457         return d
2458
2459     def test_mkdir_unicode(self):
2460         self.basedir = os.path.dirname(self.mktemp())
2461         self.set_up_grid()
2462
2463         try:
2464             motorhead_arg = u"tahoe:Mot\u00F6rhead".encode(get_argv_encoding())
2465         except UnicodeEncodeError:
2466             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
2467
2468         d = self.do_cli("create-alias", "tahoe")
2469         d.addCallback(lambda res: self.do_cli("mkdir", motorhead_arg))
2470         def _check((rc, out, err)):
2471             self.failUnlessReallyEqual(rc, 0)
2472             self.failUnlessReallyEqual(err, "")
2473             self.failUnlessIn("URI:", out)
2474         d.addCallback(_check)
2475
2476         return d
2477
2478     def test_mkdir_with_nonexistent_alias(self):
2479         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
2480         # output a sensible error message rather than a stack trace.
2481         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
2482         self.set_up_grid()
2483         d = self.do_cli("mkdir", "havasu:")
2484         def _check((rc, out, err)):
2485             self.failUnlessReallyEqual(rc, 1)
2486             self.failUnlessIn("error:", err)
2487             self.failUnlessReallyEqual(out, "")
2488         d.addCallback(_check)
2489         return d
2490
2491
2492 class Rm(GridTestMixin, CLITestMixin, unittest.TestCase):
2493     def test_rm_without_alias(self):
2494         # 'tahoe rm' should behave sensibly when invoked without an explicit
2495         # alias before the default 'tahoe' alias has been created.
2496         self.basedir = "cli/Rm/rm_without_alias"
2497         self.set_up_grid()
2498         d = self.do_cli("rm", "afile")
2499         def _check((rc, out, err)):
2500             self.failUnlessReallyEqual(rc, 1)
2501             self.failUnlessIn("error:", err)
2502             self.failUnlessReallyEqual(out, "")
2503         d.addCallback(_check)
2504
2505         d.addCallback(lambda ign: self.do_cli("unlink", "afile"))
2506         d.addCallback(_check)
2507         return d
2508
2509     def test_rm_with_nonexistent_alias(self):
2510         # 'tahoe rm' should behave sensibly when invoked with an explicit
2511         # alias that doesn't exist.
2512         self.basedir = "cli/Rm/rm_with_nonexistent_alias"
2513         self.set_up_grid()
2514         d = self.do_cli("rm", "nonexistent:afile")
2515         def _check((rc, out, err)):
2516             self.failUnlessReallyEqual(rc, 1)
2517             self.failUnlessIn("error:", err)
2518             self.failUnlessIn("nonexistent", err)
2519             self.failUnlessReallyEqual(out, "")
2520         d.addCallback(_check)
2521
2522         d.addCallback(lambda ign: self.do_cli("unlink", "nonexistent:afile"))
2523         d.addCallback(_check)
2524         return d
2525
2526
2527 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
2528     def test_empty_directory(self):
2529         self.basedir = "cli/Stats/empty_directory"
2530         self.set_up_grid()
2531         c0 = self.g.clients[0]
2532         self.fileurls = {}
2533         d = c0.create_dirnode()
2534         def _stash_root(n):
2535             self.rootnode = n
2536             self.rooturi = n.get_uri()
2537         d.addCallback(_stash_root)
2538
2539         # make sure we can get stats on an empty directory too
2540         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2541         def _check_stats((rc, out, err)):
2542             self.failUnlessReallyEqual(err, "")
2543             self.failUnlessReallyEqual(rc, 0)
2544             lines = out.splitlines()
2545             self.failUnlessIn(" count-immutable-files: 0", lines)
2546             self.failUnlessIn("   count-mutable-files: 0", lines)
2547             self.failUnlessIn("   count-literal-files: 0", lines)
2548             self.failUnlessIn("     count-directories: 1", lines)
2549             self.failUnlessIn("  size-immutable-files: 0", lines)
2550             self.failIfIn("Size Histogram:", lines)
2551         d.addCallback(_check_stats)
2552
2553         return d
2554
2555     def test_stats_without_alias(self):
2556         # when invoked with no explicit alias and before the default 'tahoe'
2557         # alias is created, 'tahoe stats' should output an informative error
2558         # message, not a stack trace.
2559         self.basedir = "cli/Stats/stats_without_alias"
2560         self.set_up_grid()
2561         d = self.do_cli("stats")
2562         def _check((rc, out, err)):
2563             self.failUnlessReallyEqual(rc, 1)
2564             self.failUnlessIn("error:", err)
2565             self.failUnlessReallyEqual(out, "")
2566         d.addCallback(_check)
2567         return d
2568
2569     def test_stats_with_nonexistent_alias(self):
2570         # when invoked with an explicit alias that doesn't exist,
2571         # 'tahoe stats' should output a useful error message.
2572         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
2573         self.set_up_grid()
2574         d = self.do_cli("stats", "havasu:")
2575         def _check((rc, out, err)):
2576             self.failUnlessReallyEqual(rc, 1)
2577             self.failUnlessIn("error:", err)
2578             self.failUnlessReallyEqual(out, "")
2579         d.addCallback(_check)
2580         return d
2581
2582
2583 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
2584     def test_webopen_with_nonexistent_alias(self):
2585         # when invoked with an alias that doesn't exist, 'tahoe webopen'
2586         # should output an informative error message instead of a stack
2587         # trace.
2588         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
2589         self.set_up_grid()
2590         d = self.do_cli("webopen", "fake:")
2591         def _check((rc, out, err)):
2592             self.failUnlessReallyEqual(rc, 1)
2593             self.failUnlessIn("error:", err)
2594             self.failUnlessReallyEqual(out, "")
2595         d.addCallback(_check)
2596         return d