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