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