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