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