src/allmydata/test/test_cli.py

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