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