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