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.interfaces import MDMF_VERSION, SDMF_VERSION
  14 from allmydata.mutable.publish import MutableData
  15 from allmydata.dirnode import normalize
  16
  17 # Test that the scripts can be imported.
  18 from allmydata.scripts import create_node, debug, keygen, startstop_node, \
  19     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls, \
  20     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_unlink, tahoe_webopen
  21 _hush_pyflakes = [create_node, debug, keygen, startstop_node,
  22     tahoe_add_alias, tahoe_backup, tahoe_check, tahoe_cp, tahoe_get, tahoe_ls,
  23     tahoe_manifest, tahoe_mkdir, tahoe_mv, tahoe_put, tahoe_unlink, tahoe_webopen]
  24
  25 from allmydata.scripts import common
  26 from allmydata.scripts.common import DEFAULT_ALIAS, get_aliases, get_alias, \
  27      DefaultAliasMarker
  28
  29 from allmydata.scripts import cli, debug, runner, backupdb
  30 from allmydata.test.common_util import StallMixin, ReallyEqualMixin
  31 from allmydata.test.no_network import GridTestMixin
  32 from twisted.internet import threads # CLI tests use deferToThread
  33 from twisted.internet import defer # List uses a DeferredList in one place.
  34 from twisted.python import usage
  35
  36 from allmydata.util.assertutil import precondition
  37 from allmydata.util.encodingutil import listdir_unicode, unicode_platform, \
  38     quote_output, get_io_encoding, get_filesystem_encoding, \
  39     unicode_to_output, unicode_to_argv, to_str
  40 from allmydata.util.fileutil import abspath_expanduser_unicode
  41
  42 timeout = 480 # deep_check takes 360s on Zandr's linksys box, others take > 240s
  43
  44
  45 class CLITestMixin(ReallyEqualMixin):
  46     def do_cli(self, verb, *args, **kwargs):
  47         nodeargs = [
  48             "--node-directory", self.get_clientdir(),
  49             ]
  50         argv = [verb] + nodeargs + list(args)
  51         stdin = kwargs.get("stdin", "")
  52         stdout, stderr = StringIO(), StringIO()
  53         d = threads.deferToThread(runner.runner, argv, run_by_human=False,
  54                                   stdin=StringIO(stdin),
  55                                   stdout=stdout, stderr=stderr)
  56         def _done(rc):
  57             return rc, stdout.getvalue(), stderr.getvalue()
  58         d.addCallback(_done)
  59         return d
  60
  61     def skip_if_cannot_represent_filename(self, u):
  62         precondition(isinstance(u, unicode))
  63
  64         enc = get_filesystem_encoding()
  65         if not unicode_platform():
  66             try:
  67                 u.encode(enc)
  68             except UnicodeEncodeError:
  69                 raise unittest.SkipTest("A non-ASCII filename could not be encoded on this platform.")
  70
  71
  72 class CLI(CLITestMixin, unittest.TestCase):
  73     # this test case only looks at argument-processing and simple stuff.
  74     def test_options(self):
  75         fileutil.rm_dir("cli/test_options")
  76         fileutil.make_dirs("cli/test_options")
  77         fileutil.make_dirs("cli/test_options/private")
  78         fileutil.write("cli/test_options/node.url", "http://localhost:8080/\n")
  79         filenode_uri = uri.WriteableSSKFileURI(writekey="\x00"*16,
  80                                                fingerprint="\x00"*32)
  81         private_uri = uri.DirectoryURI(filenode_uri).to_string()
  82         fileutil.write("cli/test_options/private/root_dir.cap", private_uri + "\n")
  83         o = cli.ListOptions()
  84         o.parseOptions(["--node-directory", "cli/test_options"])
  85         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
  86         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], private_uri)
  87         self.failUnlessReallyEqual(o.where, u"")
  88
  89         o = cli.ListOptions()
  90         o.parseOptions(["--node-directory", "cli/test_options",
  91                         "--node-url", "http://example.org:8111/"])
  92         self.failUnlessReallyEqual(o['node-url'], "http://example.org:8111/")
  93         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], private_uri)
  94         self.failUnlessReallyEqual(o.where, u"")
  95
  96         o = cli.ListOptions()
  97         o.parseOptions(["--node-directory", "cli/test_options",
  98                         "--dir-cap", "root"])
  99         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
 100         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], "root")
 101         self.failUnlessReallyEqual(o.where, u"")
 102
 103         o = cli.ListOptions()
 104         other_filenode_uri = uri.WriteableSSKFileURI(writekey="\x11"*16,
 105                                                      fingerprint="\x11"*32)
 106         other_uri = uri.DirectoryURI(other_filenode_uri).to_string()
 107         o.parseOptions(["--node-directory", "cli/test_options",
 108                         "--dir-cap", other_uri])
 109         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
 110         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], other_uri)
 111         self.failUnlessReallyEqual(o.where, u"")
 112
 113         o = cli.ListOptions()
 114         o.parseOptions(["--node-directory", "cli/test_options",
 115                         "--dir-cap", other_uri, "subdir"])
 116         self.failUnlessReallyEqual(o['node-url'], "http://localhost:8080/")
 117         self.failUnlessReallyEqual(o.aliases[DEFAULT_ALIAS], other_uri)
 118         self.failUnlessReallyEqual(o.where, u"subdir")
 119
 120         o = cli.ListOptions()
 121         self.failUnlessRaises(usage.UsageError,
 122                               o.parseOptions,
 123                               ["--node-directory", "cli/test_options",
 124                                "--node-url", "NOT-A-URL"])
 125
 126         o = cli.ListOptions()
 127         o.parseOptions(["--node-directory", "cli/test_options",
 128                         "--node-url", "http://localhost:8080"])
 129         self.failUnlessReallyEqual(o["node-url"], "http://localhost:8080/")
 130
 131         o = cli.ListOptions()
 132         o.parseOptions(["--node-directory", "cli/test_options",
 133                         "--node-url", "https://localhost/"])
 134         self.failUnlessReallyEqual(o["node-url"], "https://localhost/")
 135
 136     def _dump_cap(self, *args):
 137         config = debug.DumpCapOptions()
 138         config.stdout,config.stderr = StringIO(), StringIO()
 139         config.parseOptions(args)
 140         debug.dump_cap(config)
 141         self.failIf(config.stderr.getvalue())
 142         output = config.stdout.getvalue()
 143         return output
 144
 145     def test_dump_cap_chk(self):
 146         key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
 147         uri_extension_hash = hashutil.uri_extension_hash("stuff")
 148         needed_shares = 25
 149         total_shares = 100
 150         size = 1234
 151         u = uri.CHKFileURI(key=key,
 152                            uri_extension_hash=uri_extension_hash,
 153                            needed_shares=needed_shares,
 154                            total_shares=total_shares,
 155                            size=size)
 156         output = self._dump_cap(u.to_string())
 157         self.failUnless("CHK File:" in output, output)
 158         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
 159         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 160         self.failUnless("size: 1234" in output, output)
 161         self.failUnless("k/N: 25/100" in output, output)
 162         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 163
 164         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 165                                 u.to_string())
 166         self.failUnless("client renewal secret: znxmki5zdibb5qlt46xbdvk2t55j7hibejq3i5ijyurkr6m6jkhq" in output, output)
 167
 168         output = self._dump_cap(u.get_verify_cap().to_string())
 169         self.failIf("key: " in output, output)
 170         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 171         self.failUnless("size: 1234" in output, output)
 172         self.failUnless("k/N: 25/100" in output, output)
 173         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 174
 175         prefixed_u = "http://127.0.0.1/uri/%s" % urllib.quote(u.to_string())
 176         output = self._dump_cap(prefixed_u)
 177         self.failUnless("CHK File:" in output, output)
 178         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
 179         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 180         self.failUnless("size: 1234" in output, output)
 181         self.failUnless("k/N: 25/100" in output, output)
 182         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 183
 184     def test_dump_cap_lit(self):
 185         u = uri.LiteralFileURI("this is some data")
 186         output = self._dump_cap(u.to_string())
 187         self.failUnless("Literal File URI:" in output, output)
 188         self.failUnless("data: 'this is some data'" in output, output)
 189
 190     def test_dump_cap_sdmf(self):
 191         writekey = "\x01" * 16
 192         fingerprint = "\xfe" * 32
 193         u = uri.WriteableSSKFileURI(writekey, fingerprint)
 194
 195         output = self._dump_cap(u.to_string())
 196         self.failUnless("SDMF Writeable URI:" in output, output)
 197         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output, output)
 198         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 199         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 200         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 201
 202         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 203                                 u.to_string())
 204         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 205
 206         fileutil.make_dirs("cli/test_dump_cap/private")
 207         fileutil.write("cli/test_dump_cap/private/secret", "5s33nk3qpvnj2fw3z4mnm2y6fa\n")
 208         output = self._dump_cap("--client-dir", "cli/test_dump_cap",
 209                                 u.to_string())
 210         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 211
 212         output = self._dump_cap("--client-dir", "cli/test_dump_cap_BOGUS",
 213                                 u.to_string())
 214         self.failIf("file renewal secret:" in output, output)
 215
 216         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 217                                 u.to_string())
 218         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 219         self.failIf("file renewal secret:" in output, output)
 220
 221         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 222                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 223                                 u.to_string())
 224         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 225         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 226         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 227
 228         u = u.get_readonly()
 229         output = self._dump_cap(u.to_string())
 230         self.failUnless("SDMF Read-only URI:" in output, output)
 231         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 232         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 233         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 234
 235         u = u.get_verify_cap()
 236         output = self._dump_cap(u.to_string())
 237         self.failUnless("SDMF Verifier URI:" in output, output)
 238         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 239         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 240
 241     def test_dump_cap_mdmf(self):
 242         writekey = "\x01" * 16
 243         fingerprint = "\xfe" * 32
 244         u = uri.WriteableMDMFFileURI(writekey, fingerprint)
 245
 246         output = self._dump_cap(u.to_string())
 247         self.failUnless("MDMF Writeable URI:" in output, output)
 248         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output, output)
 249         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 250         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, 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         fileutil.make_dirs("cli/test_dump_cap/private")
 258         fileutil.write("cli/test_dump_cap/private/secret", "5s33nk3qpvnj2fw3z4mnm2y6fa\n")
 259         output = self._dump_cap("--client-dir", "cli/test_dump_cap",
 260                                 u.to_string())
 261         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 262
 263         output = self._dump_cap("--client-dir", "cli/test_dump_cap_BOGUS",
 264                                 u.to_string())
 265         self.failIf("file renewal secret:" in output, output)
 266
 267         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 268                                 u.to_string())
 269         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 270         self.failIf("file renewal secret:" in output, output)
 271
 272         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 273                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 274                                 u.to_string())
 275         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 276         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 277         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 278
 279         u = u.get_readonly()
 280         output = self._dump_cap(u.to_string())
 281         self.failUnless("MDMF Read-only URI:" in output, output)
 282         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 283         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 284         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 285
 286         u = u.get_verify_cap()
 287         output = self._dump_cap(u.to_string())
 288         self.failUnless("MDMF Verifier URI:" in output, output)
 289         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 290         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 291
 292
 293     def test_dump_cap_chk_directory(self):
 294         key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
 295         uri_extension_hash = hashutil.uri_extension_hash("stuff")
 296         needed_shares = 25
 297         total_shares = 100
 298         size = 1234
 299         u1 = uri.CHKFileURI(key=key,
 300                             uri_extension_hash=uri_extension_hash,
 301                             needed_shares=needed_shares,
 302                             total_shares=total_shares,
 303                             size=size)
 304         u = uri.ImmutableDirectoryURI(u1)
 305
 306         output = self._dump_cap(u.to_string())
 307         self.failUnless("CHK Directory URI:" in output, output)
 308         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
 309         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 310         self.failUnless("size: 1234" in output, output)
 311         self.failUnless("k/N: 25/100" in output, output)
 312         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 313
 314         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 315                                 u.to_string())
 316         self.failUnless("file renewal secret: csrvkjgomkyyyil5yo4yk5np37p6oa2ve2hg6xmk2dy7kaxsu6xq" in output, output)
 317
 318         u = u.get_verify_cap()
 319         output = self._dump_cap(u.to_string())
 320         self.failUnless("CHK Directory Verifier URI:" in output, output)
 321         self.failIf("key: " in output, output)
 322         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
 323         self.failUnless("size: 1234" in output, output)
 324         self.failUnless("k/N: 25/100" in output, output)
 325         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
 326
 327     def test_dump_cap_sdmf_directory(self):
 328         writekey = "\x01" * 16
 329         fingerprint = "\xfe" * 32
 330         u1 = uri.WriteableSSKFileURI(writekey, fingerprint)
 331         u = uri.DirectoryURI(u1)
 332
 333         output = self._dump_cap(u.to_string())
 334         self.failUnless("Directory Writeable URI:" in output, output)
 335         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output,
 336                         output)
 337         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 338         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output,
 339                         output)
 340         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 341
 342         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 343                                 u.to_string())
 344         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 345
 346         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 347                                 u.to_string())
 348         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 349         self.failIf("file renewal secret:" in output, output)
 350
 351         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 352                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 353                                 u.to_string())
 354         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 355         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 356         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 357
 358         u = u.get_readonly()
 359         output = self._dump_cap(u.to_string())
 360         self.failUnless("Directory Read-only URI:" in output, output)
 361         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 362         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 363         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 364
 365         u = u.get_verify_cap()
 366         output = self._dump_cap(u.to_string())
 367         self.failUnless("Directory Verifier URI:" in output, output)
 368         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 369         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 370
 371     def test_dump_cap_mdmf_directory(self):
 372         writekey = "\x01" * 16
 373         fingerprint = "\xfe" * 32
 374         u1 = uri.WriteableMDMFFileURI(writekey, fingerprint)
 375         u = uri.MDMFDirectoryURI(u1)
 376
 377         output = self._dump_cap(u.to_string())
 378         self.failUnless("Directory Writeable URI:" in output, output)
 379         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output,
 380                         output)
 381         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 382         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output,
 383                         output)
 384         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 385
 386         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 387                                 u.to_string())
 388         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 389
 390         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 391                                 u.to_string())
 392         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 393         self.failIf("file renewal secret:" in output, output)
 394
 395         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
 396                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
 397                                 u.to_string())
 398         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
 399         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
 400         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
 401
 402         u = u.get_readonly()
 403         output = self._dump_cap(u.to_string())
 404         self.failUnless("Directory Read-only URI:" in output, output)
 405         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
 406         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 407         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 408
 409         u = u.get_verify_cap()
 410         output = self._dump_cap(u.to_string())
 411         self.failUnless("Directory Verifier URI:" in output, output)
 412         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
 413         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
 414
 415
 416     def _catalog_shares(self, *basedirs):
 417         o = debug.CatalogSharesOptions()
 418         o.stdout,o.stderr = StringIO(), StringIO()
 419         args = list(basedirs)
 420         o.parseOptions(args)
 421         debug.catalog_shares(o)
 422         out = o.stdout.getvalue()
 423         err = o.stderr.getvalue()
 424         return out, err
 425
 426     def test_catalog_shares_error(self):
 427         nodedir1 = "cli/test_catalog_shares/node1"
 428         sharedir = os.path.join(nodedir1, "storage", "shares", "mq", "mqfblse6m5a6dh45isu2cg7oji")
 429         fileutil.make_dirs(sharedir)
 430         fileutil.write("cli/test_catalog_shares/node1/storage/shares/mq/not-a-dir", "")
 431         # write a bogus share that looks a little bit like CHK
 432         fileutil.write(os.path.join(sharedir, "8"),
 433                        "\x00\x00\x00\x01" + "\xff" * 200) # this triggers an assert
 434
 435         nodedir2 = "cli/test_catalog_shares/node2"
 436         fileutil.make_dirs(nodedir2)
 437         fileutil.write("cli/test_catalog_shares/node1/storage/shares/not-a-dir", "")
 438
 439         # now make sure that the 'catalog-shares' commands survives the error
 440         out, err = self._catalog_shares(nodedir1, nodedir2)
 441         self.failUnlessReallyEqual(out, "", out)
 442         self.failUnless("Error processing " in err,
 443                         "didn't see 'error processing' in '%s'" % err)
 444         #self.failUnless(nodedir1 in err,
 445         #                "didn't see '%s' in '%s'" % (nodedir1, err))
 446         # windows mangles the path, and os.path.join isn't enough to make
 447         # up for it, so just look for individual strings
 448         self.failUnless("node1" in err,
 449                         "didn't see 'node1' in '%s'" % err)
 450         self.failUnless("mqfblse6m5a6dh45isu2cg7oji" in err,
 451                         "didn't see 'mqfblse6m5a6dh45isu2cg7oji' in '%s'" % err)
 452
 453     def test_alias(self):
 454         aliases = {"tahoe": "TA",
 455                    "work": "WA",
 456                    "c": "CA"}
 457         def ga1(path):
 458             return get_alias(aliases, path, u"tahoe")
 459         uses_lettercolon = common.platform_uses_lettercolon_drivename()
 460         self.failUnlessReallyEqual(ga1(u"bare"), ("TA", "bare"))
 461         self.failUnlessReallyEqual(ga1(u"baredir/file"), ("TA", "baredir/file"))
 462         self.failUnlessReallyEqual(ga1(u"baredir/file:7"), ("TA", "baredir/file:7"))
 463         self.failUnlessReallyEqual(ga1(u"tahoe:"), ("TA", ""))
 464         self.failUnlessReallyEqual(ga1(u"tahoe:file"), ("TA", "file"))
 465         self.failUnlessReallyEqual(ga1(u"tahoe:dir/file"), ("TA", "dir/file"))
 466         self.failUnlessReallyEqual(ga1(u"work:"), ("WA", ""))
 467         self.failUnlessReallyEqual(ga1(u"work:file"), ("WA", "file"))
 468         self.failUnlessReallyEqual(ga1(u"work:dir/file"), ("WA", "dir/file"))
 469         # default != None means we really expect a tahoe path, regardless of
 470         # whether we're on windows or not. This is what 'tahoe get' uses.
 471         self.failUnlessReallyEqual(ga1(u"c:"), ("CA", ""))
 472         self.failUnlessReallyEqual(ga1(u"c:file"), ("CA", "file"))
 473         self.failUnlessReallyEqual(ga1(u"c:dir/file"), ("CA", "dir/file"))
 474         self.failUnlessReallyEqual(ga1(u"URI:stuff"), ("URI:stuff", ""))
 475         self.failUnlessReallyEqual(ga1(u"URI:stuff/file"), ("URI:stuff", "file"))
 476         self.failUnlessReallyEqual(ga1(u"URI:stuff:./file"), ("URI:stuff", "file"))
 477         self.failUnlessReallyEqual(ga1(u"URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
 478         self.failUnlessReallyEqual(ga1(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 479         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:")
 480         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:dir")
 481         self.failUnlessRaises(common.UnknownAliasError, ga1, u"missing:dir/file")
 482
 483         def ga2(path):
 484             return get_alias(aliases, path, None)
 485         self.failUnlessReallyEqual(ga2(u"bare"), (DefaultAliasMarker, "bare"))
 486         self.failUnlessReallyEqual(ga2(u"baredir/file"),
 487                              (DefaultAliasMarker, "baredir/file"))
 488         self.failUnlessReallyEqual(ga2(u"baredir/file:7"),
 489                              (DefaultAliasMarker, "baredir/file:7"))
 490         self.failUnlessReallyEqual(ga2(u"baredir/sub:1/file:7"),
 491                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
 492         self.failUnlessReallyEqual(ga2(u"tahoe:"), ("TA", ""))
 493         self.failUnlessReallyEqual(ga2(u"tahoe:file"), ("TA", "file"))
 494         self.failUnlessReallyEqual(ga2(u"tahoe:dir/file"), ("TA", "dir/file"))
 495         # on windows, we really want c:foo to indicate a local file.
 496         # default==None is what 'tahoe cp' uses.
 497         if uses_lettercolon:
 498             self.failUnlessReallyEqual(ga2(u"c:"), (DefaultAliasMarker, "c:"))
 499             self.failUnlessReallyEqual(ga2(u"c:file"), (DefaultAliasMarker, "c:file"))
 500             self.failUnlessReallyEqual(ga2(u"c:dir/file"),
 501                                  (DefaultAliasMarker, "c:dir/file"))
 502         else:
 503             self.failUnlessReallyEqual(ga2(u"c:"), ("CA", ""))
 504             self.failUnlessReallyEqual(ga2(u"c:file"), ("CA", "file"))
 505             self.failUnlessReallyEqual(ga2(u"c:dir/file"), ("CA", "dir/file"))
 506         self.failUnlessReallyEqual(ga2(u"work:"), ("WA", ""))
 507         self.failUnlessReallyEqual(ga2(u"work:file"), ("WA", "file"))
 508         self.failUnlessReallyEqual(ga2(u"work:dir/file"), ("WA", "dir/file"))
 509         self.failUnlessReallyEqual(ga2(u"URI:stuff"), ("URI:stuff", ""))
 510         self.failUnlessReallyEqual(ga2(u"URI:stuff/file"), ("URI:stuff", "file"))
 511         self.failUnlessReallyEqual(ga2(u"URI:stuff:./file"), ("URI:stuff", "file"))
 512         self.failUnlessReallyEqual(ga2(u"URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
 513         self.failUnlessReallyEqual(ga2(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 514         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:")
 515         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:dir")
 516         self.failUnlessRaises(common.UnknownAliasError, ga2, u"missing:dir/file")
 517
 518         def ga3(path):
 519             old = common.pretend_platform_uses_lettercolon
 520             try:
 521                 common.pretend_platform_uses_lettercolon = True
 522                 retval = get_alias(aliases, path, None)
 523             finally:
 524                 common.pretend_platform_uses_lettercolon = old
 525             return retval
 526         self.failUnlessReallyEqual(ga3(u"bare"), (DefaultAliasMarker, "bare"))
 527         self.failUnlessReallyEqual(ga3(u"baredir/file"),
 528                              (DefaultAliasMarker, "baredir/file"))
 529         self.failUnlessReallyEqual(ga3(u"baredir/file:7"),
 530                              (DefaultAliasMarker, "baredir/file:7"))
 531         self.failUnlessReallyEqual(ga3(u"baredir/sub:1/file:7"),
 532                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
 533         self.failUnlessReallyEqual(ga3(u"tahoe:"), ("TA", ""))
 534         self.failUnlessReallyEqual(ga3(u"tahoe:file"), ("TA", "file"))
 535         self.failUnlessReallyEqual(ga3(u"tahoe:dir/file"), ("TA", "dir/file"))
 536         self.failUnlessReallyEqual(ga3(u"c:"), (DefaultAliasMarker, "c:"))
 537         self.failUnlessReallyEqual(ga3(u"c:file"), (DefaultAliasMarker, "c:file"))
 538         self.failUnlessReallyEqual(ga3(u"c:dir/file"),
 539                              (DefaultAliasMarker, "c:dir/file"))
 540         self.failUnlessReallyEqual(ga3(u"work:"), ("WA", ""))
 541         self.failUnlessReallyEqual(ga3(u"work:file"), ("WA", "file"))
 542         self.failUnlessReallyEqual(ga3(u"work:dir/file"), ("WA", "dir/file"))
 543         self.failUnlessReallyEqual(ga3(u"URI:stuff"), ("URI:stuff", ""))
 544         self.failUnlessReallyEqual(ga3(u"URI:stuff:./file"), ("URI:stuff", "file"))
 545         self.failUnlessReallyEqual(ga3(u"URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
 546         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:")
 547         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:dir")
 548         self.failUnlessRaises(common.UnknownAliasError, ga3, u"missing:dir/file")
 549         # calling get_alias with a path that doesn't include an alias and
 550         # default set to something that isn't in the aliases argument should
 551         # raise an UnknownAliasError.
 552         def ga4(path):
 553             return get_alias(aliases, path, u"badddefault:")
 554         self.failUnlessRaises(common.UnknownAliasError, ga4, u"afile")
 555         self.failUnlessRaises(common.UnknownAliasError, ga4, u"a/dir/path/")
 556
 557         def ga5(path):
 558             old = common.pretend_platform_uses_lettercolon
 559             try:
 560                 common.pretend_platform_uses_lettercolon = True
 561                 retval = get_alias(aliases, path, u"baddefault:")
 562             finally:
 563                 common.pretend_platform_uses_lettercolon = old
 564             return retval
 565         self.failUnlessRaises(common.UnknownAliasError, ga5, u"C:\\Windows")
 566
 567     def test_listdir_unicode_good(self):
 568         filenames = [u'L\u00F4zane', u'Bern', u'Gen\u00E8ve']  # must be NFC
 569
 570         for name in filenames:
 571             self.skip_if_cannot_represent_filename(name)
 572
 573         basedir = "cli/common/listdir_unicode_good"
 574         fileutil.make_dirs(basedir)
 575
 576         for name in filenames:
 577             open(os.path.join(unicode(basedir), name), "wb").close()
 578
 579         for file in listdir_unicode(unicode(basedir)):
 580             self.failUnlessIn(normalize(file), filenames)
 581
 582
 583 class Help(unittest.TestCase):
 584     def test_get(self):
 585         help = str(cli.GetOptions())
 586         self.failUnlessIn(" get [options] REMOTE_FILE LOCAL_FILE", help)
 587         self.failUnlessIn("% tahoe get FOO |less", help)
 588
 589     def test_put(self):
 590         help = str(cli.PutOptions())
 591         self.failUnlessIn(" put [options] LOCAL_FILE REMOTE_FILE", help)
 592         self.failUnlessIn("% cat FILE | tahoe put", help)
 593
 594     def test_unlink(self):
 595         help = str(cli.UnlinkOptions())
 596         self.failUnlessIn(" unlink [options] REMOTE_FILE", help)
 597
 598     def test_rm(self):
 599         help = str(cli.RmOptions())
 600         self.failUnlessIn(" rm [options] REMOTE_FILE", help)
 601
 602     def test_mv(self):
 603         help = str(cli.MvOptions())
 604         self.failUnlessIn(" mv [options] FROM TO", help)
 605         self.failUnlessIn("Use 'tahoe mv' to move files", help)
 606
 607     def test_cp(self):
 608         help = str(cli.CpOptions())
 609         self.failUnlessIn(" cp [options] FROM.. TO", help)
 610         self.failUnlessIn("Use 'tahoe cp' to copy files", help)
 611
 612     def test_ln(self):
 613         help = str(cli.LnOptions())
 614         self.failUnlessIn(" ln [options] FROM_LINK TO_LINK", help)
 615         self.failUnlessIn("Use 'tahoe ln' to duplicate a link", help)
 616
 617     def test_mkdir(self):
 618         help = str(cli.MakeDirectoryOptions())
 619         self.failUnlessIn(" mkdir [options] [REMOTE_DIR]", help)
 620         self.failUnlessIn("Create a new directory", help)
 621
 622     def test_backup(self):
 623         help = str(cli.BackupOptions())
 624         self.failUnlessIn(" backup [options] FROM ALIAS:TO", help)
 625
 626     def test_webopen(self):
 627         help = str(cli.WebopenOptions())
 628         self.failUnlessIn(" webopen [options] [ALIAS:PATH]", help)
 629
 630     def test_manifest(self):
 631         help = str(cli.ManifestOptions())
 632         self.failUnlessIn(" manifest [options] [ALIAS:PATH]", help)
 633
 634     def test_stats(self):
 635         help = str(cli.StatsOptions())
 636         self.failUnlessIn(" stats [options] [ALIAS:PATH]", help)
 637
 638     def test_check(self):
 639         help = str(cli.CheckOptions())
 640         self.failUnlessIn(" check [options] [ALIAS:PATH]", help)
 641
 642     def test_deep_check(self):
 643         help = str(cli.DeepCheckOptions())
 644         self.failUnlessIn(" deep-check [options] [ALIAS:PATH]", help)
 645
 646     def test_create_alias(self):
 647         help = str(cli.CreateAliasOptions())
 648         self.failUnlessIn(" create-alias [options] ALIAS[:]", help)
 649
 650     def test_add_alias(self):
 651         help = str(cli.AddAliasOptions())
 652         self.failUnlessIn(" add-alias [options] ALIAS[:] DIRCAP", help)
 653
 654     def test_list_aliases(self):
 655         help = str(cli.ListAliasesOptions())
 656         self.failUnlessIn(" list-aliases [options]", help)
 657
 658     def test_start(self):
 659         help = str(startstop_node.StartOptions())
 660         self.failUnlessIn(" start [options] [NODEDIR]", help)
 661
 662     def test_stop(self):
 663         help = str(startstop_node.StopOptions())
 664         self.failUnlessIn(" stop [options] [NODEDIR]", help)
 665
 666     def test_restart(self):
 667         help = str(startstop_node.RestartOptions())
 668         self.failUnlessIn(" restart [options] [NODEDIR]", help)
 669
 670     def test_run(self):
 671         help = str(startstop_node.RunOptions())
 672         self.failUnlessIn(" run [options] [NODEDIR]", help)
 673
 674     def test_create_client(self):
 675         help = str(create_node.CreateClientOptions())
 676         self.failUnlessIn(" create-client [options] [NODEDIR]", help)
 677
 678     def test_create_node(self):
 679         help = str(create_node.CreateNodeOptions())
 680         self.failUnlessIn(" create-node [options] [NODEDIR]", help)
 681
 682     def test_create_introducer(self):
 683         help = str(create_node.CreateIntroducerOptions())
 684         self.failUnlessIn(" create-introducer [options] NODEDIR", help)
 685
 686     def test_debug_trial(self):
 687         help = str(debug.TrialOptions())
 688         self.failUnlessIn(" debug trial [options] [[file|package|module|TestCase|testmethod]...]", help)
 689         self.failUnlessIn("The 'tahoe debug trial' command uses the correct imports", help)
 690
 691
 692 class CreateAlias(GridTestMixin, CLITestMixin, unittest.TestCase):
 693
 694     def _test_webopen(self, args, expected_url):
 695         woo = cli.WebopenOptions()
 696         all_args = ["--node-directory", self.get_clientdir()] + list(args)
 697         woo.parseOptions(all_args)
 698         urls = []
 699         rc = cli.webopen(woo, urls.append)
 700         self.failUnlessReallyEqual(rc, 0)
 701         self.failUnlessReallyEqual(len(urls), 1)
 702         self.failUnlessReallyEqual(urls[0], expected_url)
 703
 704     def test_create(self):
 705         self.basedir = "cli/CreateAlias/create"
 706         self.set_up_grid()
 707         aliasfile = os.path.join(self.get_clientdir(), "private", "aliases")
 708
 709         d = self.do_cli("create-alias", "tahoe")
 710         def _done((rc,stdout,stderr)):
 711             self.failUnless("Alias 'tahoe' created" in stdout)
 712             self.failIf(stderr)
 713             aliases = get_aliases(self.get_clientdir())
 714             self.failUnless("tahoe" in aliases)
 715             self.failUnless(aliases["tahoe"].startswith("URI:DIR2:"))
 716         d.addCallback(_done)
 717         d.addCallback(lambda res: self.do_cli("create-alias", "two:"))
 718
 719         def _stash_urls(res):
 720             aliases = get_aliases(self.get_clientdir())
 721             node_url_file = os.path.join(self.get_clientdir(), "node.url")
 722             nodeurl = fileutil.read(node_url_file).strip()
 723             self.welcome_url = nodeurl
 724             uribase = nodeurl + "uri/"
 725             self.tahoe_url = uribase + urllib.quote(aliases["tahoe"])
 726             self.tahoe_subdir_url = self.tahoe_url + "/subdir"
 727             self.two_url = uribase + urllib.quote(aliases["two"])
 728             self.two_uri = aliases["two"]
 729         d.addCallback(_stash_urls)
 730
 731         d.addCallback(lambda res: self.do_cli("create-alias", "two")) # dup
 732         def _check_create_duplicate((rc,stdout,stderr)):
 733             self.failIfEqual(rc, 0)
 734             self.failUnless("Alias 'two' already exists!" in stderr)
 735             aliases = get_aliases(self.get_clientdir())
 736             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 737         d.addCallback(_check_create_duplicate)
 738
 739         d.addCallback(lambda res: self.do_cli("add-alias", "added", self.two_uri))
 740         def _check_add((rc,stdout,stderr)):
 741             self.failUnlessReallyEqual(rc, 0)
 742             self.failUnless("Alias 'added' added" in stdout)
 743         d.addCallback(_check_add)
 744
 745         # check add-alias with a duplicate
 746         d.addCallback(lambda res: self.do_cli("add-alias", "two", self.two_uri))
 747         def _check_add_duplicate((rc,stdout,stderr)):
 748             self.failIfEqual(rc, 0)
 749             self.failUnless("Alias 'two' already exists!" in stderr)
 750             aliases = get_aliases(self.get_clientdir())
 751             self.failUnlessReallyEqual(aliases["two"], self.two_uri)
 752         d.addCallback(_check_add_duplicate)
 753
 754         # check create-alias and add-alias with invalid aliases
 755         def _check_invalid((rc,stdout,stderr)):
 756             self.failIfEqual(rc, 0)
 757             self.failUnlessIn("cannot contain", stderr)
 758
 759         for invalid in ['foo:bar', 'foo bar', 'foobar::']:
 760             d.addCallback(lambda res: self.do_cli("create-alias", invalid))
 761             d.addCallback(_check_invalid)
 762             d.addCallback(lambda res: self.do_cli("add-alias", invalid, self.two_uri))
 763             d.addCallback(_check_invalid)
 764
 765         def _test_urls(junk):
 766             self._test_webopen([], self.welcome_url)
 767             self._test_webopen(["/"], self.tahoe_url)
 768             self._test_webopen(["tahoe:"], self.tahoe_url)
 769             self._test_webopen(["tahoe:/"], self.tahoe_url)
 770             self._test_webopen(["tahoe:subdir"], self.tahoe_subdir_url)
 771             self._test_webopen(["-i", "tahoe:subdir"],
 772                                self.tahoe_subdir_url+"?t=info")
 773             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
 774             self._test_webopen(["tahoe:subdir/file"],
 775                                self.tahoe_subdir_url + '/file')
 776             self._test_webopen(["--info", "tahoe:subdir/file"],
 777                                self.tahoe_subdir_url + '/file?t=info')
 778             # if "file" is indeed a file, then the url produced by webopen in
 779             # this case is disallowed by the webui. but by design, webopen
 780             # passes through the mistake from the user to the resultant
 781             # webopened url
 782             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
 783             self._test_webopen(["two:"], self.two_url)
 784         d.addCallback(_test_urls)
 785
 786         def _remove_trailing_newline_and_create_alias(ign):
 787             # ticket #741 is about a manually-edited alias file (which
 788             # doesn't end in a newline) being corrupted by a subsequent
 789             # "tahoe create-alias"
 790             old = fileutil.read(aliasfile)
 791             fileutil.write(aliasfile, old.rstrip())
 792             return self.do_cli("create-alias", "un-corrupted1")
 793         d.addCallback(_remove_trailing_newline_and_create_alias)
 794         def _check_not_corrupted1((rc,stdout,stderr)):
 795             self.failUnless("Alias 'un-corrupted1' created" in stdout, stdout)
 796             self.failIf(stderr)
 797             # the old behavior was to simply append the new record, causing a
 798             # line that looked like "NAME1: CAP1NAME2: CAP2". This won't look
 799             # like a valid dircap, so get_aliases() will raise an exception.
 800             aliases = get_aliases(self.get_clientdir())
 801             self.failUnless("added" in aliases)
 802             self.failUnless(aliases["added"].startswith("URI:DIR2:"))
 803             # to be safe, let's confirm that we don't see "NAME2:" in CAP1.
 804             # No chance of a false-negative, because the hyphen in
 805             # "un-corrupted1" is not a valid base32 character.
 806             self.failIfIn("un-corrupted1:", aliases["added"])
 807             self.failUnless("un-corrupted1" in aliases)
 808             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 809         d.addCallback(_check_not_corrupted1)
 810
 811         def _remove_trailing_newline_and_add_alias(ign):
 812             # same thing, but for "tahoe add-alias"
 813             old = fileutil.read(aliasfile)
 814             fileutil.write(aliasfile, old.rstrip())
 815             return self.do_cli("add-alias", "un-corrupted2", self.two_uri)
 816         d.addCallback(_remove_trailing_newline_and_add_alias)
 817         def _check_not_corrupted((rc,stdout,stderr)):
 818             self.failUnless("Alias 'un-corrupted2' added" in stdout, stdout)
 819             self.failIf(stderr)
 820             aliases = get_aliases(self.get_clientdir())
 821             self.failUnless("un-corrupted1" in aliases)
 822             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
 823             self.failIfIn("un-corrupted2:", aliases["un-corrupted1"])
 824             self.failUnless("un-corrupted2" in aliases)
 825             self.failUnless(aliases["un-corrupted2"].startswith("URI:DIR2:"))
 826         d.addCallback(_check_not_corrupted)
 827
 828     def test_create_unicode(self):
 829         self.basedir = "cli/CreateAlias/create_unicode"
 830         self.set_up_grid()
 831
 832         try:
 833             etudes_arg = u"\u00E9tudes".encode(get_io_encoding())
 834             lumiere_arg = u"lumi\u00E8re.txt".encode(get_io_encoding())
 835         except UnicodeEncodeError:
 836             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
 837
 838         d = self.do_cli("create-alias", etudes_arg)
 839         def _check_create_unicode((rc, out, err)):
 840             self.failUnlessReallyEqual(rc, 0)
 841             self.failUnlessReallyEqual(err, "")
 842             self.failUnlessIn("Alias %s created" % quote_output(u"\u00E9tudes"), out)
 843
 844             aliases = get_aliases(self.get_clientdir())
 845             self.failUnless(aliases[u"\u00E9tudes"].startswith("URI:DIR2:"))
 846         d.addCallback(_check_create_unicode)
 847
 848         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 849         def _check_ls1((rc, out, err)):
 850             self.failUnlessReallyEqual(rc, 0)
 851             self.failUnlessReallyEqual(err, "")
 852             self.failUnlessReallyEqual(out, "")
 853         d.addCallback(_check_ls1)
 854
 855         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":uploaded.txt",
 856                                               stdin="Blah blah blah"))
 857
 858         d.addCallback(lambda res: self.do_cli("ls", etudes_arg + ":"))
 859         def _check_ls2((rc, out, err)):
 860             self.failUnlessReallyEqual(rc, 0)
 861             self.failUnlessReallyEqual(err, "")
 862             self.failUnlessReallyEqual(out, "uploaded.txt\n")
 863         d.addCallback(_check_ls2)
 864
 865         d.addCallback(lambda res: self.do_cli("get", etudes_arg + ":uploaded.txt"))
 866         def _check_get((rc, out, err)):
 867             self.failUnlessReallyEqual(rc, 0)
 868             self.failUnlessReallyEqual(err, "")
 869             self.failUnlessReallyEqual(out, "Blah blah blah")
 870         d.addCallback(_check_get)
 871
 872         # Ensure that an Unicode filename in an Unicode alias works as expected
 873         d.addCallback(lambda res: self.do_cli("put", "-", etudes_arg + ":" + lumiere_arg,
 874                                               stdin="Let the sunshine In!"))
 875
 876         d.addCallback(lambda res: self.do_cli("get",
 877                                               get_aliases(self.get_clientdir())[u"\u00E9tudes"] + "/" + lumiere_arg))
 878         def _check_get2((rc, out, err)):
 879             self.failUnlessReallyEqual(rc, 0)
 880             self.failUnlessReallyEqual(err, "")
 881             self.failUnlessReallyEqual(out, "Let the sunshine In!")
 882         d.addCallback(_check_get2)
 883
 884         return d
 885
 886     # TODO: test list-aliases, including Unicode
 887
 888
 889 class Ln(GridTestMixin, CLITestMixin, unittest.TestCase):
 890     def _create_test_file(self):
 891         data = "puppies" * 1000
 892         path = os.path.join(self.basedir, "datafile")
 893         fileutil.write(path, data)
 894         self.datafile = path
 895
 896     def test_ln_without_alias(self):
 897         # if invoked without an alias when the 'tahoe' alias doesn't
 898         # exist, 'tahoe ln' should output a useful error message and not
 899         # a stack trace
 900         self.basedir = "cli/Ln/ln_without_alias"
 901         self.set_up_grid()
 902         d = self.do_cli("ln", "from", "to")
 903         def _check((rc, out, err)):
 904             self.failUnlessReallyEqual(rc, 1)
 905             self.failUnlessIn("error:", err)
 906             self.failUnlessReallyEqual(out, "")
 907         d.addCallback(_check)
 908         # Make sure that validation extends to the "to" parameter
 909         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 910         d.addCallback(lambda ign: self._create_test_file())
 911         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 912                                               "havasu:from"))
 913         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "to"))
 914         d.addCallback(_check)
 915         return d
 916
 917     def test_ln_with_nonexistent_alias(self):
 918         # If invoked with aliases that don't exist, 'tahoe ln' should
 919         # output a useful error message and not a stack trace.
 920         self.basedir = "cli/Ln/ln_with_nonexistent_alias"
 921         self.set_up_grid()
 922         d = self.do_cli("ln", "havasu:from", "havasu:to")
 923         def _check((rc, out, err)):
 924             self.failUnlessReallyEqual(rc, 1)
 925             self.failUnlessIn("error:", err)
 926         d.addCallback(_check)
 927         # Make sure that validation occurs on the to parameter if the
 928         # from parameter passes.
 929         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
 930         d.addCallback(lambda ign: self._create_test_file())
 931         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
 932                                               "havasu:from"))
 933         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "huron:to"))
 934         d.addCallback(_check)
 935         return d
 936
 937
 938 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
 939
 940     def test_unlinked_immutable_stdin(self):
 941         # tahoe get `echo DATA | tahoe put`
 942         # tahoe get `echo DATA | tahoe put -`
 943         self.basedir = "cli/Put/unlinked_immutable_stdin"
 944         DATA = "data" * 100
 945         self.set_up_grid()
 946         d = self.do_cli("put", stdin=DATA)
 947         def _uploaded(res):
 948             (rc, out, err) = res
 949             self.failUnlessIn("waiting for file data on stdin..", err)
 950             self.failUnlessIn("200 OK", err)
 951             self.readcap = out
 952             self.failUnless(self.readcap.startswith("URI:CHK:"))
 953         d.addCallback(_uploaded)
 954         d.addCallback(lambda res: self.do_cli("get", self.readcap))
 955         def _downloaded(res):
 956             (rc, out, err) = res
 957             self.failUnlessReallyEqual(err, "")
 958             self.failUnlessReallyEqual(out, DATA)
 959         d.addCallback(_downloaded)
 960         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
 961         d.addCallback(lambda (rc, out, err):
 962                       self.failUnlessReallyEqual(out, self.readcap))
 963         return d
 964
 965     def test_unlinked_immutable_from_file(self):
 966         # tahoe put file.txt
 967         # tahoe put ./file.txt
 968         # tahoe put /tmp/file.txt
 969         # tahoe put ~/file.txt
 970         self.basedir = "cli/Put/unlinked_immutable_from_file"
 971         self.set_up_grid()
 972
 973         rel_fn = os.path.join(self.basedir, "DATAFILE")
 974         abs_fn = unicode_to_argv(abspath_expanduser_unicode(unicode(rel_fn)))
 975         # we make the file small enough to fit in a LIT file, for speed
 976         fileutil.write(rel_fn, "short file")
 977         d = self.do_cli("put", rel_fn)
 978         def _uploaded((rc, out, err)):
 979             readcap = out
 980             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
 981             self.readcap = readcap
 982         d.addCallback(_uploaded)
 983         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
 984         d.addCallback(lambda (rc,stdout,stderr):
 985                       self.failUnlessReallyEqual(stdout, self.readcap))
 986         d.addCallback(lambda res: self.do_cli("put", abs_fn))
 987         d.addCallback(lambda (rc,stdout,stderr):
 988                       self.failUnlessReallyEqual(stdout, self.readcap))
 989         # we just have to assume that ~ is handled properly
 990         return d
 991
 992     def test_immutable_from_file(self):
 993         # tahoe put file.txt uploaded.txt
 994         # tahoe - uploaded.txt
 995         # tahoe put file.txt subdir/uploaded.txt
 996         # tahoe put file.txt tahoe:uploaded.txt
 997         # tahoe put file.txt tahoe:subdir/uploaded.txt
 998         # tahoe put file.txt DIRCAP:./uploaded.txt
 999         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
1000         self.basedir = "cli/Put/immutable_from_file"
1001         self.set_up_grid()
1002
1003         rel_fn = os.path.join(self.basedir, "DATAFILE")
1004         # we make the file small enough to fit in a LIT file, for speed
1005         DATA = "short file"
1006         DATA2 = "short file two"
1007         fileutil.write(rel_fn, DATA)
1008
1009         d = self.do_cli("create-alias", "tahoe")
1010
1011         d.addCallback(lambda res:
1012                       self.do_cli("put", rel_fn, "uploaded.txt"))
1013         def _uploaded((rc, out, err)):
1014             readcap = out.strip()
1015             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
1016             self.failUnlessIn("201 Created", err)
1017             self.readcap = readcap
1018         d.addCallback(_uploaded)
1019         d.addCallback(lambda res:
1020                       self.do_cli("get", "tahoe:uploaded.txt"))
1021         d.addCallback(lambda (rc,stdout,stderr):
1022                       self.failUnlessReallyEqual(stdout, DATA))
1023
1024         d.addCallback(lambda res:
1025                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
1026         def _replaced((rc, out, err)):
1027             readcap = out.strip()
1028             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
1029             self.failUnlessIn("200 OK", err)
1030         d.addCallback(_replaced)
1031
1032         d.addCallback(lambda res:
1033                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
1034         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
1035         d.addCallback(lambda (rc,stdout,stderr):
1036                       self.failUnlessReallyEqual(stdout, DATA))
1037
1038         d.addCallback(lambda res:
1039                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
1040         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
1041         d.addCallback(lambda (rc,stdout,stderr):
1042                       self.failUnlessReallyEqual(stdout, DATA))
1043
1044         d.addCallback(lambda res:
1045                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
1046         d.addCallback(lambda res:
1047                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
1048         d.addCallback(lambda (rc,stdout,stderr):
1049                       self.failUnlessReallyEqual(stdout, DATA))
1050
1051         def _get_dircap(res):
1052             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
1053         d.addCallback(_get_dircap)
1054
1055         d.addCallback(lambda res:
1056                       self.do_cli("put", rel_fn,
1057                                   self.dircap+":./uploaded5.txt"))
1058         d.addCallback(lambda res:
1059                       self.do_cli("get", "tahoe:uploaded5.txt"))
1060         d.addCallback(lambda (rc,stdout,stderr):
1061                       self.failUnlessReallyEqual(stdout, DATA))
1062
1063         d.addCallback(lambda res:
1064                       self.do_cli("put", rel_fn,
1065                                   self.dircap+":./subdir/uploaded6.txt"))
1066         d.addCallback(lambda res:
1067                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
1068         d.addCallback(lambda (rc,stdout,stderr):
1069                       self.failUnlessReallyEqual(stdout, DATA))
1070
1071         return d
1072
1073     def test_mutable_unlinked(self):
1074         # FILECAP = `echo DATA | tahoe put --mutable`
1075         # tahoe get FILECAP, compare against DATA
1076         # echo DATA2 | tahoe put - FILECAP
1077         # tahoe get FILECAP, compare against DATA2
1078         # tahoe put file.txt FILECAP
1079         self.basedir = "cli/Put/mutable_unlinked"
1080         self.set_up_grid()
1081
1082         DATA = "data" * 100
1083         DATA2 = "two" * 100
1084         rel_fn = os.path.join(self.basedir, "DATAFILE")
1085         DATA3 = "three" * 100
1086         fileutil.write(rel_fn, DATA3)
1087
1088         d = self.do_cli("put", "--mutable", stdin=DATA)
1089         def _created(res):
1090             (rc, out, err) = res
1091             self.failUnlessIn("waiting for file data on stdin..", err)
1092             self.failUnlessIn("200 OK", err)
1093             self.filecap = out
1094             self.failUnless(self.filecap.startswith("URI:SSK:"), self.filecap)
1095         d.addCallback(_created)
1096         d.addCallback(lambda res: self.do_cli("get", self.filecap))
1097         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA))
1098
1099         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
1100         def _replaced(res):
1101             (rc, out, err) = res
1102             self.failUnlessIn("waiting for file data on stdin..", err)
1103             self.failUnlessIn("200 OK", err)
1104             self.failUnlessReallyEqual(self.filecap, out)
1105         d.addCallback(_replaced)
1106         d.addCallback(lambda res: self.do_cli("get", self.filecap))
1107         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1108
1109         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
1110         def _replaced2(res):
1111             (rc, out, err) = res
1112             self.failUnlessIn("200 OK", err)
1113             self.failUnlessReallyEqual(self.filecap, out)
1114         d.addCallback(_replaced2)
1115         d.addCallback(lambda res: self.do_cli("get", self.filecap))
1116         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA3))
1117
1118         return d
1119
1120     def test_mutable(self):
1121         # echo DATA1 | tahoe put --mutable - uploaded.txt
1122         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
1123         # tahoe get uploaded.txt, compare against DATA2
1124
1125         self.basedir = "cli/Put/mutable"
1126         self.set_up_grid()
1127
1128         DATA1 = "data" * 100
1129         fn1 = os.path.join(self.basedir, "DATA1")
1130         fileutil.write(fn1, DATA1)
1131         DATA2 = "two" * 100
1132         fn2 = os.path.join(self.basedir, "DATA2")
1133         fileutil.write(fn2, DATA2)
1134
1135         d = self.do_cli("create-alias", "tahoe")
1136         d.addCallback(lambda res:
1137                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
1138         d.addCallback(lambda res:
1139                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
1140         d.addCallback(lambda res:
1141                       self.do_cli("get", "tahoe:uploaded.txt"))
1142         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1143         return d
1144
1145     def _check_mdmf_json(self, (rc, json, err)):
1146          self.failUnlessEqual(rc, 0)
1147          self.failUnlessEqual(err, "")
1148          self.failUnlessIn('"format": "mdmf"', json)
1149          # We also want a valid MDMF cap to be in the json.
1150          self.failUnlessIn("URI:MDMF", json)
1151          self.failUnlessIn("URI:MDMF-RO", json)
1152          self.failUnlessIn("URI:MDMF-Verifier", json)
1153
1154     def _check_sdmf_json(self, (rc, json, err)):
1155         self.failUnlessEqual(rc, 0)
1156         self.failUnlessEqual(err, "")
1157         self.failUnlessIn('"format": "sdmf"', json)
1158         # We also want to see the appropriate SDMF caps.
1159         self.failUnlessIn("URI:SSK", json)
1160         self.failUnlessIn("URI:SSK-RO", json)
1161         self.failUnlessIn("URI:SSK-Verifier", json)
1162
1163     def test_mutable_type(self):
1164         self.basedir = "cli/Put/mutable_type"
1165         self.set_up_grid()
1166         data = "data" * 100000
1167         fn1 = os.path.join(self.basedir, "data")
1168         fileutil.write(fn1, data)
1169         d = self.do_cli("create-alias", "tahoe")
1170
1171         def _put_and_ls(ign, mutable_type, filename):
1172             d2 = self.do_cli("put", "--mutable", "--mutable-type="+mutable_type,
1173                              fn1, filename)
1174             def _dont_fail((rc, out, err)):
1175                 self.failUnlessEqual(rc, 0)
1176             d2.addCallback(_dont_fail)
1177             d2.addCallback(lambda ign: self.do_cli("ls", "--json", filename))
1178             return d2
1179
1180         d.addCallback(_put_and_ls, "mdmf", "tahoe:uploaded.txt")
1181         d.addCallback(self._check_mdmf_json)
1182         d.addCallback(_put_and_ls, "MDMF", "tahoe:uploaded2.txt")
1183         d.addCallback(self._check_mdmf_json)
1184         d.addCallback(_put_and_ls, "sdmf", "tahoe:uploaded3.txt")
1185         d.addCallback(self._check_sdmf_json)
1186         d.addCallback(_put_and_ls, "SDMF", "tahoe:uploaded4.txt")
1187         d.addCallback(self._check_sdmf_json)
1188         return d
1189
1190     def test_mutable_type_unlinked(self):
1191         self.basedir = "cli/Put/mutable_type_unlinked"
1192         self.set_up_grid()
1193         data = "data" * 100000
1194         fn1 = os.path.join(self.basedir, "data")
1195         fileutil.write(fn1, data)
1196         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1197         d.addCallback(lambda (rc, cap, err):
1198             self.do_cli("ls", "--json", cap))
1199         d.addCallback(self._check_mdmf_json)
1200         d.addCallback(lambda ignored:
1201             self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1))
1202         d.addCallback(lambda (rc, cap, err):
1203             self.do_cli("ls", "--json", cap))
1204         d.addCallback(self._check_sdmf_json)
1205         return d
1206
1207     def test_mutable_type_implies_mutable(self):
1208         self.basedir = "cli/Put/mutable_type_implies_mutable"
1209         self.set_up_grid()
1210         data = "data" * 100000
1211         fn1 = os.path.join(self.basedir, "data")
1212         fileutil.write(fn1, data)
1213         d = self.do_cli("put", "--mutable-type=mdmf", fn1)
1214         d.addCallback(lambda (rc, cap, err):
1215             self.do_cli("ls", "--json", cap))
1216         # This will fail if an immutable file is created instead of a
1217         # mutable file.
1218         d.addCallback(self._check_mdmf_json)
1219         d.addCallback(lambda ignored:
1220             self.do_cli("put", "--mutable-type=sdmf", fn1))
1221         d.addCallback(lambda (rc, cap, err):
1222             self.do_cli("ls", "--json", cap))
1223         d.addCallback(self._check_sdmf_json)
1224         return d
1225
1226     def test_put_to_mdmf_cap(self):
1227         self.basedir = "cli/Put/put_to_mdmf_cap"
1228         self.set_up_grid()
1229         data = "data" * 100000
1230         fn1 = os.path.join(self.basedir, "data")
1231         fileutil.write(fn1, data)
1232         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1233         def _got_cap((rc, out, err)):
1234             self.failUnlessEqual(rc, 0)
1235             self.cap = out.strip()
1236         d.addCallback(_got_cap)
1237         # Now try to write something to the cap using put.
1238         data2 = "data2" * 100000
1239         fn2 = os.path.join(self.basedir, "data2")
1240         fileutil.write(fn2, data2)
1241         d.addCallback(lambda ignored:
1242             self.do_cli("put", fn2, self.cap))
1243         def _got_put((rc, out, err)):
1244             self.failUnlessEqual(rc, 0)
1245             self.failUnlessIn(self.cap, out)
1246         d.addCallback(_got_put)
1247         # Now get the cap. We should see the data we just put there.
1248         d.addCallback(lambda ignored:
1249             self.do_cli("get", self.cap))
1250         def _got_data((rc, out, err)):
1251             self.failUnlessEqual(rc, 0)
1252             self.failUnlessEqual(out, data2)
1253         d.addCallback(_got_data)
1254         # add some extension information to the cap and try to put something
1255         # to it.
1256         def _make_extended_cap(ignored):
1257             self.cap = self.cap + ":Extension-Stuff"
1258         d.addCallback(_make_extended_cap)
1259         data3 = "data3" * 100000
1260         fn3 = os.path.join(self.basedir, "data3")
1261         fileutil.write(fn3, data3)
1262         d.addCallback(lambda ignored:
1263             self.do_cli("put", fn3, self.cap))
1264         d.addCallback(lambda ignored:
1265             self.do_cli("get", self.cap))
1266         def _got_data3((rc, out, err)):
1267             self.failUnlessEqual(rc, 0)
1268             self.failUnlessEqual(out, data3)
1269         d.addCallback(_got_data3)
1270         return d
1271
1272     def test_put_to_sdmf_cap(self):
1273         self.basedir = "cli/Put/put_to_sdmf_cap"
1274         self.set_up_grid()
1275         data = "data" * 100000
1276         fn1 = os.path.join(self.basedir, "data")
1277         fileutil.write(fn1, data)
1278         d = self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1)
1279         def _got_cap((rc, out, err)):
1280             self.failUnlessEqual(rc, 0)
1281             self.cap = out.strip()
1282         d.addCallback(_got_cap)
1283         # Now try to write something to the cap using put.
1284         data2 = "data2" * 100000
1285         fn2 = os.path.join(self.basedir, "data2")
1286         fileutil.write(fn2, data2)
1287         d.addCallback(lambda ignored:
1288             self.do_cli("put", fn2, self.cap))
1289         def _got_put((rc, out, err)):
1290             self.failUnlessEqual(rc, 0)
1291             self.failUnlessIn(self.cap, out)
1292         d.addCallback(_got_put)
1293         # Now get the cap. We should see the data we just put there.
1294         d.addCallback(lambda ignored:
1295             self.do_cli("get", self.cap))
1296         def _got_data((rc, out, err)):
1297             self.failUnlessEqual(rc, 0)
1298             self.failUnlessEqual(out, data2)
1299         d.addCallback(_got_data)
1300         return d
1301
1302     def test_mutable_type_invalid_format(self):
1303         o = cli.PutOptions()
1304         self.failUnlessRaises(usage.UsageError,
1305                               o.parseOptions,
1306                               ["--mutable", "--mutable-type=ldmf"])
1307
1308     def test_put_with_nonexistent_alias(self):
1309         # when invoked with an alias that doesn't exist, 'tahoe put'
1310         # should output a useful error message, not a stack trace
1311         self.basedir = "cli/Put/put_with_nonexistent_alias"
1312         self.set_up_grid()
1313         d = self.do_cli("put", "somefile", "fake:afile")
1314         def _check((rc, out, err)):
1315             self.failUnlessReallyEqual(rc, 1)
1316             self.failUnlessIn("error:", err)
1317             self.failUnlessReallyEqual(out, "")
1318         d.addCallback(_check)
1319         return d
1320
1321     def test_immutable_from_file_unicode(self):
1322         # tahoe put "\u00E0 trier.txt" "\u00E0 trier.txt"
1323
1324         try:
1325             a_trier_arg = u"\u00E0 trier.txt".encode(get_io_encoding())
1326         except UnicodeEncodeError:
1327             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1328
1329         self.skip_if_cannot_represent_filename(u"\u00E0 trier.txt")
1330
1331         self.basedir = "cli/Put/immutable_from_file_unicode"
1332         self.set_up_grid()
1333
1334         rel_fn = os.path.join(unicode(self.basedir), u"\u00E0 trier.txt")
1335         # we make the file small enough to fit in a LIT file, for speed
1336         DATA = "short file"
1337         fileutil.write(rel_fn, DATA)
1338
1339         d = self.do_cli("create-alias", "tahoe")
1340
1341         d.addCallback(lambda res:
1342                       self.do_cli("put", rel_fn.encode(get_io_encoding()), a_trier_arg))
1343         def _uploaded((rc, out, err)):
1344             readcap = out.strip()
1345             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
1346             self.failUnlessIn("201 Created", err)
1347             self.readcap = readcap
1348         d.addCallback(_uploaded)
1349
1350         d.addCallback(lambda res:
1351                       self.do_cli("get", "tahoe:" + a_trier_arg))
1352         d.addCallback(lambda (rc, out, err):
1353                       self.failUnlessReallyEqual(out, DATA))
1354
1355         return d
1356
1357 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
1358     def test_list(self):
1359         self.basedir = "cli/List/list"
1360         self.set_up_grid()
1361         c0 = self.g.clients[0]
1362         small = "small"
1363
1364         # u"g\u00F6\u00F6d" might not be representable in the argv and/or output encodings.
1365         # It is initially included in the directory in any case.
1366         try:
1367             good_arg = u"g\u00F6\u00F6d".encode(get_io_encoding())
1368         except UnicodeEncodeError:
1369             good_arg = None
1370
1371         try:
1372             good_out = u"g\u00F6\u00F6d".encode(get_io_encoding())
1373         except UnicodeEncodeError:
1374             good_out = None
1375
1376         d = c0.create_dirnode()
1377         def _stash_root_and_create_file(n):
1378             self.rootnode = n
1379             self.rooturi = n.get_uri()
1380             return n.add_file(u"g\u00F6\u00F6d", upload.Data(small, convergence=""))
1381         d.addCallback(_stash_root_and_create_file)
1382         def _stash_goodcap(n):
1383             self.goodcap = n.get_uri()
1384         d.addCallback(_stash_goodcap)
1385         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
1386         d.addCallback(lambda n:
1387                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
1388         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
1389         d.addCallback(lambda n:
1390                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
1391         d.addCallback(lambda ign:
1392                       self.do_cli("add-alias", "tahoe", self.rooturi))
1393         d.addCallback(lambda ign: self.do_cli("ls"))
1394         def _check1((rc,out,err)):
1395             if good_out is None:
1396                 self.failUnlessReallyEqual(rc, 1)
1397                 self.failUnlessIn("files whose names could not be converted", err)
1398                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1399                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share"]))
1400             else:
1401                 self.failUnlessReallyEqual(rc, 0)
1402                 self.failUnlessReallyEqual(err, "")
1403                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", good_out]))
1404         d.addCallback(_check1)
1405         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
1406         def _check2((rc,out,err)):
1407             self.failIfEqual(rc, 0)
1408             self.failUnlessReallyEqual(err.strip(), "No such file or directory")
1409             self.failUnlessReallyEqual(out, "")
1410         d.addCallback(_check2)
1411         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
1412         def _check3((rc,out,err)):
1413             self.failIfEqual(rc, 0)
1414             self.failUnlessIn("Error during GET: 410 Gone", err)
1415             self.failUnlessIn("UnrecoverableFileError:", err)
1416             self.failUnlessIn("could not be retrieved, because there were "
1417                               "insufficient good shares.", err)
1418             self.failUnlessReallyEqual(out, "")
1419         d.addCallback(_check3)
1420         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
1421         d.addCallback(_check3)
1422         def _check4((rc, out, err)):
1423             if good_out is None:
1424                 self.failUnlessReallyEqual(rc, 1)
1425                 self.failUnlessIn("files whose names could not be converted", err)
1426                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1427                 self.failUnlessReallyEqual(out, "")
1428             else:
1429                 # listing a file (as dir/filename) should have the edge metadata,
1430                 # including the filename
1431                 self.failUnlessReallyEqual(rc, 0)
1432                 self.failUnlessIn(good_out, out)
1433                 self.failIfIn("-r-- %d -" % len(small), out,
1434                               "trailing hyphen means unknown date")
1435
1436         if good_arg is not None:
1437             d.addCallback(lambda ign: self.do_cli("ls", "-l", good_arg))
1438             d.addCallback(_check4)
1439             # listing a file as $DIRCAP/filename should work just like dir/filename
1440             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/" + good_arg))
1441             d.addCallback(_check4)
1442             # and similarly for $DIRCAP:./filename
1443             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./" + good_arg))
1444             d.addCallback(_check4)
1445
1446         def _check5((rc, out, err)):
1447             # listing a raw filecap should not explode, but it will have no
1448             # metadata, just the size
1449             self.failUnlessReallyEqual(rc, 0)
1450             self.failUnlessReallyEqual("-r-- %d -" % len(small), out.strip())
1451         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
1452         d.addCallback(_check5)
1453
1454         # Now rename 'g\u00F6\u00F6d' to 'good' and repeat the tests that might have been skipped due
1455         # to encoding problems.
1456         d.addCallback(lambda ign: self.rootnode.move_child_to(u"g\u00F6\u00F6d", self.rootnode, u"good"))
1457
1458         d.addCallback(lambda ign: self.do_cli("ls"))
1459         def _check1_ascii((rc,out,err)):
1460             self.failUnlessReallyEqual(rc, 0)
1461             self.failUnlessReallyEqual(err, "")
1462             self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", "good"]))
1463         d.addCallback(_check1_ascii)
1464         def _check4_ascii((rc, out, err)):
1465             # listing a file (as dir/filename) should have the edge metadata,
1466             # including the filename
1467             self.failUnlessReallyEqual(rc, 0)
1468             self.failUnlessIn("good", out)
1469             self.failIfIn("-r-- %d -" % len(small), out,
1470                           "trailing hyphen means unknown date")
1471
1472         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
1473         d.addCallback(_check4_ascii)
1474         # listing a file as $DIRCAP/filename should work just like dir/filename
1475         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
1476         d.addCallback(_check4_ascii)
1477         # and similarly for $DIRCAP:./filename
1478         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
1479         d.addCallback(_check4_ascii)
1480
1481         unknown_immcap = "imm.URI:unknown"
1482         def _create_unknown(ign):
1483             nm = c0.nodemaker
1484             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
1485             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
1486                                                      mutable=False)
1487         d.addCallback(_create_unknown)
1488         def _check6((rc, out, err)):
1489             # listing a directory referencing an unknown object should print
1490             # an extra message to stderr
1491             self.failUnlessReallyEqual(rc, 0)
1492             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
1493             self.failUnlessIn("included unknown objects", err)
1494         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
1495         d.addCallback(_check6)
1496         def _check7((rc, out, err)):
1497             # listing an unknown cap directly should print an extra message
1498             # to stderr (currently this only works if the URI starts with 'URI:'
1499             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
1500             # with an alias).
1501             self.failUnlessReallyEqual(rc, 0)
1502             self.failUnlessIn("?r-- ? -\n", out)
1503             self.failUnlessIn("included unknown objects", err)
1504         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
1505         d.addCallback(_check7)
1506         return d
1507
1508     def test_list_without_alias(self):
1509         # doing just 'tahoe ls' without specifying an alias or first
1510         # doing 'tahoe create-alias tahoe' should fail gracefully.
1511         self.basedir = "cli/List/list_without_alias"
1512         self.set_up_grid()
1513         d = self.do_cli("ls")
1514         def _check((rc, out, err)):
1515             self.failUnlessReallyEqual(rc, 1)
1516             self.failUnlessIn("error:", err)
1517             self.failUnlessReallyEqual(out, "")
1518         d.addCallback(_check)
1519         return d
1520
1521     def test_list_with_nonexistent_alias(self):
1522         # doing 'tahoe ls' while specifying an alias that doesn't already
1523         # exist should fail with an informative error message
1524         self.basedir = "cli/List/list_with_nonexistent_alias"
1525         self.set_up_grid()
1526         d = self.do_cli("ls", "nonexistent:")
1527         def _check((rc, out, err)):
1528             self.failUnlessReallyEqual(rc, 1)
1529             self.failUnlessIn("error:", err)
1530             self.failUnlessIn("nonexistent", err)
1531             self.failUnlessReallyEqual(out, "")
1532         d.addCallback(_check)
1533         return d
1534
1535     def _create_directory_structure(self):
1536         # Create a simple directory structure that we can use for MDMF,
1537         # SDMF, and immutable testing.
1538         assert self.g
1539
1540         client = self.g.clients[0]
1541         # Create a dirnode
1542         d = client.create_dirnode()
1543         def _got_rootnode(n):
1544             # Add a few nodes.
1545             self._dircap = n.get_uri()
1546             nm = n._nodemaker
1547             # The uploaders may run at the same time, so we need two
1548             # MutableData instances or they'll fight over offsets &c and
1549             # break.
1550             mutable_data = MutableData("data" * 100000)
1551             mutable_data2 = MutableData("data" * 100000)
1552             # Add both kinds of mutable node.
1553             d1 = nm.create_mutable_file(mutable_data,
1554                                         version=MDMF_VERSION)
1555             d2 = nm.create_mutable_file(mutable_data2,
1556                                         version=SDMF_VERSION)
1557             # Add an immutable node. We do this through the directory,
1558             # with add_file.
1559             immutable_data = upload.Data("immutable data" * 100000,
1560                                          convergence="")
1561             d3 = n.add_file(u"immutable", immutable_data)
1562             ds = [d1, d2, d3]
1563             dl = defer.DeferredList(ds)
1564             def _made_files((r1, r2, r3)):
1565                 self.failUnless(r1[0])
1566                 self.failUnless(r2[0])
1567                 self.failUnless(r3[0])
1568
1569                 # r1, r2, and r3 contain nodes.
1570                 mdmf_node = r1[1]
1571                 sdmf_node = r2[1]
1572                 imm_node = r3[1]
1573
1574                 self._mdmf_uri = mdmf_node.get_uri()
1575                 self._mdmf_readonly_uri = mdmf_node.get_readonly_uri()
1576                 self._sdmf_uri = mdmf_node.get_uri()
1577                 self._sdmf_readonly_uri = sdmf_node.get_readonly_uri()
1578                 self._imm_uri = imm_node.get_uri()
1579
1580                 d1 = n.set_node(u"mdmf", mdmf_node)
1581                 d2 = n.set_node(u"sdmf", sdmf_node)
1582                 return defer.DeferredList([d1, d2])
1583             # We can now list the directory by listing self._dircap.
1584             dl.addCallback(_made_files)
1585             return dl
1586         d.addCallback(_got_rootnode)
1587         return d
1588
1589     def test_list_mdmf(self):
1590         # 'tahoe ls' should include MDMF files.
1591         self.basedir = "cli/List/list_mdmf"
1592         self.set_up_grid()
1593         d = self._create_directory_structure()
1594         d.addCallback(lambda ignored:
1595             self.do_cli("ls", self._dircap))
1596         def _got_ls((rc, out, err)):
1597             self.failUnlessEqual(rc, 0)
1598             self.failUnlessEqual(err, "")
1599             self.failUnlessIn("immutable", out)
1600             self.failUnlessIn("mdmf", out)
1601             self.failUnlessIn("sdmf", out)
1602         d.addCallback(_got_ls)
1603         return d
1604
1605     def test_list_mdmf_json(self):
1606         # 'tahoe ls' should include MDMF caps when invoked with MDMF
1607         # caps.
1608         self.basedir = "cli/List/list_mdmf_json"
1609         self.set_up_grid()
1610         d = self._create_directory_structure()
1611         d.addCallback(lambda ignored:
1612             self.do_cli("ls", "--json", self._dircap))
1613         def _got_json((rc, out, err)):
1614             self.failUnlessEqual(rc, 0)
1615             self.failUnlessEqual(err, "")
1616             self.failUnlessIn(self._mdmf_uri, out)
1617             self.failUnlessIn(self._mdmf_readonly_uri, out)
1618             self.failUnlessIn(self._sdmf_uri, out)
1619             self.failUnlessIn(self._sdmf_readonly_uri, out)
1620             self.failUnlessIn(self._imm_uri, out)
1621             self.failUnlessIn('"format": "sdmf"', out)
1622             self.failUnlessIn('"format": "mdmf"', out)
1623         d.addCallback(_got_json)
1624         return d
1625
1626
1627 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
1628     def test_mv_behavior(self):
1629         self.basedir = "cli/Mv/mv_behavior"
1630         self.set_up_grid()
1631         fn1 = os.path.join(self.basedir, "file1")
1632         DATA1 = "Nuclear launch codes"
1633         fileutil.write(fn1, DATA1)
1634         fn2 = os.path.join(self.basedir, "file2")
1635         DATA2 = "UML diagrams"
1636         fileutil.write(fn2, DATA2)
1637         # copy both files to the grid
1638         d = self.do_cli("create-alias", "tahoe")
1639         d.addCallback(lambda res:
1640             self.do_cli("cp", fn1, "tahoe:"))
1641         d.addCallback(lambda res:
1642             self.do_cli("cp", fn2, "tahoe:"))
1643
1644         # do mv file1 file3
1645         # (we should be able to rename files)
1646         d.addCallback(lambda res:
1647             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1648         d.addCallback(lambda (rc, out, err):
1649             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1650
1651         # do mv file3 file2
1652         # (This should succeed without issue)
1653         d.addCallback(lambda res:
1654             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1655         # Out should contain "OK" to show that the transfer worked.
1656         d.addCallback(lambda (rc,out,err):
1657             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1658
1659         # Next, make a remote directory.
1660         d.addCallback(lambda res:
1661             self.do_cli("mkdir", "tahoe:directory"))
1662
1663         # mv file2 directory
1664         # (should fail with a descriptive error message; the CLI mv
1665         #  client should support this)
1666         d.addCallback(lambda res:
1667             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1668         d.addCallback(lambda (rc, out, err):
1669             self.failUnlessIn(
1670                 "Error: You can't overwrite a directory with a file", err,
1671                 "mv shouldn't overwrite directories" ))
1672
1673         # mv file2 directory/
1674         # (should succeed by making file2 a child node of directory)
1675         d.addCallback(lambda res:
1676             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1677         # We should see an "OK"...
1678         d.addCallback(lambda (rc, out, err):
1679             self.failUnlessIn("OK", out,
1680                             "mv didn't mv a file into a directory"))
1681         # ... and be able to GET the file
1682         d.addCallback(lambda res:
1683             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1684         d.addCallback(lambda (rc, out, err):
1685             self.failUnless(os.path.exists(self.basedir + "new"),
1686                             "mv didn't write the destination file"))
1687         # ... and not find the file where it was before.
1688         d.addCallback(lambda res:
1689             self.do_cli("get", "tahoe:file2", "file2"))
1690         d.addCallback(lambda (rc, out, err):
1691             self.failUnlessIn("404", err,
1692                             "mv left the source file intact"))
1693
1694         # Let's build:
1695         # directory/directory2/some_file
1696         # directory3
1697         d.addCallback(lambda res:
1698             self.do_cli("mkdir", "tahoe:directory/directory2"))
1699         d.addCallback(lambda res:
1700             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1701         d.addCallback(lambda res:
1702             self.do_cli("mkdir", "tahoe:directory3"))
1703
1704         # Let's now try to mv directory/directory2/some_file to
1705         # directory3/some_file
1706         d.addCallback(lambda res:
1707             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1708                         "tahoe:directory3/"))
1709         # We should have just some_file in tahoe:directory3
1710         d.addCallback(lambda res:
1711             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1712         d.addCallback(lambda (rc, out, err):
1713             self.failUnless("404" not in err,
1714                               "mv didn't handle nested directories correctly"))
1715         d.addCallback(lambda res:
1716             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1717         d.addCallback(lambda (rc, out, err):
1718             self.failUnlessIn("404", err,
1719                               "mv moved the wrong thing"))
1720         return d
1721
1722     def test_mv_error_if_DELETE_fails(self):
1723         self.basedir = "cli/Mv/mv_error_if_DELETE_fails"
1724         self.set_up_grid()
1725         fn1 = os.path.join(self.basedir, "file1")
1726         DATA1 = "Nuclear launch codes"
1727         fileutil.write(fn1, DATA1)
1728
1729         original_do_http = tahoe_mv.do_http
1730         def mock_do_http(method, url, body=""):
1731             if method == "DELETE":
1732                 class FakeResponse:
1733                     def read(self):
1734                         return "response"
1735                 resp = FakeResponse()
1736                 resp.status = '500 Something Went Wrong'
1737                 resp.reason = '*shrug*'
1738                 return resp
1739             else:
1740                 return original_do_http(method, url, body=body)
1741         tahoe_mv.do_http = mock_do_http
1742
1743         # copy file to the grid
1744         d = self.do_cli("create-alias", "tahoe")
1745         d.addCallback(lambda res:
1746             self.do_cli("cp", fn1, "tahoe:"))
1747
1748         # do mv file1 file2
1749         d.addCallback(lambda res:
1750             self.do_cli("mv", "tahoe:file1", "tahoe:file2"))
1751         def _check( (rc, out, err) ):
1752             self.failIfIn("OK", out, "mv printed 'OK' even though the DELETE failed")
1753             self.failUnlessEqual(rc, 2)
1754         d.addCallback(_check)
1755
1756         def _restore_do_http(res):
1757             tahoe_mv.do_http = original_do_http
1758             return res
1759         d.addBoth(_restore_do_http)
1760         return d
1761
1762     def test_mv_without_alias(self):
1763         # doing 'tahoe mv' without explicitly specifying an alias or
1764         # creating the default 'tahoe' alias should fail with a useful
1765         # error message.
1766         self.basedir = "cli/Mv/mv_without_alias"
1767         self.set_up_grid()
1768         d = self.do_cli("mv", "afile", "anotherfile")
1769         def _check((rc, out, err)):
1770             self.failUnlessReallyEqual(rc, 1)
1771             self.failUnlessIn("error:", err)
1772             self.failUnlessReallyEqual(out, "")
1773         d.addCallback(_check)
1774         # check to see that the validation extends to the
1775         # target argument by making an alias that will work with the first
1776         # one.
1777         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1778         def _create_a_test_file(ign):
1779             self.test_file_path = os.path.join(self.basedir, "afile")
1780             fileutil.write(self.test_file_path, "puppies" * 100)
1781         d.addCallback(_create_a_test_file)
1782         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1783                                               "havasu:afile"))
1784         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1785                                               "anotherfile"))
1786         d.addCallback(_check)
1787         return d
1788
1789     def test_mv_with_nonexistent_alias(self):
1790         # doing 'tahoe mv' with an alias that doesn't exist should fail
1791         # with an informative error message.
1792         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1793         self.set_up_grid()
1794         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1795         def _check((rc, out, err)):
1796             self.failUnlessReallyEqual(rc, 1)
1797             self.failUnlessIn("error:", err)
1798             self.failUnlessIn("fake", err)
1799             self.failUnlessReallyEqual(out, "")
1800         d.addCallback(_check)
1801         # check to see that the validation extends to the
1802         # target argument by making an alias that will work with the first
1803         # one.
1804         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1805         def _create_a_test_file(ign):
1806             self.test_file_path = os.path.join(self.basedir, "afile")
1807             fileutil.write(self.test_file_path, "puppies" * 100)
1808         d.addCallback(_create_a_test_file)
1809         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1810                                               "havasu:afile"))
1811         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1812                                               "fake:anotherfile"))
1813         d.addCallback(_check)
1814         return d
1815
1816
1817 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1818
1819     def test_not_enough_args(self):
1820         o = cli.CpOptions()
1821         self.failUnlessRaises(usage.UsageError,
1822                               o.parseOptions, ["onearg"])
1823
1824     def test_unicode_filename(self):
1825         self.basedir = "cli/Cp/unicode_filename"
1826
1827         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1828         try:
1829             fn1_arg = fn1.encode(get_io_encoding())
1830             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1831         except UnicodeEncodeError:
1832             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1833
1834         self.skip_if_cannot_represent_filename(fn1)
1835
1836         self.set_up_grid()
1837
1838         DATA1 = "unicode file content"
1839         fileutil.write(fn1, DATA1)
1840
1841         fn2 = os.path.join(self.basedir, "Metallica")
1842         DATA2 = "non-unicode file content"
1843         fileutil.write(fn2, DATA2)
1844
1845         d = self.do_cli("create-alias", "tahoe")
1846
1847         d.addCallback(lambda res: self.do_cli("cp", fn1_arg, "tahoe:"))
1848
1849         d.addCallback(lambda res: self.do_cli("get", "tahoe:" + artonwall_arg))
1850         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA1))
1851
1852         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1853
1854         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1855         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1856
1857         d.addCallback(lambda res: self.do_cli("ls", "tahoe:"))
1858         def _check((rc, out, err)):
1859             try:
1860                 unicode_to_output(u"\u00C4rtonwall")
1861             except UnicodeEncodeError:
1862                 self.failUnlessReallyEqual(rc, 1)
1863                 self.failUnlessReallyEqual(out, "Metallica\n")
1864                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1865                 self.failUnlessIn("files whose names could not be converted", err)
1866             else:
1867                 self.failUnlessReallyEqual(rc, 0)
1868                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"Metallica\n\u00C4rtonwall\n")
1869                 self.failUnlessReallyEqual(err, "")
1870         d.addCallback(_check)
1871
1872         return d
1873
1874     def test_dangling_symlink_vs_recursion(self):
1875         if not hasattr(os, 'symlink'):
1876             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
1877
1878         # cp -r on a directory containing a dangling symlink shouldn't assert
1879         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1880         self.set_up_grid()
1881         dn = os.path.join(self.basedir, "dir")
1882         os.mkdir(dn)
1883         fn = os.path.join(dn, "Fakebandica")
1884         ln = os.path.join(dn, "link")
1885         os.symlink(fn, ln)
1886
1887         d = self.do_cli("create-alias", "tahoe")
1888         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1889                                               dn, "tahoe:"))
1890         return d
1891
1892     def test_copy_using_filecap(self):
1893         self.basedir = "cli/Cp/test_copy_using_filecap"
1894         self.set_up_grid()
1895         outdir = os.path.join(self.basedir, "outdir")
1896         os.mkdir(outdir)
1897         fn1 = os.path.join(self.basedir, "Metallica")
1898         fn2 = os.path.join(outdir, "Not Metallica")
1899         fn3 = os.path.join(outdir, "test2")
1900         DATA1 = "puppies" * 10000
1901         fileutil.write(fn1, DATA1)
1902
1903         d = self.do_cli("create-alias", "tahoe")
1904         d.addCallback(lambda ign: self.do_cli("put", fn1))
1905         def _put_file((rc, out, err)):
1906             self.failUnlessReallyEqual(rc, 0)
1907             self.failUnlessIn("200 OK", err)
1908             # keep track of the filecap
1909             self.filecap = out.strip()
1910         d.addCallback(_put_file)
1911
1912         # Let's try copying this to the disk using the filecap
1913         #  cp FILECAP filename
1914         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1915         def _copy_file((rc, out, err)):
1916             self.failUnlessReallyEqual(rc, 0)
1917             results = fileutil.read(fn2)
1918             self.failUnlessReallyEqual(results, DATA1)
1919         d.addCallback(_copy_file)
1920
1921         # Test with ./ (see #761)
1922         #  cp FILECAP localdir
1923         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1924         def _resp((rc, out, err)):
1925             self.failUnlessReallyEqual(rc, 1)
1926             self.failUnlessIn("error: you must specify a destination filename",
1927                               err)
1928             self.failUnlessReallyEqual(out, "")
1929         d.addCallback(_resp)
1930
1931         # Create a directory, linked at tahoe:test
1932         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1933         def _get_dir((rc, out, err)):
1934             self.failUnlessReallyEqual(rc, 0)
1935             self.dircap = out.strip()
1936         d.addCallback(_get_dir)
1937
1938         # Upload a file to the directory
1939         d.addCallback(lambda ign:
1940                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1941         d.addCallback(lambda (rc, out, err): self.failUnlessReallyEqual(rc, 0))
1942
1943         #  cp DIRCAP/filename localdir
1944         d.addCallback(lambda ign:
1945                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1946         def _get_resp((rc, out, err)):
1947             self.failUnlessReallyEqual(rc, 0)
1948             results = fileutil.read(os.path.join(outdir, "test_file"))
1949             self.failUnlessReallyEqual(results, DATA1)
1950         d.addCallback(_get_resp)
1951
1952         #  cp -r DIRCAP/filename filename2
1953         d.addCallback(lambda ign:
1954                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1955         def _get_resp2((rc, out, err)):
1956             self.failUnlessReallyEqual(rc, 0)
1957             results = fileutil.read(fn3)
1958             self.failUnlessReallyEqual(results, DATA1)
1959         d.addCallback(_get_resp2)
1960         return d
1961
1962     def test_cp_with_nonexistent_alias(self):
1963         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1964         # should output a sensible error message rather than a stack trace.
1965         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1966         self.set_up_grid()
1967         d = self.do_cli("cp", "fake:file1", "fake:file2")
1968         def _check((rc, out, err)):
1969             self.failUnlessReallyEqual(rc, 1)
1970             self.failUnlessIn("error:", err)
1971         d.addCallback(_check)
1972         # 'tahoe cp' actually processes the target argument first, so we need
1973         # to check to make sure that validation extends to the source
1974         # argument.
1975         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1976         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1977                                               "tahoe:file2"))
1978         d.addCallback(_check)
1979         return d
1980
1981     def test_unicode_dirnames(self):
1982         self.basedir = "cli/Cp/unicode_dirnames"
1983
1984         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1985         try:
1986             fn1_arg = fn1.encode(get_io_encoding())
1987             del fn1_arg # hush pyflakes
1988             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1989         except UnicodeEncodeError:
1990             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1991
1992         self.skip_if_cannot_represent_filename(fn1)
1993
1994         self.set_up_grid()
1995
1996         d = self.do_cli("create-alias", "tahoe")
1997         d.addCallback(lambda res: self.do_cli("mkdir", "tahoe:test/" + artonwall_arg))
1998         d.addCallback(lambda res: self.do_cli("cp", "-r", "tahoe:test", "tahoe:test2"))
1999         d.addCallback(lambda res: self.do_cli("ls", "tahoe:test2"))
2000         def _check((rc, out, err)):
2001             try:
2002                 unicode_to_output(u"\u00C4rtonwall")
2003             except UnicodeEncodeError:
2004                 self.failUnlessReallyEqual(rc, 1)
2005                 self.failUnlessReallyEqual(out, "")
2006                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
2007                 self.failUnlessIn("files whose names could not be converted", err)
2008             else:
2009                 self.failUnlessReallyEqual(rc, 0)
2010                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"\u00C4rtonwall\n")
2011                 self.failUnlessReallyEqual(err, "")
2012         d.addCallback(_check)
2013
2014         return d
2015
2016     def test_cp_replaces_mutable_file_contents(self):
2017         self.basedir = "cli/Cp/cp_replaces_mutable_file_contents"
2018         self.set_up_grid()
2019
2020         # Write a test file, which we'll copy to the grid.
2021         test_txt_path = os.path.join(self.basedir, "test.txt")
2022         test_txt_contents = "foo bar baz"
2023         f = open(test_txt_path, "w")
2024         f.write(test_txt_contents)
2025         f.close()
2026
2027         d = self.do_cli("create-alias", "tahoe")
2028         d.addCallback(lambda ignored:
2029             self.do_cli("mkdir", "tahoe:test"))
2030         # We have to use 'tahoe put' here because 'tahoe cp' doesn't
2031         # know how to make mutable files at the destination.
2032         d.addCallback(lambda ignored:
2033             self.do_cli("put", "--mutable", test_txt_path, "tahoe:test/test.txt"))
2034         d.addCallback(lambda ignored:
2035             self.do_cli("get", "tahoe:test/test.txt"))
2036         def _check((rc, out, err)):
2037             self.failUnlessEqual(rc, 0)
2038             self.failUnlessEqual(out, test_txt_contents)
2039         d.addCallback(_check)
2040
2041         # We'll do ls --json to get the read uri and write uri for the
2042         # file we've just uploaded.
2043         d.addCallback(lambda ignored:
2044             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2045         def _get_test_txt_uris((rc, out, err)):
2046             self.failUnlessEqual(rc, 0)
2047             filetype, data = simplejson.loads(out)
2048
2049             self.failUnlessEqual(filetype, "filenode")
2050             self.failUnless(data['mutable'])
2051
2052             self.failUnlessIn("rw_uri", data)
2053             self.rw_uri = to_str(data["rw_uri"])
2054             self.failUnlessIn("ro_uri", data)
2055             self.ro_uri = to_str(data["ro_uri"])
2056         d.addCallback(_get_test_txt_uris)
2057
2058         # Now make a new file to copy in place of test.txt.
2059         new_txt_path = os.path.join(self.basedir, "new.txt")
2060         new_txt_contents = "baz bar foo" * 100000
2061         f = open(new_txt_path, "w")
2062         f.write(new_txt_contents)
2063         f.close()
2064
2065         # Copy the new file on top of the old file.
2066         d.addCallback(lambda ignored:
2067             self.do_cli("cp", new_txt_path, "tahoe:test/test.txt"))
2068
2069         # If we get test.txt now, we should see the new data.
2070         d.addCallback(lambda ignored:
2071             self.do_cli("get", "tahoe:test/test.txt"))
2072         d.addCallback(lambda (rc, out, err):
2073             self.failUnlessEqual(out, new_txt_contents))
2074         # If we get the json of the new file, we should see that the old
2075         # uri is there
2076         d.addCallback(lambda ignored:
2077             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2078         def _check_json((rc, out, err)):
2079             self.failUnlessEqual(rc, 0)
2080             filetype, data = simplejson.loads(out)
2081
2082             self.failUnlessEqual(filetype, "filenode")
2083             self.failUnless(data['mutable'])
2084
2085             self.failUnlessIn("ro_uri", data)
2086             self.failUnlessEqual(to_str(data["ro_uri"]), self.ro_uri)
2087             self.failUnlessIn("rw_uri", data)
2088             self.failUnlessEqual(to_str(data["rw_uri"]), self.rw_uri)
2089         d.addCallback(_check_json)
2090
2091         # and, finally, doing a GET directly on one of the old uris
2092         # should give us the new contents.
2093         d.addCallback(lambda ignored:
2094             self.do_cli("get", self.rw_uri))
2095         d.addCallback(lambda (rc, out, err):
2096             self.failUnlessEqual(out, new_txt_contents))
2097         # Now copy the old test.txt without an explicit destination
2098         # file. tahoe cp will match it to the existing file and
2099         # overwrite it appropriately.
2100         d.addCallback(lambda ignored:
2101             self.do_cli("cp", test_txt_path, "tahoe:test"))
2102         d.addCallback(lambda ignored:
2103             self.do_cli("get", "tahoe:test/test.txt"))
2104         d.addCallback(lambda (rc, out, err):
2105             self.failUnlessEqual(out, test_txt_contents))
2106         d.addCallback(lambda ignored:
2107             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2108         d.addCallback(_check_json)
2109         d.addCallback(lambda ignored:
2110             self.do_cli("get", self.rw_uri))
2111         d.addCallback(lambda (rc, out, err):
2112             self.failUnlessEqual(out, test_txt_contents))
2113
2114         # Now we'll make a more complicated directory structure.
2115         # test2/
2116         # test2/mutable1
2117         # test2/mutable2
2118         # test2/imm1
2119         # test2/imm2
2120         imm_test_txt_path = os.path.join(self.basedir, "imm_test.txt")
2121         imm_test_txt_contents = test_txt_contents * 10000
2122         fileutil.write(imm_test_txt_path, imm_test_txt_contents)
2123         d.addCallback(lambda ignored:
2124             self.do_cli("mkdir", "tahoe:test2"))
2125         d.addCallback(lambda ignored:
2126             self.do_cli("put", "--mutable", new_txt_path,
2127                         "tahoe:test2/mutable1"))
2128         d.addCallback(lambda ignored:
2129             self.do_cli("put", "--mutable", new_txt_path,
2130                         "tahoe:test2/mutable2"))
2131         d.addCallback(lambda ignored:
2132             self.do_cli('put', new_txt_path, "tahoe:test2/imm1"))
2133         d.addCallback(lambda ignored:
2134             self.do_cli("put", imm_test_txt_path, "tahoe:test2/imm2"))
2135         d.addCallback(lambda ignored:
2136             self.do_cli("ls", "--json", "tahoe:test2"))
2137         def _process_directory_json((rc, out, err)):
2138             self.failUnlessEqual(rc, 0)
2139
2140             filetype, data = simplejson.loads(out)
2141             self.failUnlessEqual(filetype, "dirnode")
2142             self.failUnless(data['mutable'])
2143             self.failUnlessIn("children", data)
2144             children = data['children']
2145
2146             # Store the URIs for later use.
2147             self.childuris = {}
2148             for k in ["mutable1", "mutable2", "imm1", "imm2"]:
2149                 self.failUnlessIn(k, children)
2150                 childtype, childdata = children[k]
2151                 self.failUnlessEqual(childtype, "filenode")
2152                 if "mutable" in k:
2153                     self.failUnless(childdata['mutable'])
2154                     self.failUnlessIn("rw_uri", childdata)
2155                     uri_key = "rw_uri"
2156                 else:
2157                     self.failIf(childdata['mutable'])
2158                     self.failUnlessIn("ro_uri", childdata)
2159                     uri_key = "ro_uri"
2160                 self.childuris[k] = to_str(childdata[uri_key])
2161         d.addCallback(_process_directory_json)
2162         # Now build a local directory to copy into place, like the following:
2163         # source1/
2164         # source1/mutable1
2165         # source1/mutable2
2166         # source1/imm1
2167         # source1/imm3
2168         def _build_local_directory(ignored):
2169             source1_path = os.path.join(self.basedir, "source1")
2170             fileutil.make_dirs(source1_path)
2171             for fn in ("mutable1", "mutable2", "imm1", "imm3"):
2172                 fileutil.write(os.path.join(source1_path, fn), fn * 1000)
2173             self.source1_path = source1_path
2174         d.addCallback(_build_local_directory)
2175         d.addCallback(lambda ignored:
2176             self.do_cli("cp", "-r", self.source1_path, "tahoe:test2"))
2177
2178         # We expect that mutable1 and mutable2 are overwritten in-place,
2179         # so they'll retain their URIs but have different content.
2180         def _process_file_json((rc, out, err), fn):
2181             self.failUnlessEqual(rc, 0)
2182             filetype, data = simplejson.loads(out)
2183             self.failUnlessEqual(filetype, "filenode")
2184
2185             if "mutable" in fn:
2186                 self.failUnless(data['mutable'])
2187                 self.failUnlessIn("rw_uri", data)
2188                 self.failUnlessEqual(to_str(data["rw_uri"]), self.childuris[fn])
2189             else:
2190                 self.failIf(data['mutable'])
2191                 self.failUnlessIn("ro_uri", data)
2192                 self.failIfEqual(to_str(data["ro_uri"]), self.childuris[fn])
2193
2194         for fn in ("mutable1", "mutable2"):
2195             d.addCallback(lambda ignored, fn=fn:
2196                 self.do_cli("get", "tahoe:test2/%s" % fn))
2197             d.addCallback(lambda (rc, out, err), fn=fn:
2198                 self.failUnlessEqual(out, fn * 1000))
2199             d.addCallback(lambda ignored, fn=fn:
2200                 self.do_cli("ls", "--json", "tahoe:test2/%s" % fn))
2201             d.addCallback(_process_file_json, fn=fn)
2202
2203         # imm1 should have been replaced, so both its uri and content
2204         # should be different.
2205         d.addCallback(lambda ignored:
2206             self.do_cli("get", "tahoe:test2/imm1"))
2207         d.addCallback(lambda (rc, out, err):
2208             self.failUnlessEqual(out, "imm1" * 1000))
2209         d.addCallback(lambda ignored:
2210             self.do_cli("ls", "--json", "tahoe:test2/imm1"))
2211         d.addCallback(_process_file_json, fn="imm1")
2212
2213         # imm3 should have been created.
2214         d.addCallback(lambda ignored:
2215             self.do_cli("get", "tahoe:test2/imm3"))
2216         d.addCallback(lambda (rc, out, err):
2217             self.failUnlessEqual(out, "imm3" * 1000))
2218
2219         # imm2 should be exactly as we left it, since our newly-copied
2220         # directory didn't contain an imm2 entry.
2221         d.addCallback(lambda ignored:
2222             self.do_cli("get", "tahoe:test2/imm2"))
2223         d.addCallback(lambda (rc, out, err):
2224             self.failUnlessEqual(out, imm_test_txt_contents))
2225         d.addCallback(lambda ignored:
2226             self.do_cli("ls", "--json", "tahoe:test2/imm2"))
2227         def _process_imm2_json((rc, out, err)):
2228             self.failUnlessEqual(rc, 0)
2229             filetype, data = simplejson.loads(out)
2230             self.failUnlessEqual(filetype, "filenode")
2231             self.failIf(data['mutable'])
2232             self.failUnlessIn("ro_uri", data)
2233             self.failUnlessEqual(to_str(data["ro_uri"]), self.childuris["imm2"])
2234         d.addCallback(_process_imm2_json)
2235         return d
2236
2237     def test_cp_overwrite_readonly_mutable_file(self):
2238         # tahoe cp should print an error when asked to overwrite a
2239         # mutable file that it can't overwrite.
2240         self.basedir = "cli/Cp/overwrite_readonly_mutable_file"
2241         self.set_up_grid()
2242
2243         # This is our initial file. We'll link its readcap into the
2244         # tahoe: alias.
2245         test_file_path = os.path.join(self.basedir, "test_file.txt")
2246         test_file_contents = "This is a test file."
2247         fileutil.write(test_file_path, test_file_contents)
2248
2249         # This is our replacement file. We'll try and fail to upload it
2250         # over the readcap that we linked into the tahoe: alias.
2251         replacement_file_path = os.path.join(self.basedir, "replacement.txt")
2252         replacement_file_contents = "These are new contents."
2253         fileutil.write(replacement_file_path, replacement_file_contents)
2254
2255         d = self.do_cli("create-alias", "tahoe:")
2256         d.addCallback(lambda ignored:
2257             self.do_cli("put", "--mutable", test_file_path))
2258         def _get_test_uri((rc, out, err)):
2259             self.failUnlessEqual(rc, 0)
2260             # this should be a write uri
2261             self._test_write_uri = out
2262         d.addCallback(_get_test_uri)
2263         d.addCallback(lambda ignored:
2264             self.do_cli("ls", "--json", self._test_write_uri))
2265         def _process_test_json((rc, out, err)):
2266             self.failUnlessEqual(rc, 0)
2267             filetype, data = simplejson.loads(out)
2268
2269             self.failUnlessEqual(filetype, "filenode")
2270             self.failUnless(data['mutable'])
2271             self.failUnlessIn("ro_uri", data)
2272             self._test_read_uri = to_str(data["ro_uri"])
2273         d.addCallback(_process_test_json)
2274         # Now we'll link the readonly URI into the tahoe: alias.
2275         d.addCallback(lambda ignored:
2276             self.do_cli("ln", self._test_read_uri, "tahoe:test_file.txt"))
2277         d.addCallback(lambda (rc, out, err):
2278             self.failUnlessEqual(rc, 0))
2279         # Let's grab the json of that to make sure that we did it right.
2280         d.addCallback(lambda ignored:
2281             self.do_cli("ls", "--json", "tahoe:"))
2282         def _process_tahoe_json((rc, out, err)):
2283             self.failUnlessEqual(rc, 0)
2284
2285             filetype, data = simplejson.loads(out)
2286             self.failUnlessEqual(filetype, "dirnode")
2287             self.failUnlessIn("children", data)
2288             kiddata = data['children']
2289
2290             self.failUnlessIn("test_file.txt", kiddata)
2291             testtype, testdata = kiddata['test_file.txt']
2292             self.failUnlessEqual(testtype, "filenode")
2293             self.failUnless(testdata['mutable'])
2294             self.failUnlessIn("ro_uri", testdata)
2295             self.failUnlessEqual(to_str(testdata["ro_uri"]), self._test_read_uri)
2296             self.failIfIn("rw_uri", testdata)
2297         d.addCallback(_process_tahoe_json)
2298         # Okay, now we're going to try uploading another mutable file in
2299         # place of that one. We should get an error.
2300         d.addCallback(lambda ignored:
2301             self.do_cli("cp", replacement_file_path, "tahoe:test_file.txt"))
2302         def _check_error_message((rc, out, err)):
2303             self.failUnlessEqual(rc, 1)
2304             self.failUnlessIn("replace or update requested with read-only cap", err)
2305         d.addCallback(_check_error_message)
2306         # Make extra sure that that didn't work.
2307         d.addCallback(lambda ignored:
2308             self.do_cli("get", "tahoe:test_file.txt"))
2309         d.addCallback(lambda (rc, out, err):
2310             self.failUnlessEqual(out, test_file_contents))
2311         d.addCallback(lambda ignored:
2312             self.do_cli("get", self._test_read_uri))
2313         d.addCallback(lambda (rc, out, err):
2314             self.failUnlessEqual(out, test_file_contents))
2315         # Now we'll do it without an explicit destination.
2316         d.addCallback(lambda ignored:
2317             self.do_cli("cp", test_file_path, "tahoe:"))
2318         d.addCallback(_check_error_message)
2319         d.addCallback(lambda ignored:
2320             self.do_cli("get", "tahoe:test_file.txt"))
2321         d.addCallback(lambda (rc, out, err):
2322             self.failUnlessEqual(out, test_file_contents))
2323         d.addCallback(lambda ignored:
2324             self.do_cli("get", self._test_read_uri))
2325         d.addCallback(lambda (rc, out, err):
2326             self.failUnlessEqual(out, test_file_contents))
2327         # Now we'll link a readonly file into a subdirectory.
2328         d.addCallback(lambda ignored:
2329             self.do_cli("mkdir", "tahoe:testdir"))
2330         d.addCallback(lambda (rc, out, err):
2331             self.failUnlessEqual(rc, 0))
2332         d.addCallback(lambda ignored:
2333             self.do_cli("ln", self._test_read_uri, "tahoe:test/file2.txt"))
2334         d.addCallback(lambda (rc, out, err):
2335             self.failUnlessEqual(rc, 0))
2336
2337         test_dir_path = os.path.join(self.basedir, "test")
2338         fileutil.make_dirs(test_dir_path)
2339         for f in ("file1.txt", "file2.txt"):
2340             fileutil.write(os.path.join(test_dir_path, f), f * 10000)
2341
2342         d.addCallback(lambda ignored:
2343             self.do_cli("cp", "-r", test_dir_path, "tahoe:test"))
2344         d.addCallback(_check_error_message)
2345         d.addCallback(lambda ignored:
2346             self.do_cli("ls", "--json", "tahoe:test"))
2347         def _got_testdir_json((rc, out, err)):
2348             self.failUnlessEqual(rc, 0)
2349
2350             filetype, data = simplejson.loads(out)
2351             self.failUnlessEqual(filetype, "dirnode")
2352
2353             self.failUnlessIn("children", data)
2354             childdata = data['children']
2355
2356             self.failUnlessIn("file2.txt", childdata)
2357             file2type, file2data = childdata['file2.txt']
2358             self.failUnlessEqual(file2type, "filenode")
2359             self.failUnless(file2data['mutable'])
2360             self.failUnlessIn("ro_uri", file2data)
2361             self.failUnlessEqual(to_str(file2data["ro_uri"]), self._test_read_uri)
2362             self.failIfIn("rw_uri", file2data)
2363         d.addCallback(_got_testdir_json)
2364         return d
2365
2366
2367 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
2368
2369     def writeto(self, path, data):
2370         full_path = os.path.join(self.basedir, "home", path)
2371         fileutil.make_dirs(os.path.dirname(full_path))
2372         fileutil.write(full_path, data)
2373
2374     def count_output(self, out):
2375         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
2376                         "(\d)+ files skipped, "
2377                         "(\d+) directories created \((\d+) reused\), "
2378                         "(\d+) directories skipped", out)
2379         return [int(s) for s in mo.groups()]
2380
2381     def count_output2(self, out):
2382         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
2383         return [int(s) for s in mo.groups()]
2384
2385     def test_backup(self):
2386         self.basedir = "cli/Backup/backup"
2387         self.set_up_grid()
2388
2389         # is the backupdb available? If so, we test that a second backup does
2390         # not create new directories.
2391         hush = StringIO()
2392         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
2393                                          hush)
2394
2395         # create a small local directory with a couple of files
2396         source = os.path.join(self.basedir, "home")
2397         fileutil.make_dirs(os.path.join(source, "empty"))
2398         self.writeto("parent/subdir/foo.txt", "foo")
2399         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
2400         self.writeto("parent/blah.txt", "blah")
2401
2402         def do_backup(verbose=False):
2403             cmd = ["backup"]
2404             if verbose:
2405                 cmd.append("--verbose")
2406             cmd.append(source)
2407             cmd.append("tahoe:backups")
2408             return self.do_cli(*cmd)
2409
2410         d = self.do_cli("create-alias", "tahoe")
2411
2412         if not have_bdb:
2413             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
2414             def _should_complain((rc, out, err)):
2415                 self.failUnless("I was unable to import a python sqlite library" in err, err)
2416             d.addCallback(_should_complain)
2417             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
2418
2419         d.addCallback(lambda res: do_backup())
2420         def _check0((rc, out, err)):
2421             self.failUnlessReallyEqual(err, "")
2422             self.failUnlessReallyEqual(rc, 0)
2423             fu, fr, fs, dc, dr, ds = self.count_output(out)
2424             # foo.txt, bar.txt, blah.txt
2425             self.failUnlessReallyEqual(fu, 3)
2426             self.failUnlessReallyEqual(fr, 0)
2427             self.failUnlessReallyEqual(fs, 0)
2428             # empty, home, home/parent, home/parent/subdir
2429             self.failUnlessReallyEqual(dc, 4)
2430             self.failUnlessReallyEqual(dr, 0)
2431             self.failUnlessReallyEqual(ds, 0)
2432         d.addCallback(_check0)
2433
2434         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
2435         def _check1((rc, out, err)):
2436             self.failUnlessReallyEqual(err, "")
2437             self.failUnlessReallyEqual(rc, 0)
2438             lines = out.split("\n")
2439             children = dict([line.split() for line in lines if line])
2440             latest_uri = children["Latest"]
2441             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
2442             childnames = children.keys()
2443             self.failUnlessReallyEqual(sorted(childnames), ["Archives", "Latest"])
2444         d.addCallback(_check1)
2445         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
2446         def _check2((rc, out, err)):
2447             self.failUnlessReallyEqual(err, "")
2448             self.failUnlessReallyEqual(rc, 0)
2449             self.failUnlessReallyEqual(sorted(out.split()), ["empty", "parent"])
2450         d.addCallback(_check2)
2451         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
2452         def _check2a((rc, out, err)):
2453             self.failUnlessReallyEqual(err, "")
2454             self.failUnlessReallyEqual(rc, 0)
2455             self.failUnlessReallyEqual(out.strip(), "")
2456         d.addCallback(_check2a)
2457         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2458         def _check3((rc, out, err)):
2459             self.failUnlessReallyEqual(err, "")
2460             self.failUnlessReallyEqual(rc, 0)
2461             self.failUnlessReallyEqual(out, "foo")
2462         d.addCallback(_check3)
2463         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2464         def _check4((rc, out, err)):
2465             self.failUnlessReallyEqual(err, "")
2466             self.failUnlessReallyEqual(rc, 0)
2467             self.old_archives = out.split()
2468             self.failUnlessReallyEqual(len(self.old_archives), 1)
2469         d.addCallback(_check4)
2470
2471
2472         d.addCallback(self.stall, 1.1)
2473         d.addCallback(lambda res: do_backup())
2474         def _check4a((rc, out, err)):
2475             # second backup should reuse everything, if the backupdb is
2476             # available
2477             self.failUnlessReallyEqual(err, "")
2478             self.failUnlessReallyEqual(rc, 0)
2479             if have_bdb:
2480                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2481                 # foo.txt, bar.txt, blah.txt
2482                 self.failUnlessReallyEqual(fu, 0)
2483                 self.failUnlessReallyEqual(fr, 3)
2484                 self.failUnlessReallyEqual(fs, 0)
2485                 # empty, home, home/parent, home/parent/subdir
2486                 self.failUnlessReallyEqual(dc, 0)
2487                 self.failUnlessReallyEqual(dr, 4)
2488                 self.failUnlessReallyEqual(ds, 0)
2489         d.addCallback(_check4a)
2490
2491         if have_bdb:
2492             # sneak into the backupdb, crank back the "last checked"
2493             # timestamp to force a check on all files
2494             def _reset_last_checked(res):
2495                 dbfile = os.path.join(self.get_clientdir(),
2496                                       "private", "backupdb.sqlite")
2497                 self.failUnless(os.path.exists(dbfile), dbfile)
2498                 bdb = backupdb.get_backupdb(dbfile)
2499                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
2500                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
2501                 bdb.connection.commit()
2502
2503             d.addCallback(_reset_last_checked)
2504
2505             d.addCallback(self.stall, 1.1)
2506             d.addCallback(lambda res: do_backup(verbose=True))
2507             def _check4b((rc, out, err)):
2508                 # we should check all files, and re-use all of them. None of
2509                 # the directories should have been changed, so we should
2510                 # re-use all of them too.
2511                 self.failUnlessReallyEqual(err, "")
2512                 self.failUnlessReallyEqual(rc, 0)
2513                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2514                 fchecked, dchecked = self.count_output2(out)
2515                 self.failUnlessReallyEqual(fchecked, 3)
2516                 self.failUnlessReallyEqual(fu, 0)
2517                 self.failUnlessReallyEqual(fr, 3)
2518                 self.failUnlessReallyEqual(fs, 0)
2519                 self.failUnlessReallyEqual(dchecked, 4)
2520                 self.failUnlessReallyEqual(dc, 0)
2521                 self.failUnlessReallyEqual(dr, 4)
2522                 self.failUnlessReallyEqual(ds, 0)
2523             d.addCallback(_check4b)
2524
2525         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2526         def _check5((rc, out, err)):
2527             self.failUnlessReallyEqual(err, "")
2528             self.failUnlessReallyEqual(rc, 0)
2529             self.new_archives = out.split()
2530             expected_new = 2
2531             if have_bdb:
2532                 expected_new += 1
2533             self.failUnlessReallyEqual(len(self.new_archives), expected_new, out)
2534             # the original backup should still be the oldest (i.e. sorts
2535             # alphabetically towards the beginning)
2536             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2537                                  self.old_archives[0])
2538         d.addCallback(_check5)
2539
2540         d.addCallback(self.stall, 1.1)
2541         def _modify(res):
2542             self.writeto("parent/subdir/foo.txt", "FOOF!")
2543             # and turn a file into a directory
2544             os.unlink(os.path.join(source, "parent/blah.txt"))
2545             os.mkdir(os.path.join(source, "parent/blah.txt"))
2546             self.writeto("parent/blah.txt/surprise file", "surprise")
2547             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
2548             # turn a directory into a file
2549             os.rmdir(os.path.join(source, "empty"))
2550             self.writeto("empty", "imagine nothing being here")
2551             return do_backup()
2552         d.addCallback(_modify)
2553         def _check5a((rc, out, err)):
2554             # second backup should reuse bar.txt (if backupdb is available),
2555             # and upload the rest. None of the directories can be reused.
2556             self.failUnlessReallyEqual(err, "")
2557             self.failUnlessReallyEqual(rc, 0)
2558             if have_bdb:
2559                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2560                 # new foo.txt, surprise file, subfile, empty
2561                 self.failUnlessReallyEqual(fu, 4)
2562                 # old bar.txt
2563                 self.failUnlessReallyEqual(fr, 1)
2564                 self.failUnlessReallyEqual(fs, 0)
2565                 # home, parent, subdir, blah.txt, surprisedir
2566                 self.failUnlessReallyEqual(dc, 5)
2567                 self.failUnlessReallyEqual(dr, 0)
2568                 self.failUnlessReallyEqual(ds, 0)
2569         d.addCallback(_check5a)
2570         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2571         def _check6((rc, out, err)):
2572             self.failUnlessReallyEqual(err, "")
2573             self.failUnlessReallyEqual(rc, 0)
2574             self.new_archives = out.split()
2575             expected_new = 3
2576             if have_bdb:
2577                 expected_new += 1
2578             self.failUnlessReallyEqual(len(self.new_archives), expected_new)
2579             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2580                                  self.old_archives[0])
2581         d.addCallback(_check6)
2582         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2583         def _check7((rc, out, err)):
2584             self.failUnlessReallyEqual(err, "")
2585             self.failUnlessReallyEqual(rc, 0)
2586             self.failUnlessReallyEqual(out, "FOOF!")
2587             # the old snapshot should not be modified
2588             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
2589         d.addCallback(_check7)
2590         def _check8((rc, out, err)):
2591             self.failUnlessReallyEqual(err, "")
2592             self.failUnlessReallyEqual(rc, 0)
2593             self.failUnlessReallyEqual(out, "foo")
2594         d.addCallback(_check8)
2595
2596         return d
2597
2598     # on our old dapper buildslave, this test takes a long time (usually
2599     # 130s), so we have to bump up the default 120s timeout. The create-alias
2600     # and initial backup alone take 60s, probably because of the handful of
2601     # dirnodes being created (RSA key generation). The backup between check4
2602     # and check4a takes 6s, as does the backup before check4b.
2603     test_backup.timeout = 3000
2604
2605     def _check_filtering(self, filtered, all, included, excluded):
2606         filtered = set(filtered)
2607         all = set(all)
2608         included = set(included)
2609         excluded = set(excluded)
2610         self.failUnlessReallyEqual(filtered, included)
2611         self.failUnlessReallyEqual(all.difference(filtered), excluded)
2612
2613     def test_exclude_options(self):
2614         root_listdir = (u'lib.a', u'_darcs', u'subdir', u'nice_doc.lyx')
2615         subdir_listdir = (u'another_doc.lyx', u'run_snake_run.py', u'CVS', u'.svn', u'_darcs')
2616         basedir = "cli/Backup/exclude_options"
2617         fileutil.make_dirs(basedir)
2618         nodeurl_path = os.path.join(basedir, 'node.url')
2619         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2620
2621         # test simple exclude
2622         backup_options = cli.BackupOptions()
2623         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2624                                      basedir, 'from', 'to'])
2625         filtered = list(backup_options.filter_listdir(root_listdir))
2626         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2627                               (u'nice_doc.lyx',))
2628         # multiple exclude
2629         backup_options = cli.BackupOptions()
2630         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
2631                                      basedir, 'from', 'to'])
2632         filtered = list(backup_options.filter_listdir(root_listdir))
2633         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2634                               (u'nice_doc.lyx', u'lib.a'))
2635         # vcs metadata exclusion
2636         backup_options = cli.BackupOptions()
2637         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
2638                                      basedir, 'from', 'to'])
2639         filtered = list(backup_options.filter_listdir(subdir_listdir))
2640         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'run_snake_run.py',),
2641                               (u'CVS', u'.svn', u'_darcs'))
2642         # read exclude patterns from file
2643         exclusion_string = "_darcs\n*py\n.svn"
2644         excl_filepath = os.path.join(basedir, 'exclusion')
2645         fileutil.write(excl_filepath, exclusion_string)
2646         backup_options = cli.BackupOptions()
2647         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2648                                      basedir, 'from', 'to'])
2649         filtered = list(backup_options.filter_listdir(subdir_listdir))
2650         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'CVS'),
2651                               (u'.svn', u'_darcs', u'run_snake_run.py'))
2652         # test BackupConfigurationError
2653         self.failUnlessRaises(cli.BackupConfigurationError,
2654                               backup_options.parseOptions,
2655                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
2656                                basedir, 'from', 'to'])
2657
2658         # test that an iterator works too
2659         backup_options = cli.BackupOptions()
2660         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2661                                      basedir, 'from', 'to'])
2662         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2663         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2664                               (u'nice_doc.lyx',))
2665
2666     def test_exclude_options_unicode(self):
2667         nice_doc = u"nice_d\u00F8c.lyx"
2668         try:
2669             doc_pattern_arg = u"*d\u00F8c*".encode(get_io_encoding())
2670         except UnicodeEncodeError:
2671             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
2672
2673         root_listdir = (u'lib.a', u'_darcs', u'subdir', nice_doc)
2674         basedir = "cli/Backup/exclude_options_unicode"
2675         fileutil.make_dirs(basedir)
2676         nodeurl_path = os.path.join(basedir, 'node.url')
2677         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2678
2679         # test simple exclude
2680         backup_options = cli.BackupOptions()
2681         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2682                                      basedir, 'from', 'to'])
2683         filtered = list(backup_options.filter_listdir(root_listdir))
2684         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2685                               (nice_doc,))
2686         # multiple exclude
2687         backup_options = cli.BackupOptions()
2688         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--exclude', 'lib.?', '--node-directory',
2689                                      basedir, 'from', 'to'])
2690         filtered = list(backup_options.filter_listdir(root_listdir))
2691         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2692                              (nice_doc, u'lib.a'))
2693         # read exclude patterns from file
2694         exclusion_string = doc_pattern_arg + "\nlib.?"
2695         excl_filepath = os.path.join(basedir, 'exclusion')
2696         fileutil.write(excl_filepath, exclusion_string)
2697         backup_options = cli.BackupOptions()
2698         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2699                                      basedir, 'from', 'to'])
2700         filtered = list(backup_options.filter_listdir(root_listdir))
2701         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2702                              (nice_doc, u'lib.a'))
2703
2704         # test that an iterator works too
2705         backup_options = cli.BackupOptions()
2706         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2707                                      basedir, 'from', 'to'])
2708         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2709         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2710                               (nice_doc,))
2711
2712     @patch('__builtin__.file')
2713     def test_exclude_from_tilde_expansion(self, mock):
2714         basedir = "cli/Backup/exclude_from_tilde_expansion"
2715         fileutil.make_dirs(basedir)
2716         nodeurl_path = os.path.join(basedir, 'node.url')
2717         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2718
2719         # ensure that tilde expansion is performed on exclude-from argument
2720         exclude_file = u'~/.tahoe/excludes.dummy'
2721         backup_options = cli.BackupOptions()
2722
2723         mock.return_value = StringIO()
2724         backup_options.parseOptions(['--exclude-from', unicode_to_argv(exclude_file),
2725                                      '--node-directory', basedir, 'from', 'to'])
2726         self.failUnlessIn(((abspath_expanduser_unicode(exclude_file),), {}), mock.call_args_list)
2727
2728     def test_ignore_symlinks(self):
2729         if not hasattr(os, 'symlink'):
2730             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
2731
2732         self.basedir = os.path.dirname(self.mktemp())
2733         self.set_up_grid()
2734
2735         source = os.path.join(self.basedir, "home")
2736         self.writeto("foo.txt", "foo")
2737         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
2738
2739         d = self.do_cli("create-alias", "tahoe")
2740         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
2741
2742         def _check((rc, out, err)):
2743             self.failUnlessReallyEqual(rc, 2)
2744             foo2 = os.path.join(source, "foo2.txt")
2745             self.failUnlessReallyEqual(err, "WARNING: cannot backup symlink '%s'\n" % foo2)
2746
2747             fu, fr, fs, dc, dr, ds = self.count_output(out)
2748             # foo.txt
2749             self.failUnlessReallyEqual(fu, 1)
2750             self.failUnlessReallyEqual(fr, 0)
2751             # foo2.txt
2752             self.failUnlessReallyEqual(fs, 1)
2753             # home
2754             self.failUnlessReallyEqual(dc, 1)
2755             self.failUnlessReallyEqual(dr, 0)
2756             self.failUnlessReallyEqual(ds, 0)
2757
2758         d.addCallback(_check)
2759         return d
2760
2761     def test_ignore_unreadable_file(self):
2762         self.basedir = os.path.dirname(self.mktemp())
2763         self.set_up_grid()
2764
2765         source = os.path.join(self.basedir, "home")
2766         self.writeto("foo.txt", "foo")
2767         os.chmod(os.path.join(source, "foo.txt"), 0000)
2768
2769         d = self.do_cli("create-alias", "tahoe")
2770         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2771
2772         def _check((rc, out, err)):
2773             self.failUnlessReallyEqual(rc, 2)
2774             self.failUnlessReallyEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
2775
2776             fu, fr, fs, dc, dr, ds = self.count_output(out)
2777             self.failUnlessReallyEqual(fu, 0)
2778             self.failUnlessReallyEqual(fr, 0)
2779             # foo.txt
2780             self.failUnlessReallyEqual(fs, 1)
2781             # home
2782             self.failUnlessReallyEqual(dc, 1)
2783             self.failUnlessReallyEqual(dr, 0)
2784             self.failUnlessReallyEqual(ds, 0)
2785         d.addCallback(_check)
2786
2787         # This is necessary for the temp files to be correctly removed
2788         def _cleanup(self):
2789             os.chmod(os.path.join(source, "foo.txt"), 0644)
2790         d.addCallback(_cleanup)
2791         d.addErrback(_cleanup)
2792
2793         return d
2794
2795     def test_ignore_unreadable_directory(self):
2796         self.basedir = os.path.dirname(self.mktemp())
2797         self.set_up_grid()
2798
2799         source = os.path.join(self.basedir, "home")
2800         os.mkdir(source)
2801         os.mkdir(os.path.join(source, "test"))
2802         os.chmod(os.path.join(source, "test"), 0000)
2803
2804         d = self.do_cli("create-alias", "tahoe")
2805         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2806
2807         def _check((rc, out, err)):
2808             self.failUnlessReallyEqual(rc, 2)
2809             self.failUnlessReallyEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
2810
2811             fu, fr, fs, dc, dr, ds = self.count_output(out)
2812             self.failUnlessReallyEqual(fu, 0)
2813             self.failUnlessReallyEqual(fr, 0)
2814             self.failUnlessReallyEqual(fs, 0)
2815             # home, test
2816             self.failUnlessReallyEqual(dc, 2)
2817             self.failUnlessReallyEqual(dr, 0)
2818             # test
2819             self.failUnlessReallyEqual(ds, 1)
2820         d.addCallback(_check)
2821
2822         # This is necessary for the temp files to be correctly removed
2823         def _cleanup(self):
2824             os.chmod(os.path.join(source, "test"), 0655)
2825         d.addCallback(_cleanup)
2826         d.addErrback(_cleanup)
2827         return d
2828
2829     def test_backup_without_alias(self):
2830         # 'tahoe backup' should output a sensible error message when invoked
2831         # without an alias instead of a stack trace.
2832         self.basedir = os.path.dirname(self.mktemp())
2833         self.set_up_grid()
2834         source = os.path.join(self.basedir, "file1")
2835         d = self.do_cli('backup', source, source)
2836         def _check((rc, out, err)):
2837             self.failUnlessReallyEqual(rc, 1)
2838             self.failUnlessIn("error:", err)
2839             self.failUnlessReallyEqual(out, "")
2840         d.addCallback(_check)
2841         return d
2842
2843     def test_backup_with_nonexistent_alias(self):
2844         # 'tahoe backup' should output a sensible error message when invoked
2845         # with a nonexistent alias.
2846         self.basedir = os.path.dirname(self.mktemp())
2847         self.set_up_grid()
2848         source = os.path.join(self.basedir, "file1")
2849         d = self.do_cli("backup", source, "nonexistent:" + source)
2850         def _check((rc, out, err)):
2851             self.failUnlessReallyEqual(rc, 1)
2852             self.failUnlessIn("error:", err)
2853             self.failUnlessIn("nonexistent", err)
2854             self.failUnlessReallyEqual(out, "")
2855         d.addCallback(_check)
2856         return d
2857
2858
2859 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
2860
2861     def test_check(self):
2862         self.basedir = "cli/Check/check"
2863         self.set_up_grid()
2864         c0 = self.g.clients[0]
2865         DATA = "data" * 100
2866         DATA_uploadable = MutableData(DATA)
2867         d = c0.create_mutable_file(DATA_uploadable)
2868         def _stash_uri(n):
2869             self.uri = n.get_uri()
2870         d.addCallback(_stash_uri)
2871
2872         d.addCallback(lambda ign: self.do_cli("check", self.uri))
2873         def _check1((rc, out, err)):
2874             self.failUnlessReallyEqual(err, "")
2875             self.failUnlessReallyEqual(rc, 0)
2876             lines = out.splitlines()
2877             self.failUnless("Summary: Healthy" in lines, out)
2878             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2879         d.addCallback(_check1)
2880
2881         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
2882         def _check2((rc, out, err)):
2883             self.failUnlessReallyEqual(err, "")
2884             self.failUnlessReallyEqual(rc, 0)
2885             data = simplejson.loads(out)
2886             self.failUnlessReallyEqual(to_str(data["summary"]), "Healthy")
2887         d.addCallback(_check2)
2888
2889         def _clobber_shares(ignored):
2890             # delete one, corrupt a second
2891             shares = self.find_uri_shares(self.uri)
2892             self.failUnlessReallyEqual(len(shares), 10)
2893             os.unlink(shares[0][2])
2894             cso = debug.CorruptShareOptions()
2895             cso.stdout = StringIO()
2896             cso.parseOptions([shares[1][2]])
2897             storage_index = uri.from_string(self.uri).get_storage_index()
2898             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
2899                                        (base32.b2a(shares[1][1]),
2900                                         base32.b2a(storage_index),
2901                                         shares[1][0])
2902             debug.corrupt_share(cso)
2903         d.addCallback(_clobber_shares)
2904
2905         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
2906         def _check3((rc, out, err)):
2907             self.failUnlessReallyEqual(err, "")
2908             self.failUnlessReallyEqual(rc, 0)
2909             lines = out.splitlines()
2910             summary = [l for l in lines if l.startswith("Summary")][0]
2911             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
2912                             in summary, summary)
2913             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2914             self.failUnless(" corrupt shares:" in lines, out)
2915             self.failUnless(self._corrupt_share_line in lines, out)
2916         d.addCallback(_check3)
2917
2918         d.addCallback(lambda ign:
2919                       self.do_cli("check", "--verify", "--repair", self.uri))
2920         def _check4((rc, out, err)):
2921             self.failUnlessReallyEqual(err, "")
2922             self.failUnlessReallyEqual(rc, 0)
2923             lines = out.splitlines()
2924             self.failUnless("Summary: not healthy" in lines, out)
2925             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2926             self.failUnless(" corrupt shares:" in lines, out)
2927             self.failUnless(self._corrupt_share_line in lines, out)
2928             self.failUnless(" repair successful" in lines, out)
2929         d.addCallback(_check4)
2930
2931         d.addCallback(lambda ign:
2932                       self.do_cli("check", "--verify", "--repair", self.uri))
2933         def _check5((rc, out, err)):
2934             self.failUnlessReallyEqual(err, "")
2935             self.failUnlessReallyEqual(rc, 0)
2936             lines = out.splitlines()
2937             self.failUnless("Summary: healthy" in lines, out)
2938             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2939             self.failIf(" corrupt shares:" in lines, out)
2940         d.addCallback(_check5)
2941
2942         return d
2943
2944     def test_deep_check(self):
2945         self.basedir = "cli/Check/deep_check"
2946         self.set_up_grid()
2947         c0 = self.g.clients[0]
2948         self.uris = {}
2949         self.fileurls = {}
2950         DATA = "data" * 100
2951         quoted_good = quote_output(u"g\u00F6\u00F6d")
2952
2953         d = c0.create_dirnode()
2954         def _stash_root_and_create_file(n):
2955             self.rootnode = n
2956             self.rooturi = n.get_uri()
2957             return n.add_file(u"g\u00F6\u00F6d", upload.Data(DATA, convergence=""))
2958         d.addCallback(_stash_root_and_create_file)
2959         def _stash_uri(fn, which):
2960             self.uris[which] = fn.get_uri()
2961             return fn
2962         d.addCallback(_stash_uri, u"g\u00F6\u00F6d")
2963         d.addCallback(lambda ign:
2964                       self.rootnode.add_file(u"small",
2965                                            upload.Data("literal",
2966                                                         convergence="")))
2967         d.addCallback(_stash_uri, "small")
2968         d.addCallback(lambda ign:
2969             c0.create_mutable_file(MutableData(DATA+"1")))
2970         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
2971         d.addCallback(_stash_uri, "mutable")
2972
2973         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2974         def _check1((rc, out, err)):
2975             self.failUnlessReallyEqual(err, "")
2976             self.failUnlessReallyEqual(rc, 0)
2977             lines = out.splitlines()
2978             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2979                             in lines, out)
2980         d.addCallback(_check1)
2981
2982         # root
2983         # root/g\u00F6\u00F6d
2984         # root/small
2985         # root/mutable
2986
2987         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
2988                                               self.rooturi))
2989         def _check2((rc, out, err)):
2990             self.failUnlessReallyEqual(err, "")
2991             self.failUnlessReallyEqual(rc, 0)
2992             lines = out.splitlines()
2993             self.failUnless("'<root>': Healthy" in lines, out)
2994             self.failUnless("'small': Healthy (LIT)" in lines, out)
2995             self.failUnless((quoted_good + ": Healthy") in lines, out)
2996             self.failUnless("'mutable': Healthy" in lines, out)
2997             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2998                             in lines, out)
2999         d.addCallback(_check2)
3000
3001         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
3002         def _check_stats((rc, out, err)):
3003             self.failUnlessReallyEqual(err, "")
3004             self.failUnlessReallyEqual(rc, 0)
3005             lines = out.splitlines()
3006             self.failUnlessIn(" count-immutable-files: 1", lines)
3007             self.failUnlessIn("   count-mutable-files: 1", lines)
3008             self.failUnlessIn("   count-literal-files: 1", lines)
3009             self.failUnlessIn("     count-directories: 1", lines)
3010             self.failUnlessIn("  size-immutable-files: 400", lines)
3011             self.failUnlessIn("Size Histogram:", lines)
3012             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
3013             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
3014         d.addCallback(_check_stats)
3015
3016         def _clobber_shares(ignored):
3017             shares = self.find_uri_shares(self.uris[u"g\u00F6\u00F6d"])
3018             self.failUnlessReallyEqual(len(shares), 10)
3019             os.unlink(shares[0][2])
3020
3021             shares = self.find_uri_shares(self.uris["mutable"])
3022             cso = debug.CorruptShareOptions()
3023             cso.stdout = StringIO()
3024             cso.parseOptions([shares[1][2]])
3025             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
3026             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
3027                                        (base32.b2a(shares[1][1]),
3028                                         base32.b2a(storage_index),
3029                                         shares[1][0])
3030             debug.corrupt_share(cso)
3031         d.addCallback(_clobber_shares)
3032
3033         # root
3034         # root/g\u00F6\u00F6d  [9 shares]
3035         # root/small
3036         # root/mutable [1 corrupt share]
3037
3038         d.addCallback(lambda ign:
3039                       self.do_cli("deep-check", "--verbose", self.rooturi))
3040         def _check3((rc, out, err)):
3041             self.failUnlessReallyEqual(err, "")
3042             self.failUnlessReallyEqual(rc, 0)
3043             lines = out.splitlines()
3044             self.failUnless("'<root>': Healthy" in lines, out)
3045             self.failUnless("'small': Healthy (LIT)" in lines, out)
3046             self.failUnless("'mutable': Healthy" in lines, out) # needs verifier
3047             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
3048             self.failIf(self._corrupt_share_line in lines, out)
3049             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
3050                             in lines, out)
3051         d.addCallback(_check3)
3052
3053         d.addCallback(lambda ign:
3054                       self.do_cli("deep-check", "--verbose", "--verify",
3055                                   self.rooturi))
3056         def _check4((rc, out, err)):
3057             self.failUnlessReallyEqual(err, "")
3058             self.failUnlessReallyEqual(rc, 0)
3059             lines = out.splitlines()
3060             self.failUnless("'<root>': Healthy" in lines, out)
3061             self.failUnless("'small': Healthy (LIT)" in lines, out)
3062             mutable = [l for l in lines if l.startswith("'mutable'")][0]
3063             self.failUnless(mutable.startswith("'mutable': Unhealthy: 9 shares (enc 3-of-10)"),
3064                             mutable)
3065             self.failUnless(self._corrupt_share_line in lines, out)
3066             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
3067             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
3068                             in lines, out)
3069         d.addCallback(_check4)
3070
3071         d.addCallback(lambda ign:
3072                       self.do_cli("deep-check", "--raw",
3073                                   self.rooturi))
3074         def _check5((rc, out, err)):
3075             self.failUnlessReallyEqual(err, "")
3076             self.failUnlessReallyEqual(rc, 0)
3077             lines = out.splitlines()
3078             units = [simplejson.loads(line) for line in lines]
3079             # root, small, g\u00F6\u00F6d, mutable,  stats
3080             self.failUnlessReallyEqual(len(units), 4+1)
3081         d.addCallback(_check5)
3082
3083         d.addCallback(lambda ign:
3084                       self.do_cli("deep-check",
3085                                   "--verbose", "--verify", "--repair",
3086                                   self.rooturi))
3087         def _check6((rc, out, err)):
3088             self.failUnlessReallyEqual(err, "")
3089             self.failUnlessReallyEqual(rc, 0)
3090             lines = out.splitlines()
3091             self.failUnless("'<root>': healthy" in lines, out)
3092             self.failUnless("'small': healthy" in lines, out)
3093             self.failUnless("'mutable': not healthy" in lines, out)
3094             self.failUnless(self._corrupt_share_line in lines, out)
3095             self.failUnless((quoted_good + ": not healthy") in lines, out)
3096             self.failUnless("done: 4 objects checked" in lines, out)
3097             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
3098             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
3099                             in lines, out)
3100             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
3101         d.addCallback(_check6)
3102
3103         # now add a subdir, and a file below that, then make the subdir
3104         # unrecoverable
3105
3106         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
3107         d.addCallback(_stash_uri, "subdir")
3108         d.addCallback(lambda fn:
3109                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
3110         d.addCallback(lambda ign:
3111                       self.delete_shares_numbered(self.uris["subdir"],
3112                                                   range(10)))
3113
3114         # root
3115         # rootg\u00F6\u00F6d/
3116         # root/small
3117         # root/mutable
3118         # root/subdir [unrecoverable: 0 shares]
3119         # root/subfile
3120
3121         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
3122         def _manifest_failed((rc, out, err)):
3123             self.failIfEqual(rc, 0)
3124             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3125             # the fatal directory should still show up, as the last line
3126             self.failUnlessIn(" subdir\n", out)
3127         d.addCallback(_manifest_failed)
3128
3129         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
3130         def _deep_check_failed((rc, out, err)):
3131             self.failIfEqual(rc, 0)
3132             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3133             # we want to make sure that the error indication is the last
3134             # thing that gets emitted
3135             self.failIf("done:" in out, out)
3136         d.addCallback(_deep_check_failed)
3137
3138         # this test is disabled until the deep-repair response to an
3139         # unrepairable directory is fixed. The failure-to-repair should not
3140         # throw an exception, but the failure-to-traverse that follows
3141         # should throw UnrecoverableFileError.
3142
3143         #d.addCallback(lambda ign:
3144         #              self.do_cli("deep-check", "--repair", self.rooturi))
3145         #def _deep_check_repair_failed((rc, out, err)):
3146         #    self.failIfEqual(rc, 0)
3147         #    print err
3148         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3149         #    self.failIf("done:" in out, out)
3150         #d.addCallback(_deep_check_repair_failed)
3151
3152         return d
3153
3154     def test_check_without_alias(self):
3155         # 'tahoe check' should output a sensible error message if it needs to
3156         # find the default alias and can't
3157         self.basedir = "cli/Check/check_without_alias"
3158         self.set_up_grid()
3159         d = self.do_cli("check")
3160         def _check((rc, out, err)):
3161             self.failUnlessReallyEqual(rc, 1)
3162             self.failUnlessIn("error:", err)
3163             self.failUnlessReallyEqual(out, "")
3164         d.addCallback(_check)
3165         d.addCallback(lambda ign: self.do_cli("deep-check"))
3166         d.addCallback(_check)
3167         return d
3168
3169     def test_check_with_nonexistent_alias(self):
3170         # 'tahoe check' should output a sensible error message if it needs to
3171         # find an alias and can't.
3172         self.basedir = "cli/Check/check_with_nonexistent_alias"
3173         self.set_up_grid()
3174         d = self.do_cli("check", "nonexistent:")
3175         def _check((rc, out, err)):
3176             self.failUnlessReallyEqual(rc, 1)
3177             self.failUnlessIn("error:", err)
3178             self.failUnlessIn("nonexistent", err)
3179             self.failUnlessReallyEqual(out, "")
3180         d.addCallback(_check)
3181         return d
3182
3183
3184 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
3185     def test_get(self):
3186         self.basedir = "cli/Errors/get"
3187         self.set_up_grid()
3188         c0 = self.g.clients[0]
3189         self.fileurls = {}
3190         DATA = "data" * 100
3191         d = c0.upload(upload.Data(DATA, convergence=""))
3192         def _stash_bad(ur):
3193             self.uri_1share = ur.uri
3194             self.delete_shares_numbered(ur.uri, range(1,10))
3195         d.addCallback(_stash_bad)
3196
3197         # the download is abandoned as soon as it's clear that we won't get
3198         # enough shares. The one remaining share might be in either the
3199         # COMPLETE or the PENDING state.
3200         in_complete_msg = "ran out of shares: complete=sh0 pending= overdue= unused= need 3"
3201         in_pending_msg = "ran out of shares: complete= pending=Share(sh0-on-fob7vqgd) overdue= unused= need 3"
3202
3203         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
3204         def _check1((rc, out, err)):
3205             self.failIfEqual(rc, 0)
3206             self.failUnless("410 Gone" in err, err)
3207             self.failUnlessIn("NotEnoughSharesError: ", err)
3208             self.failUnless(in_complete_msg in err or in_pending_msg in err,
3209                             err)
3210         d.addCallback(_check1)
3211
3212         targetf = os.path.join(self.basedir, "output")
3213         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
3214         def _check2((rc, out, err)):
3215             self.failIfEqual(rc, 0)
3216             self.failUnless("410 Gone" in err, err)
3217             self.failUnlessIn("NotEnoughSharesError: ", err)
3218             self.failUnless(in_complete_msg in err or in_pending_msg in err,
3219                             err)
3220             self.failIf(os.path.exists(targetf))
3221         d.addCallback(_check2)
3222
3223         return d
3224
3225
3226 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
3227     def test_get_without_alias(self):
3228         # 'tahoe get' should output a useful error message when invoked
3229         # without an explicit alias and when the default 'tahoe' alias
3230         # hasn't been created yet.
3231         self.basedir = "cli/Get/get_without_alias"
3232         self.set_up_grid()
3233         d = self.do_cli('get', 'file')
3234         def _check((rc, out, err)):
3235             self.failUnlessReallyEqual(rc, 1)
3236             self.failUnlessIn("error:", err)
3237             self.failUnlessReallyEqual(out, "")
3238         d.addCallback(_check)
3239         return d
3240
3241     def test_get_with_nonexistent_alias(self):
3242         # 'tahoe get' should output a useful error message when invoked with
3243         # an explicit alias that doesn't exist.
3244         self.basedir = "cli/Get/get_with_nonexistent_alias"
3245         self.set_up_grid()
3246         d = self.do_cli("get", "nonexistent:file")
3247         def _check((rc, out, err)):
3248             self.failUnlessReallyEqual(rc, 1)
3249             self.failUnlessIn("error:", err)
3250             self.failUnlessIn("nonexistent", err)
3251             self.failUnlessReallyEqual(out, "")
3252         d.addCallback(_check)
3253         return d
3254
3255
3256 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
3257     def test_manifest_without_alias(self):
3258         # 'tahoe manifest' should output a useful error message when invoked
3259         # without an explicit alias when the default 'tahoe' alias is
3260         # missing.
3261         self.basedir = "cli/Manifest/manifest_without_alias"
3262         self.set_up_grid()
3263         d = self.do_cli("manifest")
3264         def _check((rc, out, err)):
3265             self.failUnlessReallyEqual(rc, 1)
3266             self.failUnlessIn("error:", err)
3267             self.failUnlessReallyEqual(out, "")
3268         d.addCallback(_check)
3269         return d
3270
3271     def test_manifest_with_nonexistent_alias(self):
3272         # 'tahoe manifest' should output a useful error message when invoked
3273         # with an explicit alias that doesn't exist.
3274         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
3275         self.set_up_grid()
3276         d = self.do_cli("manifest", "nonexistent:")
3277         def _check((rc, out, err)):
3278             self.failUnlessReallyEqual(rc, 1)
3279             self.failUnlessIn("error:", err)
3280             self.failUnlessIn("nonexistent", err)
3281             self.failUnlessReallyEqual(out, "")
3282         d.addCallback(_check)
3283         return d
3284
3285
3286 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
3287     def test_mkdir(self):
3288         self.basedir = os.path.dirname(self.mktemp())
3289         self.set_up_grid()
3290
3291         d = self.do_cli("create-alias", "tahoe")
3292         d.addCallback(lambda res: self.do_cli("mkdir", "test"))
3293         def _check((rc, out, err)):
3294             self.failUnlessReallyEqual(rc, 0)
3295             self.failUnlessReallyEqual(err, "")
3296             self.failUnlessIn("URI:", out)
3297         d.addCallback(_check)
3298
3299         return d
3300
3301     def test_mkdir_mutable_type(self):
3302         self.basedir = os.path.dirname(self.mktemp())
3303         self.set_up_grid()
3304         d = self.do_cli("create-alias", "tahoe")
3305         def _check((rc, out, err), st):
3306             self.failUnlessReallyEqual(rc, 0)
3307             self.failUnlessReallyEqual(err, "")
3308             self.failUnlessIn(st, out)
3309             return out
3310         def _mkdir(ign, mutable_type, uri_prefix, dirname):
3311             d2 = self.do_cli("mkdir", "--mutable-type="+mutable_type, dirname)
3312             d2.addCallback(_check, uri_prefix)
3313             def _stash_filecap(cap):
3314                 u = uri.from_string(cap)
3315                 fn_uri = u.get_filenode_cap()
3316                 self._filecap = fn_uri.to_string()
3317             d2.addCallback(_stash_filecap)
3318             d2.addCallback(lambda ign: self.do_cli("ls", "--json", dirname))
3319             d2.addCallback(_check, uri_prefix)
3320             d2.addCallback(lambda ign: self.do_cli("ls", "--json", self._filecap))
3321             d2.addCallback(_check, '"format": "%s"' % (mutable_type.lower(),))
3322             return d2
3323
3324         d.addCallback(_mkdir, "sdmf", "URI:DIR2", "tahoe:foo")
3325         d.addCallback(_mkdir, "SDMF", "URI:DIR2", "tahoe:foo2")
3326         d.addCallback(_mkdir, "mdmf", "URI:DIR2-MDMF", "tahoe:bar")
3327         d.addCallback(_mkdir, "MDMF", "URI:DIR2-MDMF", "tahoe:bar2")
3328         return d
3329
3330     def test_mkdir_mutable_type_unlinked(self):
3331         self.basedir = os.path.dirname(self.mktemp())
3332         self.set_up_grid()
3333         d = self.do_cli("mkdir", "--mutable-type=sdmf")
3334         def _check((rc, out, err), st):
3335             self.failUnlessReallyEqual(rc, 0)
3336             self.failUnlessReallyEqual(err, "")
3337             self.failUnlessIn(st, out)
3338             return out
3339         d.addCallback(_check, "URI:DIR2")
3340         def _stash_dircap(cap):
3341             self._dircap = cap
3342             # Now we're going to feed the cap into uri.from_string...
3343             u = uri.from_string(cap)
3344             # ...grab the underlying filenode uri.
3345             fn_uri = u.get_filenode_cap()
3346             # ...and stash that.
3347             self._filecap = fn_uri.to_string()
3348         d.addCallback(_stash_dircap)
3349         d.addCallback(lambda res: self.do_cli("ls", "--json",
3350                                               self._filecap))
3351         d.addCallback(_check, '"format": "sdmf"')
3352         d.addCallback(lambda res: self.do_cli("mkdir", "--mutable-type=mdmf"))
3353         d.addCallback(_check, "URI:DIR2-MDMF")
3354         d.addCallback(_stash_dircap)
3355         d.addCallback(lambda res: self.do_cli("ls", "--json",
3356                                               self._filecap))
3357         d.addCallback(_check, '"format": "mdmf"')
3358         return d
3359
3360     def test_mkdir_bad_mutable_type(self):
3361         o = cli.MakeDirectoryOptions()
3362         self.failUnlessRaises(usage.UsageError,
3363                               o.parseOptions,
3364                               ["--mutable", "--mutable-type=ldmf"])
3365
3366     def test_mkdir_unicode(self):
3367         self.basedir = os.path.dirname(self.mktemp())
3368         self.set_up_grid()
3369
3370         try:
3371             motorhead_arg = u"tahoe:Mot\u00F6rhead".encode(get_io_encoding())
3372         except UnicodeEncodeError:
3373             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
3374
3375         d = self.do_cli("create-alias", "tahoe")
3376         d.addCallback(lambda res: self.do_cli("mkdir", motorhead_arg))
3377         def _check((rc, out, err)):
3378             self.failUnlessReallyEqual(rc, 0)
3379             self.failUnlessReallyEqual(err, "")
3380             self.failUnlessIn("URI:", out)
3381         d.addCallback(_check)
3382
3383         return d
3384
3385     def test_mkdir_with_nonexistent_alias(self):
3386         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
3387         # output a sensible error message rather than a stack trace.
3388         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
3389         self.set_up_grid()
3390         d = self.do_cli("mkdir", "havasu:")
3391         def _check((rc, out, err)):
3392             self.failUnlessReallyEqual(rc, 1)
3393             self.failUnlessIn("error:", err)
3394             self.failUnlessReallyEqual(out, "")
3395         d.addCallback(_check)
3396         return d
3397
3398
3399 class Unlink(GridTestMixin, CLITestMixin, unittest.TestCase):
3400     command = "unlink"
3401
3402     def _create_test_file(self):
3403         data = "puppies" * 1000
3404         path = os.path.join(self.basedir, "datafile")
3405         fileutil.write(path, data)
3406         self.datafile = path
3407
3408     def test_unlink_without_alias(self):
3409         # 'tahoe unlink' should behave sensibly when invoked without an explicit
3410         # alias before the default 'tahoe' alias has been created.
3411         self.basedir = "cli/Unlink/%s_without_alias" % (self.command,)
3412         self.set_up_grid()
3413         d = self.do_cli(self.command, "afile")
3414         def _check((rc, out, err)):
3415             self.failUnlessReallyEqual(rc, 1)
3416             self.failUnlessIn("error:", err)
3417             self.failUnlessReallyEqual(out, "")
3418         d.addCallback(_check)
3419
3420         d.addCallback(lambda ign: self.do_cli(self.command, "afile"))
3421         d.addCallback(_check)
3422         return d
3423
3424     def test_unlink_with_nonexistent_alias(self):
3425         # 'tahoe unlink' should behave sensibly when invoked with an explicit
3426         # alias that doesn't exist.
3427         self.basedir = "cli/Unlink/%s_with_nonexistent_alias" % (self.command,)
3428         self.set_up_grid()
3429         d = self.do_cli(self.command, "nonexistent:afile")
3430         def _check((rc, out, err)):
3431             self.failUnlessReallyEqual(rc, 1)
3432             self.failUnlessIn("error:", err)
3433             self.failUnlessIn("nonexistent", err)
3434             self.failUnlessReallyEqual(out, "")
3435         d.addCallback(_check)
3436
3437         d.addCallback(lambda ign: self.do_cli(self.command, "nonexistent:afile"))
3438         d.addCallback(_check)
3439         return d
3440
3441     def test_unlink_without_path(self):
3442         # 'tahoe unlink' should give a sensible error message when invoked without a path.
3443         self.basedir = "cli/Unlink/%s_without_path" % (self.command,)
3444         self.set_up_grid()
3445         self._create_test_file()
3446         d = self.do_cli("create-alias", "tahoe")
3447         d.addCallback(lambda ign: self.do_cli("put", self.datafile, "tahoe:test"))
3448         def _do_unlink((rc, out, err)):
3449             self.failUnlessReallyEqual(rc, 0)
3450             self.failUnless(out.startswith("URI:"), out)
3451             return self.do_cli(self.command, out.strip('\n'))
3452         d.addCallback(_do_unlink)
3453
3454         def _check((rc, out, err)):
3455             self.failUnlessReallyEqual(rc, 1)
3456             self.failUnlessIn("'tahoe %s'" % (self.command,), err)
3457             self.failUnlessIn("path must be given", err)
3458             self.failUnlessReallyEqual(out, "")
3459         d.addCallback(_check)
3460         return d
3461
3462
3463 class Rm(Unlink):
3464     """Test that 'tahoe rm' behaves in the same way as 'tahoe unlink'."""
3465     command = "rm"
3466
3467
3468 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
3469     def test_empty_directory(self):
3470         self.basedir = "cli/Stats/empty_directory"
3471         self.set_up_grid()
3472         c0 = self.g.clients[0]
3473         self.fileurls = {}
3474         d = c0.create_dirnode()
3475         def _stash_root(n):
3476             self.rootnode = n
3477             self.rooturi = n.get_uri()
3478         d.addCallback(_stash_root)
3479
3480         # make sure we can get stats on an empty directory too
3481         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
3482         def _check_stats((rc, out, err)):
3483             self.failUnlessReallyEqual(err, "")
3484             self.failUnlessReallyEqual(rc, 0)
3485             lines = out.splitlines()
3486             self.failUnlessIn(" count-immutable-files: 0", lines)
3487             self.failUnlessIn("   count-mutable-files: 0", lines)
3488             self.failUnlessIn("   count-literal-files: 0", lines)
3489             self.failUnlessIn("     count-directories: 1", lines)
3490             self.failUnlessIn("  size-immutable-files: 0", lines)
3491             self.failIfIn("Size Histogram:", lines)
3492         d.addCallback(_check_stats)
3493
3494         return d
3495
3496     def test_stats_without_alias(self):
3497         # when invoked with no explicit alias and before the default 'tahoe'
3498         # alias is created, 'tahoe stats' should output an informative error
3499         # message, not a stack trace.
3500         self.basedir = "cli/Stats/stats_without_alias"
3501         self.set_up_grid()
3502         d = self.do_cli("stats")
3503         def _check((rc, out, err)):
3504             self.failUnlessReallyEqual(rc, 1)
3505             self.failUnlessIn("error:", err)
3506             self.failUnlessReallyEqual(out, "")
3507         d.addCallback(_check)
3508         return d
3509
3510     def test_stats_with_nonexistent_alias(self):
3511         # when invoked with an explicit alias that doesn't exist,
3512         # 'tahoe stats' should output a useful error message.
3513         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
3514         self.set_up_grid()
3515         d = self.do_cli("stats", "havasu:")
3516         def _check((rc, out, err)):
3517             self.failUnlessReallyEqual(rc, 1)
3518             self.failUnlessIn("error:", err)
3519             self.failUnlessReallyEqual(out, "")
3520         d.addCallback(_check)
3521         return d
3522
3523
3524 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
3525     def test_webopen_with_nonexistent_alias(self):
3526         # when invoked with an alias that doesn't exist, 'tahoe webopen'
3527         # should output an informative error message instead of a stack
3528         # trace.
3529         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
3530         self.set_up_grid()
3531         d = self.do_cli("webopen", "fake:")
3532         def _check((rc, out, err)):
3533             self.failUnlessReallyEqual(rc, 1)
3534             self.failUnlessIn("error:", err)
3535             self.failUnlessReallyEqual(out, "")
3536         d.addCallback(_check)
3537         return d
3538
3539     def test_webopen(self):
3540         # TODO: replace with @patch that supports Deferreds.
3541         import webbrowser
3542         def call_webbrowser_open(url):
3543             self.failUnlessIn(self.alias_uri.replace(':', '%3A'), url)
3544             self.webbrowser_open_called = True
3545         def _cleanup(res):
3546             webbrowser.open = self.old_webbrowser_open
3547             return res
3548
3549         self.old_webbrowser_open = webbrowser.open
3550         try:
3551             webbrowser.open = call_webbrowser_open
3552
3553             self.basedir = "cli/Webopen/webopen"
3554             self.set_up_grid()
3555             d = self.do_cli("create-alias", "alias:")
3556             def _check_alias((rc, out, err)):
3557                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3558                 self.failUnlessIn("Alias 'alias' created", out)
3559                 self.failUnlessReallyEqual(err, "")
3560                 self.alias_uri = get_aliases(self.get_clientdir())["alias"]
3561             d.addCallback(_check_alias)
3562             d.addCallback(lambda res: self.do_cli("webopen", "alias:"))
3563             def _check_webopen((rc, out, err)):
3564                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3565                 self.failUnlessReallyEqual(out, "")
3566                 self.failUnlessReallyEqual(err, "")
3567                 self.failUnless(self.webbrowser_open_called)
3568             d.addCallback(_check_webopen)
3569             d.addBoth(_cleanup)
3570         except:
3571             _cleanup(None)
3572             raise
3573         return d