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
  15 # functionality are 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(["-i", "tahoe:subdir"],
 534                                self.tahoe_subdir_url+"?t=info")
 535             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
 536             self._test_webopen(["tahoe:subdir/file"],
 537                                self.tahoe_subdir_url + '/file')
 538             self._test_webopen(["--info", "tahoe:subdir/file"],
 539                                self.tahoe_subdir_url + '/file?t=info')
 540             # if "file" is indeed a file, then the url produced by webopen in
 541             # this case is disallowed by the webui. but by design, webopen
 542             # passes through the mistake from the user to the resultant
 543             # webopened url
 544             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
 545             self._test_webopen(["two:"], self.two_url)
 546         d.addCallback(_test_urls)
 547
 548         def _remove_trailing_newline_and_create_alias(ign):
 549             # ticket #741 is about a manually-edited alias file (which
 550             # doesn't end in a newline) being corrupted by a subsequent
 551             # "tahoe create-alias"
 552             old = fileutil.read(aliasfile)
 553             fileutil.write(aliasfile, old.rstrip())
 554             return self.do_cli("create-alias", "un-corrupted1")
 555         d.addCallback(_remove_trailing_newline_and_create_alias)
 556         def _check_not_corrupted1((rc,stdout,stderr)):
 557             self.failUnless("Alias 'un-corrupted1' created" in stdout, stdout)
 558             self.failIf(stderr)
 559             # the old behavior was to simply append the new record, causing a
 560             # line that looked like "NAME1: CAP1NAME2: CAP2". This won't look
 561             # like a valid dircap, so get_aliases() will raise an exception.
 562             aliases = get_aliases(self.get_clientdir())
 563             self.failUnless("added" in aliases)
 564             self.failUnless(aliases["added"].startswith("URI:DIR2:"))
 565             # to be safe, let's confirm that we don't see "NAME2:" in CAP1.
 566             # No chance of a false-negative, because the hyphen in
 567             # "un-corrupted1" is not a valid base32 character.
 568             self.failIfIn("un-corrupted1:", aliases["added"])
 569             self.failUnless("un-corrupted1" in aliases)
 570             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 571         d.addCallback(_check_not_corrupted1)
 572
 573         def _remove_trailing_newline_and_add_alias(ign):
 574             # same thing, but for "tahoe add-alias"
 575             old = fileutil.read(aliasfile)
 576             fileutil.write(aliasfile, old.rstrip())
 577             return self.do_cli("add-alias", "un-corrupted2", self.two_uri)
 578         d.addCallback(_remove_trailing_newline_and_add_alias)
 579         def _check_not_corrupted((rc,stdout,stderr)):
 580             self.failUnless("Alias 'un-corrupted2' added" in stdout, stdout)
 581             self.failIf(stderr)
 582             aliases = get_aliases(self.get_clientdir())
 583             self.failUnless("un-corrupted1" in aliases)
 584             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 585             self.failIfIn("un-corrupted2:", aliases["un-corrupted1"])
 586             self.failUnless("un-corrupted2" in aliases)
 587             self.failUnless(aliases["un-corrupted2"].startswith("URI:DIR2:"))
 588         d.addCallback(_check_not_corrupted)
 589
 590         return d
 591
 592
 593 class Ln(GridTestMixin, CLITestMixin, unittest.TestCase):
 594     def _create_test_file(self):
 595         data = "puppies" * 1000
 596         path = os.path.join(self.basedir, "datafile")
 597         f = open(path, 'wb')
 598         f.write(data)
 599         f.close()
 600         self.datafile = path
 601
 602     def test_ln_without_alias(self):
 603         # if invoked without an alias when the 'tahoe' alias doesn't
 604         # exist, 'tahoe ln' should output a useful error message and not
 605         # a stack trace
 606         self.basedir = "cli/Ln/ln_without_alias"
 607         self.set_up_grid()
 608         d = self.do_cli("ln", "from", "to")
 609         def _check((rc, out, err)):
 610             self.failUnlessEqual(rc, 1)
 611             self.failUnlessIn("error:", err)
 612         d.addCallback(_check)
 613         # Make sure that validation extends to the "to" parameter
 614         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 615         d.addCallback(lambda ign: self._create_test_file())
 616         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 617                                               "havasu:from"))
 618         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "to"))
 619         d.addCallback(_check)
 620         return d
 621
 622     def test_ln_with_nonexistent_alias(self):
 623         # If invoked with aliases that don't exist, 'tahoe ln' should
 624         # output a useful error message and not a stack trace.
 625         self.basedir = "cli/Ln/ln_with_nonexistent_alias"
 626         self.set_up_grid()
 627         d = self.do_cli("ln", "havasu:from", "havasu:to")
 628         def _check((rc, out, err)):
 629             self.failUnlessEqual(rc, 1)
 630             self.failUnlessIn("error:", err)
 631         d.addCallback(_check)
 632         # Make sure that validation occurs on the to parameter if the
 633         # from parameter passes.
 634         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 635         d.addCallback(lambda ign: self._create_test_file())
 636         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 637                                               "havasu:from"))
 638         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "huron:to"))
 639         d.addCallback(_check)
 640         return d
 641
 642
 643 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
 644
 645     def test_unlinked_immutable_stdin(self):
 646         # tahoe get `echo DATA | tahoe put`
 647         # tahoe get `echo DATA | tahoe put -`
 648         self.basedir = "cli/Put/unlinked_immutable_stdin"
 649         DATA = "data" * 100
 650         self.set_up_grid()
 651         d = self.do_cli("put", stdin=DATA)
 652         def _uploaded(res):
 653             (rc, stdout, stderr) = res
 654             self.failUnless("waiting for file data on stdin.." in stderr)
 655             self.failUnless("200 OK" in stderr, stderr)
 656             self.readcap = stdout
 657             self.failUnless(self.readcap.startswith("URI:CHK:"))
 658         d.addCallback(_uploaded)
 659         d.addCallback(lambda res: self.do_cli("get", self.readcap))
 660         def _downloaded(res):
 661             (rc, stdout, stderr) = res
 662             self.failUnlessEqual(stderr, "")
 663             self.failUnlessEqual(stdout, DATA)
 664         d.addCallback(_downloaded)
 665         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
 666         d.addCallback(lambda (rc,stdout,stderr):
 667                       self.failUnlessEqual(stdout, self.readcap))
 668         return d
 669
 670     def test_unlinked_immutable_from_file(self):
 671         # tahoe put file.txt
 672         # tahoe put ./file.txt
 673         # tahoe put /tmp/file.txt
 674         # tahoe put ~/file.txt
 675         self.basedir = "cli/Put/unlinked_immutable_from_file"
 676         self.set_up_grid()
 677
 678         rel_fn = os.path.join(self.basedir, "DATAFILE")
 679         abs_fn = os.path.abspath(rel_fn)
 680         # we make the file small enough to fit in a LIT file, for speed
 681         fileutil.write(rel_fn, "short file")
 682         d = self.do_cli("put", rel_fn)
 683         def _uploaded((rc,stdout,stderr)):
 684             readcap = stdout
 685             self.failUnless(readcap.startswith("URI:LIT:"))
 686             self.readcap = readcap
 687         d.addCallback(_uploaded)
 688         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
 689         d.addCallback(lambda (rc,stdout,stderr):
 690                       self.failUnlessEqual(stdout, self.readcap))
 691         d.addCallback(lambda res: self.do_cli("put", abs_fn))
 692         d.addCallback(lambda (rc,stdout,stderr):
 693                       self.failUnlessEqual(stdout, self.readcap))
 694         # we just have to assume that ~ is handled properly
 695         return d
 696
 697     def test_immutable_from_file(self):
 698         # tahoe put file.txt uploaded.txt
 699         # tahoe - uploaded.txt
 700         # tahoe put file.txt subdir/uploaded.txt
 701         # tahoe put file.txt tahoe:uploaded.txt
 702         # tahoe put file.txt tahoe:subdir/uploaded.txt
 703         # tahoe put file.txt DIRCAP:./uploaded.txt
 704         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
 705         self.basedir = "cli/Put/immutable_from_file"
 706         self.set_up_grid()
 707
 708         rel_fn = os.path.join(self.basedir, "DATAFILE")
 709         # we make the file small enough to fit in a LIT file, for speed
 710         DATA = "short file"
 711         DATA2 = "short file two"
 712         fileutil.write(rel_fn, DATA)
 713
 714         d = self.do_cli("create-alias", "tahoe")
 715
 716         d.addCallback(lambda res:
 717                       self.do_cli("put", rel_fn, "uploaded.txt"))
 718         def _uploaded((rc,stdout,stderr)):
 719             readcap = stdout.strip()
 720             self.failUnless(readcap.startswith("URI:LIT:"))
 721             self.failUnless("201 Created" in stderr, stderr)
 722             self.readcap = readcap
 723         d.addCallback(_uploaded)
 724         d.addCallback(lambda res:
 725                       self.do_cli("get", "tahoe:uploaded.txt"))
 726         d.addCallback(lambda (rc,stdout,stderr):
 727                       self.failUnlessEqual(stdout, DATA))
 728
 729         d.addCallback(lambda res:
 730                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
 731         def _replaced((rc,stdout,stderr)):
 732             readcap = stdout.strip()
 733             self.failUnless(readcap.startswith("URI:LIT:"))
 734             self.failUnless("200 OK" in stderr, stderr)
 735         d.addCallback(_replaced)
 736
 737         d.addCallback(lambda res:
 738                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
 739         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
 740         d.addCallback(lambda (rc,stdout,stderr):
 741                       self.failUnlessEqual(stdout, DATA))
 742
 743         d.addCallback(lambda res:
 744                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
 745         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
 746         d.addCallback(lambda (rc,stdout,stderr):
 747                       self.failUnlessEqual(stdout, DATA))
 748
 749         d.addCallback(lambda res:
 750                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
 751         d.addCallback(lambda res:
 752                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
 753         d.addCallback(lambda (rc,stdout,stderr):
 754                       self.failUnlessEqual(stdout, DATA))
 755
 756         def _get_dircap(res):
 757             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
 758         d.addCallback(_get_dircap)
 759
 760         d.addCallback(lambda res:
 761                       self.do_cli("put", rel_fn,
 762                                   self.dircap+":./uploaded5.txt"))
 763         d.addCallback(lambda res:
 764                       self.do_cli("get", "tahoe:uploaded5.txt"))
 765         d.addCallback(lambda (rc,stdout,stderr):
 766                       self.failUnlessEqual(stdout, DATA))
 767
 768         d.addCallback(lambda res:
 769                       self.do_cli("put", rel_fn,
 770                                   self.dircap+":./subdir/uploaded6.txt"))
 771         d.addCallback(lambda res:
 772                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
 773         d.addCallback(lambda (rc,stdout,stderr):
 774                       self.failUnlessEqual(stdout, DATA))
 775
 776         return d
 777
 778     def test_mutable_unlinked(self):
 779         # FILECAP = `echo DATA | tahoe put --mutable`
 780         # tahoe get FILECAP, compare against DATA
 781         # echo DATA2 | tahoe put - FILECAP
 782         # tahoe get FILECAP, compare against DATA2
 783         # tahoe put file.txt FILECAP
 784         self.basedir = "cli/Put/mutable_unlinked"
 785         self.set_up_grid()
 786
 787         DATA = "data" * 100
 788         DATA2 = "two" * 100
 789         rel_fn = os.path.join(self.basedir, "DATAFILE")
 790         DATA3 = "three" * 100
 791         fileutil.write(rel_fn, DATA3)
 792
 793         d = self.do_cli("put", "--mutable", stdin=DATA)
 794         def _created(res):
 795             (rc, stdout, stderr) = res
 796             self.failUnless("waiting for file data on stdin.." in stderr)
 797             self.failUnless("200 OK" in stderr)
 798             self.filecap = stdout
 799             self.failUnless(self.filecap.startswith("URI:SSK:"))
 800         d.addCallback(_created)
 801         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 802         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA))
 803
 804         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
 805         def _replaced(res):
 806             (rc, stdout, stderr) = res
 807             self.failUnless("waiting for file data on stdin.." in stderr)
 808             self.failUnless("200 OK" in stderr)
 809             self.failUnlessEqual(self.filecap, stdout)
 810         d.addCallback(_replaced)
 811         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 812         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
 813
 814         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
 815         def _replaced2(res):
 816             (rc, stdout, stderr) = res
 817             self.failUnless("200 OK" in stderr)
 818             self.failUnlessEqual(self.filecap, stdout)
 819         d.addCallback(_replaced2)
 820         d.addCallback(lambda res: self.do_cli("get", self.filecap))
 821         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA3))
 822
 823         return d
 824
 825     def test_mutable(self):
 826         # echo DATA1 | tahoe put --mutable - uploaded.txt
 827         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
 828         # tahoe get uploaded.txt, compare against DATA2
 829
 830         self.basedir = "cli/Put/mutable"
 831         self.set_up_grid()
 832
 833         DATA1 = "data" * 100
 834         fn1 = os.path.join(self.basedir, "DATA1")
 835         fileutil.write(fn1, DATA1)
 836         DATA2 = "two" * 100
 837         fn2 = os.path.join(self.basedir, "DATA2")
 838         fileutil.write(fn2, DATA2)
 839
 840         d = self.do_cli("create-alias", "tahoe")
 841         d.addCallback(lambda res:
 842                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
 843         d.addCallback(lambda res:
 844                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
 845         d.addCallback(lambda res:
 846                       self.do_cli("get", "tahoe:uploaded.txt"))
 847         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
 848         return d
 849
 850     def test_put_with_nonexistent_alias(self):
 851         # when invoked with an alias that doesn't exist, 'tahoe put'
 852         # should output a useful error message, not a stack trace
 853         self.basedir = "cli/Put/put_with_nonexistent_alias"
 854         self.set_up_grid()
 855         d = self.do_cli("put", "somefile", "fake:afile")
 856         def _check((rc, out, err)):
 857             self.failUnlessEqual(rc, 1)
 858             self.failUnlessIn("error:", err)
 859         d.addCallback(_check)
 860         return d
 861
 862
 863 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
 864     def test_list(self):
 865         self.basedir = "cli/List/list"
 866         self.set_up_grid()
 867         c0 = self.g.clients[0]
 868         small = "small"
 869         d = c0.create_dirnode()
 870         def _stash_root_and_create_file(n):
 871             self.rootnode = n
 872             self.rooturi = n.get_uri()
 873             return n.add_file(u"good", upload.Data(small, convergence=""))
 874         d.addCallback(_stash_root_and_create_file)
 875         def _stash_goodcap(n):
 876             self.goodcap = n.get_uri()
 877         d.addCallback(_stash_goodcap)
 878         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
 879         d.addCallback(lambda n:
 880                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
 881         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
 882         d.addCallback(lambda n:
 883                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
 884         d.addCallback(lambda ign:
 885                       self.do_cli("add-alias", "tahoe", self.rooturi))
 886         d.addCallback(lambda ign: self.do_cli("ls"))
 887         def _check1((rc,out,err)):
 888             self.failUnlessEqual(err, "")
 889             self.failUnlessEqual(rc, 0)
 890             self.failUnlessEqual(out.splitlines(), ["0share", "1share", "good"])
 891         d.addCallback(_check1)
 892         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
 893         def _check2((rc,out,err)):
 894             self.failIfEqual(rc, 0)
 895             self.failUnlessEqual(err.strip(), "No such file or directory")
 896             self.failUnlessEqual(out, "")
 897         d.addCallback(_check2)
 898         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
 899         def _check3((rc,out,err)):
 900             self.failIfEqual(rc, 0)
 901             self.failUnlessIn("Error during GET: 410 Gone ", err)
 902             self.failUnlessIn("UnrecoverableFileError:", err)
 903             self.failUnlessIn("could not be retrieved, because there were "
 904                               "insufficient good shares.", err)
 905             self.failUnlessEqual(out, "")
 906         d.addCallback(_check3)
 907         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
 908         d.addCallback(_check3)
 909         def _check4((rc, out, err)):
 910             # listing a file (as dir/filename) should have the edge metadata,
 911             # including the filename
 912             self.failUnlessEqual(rc, 0)
 913             self.failUnlessIn("good", out)
 914             self.failIfIn("-r-- %d -" % len(small), out,
 915                           "trailing hyphen means unknown date")
 916         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
 917         d.addCallback(_check4)
 918         # listing a file as $DIRCAP/filename should work just like dir/filename
 919         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
 920         d.addCallback(_check4)
 921         # and similarly for $DIRCAP:./filename
 922         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
 923         d.addCallback(_check4)
 924         def _check5((rc, out, err)):
 925             # listing a raw filecap should not explode, but it will have no
 926             # metadata, just the size
 927             self.failUnlessEqual(rc, 0)
 928             self.failUnlessEqual("-r-- %d -" % len(small), out.strip())
 929         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
 930         d.addCallback(_check5)
 931         unknown_immcap = "imm.URI:unknown"
 932         def _create_unknown(ign):
 933             nm = c0.nodemaker
 934             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
 935             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
 936                                                      mutable=False)
 937         d.addCallback(_create_unknown)
 938         def _check6((rc, out, err)):
 939             # listing a directory referencing an unknown object should print
 940             # an extra message to stderr
 941             self.failUnlessEqual(rc, 0)
 942             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
 943             self.failUnlessIn("included unknown objects", err)
 944         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
 945         d.addCallback(_check6)
 946         def _check7((rc, out, err)):
 947             # listing an unknown cap directly should print an extra message
 948             # to stderr (currently this only works if the URI starts with 'URI:'
 949             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
 950             # with an alias).
 951             self.failUnlessEqual(rc, 0)
 952             self.failUnlessIn("?r-- ? -\n", out)
 953             self.failUnlessIn("included unknown objects", err)
 954         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
 955         d.addCallback(_check7)
 956         return d
 957
 958     def test_list_without_alias(self):
 959         # doing just 'tahoe ls' without specifying an alias or first
 960         # doing 'tahoe create-alias tahoe' should fail gracefully.
 961         self.basedir = "cli/List/list_without_alias"
 962         self.set_up_grid()
 963         d = self.do_cli("ls")
 964         def _check((rc, out, err)):
 965             self.failUnlessEqual(rc, 1)
 966             self.failUnlessIn("error:", err)
 967         d.addCallback(_check)
 968         return d
 969
 970     def test_list_with_nonexistent_alias(self):
 971         # doing 'tahoe ls' while specifying an alias that doesn't already
 972         # exist should fail with an informative error message
 973         self.basedir = "cli/List/list_with_nonexistent_alias"
 974         self.set_up_grid()
 975         d = self.do_cli("ls", "nonexistent:")
 976         def _check((rc, out, err)):
 977             self.failUnlessEqual(rc, 1)
 978             self.failUnlessIn("error:", err)
 979             self.failUnlessIn("nonexistent", err)
 980         d.addCallback(_check)
 981         return d
 982
 983
 984 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
 985     def test_mv_behavior(self):
 986         self.basedir = "cli/Mv/mv_behavior"
 987         self.set_up_grid()
 988         fn1 = os.path.join(self.basedir, "file1")
 989         DATA1 = "Nuclear launch codes"
 990         fileutil.write(fn1, DATA1)
 991         fn2 = os.path.join(self.basedir, "file2")
 992         DATA2 = "UML diagrams"
 993         fileutil.write(fn2, DATA2)
 994         # copy both files to the grid
 995         d = self.do_cli("create-alias", "tahoe")
 996         d.addCallback(lambda res:
 997             self.do_cli("cp", fn1, "tahoe:"))
 998         d.addCallback(lambda res:
 999             self.do_cli("cp", fn2, "tahoe:"))
1000
1001         # do mv file1 file3
1002         # (we should be able to rename files)
1003         d.addCallback(lambda res:
1004             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1005         d.addCallback(lambda (rc, out, err):
1006             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1007
1008         # do mv file3 file2
1009         # (This should succeed without issue)
1010         d.addCallback(lambda res:
1011             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1012         # Out should contain "OK" to show that the transfer worked.
1013         d.addCallback(lambda (rc,out,err):
1014             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1015
1016         # Next, make a remote directory.
1017         d.addCallback(lambda res:
1018             self.do_cli("mkdir", "tahoe:directory"))
1019
1020         # mv file2 directory
1021         # (should fail with a descriptive error message; the CLI mv
1022         #  client should support this)
1023         d.addCallback(lambda res:
1024             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1025         d.addCallback(lambda (rc, out, err):
1026             self.failUnlessIn(
1027                 "Error: You can't overwrite a directory with a file", err,
1028                 "mv shouldn't overwrite directories" ))
1029
1030         # mv file2 directory/
1031         # (should succeed by making file2 a child node of directory)
1032         d.addCallback(lambda res:
1033             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1034         # We should see an "OK"...
1035         d.addCallback(lambda (rc, out, err):
1036             self.failUnlessIn("OK", out,
1037                             "mv didn't mv a file into a directory"))
1038         # ... and be able to GET the file
1039         d.addCallback(lambda res:
1040             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1041         d.addCallback(lambda (rc, out, err):
1042             self.failUnless(os.path.exists(self.basedir + "new"),
1043                             "mv didn't write the destination file"))
1044         # ... and not find the file where it was before.
1045         d.addCallback(lambda res:
1046             self.do_cli("get", "tahoe:file2", "file2"))
1047         d.addCallback(lambda (rc, out, err):
1048             self.failUnlessIn("404", err,
1049                             "mv left the source file intact"))
1050
1051         # Let's build:
1052         # directory/directory2/some_file
1053         # directory3
1054         d.addCallback(lambda res:
1055             self.do_cli("mkdir", "tahoe:directory/directory2"))
1056         d.addCallback(lambda res:
1057             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1058         d.addCallback(lambda res:
1059             self.do_cli("mkdir", "tahoe:directory3"))
1060
1061         # Let's now try to mv directory/directory2/some_file to
1062         # directory3/some_file
1063         d.addCallback(lambda res:
1064             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1065                         "tahoe:directory3/"))
1066         # We should have just some_file in tahoe:directory3
1067         d.addCallback(lambda res:
1068             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1069         d.addCallback(lambda (rc, out, err):
1070             self.failUnless("404" not in err,
1071                               "mv didn't handle nested directories correctly"))
1072         d.addCallback(lambda res:
1073             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1074         d.addCallback(lambda (rc, out, err):
1075             self.failUnlessIn("404", err,
1076                               "mv moved the wrong thing"))
1077         return d
1078
1079     def test_mv_without_alias(self):
1080         # doing 'tahoe mv' without explicitly specifying an alias or
1081         # creating the default 'tahoe' alias should fail with a useful
1082         # error message.
1083         self.basedir = "cli/Mv/mv_without_alias"
1084         self.set_up_grid()
1085         d = self.do_cli("mv", "afile", "anotherfile")
1086         def _check((rc, out, err)):
1087             self.failUnlessEqual(rc, 1)
1088             self.failUnlessIn("error:", err)
1089         d.addCallback(_check)
1090         # check to see that the validation extends to the
1091         # target argument by making an alias that will work with the first
1092         # one.
1093         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1094         def _create_a_test_file(ign):
1095             self.test_file_path = os.path.join(self.basedir, "afile")
1096             f = open(self.test_file_path, "wb")
1097             f.write("puppies" * 100)
1098             f.close()
1099         d.addCallback(_create_a_test_file)
1100         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1101                                               "havasu:afile"))
1102         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1103                                               "anotherfile"))
1104         d.addCallback(_check)
1105         return d
1106
1107     def test_mv_with_nonexistent_alias(self):
1108         # doing 'tahoe mv' with an alias that doesn't exist should fail
1109         # with an informative error message.
1110         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1111         self.set_up_grid()
1112         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1113         def _check((rc, out, err)):
1114             self.failUnlessEqual(rc, 1)
1115             self.failUnlessIn("error:", err)
1116             self.failUnlessIn("fake", err)
1117         d.addCallback(_check)
1118         # check to see that the validation extends to the
1119         # target argument by making an alias that will work with the first
1120         # one.
1121         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1122         def _create_a_test_file(ign):
1123             self.test_file_path = os.path.join(self.basedir, "afile")
1124             f = open(self.test_file_path, "wb")
1125             f.write("puppies" * 100)
1126             f.close()
1127         d.addCallback(_create_a_test_file)
1128         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1129                                               "havasu:afile"))
1130         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1131                                               "fake:anotherfile"))
1132         d.addCallback(_check)
1133         return d
1134
1135
1136 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1137
1138     def test_not_enough_args(self):
1139         o = cli.CpOptions()
1140         self.failUnlessRaises(usage.UsageError,
1141                               o.parseOptions, ["onearg"])
1142
1143     def test_unicode_filename(self):
1144         self.basedir = "cli/Cp/unicode_filename"
1145         self.set_up_grid()
1146
1147         fn1 = os.path.join(self.basedir, "Ärtonwall")
1148         DATA1 = "unicode file content"
1149         fileutil.write(fn1, DATA1)
1150
1151         fn2 = os.path.join(self.basedir, "Metallica")
1152         DATA2 = "non-unicode file content"
1153         fileutil.write(fn2, DATA2)
1154
1155         # Bug #534
1156         # Assure that uploading a file whose name contains unicode character
1157         # doesn't prevent further uploads in the same directory
1158         d = self.do_cli("create-alias", "tahoe")
1159         d.addCallback(lambda res: self.do_cli("cp", fn1, "tahoe:"))
1160         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1161
1162         d.addCallback(lambda res: self.do_cli("get", "tahoe:Ärtonwall"))
1163         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA1))
1164
1165         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1166         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
1167
1168         return d
1169     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."
1170
1171     def test_dangling_symlink_vs_recursion(self):
1172         if not hasattr(os, 'symlink'):
1173             raise unittest.SkipTest("There is no symlink on this platform.")
1174         # cp -r on a directory containing a dangling symlink shouldn't assert
1175         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1176         self.set_up_grid()
1177         dn = os.path.join(self.basedir, "dir")
1178         os.mkdir(dn)
1179         fn = os.path.join(dn, "Fakebandica")
1180         ln = os.path.join(dn, "link")
1181         os.symlink(fn, ln)
1182
1183         d = self.do_cli("create-alias", "tahoe")
1184         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1185                                               dn, "tahoe:"))
1186         return d
1187
1188     def test_copy_using_filecap(self):
1189         self.basedir = "cli/Cp/test_copy_using_filecap"
1190         self.set_up_grid()
1191         outdir = os.path.join(self.basedir, "outdir")
1192         os.mkdir(outdir)
1193         fn1 = os.path.join(self.basedir, "Metallica")
1194         fn2 = os.path.join(outdir, "Not Metallica")
1195         fn3 = os.path.join(outdir, "test2")
1196         DATA1 = "puppies" * 10000
1197         fileutil.write(fn1, DATA1)
1198
1199         d = self.do_cli("create-alias", "tahoe")
1200         d.addCallback(lambda ign: self.do_cli("put", fn1))
1201         def _put_file((rc, out, err)):
1202             self.failUnlessEqual(rc, 0)
1203             # keep track of the filecap
1204             self.filecap = out.strip()
1205         d.addCallback(_put_file)
1206
1207         # Let's try copying this to the disk using the filecap
1208         #  cp FILECAP filename
1209         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1210         def _copy_file((rc, out, err)):
1211             self.failUnlessEqual(rc, 0)
1212             results = fileutil.read(fn2)
1213             self.failUnlessEqual(results, DATA1)
1214         d.addCallback(_copy_file)
1215
1216         # Test with ./ (see #761)
1217         #  cp FILECAP localdir
1218         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1219         def _resp((rc, out, err)):
1220             self.failUnlessEqual(rc, 1)
1221             self.failUnlessIn("error: you must specify a destination filename",
1222                               err)
1223         d.addCallback(_resp)
1224
1225         # Create a directory, linked at tahoe:test
1226         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1227         def _get_dir((rc, out, err)):
1228             self.failUnlessEqual(rc, 0)
1229             self.dircap = out.strip()
1230         d.addCallback(_get_dir)
1231
1232         # Upload a file to the directory
1233         d.addCallback(lambda ign:
1234                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1235         d.addCallback(lambda (rc, out, err): self.failUnlessEqual(rc, 0))
1236
1237         #  cp DIRCAP/filename localdir
1238         d.addCallback(lambda ign:
1239                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1240         def _get_resp((rc, out, err)):
1241             self.failUnlessEqual(rc, 0)
1242             results = fileutil.read(os.path.join(outdir, "test_file"))
1243             self.failUnlessEqual(results, DATA1)
1244         d.addCallback(_get_resp)
1245
1246         #  cp -r DIRCAP/filename filename2
1247         d.addCallback(lambda ign:
1248                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1249         def _get_resp2((rc, out, err)):
1250             self.failUnlessEqual(rc, 0)
1251             results = fileutil.read(fn3)
1252             self.failUnlessEqual(results, DATA1)
1253         d.addCallback(_get_resp2)
1254         return d
1255
1256     def test_cp_with_nonexistent_alias(self):
1257         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1258         # should output a sensible error message rather than a stack trace.
1259         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1260         self.set_up_grid()
1261         d = self.do_cli("cp", "fake:file1", "fake:file2")
1262         def _check((rc, out, err)):
1263             self.failUnlessEqual(rc, 1)
1264             self.failUnlessIn("error:", err)
1265         d.addCallback(_check)
1266         # 'tahoe cp' actually processes the target argument first, so we need
1267         # to check to make sure that validation extends to the source
1268         # argument.
1269         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1270         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1271                                               "tahoe:file2"))
1272         d.addCallback(_check)
1273         return d
1274
1275
1276 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
1277
1278     def writeto(self, path, data):
1279         full_path = os.path.join(self.basedir, "home", path)
1280         fileutil.make_dirs(os.path.dirname(full_path))
1281         fileutil.write(full_path, data)
1282
1283     def count_output(self, out):
1284         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
1285                         "(\d)+ files skipped, "
1286                         "(\d+) directories created \((\d+) reused\), "
1287                         "(\d+) directories skipped", out)
1288         return [int(s) for s in mo.groups()]
1289
1290     def count_output2(self, out):
1291         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
1292         return [int(s) for s in mo.groups()]
1293
1294     def test_backup(self):
1295         self.basedir = "cli/Backup/backup"
1296         self.set_up_grid()
1297
1298         # is the backupdb available? If so, we test that a second backup does
1299         # not create new directories.
1300         hush = StringIO()
1301         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
1302                                          hush)
1303
1304         # create a small local directory with a couple of files
1305         source = os.path.join(self.basedir, "home")
1306         fileutil.make_dirs(os.path.join(source, "empty"))
1307         self.writeto("parent/subdir/foo.txt", "foo")
1308         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
1309         self.writeto("parent/blah.txt", "blah")
1310
1311         def do_backup(verbose=False):
1312             cmd = ["backup"]
1313             if verbose:
1314                 cmd.append("--verbose")
1315             cmd.append(source)
1316             cmd.append("tahoe:backups")
1317             return self.do_cli(*cmd)
1318
1319         d = self.do_cli("create-alias", "tahoe")
1320
1321         if not have_bdb:
1322             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
1323             def _should_complain((rc, out, err)):
1324                 self.failUnless("I was unable to import a python sqlite library" in err, err)
1325             d.addCallback(_should_complain)
1326             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
1327
1328         d.addCallback(lambda res: do_backup())
1329         def _check0((rc, out, err)):
1330             self.failUnlessEqual(err, "")
1331             self.failUnlessEqual(rc, 0)
1332             fu, fr, fs, dc, dr, ds = self.count_output(out)
1333             # foo.txt, bar.txt, blah.txt
1334             self.failUnlessEqual(fu, 3)
1335             self.failUnlessEqual(fr, 0)
1336             self.failUnlessEqual(fs, 0)
1337             # empty, home, home/parent, home/parent/subdir
1338             self.failUnlessEqual(dc, 4)
1339             self.failUnlessEqual(dr, 0)
1340             self.failUnlessEqual(ds, 0)
1341         d.addCallback(_check0)
1342
1343         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
1344         def _check1((rc, out, err)):
1345             self.failUnlessEqual(err, "")
1346             self.failUnlessEqual(rc, 0)
1347             lines = out.split("\n")
1348             children = dict([line.split() for line in lines if line])
1349             latest_uri = children["Latest"]
1350             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
1351             childnames = children.keys()
1352             self.failUnlessEqual(sorted(childnames), ["Archives", "Latest"])
1353         d.addCallback(_check1)
1354         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
1355         def _check2((rc, out, err)):
1356             self.failUnlessEqual(err, "")
1357             self.failUnlessEqual(rc, 0)
1358             self.failUnlessEqual(sorted(out.split()), ["empty", "parent"])
1359         d.addCallback(_check2)
1360         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
1361         def _check2a((rc, out, err)):
1362             self.failUnlessEqual(err, "")
1363             self.failUnlessEqual(rc, 0)
1364             self.failUnlessEqual(out.strip(), "")
1365         d.addCallback(_check2a)
1366         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1367         def _check3((rc, out, err)):
1368             self.failUnlessEqual(err, "")
1369             self.failUnlessEqual(rc, 0)
1370             self.failUnlessEqual(out, "foo")
1371         d.addCallback(_check3)
1372         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1373         def _check4((rc, out, err)):
1374             self.failUnlessEqual(err, "")
1375             self.failUnlessEqual(rc, 0)
1376             self.old_archives = out.split()
1377             self.failUnlessEqual(len(self.old_archives), 1)
1378         d.addCallback(_check4)
1379
1380
1381         d.addCallback(self.stall, 1.1)
1382         d.addCallback(lambda res: do_backup())
1383         def _check4a((rc, out, err)):
1384             # second backup should reuse everything, if the backupdb is
1385             # available
1386             self.failUnlessEqual(err, "")
1387             self.failUnlessEqual(rc, 0)
1388             if have_bdb:
1389                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1390                 # foo.txt, bar.txt, blah.txt
1391                 self.failUnlessEqual(fu, 0)
1392                 self.failUnlessEqual(fr, 3)
1393                 self.failUnlessEqual(fs, 0)
1394                 # empty, home, home/parent, home/parent/subdir
1395                 self.failUnlessEqual(dc, 0)
1396                 self.failUnlessEqual(dr, 4)
1397                 self.failUnlessEqual(ds, 0)
1398         d.addCallback(_check4a)
1399
1400         if have_bdb:
1401             # sneak into the backupdb, crank back the "last checked"
1402             # timestamp to force a check on all files
1403             def _reset_last_checked(res):
1404                 dbfile = os.path.join(self.get_clientdir(),
1405                                       "private", "backupdb.sqlite")
1406                 self.failUnless(os.path.exists(dbfile), dbfile)
1407                 bdb = backupdb.get_backupdb(dbfile)
1408                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
1409                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
1410                 bdb.connection.commit()
1411
1412             d.addCallback(_reset_last_checked)
1413
1414             d.addCallback(self.stall, 1.1)
1415             d.addCallback(lambda res: do_backup(verbose=True))
1416             def _check4b((rc, out, err)):
1417                 # we should check all files, and re-use all of them. None of
1418                 # the directories should have been changed, so we should
1419                 # re-use all of them too.
1420                 self.failUnlessEqual(err, "")
1421                 self.failUnlessEqual(rc, 0)
1422                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1423                 fchecked, dchecked = self.count_output2(out)
1424                 self.failUnlessEqual(fchecked, 3)
1425                 self.failUnlessEqual(fu, 0)
1426                 self.failUnlessEqual(fr, 3)
1427                 self.failUnlessEqual(fs, 0)
1428                 self.failUnlessEqual(dchecked, 4)
1429                 self.failUnlessEqual(dc, 0)
1430                 self.failUnlessEqual(dr, 4)
1431                 self.failUnlessEqual(ds, 0)
1432             d.addCallback(_check4b)
1433
1434         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1435         def _check5((rc, out, err)):
1436             self.failUnlessEqual(err, "")
1437             self.failUnlessEqual(rc, 0)
1438             self.new_archives = out.split()
1439             expected_new = 2
1440             if have_bdb:
1441                 expected_new += 1
1442             self.failUnlessEqual(len(self.new_archives), expected_new, out)
1443             # the original backup should still be the oldest (i.e. sorts
1444             # alphabetically towards the beginning)
1445             self.failUnlessEqual(sorted(self.new_archives)[0],
1446                                  self.old_archives[0])
1447         d.addCallback(_check5)
1448
1449         d.addCallback(self.stall, 1.1)
1450         def _modify(res):
1451             self.writeto("parent/subdir/foo.txt", "FOOF!")
1452             # and turn a file into a directory
1453             os.unlink(os.path.join(source, "parent/blah.txt"))
1454             os.mkdir(os.path.join(source, "parent/blah.txt"))
1455             self.writeto("parent/blah.txt/surprise file", "surprise")
1456             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
1457             # turn a directory into a file
1458             os.rmdir(os.path.join(source, "empty"))
1459             self.writeto("empty", "imagine nothing being here")
1460             return do_backup()
1461         d.addCallback(_modify)
1462         def _check5a((rc, out, err)):
1463             # second backup should reuse bar.txt (if backupdb is available),
1464             # and upload the rest. None of the directories can be reused.
1465             self.failUnlessEqual(err, "")
1466             self.failUnlessEqual(rc, 0)
1467             if have_bdb:
1468                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1469                 # new foo.txt, surprise file, subfile, empty
1470                 self.failUnlessEqual(fu, 4)
1471                 # old bar.txt
1472                 self.failUnlessEqual(fr, 1)
1473                 self.failUnlessEqual(fs, 0)
1474                 # home, parent, subdir, blah.txt, surprisedir
1475                 self.failUnlessEqual(dc, 5)
1476                 self.failUnlessEqual(dr, 0)
1477                 self.failUnlessEqual(ds, 0)
1478         d.addCallback(_check5a)
1479         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1480         def _check6((rc, out, err)):
1481             self.failUnlessEqual(err, "")
1482             self.failUnlessEqual(rc, 0)
1483             self.new_archives = out.split()
1484             expected_new = 3
1485             if have_bdb:
1486                 expected_new += 1
1487             self.failUnlessEqual(len(self.new_archives), expected_new)
1488             self.failUnlessEqual(sorted(self.new_archives)[0],
1489                                  self.old_archives[0])
1490         d.addCallback(_check6)
1491         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1492         def _check7((rc, out, err)):
1493             self.failUnlessEqual(err, "")
1494             self.failUnlessEqual(rc, 0)
1495             self.failUnlessEqual(out, "FOOF!")
1496             # the old snapshot should not be modified
1497             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
1498         d.addCallback(_check7)
1499         def _check8((rc, out, err)):
1500             self.failUnlessEqual(err, "")
1501             self.failUnlessEqual(rc, 0)
1502             self.failUnlessEqual(out, "foo")
1503         d.addCallback(_check8)
1504
1505         return d
1506
1507     # on our old dapper buildslave, this test takes a long time (usually
1508     # 130s), so we have to bump up the default 120s timeout. The create-alias
1509     # and initial backup alone take 60s, probably because of the handful of
1510     # dirnodes being created (RSA key generation). The backup between check4
1511     # and check4a takes 6s, as does the backup before check4b.
1512     test_backup.timeout = 3000
1513
1514     def test_exclude_options(self):
1515         root_listdir = ('lib.a', '_darcs', 'subdir', 'nice_doc.lyx')
1516         subdir_listdir = ('another_doc.lyx', 'run_snake_run.py', 'CVS', '.svn', '_darcs')
1517         basedir = "cli/Backup/exclude_options"
1518         fileutil.make_dirs(basedir)
1519         nodeurl_path = os.path.join(basedir, 'node.url')
1520         fileutil.write(nodeurl_path, 'http://example.net:2357/')
1521
1522         def _check_filtering(filtered, all, included, excluded):
1523             filtered = set(filtered)
1524             all = set(all)
1525             included = set(included)
1526             excluded = set(excluded)
1527             self.failUnlessEqual(filtered, included)
1528             self.failUnlessEqual(all.difference(filtered), excluded)
1529
1530         # test simple exclude
1531         backup_options = cli.BackupOptions()
1532         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1533                                      basedir, 'from', 'to'])
1534         filtered = list(backup_options.filter_listdir(root_listdir))
1535         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1536                          ('nice_doc.lyx',))
1537         # multiple exclude
1538         backup_options = cli.BackupOptions()
1539         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
1540                                      basedir, 'from', 'to'])
1541         filtered = list(backup_options.filter_listdir(root_listdir))
1542         _check_filtering(filtered, root_listdir, ('_darcs', 'subdir'),
1543                          ('nice_doc.lyx', 'lib.a'))
1544         # vcs metadata exclusion
1545         backup_options = cli.BackupOptions()
1546         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
1547                                      basedir, 'from', 'to'])
1548         filtered = list(backup_options.filter_listdir(subdir_listdir))
1549         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'run_snake_run.py',),
1550                          ('CVS', '.svn', '_darcs'))
1551         # read exclude patterns from file
1552         exclusion_string = "_darcs\n*py\n.svn"
1553         excl_filepath = os.path.join(basedir, 'exclusion')
1554         fileutil.write(excl_filepath, exclusion_string)
1555         backup_options = cli.BackupOptions()
1556         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1557                                      basedir, 'from', 'to'])
1558         filtered = list(backup_options.filter_listdir(subdir_listdir))
1559         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'CVS'),
1560                          ('.svn', '_darcs', 'run_snake_run.py'))
1561         # text BackupConfigurationError
1562         self.failUnlessRaises(cli.BackupConfigurationError,
1563                               backup_options.parseOptions,
1564                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
1565                                basedir, 'from', 'to'])
1566
1567         # test that an iterator works too
1568         backup_options = cli.BackupOptions()
1569         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1570                                      basedir, 'from', 'to'])
1571         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1572         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1573                          ('nice_doc.lyx',))
1574
1575     def test_ignore_symlinks(self):
1576         if not hasattr(os, 'symlink'):
1577             raise unittest.SkipTest("There is no symlink on this platform.")
1578
1579         self.basedir = os.path.dirname(self.mktemp())
1580         self.set_up_grid()
1581
1582         source = os.path.join(self.basedir, "home")
1583         self.writeto("foo.txt", "foo")
1584         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
1585
1586         d = self.do_cli("create-alias", "tahoe")
1587         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
1588
1589         def _check((rc, out, err)):
1590             self.failUnlessEqual(rc, 2)
1591             foo2 = os.path.join(source, "foo2.txt")
1592             self.failUnlessEqual(err, "WARNING: cannot backup symlink %s\n" % foo2)
1593
1594             fu, fr, fs, dc, dr, ds = self.count_output(out)
1595             # foo.txt
1596             self.failUnlessEqual(fu, 1)
1597             self.failUnlessEqual(fr, 0)
1598             # foo2.txt
1599             self.failUnlessEqual(fs, 1)
1600             # home
1601             self.failUnlessEqual(dc, 1)
1602             self.failUnlessEqual(dr, 0)
1603             self.failUnlessEqual(ds, 0)
1604
1605         d.addCallback(_check)
1606         return d
1607
1608     def test_ignore_unreadable_file(self):
1609         self.basedir = os.path.dirname(self.mktemp())
1610         self.set_up_grid()
1611
1612         source = os.path.join(self.basedir, "home")
1613         self.writeto("foo.txt", "foo")
1614         os.chmod(os.path.join(source, "foo.txt"), 0000)
1615
1616         d = self.do_cli("create-alias", "tahoe")
1617         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1618
1619         def _check((rc, out, err)):
1620             self.failUnlessEqual(rc, 2)
1621             self.failUnlessEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
1622
1623             fu, fr, fs, dc, dr, ds = self.count_output(out)
1624             self.failUnlessEqual(fu, 0)
1625             self.failUnlessEqual(fr, 0)
1626             # foo.txt
1627             self.failUnlessEqual(fs, 1)
1628             # home
1629             self.failUnlessEqual(dc, 1)
1630             self.failUnlessEqual(dr, 0)
1631             self.failUnlessEqual(ds, 0)
1632         d.addCallback(_check)
1633
1634         # This is necessary for the temp files to be correctly removed
1635         def _cleanup(self):
1636             os.chmod(os.path.join(source, "foo.txt"), 0644)
1637         d.addCallback(_cleanup)
1638         d.addErrback(_cleanup)
1639
1640         return d
1641
1642     def test_ignore_unreadable_directory(self):
1643         self.basedir = os.path.dirname(self.mktemp())
1644         self.set_up_grid()
1645
1646         source = os.path.join(self.basedir, "home")
1647         os.mkdir(source)
1648         os.mkdir(os.path.join(source, "test"))
1649         os.chmod(os.path.join(source, "test"), 0000)
1650
1651         d = self.do_cli("create-alias", "tahoe")
1652         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1653
1654         def _check((rc, out, err)):
1655             self.failUnlessEqual(rc, 2)
1656             self.failUnlessEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
1657
1658             fu, fr, fs, dc, dr, ds = self.count_output(out)
1659             self.failUnlessEqual(fu, 0)
1660             self.failUnlessEqual(fr, 0)
1661             self.failUnlessEqual(fs, 0)
1662             # home, test
1663             self.failUnlessEqual(dc, 2)
1664             self.failUnlessEqual(dr, 0)
1665             # test
1666             self.failUnlessEqual(ds, 1)
1667         d.addCallback(_check)
1668
1669         # This is necessary for the temp files to be correctly removed
1670         def _cleanup(self):
1671             os.chmod(os.path.join(source, "test"), 0655)
1672         d.addCallback(_cleanup)
1673         d.addErrback(_cleanup)
1674         return d
1675
1676     def test_backup_without_alias(self):
1677         # 'tahoe backup' should output a sensible error message when invoked
1678         # without an alias instead of a stack trace.
1679         self.basedir = os.path.dirname(self.mktemp())
1680         self.set_up_grid()
1681         source = os.path.join(self.basedir, "file1")
1682         d = self.do_cli('backup', source, source)
1683         def _check((rc, out, err)):
1684             self.failUnlessEqual(rc, 1)
1685             self.failUnlessIn("error:", err)
1686         d.addCallback(_check)
1687         return d
1688
1689     def test_backup_with_nonexistent_alias(self):
1690         # 'tahoe backup' should output a sensible error message when invoked
1691         # with a nonexistent alias.
1692         self.basedir = os.path.dirname(self.mktemp())
1693         self.set_up_grid()
1694         source = os.path.join(self.basedir, "file1")
1695         d = self.do_cli("backup", source, "nonexistent:" + source)
1696         def _check((rc, out, err)):
1697             self.failUnlessEqual(rc, 1)
1698             self.failUnlessIn("error:", err)
1699             self.failUnlessIn("nonexistent", err)
1700         d.addCallback(_check)
1701         return d
1702
1703
1704 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
1705
1706     def test_check(self):
1707         self.basedir = "cli/Check/check"
1708         self.set_up_grid()
1709         c0 = self.g.clients[0]
1710         DATA = "data" * 100
1711         d = c0.create_mutable_file(DATA)
1712         def _stash_uri(n):
1713             self.uri = n.get_uri()
1714         d.addCallback(_stash_uri)
1715
1716         d.addCallback(lambda ign: self.do_cli("check", self.uri))
1717         def _check1((rc, out, err)):
1718             self.failUnlessEqual(err, "")
1719             self.failUnlessEqual(rc, 0)
1720             lines = out.splitlines()
1721             self.failUnless("Summary: Healthy" in lines, out)
1722             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1723         d.addCallback(_check1)
1724
1725         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
1726         def _check2((rc, out, err)):
1727             self.failUnlessEqual(err, "")
1728             self.failUnlessEqual(rc, 0)
1729             data = simplejson.loads(out)
1730             self.failUnlessEqual(data["summary"], "Healthy")
1731         d.addCallback(_check2)
1732
1733         def _clobber_shares(ignored):
1734             # delete one, corrupt a second
1735             shares = self.find_shares(self.uri)
1736             self.failUnlessEqual(len(shares), 10)
1737             os.unlink(shares[0][2])
1738             cso = debug.CorruptShareOptions()
1739             cso.stdout = StringIO()
1740             cso.parseOptions([shares[1][2]])
1741             storage_index = uri.from_string(self.uri).get_storage_index()
1742             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
1743                                        (base32.b2a(shares[1][1]),
1744                                         base32.b2a(storage_index),
1745                                         shares[1][0])
1746             debug.corrupt_share(cso)
1747         d.addCallback(_clobber_shares)
1748
1749         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
1750         def _check3((rc, out, err)):
1751             self.failUnlessEqual(err, "")
1752             self.failUnlessEqual(rc, 0)
1753             lines = out.splitlines()
1754             summary = [l for l in lines if l.startswith("Summary")][0]
1755             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
1756                             in summary, summary)
1757             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1758             self.failUnless(" corrupt shares:" in lines, out)
1759             self.failUnless(self._corrupt_share_line in lines, out)
1760         d.addCallback(_check3)
1761
1762         d.addCallback(lambda ign:
1763                       self.do_cli("check", "--verify", "--repair", self.uri))
1764         def _check4((rc, out, err)):
1765             self.failUnlessEqual(err, "")
1766             self.failUnlessEqual(rc, 0)
1767             lines = out.splitlines()
1768             self.failUnless("Summary: not healthy" in lines, out)
1769             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1770             self.failUnless(" corrupt shares:" in lines, out)
1771             self.failUnless(self._corrupt_share_line in lines, out)
1772             self.failUnless(" repair successful" in lines, out)
1773         d.addCallback(_check4)
1774
1775         d.addCallback(lambda ign:
1776                       self.do_cli("check", "--verify", "--repair", self.uri))
1777         def _check5((rc, out, err)):
1778             self.failUnlessEqual(err, "")
1779             self.failUnlessEqual(rc, 0)
1780             lines = out.splitlines()
1781             self.failUnless("Summary: healthy" in lines, out)
1782             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1783             self.failIf(" corrupt shares:" in lines, out)
1784         d.addCallback(_check5)
1785
1786         return d
1787
1788     def test_deep_check(self):
1789         self.basedir = "cli/Check/deep_check"
1790         self.set_up_grid()
1791         c0 = self.g.clients[0]
1792         self.uris = {}
1793         self.fileurls = {}
1794         DATA = "data" * 100
1795         d = c0.create_dirnode()
1796         def _stash_root_and_create_file(n):
1797             self.rootnode = n
1798             self.rooturi = n.get_uri()
1799             return n.add_file(u"good", upload.Data(DATA, convergence=""))
1800         d.addCallback(_stash_root_and_create_file)
1801         def _stash_uri(fn, which):
1802             self.uris[which] = fn.get_uri()
1803             return fn
1804         d.addCallback(_stash_uri, "good")
1805         d.addCallback(lambda ign:
1806                       self.rootnode.add_file(u"small",
1807                                              upload.Data("literal",
1808                                                         convergence="")))
1809         d.addCallback(_stash_uri, "small")
1810         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
1811         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
1812         d.addCallback(_stash_uri, "mutable")
1813
1814         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1815         def _check1((rc, out, err)):
1816             self.failUnlessEqual(err, "")
1817             self.failUnlessEqual(rc, 0)
1818             lines = out.splitlines()
1819             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1820                             in lines, out)
1821         d.addCallback(_check1)
1822
1823         # root
1824         # root/good
1825         # root/small
1826         # root/mutable
1827
1828         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
1829                                               self.rooturi))
1830         def _check2((rc, out, err)):
1831             self.failUnlessEqual(err, "")
1832             self.failUnlessEqual(rc, 0)
1833             lines = out.splitlines()
1834             self.failUnless("<root>: Healthy" in lines, out)
1835             self.failUnless("small: Healthy (LIT)" in lines, out)
1836             self.failUnless("good: Healthy" in lines, out)
1837             self.failUnless("mutable: Healthy" in lines, out)
1838             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1839                             in lines, out)
1840         d.addCallback(_check2)
1841
1842         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1843         def _check_stats((rc, out, err)):
1844             self.failUnlessEqual(err, "")
1845             self.failUnlessEqual(rc, 0)
1846             lines = out.splitlines()
1847             self.failUnlessIn(" count-immutable-files: 1", lines)
1848             self.failUnlessIn("   count-mutable-files: 1", lines)
1849             self.failUnlessIn("   count-literal-files: 1", lines)
1850             self.failUnlessIn("     count-directories: 1", lines)
1851             self.failUnlessIn("  size-immutable-files: 400", lines)
1852             self.failUnlessIn("Size Histogram:", lines)
1853             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
1854             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
1855         d.addCallback(_check_stats)
1856
1857         def _clobber_shares(ignored):
1858             shares = self.find_shares(self.uris["good"])
1859             self.failUnlessEqual(len(shares), 10)
1860             os.unlink(shares[0][2])
1861
1862             shares = self.find_shares(self.uris["mutable"])
1863             cso = debug.CorruptShareOptions()
1864             cso.stdout = StringIO()
1865             cso.parseOptions([shares[1][2]])
1866             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
1867             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
1868                                        (base32.b2a(shares[1][1]),
1869                                         base32.b2a(storage_index),
1870                                         shares[1][0])
1871             debug.corrupt_share(cso)
1872         d.addCallback(_clobber_shares)
1873
1874         # root
1875         # root/good  [9 shares]
1876         # root/small
1877         # root/mutable [1 corrupt share]
1878
1879         d.addCallback(lambda ign:
1880                       self.do_cli("deep-check", "--verbose", self.rooturi))
1881         def _check3((rc, out, err)):
1882             self.failUnlessEqual(err, "")
1883             self.failUnlessEqual(rc, 0)
1884             lines = out.splitlines()
1885             self.failUnless("<root>: Healthy" in lines, out)
1886             self.failUnless("small: Healthy (LIT)" in lines, out)
1887             self.failUnless("mutable: Healthy" in lines, out) # needs verifier
1888             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1889                             in lines, out)
1890             self.failIf(self._corrupt_share_line in lines, out)
1891             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
1892                             in lines, out)
1893         d.addCallback(_check3)
1894
1895         d.addCallback(lambda ign:
1896                       self.do_cli("deep-check", "--verbose", "--verify",
1897                                   self.rooturi))
1898         def _check4((rc, out, err)):
1899             self.failUnlessEqual(err, "")
1900             self.failUnlessEqual(rc, 0)
1901             lines = out.splitlines()
1902             self.failUnless("<root>: Healthy" in lines, out)
1903             self.failUnless("small: Healthy (LIT)" in lines, out)
1904             mutable = [l for l in lines if l.startswith("mutable")][0]
1905             self.failUnless(mutable.startswith("mutable: Unhealthy: 9 shares (enc 3-of-10)"),
1906                             mutable)
1907             self.failUnless(self._corrupt_share_line in lines, out)
1908             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1909                             in lines, out)
1910             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
1911                             in lines, out)
1912         d.addCallback(_check4)
1913
1914         d.addCallback(lambda ign:
1915                       self.do_cli("deep-check", "--raw",
1916                                   self.rooturi))
1917         def _check5((rc, out, err)):
1918             self.failUnlessEqual(err, "")
1919             self.failUnlessEqual(rc, 0)
1920             lines = out.splitlines()
1921             units = [simplejson.loads(line) for line in lines]
1922             # root, small, good, mutable,  stats
1923             self.failUnlessEqual(len(units), 4+1)
1924         d.addCallback(_check5)
1925
1926         d.addCallback(lambda ign:
1927                       self.do_cli("deep-check",
1928                                   "--verbose", "--verify", "--repair",
1929                                   self.rooturi))
1930         def _check6((rc, out, err)):
1931             self.failUnlessEqual(err, "")
1932             self.failUnlessEqual(rc, 0)
1933             lines = out.splitlines()
1934             self.failUnless("<root>: healthy" in lines, out)
1935             self.failUnless("small: healthy" in lines, out)
1936             self.failUnless("mutable: not healthy" in lines, out)
1937             self.failUnless(self._corrupt_share_line in lines, out)
1938             self.failUnless("good: not healthy" in lines, out)
1939             self.failUnless("done: 4 objects checked" in lines, out)
1940             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
1941             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
1942                             in lines, out)
1943             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
1944         d.addCallback(_check6)
1945
1946         # now add a subdir, and a file below that, then make the subdir
1947         # unrecoverable
1948
1949         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
1950         d.addCallback(_stash_uri, "subdir")
1951         d.addCallback(lambda fn:
1952                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
1953         d.addCallback(lambda ign:
1954                       self.delete_shares_numbered(self.uris["subdir"],
1955                                                   range(10)))
1956
1957         # root
1958         # root/good
1959         # root/small
1960         # root/mutable
1961         # root/subdir [unrecoverable: 0 shares]
1962         # root/subfile
1963
1964         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
1965         def _manifest_failed((rc, out, err)):
1966             self.failIfEqual(rc, 0)
1967             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1968             # the fatal directory should still show up, as the last line
1969             self.failUnlessIn(" subdir\n", out)
1970         d.addCallback(_manifest_failed)
1971
1972         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1973         def _deep_check_failed((rc, out, err)):
1974             self.failIfEqual(rc, 0)
1975             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1976             # we want to make sure that the error indication is the last
1977             # thing that gets emitted
1978             self.failIf("done:" in out, out)
1979         d.addCallback(_deep_check_failed)
1980
1981         # this test is disabled until the deep-repair response to an
1982         # unrepairable directory is fixed. The failure-to-repair should not
1983         # throw an exception, but the failure-to-traverse that follows
1984         # should throw UnrecoverableFileError.
1985
1986         #d.addCallback(lambda ign:
1987         #              self.do_cli("deep-check", "--repair", self.rooturi))
1988         #def _deep_check_repair_failed((rc, out, err)):
1989         #    self.failIfEqual(rc, 0)
1990         #    print err
1991         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1992         #    self.failIf("done:" in out, out)
1993         #d.addCallback(_deep_check_repair_failed)
1994
1995         return d
1996
1997     def test_check_without_alias(self):
1998         # 'tahoe check' should output a sensible error message if it needs to
1999         # find the default alias and can't
2000         self.basedir = "cli/Check/check_without_alias"
2001         self.set_up_grid()
2002         d = self.do_cli("check")
2003         def _check((rc, out, err)):
2004             self.failUnlessEqual(rc, 1)
2005             self.failUnlessIn("error:", err)
2006         d.addCallback(_check)
2007         d.addCallback(lambda ign: self.do_cli("deep-check"))
2008         d.addCallback(_check)
2009         return d
2010
2011     def test_check_with_nonexistent_alias(self):
2012         # 'tahoe check' should output a sensible error message if it needs to
2013         # find an alias and can't.
2014         self.basedir = "cli/Check/check_with_nonexistent_alias"
2015         self.set_up_grid()
2016         d = self.do_cli("check", "nonexistent:")
2017         def _check((rc, out, err)):
2018             self.failUnlessEqual(rc, 1)
2019             self.failUnlessIn("error:", err)
2020             self.failUnlessIn("nonexistent", err)
2021         d.addCallback(_check)
2022         return d
2023
2024
2025 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
2026     def test_get(self):
2027         self.basedir = "cli/Errors/get"
2028         self.set_up_grid()
2029         c0 = self.g.clients[0]
2030         self.fileurls = {}
2031         DATA = "data" * 100
2032         d = c0.upload(upload.Data(DATA, convergence=""))
2033         def _stash_bad(ur):
2034             self.uri_1share = ur.uri
2035             self.delete_shares_numbered(ur.uri, range(1,10))
2036         d.addCallback(_stash_bad)
2037
2038         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
2039         def _check1((rc, out, err)):
2040             self.failIfEqual(rc, 0)
2041             self.failUnless("410 Gone" in err, err)
2042             self.failUnlessIn("NotEnoughSharesError: ", err)
2043             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
2044         d.addCallback(_check1)
2045
2046         targetf = os.path.join(self.basedir, "output")
2047         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
2048         def _check2((rc, out, err)):
2049             self.failIfEqual(rc, 0)
2050             self.failUnless("410 Gone" in err, err)
2051             self.failUnlessIn("NotEnoughSharesError: ", err)
2052             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
2053             self.failIf(os.path.exists(targetf))
2054         d.addCallback(_check2)
2055
2056         return d
2057
2058
2059 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
2060     def test_get_without_alias(self):
2061         # 'tahoe get' should output a useful error message when invoked
2062         # without an explicit alias and when the default 'tahoe' alias
2063         # hasn't been created yet.
2064         self.basedir = "cli/Get/get_without_alias"
2065         self.set_up_grid()
2066         d = self.do_cli('get', 'file')
2067         def _check((rc, out, err)):
2068             self.failUnlessEqual(rc, 1)
2069             self.failUnlessIn("error:", err)
2070         d.addCallback(_check)
2071         return d
2072
2073     def test_get_with_nonexistent_alias(self):
2074         # 'tahoe get' should output a useful error message when invoked with
2075         # an explicit alias that doesn't exist.
2076         self.basedir = "cli/Get/get_with_nonexistent_alias"
2077         self.set_up_grid()
2078         d = self.do_cli("get", "nonexistent:file")
2079         def _check((rc, out, err)):
2080             self.failUnlessEqual(rc, 1)
2081             self.failUnlessIn("error:", err)
2082             self.failUnlessIn("nonexistent", err)
2083         d.addCallback(_check)
2084         return d
2085
2086
2087 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
2088     def test_manifest_without_alias(self):
2089         # 'tahoe manifest' should output a useful error message when invoked
2090         # without an explicit alias when the default 'tahoe' alias is
2091         # missing.
2092         self.basedir = "cli/Manifest/manifest_without_alias"
2093         self.set_up_grid()
2094         d = self.do_cli("manifest")
2095         def _check((rc, out, err)):
2096             self.failUnlessEqual(rc, 1)
2097             self.failUnlessIn("error:", err)
2098         d.addCallback(_check)
2099         return d
2100
2101     def test_manifest_with_nonexistent_alias(self):
2102         # 'tahoe manifest' should output a useful error message when invoked
2103         # with an explicit alias that doesn't exist.
2104         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
2105         self.set_up_grid()
2106         d = self.do_cli("manifest", "nonexistent:")
2107         def _check((rc, out, err)):
2108             self.failUnlessEqual(rc, 1)
2109             self.failUnlessIn("error:", err)
2110             self.failUnlessIn("nonexistent", err)
2111         d.addCallback(_check)
2112         return d
2113
2114
2115 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
2116     def test_mkdir_with_nonexistent_alias(self):
2117         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
2118         # output a sensible error message rather than a stack trace.
2119         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
2120         self.set_up_grid()
2121         d = self.do_cli("mkdir", "havasu:")
2122         def _check((rc, out, err)):
2123             self.failUnlessEqual(rc, 1)
2124             self.failUnlessIn("error:", err)
2125         d.addCallback(_check)
2126         return d
2127
2128
2129 class Rm(GridTestMixin, CLITestMixin, unittest.TestCase):
2130     def test_rm_without_alias(self):
2131         # 'tahoe rm' should behave sensibly when invoked without an explicit
2132         # alias before the default 'tahoe' alias has been created.
2133         self.basedir = "cli/Rm/rm_without_alias"
2134         self.set_up_grid()
2135         d = self.do_cli("rm", "afile")
2136         def _check((rc, out, err)):
2137             self.failUnlessIn("error:", err)
2138             self.failUnlessEqual(rc, 1)
2139         d.addCallback(_check)
2140         return d
2141
2142     def test_rm_with_nonexistent_alias(self):
2143         # 'tahoe rm' should behave sensibly when invoked with an explicit
2144         # alias that doesn't exist.
2145         self.basedir = "cli/Rm/rm_with_nonexistent_alias"
2146         self.set_up_grid()
2147         d = self.do_cli("rm", "nonexistent:afile")
2148         def _check((rc, out, err)):
2149             self.failUnlessEqual(rc, 1)
2150             self.failUnlessIn("error:", err)
2151             self.failUnlessIn("nonexistent", err)
2152         d.addCallback(_check)
2153         return d
2154
2155
2156 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
2157     def test_empty_directory(self):
2158         self.basedir = "cli/Stats/empty_directory"
2159         self.set_up_grid()
2160         c0 = self.g.clients[0]
2161         self.fileurls = {}
2162         d = c0.create_dirnode()
2163         def _stash_root(n):
2164             self.rootnode = n
2165             self.rooturi = n.get_uri()
2166         d.addCallback(_stash_root)
2167
2168         # make sure we can get stats on an empty directory too
2169         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2170         def _check_stats((rc, out, err)):
2171             self.failUnlessEqual(err, "")
2172             self.failUnlessEqual(rc, 0)
2173             lines = out.splitlines()
2174             self.failUnlessIn(" count-immutable-files: 0", lines)
2175             self.failUnlessIn("   count-mutable-files: 0", lines)
2176             self.failUnlessIn("   count-literal-files: 0", lines)
2177             self.failUnlessIn("     count-directories: 1", lines)
2178             self.failUnlessIn("  size-immutable-files: 0", lines)
2179             self.failIfIn("Size Histogram:", lines)
2180         d.addCallback(_check_stats)
2181
2182         return d
2183
2184     def test_stats_without_alias(self):
2185         # when invoked with no explicit alias and before the default 'tahoe'
2186         # alias is created, 'tahoe stats' should output an informative error
2187         # message, not a stack trace.
2188         self.basedir = "cli/Stats/stats_without_alias"
2189         self.set_up_grid()
2190         d = self.do_cli("stats")
2191         def _check((rc, out, err)):
2192             self.failUnlessEqual(rc, 1)
2193             self.failUnlessIn("error:", err)
2194         d.addCallback(_check)
2195         return d
2196
2197     def test_stats_with_nonexistent_alias(self):
2198         # when invoked with an explicit alias that doesn't exist,
2199         # 'tahoe stats' should output a useful error message.
2200         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
2201         self.set_up_grid()
2202         d = self.do_cli("stats", "havasu:")
2203         def _check((rc, out, err)):
2204             self.failUnlessEqual(rc, 1)
2205             self.failUnlessIn("error:", err)
2206         d.addCallback(_check)
2207         return d
2208
2209
2210 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
2211     def test_webopen_with_nonexistent_alias(self):
2212         # when invoked with an alias that doesn't exist, 'tahoe webopen'
2213         # should output an informative error message instead of a stack
2214         # trace.
2215         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
2216         self.set_up_grid()
2217         d = self.do_cli("webopen", "fake:")
2218         def _check((rc, out, err)):
2219             self.failUnlessEqual(rc, 1)
2220             self.failUnlessIn("error:", err)
2221         d.addCallback(_check)
2222         return d