src/allmydata/test/test_cli.py

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