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