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