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