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