src/allmydata/test/test_cli.py

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