src/allmydata/test/test_cli.py

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