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