src/allmydata/test/test_cli.py

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