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('"mutable-type": "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('"mutable-type": "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         d.addCallback(lambda ignored:
1171             self.do_cli("put", "--mutable", "--mutable-type=mdmf",
1172                         fn1, "tahoe:uploaded.txt"))
1173         d.addCallback(lambda ignored:
1174             self.do_cli("ls", "--json", "tahoe:uploaded.txt"))
1175         d.addCallback(self._check_mdmf_json)
1176         d.addCallback(lambda ignored:
1177             self.do_cli("put", "--mutable", "--mutable-type=sdmf",
1178                         fn1, "tahoe:uploaded2.txt"))
1179         d.addCallback(lambda ignored:
1180             self.do_cli("ls", "--json", "tahoe:uploaded2.txt"))
1181         d.addCallback(self._check_sdmf_json)
1182         return d
1183
1184     def test_mutable_type_unlinked(self):
1185         self.basedir = "cli/Put/mutable_type_unlinked"
1186         self.set_up_grid()
1187         data = "data" * 100000
1188         fn1 = os.path.join(self.basedir, "data")
1189         fileutil.write(fn1, data)
1190         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1191         d.addCallback(lambda (rc, cap, err):
1192             self.do_cli("ls", "--json", cap))
1193         d.addCallback(self._check_mdmf_json)
1194         d.addCallback(lambda ignored:
1195             self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1))
1196         d.addCallback(lambda (rc, cap, err):
1197             self.do_cli("ls", "--json", cap))
1198         d.addCallback(self._check_sdmf_json)
1199         return d
1200
1201     def test_mutable_type_implies_mutable(self):
1202         self.basedir = "cli/Put/mutable_type_implies_mutable"
1203         self.set_up_grid()
1204         data = "data" * 100000
1205         fn1 = os.path.join(self.basedir, "data")
1206         fileutil.write(fn1, data)
1207         d = self.do_cli("put", "--mutable-type=mdmf", fn1)
1208         d.addCallback(lambda (rc, cap, err):
1209             self.do_cli("ls", "--json", cap))
1210         # This will fail if an immutable file is created instead of a
1211         # mutable file.
1212         d.addCallback(self._check_mdmf_json)
1213         d.addCallback(lambda ignored:
1214             self.do_cli("put", "--mutable-type=sdmf", fn1))
1215         d.addCallback(lambda (rc, cap, err):
1216             self.do_cli("ls", "--json", cap))
1217         d.addCallback(self._check_sdmf_json)
1218         return d
1219
1220     def test_put_to_mdmf_cap(self):
1221         self.basedir = "cli/Put/put_to_mdmf_cap"
1222         self.set_up_grid()
1223         data = "data" * 100000
1224         fn1 = os.path.join(self.basedir, "data")
1225         fileutil.write(fn1, data)
1226         d = self.do_cli("put", "--mutable", "--mutable-type=mdmf", fn1)
1227         def _got_cap((rc, out, err)):
1228             self.failUnlessEqual(rc, 0)
1229             self.cap = out
1230         d.addCallback(_got_cap)
1231         # Now try to write something to the cap using put.
1232         data2 = "data2" * 100000
1233         fn2 = os.path.join(self.basedir, "data2")
1234         fileutil.write(fn2, data2)
1235         d.addCallback(lambda ignored:
1236             self.do_cli("put", fn2, self.cap))
1237         def _got_put((rc, out, err)):
1238             self.failUnlessEqual(rc, 0)
1239             self.failUnlessIn(self.cap, out)
1240         d.addCallback(_got_put)
1241         # Now get the cap. We should see the data we just put there.
1242         d.addCallback(lambda ignored:
1243             self.do_cli("get", self.cap))
1244         def _got_data((rc, out, err)):
1245             self.failUnlessEqual(rc, 0)
1246             self.failUnlessEqual(out, data2)
1247         d.addCallback(_got_data)
1248         # Now strip the extension information off of the cap and try
1249         # to put something to it.
1250         def _make_bare_cap(ignored):
1251             cap = self.cap.split(":")
1252             cap = ":".join(cap[:len(cap) - 2])
1253             self.cap = cap
1254         d.addCallback(_make_bare_cap)
1255         data3 = "data3" * 100000
1256         fn3 = os.path.join(self.basedir, "data3")
1257         fileutil.write(fn3, data3)
1258         d.addCallback(lambda ignored:
1259             self.do_cli("put", fn3, self.cap))
1260         d.addCallback(lambda ignored:
1261             self.do_cli("get", self.cap))
1262         def _got_data3((rc, out, err)):
1263             self.failUnlessEqual(rc, 0)
1264             self.failUnlessEqual(out, data3)
1265         d.addCallback(_got_data3)
1266         return d
1267
1268     def test_put_to_sdmf_cap(self):
1269         self.basedir = "cli/Put/put_to_sdmf_cap"
1270         self.set_up_grid()
1271         data = "data" * 100000
1272         fn1 = os.path.join(self.basedir, "data")
1273         fileutil.write(fn1, data)
1274         d = self.do_cli("put", "--mutable", "--mutable-type=sdmf", fn1)
1275         def _got_cap((rc, out, err)):
1276             self.failUnlessEqual(rc, 0)
1277             self.cap = out
1278         d.addCallback(_got_cap)
1279         # Now try to write something to the cap using put.
1280         data2 = "data2" * 100000
1281         fn2 = os.path.join(self.basedir, "data2")
1282         fileutil.write(fn2, data2)
1283         d.addCallback(lambda ignored:
1284             self.do_cli("put", fn2, self.cap))
1285         def _got_put((rc, out, err)):
1286             self.failUnlessEqual(rc, 0)
1287             self.failUnlessIn(self.cap, out)
1288         d.addCallback(_got_put)
1289         # Now get the cap. We should see the data we just put there.
1290         d.addCallback(lambda ignored:
1291             self.do_cli("get", self.cap))
1292         def _got_data((rc, out, err)):
1293             self.failUnlessEqual(rc, 0)
1294             self.failUnlessEqual(out, data2)
1295         d.addCallback(_got_data)
1296         return d
1297
1298     def test_mutable_type_invalid_format(self):
1299         o = cli.PutOptions()
1300         self.failUnlessRaises(usage.UsageError,
1301                               o.parseOptions,
1302                               ["--mutable", "--mutable-type=ldmf"])
1303
1304     def test_put_with_nonexistent_alias(self):
1305         # when invoked with an alias that doesn't exist, 'tahoe put'
1306         # should output a useful error message, not a stack trace
1307         self.basedir = "cli/Put/put_with_nonexistent_alias"
1308         self.set_up_grid()
1309         d = self.do_cli("put", "somefile", "fake:afile")
1310         def _check((rc, out, err)):
1311             self.failUnlessReallyEqual(rc, 1)
1312             self.failUnlessIn("error:", err)
1313             self.failUnlessReallyEqual(out, "")
1314         d.addCallback(_check)
1315         return d
1316
1317     def test_immutable_from_file_unicode(self):
1318         # tahoe put "\u00E0 trier.txt" "\u00E0 trier.txt"
1319
1320         try:
1321             a_trier_arg = u"\u00E0 trier.txt".encode(get_io_encoding())
1322         except UnicodeEncodeError:
1323             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1324
1325         self.skip_if_cannot_represent_filename(u"\u00E0 trier.txt")
1326
1327         self.basedir = "cli/Put/immutable_from_file_unicode"
1328         self.set_up_grid()
1329
1330         rel_fn = os.path.join(unicode(self.basedir), u"\u00E0 trier.txt")
1331         # we make the file small enough to fit in a LIT file, for speed
1332         DATA = "short file"
1333         fileutil.write(rel_fn, DATA)
1334
1335         d = self.do_cli("create-alias", "tahoe")
1336
1337         d.addCallback(lambda res:
1338                       self.do_cli("put", rel_fn.encode(get_io_encoding()), a_trier_arg))
1339         def _uploaded((rc, out, err)):
1340             readcap = out.strip()
1341             self.failUnless(readcap.startswith("URI:LIT:"), readcap)
1342             self.failUnlessIn("201 Created", err)
1343             self.readcap = readcap
1344         d.addCallback(_uploaded)
1345
1346         d.addCallback(lambda res:
1347                       self.do_cli("get", "tahoe:" + a_trier_arg))
1348         d.addCallback(lambda (rc, out, err):
1349                       self.failUnlessReallyEqual(out, DATA))
1350
1351         return d
1352
1353 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
1354     def test_list(self):
1355         self.basedir = "cli/List/list"
1356         self.set_up_grid()
1357         c0 = self.g.clients[0]
1358         small = "small"
1359
1360         # u"g\u00F6\u00F6d" might not be representable in the argv and/or output encodings.
1361         # It is initially included in the directory in any case.
1362         try:
1363             good_arg = u"g\u00F6\u00F6d".encode(get_io_encoding())
1364         except UnicodeEncodeError:
1365             good_arg = None
1366
1367         try:
1368             good_out = u"g\u00F6\u00F6d".encode(get_io_encoding())
1369         except UnicodeEncodeError:
1370             good_out = None
1371
1372         d = c0.create_dirnode()
1373         def _stash_root_and_create_file(n):
1374             self.rootnode = n
1375             self.rooturi = n.get_uri()
1376             return n.add_file(u"g\u00F6\u00F6d", upload.Data(small, convergence=""))
1377         d.addCallback(_stash_root_and_create_file)
1378         def _stash_goodcap(n):
1379             self.goodcap = n.get_uri()
1380         d.addCallback(_stash_goodcap)
1381         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
1382         d.addCallback(lambda n:
1383                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
1384         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
1385         d.addCallback(lambda n:
1386                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
1387         d.addCallback(lambda ign:
1388                       self.do_cli("add-alias", "tahoe", self.rooturi))
1389         d.addCallback(lambda ign: self.do_cli("ls"))
1390         def _check1((rc,out,err)):
1391             if good_out is None:
1392                 self.failUnlessReallyEqual(rc, 1)
1393                 self.failUnlessIn("files whose names could not be converted", err)
1394                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1395                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share"]))
1396             else:
1397                 self.failUnlessReallyEqual(rc, 0)
1398                 self.failUnlessReallyEqual(err, "")
1399                 self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", good_out]))
1400         d.addCallback(_check1)
1401         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
1402         def _check2((rc,out,err)):
1403             self.failIfEqual(rc, 0)
1404             self.failUnlessReallyEqual(err.strip(), "No such file or directory")
1405             self.failUnlessReallyEqual(out, "")
1406         d.addCallback(_check2)
1407         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
1408         def _check3((rc,out,err)):
1409             self.failIfEqual(rc, 0)
1410             self.failUnlessIn("Error during GET: 410 Gone", err)
1411             self.failUnlessIn("UnrecoverableFileError:", err)
1412             self.failUnlessIn("could not be retrieved, because there were "
1413                               "insufficient good shares.", err)
1414             self.failUnlessReallyEqual(out, "")
1415         d.addCallback(_check3)
1416         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
1417         d.addCallback(_check3)
1418         def _check4((rc, out, err)):
1419             if good_out is None:
1420                 self.failUnlessReallyEqual(rc, 1)
1421                 self.failUnlessIn("files whose names could not be converted", err)
1422                 self.failUnlessIn(quote_output(u"g\u00F6\u00F6d"), err)
1423                 self.failUnlessReallyEqual(out, "")
1424             else:
1425                 # listing a file (as dir/filename) should have the edge metadata,
1426                 # including the filename
1427                 self.failUnlessReallyEqual(rc, 0)
1428                 self.failUnlessIn(good_out, out)
1429                 self.failIfIn("-r-- %d -" % len(small), out,
1430                               "trailing hyphen means unknown date")
1431
1432         if good_arg is not None:
1433             d.addCallback(lambda ign: self.do_cli("ls", "-l", good_arg))
1434             d.addCallback(_check4)
1435             # listing a file as $DIRCAP/filename should work just like dir/filename
1436             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/" + good_arg))
1437             d.addCallback(_check4)
1438             # and similarly for $DIRCAP:./filename
1439             d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./" + good_arg))
1440             d.addCallback(_check4)
1441
1442         def _check5((rc, out, err)):
1443             # listing a raw filecap should not explode, but it will have no
1444             # metadata, just the size
1445             self.failUnlessReallyEqual(rc, 0)
1446             self.failUnlessReallyEqual("-r-- %d -" % len(small), out.strip())
1447         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
1448         d.addCallback(_check5)
1449
1450         # Now rename 'g\u00F6\u00F6d' to 'good' and repeat the tests that might have been skipped due
1451         # to encoding problems.
1452         d.addCallback(lambda ign: self.rootnode.move_child_to(u"g\u00F6\u00F6d", self.rootnode, u"good"))
1453
1454         d.addCallback(lambda ign: self.do_cli("ls"))
1455         def _check1_ascii((rc,out,err)):
1456             self.failUnlessReallyEqual(rc, 0)
1457             self.failUnlessReallyEqual(err, "")
1458             self.failUnlessReallyEqual(sorted(out.splitlines()), sorted(["0share", "1share", "good"]))
1459         d.addCallback(_check1_ascii)
1460         def _check4_ascii((rc, out, err)):
1461             # listing a file (as dir/filename) should have the edge metadata,
1462             # including the filename
1463             self.failUnlessReallyEqual(rc, 0)
1464             self.failUnlessIn("good", out)
1465             self.failIfIn("-r-- %d -" % len(small), out,
1466                           "trailing hyphen means unknown date")
1467
1468         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
1469         d.addCallback(_check4_ascii)
1470         # listing a file as $DIRCAP/filename should work just like dir/filename
1471         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
1472         d.addCallback(_check4_ascii)
1473         # and similarly for $DIRCAP:./filename
1474         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
1475         d.addCallback(_check4_ascii)
1476
1477         unknown_immcap = "imm.URI:unknown"
1478         def _create_unknown(ign):
1479             nm = c0.nodemaker
1480             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
1481             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
1482                                                      mutable=False)
1483         d.addCallback(_create_unknown)
1484         def _check6((rc, out, err)):
1485             # listing a directory referencing an unknown object should print
1486             # an extra message to stderr
1487             self.failUnlessReallyEqual(rc, 0)
1488             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
1489             self.failUnlessIn("included unknown objects", err)
1490         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
1491         d.addCallback(_check6)
1492         def _check7((rc, out, err)):
1493             # listing an unknown cap directly should print an extra message
1494             # to stderr (currently this only works if the URI starts with 'URI:'
1495             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
1496             # with an alias).
1497             self.failUnlessReallyEqual(rc, 0)
1498             self.failUnlessIn("?r-- ? -\n", out)
1499             self.failUnlessIn("included unknown objects", err)
1500         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
1501         d.addCallback(_check7)
1502         return d
1503
1504     def test_list_without_alias(self):
1505         # doing just 'tahoe ls' without specifying an alias or first
1506         # doing 'tahoe create-alias tahoe' should fail gracefully.
1507         self.basedir = "cli/List/list_without_alias"
1508         self.set_up_grid()
1509         d = self.do_cli("ls")
1510         def _check((rc, out, err)):
1511             self.failUnlessReallyEqual(rc, 1)
1512             self.failUnlessIn("error:", err)
1513             self.failUnlessReallyEqual(out, "")
1514         d.addCallback(_check)
1515         return d
1516
1517     def test_list_with_nonexistent_alias(self):
1518         # doing 'tahoe ls' while specifying an alias that doesn't already
1519         # exist should fail with an informative error message
1520         self.basedir = "cli/List/list_with_nonexistent_alias"
1521         self.set_up_grid()
1522         d = self.do_cli("ls", "nonexistent:")
1523         def _check((rc, out, err)):
1524             self.failUnlessReallyEqual(rc, 1)
1525             self.failUnlessIn("error:", err)
1526             self.failUnlessIn("nonexistent", err)
1527             self.failUnlessReallyEqual(out, "")
1528         d.addCallback(_check)
1529         return d
1530
1531     def _create_directory_structure(self):
1532         # Create a simple directory structure that we can use for MDMF,
1533         # SDMF, and immutable testing.
1534         assert self.g
1535
1536         client = self.g.clients[0]
1537         # Create a dirnode
1538         d = client.create_dirnode()
1539         def _got_rootnode(n):
1540             # Add a few nodes.
1541             self._dircap = n.get_uri()
1542             nm = n._nodemaker
1543             # The uploaders may run at the same time, so we need two
1544             # MutableData instances or they'll fight over offsets &c and
1545             # break.
1546             mutable_data = MutableData("data" * 100000)
1547             mutable_data2 = MutableData("data" * 100000)
1548             # Add both kinds of mutable node.
1549             d1 = nm.create_mutable_file(mutable_data,
1550                                         version=MDMF_VERSION)
1551             d2 = nm.create_mutable_file(mutable_data2,
1552                                         version=SDMF_VERSION)
1553             # Add an immutable node. We do this through the directory,
1554             # with add_file.
1555             immutable_data = upload.Data("immutable data" * 100000,
1556                                          convergence="")
1557             d3 = n.add_file(u"immutable", immutable_data)
1558             ds = [d1, d2, d3]
1559             dl = defer.DeferredList(ds)
1560             def _made_files((r1, r2, r3)):
1561                 self.failUnless(r1[0])
1562                 self.failUnless(r2[0])
1563                 self.failUnless(r3[0])
1564
1565                 # r1, r2, and r3 contain nodes.
1566                 mdmf_node = r1[1]
1567                 sdmf_node = r2[1]
1568                 imm_node = r3[1]
1569
1570                 self._mdmf_uri = mdmf_node.get_uri()
1571                 self._mdmf_readonly_uri = mdmf_node.get_readonly_uri()
1572                 self._sdmf_uri = mdmf_node.get_uri()
1573                 self._sdmf_readonly_uri = sdmf_node.get_readonly_uri()
1574                 self._imm_uri = imm_node.get_uri()
1575
1576                 d1 = n.set_node(u"mdmf", mdmf_node)
1577                 d2 = n.set_node(u"sdmf", sdmf_node)
1578                 return defer.DeferredList([d1, d2])
1579             # We can now list the directory by listing self._dircap.
1580             dl.addCallback(_made_files)
1581             return dl
1582         d.addCallback(_got_rootnode)
1583         return d
1584
1585     def test_list_mdmf(self):
1586         # 'tahoe ls' should include MDMF files.
1587         self.basedir = "cli/List/list_mdmf"
1588         self.set_up_grid()
1589         d = self._create_directory_structure()
1590         d.addCallback(lambda ignored:
1591             self.do_cli("ls", self._dircap))
1592         def _got_ls((rc, out, err)):
1593             self.failUnlessEqual(rc, 0)
1594             self.failUnlessEqual(err, "")
1595             self.failUnlessIn("immutable", out)
1596             self.failUnlessIn("mdmf", out)
1597             self.failUnlessIn("sdmf", out)
1598         d.addCallback(_got_ls)
1599         return d
1600
1601     def test_list_mdmf_json(self):
1602         # 'tahoe ls' should include MDMF caps when invoked with MDMF
1603         # caps.
1604         self.basedir = "cli/List/list_mdmf_json"
1605         self.set_up_grid()
1606         d = self._create_directory_structure()
1607         d.addCallback(lambda ignored:
1608             self.do_cli("ls", "--json", self._dircap))
1609         def _got_json((rc, out, err)):
1610             self.failUnlessEqual(rc, 0)
1611             self.failUnlessEqual(err, "")
1612             self.failUnlessIn(self._mdmf_uri, out)
1613             self.failUnlessIn(self._mdmf_readonly_uri, out)
1614             self.failUnlessIn(self._sdmf_uri, out)
1615             self.failUnlessIn(self._sdmf_readonly_uri, out)
1616             self.failUnlessIn(self._imm_uri, out)
1617             self.failUnlessIn('"mutable-type": "sdmf"', out)
1618             self.failUnlessIn('"mutable-type": "mdmf"', out)
1619         d.addCallback(_got_json)
1620         return d
1621
1622
1623 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
1624     def test_mv_behavior(self):
1625         self.basedir = "cli/Mv/mv_behavior"
1626         self.set_up_grid()
1627         fn1 = os.path.join(self.basedir, "file1")
1628         DATA1 = "Nuclear launch codes"
1629         fileutil.write(fn1, DATA1)
1630         fn2 = os.path.join(self.basedir, "file2")
1631         DATA2 = "UML diagrams"
1632         fileutil.write(fn2, DATA2)
1633         # copy both files to the grid
1634         d = self.do_cli("create-alias", "tahoe")
1635         d.addCallback(lambda res:
1636             self.do_cli("cp", fn1, "tahoe:"))
1637         d.addCallback(lambda res:
1638             self.do_cli("cp", fn2, "tahoe:"))
1639
1640         # do mv file1 file3
1641         # (we should be able to rename files)
1642         d.addCallback(lambda res:
1643             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1644         d.addCallback(lambda (rc, out, err):
1645             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1646
1647         # do mv file3 file2
1648         # (This should succeed without issue)
1649         d.addCallback(lambda res:
1650             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1651         # Out should contain "OK" to show that the transfer worked.
1652         d.addCallback(lambda (rc,out,err):
1653             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1654
1655         # Next, make a remote directory.
1656         d.addCallback(lambda res:
1657             self.do_cli("mkdir", "tahoe:directory"))
1658
1659         # mv file2 directory
1660         # (should fail with a descriptive error message; the CLI mv
1661         #  client should support this)
1662         d.addCallback(lambda res:
1663             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1664         d.addCallback(lambda (rc, out, err):
1665             self.failUnlessIn(
1666                 "Error: You can't overwrite a directory with a file", err,
1667                 "mv shouldn't overwrite directories" ))
1668
1669         # mv file2 directory/
1670         # (should succeed by making file2 a child node of directory)
1671         d.addCallback(lambda res:
1672             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1673         # We should see an "OK"...
1674         d.addCallback(lambda (rc, out, err):
1675             self.failUnlessIn("OK", out,
1676                             "mv didn't mv a file into a directory"))
1677         # ... and be able to GET the file
1678         d.addCallback(lambda res:
1679             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1680         d.addCallback(lambda (rc, out, err):
1681             self.failUnless(os.path.exists(self.basedir + "new"),
1682                             "mv didn't write the destination file"))
1683         # ... and not find the file where it was before.
1684         d.addCallback(lambda res:
1685             self.do_cli("get", "tahoe:file2", "file2"))
1686         d.addCallback(lambda (rc, out, err):
1687             self.failUnlessIn("404", err,
1688                             "mv left the source file intact"))
1689
1690         # Let's build:
1691         # directory/directory2/some_file
1692         # directory3
1693         d.addCallback(lambda res:
1694             self.do_cli("mkdir", "tahoe:directory/directory2"))
1695         d.addCallback(lambda res:
1696             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1697         d.addCallback(lambda res:
1698             self.do_cli("mkdir", "tahoe:directory3"))
1699
1700         # Let's now try to mv directory/directory2/some_file to
1701         # directory3/some_file
1702         d.addCallback(lambda res:
1703             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1704                         "tahoe:directory3/"))
1705         # We should have just some_file in tahoe:directory3
1706         d.addCallback(lambda res:
1707             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1708         d.addCallback(lambda (rc, out, err):
1709             self.failUnless("404" not in err,
1710                               "mv didn't handle nested directories correctly"))
1711         d.addCallback(lambda res:
1712             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1713         d.addCallback(lambda (rc, out, err):
1714             self.failUnlessIn("404", err,
1715                               "mv moved the wrong thing"))
1716         return d
1717
1718     def test_mv_error_if_DELETE_fails(self):
1719         self.basedir = "cli/Mv/mv_error_if_DELETE_fails"
1720         self.set_up_grid()
1721         fn1 = os.path.join(self.basedir, "file1")
1722         DATA1 = "Nuclear launch codes"
1723         fileutil.write(fn1, DATA1)
1724
1725         original_do_http = tahoe_mv.do_http
1726         def mock_do_http(method, url, body=""):
1727             if method == "DELETE":
1728                 class FakeResponse:
1729                     def read(self):
1730                         return "response"
1731                 resp = FakeResponse()
1732                 resp.status = '500 Something Went Wrong'
1733                 resp.reason = '*shrug*'
1734                 return resp
1735             else:
1736                 return original_do_http(method, url, body=body)
1737         tahoe_mv.do_http = mock_do_http
1738
1739         # copy file to the grid
1740         d = self.do_cli("create-alias", "tahoe")
1741         d.addCallback(lambda res:
1742             self.do_cli("cp", fn1, "tahoe:"))
1743
1744         # do mv file1 file2
1745         d.addCallback(lambda res:
1746             self.do_cli("mv", "tahoe:file1", "tahoe:file2"))
1747         def _check( (rc, out, err) ):
1748             self.failIfIn("OK", out, "mv printed 'OK' even though the DELETE failed")
1749             self.failUnlessEqual(rc, 2)
1750         d.addCallback(_check)
1751
1752         def _restore_do_http(res):
1753             tahoe_mv.do_http = original_do_http
1754             return res
1755         d.addBoth(_restore_do_http)
1756         return d
1757
1758     def test_mv_without_alias(self):
1759         # doing 'tahoe mv' without explicitly specifying an alias or
1760         # creating the default 'tahoe' alias should fail with a useful
1761         # error message.
1762         self.basedir = "cli/Mv/mv_without_alias"
1763         self.set_up_grid()
1764         d = self.do_cli("mv", "afile", "anotherfile")
1765         def _check((rc, out, err)):
1766             self.failUnlessReallyEqual(rc, 1)
1767             self.failUnlessIn("error:", err)
1768             self.failUnlessReallyEqual(out, "")
1769         d.addCallback(_check)
1770         # check to see that the validation extends to the
1771         # target argument by making an alias that will work with the first
1772         # one.
1773         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1774         def _create_a_test_file(ign):
1775             self.test_file_path = os.path.join(self.basedir, "afile")
1776             fileutil.write(self.test_file_path, "puppies" * 100)
1777         d.addCallback(_create_a_test_file)
1778         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1779                                               "havasu:afile"))
1780         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1781                                               "anotherfile"))
1782         d.addCallback(_check)
1783         return d
1784
1785     def test_mv_with_nonexistent_alias(self):
1786         # doing 'tahoe mv' with an alias that doesn't exist should fail
1787         # with an informative error message.
1788         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1789         self.set_up_grid()
1790         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1791         def _check((rc, out, err)):
1792             self.failUnlessReallyEqual(rc, 1)
1793             self.failUnlessIn("error:", err)
1794             self.failUnlessIn("fake", err)
1795             self.failUnlessReallyEqual(out, "")
1796         d.addCallback(_check)
1797         # check to see that the validation extends to the
1798         # target argument by making an alias that will work with the first
1799         # one.
1800         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1801         def _create_a_test_file(ign):
1802             self.test_file_path = os.path.join(self.basedir, "afile")
1803             fileutil.write(self.test_file_path, "puppies" * 100)
1804         d.addCallback(_create_a_test_file)
1805         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1806                                               "havasu:afile"))
1807         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1808                                               "fake:anotherfile"))
1809         d.addCallback(_check)
1810         return d
1811
1812
1813 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1814
1815     def test_not_enough_args(self):
1816         o = cli.CpOptions()
1817         self.failUnlessRaises(usage.UsageError,
1818                               o.parseOptions, ["onearg"])
1819
1820     def test_unicode_filename(self):
1821         self.basedir = "cli/Cp/unicode_filename"
1822
1823         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1824         try:
1825             fn1_arg = fn1.encode(get_io_encoding())
1826             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1827         except UnicodeEncodeError:
1828             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1829
1830         self.skip_if_cannot_represent_filename(fn1)
1831
1832         self.set_up_grid()
1833
1834         DATA1 = "unicode file content"
1835         fileutil.write(fn1, DATA1)
1836
1837         fn2 = os.path.join(self.basedir, "Metallica")
1838         DATA2 = "non-unicode file content"
1839         fileutil.write(fn2, DATA2)
1840
1841         d = self.do_cli("create-alias", "tahoe")
1842
1843         d.addCallback(lambda res: self.do_cli("cp", fn1_arg, "tahoe:"))
1844
1845         d.addCallback(lambda res: self.do_cli("get", "tahoe:" + artonwall_arg))
1846         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA1))
1847
1848         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1849
1850         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1851         d.addCallback(lambda (rc,out,err): self.failUnlessReallyEqual(out, DATA2))
1852
1853         d.addCallback(lambda res: self.do_cli("ls", "tahoe:"))
1854         def _check((rc, out, err)):
1855             try:
1856                 unicode_to_output(u"\u00C4rtonwall")
1857             except UnicodeEncodeError:
1858                 self.failUnlessReallyEqual(rc, 1)
1859                 self.failUnlessReallyEqual(out, "Metallica\n")
1860                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
1861                 self.failUnlessIn("files whose names could not be converted", err)
1862             else:
1863                 self.failUnlessReallyEqual(rc, 0)
1864                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"Metallica\n\u00C4rtonwall\n")
1865                 self.failUnlessReallyEqual(err, "")
1866         d.addCallback(_check)
1867
1868         return d
1869
1870     def test_dangling_symlink_vs_recursion(self):
1871         if not hasattr(os, 'symlink'):
1872             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
1873
1874         # cp -r on a directory containing a dangling symlink shouldn't assert
1875         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1876         self.set_up_grid()
1877         dn = os.path.join(self.basedir, "dir")
1878         os.mkdir(dn)
1879         fn = os.path.join(dn, "Fakebandica")
1880         ln = os.path.join(dn, "link")
1881         os.symlink(fn, ln)
1882
1883         d = self.do_cli("create-alias", "tahoe")
1884         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1885                                               dn, "tahoe:"))
1886         return d
1887
1888     def test_copy_using_filecap(self):
1889         self.basedir = "cli/Cp/test_copy_using_filecap"
1890         self.set_up_grid()
1891         outdir = os.path.join(self.basedir, "outdir")
1892         os.mkdir(outdir)
1893         fn1 = os.path.join(self.basedir, "Metallica")
1894         fn2 = os.path.join(outdir, "Not Metallica")
1895         fn3 = os.path.join(outdir, "test2")
1896         DATA1 = "puppies" * 10000
1897         fileutil.write(fn1, DATA1)
1898
1899         d = self.do_cli("create-alias", "tahoe")
1900         d.addCallback(lambda ign: self.do_cli("put", fn1))
1901         def _put_file((rc, out, err)):
1902             self.failUnlessReallyEqual(rc, 0)
1903             self.failUnlessIn("200 OK", err)
1904             # keep track of the filecap
1905             self.filecap = out.strip()
1906         d.addCallback(_put_file)
1907
1908         # Let's try copying this to the disk using the filecap
1909         #  cp FILECAP filename
1910         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1911         def _copy_file((rc, out, err)):
1912             self.failUnlessReallyEqual(rc, 0)
1913             results = fileutil.read(fn2)
1914             self.failUnlessReallyEqual(results, DATA1)
1915         d.addCallback(_copy_file)
1916
1917         # Test with ./ (see #761)
1918         #  cp FILECAP localdir
1919         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1920         def _resp((rc, out, err)):
1921             self.failUnlessReallyEqual(rc, 1)
1922             self.failUnlessIn("error: you must specify a destination filename",
1923                               err)
1924             self.failUnlessReallyEqual(out, "")
1925         d.addCallback(_resp)
1926
1927         # Create a directory, linked at tahoe:test
1928         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1929         def _get_dir((rc, out, err)):
1930             self.failUnlessReallyEqual(rc, 0)
1931             self.dircap = out.strip()
1932         d.addCallback(_get_dir)
1933
1934         # Upload a file to the directory
1935         d.addCallback(lambda ign:
1936                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1937         d.addCallback(lambda (rc, out, err): self.failUnlessReallyEqual(rc, 0))
1938
1939         #  cp DIRCAP/filename localdir
1940         d.addCallback(lambda ign:
1941                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1942         def _get_resp((rc, out, err)):
1943             self.failUnlessReallyEqual(rc, 0)
1944             results = fileutil.read(os.path.join(outdir, "test_file"))
1945             self.failUnlessReallyEqual(results, DATA1)
1946         d.addCallback(_get_resp)
1947
1948         #  cp -r DIRCAP/filename filename2
1949         d.addCallback(lambda ign:
1950                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1951         def _get_resp2((rc, out, err)):
1952             self.failUnlessReallyEqual(rc, 0)
1953             results = fileutil.read(fn3)
1954             self.failUnlessReallyEqual(results, DATA1)
1955         d.addCallback(_get_resp2)
1956         return d
1957
1958     def test_cp_with_nonexistent_alias(self):
1959         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1960         # should output a sensible error message rather than a stack trace.
1961         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1962         self.set_up_grid()
1963         d = self.do_cli("cp", "fake:file1", "fake:file2")
1964         def _check((rc, out, err)):
1965             self.failUnlessReallyEqual(rc, 1)
1966             self.failUnlessIn("error:", err)
1967         d.addCallback(_check)
1968         # 'tahoe cp' actually processes the target argument first, so we need
1969         # to check to make sure that validation extends to the source
1970         # argument.
1971         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1972         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1973                                               "tahoe:file2"))
1974         d.addCallback(_check)
1975         return d
1976
1977     def test_unicode_dirnames(self):
1978         self.basedir = "cli/Cp/unicode_dirnames"
1979
1980         fn1 = os.path.join(unicode(self.basedir), u"\u00C4rtonwall")
1981         try:
1982             fn1_arg = fn1.encode(get_io_encoding())
1983             del fn1_arg # hush pyflakes
1984             artonwall_arg = u"\u00C4rtonwall".encode(get_io_encoding())
1985         except UnicodeEncodeError:
1986             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
1987
1988         self.skip_if_cannot_represent_filename(fn1)
1989
1990         self.set_up_grid()
1991
1992         d = self.do_cli("create-alias", "tahoe")
1993         d.addCallback(lambda res: self.do_cli("mkdir", "tahoe:test/" + artonwall_arg))
1994         d.addCallback(lambda res: self.do_cli("cp", "-r", "tahoe:test", "tahoe:test2"))
1995         d.addCallback(lambda res: self.do_cli("ls", "tahoe:test2"))
1996         def _check((rc, out, err)):
1997             try:
1998                 unicode_to_output(u"\u00C4rtonwall")
1999             except UnicodeEncodeError:
2000                 self.failUnlessReallyEqual(rc, 1)
2001                 self.failUnlessReallyEqual(out, "")
2002                 self.failUnlessIn(quote_output(u"\u00C4rtonwall"), err)
2003                 self.failUnlessIn("files whose names could not be converted", err)
2004             else:
2005                 self.failUnlessReallyEqual(rc, 0)
2006                 self.failUnlessReallyEqual(out.decode(get_io_encoding()), u"\u00C4rtonwall\n")
2007                 self.failUnlessReallyEqual(err, "")
2008         d.addCallback(_check)
2009
2010         return d
2011
2012     def test_cp_replaces_mutable_file_contents(self):
2013         self.basedir = "cli/Cp/cp_replaces_mutable_file_contents"
2014         self.set_up_grid()
2015
2016         # Write a test file, which we'll copy to the grid.
2017         test_txt_path = os.path.join(self.basedir, "test.txt")
2018         test_txt_contents = "foo bar baz"
2019         f = open(test_txt_path, "w")
2020         f.write(test_txt_contents)
2021         f.close()
2022
2023         d = self.do_cli("create-alias", "tahoe")
2024         d.addCallback(lambda ignored:
2025             self.do_cli("mkdir", "tahoe:test"))
2026         # We have to use 'tahoe put' here because 'tahoe cp' doesn't
2027         # know how to make mutable files at the destination.
2028         d.addCallback(lambda ignored:
2029             self.do_cli("put", "--mutable", test_txt_path, "tahoe:test/test.txt"))
2030         d.addCallback(lambda ignored:
2031             self.do_cli("get", "tahoe:test/test.txt"))
2032         def _check((rc, out, err)):
2033             self.failUnlessEqual(rc, 0)
2034             self.failUnlessEqual(out, test_txt_contents)
2035         d.addCallback(_check)
2036
2037         # We'll do ls --json to get the read uri and write uri for the
2038         # file we've just uploaded.
2039         d.addCallback(lambda ignored:
2040             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2041         def _get_test_txt_uris((rc, out, err)):
2042             self.failUnlessEqual(rc, 0)
2043             filetype, data = simplejson.loads(out)
2044
2045             self.failUnlessEqual(filetype, "filenode")
2046             self.failUnless(data['mutable'])
2047
2048             self.failUnlessIn("rw_uri", data)
2049             self.rw_uri = to_str(data["rw_uri"])
2050             self.failUnlessIn("ro_uri", data)
2051             self.ro_uri = to_str(data["ro_uri"])
2052         d.addCallback(_get_test_txt_uris)
2053
2054         # Now make a new file to copy in place of test.txt.
2055         new_txt_path = os.path.join(self.basedir, "new.txt")
2056         new_txt_contents = "baz bar foo" * 100000
2057         f = open(new_txt_path, "w")
2058         f.write(new_txt_contents)
2059         f.close()
2060
2061         # Copy the new file on top of the old file.
2062         d.addCallback(lambda ignored:
2063             self.do_cli("cp", new_txt_path, "tahoe:test/test.txt"))
2064
2065         # If we get test.txt now, we should see the new data.
2066         d.addCallback(lambda ignored:
2067             self.do_cli("get", "tahoe:test/test.txt"))
2068         d.addCallback(lambda (rc, out, err):
2069             self.failUnlessEqual(out, new_txt_contents))
2070         # If we get the json of the new file, we should see that the old
2071         # uri is there
2072         d.addCallback(lambda ignored:
2073             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2074         def _check_json((rc, out, err)):
2075             self.failUnlessEqual(rc, 0)
2076             filetype, data = simplejson.loads(out)
2077
2078             self.failUnlessEqual(filetype, "filenode")
2079             self.failUnless(data['mutable'])
2080
2081             self.failUnlessIn("ro_uri", data)
2082             self.failUnlessEqual(to_str(data["ro_uri"]), self.ro_uri)
2083             self.failUnlessIn("rw_uri", data)
2084             self.failUnlessEqual(to_str(data["rw_uri"]), self.rw_uri)
2085         d.addCallback(_check_json)
2086
2087         # and, finally, doing a GET directly on one of the old uris
2088         # should give us the new contents.
2089         d.addCallback(lambda ignored:
2090             self.do_cli("get", self.rw_uri))
2091         d.addCallback(lambda (rc, out, err):
2092             self.failUnlessEqual(out, new_txt_contents))
2093         # Now copy the old test.txt without an explicit destination
2094         # file. tahoe cp will match it to the existing file and
2095         # overwrite it appropriately.
2096         d.addCallback(lambda ignored:
2097             self.do_cli("cp", test_txt_path, "tahoe:test"))
2098         d.addCallback(lambda ignored:
2099             self.do_cli("get", "tahoe:test/test.txt"))
2100         d.addCallback(lambda (rc, out, err):
2101             self.failUnlessEqual(out, test_txt_contents))
2102         d.addCallback(lambda ignored:
2103             self.do_cli("ls", "--json", "tahoe:test/test.txt"))
2104         d.addCallback(_check_json)
2105         d.addCallback(lambda ignored:
2106             self.do_cli("get", self.rw_uri))
2107         d.addCallback(lambda (rc, out, err):
2108             self.failUnlessEqual(out, test_txt_contents))
2109
2110         # Now we'll make a more complicated directory structure.
2111         # test2/
2112         # test2/mutable1
2113         # test2/mutable2
2114         # test2/imm1
2115         # test2/imm2
2116         imm_test_txt_path = os.path.join(self.basedir, "imm_test.txt")
2117         imm_test_txt_contents = test_txt_contents * 10000
2118         fileutil.write(imm_test_txt_path, imm_test_txt_contents)
2119         d.addCallback(lambda ignored:
2120             self.do_cli("mkdir", "tahoe:test2"))
2121         d.addCallback(lambda ignored:
2122             self.do_cli("put", "--mutable", new_txt_path,
2123                         "tahoe:test2/mutable1"))
2124         d.addCallback(lambda ignored:
2125             self.do_cli("put", "--mutable", new_txt_path,
2126                         "tahoe:test2/mutable2"))
2127         d.addCallback(lambda ignored:
2128             self.do_cli('put', new_txt_path, "tahoe:test2/imm1"))
2129         d.addCallback(lambda ignored:
2130             self.do_cli("put", imm_test_txt_path, "tahoe:test2/imm2"))
2131         d.addCallback(lambda ignored:
2132             self.do_cli("ls", "--json", "tahoe:test2"))
2133         def _process_directory_json((rc, out, err)):
2134             self.failUnlessEqual(rc, 0)
2135
2136             filetype, data = simplejson.loads(out)
2137             self.failUnlessEqual(filetype, "dirnode")
2138             self.failUnless(data['mutable'])
2139             self.failUnlessIn("children", data)
2140             children = data['children']
2141
2142             # Store the URIs for later use.
2143             self.childuris = {}
2144             for k in ["mutable1", "mutable2", "imm1", "imm2"]:
2145                 self.failUnlessIn(k, children)
2146                 childtype, childdata = children[k]
2147                 self.failUnlessEqual(childtype, "filenode")
2148                 if "mutable" in k:
2149                     self.failUnless(childdata['mutable'])
2150                     self.failUnlessIn("rw_uri", childdata)
2151                     uri_key = "rw_uri"
2152                 else:
2153                     self.failIf(childdata['mutable'])
2154                     self.failUnlessIn("ro_uri", childdata)
2155                     uri_key = "ro_uri"
2156                 self.childuris[k] = to_str(childdata[uri_key])
2157         d.addCallback(_process_directory_json)
2158         # Now build a local directory to copy into place, like the following:
2159         # source1/
2160         # source1/mutable1
2161         # source1/mutable2
2162         # source1/imm1
2163         # source1/imm3
2164         def _build_local_directory(ignored):
2165             source1_path = os.path.join(self.basedir, "source1")
2166             fileutil.make_dirs(source1_path)
2167             for fn in ("mutable1", "mutable2", "imm1", "imm3"):
2168                 fileutil.write(os.path.join(source1_path, fn), fn * 1000)
2169             self.source1_path = source1_path
2170         d.addCallback(_build_local_directory)
2171         d.addCallback(lambda ignored:
2172             self.do_cli("cp", "-r", self.source1_path, "tahoe:test2"))
2173
2174         # We expect that mutable1 and mutable2 are overwritten in-place,
2175         # so they'll retain their URIs but have different content.
2176         def _process_file_json((rc, out, err), fn):
2177             self.failUnlessEqual(rc, 0)
2178             filetype, data = simplejson.loads(out)
2179             self.failUnlessEqual(filetype, "filenode")
2180
2181             if "mutable" in fn:
2182                 self.failUnless(data['mutable'])
2183                 self.failUnlessIn("rw_uri", data)
2184                 self.failUnlessEqual(to_str(data["rw_uri"]), self.childuris[fn])
2185             else:
2186                 self.failIf(data['mutable'])
2187                 self.failUnlessIn("ro_uri", data)
2188                 self.failIfEqual(to_str(data["ro_uri"]), self.childuris[fn])
2189
2190         for fn in ("mutable1", "mutable2"):
2191             d.addCallback(lambda ignored, fn=fn:
2192                 self.do_cli("get", "tahoe:test2/%s" % fn))
2193             d.addCallback(lambda (rc, out, err), fn=fn:
2194                 self.failUnlessEqual(out, fn * 1000))
2195             d.addCallback(lambda ignored, fn=fn:
2196                 self.do_cli("ls", "--json", "tahoe:test2/%s" % fn))
2197             d.addCallback(_process_file_json, fn=fn)
2198
2199         # imm1 should have been replaced, so both its uri and content
2200         # should be different.
2201         d.addCallback(lambda ignored:
2202             self.do_cli("get", "tahoe:test2/imm1"))
2203         d.addCallback(lambda (rc, out, err):
2204             self.failUnlessEqual(out, "imm1" * 1000))
2205         d.addCallback(lambda ignored:
2206             self.do_cli("ls", "--json", "tahoe:test2/imm1"))
2207         d.addCallback(_process_file_json, fn="imm1")
2208
2209         # imm3 should have been created.
2210         d.addCallback(lambda ignored:
2211             self.do_cli("get", "tahoe:test2/imm3"))
2212         d.addCallback(lambda (rc, out, err):
2213             self.failUnlessEqual(out, "imm3" * 1000))
2214
2215         # imm2 should be exactly as we left it, since our newly-copied
2216         # directory didn't contain an imm2 entry.
2217         d.addCallback(lambda ignored:
2218             self.do_cli("get", "tahoe:test2/imm2"))
2219         d.addCallback(lambda (rc, out, err):
2220             self.failUnlessEqual(out, imm_test_txt_contents))
2221         d.addCallback(lambda ignored:
2222             self.do_cli("ls", "--json", "tahoe:test2/imm2"))
2223         def _process_imm2_json((rc, out, err)):
2224             self.failUnlessEqual(rc, 0)
2225             filetype, data = simplejson.loads(out)
2226             self.failUnlessEqual(filetype, "filenode")
2227             self.failIf(data['mutable'])
2228             self.failUnlessIn("ro_uri", data)
2229             self.failUnlessEqual(to_str(data["ro_uri"]), self.childuris["imm2"])
2230         d.addCallback(_process_imm2_json)
2231         return d
2232
2233     def test_cp_overwrite_readonly_mutable_file(self):
2234         # tahoe cp should print an error when asked to overwrite a
2235         # mutable file that it can't overwrite.
2236         self.basedir = "cli/Cp/overwrite_readonly_mutable_file"
2237         self.set_up_grid()
2238
2239         # This is our initial file. We'll link its readcap into the
2240         # tahoe: alias.
2241         test_file_path = os.path.join(self.basedir, "test_file.txt")
2242         test_file_contents = "This is a test file."
2243         fileutil.write(test_file_path, test_file_contents)
2244
2245         # This is our replacement file. We'll try and fail to upload it
2246         # over the readcap that we linked into the tahoe: alias.
2247         replacement_file_path = os.path.join(self.basedir, "replacement.txt")
2248         replacement_file_contents = "These are new contents."
2249         fileutil.write(replacement_file_path, replacement_file_contents)
2250
2251         d = self.do_cli("create-alias", "tahoe:")
2252         d.addCallback(lambda ignored:
2253             self.do_cli("put", "--mutable", test_file_path))
2254         def _get_test_uri((rc, out, err)):
2255             self.failUnlessEqual(rc, 0)
2256             # this should be a write uri
2257             self._test_write_uri = out
2258         d.addCallback(_get_test_uri)
2259         d.addCallback(lambda ignored:
2260             self.do_cli("ls", "--json", self._test_write_uri))
2261         def _process_test_json((rc, out, err)):
2262             self.failUnlessEqual(rc, 0)
2263             filetype, data = simplejson.loads(out)
2264
2265             self.failUnlessEqual(filetype, "filenode")
2266             self.failUnless(data['mutable'])
2267             self.failUnlessIn("ro_uri", data)
2268             self._test_read_uri = to_str(data["ro_uri"])
2269         d.addCallback(_process_test_json)
2270         # Now we'll link the readonly URI into the tahoe: alias.
2271         d.addCallback(lambda ignored:
2272             self.do_cli("ln", self._test_read_uri, "tahoe:test_file.txt"))
2273         d.addCallback(lambda (rc, out, err):
2274             self.failUnlessEqual(rc, 0))
2275         # Let's grab the json of that to make sure that we did it right.
2276         d.addCallback(lambda ignored:
2277             self.do_cli("ls", "--json", "tahoe:"))
2278         def _process_tahoe_json((rc, out, err)):
2279             self.failUnlessEqual(rc, 0)
2280
2281             filetype, data = simplejson.loads(out)
2282             self.failUnlessEqual(filetype, "dirnode")
2283             self.failUnlessIn("children", data)
2284             kiddata = data['children']
2285
2286             self.failUnlessIn("test_file.txt", kiddata)
2287             testtype, testdata = kiddata['test_file.txt']
2288             self.failUnlessEqual(testtype, "filenode")
2289             self.failUnless(testdata['mutable'])
2290             self.failUnlessIn("ro_uri", testdata)
2291             self.failUnlessEqual(to_str(testdata["ro_uri"]), self._test_read_uri)
2292             self.failIfIn("rw_uri", testdata)
2293         d.addCallback(_process_tahoe_json)
2294         # Okay, now we're going to try uploading another mutable file in
2295         # place of that one. We should get an error.
2296         d.addCallback(lambda ignored:
2297             self.do_cli("cp", replacement_file_path, "tahoe:test_file.txt"))
2298         def _check_error_message((rc, out, err)):
2299             self.failUnlessEqual(rc, 1)
2300             self.failUnlessIn("replace or update requested with read-only cap", err)
2301         d.addCallback(_check_error_message)
2302         # Make extra sure that that didn't work.
2303         d.addCallback(lambda ignored:
2304             self.do_cli("get", "tahoe:test_file.txt"))
2305         d.addCallback(lambda (rc, out, err):
2306             self.failUnlessEqual(out, test_file_contents))
2307         d.addCallback(lambda ignored:
2308             self.do_cli("get", self._test_read_uri))
2309         d.addCallback(lambda (rc, out, err):
2310             self.failUnlessEqual(out, test_file_contents))
2311         # Now we'll do it without an explicit destination.
2312         d.addCallback(lambda ignored:
2313             self.do_cli("cp", test_file_path, "tahoe:"))
2314         d.addCallback(_check_error_message)
2315         d.addCallback(lambda ignored:
2316             self.do_cli("get", "tahoe:test_file.txt"))
2317         d.addCallback(lambda (rc, out, err):
2318             self.failUnlessEqual(out, test_file_contents))
2319         d.addCallback(lambda ignored:
2320             self.do_cli("get", self._test_read_uri))
2321         d.addCallback(lambda (rc, out, err):
2322             self.failUnlessEqual(out, test_file_contents))
2323         # Now we'll link a readonly file into a subdirectory.
2324         d.addCallback(lambda ignored:
2325             self.do_cli("mkdir", "tahoe:testdir"))
2326         d.addCallback(lambda (rc, out, err):
2327             self.failUnlessEqual(rc, 0))
2328         d.addCallback(lambda ignored:
2329             self.do_cli("ln", self._test_read_uri, "tahoe:test/file2.txt"))
2330         d.addCallback(lambda (rc, out, err):
2331             self.failUnlessEqual(rc, 0))
2332
2333         test_dir_path = os.path.join(self.basedir, "test")
2334         fileutil.make_dirs(test_dir_path)
2335         for f in ("file1.txt", "file2.txt"):
2336             fileutil.write(os.path.join(test_dir_path, f), f * 10000)
2337
2338         d.addCallback(lambda ignored:
2339             self.do_cli("cp", "-r", test_dir_path, "tahoe:test"))
2340         d.addCallback(_check_error_message)
2341         d.addCallback(lambda ignored:
2342             self.do_cli("ls", "--json", "tahoe:test"))
2343         def _got_testdir_json((rc, out, err)):
2344             self.failUnlessEqual(rc, 0)
2345
2346             filetype, data = simplejson.loads(out)
2347             self.failUnlessEqual(filetype, "dirnode")
2348
2349             self.failUnlessIn("children", data)
2350             childdata = data['children']
2351
2352             self.failUnlessIn("file2.txt", childdata)
2353             file2type, file2data = childdata['file2.txt']
2354             self.failUnlessEqual(file2type, "filenode")
2355             self.failUnless(file2data['mutable'])
2356             self.failUnlessIn("ro_uri", file2data)
2357             self.failUnlessEqual(to_str(file2data["ro_uri"]), self._test_read_uri)
2358             self.failIfIn("rw_uri", file2data)
2359         d.addCallback(_got_testdir_json)
2360         return d
2361
2362
2363 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
2364
2365     def writeto(self, path, data):
2366         full_path = os.path.join(self.basedir, "home", path)
2367         fileutil.make_dirs(os.path.dirname(full_path))
2368         fileutil.write(full_path, data)
2369
2370     def count_output(self, out):
2371         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
2372                         "(\d)+ files skipped, "
2373                         "(\d+) directories created \((\d+) reused\), "
2374                         "(\d+) directories skipped", out)
2375         return [int(s) for s in mo.groups()]
2376
2377     def count_output2(self, out):
2378         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
2379         return [int(s) for s in mo.groups()]
2380
2381     def test_backup(self):
2382         self.basedir = "cli/Backup/backup"
2383         self.set_up_grid()
2384
2385         # is the backupdb available? If so, we test that a second backup does
2386         # not create new directories.
2387         hush = StringIO()
2388         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
2389                                          hush)
2390
2391         # create a small local directory with a couple of files
2392         source = os.path.join(self.basedir, "home")
2393         fileutil.make_dirs(os.path.join(source, "empty"))
2394         self.writeto("parent/subdir/foo.txt", "foo")
2395         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
2396         self.writeto("parent/blah.txt", "blah")
2397
2398         def do_backup(verbose=False):
2399             cmd = ["backup"]
2400             if verbose:
2401                 cmd.append("--verbose")
2402             cmd.append(source)
2403             cmd.append("tahoe:backups")
2404             return self.do_cli(*cmd)
2405
2406         d = self.do_cli("create-alias", "tahoe")
2407
2408         if not have_bdb:
2409             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
2410             def _should_complain((rc, out, err)):
2411                 self.failUnless("I was unable to import a python sqlite library" in err, err)
2412             d.addCallback(_should_complain)
2413             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
2414
2415         d.addCallback(lambda res: do_backup())
2416         def _check0((rc, out, err)):
2417             self.failUnlessReallyEqual(err, "")
2418             self.failUnlessReallyEqual(rc, 0)
2419             fu, fr, fs, dc, dr, ds = self.count_output(out)
2420             # foo.txt, bar.txt, blah.txt
2421             self.failUnlessReallyEqual(fu, 3)
2422             self.failUnlessReallyEqual(fr, 0)
2423             self.failUnlessReallyEqual(fs, 0)
2424             # empty, home, home/parent, home/parent/subdir
2425             self.failUnlessReallyEqual(dc, 4)
2426             self.failUnlessReallyEqual(dr, 0)
2427             self.failUnlessReallyEqual(ds, 0)
2428         d.addCallback(_check0)
2429
2430         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
2431         def _check1((rc, out, err)):
2432             self.failUnlessReallyEqual(err, "")
2433             self.failUnlessReallyEqual(rc, 0)
2434             lines = out.split("\n")
2435             children = dict([line.split() for line in lines if line])
2436             latest_uri = children["Latest"]
2437             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
2438             childnames = children.keys()
2439             self.failUnlessReallyEqual(sorted(childnames), ["Archives", "Latest"])
2440         d.addCallback(_check1)
2441         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
2442         def _check2((rc, out, err)):
2443             self.failUnlessReallyEqual(err, "")
2444             self.failUnlessReallyEqual(rc, 0)
2445             self.failUnlessReallyEqual(sorted(out.split()), ["empty", "parent"])
2446         d.addCallback(_check2)
2447         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
2448         def _check2a((rc, out, err)):
2449             self.failUnlessReallyEqual(err, "")
2450             self.failUnlessReallyEqual(rc, 0)
2451             self.failUnlessReallyEqual(out.strip(), "")
2452         d.addCallback(_check2a)
2453         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2454         def _check3((rc, out, err)):
2455             self.failUnlessReallyEqual(err, "")
2456             self.failUnlessReallyEqual(rc, 0)
2457             self.failUnlessReallyEqual(out, "foo")
2458         d.addCallback(_check3)
2459         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2460         def _check4((rc, out, err)):
2461             self.failUnlessReallyEqual(err, "")
2462             self.failUnlessReallyEqual(rc, 0)
2463             self.old_archives = out.split()
2464             self.failUnlessReallyEqual(len(self.old_archives), 1)
2465         d.addCallback(_check4)
2466
2467
2468         d.addCallback(self.stall, 1.1)
2469         d.addCallback(lambda res: do_backup())
2470         def _check4a((rc, out, err)):
2471             # second backup should reuse everything, if the backupdb is
2472             # available
2473             self.failUnlessReallyEqual(err, "")
2474             self.failUnlessReallyEqual(rc, 0)
2475             if have_bdb:
2476                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2477                 # foo.txt, bar.txt, blah.txt
2478                 self.failUnlessReallyEqual(fu, 0)
2479                 self.failUnlessReallyEqual(fr, 3)
2480                 self.failUnlessReallyEqual(fs, 0)
2481                 # empty, home, home/parent, home/parent/subdir
2482                 self.failUnlessReallyEqual(dc, 0)
2483                 self.failUnlessReallyEqual(dr, 4)
2484                 self.failUnlessReallyEqual(ds, 0)
2485         d.addCallback(_check4a)
2486
2487         if have_bdb:
2488             # sneak into the backupdb, crank back the "last checked"
2489             # timestamp to force a check on all files
2490             def _reset_last_checked(res):
2491                 dbfile = os.path.join(self.get_clientdir(),
2492                                       "private", "backupdb.sqlite")
2493                 self.failUnless(os.path.exists(dbfile), dbfile)
2494                 bdb = backupdb.get_backupdb(dbfile)
2495                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
2496                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
2497                 bdb.connection.commit()
2498
2499             d.addCallback(_reset_last_checked)
2500
2501             d.addCallback(self.stall, 1.1)
2502             d.addCallback(lambda res: do_backup(verbose=True))
2503             def _check4b((rc, out, err)):
2504                 # we should check all files, and re-use all of them. None of
2505                 # the directories should have been changed, so we should
2506                 # re-use all of them too.
2507                 self.failUnlessReallyEqual(err, "")
2508                 self.failUnlessReallyEqual(rc, 0)
2509                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2510                 fchecked, dchecked = self.count_output2(out)
2511                 self.failUnlessReallyEqual(fchecked, 3)
2512                 self.failUnlessReallyEqual(fu, 0)
2513                 self.failUnlessReallyEqual(fr, 3)
2514                 self.failUnlessReallyEqual(fs, 0)
2515                 self.failUnlessReallyEqual(dchecked, 4)
2516                 self.failUnlessReallyEqual(dc, 0)
2517                 self.failUnlessReallyEqual(dr, 4)
2518                 self.failUnlessReallyEqual(ds, 0)
2519             d.addCallback(_check4b)
2520
2521         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2522         def _check5((rc, out, err)):
2523             self.failUnlessReallyEqual(err, "")
2524             self.failUnlessReallyEqual(rc, 0)
2525             self.new_archives = out.split()
2526             expected_new = 2
2527             if have_bdb:
2528                 expected_new += 1
2529             self.failUnlessReallyEqual(len(self.new_archives), expected_new, out)
2530             # the original backup should still be the oldest (i.e. sorts
2531             # alphabetically towards the beginning)
2532             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2533                                  self.old_archives[0])
2534         d.addCallback(_check5)
2535
2536         d.addCallback(self.stall, 1.1)
2537         def _modify(res):
2538             self.writeto("parent/subdir/foo.txt", "FOOF!")
2539             # and turn a file into a directory
2540             os.unlink(os.path.join(source, "parent/blah.txt"))
2541             os.mkdir(os.path.join(source, "parent/blah.txt"))
2542             self.writeto("parent/blah.txt/surprise file", "surprise")
2543             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
2544             # turn a directory into a file
2545             os.rmdir(os.path.join(source, "empty"))
2546             self.writeto("empty", "imagine nothing being here")
2547             return do_backup()
2548         d.addCallback(_modify)
2549         def _check5a((rc, out, err)):
2550             # second backup should reuse bar.txt (if backupdb is available),
2551             # and upload the rest. None of the directories can be reused.
2552             self.failUnlessReallyEqual(err, "")
2553             self.failUnlessReallyEqual(rc, 0)
2554             if have_bdb:
2555                 fu, fr, fs, dc, dr, ds = self.count_output(out)
2556                 # new foo.txt, surprise file, subfile, empty
2557                 self.failUnlessReallyEqual(fu, 4)
2558                 # old bar.txt
2559                 self.failUnlessReallyEqual(fr, 1)
2560                 self.failUnlessReallyEqual(fs, 0)
2561                 # home, parent, subdir, blah.txt, surprisedir
2562                 self.failUnlessReallyEqual(dc, 5)
2563                 self.failUnlessReallyEqual(dr, 0)
2564                 self.failUnlessReallyEqual(ds, 0)
2565         d.addCallback(_check5a)
2566         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
2567         def _check6((rc, out, err)):
2568             self.failUnlessReallyEqual(err, "")
2569             self.failUnlessReallyEqual(rc, 0)
2570             self.new_archives = out.split()
2571             expected_new = 3
2572             if have_bdb:
2573                 expected_new += 1
2574             self.failUnlessReallyEqual(len(self.new_archives), expected_new)
2575             self.failUnlessReallyEqual(sorted(self.new_archives)[0],
2576                                  self.old_archives[0])
2577         d.addCallback(_check6)
2578         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
2579         def _check7((rc, out, err)):
2580             self.failUnlessReallyEqual(err, "")
2581             self.failUnlessReallyEqual(rc, 0)
2582             self.failUnlessReallyEqual(out, "FOOF!")
2583             # the old snapshot should not be modified
2584             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
2585         d.addCallback(_check7)
2586         def _check8((rc, out, err)):
2587             self.failUnlessReallyEqual(err, "")
2588             self.failUnlessReallyEqual(rc, 0)
2589             self.failUnlessReallyEqual(out, "foo")
2590         d.addCallback(_check8)
2591
2592         return d
2593
2594     # on our old dapper buildslave, this test takes a long time (usually
2595     # 130s), so we have to bump up the default 120s timeout. The create-alias
2596     # and initial backup alone take 60s, probably because of the handful of
2597     # dirnodes being created (RSA key generation). The backup between check4
2598     # and check4a takes 6s, as does the backup before check4b.
2599     test_backup.timeout = 3000
2600
2601     def _check_filtering(self, filtered, all, included, excluded):
2602         filtered = set(filtered)
2603         all = set(all)
2604         included = set(included)
2605         excluded = set(excluded)
2606         self.failUnlessReallyEqual(filtered, included)
2607         self.failUnlessReallyEqual(all.difference(filtered), excluded)
2608
2609     def test_exclude_options(self):
2610         root_listdir = (u'lib.a', u'_darcs', u'subdir', u'nice_doc.lyx')
2611         subdir_listdir = (u'another_doc.lyx', u'run_snake_run.py', u'CVS', u'.svn', u'_darcs')
2612         basedir = "cli/Backup/exclude_options"
2613         fileutil.make_dirs(basedir)
2614         nodeurl_path = os.path.join(basedir, 'node.url')
2615         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2616
2617         # test simple exclude
2618         backup_options = cli.BackupOptions()
2619         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2620                                      basedir, 'from', 'to'])
2621         filtered = list(backup_options.filter_listdir(root_listdir))
2622         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2623                               (u'nice_doc.lyx',))
2624         # multiple exclude
2625         backup_options = cli.BackupOptions()
2626         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
2627                                      basedir, 'from', 'to'])
2628         filtered = list(backup_options.filter_listdir(root_listdir))
2629         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2630                               (u'nice_doc.lyx', u'lib.a'))
2631         # vcs metadata exclusion
2632         backup_options = cli.BackupOptions()
2633         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
2634                                      basedir, 'from', 'to'])
2635         filtered = list(backup_options.filter_listdir(subdir_listdir))
2636         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'run_snake_run.py',),
2637                               (u'CVS', u'.svn', u'_darcs'))
2638         # read exclude patterns from file
2639         exclusion_string = "_darcs\n*py\n.svn"
2640         excl_filepath = os.path.join(basedir, 'exclusion')
2641         fileutil.write(excl_filepath, exclusion_string)
2642         backup_options = cli.BackupOptions()
2643         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2644                                      basedir, 'from', 'to'])
2645         filtered = list(backup_options.filter_listdir(subdir_listdir))
2646         self._check_filtering(filtered, subdir_listdir, (u'another_doc.lyx', u'CVS'),
2647                               (u'.svn', u'_darcs', u'run_snake_run.py'))
2648         # test BackupConfigurationError
2649         self.failUnlessRaises(cli.BackupConfigurationError,
2650                               backup_options.parseOptions,
2651                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
2652                                basedir, 'from', 'to'])
2653
2654         # test that an iterator works too
2655         backup_options = cli.BackupOptions()
2656         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
2657                                      basedir, 'from', 'to'])
2658         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2659         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2660                               (u'nice_doc.lyx',))
2661
2662     def test_exclude_options_unicode(self):
2663         nice_doc = u"nice_d\u00F8c.lyx"
2664         try:
2665             doc_pattern_arg = u"*d\u00F8c*".encode(get_io_encoding())
2666         except UnicodeEncodeError:
2667             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
2668
2669         root_listdir = (u'lib.a', u'_darcs', u'subdir', nice_doc)
2670         basedir = "cli/Backup/exclude_options_unicode"
2671         fileutil.make_dirs(basedir)
2672         nodeurl_path = os.path.join(basedir, 'node.url')
2673         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2674
2675         # test simple exclude
2676         backup_options = cli.BackupOptions()
2677         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2678                                      basedir, 'from', 'to'])
2679         filtered = list(backup_options.filter_listdir(root_listdir))
2680         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2681                               (nice_doc,))
2682         # multiple exclude
2683         backup_options = cli.BackupOptions()
2684         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--exclude', 'lib.?', '--node-directory',
2685                                      basedir, 'from', 'to'])
2686         filtered = list(backup_options.filter_listdir(root_listdir))
2687         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2688                              (nice_doc, u'lib.a'))
2689         # read exclude patterns from file
2690         exclusion_string = doc_pattern_arg + "\nlib.?"
2691         excl_filepath = os.path.join(basedir, 'exclusion')
2692         fileutil.write(excl_filepath, exclusion_string)
2693         backup_options = cli.BackupOptions()
2694         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
2695                                      basedir, 'from', 'to'])
2696         filtered = list(backup_options.filter_listdir(root_listdir))
2697         self._check_filtering(filtered, root_listdir, (u'_darcs', u'subdir'),
2698                              (nice_doc, u'lib.a'))
2699
2700         # test that an iterator works too
2701         backup_options = cli.BackupOptions()
2702         backup_options.parseOptions(['--exclude', doc_pattern_arg, '--node-directory',
2703                                      basedir, 'from', 'to'])
2704         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
2705         self._check_filtering(filtered, root_listdir, (u'lib.a', u'_darcs', u'subdir'),
2706                               (nice_doc,))
2707
2708     @patch('__builtin__.file')
2709     def test_exclude_from_tilde_expansion(self, mock):
2710         basedir = "cli/Backup/exclude_from_tilde_expansion"
2711         fileutil.make_dirs(basedir)
2712         nodeurl_path = os.path.join(basedir, 'node.url')
2713         fileutil.write(nodeurl_path, 'http://example.net:2357/')
2714
2715         # ensure that tilde expansion is performed on exclude-from argument
2716         exclude_file = u'~/.tahoe/excludes.dummy'
2717         backup_options = cli.BackupOptions()
2718
2719         mock.return_value = StringIO()
2720         backup_options.parseOptions(['--exclude-from', unicode_to_argv(exclude_file),
2721                                      '--node-directory', basedir, 'from', 'to'])
2722         self.failUnlessIn(((abspath_expanduser_unicode(exclude_file),), {}), mock.call_args_list)
2723
2724     def test_ignore_symlinks(self):
2725         if not hasattr(os, 'symlink'):
2726             raise unittest.SkipTest("Symlinks are not supported by Python on this platform.")
2727
2728         self.basedir = os.path.dirname(self.mktemp())
2729         self.set_up_grid()
2730
2731         source = os.path.join(self.basedir, "home")
2732         self.writeto("foo.txt", "foo")
2733         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
2734
2735         d = self.do_cli("create-alias", "tahoe")
2736         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
2737
2738         def _check((rc, out, err)):
2739             self.failUnlessReallyEqual(rc, 2)
2740             foo2 = os.path.join(source, "foo2.txt")
2741             self.failUnlessReallyEqual(err, "WARNING: cannot backup symlink '%s'\n" % foo2)
2742
2743             fu, fr, fs, dc, dr, ds = self.count_output(out)
2744             # foo.txt
2745             self.failUnlessReallyEqual(fu, 1)
2746             self.failUnlessReallyEqual(fr, 0)
2747             # foo2.txt
2748             self.failUnlessReallyEqual(fs, 1)
2749             # home
2750             self.failUnlessReallyEqual(dc, 1)
2751             self.failUnlessReallyEqual(dr, 0)
2752             self.failUnlessReallyEqual(ds, 0)
2753
2754         d.addCallback(_check)
2755         return d
2756
2757     def test_ignore_unreadable_file(self):
2758         self.basedir = os.path.dirname(self.mktemp())
2759         self.set_up_grid()
2760
2761         source = os.path.join(self.basedir, "home")
2762         self.writeto("foo.txt", "foo")
2763         os.chmod(os.path.join(source, "foo.txt"), 0000)
2764
2765         d = self.do_cli("create-alias", "tahoe")
2766         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2767
2768         def _check((rc, out, err)):
2769             self.failUnlessReallyEqual(rc, 2)
2770             self.failUnlessReallyEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
2771
2772             fu, fr, fs, dc, dr, ds = self.count_output(out)
2773             self.failUnlessReallyEqual(fu, 0)
2774             self.failUnlessReallyEqual(fr, 0)
2775             # foo.txt
2776             self.failUnlessReallyEqual(fs, 1)
2777             # home
2778             self.failUnlessReallyEqual(dc, 1)
2779             self.failUnlessReallyEqual(dr, 0)
2780             self.failUnlessReallyEqual(ds, 0)
2781         d.addCallback(_check)
2782
2783         # This is necessary for the temp files to be correctly removed
2784         def _cleanup(self):
2785             os.chmod(os.path.join(source, "foo.txt"), 0644)
2786         d.addCallback(_cleanup)
2787         d.addErrback(_cleanup)
2788
2789         return d
2790
2791     def test_ignore_unreadable_directory(self):
2792         self.basedir = os.path.dirname(self.mktemp())
2793         self.set_up_grid()
2794
2795         source = os.path.join(self.basedir, "home")
2796         os.mkdir(source)
2797         os.mkdir(os.path.join(source, "test"))
2798         os.chmod(os.path.join(source, "test"), 0000)
2799
2800         d = self.do_cli("create-alias", "tahoe")
2801         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
2802
2803         def _check((rc, out, err)):
2804             self.failUnlessReallyEqual(rc, 2)
2805             self.failUnlessReallyEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
2806
2807             fu, fr, fs, dc, dr, ds = self.count_output(out)
2808             self.failUnlessReallyEqual(fu, 0)
2809             self.failUnlessReallyEqual(fr, 0)
2810             self.failUnlessReallyEqual(fs, 0)
2811             # home, test
2812             self.failUnlessReallyEqual(dc, 2)
2813             self.failUnlessReallyEqual(dr, 0)
2814             # test
2815             self.failUnlessReallyEqual(ds, 1)
2816         d.addCallback(_check)
2817
2818         # This is necessary for the temp files to be correctly removed
2819         def _cleanup(self):
2820             os.chmod(os.path.join(source, "test"), 0655)
2821         d.addCallback(_cleanup)
2822         d.addErrback(_cleanup)
2823         return d
2824
2825     def test_backup_without_alias(self):
2826         # 'tahoe backup' should output a sensible error message when invoked
2827         # without an alias instead of a stack trace.
2828         self.basedir = os.path.dirname(self.mktemp())
2829         self.set_up_grid()
2830         source = os.path.join(self.basedir, "file1")
2831         d = self.do_cli('backup', source, source)
2832         def _check((rc, out, err)):
2833             self.failUnlessReallyEqual(rc, 1)
2834             self.failUnlessIn("error:", err)
2835             self.failUnlessReallyEqual(out, "")
2836         d.addCallback(_check)
2837         return d
2838
2839     def test_backup_with_nonexistent_alias(self):
2840         # 'tahoe backup' should output a sensible error message when invoked
2841         # with a nonexistent alias.
2842         self.basedir = os.path.dirname(self.mktemp())
2843         self.set_up_grid()
2844         source = os.path.join(self.basedir, "file1")
2845         d = self.do_cli("backup", source, "nonexistent:" + source)
2846         def _check((rc, out, err)):
2847             self.failUnlessReallyEqual(rc, 1)
2848             self.failUnlessIn("error:", err)
2849             self.failUnlessIn("nonexistent", err)
2850             self.failUnlessReallyEqual(out, "")
2851         d.addCallback(_check)
2852         return d
2853
2854
2855 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
2856
2857     def test_check(self):
2858         self.basedir = "cli/Check/check"
2859         self.set_up_grid()
2860         c0 = self.g.clients[0]
2861         DATA = "data" * 100
2862         DATA_uploadable = MutableData(DATA)
2863         d = c0.create_mutable_file(DATA_uploadable)
2864         def _stash_uri(n):
2865             self.uri = n.get_uri()
2866         d.addCallback(_stash_uri)
2867
2868         d.addCallback(lambda ign: self.do_cli("check", self.uri))
2869         def _check1((rc, out, err)):
2870             self.failUnlessReallyEqual(err, "")
2871             self.failUnlessReallyEqual(rc, 0)
2872             lines = out.splitlines()
2873             self.failUnless("Summary: Healthy" in lines, out)
2874             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2875         d.addCallback(_check1)
2876
2877         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
2878         def _check2((rc, out, err)):
2879             self.failUnlessReallyEqual(err, "")
2880             self.failUnlessReallyEqual(rc, 0)
2881             data = simplejson.loads(out)
2882             self.failUnlessReallyEqual(to_str(data["summary"]), "Healthy")
2883         d.addCallback(_check2)
2884
2885         def _clobber_shares(ignored):
2886             # delete one, corrupt a second
2887             shares = self.find_uri_shares(self.uri)
2888             self.failUnlessReallyEqual(len(shares), 10)
2889             os.unlink(shares[0][2])
2890             cso = debug.CorruptShareOptions()
2891             cso.stdout = StringIO()
2892             cso.parseOptions([shares[1][2]])
2893             storage_index = uri.from_string(self.uri).get_storage_index()
2894             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
2895                                        (base32.b2a(shares[1][1]),
2896                                         base32.b2a(storage_index),
2897                                         shares[1][0])
2898             debug.corrupt_share(cso)
2899         d.addCallback(_clobber_shares)
2900
2901         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
2902         def _check3((rc, out, err)):
2903             self.failUnlessReallyEqual(err, "")
2904             self.failUnlessReallyEqual(rc, 0)
2905             lines = out.splitlines()
2906             summary = [l for l in lines if l.startswith("Summary")][0]
2907             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
2908                             in summary, summary)
2909             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2910             self.failUnless(" corrupt shares:" in lines, out)
2911             self.failUnless(self._corrupt_share_line in lines, out)
2912         d.addCallback(_check3)
2913
2914         d.addCallback(lambda ign:
2915                       self.do_cli("check", "--verify", "--repair", self.uri))
2916         def _check4((rc, out, err)):
2917             self.failUnlessReallyEqual(err, "")
2918             self.failUnlessReallyEqual(rc, 0)
2919             lines = out.splitlines()
2920             self.failUnless("Summary: not healthy" in lines, out)
2921             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
2922             self.failUnless(" corrupt shares:" in lines, out)
2923             self.failUnless(self._corrupt_share_line in lines, out)
2924             self.failUnless(" repair successful" in lines, out)
2925         d.addCallback(_check4)
2926
2927         d.addCallback(lambda ign:
2928                       self.do_cli("check", "--verify", "--repair", self.uri))
2929         def _check5((rc, out, err)):
2930             self.failUnlessReallyEqual(err, "")
2931             self.failUnlessReallyEqual(rc, 0)
2932             lines = out.splitlines()
2933             self.failUnless("Summary: healthy" in lines, out)
2934             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
2935             self.failIf(" corrupt shares:" in lines, out)
2936         d.addCallback(_check5)
2937
2938         return d
2939
2940     def test_deep_check(self):
2941         self.basedir = "cli/Check/deep_check"
2942         self.set_up_grid()
2943         c0 = self.g.clients[0]
2944         self.uris = {}
2945         self.fileurls = {}
2946         DATA = "data" * 100
2947         quoted_good = quote_output(u"g\u00F6\u00F6d")
2948
2949         d = c0.create_dirnode()
2950         def _stash_root_and_create_file(n):
2951             self.rootnode = n
2952             self.rooturi = n.get_uri()
2953             return n.add_file(u"g\u00F6\u00F6d", upload.Data(DATA, convergence=""))
2954         d.addCallback(_stash_root_and_create_file)
2955         def _stash_uri(fn, which):
2956             self.uris[which] = fn.get_uri()
2957             return fn
2958         d.addCallback(_stash_uri, u"g\u00F6\u00F6d")
2959         d.addCallback(lambda ign:
2960                       self.rootnode.add_file(u"small",
2961                                            upload.Data("literal",
2962                                                         convergence="")))
2963         d.addCallback(_stash_uri, "small")
2964         d.addCallback(lambda ign:
2965             c0.create_mutable_file(MutableData(DATA+"1")))
2966         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
2967         d.addCallback(_stash_uri, "mutable")
2968
2969         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
2970         def _check1((rc, out, err)):
2971             self.failUnlessReallyEqual(err, "")
2972             self.failUnlessReallyEqual(rc, 0)
2973             lines = out.splitlines()
2974             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2975                             in lines, out)
2976         d.addCallback(_check1)
2977
2978         # root
2979         # root/g\u00F6\u00F6d
2980         # root/small
2981         # root/mutable
2982
2983         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
2984                                               self.rooturi))
2985         def _check2((rc, out, err)):
2986             self.failUnlessReallyEqual(err, "")
2987             self.failUnlessReallyEqual(rc, 0)
2988             lines = out.splitlines()
2989             self.failUnless("'<root>': Healthy" in lines, out)
2990             self.failUnless("'small': Healthy (LIT)" in lines, out)
2991             self.failUnless((quoted_good + ": Healthy") in lines, out)
2992             self.failUnless("'mutable': Healthy" in lines, out)
2993             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
2994                             in lines, out)
2995         d.addCallback(_check2)
2996
2997         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2998         def _check_stats((rc, out, err)):
2999             self.failUnlessReallyEqual(err, "")
3000             self.failUnlessReallyEqual(rc, 0)
3001             lines = out.splitlines()
3002             self.failUnlessIn(" count-immutable-files: 1", lines)
3003             self.failUnlessIn("   count-mutable-files: 1", lines)
3004             self.failUnlessIn("   count-literal-files: 1", lines)
3005             self.failUnlessIn("     count-directories: 1", lines)
3006             self.failUnlessIn("  size-immutable-files: 400", lines)
3007             self.failUnlessIn("Size Histogram:", lines)
3008             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
3009             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
3010         d.addCallback(_check_stats)
3011
3012         def _clobber_shares(ignored):
3013             shares = self.find_uri_shares(self.uris[u"g\u00F6\u00F6d"])
3014             self.failUnlessReallyEqual(len(shares), 10)
3015             os.unlink(shares[0][2])
3016
3017             shares = self.find_uri_shares(self.uris["mutable"])
3018             cso = debug.CorruptShareOptions()
3019             cso.stdout = StringIO()
3020             cso.parseOptions([shares[1][2]])
3021             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
3022             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
3023                                        (base32.b2a(shares[1][1]),
3024                                         base32.b2a(storage_index),
3025                                         shares[1][0])
3026             debug.corrupt_share(cso)
3027         d.addCallback(_clobber_shares)
3028
3029         # root
3030         # root/g\u00F6\u00F6d  [9 shares]
3031         # root/small
3032         # root/mutable [1 corrupt share]
3033
3034         d.addCallback(lambda ign:
3035                       self.do_cli("deep-check", "--verbose", self.rooturi))
3036         def _check3((rc, out, err)):
3037             self.failUnlessReallyEqual(err, "")
3038             self.failUnlessReallyEqual(rc, 0)
3039             lines = out.splitlines()
3040             self.failUnless("'<root>': Healthy" in lines, out)
3041             self.failUnless("'small': Healthy (LIT)" in lines, out)
3042             self.failUnless("'mutable': Healthy" in lines, out) # needs verifier
3043             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
3044             self.failIf(self._corrupt_share_line in lines, out)
3045             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
3046                             in lines, out)
3047         d.addCallback(_check3)
3048
3049         d.addCallback(lambda ign:
3050                       self.do_cli("deep-check", "--verbose", "--verify",
3051                                   self.rooturi))
3052         def _check4((rc, out, err)):
3053             self.failUnlessReallyEqual(err, "")
3054             self.failUnlessReallyEqual(rc, 0)
3055             lines = out.splitlines()
3056             self.failUnless("'<root>': Healthy" in lines, out)
3057             self.failUnless("'small': Healthy (LIT)" in lines, out)
3058             mutable = [l for l in lines if l.startswith("'mutable'")][0]
3059             self.failUnless(mutable.startswith("'mutable': Unhealthy: 9 shares (enc 3-of-10)"),
3060                             mutable)
3061             self.failUnless(self._corrupt_share_line in lines, out)
3062             self.failUnless((quoted_good + ": Not Healthy: 9 shares (enc 3-of-10)") in lines, out)
3063             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
3064                             in lines, out)
3065         d.addCallback(_check4)
3066
3067         d.addCallback(lambda ign:
3068                       self.do_cli("deep-check", "--raw",
3069                                   self.rooturi))
3070         def _check5((rc, out, err)):
3071             self.failUnlessReallyEqual(err, "")
3072             self.failUnlessReallyEqual(rc, 0)
3073             lines = out.splitlines()
3074             units = [simplejson.loads(line) for line in lines]
3075             # root, small, g\u00F6\u00F6d, mutable,  stats
3076             self.failUnlessReallyEqual(len(units), 4+1)
3077         d.addCallback(_check5)
3078
3079         d.addCallback(lambda ign:
3080                       self.do_cli("deep-check",
3081                                   "--verbose", "--verify", "--repair",
3082                                   self.rooturi))
3083         def _check6((rc, out, err)):
3084             self.failUnlessReallyEqual(err, "")
3085             self.failUnlessReallyEqual(rc, 0)
3086             lines = out.splitlines()
3087             self.failUnless("'<root>': healthy" in lines, out)
3088             self.failUnless("'small': healthy" in lines, out)
3089             self.failUnless("'mutable': not healthy" in lines, out)
3090             self.failUnless(self._corrupt_share_line in lines, out)
3091             self.failUnless((quoted_good + ": not healthy") in lines, out)
3092             self.failUnless("done: 4 objects checked" in lines, out)
3093             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
3094             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
3095                             in lines, out)
3096             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
3097         d.addCallback(_check6)
3098
3099         # now add a subdir, and a file below that, then make the subdir
3100         # unrecoverable
3101
3102         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
3103         d.addCallback(_stash_uri, "subdir")
3104         d.addCallback(lambda fn:
3105                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
3106         d.addCallback(lambda ign:
3107                       self.delete_shares_numbered(self.uris["subdir"],
3108                                                   range(10)))
3109
3110         # root
3111         # rootg\u00F6\u00F6d/
3112         # root/small
3113         # root/mutable
3114         # root/subdir [unrecoverable: 0 shares]
3115         # root/subfile
3116
3117         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
3118         def _manifest_failed((rc, out, err)):
3119             self.failIfEqual(rc, 0)
3120             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3121             # the fatal directory should still show up, as the last line
3122             self.failUnlessIn(" subdir\n", out)
3123         d.addCallback(_manifest_failed)
3124
3125         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
3126         def _deep_check_failed((rc, out, err)):
3127             self.failIfEqual(rc, 0)
3128             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3129             # we want to make sure that the error indication is the last
3130             # thing that gets emitted
3131             self.failIf("done:" in out, out)
3132         d.addCallback(_deep_check_failed)
3133
3134         # this test is disabled until the deep-repair response to an
3135         # unrepairable directory is fixed. The failure-to-repair should not
3136         # throw an exception, but the failure-to-traverse that follows
3137         # should throw UnrecoverableFileError.
3138
3139         #d.addCallback(lambda ign:
3140         #              self.do_cli("deep-check", "--repair", self.rooturi))
3141         #def _deep_check_repair_failed((rc, out, err)):
3142         #    self.failIfEqual(rc, 0)
3143         #    print err
3144         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
3145         #    self.failIf("done:" in out, out)
3146         #d.addCallback(_deep_check_repair_failed)
3147
3148         return d
3149
3150     def test_check_without_alias(self):
3151         # 'tahoe check' should output a sensible error message if it needs to
3152         # find the default alias and can't
3153         self.basedir = "cli/Check/check_without_alias"
3154         self.set_up_grid()
3155         d = self.do_cli("check")
3156         def _check((rc, out, err)):
3157             self.failUnlessReallyEqual(rc, 1)
3158             self.failUnlessIn("error:", err)
3159             self.failUnlessReallyEqual(out, "")
3160         d.addCallback(_check)
3161         d.addCallback(lambda ign: self.do_cli("deep-check"))
3162         d.addCallback(_check)
3163         return d
3164
3165     def test_check_with_nonexistent_alias(self):
3166         # 'tahoe check' should output a sensible error message if it needs to
3167         # find an alias and can't.
3168         self.basedir = "cli/Check/check_with_nonexistent_alias"
3169         self.set_up_grid()
3170         d = self.do_cli("check", "nonexistent:")
3171         def _check((rc, out, err)):
3172             self.failUnlessReallyEqual(rc, 1)
3173             self.failUnlessIn("error:", err)
3174             self.failUnlessIn("nonexistent", err)
3175             self.failUnlessReallyEqual(out, "")
3176         d.addCallback(_check)
3177         return d
3178
3179
3180 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
3181     def test_get(self):
3182         self.basedir = "cli/Errors/get"
3183         self.set_up_grid()
3184         c0 = self.g.clients[0]
3185         self.fileurls = {}
3186         DATA = "data" * 100
3187         d = c0.upload(upload.Data(DATA, convergence=""))
3188         def _stash_bad(ur):
3189             self.uri_1share = ur.uri
3190             self.delete_shares_numbered(ur.uri, range(1,10))
3191         d.addCallback(_stash_bad)
3192
3193         # the download is abandoned as soon as it's clear that we won't get
3194         # enough shares. The one remaining share might be in either the
3195         # COMPLETE or the PENDING state.
3196         in_complete_msg = "ran out of shares: complete=sh0 pending= overdue= unused= need 3"
3197         in_pending_msg = "ran out of shares: complete= pending=Share(sh0-on-fob7vqgd) overdue= unused= need 3"
3198
3199         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
3200         def _check1((rc, out, err)):
3201             self.failIfEqual(rc, 0)
3202             self.failUnless("410 Gone" in err, err)
3203             self.failUnlessIn("NotEnoughSharesError: ", err)
3204             self.failUnless(in_complete_msg in err or in_pending_msg in err,
3205                             err)
3206         d.addCallback(_check1)
3207
3208         targetf = os.path.join(self.basedir, "output")
3209         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
3210         def _check2((rc, out, err)):
3211             self.failIfEqual(rc, 0)
3212             self.failUnless("410 Gone" in err, err)
3213             self.failUnlessIn("NotEnoughSharesError: ", err)
3214             self.failUnless(in_complete_msg in err or in_pending_msg in err,
3215                             err)
3216             self.failIf(os.path.exists(targetf))
3217         d.addCallback(_check2)
3218
3219         return d
3220
3221
3222 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
3223     def test_get_without_alias(self):
3224         # 'tahoe get' should output a useful error message when invoked
3225         # without an explicit alias and when the default 'tahoe' alias
3226         # hasn't been created yet.
3227         self.basedir = "cli/Get/get_without_alias"
3228         self.set_up_grid()
3229         d = self.do_cli('get', 'file')
3230         def _check((rc, out, err)):
3231             self.failUnlessReallyEqual(rc, 1)
3232             self.failUnlessIn("error:", err)
3233             self.failUnlessReallyEqual(out, "")
3234         d.addCallback(_check)
3235         return d
3236
3237     def test_get_with_nonexistent_alias(self):
3238         # 'tahoe get' should output a useful error message when invoked with
3239         # an explicit alias that doesn't exist.
3240         self.basedir = "cli/Get/get_with_nonexistent_alias"
3241         self.set_up_grid()
3242         d = self.do_cli("get", "nonexistent:file")
3243         def _check((rc, out, err)):
3244             self.failUnlessReallyEqual(rc, 1)
3245             self.failUnlessIn("error:", err)
3246             self.failUnlessIn("nonexistent", err)
3247             self.failUnlessReallyEqual(out, "")
3248         d.addCallback(_check)
3249         return d
3250
3251
3252 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
3253     def test_manifest_without_alias(self):
3254         # 'tahoe manifest' should output a useful error message when invoked
3255         # without an explicit alias when the default 'tahoe' alias is
3256         # missing.
3257         self.basedir = "cli/Manifest/manifest_without_alias"
3258         self.set_up_grid()
3259         d = self.do_cli("manifest")
3260         def _check((rc, out, err)):
3261             self.failUnlessReallyEqual(rc, 1)
3262             self.failUnlessIn("error:", err)
3263             self.failUnlessReallyEqual(out, "")
3264         d.addCallback(_check)
3265         return d
3266
3267     def test_manifest_with_nonexistent_alias(self):
3268         # 'tahoe manifest' should output a useful error message when invoked
3269         # with an explicit alias that doesn't exist.
3270         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
3271         self.set_up_grid()
3272         d = self.do_cli("manifest", "nonexistent:")
3273         def _check((rc, out, err)):
3274             self.failUnlessReallyEqual(rc, 1)
3275             self.failUnlessIn("error:", err)
3276             self.failUnlessIn("nonexistent", err)
3277             self.failUnlessReallyEqual(out, "")
3278         d.addCallback(_check)
3279         return d
3280
3281
3282 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
3283     def test_mkdir(self):
3284         self.basedir = os.path.dirname(self.mktemp())
3285         self.set_up_grid()
3286
3287         d = self.do_cli("create-alias", "tahoe")
3288         d.addCallback(lambda res: self.do_cli("mkdir", "test"))
3289         def _check((rc, out, err)):
3290             self.failUnlessReallyEqual(rc, 0)
3291             self.failUnlessReallyEqual(err, "")
3292             self.failUnlessIn("URI:", out)
3293         d.addCallback(_check)
3294
3295         return d
3296
3297     def test_mkdir_mutable_type(self):
3298         self.basedir = os.path.dirname(self.mktemp())
3299         self.set_up_grid()
3300         d = self.do_cli("create-alias", "tahoe")
3301         d.addCallback(lambda ignored:
3302             self.do_cli("mkdir", "--mutable-type=sdmf", "tahoe:foo"))
3303         def _check((rc, out, err), st):
3304             self.failUnlessReallyEqual(rc, 0)
3305             self.failUnlessReallyEqual(err, "")
3306             self.failUnlessIn(st, out)
3307             return out
3308         def _stash_dircap(cap):
3309             self._dircap = cap
3310             u = uri.from_string(cap)
3311             fn_uri = u.get_filenode_cap()
3312             self._filecap = fn_uri.to_string()
3313         d.addCallback(_check, "URI:DIR2")
3314         d.addCallback(_stash_dircap)
3315         d.addCallback(lambda ignored:
3316             self.do_cli("ls", "--json", "tahoe:foo"))
3317         d.addCallback(_check, "URI:DIR2")
3318         d.addCallback(lambda ignored:
3319             self.do_cli("ls", "--json", self._filecap))
3320         d.addCallback(_check, '"mutable-type": "sdmf"')
3321         d.addCallback(lambda ignored:
3322             self.do_cli("mkdir", "--mutable-type=mdmf", "tahoe:bar"))
3323         d.addCallback(_check, "URI:DIR2-MDMF")
3324         d.addCallback(_stash_dircap)
3325         d.addCallback(lambda ignored:
3326             self.do_cli("ls", "--json", "tahoe:bar"))
3327         d.addCallback(_check, "URI:DIR2-MDMF")
3328         d.addCallback(lambda ignored:
3329             self.do_cli("ls", "--json", self._filecap))
3330         d.addCallback(_check, '"mutable-type": "mdmf"')
3331         return d
3332
3333     def test_mkdir_mutable_type_unlinked(self):
3334         self.basedir = os.path.dirname(self.mktemp())
3335         self.set_up_grid()
3336         d = self.do_cli("mkdir", "--mutable-type=sdmf")
3337         def _check((rc, out, err), st):
3338             self.failUnlessReallyEqual(rc, 0)
3339             self.failUnlessReallyEqual(err, "")
3340             self.failUnlessIn(st, out)
3341             return out
3342         d.addCallback(_check, "URI:DIR2")
3343         def _stash_dircap(cap):
3344             self._dircap = cap
3345             # Now we're going to feed the cap into uri.from_string...
3346             u = uri.from_string(cap)
3347             # ...grab the underlying filenode uri.
3348             fn_uri = u.get_filenode_cap()
3349             # ...and stash that.
3350             self._filecap = fn_uri.to_string()
3351         d.addCallback(_stash_dircap)
3352         d.addCallback(lambda res: self.do_cli("ls", "--json",
3353                                               self._filecap))
3354         d.addCallback(_check, '"mutable-type": "sdmf"')
3355         d.addCallback(lambda res: self.do_cli("mkdir", "--mutable-type=mdmf"))
3356         d.addCallback(_check, "URI:DIR2-MDMF")
3357         d.addCallback(_stash_dircap)
3358         d.addCallback(lambda res: self.do_cli("ls", "--json",
3359                                               self._filecap))
3360         d.addCallback(_check, '"mutable-type": "mdmf"')
3361         return d
3362
3363     def test_mkdir_bad_mutable_type(self):
3364         o = cli.MakeDirectoryOptions()
3365         self.failUnlessRaises(usage.UsageError,
3366                               o.parseOptions,
3367                               ["--mutable", "--mutable-type=ldmf"])
3368
3369     def test_mkdir_unicode(self):
3370         self.basedir = os.path.dirname(self.mktemp())
3371         self.set_up_grid()
3372
3373         try:
3374             motorhead_arg = u"tahoe:Mot\u00F6rhead".encode(get_io_encoding())
3375         except UnicodeEncodeError:
3376             raise unittest.SkipTest("A non-ASCII command argument could not be encoded on this platform.")
3377
3378         d = self.do_cli("create-alias", "tahoe")
3379         d.addCallback(lambda res: self.do_cli("mkdir", motorhead_arg))
3380         def _check((rc, out, err)):
3381             self.failUnlessReallyEqual(rc, 0)
3382             self.failUnlessReallyEqual(err, "")
3383             self.failUnlessIn("URI:", out)
3384         d.addCallback(_check)
3385
3386         return d
3387
3388     def test_mkdir_with_nonexistent_alias(self):
3389         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
3390         # output a sensible error message rather than a stack trace.
3391         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
3392         self.set_up_grid()
3393         d = self.do_cli("mkdir", "havasu:")
3394         def _check((rc, out, err)):
3395             self.failUnlessReallyEqual(rc, 1)
3396             self.failUnlessIn("error:", err)
3397             self.failUnlessReallyEqual(out, "")
3398         d.addCallback(_check)
3399         return d
3400
3401
3402 class Unlink(GridTestMixin, CLITestMixin, unittest.TestCase):
3403     command = "unlink"
3404
3405     def _create_test_file(self):
3406         data = "puppies" * 1000
3407         path = os.path.join(self.basedir, "datafile")
3408         fileutil.write(path, data)
3409         self.datafile = path
3410
3411     def test_unlink_without_alias(self):
3412         # 'tahoe unlink' should behave sensibly when invoked without an explicit
3413         # alias before the default 'tahoe' alias has been created.
3414         self.basedir = "cli/Unlink/%s_without_alias" % (self.command,)
3415         self.set_up_grid()
3416         d = self.do_cli(self.command, "afile")
3417         def _check((rc, out, err)):
3418             self.failUnlessReallyEqual(rc, 1)
3419             self.failUnlessIn("error:", err)
3420             self.failUnlessReallyEqual(out, "")
3421         d.addCallback(_check)
3422
3423         d.addCallback(lambda ign: self.do_cli(self.command, "afile"))
3424         d.addCallback(_check)
3425         return d
3426
3427     def test_unlink_with_nonexistent_alias(self):
3428         # 'tahoe unlink' should behave sensibly when invoked with an explicit
3429         # alias that doesn't exist.
3430         self.basedir = "cli/Unlink/%s_with_nonexistent_alias" % (self.command,)
3431         self.set_up_grid()
3432         d = self.do_cli(self.command, "nonexistent:afile")
3433         def _check((rc, out, err)):
3434             self.failUnlessReallyEqual(rc, 1)
3435             self.failUnlessIn("error:", err)
3436             self.failUnlessIn("nonexistent", err)
3437             self.failUnlessReallyEqual(out, "")
3438         d.addCallback(_check)
3439
3440         d.addCallback(lambda ign: self.do_cli(self.command, "nonexistent:afile"))
3441         d.addCallback(_check)
3442         return d
3443
3444     def test_unlink_without_path(self):
3445         # 'tahoe unlink' should give a sensible error message when invoked without a path.
3446         self.basedir = "cli/Unlink/%s_without_path" % (self.command,)
3447         self.set_up_grid()
3448         self._create_test_file()
3449         d = self.do_cli("create-alias", "tahoe")
3450         d.addCallback(lambda ign: self.do_cli("put", self.datafile, "tahoe:test"))
3451         def _do_unlink((rc, out, err)):
3452             self.failUnlessReallyEqual(rc, 0)
3453             self.failUnless(out.startswith("URI:"), out)
3454             return self.do_cli(self.command, out.strip('\n'))
3455         d.addCallback(_do_unlink)
3456
3457         def _check((rc, out, err)):
3458             self.failUnlessReallyEqual(rc, 1)
3459             self.failUnlessIn("'tahoe %s'" % (self.command,), err)
3460             self.failUnlessIn("path must be given", err)
3461             self.failUnlessReallyEqual(out, "")
3462         d.addCallback(_check)
3463         return d
3464
3465
3466 class Rm(Unlink):
3467     """Test that 'tahoe rm' behaves in the same way as 'tahoe unlink'."""
3468     command = "rm"
3469
3470
3471 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
3472     def test_empty_directory(self):
3473         self.basedir = "cli/Stats/empty_directory"
3474         self.set_up_grid()
3475         c0 = self.g.clients[0]
3476         self.fileurls = {}
3477         d = c0.create_dirnode()
3478         def _stash_root(n):
3479             self.rootnode = n
3480             self.rooturi = n.get_uri()
3481         d.addCallback(_stash_root)
3482
3483         # make sure we can get stats on an empty directory too
3484         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
3485         def _check_stats((rc, out, err)):
3486             self.failUnlessReallyEqual(err, "")
3487             self.failUnlessReallyEqual(rc, 0)
3488             lines = out.splitlines()
3489             self.failUnlessIn(" count-immutable-files: 0", lines)
3490             self.failUnlessIn("   count-mutable-files: 0", lines)
3491             self.failUnlessIn("   count-literal-files: 0", lines)
3492             self.failUnlessIn("     count-directories: 1", lines)
3493             self.failUnlessIn("  size-immutable-files: 0", lines)
3494             self.failIfIn("Size Histogram:", lines)
3495         d.addCallback(_check_stats)
3496
3497         return d
3498
3499     def test_stats_without_alias(self):
3500         # when invoked with no explicit alias and before the default 'tahoe'
3501         # alias is created, 'tahoe stats' should output an informative error
3502         # message, not a stack trace.
3503         self.basedir = "cli/Stats/stats_without_alias"
3504         self.set_up_grid()
3505         d = self.do_cli("stats")
3506         def _check((rc, out, err)):
3507             self.failUnlessReallyEqual(rc, 1)
3508             self.failUnlessIn("error:", err)
3509             self.failUnlessReallyEqual(out, "")
3510         d.addCallback(_check)
3511         return d
3512
3513     def test_stats_with_nonexistent_alias(self):
3514         # when invoked with an explicit alias that doesn't exist,
3515         # 'tahoe stats' should output a useful error message.
3516         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
3517         self.set_up_grid()
3518         d = self.do_cli("stats", "havasu:")
3519         def _check((rc, out, err)):
3520             self.failUnlessReallyEqual(rc, 1)
3521             self.failUnlessIn("error:", err)
3522             self.failUnlessReallyEqual(out, "")
3523         d.addCallback(_check)
3524         return d
3525
3526
3527 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
3528     def test_webopen_with_nonexistent_alias(self):
3529         # when invoked with an alias that doesn't exist, 'tahoe webopen'
3530         # should output an informative error message instead of a stack
3531         # trace.
3532         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
3533         self.set_up_grid()
3534         d = self.do_cli("webopen", "fake:")
3535         def _check((rc, out, err)):
3536             self.failUnlessReallyEqual(rc, 1)
3537             self.failUnlessIn("error:", err)
3538             self.failUnlessReallyEqual(out, "")
3539         d.addCallback(_check)
3540         return d
3541
3542     def test_webopen(self):
3543         # TODO: replace with @patch that supports Deferreds.
3544         import webbrowser
3545         def call_webbrowser_open(url):
3546             self.failUnlessIn(self.alias_uri.replace(':', '%3A'), url)
3547             self.webbrowser_open_called = True
3548         def _cleanup(res):
3549             webbrowser.open = self.old_webbrowser_open
3550             return res
3551
3552         self.old_webbrowser_open = webbrowser.open
3553         try:
3554             webbrowser.open = call_webbrowser_open
3555
3556             self.basedir = "cli/Webopen/webopen"
3557             self.set_up_grid()
3558             d = self.do_cli("create-alias", "alias:")
3559             def _check_alias((rc, out, err)):
3560                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3561                 self.failUnlessIn("Alias 'alias' created", out)
3562                 self.failUnlessReallyEqual(err, "")
3563                 self.alias_uri = get_aliases(self.get_clientdir())["alias"]
3564             d.addCallback(_check_alias)
3565             d.addCallback(lambda res: self.do_cli("webopen", "alias:"))
3566             def _check_webopen((rc, out, err)):
3567                 self.failUnlessReallyEqual(rc, 0, repr((rc, out, err)))
3568                 self.failUnlessReallyEqual(out, "")
3569                 self.failUnlessReallyEqual(err, "")
3570                 self.failUnless(self.webbrowser_open_called)
3571             d.addCallback(_check_webopen)
3572             d.addBoth(_cleanup)
3573         except:
3574             _cleanup(None)
3575             raise
3576         return d