]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - src/allmydata/test/test_cli.py
CLI: Support for https url in option --node-url
[tahoe-lafs/tahoe-lafs.git] / src / allmydata / test / test_cli.py
1 # coding=utf-8
2
3 import os.path
4 from twisted.trial import unittest
5 from cStringIO import StringIO
6 import urllib
7 import re
8 import simplejson
9
10 from allmydata.util import fileutil, hashutil, base32
11 from allmydata import uri
12 from allmydata.immutable import upload
13
14 # Test that the scripts can be imported -- although the actual tests of their
15 # functionality are done by invoking them in a subprocess.
16 from allmydata.scripts import tahoe_ls, tahoe_get, tahoe_put, tahoe_rm, tahoe_cp
17 _hush_pyflakes = [tahoe_ls, tahoe_get, tahoe_put, tahoe_rm, tahoe_cp]
18
19 from allmydata.scripts import common
20 from allmydata.scripts.common import DEFAULT_ALIAS, get_aliases, get_alias, \
21      DefaultAliasMarker
22
23 from allmydata.scripts import cli, debug, runner, backupdb
24 from allmydata.test.common_util import StallMixin
25 from allmydata.test.no_network import GridTestMixin
26 from twisted.internet import threads # CLI tests use deferToThread
27 from twisted.python import usage
28
29 timeout = 480 # deep_check takes 360s on Zandr's linksys box, others take > 240s
30
31
32 class CLI(unittest.TestCase):
33     # this test case only looks at argument-processing and simple stuff.
34     def test_options(self):
35         fileutil.rm_dir("cli/test_options")
36         fileutil.make_dirs("cli/test_options")
37         fileutil.make_dirs("cli/test_options/private")
38         fileutil.write("cli/test_options/node.url", "http://localhost:8080/\n")
39         filenode_uri = uri.WriteableSSKFileURI(writekey="\x00"*16,
40                                                fingerprint="\x00"*32)
41         private_uri = uri.DirectoryURI(filenode_uri).to_string()
42         fileutil.write("cli/test_options/private/root_dir.cap", private_uri + "\n")
43         o = cli.ListOptions()
44         o.parseOptions(["--node-directory", "cli/test_options"])
45         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
46         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], private_uri)
47         self.failUnlessEqual(o.where, "")
48
49         o = cli.ListOptions()
50         o.parseOptions(["--node-directory", "cli/test_options",
51                         "--node-url", "http://example.org:8111/"])
52         self.failUnlessEqual(o['node-url'], "http://example.org:8111/")
53         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], private_uri)
54         self.failUnlessEqual(o.where, "")
55
56         o = cli.ListOptions()
57         o.parseOptions(["--node-directory", "cli/test_options",
58                         "--dir-cap", "root"])
59         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
60         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], "root")
61         self.failUnlessEqual(o.where, "")
62
63         o = cli.ListOptions()
64         other_filenode_uri = uri.WriteableSSKFileURI(writekey="\x11"*16,
65                                                      fingerprint="\x11"*32)
66         other_uri = uri.DirectoryURI(other_filenode_uri).to_string()
67         o.parseOptions(["--node-directory", "cli/test_options",
68                         "--dir-cap", other_uri])
69         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
70         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], other_uri)
71         self.failUnlessEqual(o.where, "")
72
73         o = cli.ListOptions()
74         o.parseOptions(["--node-directory", "cli/test_options",
75                         "--dir-cap", other_uri, "subdir"])
76         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
77         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], other_uri)
78         self.failUnlessEqual(o.where, "subdir")
79
80         o = cli.ListOptions()
81         self.failUnlessRaises(usage.UsageError,
82                               o.parseOptions,
83                               ["--node-directory", "cli/test_options",
84                                "--node-url", "NOT-A-URL"])
85
86         o = cli.ListOptions()
87         o.parseOptions(["--node-directory", "cli/test_options",
88                         "--node-url", "http://localhost:8080"])
89         self.failUnlessEqual(o["node-url"], "http://localhost:8080/")
90
91         o = cli.ListOptions()
92         o.parseOptions(["--node-directory", "cli/test_options",
93                         "--node-url", "https://localhost/"])
94         self.failUnlessEqual(o["node-url"], "https://localhost/")
95
96     def _dump_cap(self, *args):
97         config = debug.DumpCapOptions()
98         config.stdout,config.stderr = StringIO(), StringIO()
99         config.parseOptions(args)
100         debug.dump_cap(config)
101         self.failIf(config.stderr.getvalue())
102         output = config.stdout.getvalue()
103         return output
104
105     def test_dump_cap_chk(self):
106         key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
107         uri_extension_hash = hashutil.uri_extension_hash("stuff")
108         needed_shares = 25
109         total_shares = 100
110         size = 1234
111         u = uri.CHKFileURI(key=key,
112                            uri_extension_hash=uri_extension_hash,
113                            needed_shares=needed_shares,
114                            total_shares=total_shares,
115                            size=size)
116         output = self._dump_cap(u.to_string())
117         self.failUnless("CHK File:" in output, output)
118         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
119         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
120         self.failUnless("size: 1234" in output, output)
121         self.failUnless("k/N: 25/100" in output, output)
122         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
123
124         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
125                                 u.to_string())
126         self.failUnless("client renewal secret: znxmki5zdibb5qlt46xbdvk2t55j7hibejq3i5ijyurkr6m6jkhq" in output, output)
127
128         output = self._dump_cap(u.get_verify_cap().to_string())
129         self.failIf("key: " in output, output)
130         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
131         self.failUnless("size: 1234" in output, output)
132         self.failUnless("k/N: 25/100" in output, output)
133         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
134
135         prefixed_u = "http://127.0.0.1/uri/%s" % urllib.quote(u.to_string())
136         output = self._dump_cap(prefixed_u)
137         self.failUnless("CHK File:" in output, output)
138         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
139         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
140         self.failUnless("size: 1234" in output, output)
141         self.failUnless("k/N: 25/100" in output, output)
142         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
143
144     def test_dump_cap_lit(self):
145         u = uri.LiteralFileURI("this is some data")
146         output = self._dump_cap(u.to_string())
147         self.failUnless("Literal File URI:" in output, output)
148         self.failUnless("data: this is some data" in output, output)
149
150     def test_dump_cap_ssk(self):
151         writekey = "\x01" * 16
152         fingerprint = "\xfe" * 32
153         u = uri.WriteableSSKFileURI(writekey, fingerprint)
154
155         output = self._dump_cap(u.to_string())
156         self.failUnless("SSK Writeable URI:" in output, output)
157         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output, output)
158         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
159         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
160         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
161
162         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
163                                 u.to_string())
164         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
165
166         fileutil.make_dirs("cli/test_dump_cap/private")
167         fileutil.write("cli/test_dump_cap/private/secret", "5s33nk3qpvnj2fw3z4mnm2y6fa\n")
168         output = self._dump_cap("--client-dir", "cli/test_dump_cap",
169                                 u.to_string())
170         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
171
172         output = self._dump_cap("--client-dir", "cli/test_dump_cap_BOGUS",
173                                 u.to_string())
174         self.failIf("file renewal secret:" in output, output)
175
176         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
177                                 u.to_string())
178         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
179         self.failIf("file renewal secret:" in output, output)
180
181         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
182                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
183                                 u.to_string())
184         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
185         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
186         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
187
188         u = u.get_readonly()
189         output = self._dump_cap(u.to_string())
190         self.failUnless("SSK Read-only URI:" in output, output)
191         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
192         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
193         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
194
195         u = u.get_verify_cap()
196         output = self._dump_cap(u.to_string())
197         self.failUnless("SSK Verifier URI:" in output, output)
198         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
199         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
200
201     def test_dump_cap_directory(self):
202         writekey = "\x01" * 16
203         fingerprint = "\xfe" * 32
204         u1 = uri.WriteableSSKFileURI(writekey, fingerprint)
205         u = uri.DirectoryURI(u1)
206
207         output = self._dump_cap(u.to_string())
208         self.failUnless("Directory Writeable URI:" in output, output)
209         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output,
210                         output)
211         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
212         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output,
213                         output)
214         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
215
216         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
217                                 u.to_string())
218         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
219
220         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
221                                 u.to_string())
222         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
223         self.failIf("file renewal secret:" in output, output)
224
225         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
226                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
227                                 u.to_string())
228         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
229         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
230         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
231
232         u = u.get_readonly()
233         output = self._dump_cap(u.to_string())
234         self.failUnless("Directory Read-only URI:" in output, output)
235         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
236         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
237         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
238
239         u = u.get_verify_cap()
240         output = self._dump_cap(u.to_string())
241         self.failUnless("Directory Verifier URI:" in output, output)
242         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
243         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
244
245     def _catalog_shares(self, *basedirs):
246         o = debug.CatalogSharesOptions()
247         o.stdout,o.stderr = StringIO(), StringIO()
248         args = list(basedirs)
249         o.parseOptions(args)
250         debug.catalog_shares(o)
251         out = o.stdout.getvalue()
252         err = o.stderr.getvalue()
253         return out, err
254
255     def test_catalog_shares_error(self):
256         nodedir1 = "cli/test_catalog_shares/node1"
257         sharedir = os.path.join(nodedir1, "storage", "shares", "mq", "mqfblse6m5a6dh45isu2cg7oji")
258         fileutil.make_dirs(sharedir)
259         fileutil.write("cli/test_catalog_shares/node1/storage/shares/mq/not-a-dir", "")
260         # write a bogus share that looks a little bit like CHK
261         fileutil.write(os.path.join(sharedir, "8"),
262                        "\x00\x00\x00\x01" + "\xff" * 200) # this triggers an assert
263
264         nodedir2 = "cli/test_catalog_shares/node2"
265         fileutil.make_dirs(nodedir2)
266         fileutil.write("cli/test_catalog_shares/node1/storage/shares/not-a-dir", "")
267
268         # now make sure that the 'catalog-shares' commands survives the error
269         out, err = self._catalog_shares(nodedir1, nodedir2)
270         self.failUnlessEqual(out, "", out)
271         self.failUnless("Error processing " in err,
272                         "didn't see 'error processing' in '%s'" % err)
273         #self.failUnless(nodedir1 in err,
274         #                "didn't see '%s' in '%s'" % (nodedir1, err))
275         # windows mangles the path, and os.path.join isn't enough to make
276         # up for it, so just look for individual strings
277         self.failUnless("node1" in err,
278                         "didn't see 'node1' in '%s'" % err)
279         self.failUnless("mqfblse6m5a6dh45isu2cg7oji" in err,
280                         "didn't see 'mqfblse6m5a6dh45isu2cg7oji' in '%s'" % err)
281
282     def test_alias(self):
283         aliases = {"tahoe": "TA",
284                    "work": "WA",
285                    "c": "CA"}
286         def ga1(path):
287             return get_alias(aliases, path, "tahoe")
288         uses_lettercolon = common.platform_uses_lettercolon_drivename()
289         self.failUnlessEqual(ga1("bare"), ("TA", "bare"))
290         self.failUnlessEqual(ga1("baredir/file"), ("TA", "baredir/file"))
291         self.failUnlessEqual(ga1("baredir/file:7"), ("TA", "baredir/file:7"))
292         self.failUnlessEqual(ga1("tahoe:"), ("TA", ""))
293         self.failUnlessEqual(ga1("tahoe:file"), ("TA", "file"))
294         self.failUnlessEqual(ga1("tahoe:dir/file"), ("TA", "dir/file"))
295         self.failUnlessEqual(ga1("work:"), ("WA", ""))
296         self.failUnlessEqual(ga1("work:file"), ("WA", "file"))
297         self.failUnlessEqual(ga1("work:dir/file"), ("WA", "dir/file"))
298         # default != None means we really expect a tahoe path, regardless of
299         # whether we're on windows or not. This is what 'tahoe get' uses.
300         self.failUnlessEqual(ga1("c:"), ("CA", ""))
301         self.failUnlessEqual(ga1("c:file"), ("CA", "file"))
302         self.failUnlessEqual(ga1("c:dir/file"), ("CA", "dir/file"))
303         self.failUnlessEqual(ga1("URI:stuff"), ("URI:stuff", ""))
304         self.failUnlessEqual(ga1("URI:stuff/file"), ("URI:stuff", "file"))
305         self.failUnlessEqual(ga1("URI:stuff:./file"), ("URI:stuff", "file"))
306         self.failUnlessEqual(ga1("URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
307         self.failUnlessEqual(ga1("URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
308         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:")
309         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:dir")
310         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:dir/file")
311
312         def ga2(path):
313             return get_alias(aliases, path, None)
314         self.failUnlessEqual(ga2("bare"), (DefaultAliasMarker, "bare"))
315         self.failUnlessEqual(ga2("baredir/file"),
316                              (DefaultAliasMarker, "baredir/file"))
317         self.failUnlessEqual(ga2("baredir/file:7"),
318                              (DefaultAliasMarker, "baredir/file:7"))
319         self.failUnlessEqual(ga2("baredir/sub:1/file:7"),
320                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
321         self.failUnlessEqual(ga2("tahoe:"), ("TA", ""))
322         self.failUnlessEqual(ga2("tahoe:file"), ("TA", "file"))
323         self.failUnlessEqual(ga2("tahoe:dir/file"), ("TA", "dir/file"))
324         # on windows, we really want c:foo to indicate a local file.
325         # default==None is what 'tahoe cp' uses.
326         if uses_lettercolon:
327             self.failUnlessEqual(ga2("c:"), (DefaultAliasMarker, "c:"))
328             self.failUnlessEqual(ga2("c:file"), (DefaultAliasMarker, "c:file"))
329             self.failUnlessEqual(ga2("c:dir/file"),
330                                  (DefaultAliasMarker, "c:dir/file"))
331         else:
332             self.failUnlessEqual(ga2("c:"), ("CA", ""))
333             self.failUnlessEqual(ga2("c:file"), ("CA", "file"))
334             self.failUnlessEqual(ga2("c:dir/file"), ("CA", "dir/file"))
335         self.failUnlessEqual(ga2("work:"), ("WA", ""))
336         self.failUnlessEqual(ga2("work:file"), ("WA", "file"))
337         self.failUnlessEqual(ga2("work:dir/file"), ("WA", "dir/file"))
338         self.failUnlessEqual(ga2("URI:stuff"), ("URI:stuff", ""))
339         self.failUnlessEqual(ga2("URI:stuff/file"), ("URI:stuff", "file"))
340         self.failUnlessEqual(ga2("URI:stuff:./file"), ("URI:stuff", "file"))
341         self.failUnlessEqual(ga2("URI:stuff/dir/file"), ("URI:stuff", "dir/file"))
342         self.failUnlessEqual(ga2("URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
343         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:")
344         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:dir")
345         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:dir/file")
346
347         def ga3(path):
348             old = common.pretend_platform_uses_lettercolon
349             try:
350                 common.pretend_platform_uses_lettercolon = True
351                 retval = get_alias(aliases, path, None)
352             finally:
353                 common.pretend_platform_uses_lettercolon = old
354             return retval
355         self.failUnlessEqual(ga3("bare"), (DefaultAliasMarker, "bare"))
356         self.failUnlessEqual(ga3("baredir/file"),
357                              (DefaultAliasMarker, "baredir/file"))
358         self.failUnlessEqual(ga3("baredir/file:7"),
359                              (DefaultAliasMarker, "baredir/file:7"))
360         self.failUnlessEqual(ga3("baredir/sub:1/file:7"),
361                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
362         self.failUnlessEqual(ga3("tahoe:"), ("TA", ""))
363         self.failUnlessEqual(ga3("tahoe:file"), ("TA", "file"))
364         self.failUnlessEqual(ga3("tahoe:dir/file"), ("TA", "dir/file"))
365         self.failUnlessEqual(ga3("c:"), (DefaultAliasMarker, "c:"))
366         self.failUnlessEqual(ga3("c:file"), (DefaultAliasMarker, "c:file"))
367         self.failUnlessEqual(ga3("c:dir/file"),
368                              (DefaultAliasMarker, "c:dir/file"))
369         self.failUnlessEqual(ga3("work:"), ("WA", ""))
370         self.failUnlessEqual(ga3("work:file"), ("WA", "file"))
371         self.failUnlessEqual(ga3("work:dir/file"), ("WA", "dir/file"))
372         self.failUnlessEqual(ga3("URI:stuff"), ("URI:stuff", ""))
373         self.failUnlessEqual(ga3("URI:stuff:./file"), ("URI:stuff", "file"))
374         self.failUnlessEqual(ga3("URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
375         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:")
376         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:dir")
377         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:dir/file")
378         # calling get_alias with a path that doesn't include an alias and
379         # default set to something that isn't in the aliases argument should
380         # raise an UnknownAliasError.
381         def ga4(path):
382             return get_alias(aliases, path, "badddefault:")
383         self.failUnlessRaises(common.UnknownAliasError, ga4, "afile")
384         self.failUnlessRaises(common.UnknownAliasError, ga4, "a/dir/path/")
385
386         def ga5(path):
387             old = common.pretend_platform_uses_lettercolon
388             try:
389                 common.pretend_platform_uses_lettercolon = True
390                 retval = get_alias(aliases, path, "baddefault:")
391             finally:
392                 common.pretend_platform_uses_lettercolon = old
393             return retval
394         self.failUnlessRaises(common.UnknownAliasError, ga5, "C:\\Windows")
395
396
397 class Help(unittest.TestCase):
398
399     def test_get(self):
400         help = str(cli.GetOptions())
401         self.failUnless("get REMOTE_FILE LOCAL_FILE" in help, help)
402         self.failUnless("% tahoe get FOO |less" in help, help)
403
404     def test_put(self):
405         help = str(cli.PutOptions())
406         self.failUnless("put LOCAL_FILE REMOTE_FILE" in help, help)
407         self.failUnless("% cat FILE | tahoe put" in help, help)
408
409     def test_rm(self):
410         help = str(cli.RmOptions())
411         self.failUnless("rm REMOTE_FILE" in help, help)
412
413     def test_mv(self):
414         help = str(cli.MvOptions())
415         self.failUnless("mv FROM TO" in help, help)
416         self.failUnless("Use 'tahoe mv' to move files" in help)
417
418     def test_ln(self):
419         help = str(cli.LnOptions())
420         self.failUnless("ln FROM TO" in help, help)
421
422     def test_backup(self):
423         help = str(cli.BackupOptions())
424         self.failUnless("backup FROM ALIAS:TO" in help, help)
425
426     def test_webopen(self):
427         help = str(cli.WebopenOptions())
428         self.failUnless("webopen [ALIAS:PATH]" in help, help)
429
430     def test_manifest(self):
431         help = str(cli.ManifestOptions())
432         self.failUnless("manifest [ALIAS:PATH]" in help, help)
433
434     def test_stats(self):
435         help = str(cli.StatsOptions())
436         self.failUnless("stats [ALIAS:PATH]" in help, help)
437
438     def test_check(self):
439         help = str(cli.CheckOptions())
440         self.failUnless("check [ALIAS:PATH]" in help, help)
441
442     def test_deep_check(self):
443         help = str(cli.DeepCheckOptions())
444         self.failUnless("deep-check [ALIAS:PATH]" in help, help)
445
446     def test_create_alias(self):
447         help = str(cli.CreateAliasOptions())
448         self.failUnless("create-alias ALIAS" in help, help)
449
450     def test_add_aliases(self):
451         help = str(cli.AddAliasOptions())
452         self.failUnless("add-alias ALIAS DIRCAP" in help, help)
453
454 class CLITestMixin:
455     def do_cli(self, verb, *args, **kwargs):
456         nodeargs = [
457             "--node-directory", self.get_clientdir(),
458             ]
459         argv = [verb] + nodeargs + list(args)
460         stdin = kwargs.get("stdin", "")
461         stdout, stderr = StringIO(), StringIO()
462         d = threads.deferToThread(runner.runner, argv, run_by_human=False,
463                                   stdin=StringIO(stdin),
464                                   stdout=stdout, stderr=stderr)
465         def _done(rc):
466             return rc, stdout.getvalue(), stderr.getvalue()
467         d.addCallback(_done)
468         return d
469
470 class CreateAlias(GridTestMixin, CLITestMixin, unittest.TestCase):
471
472     def _test_webopen(self, args, expected_url):
473         woo = cli.WebopenOptions()
474         all_args = ["--node-directory", self.get_clientdir()] + list(args)
475         woo.parseOptions(all_args)
476         urls = []
477         rc = cli.webopen(woo, urls.append)
478         self.failUnlessEqual(rc, 0)
479         self.failUnlessEqual(len(urls), 1)
480         self.failUnlessEqual(urls[0], expected_url)
481
482     def test_create(self):
483         self.basedir = "cli/CreateAlias/create"
484         self.set_up_grid()
485         aliasfile = os.path.join(self.get_clientdir(), "private", "aliases")
486
487         d = self.do_cli("create-alias", "tahoe")
488         def _done((rc,stdout,stderr)):
489             self.failUnless("Alias 'tahoe' created" in stdout)
490             self.failIf(stderr)
491             aliases = get_aliases(self.get_clientdir())
492             self.failUnless("tahoe" in aliases)
493             self.failUnless(aliases["tahoe"].startswith("URI:DIR2:"))
494         d.addCallback(_done)
495         d.addCallback(lambda res: self.do_cli("create-alias", "two"))
496
497         def _stash_urls(res):
498             aliases = get_aliases(self.get_clientdir())
499             node_url_file = os.path.join(self.get_clientdir(), "node.url")
500             nodeurl = fileutil.read(node_url_file).strip()
501             self.welcome_url = nodeurl
502             uribase = nodeurl + "uri/"
503             self.tahoe_url = uribase + urllib.quote(aliases["tahoe"])
504             self.tahoe_subdir_url = self.tahoe_url + "/subdir"
505             self.two_url = uribase + urllib.quote(aliases["two"])
506             self.two_uri = aliases["two"]
507         d.addCallback(_stash_urls)
508
509         d.addCallback(lambda res: self.do_cli("create-alias", "two")) # dup
510         def _check_create_duplicate((rc,stdout,stderr)):
511             self.failIfEqual(rc, 0)
512             self.failUnless("Alias 'two' already exists!" in stderr)
513             aliases = get_aliases(self.get_clientdir())
514             self.failUnlessEqual(aliases["two"], self.two_uri)
515         d.addCallback(_check_create_duplicate)
516
517         d.addCallback(lambda res: self.do_cli("add-alias", "added", self.two_uri))
518         def _check_add((rc,stdout,stderr)):
519             self.failUnlessEqual(rc, 0)
520             self.failUnless("Alias 'added' added" in stdout)
521         d.addCallback(_check_add)
522
523         # check add-alias with a duplicate
524         d.addCallback(lambda res: self.do_cli("add-alias", "two", self.two_uri))
525         def _check_add_duplicate((rc,stdout,stderr)):
526             self.failIfEqual(rc, 0)
527             self.failUnless("Alias 'two' already exists!" in stderr)
528             aliases = get_aliases(self.get_clientdir())
529             self.failUnlessEqual(aliases["two"], self.two_uri)
530         d.addCallback(_check_add_duplicate)
531
532         def _test_urls(junk):
533             self._test_webopen([], self.welcome_url)
534             self._test_webopen(["/"], self.tahoe_url)
535             self._test_webopen(["tahoe:"], self.tahoe_url)
536             self._test_webopen(["tahoe:/"], self.tahoe_url)
537             self._test_webopen(["tahoe:subdir"], self.tahoe_subdir_url)
538             self._test_webopen(["-i", "tahoe:subdir"],
539                                self.tahoe_subdir_url+"?t=info")
540             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
541             self._test_webopen(["tahoe:subdir/file"],
542                                self.tahoe_subdir_url + '/file')
543             self._test_webopen(["--info", "tahoe:subdir/file"],
544                                self.tahoe_subdir_url + '/file?t=info')
545             # if "file" is indeed a file, then the url produced by webopen in
546             # this case is disallowed by the webui. but by design, webopen
547             # passes through the mistake from the user to the resultant
548             # webopened url
549             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
550             self._test_webopen(["two:"], self.two_url)
551         d.addCallback(_test_urls)
552
553         def _remove_trailing_newline_and_create_alias(ign):
554             # ticket #741 is about a manually-edited alias file (which
555             # doesn't end in a newline) being corrupted by a subsequent
556             # "tahoe create-alias"
557             old = fileutil.read(aliasfile)
558             fileutil.write(aliasfile, old.rstrip())
559             return self.do_cli("create-alias", "un-corrupted1")
560         d.addCallback(_remove_trailing_newline_and_create_alias)
561         def _check_not_corrupted1((rc,stdout,stderr)):
562             self.failUnless("Alias 'un-corrupted1' created" in stdout, stdout)
563             self.failIf(stderr)
564             # the old behavior was to simply append the new record, causing a
565             # line that looked like "NAME1: CAP1NAME2: CAP2". This won't look
566             # like a valid dircap, so get_aliases() will raise an exception.
567             aliases = get_aliases(self.get_clientdir())
568             self.failUnless("added" in aliases)
569             self.failUnless(aliases["added"].startswith("URI:DIR2:"))
570             # to be safe, let's confirm that we don't see "NAME2:" in CAP1.
571             # No chance of a false-negative, because the hyphen in
572             # "un-corrupted1" is not a valid base32 character.
573             self.failIfIn("un-corrupted1:", aliases["added"])
574             self.failUnless("un-corrupted1" in aliases)
575             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
576         d.addCallback(_check_not_corrupted1)
577
578         def _remove_trailing_newline_and_add_alias(ign):
579             # same thing, but for "tahoe add-alias"
580             old = fileutil.read(aliasfile)
581             fileutil.write(aliasfile, old.rstrip())
582             return self.do_cli("add-alias", "un-corrupted2", self.two_uri)
583         d.addCallback(_remove_trailing_newline_and_add_alias)
584         def _check_not_corrupted((rc,stdout,stderr)):
585             self.failUnless("Alias 'un-corrupted2' added" in stdout, stdout)
586             self.failIf(stderr)
587             aliases = get_aliases(self.get_clientdir())
588             self.failUnless("un-corrupted1" in aliases)
589             self.failUnless(aliases["un-corrupted1"].startswith("URI:DIR2:"))
590             self.failIfIn("un-corrupted2:", aliases["un-corrupted1"])
591             self.failUnless("un-corrupted2" in aliases)
592             self.failUnless(aliases["un-corrupted2"].startswith("URI:DIR2:"))
593         d.addCallback(_check_not_corrupted)
594
595         return d
596
597
598 class Ln(GridTestMixin, CLITestMixin, unittest.TestCase):
599     def _create_test_file(self):
600         data = "puppies" * 1000
601         path = os.path.join(self.basedir, "datafile")
602         f = open(path, 'wb')
603         f.write(data)
604         f.close()
605         self.datafile = path
606
607     def test_ln_without_alias(self):
608         # if invoked without an alias when the 'tahoe' alias doesn't
609         # exist, 'tahoe ln' should output a useful error message and not
610         # a stack trace
611         self.basedir = "cli/Ln/ln_without_alias"
612         self.set_up_grid()
613         d = self.do_cli("ln", "from", "to")
614         def _check((rc, out, err)):
615             self.failUnlessEqual(rc, 1)
616             self.failUnlessIn("error:", err)
617         d.addCallback(_check)
618         # Make sure that validation extends to the "to" parameter
619         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
620         d.addCallback(lambda ign: self._create_test_file())
621         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
622                                               "havasu:from"))
623         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "to"))
624         d.addCallback(_check)
625         return d
626
627     def test_ln_with_nonexistent_alias(self):
628         # If invoked with aliases that don't exist, 'tahoe ln' should
629         # output a useful error message and not a stack trace.
630         self.basedir = "cli/Ln/ln_with_nonexistent_alias"
631         self.set_up_grid()
632         d = self.do_cli("ln", "havasu:from", "havasu:to")
633         def _check((rc, out, err)):
634             self.failUnlessEqual(rc, 1)
635             self.failUnlessIn("error:", err)
636         d.addCallback(_check)
637         # Make sure that validation occurs on the to parameter if the
638         # from parameter passes.
639         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
640         d.addCallback(lambda ign: self._create_test_file())
641         d.addCallback(lambda ign: self.do_cli("put", self.datafile,
642                                               "havasu:from"))
643         d.addCallback(lambda ign: self.do_cli("ln", "havasu:from", "huron:to"))
644         d.addCallback(_check)
645         return d
646
647
648 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
649
650     def test_unlinked_immutable_stdin(self):
651         # tahoe get `echo DATA | tahoe put`
652         # tahoe get `echo DATA | tahoe put -`
653         self.basedir = "cli/Put/unlinked_immutable_stdin"
654         DATA = "data" * 100
655         self.set_up_grid()
656         d = self.do_cli("put", stdin=DATA)
657         def _uploaded(res):
658             (rc, stdout, stderr) = res
659             self.failUnless("waiting for file data on stdin.." in stderr)
660             self.failUnless("200 OK" in stderr, stderr)
661             self.readcap = stdout
662             self.failUnless(self.readcap.startswith("URI:CHK:"))
663         d.addCallback(_uploaded)
664         d.addCallback(lambda res: self.do_cli("get", self.readcap))
665         def _downloaded(res):
666             (rc, stdout, stderr) = res
667             self.failUnlessEqual(stderr, "")
668             self.failUnlessEqual(stdout, DATA)
669         d.addCallback(_downloaded)
670         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
671         d.addCallback(lambda (rc,stdout,stderr):
672                       self.failUnlessEqual(stdout, self.readcap))
673         return d
674
675     def test_unlinked_immutable_from_file(self):
676         # tahoe put file.txt
677         # tahoe put ./file.txt
678         # tahoe put /tmp/file.txt
679         # tahoe put ~/file.txt
680         self.basedir = "cli/Put/unlinked_immutable_from_file"
681         self.set_up_grid()
682
683         rel_fn = os.path.join(self.basedir, "DATAFILE")
684         abs_fn = os.path.abspath(rel_fn)
685         # we make the file small enough to fit in a LIT file, for speed
686         fileutil.write(rel_fn, "short file")
687         d = self.do_cli("put", rel_fn)
688         def _uploaded((rc,stdout,stderr)):
689             readcap = stdout
690             self.failUnless(readcap.startswith("URI:LIT:"))
691             self.readcap = readcap
692         d.addCallback(_uploaded)
693         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
694         d.addCallback(lambda (rc,stdout,stderr):
695                       self.failUnlessEqual(stdout, self.readcap))
696         d.addCallback(lambda res: self.do_cli("put", abs_fn))
697         d.addCallback(lambda (rc,stdout,stderr):
698                       self.failUnlessEqual(stdout, self.readcap))
699         # we just have to assume that ~ is handled properly
700         return d
701
702     def test_immutable_from_file(self):
703         # tahoe put file.txt uploaded.txt
704         # tahoe - uploaded.txt
705         # tahoe put file.txt subdir/uploaded.txt
706         # tahoe put file.txt tahoe:uploaded.txt
707         # tahoe put file.txt tahoe:subdir/uploaded.txt
708         # tahoe put file.txt DIRCAP:./uploaded.txt
709         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
710         self.basedir = "cli/Put/immutable_from_file"
711         self.set_up_grid()
712
713         rel_fn = os.path.join(self.basedir, "DATAFILE")
714         # we make the file small enough to fit in a LIT file, for speed
715         DATA = "short file"
716         DATA2 = "short file two"
717         fileutil.write(rel_fn, DATA)
718
719         d = self.do_cli("create-alias", "tahoe")
720
721         d.addCallback(lambda res:
722                       self.do_cli("put", rel_fn, "uploaded.txt"))
723         def _uploaded((rc,stdout,stderr)):
724             readcap = stdout.strip()
725             self.failUnless(readcap.startswith("URI:LIT:"))
726             self.failUnless("201 Created" in stderr, stderr)
727             self.readcap = readcap
728         d.addCallback(_uploaded)
729         d.addCallback(lambda res:
730                       self.do_cli("get", "tahoe:uploaded.txt"))
731         d.addCallback(lambda (rc,stdout,stderr):
732                       self.failUnlessEqual(stdout, DATA))
733
734         d.addCallback(lambda res:
735                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
736         def _replaced((rc,stdout,stderr)):
737             readcap = stdout.strip()
738             self.failUnless(readcap.startswith("URI:LIT:"))
739             self.failUnless("200 OK" in stderr, stderr)
740         d.addCallback(_replaced)
741
742         d.addCallback(lambda res:
743                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
744         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
745         d.addCallback(lambda (rc,stdout,stderr):
746                       self.failUnlessEqual(stdout, DATA))
747
748         d.addCallback(lambda res:
749                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
750         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
751         d.addCallback(lambda (rc,stdout,stderr):
752                       self.failUnlessEqual(stdout, DATA))
753
754         d.addCallback(lambda res:
755                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
756         d.addCallback(lambda res:
757                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
758         d.addCallback(lambda (rc,stdout,stderr):
759                       self.failUnlessEqual(stdout, DATA))
760
761         def _get_dircap(res):
762             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
763         d.addCallback(_get_dircap)
764
765         d.addCallback(lambda res:
766                       self.do_cli("put", rel_fn,
767                                   self.dircap+":./uploaded5.txt"))
768         d.addCallback(lambda res:
769                       self.do_cli("get", "tahoe:uploaded5.txt"))
770         d.addCallback(lambda (rc,stdout,stderr):
771                       self.failUnlessEqual(stdout, DATA))
772
773         d.addCallback(lambda res:
774                       self.do_cli("put", rel_fn,
775                                   self.dircap+":./subdir/uploaded6.txt"))
776         d.addCallback(lambda res:
777                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
778         d.addCallback(lambda (rc,stdout,stderr):
779                       self.failUnlessEqual(stdout, DATA))
780
781         return d
782
783     def test_mutable_unlinked(self):
784         # FILECAP = `echo DATA | tahoe put --mutable`
785         # tahoe get FILECAP, compare against DATA
786         # echo DATA2 | tahoe put - FILECAP
787         # tahoe get FILECAP, compare against DATA2
788         # tahoe put file.txt FILECAP
789         self.basedir = "cli/Put/mutable_unlinked"
790         self.set_up_grid()
791
792         DATA = "data" * 100
793         DATA2 = "two" * 100
794         rel_fn = os.path.join(self.basedir, "DATAFILE")
795         DATA3 = "three" * 100
796         fileutil.write(rel_fn, DATA3)
797
798         d = self.do_cli("put", "--mutable", stdin=DATA)
799         def _created(res):
800             (rc, stdout, stderr) = res
801             self.failUnless("waiting for file data on stdin.." in stderr)
802             self.failUnless("200 OK" in stderr)
803             self.filecap = stdout
804             self.failUnless(self.filecap.startswith("URI:SSK:"))
805         d.addCallback(_created)
806         d.addCallback(lambda res: self.do_cli("get", self.filecap))
807         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA))
808
809         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
810         def _replaced(res):
811             (rc, stdout, stderr) = res
812             self.failUnless("waiting for file data on stdin.." in stderr)
813             self.failUnless("200 OK" in stderr)
814             self.failUnlessEqual(self.filecap, stdout)
815         d.addCallback(_replaced)
816         d.addCallback(lambda res: self.do_cli("get", self.filecap))
817         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
818
819         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
820         def _replaced2(res):
821             (rc, stdout, stderr) = res
822             self.failUnless("200 OK" in stderr)
823             self.failUnlessEqual(self.filecap, stdout)
824         d.addCallback(_replaced2)
825         d.addCallback(lambda res: self.do_cli("get", self.filecap))
826         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA3))
827
828         return d
829
830     def test_mutable(self):
831         # echo DATA1 | tahoe put --mutable - uploaded.txt
832         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
833         # tahoe get uploaded.txt, compare against DATA2
834
835         self.basedir = "cli/Put/mutable"
836         self.set_up_grid()
837
838         DATA1 = "data" * 100
839         fn1 = os.path.join(self.basedir, "DATA1")
840         fileutil.write(fn1, DATA1)
841         DATA2 = "two" * 100
842         fn2 = os.path.join(self.basedir, "DATA2")
843         fileutil.write(fn2, DATA2)
844
845         d = self.do_cli("create-alias", "tahoe")
846         d.addCallback(lambda res:
847                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
848         d.addCallback(lambda res:
849                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
850         d.addCallback(lambda res:
851                       self.do_cli("get", "tahoe:uploaded.txt"))
852         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
853         return d
854
855     def test_put_with_nonexistent_alias(self):
856         # when invoked with an alias that doesn't exist, 'tahoe put'
857         # should output a useful error message, not a stack trace
858         self.basedir = "cli/Put/put_with_nonexistent_alias"
859         self.set_up_grid()
860         d = self.do_cli("put", "somefile", "fake:afile")
861         def _check((rc, out, err)):
862             self.failUnlessEqual(rc, 1)
863             self.failUnlessIn("error:", err)
864         d.addCallback(_check)
865         return d
866
867
868 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
869     def test_list(self):
870         self.basedir = "cli/List/list"
871         self.set_up_grid()
872         c0 = self.g.clients[0]
873         small = "small"
874         d = c0.create_dirnode()
875         def _stash_root_and_create_file(n):
876             self.rootnode = n
877             self.rooturi = n.get_uri()
878             return n.add_file(u"good", upload.Data(small, convergence=""))
879         d.addCallback(_stash_root_and_create_file)
880         def _stash_goodcap(n):
881             self.goodcap = n.get_uri()
882         d.addCallback(_stash_goodcap)
883         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
884         d.addCallback(lambda n:
885                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
886         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
887         d.addCallback(lambda n:
888                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
889         d.addCallback(lambda ign:
890                       self.do_cli("add-alias", "tahoe", self.rooturi))
891         d.addCallback(lambda ign: self.do_cli("ls"))
892         def _check1((rc,out,err)):
893             self.failUnlessEqual(err, "")
894             self.failUnlessEqual(rc, 0)
895             self.failUnlessEqual(out.splitlines(), ["0share", "1share", "good"])
896         d.addCallback(_check1)
897         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
898         def _check2((rc,out,err)):
899             self.failIfEqual(rc, 0)
900             self.failUnlessEqual(err.strip(), "No such file or directory")
901             self.failUnlessEqual(out, "")
902         d.addCallback(_check2)
903         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
904         def _check3((rc,out,err)):
905             self.failIfEqual(rc, 0)
906             self.failUnlessIn("Error during GET: 410 Gone ", err)
907             self.failUnlessIn("UnrecoverableFileError:", err)
908             self.failUnlessIn("could not be retrieved, because there were "
909                               "insufficient good shares.", err)
910             self.failUnlessEqual(out, "")
911         d.addCallback(_check3)
912         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
913         d.addCallback(_check3)
914         def _check4((rc, out, err)):
915             # listing a file (as dir/filename) should have the edge metadata,
916             # including the filename
917             self.failUnlessEqual(rc, 0)
918             self.failUnlessIn("good", out)
919             self.failIfIn("-r-- %d -" % len(small), out,
920                           "trailing hyphen means unknown date")
921         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
922         d.addCallback(_check4)
923         # listing a file as $DIRCAP/filename should work just like dir/filename
924         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + "/good"))
925         d.addCallback(_check4)
926         # and similarly for $DIRCAP:./filename
927         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.rooturi + ":./good"))
928         d.addCallback(_check4)
929         def _check5((rc, out, err)):
930             # listing a raw filecap should not explode, but it will have no
931             # metadata, just the size
932             self.failUnlessEqual(rc, 0)
933             self.failUnlessEqual("-r-- %d -" % len(small), out.strip())
934         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
935         d.addCallback(_check5)
936         unknown_immcap = "imm.URI:unknown"
937         def _create_unknown(ign):
938             nm = c0.nodemaker
939             kids = {u"unknownchild-imm": (nm.create_from_cap(unknown_immcap), {})}
940             return self.rootnode.create_subdirectory(u"unknown", initial_children=kids,
941                                                      mutable=False)
942         d.addCallback(_create_unknown)
943         def _check6((rc, out, err)):
944             # listing a directory referencing an unknown object should print
945             # an extra message to stderr
946             self.failUnlessEqual(rc, 0)
947             self.failUnlessIn("?r-- ? - unknownchild-imm\n", out)
948             self.failUnlessIn("included unknown objects", err)
949         d.addCallback(lambda ign: self.do_cli("ls", "-l", "unknown"))
950         d.addCallback(_check6)
951         def _check7((rc, out, err)):
952             # listing an unknown cap directly should print an extra message
953             # to stderr (currently this only works if the URI starts with 'URI:'
954             # after any 'ro.' or 'imm.' prefix, otherwise it will be confused
955             # with an alias).
956             self.failUnlessEqual(rc, 0)
957             self.failUnlessIn("?r-- ? -\n", out)
958             self.failUnlessIn("included unknown objects", err)
959         d.addCallback(lambda ign: self.do_cli("ls", "-l", unknown_immcap))
960         d.addCallback(_check7)
961         return d
962
963     def test_list_without_alias(self):
964         # doing just 'tahoe ls' without specifying an alias or first
965         # doing 'tahoe create-alias tahoe' should fail gracefully.
966         self.basedir = "cli/List/list_without_alias"
967         self.set_up_grid()
968         d = self.do_cli("ls")
969         def _check((rc, out, err)):
970             self.failUnlessEqual(rc, 1)
971             self.failUnlessIn("error:", err)
972         d.addCallback(_check)
973         return d
974
975     def test_list_with_nonexistent_alias(self):
976         # doing 'tahoe ls' while specifying an alias that doesn't already
977         # exist should fail with an informative error message
978         self.basedir = "cli/List/list_with_nonexistent_alias"
979         self.set_up_grid()
980         d = self.do_cli("ls", "nonexistent:")
981         def _check((rc, out, err)):
982             self.failUnlessEqual(rc, 1)
983             self.failUnlessIn("error:", err)
984             self.failUnlessIn("nonexistent", err)
985         d.addCallback(_check)
986         return d
987
988
989 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
990     def test_mv_behavior(self):
991         self.basedir = "cli/Mv/mv_behavior"
992         self.set_up_grid()
993         fn1 = os.path.join(self.basedir, "file1")
994         DATA1 = "Nuclear launch codes"
995         fileutil.write(fn1, DATA1)
996         fn2 = os.path.join(self.basedir, "file2")
997         DATA2 = "UML diagrams"
998         fileutil.write(fn2, DATA2)
999         # copy both files to the grid
1000         d = self.do_cli("create-alias", "tahoe")
1001         d.addCallback(lambda res:
1002             self.do_cli("cp", fn1, "tahoe:"))
1003         d.addCallback(lambda res:
1004             self.do_cli("cp", fn2, "tahoe:"))
1005
1006         # do mv file1 file3
1007         # (we should be able to rename files)
1008         d.addCallback(lambda res:
1009             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
1010         d.addCallback(lambda (rc, out, err):
1011             self.failUnlessIn("OK", out, "mv didn't rename a file"))
1012
1013         # do mv file3 file2
1014         # (This should succeed without issue)
1015         d.addCallback(lambda res:
1016             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
1017         # Out should contain "OK" to show that the transfer worked.
1018         d.addCallback(lambda (rc,out,err):
1019             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
1020
1021         # Next, make a remote directory.
1022         d.addCallback(lambda res:
1023             self.do_cli("mkdir", "tahoe:directory"))
1024
1025         # mv file2 directory
1026         # (should fail with a descriptive error message; the CLI mv
1027         #  client should support this)
1028         d.addCallback(lambda res:
1029             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
1030         d.addCallback(lambda (rc, out, err):
1031             self.failUnlessIn(
1032                 "Error: You can't overwrite a directory with a file", err,
1033                 "mv shouldn't overwrite directories" ))
1034
1035         # mv file2 directory/
1036         # (should succeed by making file2 a child node of directory)
1037         d.addCallback(lambda res:
1038             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
1039         # We should see an "OK"...
1040         d.addCallback(lambda (rc, out, err):
1041             self.failUnlessIn("OK", out,
1042                             "mv didn't mv a file into a directory"))
1043         # ... and be able to GET the file
1044         d.addCallback(lambda res:
1045             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
1046         d.addCallback(lambda (rc, out, err):
1047             self.failUnless(os.path.exists(self.basedir + "new"),
1048                             "mv didn't write the destination file"))
1049         # ... and not find the file where it was before.
1050         d.addCallback(lambda res:
1051             self.do_cli("get", "tahoe:file2", "file2"))
1052         d.addCallback(lambda (rc, out, err):
1053             self.failUnlessIn("404", err,
1054                             "mv left the source file intact"))
1055
1056         # Let's build:
1057         # directory/directory2/some_file
1058         # directory3
1059         d.addCallback(lambda res:
1060             self.do_cli("mkdir", "tahoe:directory/directory2"))
1061         d.addCallback(lambda res:
1062             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
1063         d.addCallback(lambda res:
1064             self.do_cli("mkdir", "tahoe:directory3"))
1065
1066         # Let's now try to mv directory/directory2/some_file to
1067         # directory3/some_file
1068         d.addCallback(lambda res:
1069             self.do_cli("mv", "tahoe:directory/directory2/some_file",
1070                         "tahoe:directory3/"))
1071         # We should have just some_file in tahoe:directory3
1072         d.addCallback(lambda res:
1073             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
1074         d.addCallback(lambda (rc, out, err):
1075             self.failUnless("404" not in err,
1076                               "mv didn't handle nested directories correctly"))
1077         d.addCallback(lambda res:
1078             self.do_cli("get", "tahoe:directory3/directory", "directory"))
1079         d.addCallback(lambda (rc, out, err):
1080             self.failUnlessIn("404", err,
1081                               "mv moved the wrong thing"))
1082         return d
1083
1084     def test_mv_without_alias(self):
1085         # doing 'tahoe mv' without explicitly specifying an alias or
1086         # creating the default 'tahoe' alias should fail with a useful
1087         # error message.
1088         self.basedir = "cli/Mv/mv_without_alias"
1089         self.set_up_grid()
1090         d = self.do_cli("mv", "afile", "anotherfile")
1091         def _check((rc, out, err)):
1092             self.failUnlessEqual(rc, 1)
1093             self.failUnlessIn("error:", err)
1094         d.addCallback(_check)
1095         # check to see that the validation extends to the
1096         # target argument by making an alias that will work with the first
1097         # one.
1098         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1099         def _create_a_test_file(ign):
1100             self.test_file_path = os.path.join(self.basedir, "afile")
1101             f = open(self.test_file_path, "wb")
1102             f.write("puppies" * 100)
1103             f.close()
1104         d.addCallback(_create_a_test_file)
1105         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1106                                               "havasu:afile"))
1107         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1108                                               "anotherfile"))
1109         d.addCallback(_check)
1110         return d
1111
1112     def test_mv_with_nonexistent_alias(self):
1113         # doing 'tahoe mv' with an alias that doesn't exist should fail
1114         # with an informative error message.
1115         self.basedir = "cli/Mv/mv_with_nonexistent_alias"
1116         self.set_up_grid()
1117         d = self.do_cli("mv", "fake:afile", "fake:anotherfile")
1118         def _check((rc, out, err)):
1119             self.failUnlessEqual(rc, 1)
1120             self.failUnlessIn("error:", err)
1121             self.failUnlessIn("fake", err)
1122         d.addCallback(_check)
1123         # check to see that the validation extends to the
1124         # target argument by making an alias that will work with the first
1125         # one.
1126         d.addCallback(lambda ign: self.do_cli("create-alias", "havasu"))
1127         def _create_a_test_file(ign):
1128             self.test_file_path = os.path.join(self.basedir, "afile")
1129             f = open(self.test_file_path, "wb")
1130             f.write("puppies" * 100)
1131             f.close()
1132         d.addCallback(_create_a_test_file)
1133         d.addCallback(lambda ign: self.do_cli("put", self.test_file_path,
1134                                               "havasu:afile"))
1135         d.addCallback(lambda ign: self.do_cli("mv", "havasu:afile",
1136                                               "fake:anotherfile"))
1137         d.addCallback(_check)
1138         return d
1139
1140
1141 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
1142
1143     def test_not_enough_args(self):
1144         o = cli.CpOptions()
1145         self.failUnlessRaises(usage.UsageError,
1146                               o.parseOptions, ["onearg"])
1147
1148     def test_unicode_filename(self):
1149         self.basedir = "cli/Cp/unicode_filename"
1150         self.set_up_grid()
1151
1152         fn1 = os.path.join(self.basedir, "Ärtonwall")
1153         DATA1 = "unicode file content"
1154         fileutil.write(fn1, DATA1)
1155
1156         fn2 = os.path.join(self.basedir, "Metallica")
1157         DATA2 = "non-unicode file content"
1158         fileutil.write(fn2, DATA2)
1159
1160         # Bug #534
1161         # Assure that uploading a file whose name contains unicode character
1162         # doesn't prevent further uploads in the same directory
1163         d = self.do_cli("create-alias", "tahoe")
1164         d.addCallback(lambda res: self.do_cli("cp", fn1, "tahoe:"))
1165         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
1166
1167         d.addCallback(lambda res: self.do_cli("get", "tahoe:Ärtonwall"))
1168         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA1))
1169
1170         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
1171         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
1172
1173         return d
1174     test_unicode_filename.todo = "This behavior is not yet supported, although it does happen to work (for reasons that are ill-understood) on many platforms.  See issue ticket #534."
1175
1176     def test_dangling_symlink_vs_recursion(self):
1177         if not hasattr(os, 'symlink'):
1178             raise unittest.SkipTest("There is no symlink on this platform.")
1179         # cp -r on a directory containing a dangling symlink shouldn't assert
1180         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
1181         self.set_up_grid()
1182         dn = os.path.join(self.basedir, "dir")
1183         os.mkdir(dn)
1184         fn = os.path.join(dn, "Fakebandica")
1185         ln = os.path.join(dn, "link")
1186         os.symlink(fn, ln)
1187
1188         d = self.do_cli("create-alias", "tahoe")
1189         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
1190                                               dn, "tahoe:"))
1191         return d
1192
1193     def test_copy_using_filecap(self):
1194         self.basedir = "cli/Cp/test_copy_using_filecap"
1195         self.set_up_grid()
1196         outdir = os.path.join(self.basedir, "outdir")
1197         os.mkdir(outdir)
1198         fn1 = os.path.join(self.basedir, "Metallica")
1199         fn2 = os.path.join(outdir, "Not Metallica")
1200         fn3 = os.path.join(outdir, "test2")
1201         DATA1 = "puppies" * 10000
1202         fileutil.write(fn1, DATA1)
1203
1204         d = self.do_cli("create-alias", "tahoe")
1205         d.addCallback(lambda ign: self.do_cli("put", fn1))
1206         def _put_file((rc, out, err)):
1207             self.failUnlessEqual(rc, 0)
1208             # keep track of the filecap
1209             self.filecap = out.strip()
1210         d.addCallback(_put_file)
1211
1212         # Let's try copying this to the disk using the filecap
1213         #  cp FILECAP filename
1214         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, fn2))
1215         def _copy_file((rc, out, err)):
1216             self.failUnlessEqual(rc, 0)
1217             results = fileutil.read(fn2)
1218             self.failUnlessEqual(results, DATA1)
1219         d.addCallback(_copy_file)
1220
1221         # Test with ./ (see #761)
1222         #  cp FILECAP localdir
1223         d.addCallback(lambda ign: self.do_cli("cp", self.filecap, outdir))
1224         def _resp((rc, out, err)):
1225             self.failUnlessEqual(rc, 1)
1226             self.failUnlessIn("error: you must specify a destination filename",
1227                               err)
1228         d.addCallback(_resp)
1229
1230         # Create a directory, linked at tahoe:test
1231         d.addCallback(lambda ign: self.do_cli("mkdir", "tahoe:test"))
1232         def _get_dir((rc, out, err)):
1233             self.failUnlessEqual(rc, 0)
1234             self.dircap = out.strip()
1235         d.addCallback(_get_dir)
1236
1237         # Upload a file to the directory
1238         d.addCallback(lambda ign:
1239                       self.do_cli("put", fn1, "tahoe:test/test_file"))
1240         d.addCallback(lambda (rc, out, err): self.failUnlessEqual(rc, 0))
1241
1242         #  cp DIRCAP/filename localdir
1243         d.addCallback(lambda ign:
1244                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1245         def _get_resp((rc, out, err)):
1246             self.failUnlessEqual(rc, 0)
1247             results = fileutil.read(os.path.join(outdir, "test_file"))
1248             self.failUnlessEqual(results, DATA1)
1249         d.addCallback(_get_resp)
1250
1251         #  cp -r DIRCAP/filename filename2
1252         d.addCallback(lambda ign:
1253                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1254         def _get_resp2((rc, out, err)):
1255             self.failUnlessEqual(rc, 0)
1256             results = fileutil.read(fn3)
1257             self.failUnlessEqual(results, DATA1)
1258         d.addCallback(_get_resp2)
1259         return d
1260
1261     def test_cp_with_nonexistent_alias(self):
1262         # when invoked with an alias or aliases that don't exist, 'tahoe cp'
1263         # should output a sensible error message rather than a stack trace.
1264         self.basedir = "cli/Cp/cp_with_nonexistent_alias"
1265         self.set_up_grid()
1266         d = self.do_cli("cp", "fake:file1", "fake:file2")
1267         def _check((rc, out, err)):
1268             self.failUnlessEqual(rc, 1)
1269             self.failUnlessIn("error:", err)
1270         d.addCallback(_check)
1271         # 'tahoe cp' actually processes the target argument first, so we need
1272         # to check to make sure that validation extends to the source
1273         # argument.
1274         d.addCallback(lambda ign: self.do_cli("create-alias", "tahoe"))
1275         d.addCallback(lambda ign: self.do_cli("cp", "fake:file1",
1276                                               "tahoe:file2"))
1277         d.addCallback(_check)
1278         return d
1279
1280
1281 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
1282
1283     def writeto(self, path, data):
1284         full_path = os.path.join(self.basedir, "home", path)
1285         fileutil.make_dirs(os.path.dirname(full_path))
1286         fileutil.write(full_path, data)
1287
1288     def count_output(self, out):
1289         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), "
1290                         "(\d)+ files skipped, "
1291                         "(\d+) directories created \((\d+) reused\), "
1292                         "(\d+) directories skipped", out)
1293         return [int(s) for s in mo.groups()]
1294
1295     def count_output2(self, out):
1296         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
1297         return [int(s) for s in mo.groups()]
1298
1299     def test_backup(self):
1300         self.basedir = "cli/Backup/backup"
1301         self.set_up_grid()
1302
1303         # is the backupdb available? If so, we test that a second backup does
1304         # not create new directories.
1305         hush = StringIO()
1306         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
1307                                          hush)
1308
1309         # create a small local directory with a couple of files
1310         source = os.path.join(self.basedir, "home")
1311         fileutil.make_dirs(os.path.join(source, "empty"))
1312         self.writeto("parent/subdir/foo.txt", "foo")
1313         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
1314         self.writeto("parent/blah.txt", "blah")
1315
1316         def do_backup(verbose=False):
1317             cmd = ["backup"]
1318             if verbose:
1319                 cmd.append("--verbose")
1320             cmd.append(source)
1321             cmd.append("tahoe:backups")
1322             return self.do_cli(*cmd)
1323
1324         d = self.do_cli("create-alias", "tahoe")
1325
1326         if not have_bdb:
1327             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
1328             def _should_complain((rc, out, err)):
1329                 self.failUnless("I was unable to import a python sqlite library" in err, err)
1330             d.addCallback(_should_complain)
1331             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
1332
1333         d.addCallback(lambda res: do_backup())
1334         def _check0((rc, out, err)):
1335             self.failUnlessEqual(err, "")
1336             self.failUnlessEqual(rc, 0)
1337             fu, fr, fs, dc, dr, ds = self.count_output(out)
1338             # foo.txt, bar.txt, blah.txt
1339             self.failUnlessEqual(fu, 3)
1340             self.failUnlessEqual(fr, 0)
1341             self.failUnlessEqual(fs, 0)
1342             # empty, home, home/parent, home/parent/subdir
1343             self.failUnlessEqual(dc, 4)
1344             self.failUnlessEqual(dr, 0)
1345             self.failUnlessEqual(ds, 0)
1346         d.addCallback(_check0)
1347
1348         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
1349         def _check1((rc, out, err)):
1350             self.failUnlessEqual(err, "")
1351             self.failUnlessEqual(rc, 0)
1352             lines = out.split("\n")
1353             children = dict([line.split() for line in lines if line])
1354             latest_uri = children["Latest"]
1355             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
1356             childnames = children.keys()
1357             self.failUnlessEqual(sorted(childnames), ["Archives", "Latest"])
1358         d.addCallback(_check1)
1359         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
1360         def _check2((rc, out, err)):
1361             self.failUnlessEqual(err, "")
1362             self.failUnlessEqual(rc, 0)
1363             self.failUnlessEqual(sorted(out.split()), ["empty", "parent"])
1364         d.addCallback(_check2)
1365         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
1366         def _check2a((rc, out, err)):
1367             self.failUnlessEqual(err, "")
1368             self.failUnlessEqual(rc, 0)
1369             self.failUnlessEqual(out.strip(), "")
1370         d.addCallback(_check2a)
1371         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1372         def _check3((rc, out, err)):
1373             self.failUnlessEqual(err, "")
1374             self.failUnlessEqual(rc, 0)
1375             self.failUnlessEqual(out, "foo")
1376         d.addCallback(_check3)
1377         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1378         def _check4((rc, out, err)):
1379             self.failUnlessEqual(err, "")
1380             self.failUnlessEqual(rc, 0)
1381             self.old_archives = out.split()
1382             self.failUnlessEqual(len(self.old_archives), 1)
1383         d.addCallback(_check4)
1384
1385
1386         d.addCallback(self.stall, 1.1)
1387         d.addCallback(lambda res: do_backup())
1388         def _check4a((rc, out, err)):
1389             # second backup should reuse everything, if the backupdb is
1390             # available
1391             self.failUnlessEqual(err, "")
1392             self.failUnlessEqual(rc, 0)
1393             if have_bdb:
1394                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1395                 # foo.txt, bar.txt, blah.txt
1396                 self.failUnlessEqual(fu, 0)
1397                 self.failUnlessEqual(fr, 3)
1398                 self.failUnlessEqual(fs, 0)
1399                 # empty, home, home/parent, home/parent/subdir
1400                 self.failUnlessEqual(dc, 0)
1401                 self.failUnlessEqual(dr, 4)
1402                 self.failUnlessEqual(ds, 0)
1403         d.addCallback(_check4a)
1404
1405         if have_bdb:
1406             # sneak into the backupdb, crank back the "last checked"
1407             # timestamp to force a check on all files
1408             def _reset_last_checked(res):
1409                 dbfile = os.path.join(self.get_clientdir(),
1410                                       "private", "backupdb.sqlite")
1411                 self.failUnless(os.path.exists(dbfile), dbfile)
1412                 bdb = backupdb.get_backupdb(dbfile)
1413                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
1414                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
1415                 bdb.connection.commit()
1416
1417             d.addCallback(_reset_last_checked)
1418
1419             d.addCallback(self.stall, 1.1)
1420             d.addCallback(lambda res: do_backup(verbose=True))
1421             def _check4b((rc, out, err)):
1422                 # we should check all files, and re-use all of them. None of
1423                 # the directories should have been changed, so we should
1424                 # re-use all of them too.
1425                 self.failUnlessEqual(err, "")
1426                 self.failUnlessEqual(rc, 0)
1427                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1428                 fchecked, dchecked = self.count_output2(out)
1429                 self.failUnlessEqual(fchecked, 3)
1430                 self.failUnlessEqual(fu, 0)
1431                 self.failUnlessEqual(fr, 3)
1432                 self.failUnlessEqual(fs, 0)
1433                 self.failUnlessEqual(dchecked, 4)
1434                 self.failUnlessEqual(dc, 0)
1435                 self.failUnlessEqual(dr, 4)
1436                 self.failUnlessEqual(ds, 0)
1437             d.addCallback(_check4b)
1438
1439         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1440         def _check5((rc, out, err)):
1441             self.failUnlessEqual(err, "")
1442             self.failUnlessEqual(rc, 0)
1443             self.new_archives = out.split()
1444             expected_new = 2
1445             if have_bdb:
1446                 expected_new += 1
1447             self.failUnlessEqual(len(self.new_archives), expected_new, out)
1448             # the original backup should still be the oldest (i.e. sorts
1449             # alphabetically towards the beginning)
1450             self.failUnlessEqual(sorted(self.new_archives)[0],
1451                                  self.old_archives[0])
1452         d.addCallback(_check5)
1453
1454         d.addCallback(self.stall, 1.1)
1455         def _modify(res):
1456             self.writeto("parent/subdir/foo.txt", "FOOF!")
1457             # and turn a file into a directory
1458             os.unlink(os.path.join(source, "parent/blah.txt"))
1459             os.mkdir(os.path.join(source, "parent/blah.txt"))
1460             self.writeto("parent/blah.txt/surprise file", "surprise")
1461             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
1462             # turn a directory into a file
1463             os.rmdir(os.path.join(source, "empty"))
1464             self.writeto("empty", "imagine nothing being here")
1465             return do_backup()
1466         d.addCallback(_modify)
1467         def _check5a((rc, out, err)):
1468             # second backup should reuse bar.txt (if backupdb is available),
1469             # and upload the rest. None of the directories can be reused.
1470             self.failUnlessEqual(err, "")
1471             self.failUnlessEqual(rc, 0)
1472             if have_bdb:
1473                 fu, fr, fs, dc, dr, ds = self.count_output(out)
1474                 # new foo.txt, surprise file, subfile, empty
1475                 self.failUnlessEqual(fu, 4)
1476                 # old bar.txt
1477                 self.failUnlessEqual(fr, 1)
1478                 self.failUnlessEqual(fs, 0)
1479                 # home, parent, subdir, blah.txt, surprisedir
1480                 self.failUnlessEqual(dc, 5)
1481                 self.failUnlessEqual(dr, 0)
1482                 self.failUnlessEqual(ds, 0)
1483         d.addCallback(_check5a)
1484         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1485         def _check6((rc, out, err)):
1486             self.failUnlessEqual(err, "")
1487             self.failUnlessEqual(rc, 0)
1488             self.new_archives = out.split()
1489             expected_new = 3
1490             if have_bdb:
1491                 expected_new += 1
1492             self.failUnlessEqual(len(self.new_archives), expected_new)
1493             self.failUnlessEqual(sorted(self.new_archives)[0],
1494                                  self.old_archives[0])
1495         d.addCallback(_check6)
1496         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1497         def _check7((rc, out, err)):
1498             self.failUnlessEqual(err, "")
1499             self.failUnlessEqual(rc, 0)
1500             self.failUnlessEqual(out, "FOOF!")
1501             # the old snapshot should not be modified
1502             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
1503         d.addCallback(_check7)
1504         def _check8((rc, out, err)):
1505             self.failUnlessEqual(err, "")
1506             self.failUnlessEqual(rc, 0)
1507             self.failUnlessEqual(out, "foo")
1508         d.addCallback(_check8)
1509
1510         return d
1511
1512     # on our old dapper buildslave, this test takes a long time (usually
1513     # 130s), so we have to bump up the default 120s timeout. The create-alias
1514     # and initial backup alone take 60s, probably because of the handful of
1515     # dirnodes being created (RSA key generation). The backup between check4
1516     # and check4a takes 6s, as does the backup before check4b.
1517     test_backup.timeout = 3000
1518
1519     def test_exclude_options(self):
1520         root_listdir = ('lib.a', '_darcs', 'subdir', 'nice_doc.lyx')
1521         subdir_listdir = ('another_doc.lyx', 'run_snake_run.py', 'CVS', '.svn', '_darcs')
1522         basedir = "cli/Backup/exclude_options"
1523         fileutil.make_dirs(basedir)
1524         nodeurl_path = os.path.join(basedir, 'node.url')
1525         fileutil.write(nodeurl_path, 'http://example.net:2357/')
1526
1527         def _check_filtering(filtered, all, included, excluded):
1528             filtered = set(filtered)
1529             all = set(all)
1530             included = set(included)
1531             excluded = set(excluded)
1532             self.failUnlessEqual(filtered, included)
1533             self.failUnlessEqual(all.difference(filtered), excluded)
1534
1535         # test simple exclude
1536         backup_options = cli.BackupOptions()
1537         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1538                                      basedir, 'from', 'to'])
1539         filtered = list(backup_options.filter_listdir(root_listdir))
1540         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1541                          ('nice_doc.lyx',))
1542         # multiple exclude
1543         backup_options = cli.BackupOptions()
1544         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
1545                                      basedir, 'from', 'to'])
1546         filtered = list(backup_options.filter_listdir(root_listdir))
1547         _check_filtering(filtered, root_listdir, ('_darcs', 'subdir'),
1548                          ('nice_doc.lyx', 'lib.a'))
1549         # vcs metadata exclusion
1550         backup_options = cli.BackupOptions()
1551         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
1552                                      basedir, 'from', 'to'])
1553         filtered = list(backup_options.filter_listdir(subdir_listdir))
1554         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'run_snake_run.py',),
1555                          ('CVS', '.svn', '_darcs'))
1556         # read exclude patterns from file
1557         exclusion_string = "_darcs\n*py\n.svn"
1558         excl_filepath = os.path.join(basedir, 'exclusion')
1559         fileutil.write(excl_filepath, exclusion_string)
1560         backup_options = cli.BackupOptions()
1561         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1562                                      basedir, 'from', 'to'])
1563         filtered = list(backup_options.filter_listdir(subdir_listdir))
1564         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'CVS'),
1565                          ('.svn', '_darcs', 'run_snake_run.py'))
1566         # text BackupConfigurationError
1567         self.failUnlessRaises(cli.BackupConfigurationError,
1568                               backup_options.parseOptions,
1569                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
1570                                basedir, 'from', 'to'])
1571
1572         # test that an iterator works too
1573         backup_options = cli.BackupOptions()
1574         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1575                                      basedir, 'from', 'to'])
1576         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1577         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1578                          ('nice_doc.lyx',))
1579
1580     def test_ignore_symlinks(self):
1581         if not hasattr(os, 'symlink'):
1582             raise unittest.SkipTest("There is no symlink on this platform.")
1583
1584         self.basedir = os.path.dirname(self.mktemp())
1585         self.set_up_grid()
1586
1587         source = os.path.join(self.basedir, "home")
1588         self.writeto("foo.txt", "foo")
1589         os.symlink(os.path.join(source, "foo.txt"), os.path.join(source, "foo2.txt"))
1590
1591         d = self.do_cli("create-alias", "tahoe")
1592         d.addCallback(lambda res: self.do_cli("backup", "--verbose", source, "tahoe:test"))
1593
1594         def _check((rc, out, err)):
1595             self.failUnlessEqual(rc, 2)
1596             foo2 = os.path.join(source, "foo2.txt")
1597             self.failUnlessEqual(err, "WARNING: cannot backup symlink %s\n" % foo2)
1598
1599             fu, fr, fs, dc, dr, ds = self.count_output(out)
1600             # foo.txt
1601             self.failUnlessEqual(fu, 1)
1602             self.failUnlessEqual(fr, 0)
1603             # foo2.txt
1604             self.failUnlessEqual(fs, 1)
1605             # home
1606             self.failUnlessEqual(dc, 1)
1607             self.failUnlessEqual(dr, 0)
1608             self.failUnlessEqual(ds, 0)
1609
1610         d.addCallback(_check)
1611         return d
1612
1613     def test_ignore_unreadable_file(self):
1614         self.basedir = os.path.dirname(self.mktemp())
1615         self.set_up_grid()
1616
1617         source = os.path.join(self.basedir, "home")
1618         self.writeto("foo.txt", "foo")
1619         os.chmod(os.path.join(source, "foo.txt"), 0000)
1620
1621         d = self.do_cli("create-alias", "tahoe")
1622         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1623
1624         def _check((rc, out, err)):
1625             self.failUnlessEqual(rc, 2)
1626             self.failUnlessEqual(err, "WARNING: permission denied on file %s\n" % os.path.join(source, "foo.txt"))
1627
1628             fu, fr, fs, dc, dr, ds = self.count_output(out)
1629             self.failUnlessEqual(fu, 0)
1630             self.failUnlessEqual(fr, 0)
1631             # foo.txt
1632             self.failUnlessEqual(fs, 1)
1633             # home
1634             self.failUnlessEqual(dc, 1)
1635             self.failUnlessEqual(dr, 0)
1636             self.failUnlessEqual(ds, 0)
1637         d.addCallback(_check)
1638
1639         # This is necessary for the temp files to be correctly removed
1640         def _cleanup(self):
1641             os.chmod(os.path.join(source, "foo.txt"), 0644)
1642         d.addCallback(_cleanup)
1643         d.addErrback(_cleanup)
1644
1645         return d
1646
1647     def test_ignore_unreadable_directory(self):
1648         self.basedir = os.path.dirname(self.mktemp())
1649         self.set_up_grid()
1650
1651         source = os.path.join(self.basedir, "home")
1652         os.mkdir(source)
1653         os.mkdir(os.path.join(source, "test"))
1654         os.chmod(os.path.join(source, "test"), 0000)
1655
1656         d = self.do_cli("create-alias", "tahoe")
1657         d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:test"))
1658
1659         def _check((rc, out, err)):
1660             self.failUnlessEqual(rc, 2)
1661             self.failUnlessEqual(err, "WARNING: permission denied on directory %s\n" % os.path.join(source, "test"))
1662
1663             fu, fr, fs, dc, dr, ds = self.count_output(out)
1664             self.failUnlessEqual(fu, 0)
1665             self.failUnlessEqual(fr, 0)
1666             self.failUnlessEqual(fs, 0)
1667             # home, test
1668             self.failUnlessEqual(dc, 2)
1669             self.failUnlessEqual(dr, 0)
1670             # test
1671             self.failUnlessEqual(ds, 1)
1672         d.addCallback(_check)
1673
1674         # This is necessary for the temp files to be correctly removed
1675         def _cleanup(self):
1676             os.chmod(os.path.join(source, "test"), 0655)
1677         d.addCallback(_cleanup)
1678         d.addErrback(_cleanup)
1679         return d
1680
1681     def test_backup_without_alias(self):
1682         # 'tahoe backup' should output a sensible error message when invoked
1683         # without an alias instead of a stack trace.
1684         self.basedir = os.path.dirname(self.mktemp())
1685         self.set_up_grid()
1686         source = os.path.join(self.basedir, "file1")
1687         d = self.do_cli('backup', source, source)
1688         def _check((rc, out, err)):
1689             self.failUnlessEqual(rc, 1)
1690             self.failUnlessIn("error:", err)
1691         d.addCallback(_check)
1692         return d
1693
1694     def test_backup_with_nonexistent_alias(self):
1695         # 'tahoe backup' should output a sensible error message when invoked
1696         # with a nonexistent alias.
1697         self.basedir = os.path.dirname(self.mktemp())
1698         self.set_up_grid()
1699         source = os.path.join(self.basedir, "file1")
1700         d = self.do_cli("backup", source, "nonexistent:" + source)
1701         def _check((rc, out, err)):
1702             self.failUnlessEqual(rc, 1)
1703             self.failUnlessIn("error:", err)
1704             self.failUnlessIn("nonexistent", err)
1705         d.addCallback(_check)
1706         return d
1707
1708
1709 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
1710
1711     def test_check(self):
1712         self.basedir = "cli/Check/check"
1713         self.set_up_grid()
1714         c0 = self.g.clients[0]
1715         DATA = "data" * 100
1716         d = c0.create_mutable_file(DATA)
1717         def _stash_uri(n):
1718             self.uri = n.get_uri()
1719         d.addCallback(_stash_uri)
1720
1721         d.addCallback(lambda ign: self.do_cli("check", self.uri))
1722         def _check1((rc, out, err)):
1723             self.failUnlessEqual(err, "")
1724             self.failUnlessEqual(rc, 0)
1725             lines = out.splitlines()
1726             self.failUnless("Summary: Healthy" in lines, out)
1727             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1728         d.addCallback(_check1)
1729
1730         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
1731         def _check2((rc, out, err)):
1732             self.failUnlessEqual(err, "")
1733             self.failUnlessEqual(rc, 0)
1734             data = simplejson.loads(out)
1735             self.failUnlessEqual(data["summary"], "Healthy")
1736         d.addCallback(_check2)
1737
1738         def _clobber_shares(ignored):
1739             # delete one, corrupt a second
1740             shares = self.find_shares(self.uri)
1741             self.failUnlessEqual(len(shares), 10)
1742             os.unlink(shares[0][2])
1743             cso = debug.CorruptShareOptions()
1744             cso.stdout = StringIO()
1745             cso.parseOptions([shares[1][2]])
1746             storage_index = uri.from_string(self.uri).get_storage_index()
1747             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
1748                                        (base32.b2a(shares[1][1]),
1749                                         base32.b2a(storage_index),
1750                                         shares[1][0])
1751             debug.corrupt_share(cso)
1752         d.addCallback(_clobber_shares)
1753
1754         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
1755         def _check3((rc, out, err)):
1756             self.failUnlessEqual(err, "")
1757             self.failUnlessEqual(rc, 0)
1758             lines = out.splitlines()
1759             summary = [l for l in lines if l.startswith("Summary")][0]
1760             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
1761                             in summary, summary)
1762             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1763             self.failUnless(" corrupt shares:" in lines, out)
1764             self.failUnless(self._corrupt_share_line in lines, out)
1765         d.addCallback(_check3)
1766
1767         d.addCallback(lambda ign:
1768                       self.do_cli("check", "--verify", "--repair", self.uri))
1769         def _check4((rc, out, err)):
1770             self.failUnlessEqual(err, "")
1771             self.failUnlessEqual(rc, 0)
1772             lines = out.splitlines()
1773             self.failUnless("Summary: not healthy" in lines, out)
1774             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1775             self.failUnless(" corrupt shares:" in lines, out)
1776             self.failUnless(self._corrupt_share_line in lines, out)
1777             self.failUnless(" repair successful" in lines, out)
1778         d.addCallback(_check4)
1779
1780         d.addCallback(lambda ign:
1781                       self.do_cli("check", "--verify", "--repair", self.uri))
1782         def _check5((rc, out, err)):
1783             self.failUnlessEqual(err, "")
1784             self.failUnlessEqual(rc, 0)
1785             lines = out.splitlines()
1786             self.failUnless("Summary: healthy" in lines, out)
1787             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1788             self.failIf(" corrupt shares:" in lines, out)
1789         d.addCallback(_check5)
1790
1791         return d
1792
1793     def test_deep_check(self):
1794         self.basedir = "cli/Check/deep_check"
1795         self.set_up_grid()
1796         c0 = self.g.clients[0]
1797         self.uris = {}
1798         self.fileurls = {}
1799         DATA = "data" * 100
1800         d = c0.create_dirnode()
1801         def _stash_root_and_create_file(n):
1802             self.rootnode = n
1803             self.rooturi = n.get_uri()
1804             return n.add_file(u"good", upload.Data(DATA, convergence=""))
1805         d.addCallback(_stash_root_and_create_file)
1806         def _stash_uri(fn, which):
1807             self.uris[which] = fn.get_uri()
1808             return fn
1809         d.addCallback(_stash_uri, "good")
1810         d.addCallback(lambda ign:
1811                       self.rootnode.add_file(u"small",
1812                                              upload.Data("literal",
1813                                                         convergence="")))
1814         d.addCallback(_stash_uri, "small")
1815         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
1816         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
1817         d.addCallback(_stash_uri, "mutable")
1818
1819         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1820         def _check1((rc, out, err)):
1821             self.failUnlessEqual(err, "")
1822             self.failUnlessEqual(rc, 0)
1823             lines = out.splitlines()
1824             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1825                             in lines, out)
1826         d.addCallback(_check1)
1827
1828         # root
1829         # root/good
1830         # root/small
1831         # root/mutable
1832
1833         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
1834                                               self.rooturi))
1835         def _check2((rc, out, err)):
1836             self.failUnlessEqual(err, "")
1837             self.failUnlessEqual(rc, 0)
1838             lines = out.splitlines()
1839             self.failUnless("<root>: Healthy" in lines, out)
1840             self.failUnless("small: Healthy (LIT)" in lines, out)
1841             self.failUnless("good: Healthy" in lines, out)
1842             self.failUnless("mutable: Healthy" in lines, out)
1843             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1844                             in lines, out)
1845         d.addCallback(_check2)
1846
1847         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1848         def _check_stats((rc, out, err)):
1849             self.failUnlessEqual(err, "")
1850             self.failUnlessEqual(rc, 0)
1851             lines = out.splitlines()
1852             self.failUnlessIn(" count-immutable-files: 1", lines)
1853             self.failUnlessIn("   count-mutable-files: 1", lines)
1854             self.failUnlessIn("   count-literal-files: 1", lines)
1855             self.failUnlessIn("     count-directories: 1", lines)
1856             self.failUnlessIn("  size-immutable-files: 400", lines)
1857             self.failUnlessIn("Size Histogram:", lines)
1858             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
1859             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
1860         d.addCallback(_check_stats)
1861
1862         def _clobber_shares(ignored):
1863             shares = self.find_shares(self.uris["good"])
1864             self.failUnlessEqual(len(shares), 10)
1865             os.unlink(shares[0][2])
1866
1867             shares = self.find_shares(self.uris["mutable"])
1868             cso = debug.CorruptShareOptions()
1869             cso.stdout = StringIO()
1870             cso.parseOptions([shares[1][2]])
1871             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
1872             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
1873                                        (base32.b2a(shares[1][1]),
1874                                         base32.b2a(storage_index),
1875                                         shares[1][0])
1876             debug.corrupt_share(cso)
1877         d.addCallback(_clobber_shares)
1878
1879         # root
1880         # root/good  [9 shares]
1881         # root/small
1882         # root/mutable [1 corrupt share]
1883
1884         d.addCallback(lambda ign:
1885                       self.do_cli("deep-check", "--verbose", self.rooturi))
1886         def _check3((rc, out, err)):
1887             self.failUnlessEqual(err, "")
1888             self.failUnlessEqual(rc, 0)
1889             lines = out.splitlines()
1890             self.failUnless("<root>: Healthy" in lines, out)
1891             self.failUnless("small: Healthy (LIT)" in lines, out)
1892             self.failUnless("mutable: Healthy" in lines, out) # needs verifier
1893             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1894                             in lines, out)
1895             self.failIf(self._corrupt_share_line in lines, out)
1896             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
1897                             in lines, out)
1898         d.addCallback(_check3)
1899
1900         d.addCallback(lambda ign:
1901                       self.do_cli("deep-check", "--verbose", "--verify",
1902                                   self.rooturi))
1903         def _check4((rc, out, err)):
1904             self.failUnlessEqual(err, "")
1905             self.failUnlessEqual(rc, 0)
1906             lines = out.splitlines()
1907             self.failUnless("<root>: Healthy" in lines, out)
1908             self.failUnless("small: Healthy (LIT)" in lines, out)
1909             mutable = [l for l in lines if l.startswith("mutable")][0]
1910             self.failUnless(mutable.startswith("mutable: Unhealthy: 9 shares (enc 3-of-10)"),
1911                             mutable)
1912             self.failUnless(self._corrupt_share_line in lines, out)
1913             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1914                             in lines, out)
1915             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
1916                             in lines, out)
1917         d.addCallback(_check4)
1918
1919         d.addCallback(lambda ign:
1920                       self.do_cli("deep-check", "--raw",
1921                                   self.rooturi))
1922         def _check5((rc, out, err)):
1923             self.failUnlessEqual(err, "")
1924             self.failUnlessEqual(rc, 0)
1925             lines = out.splitlines()
1926             units = [simplejson.loads(line) for line in lines]
1927             # root, small, good, mutable,  stats
1928             self.failUnlessEqual(len(units), 4+1)
1929         d.addCallback(_check5)
1930
1931         d.addCallback(lambda ign:
1932                       self.do_cli("deep-check",
1933                                   "--verbose", "--verify", "--repair",
1934                                   self.rooturi))
1935         def _check6((rc, out, err)):
1936             self.failUnlessEqual(err, "")
1937             self.failUnlessEqual(rc, 0)
1938             lines = out.splitlines()
1939             self.failUnless("<root>: healthy" in lines, out)
1940             self.failUnless("small: healthy" in lines, out)
1941             self.failUnless("mutable: not healthy" in lines, out)
1942             self.failUnless(self._corrupt_share_line in lines, out)
1943             self.failUnless("good: not healthy" in lines, out)
1944             self.failUnless("done: 4 objects checked" in lines, out)
1945             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
1946             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
1947                             in lines, out)
1948             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
1949         d.addCallback(_check6)
1950
1951         # now add a subdir, and a file below that, then make the subdir
1952         # unrecoverable
1953
1954         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
1955         d.addCallback(_stash_uri, "subdir")
1956         d.addCallback(lambda fn:
1957                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
1958         d.addCallback(lambda ign:
1959                       self.delete_shares_numbered(self.uris["subdir"],
1960                                                   range(10)))
1961
1962         # root
1963         # root/good
1964         # root/small
1965         # root/mutable
1966         # root/subdir [unrecoverable: 0 shares]
1967         # root/subfile
1968
1969         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
1970         def _manifest_failed((rc, out, err)):
1971             self.failIfEqual(rc, 0)
1972             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1973             # the fatal directory should still show up, as the last line
1974             self.failUnlessIn(" subdir\n", out)
1975         d.addCallback(_manifest_failed)
1976
1977         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1978         def _deep_check_failed((rc, out, err)):
1979             self.failIfEqual(rc, 0)
1980             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1981             # we want to make sure that the error indication is the last
1982             # thing that gets emitted
1983             self.failIf("done:" in out, out)
1984         d.addCallback(_deep_check_failed)
1985
1986         # this test is disabled until the deep-repair response to an
1987         # unrepairable directory is fixed. The failure-to-repair should not
1988         # throw an exception, but the failure-to-traverse that follows
1989         # should throw UnrecoverableFileError.
1990
1991         #d.addCallback(lambda ign:
1992         #              self.do_cli("deep-check", "--repair", self.rooturi))
1993         #def _deep_check_repair_failed((rc, out, err)):
1994         #    self.failIfEqual(rc, 0)
1995         #    print err
1996         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1997         #    self.failIf("done:" in out, out)
1998         #d.addCallback(_deep_check_repair_failed)
1999
2000         return d
2001
2002     def test_check_without_alias(self):
2003         # 'tahoe check' should output a sensible error message if it needs to
2004         # find the default alias and can't
2005         self.basedir = "cli/Check/check_without_alias"
2006         self.set_up_grid()
2007         d = self.do_cli("check")
2008         def _check((rc, out, err)):
2009             self.failUnlessEqual(rc, 1)
2010             self.failUnlessIn("error:", err)
2011         d.addCallback(_check)
2012         d.addCallback(lambda ign: self.do_cli("deep-check"))
2013         d.addCallback(_check)
2014         return d
2015
2016     def test_check_with_nonexistent_alias(self):
2017         # 'tahoe check' should output a sensible error message if it needs to
2018         # find an alias and can't.
2019         self.basedir = "cli/Check/check_with_nonexistent_alias"
2020         self.set_up_grid()
2021         d = self.do_cli("check", "nonexistent:")
2022         def _check((rc, out, err)):
2023             self.failUnlessEqual(rc, 1)
2024             self.failUnlessIn("error:", err)
2025             self.failUnlessIn("nonexistent", err)
2026         d.addCallback(_check)
2027         return d
2028
2029
2030 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
2031     def test_get(self):
2032         self.basedir = "cli/Errors/get"
2033         self.set_up_grid()
2034         c0 = self.g.clients[0]
2035         self.fileurls = {}
2036         DATA = "data" * 100
2037         d = c0.upload(upload.Data(DATA, convergence=""))
2038         def _stash_bad(ur):
2039             self.uri_1share = ur.uri
2040             self.delete_shares_numbered(ur.uri, range(1,10))
2041         d.addCallback(_stash_bad)
2042
2043         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
2044         def _check1((rc, out, err)):
2045             self.failIfEqual(rc, 0)
2046             self.failUnless("410 Gone" in err, err)
2047             self.failUnlessIn("NotEnoughSharesError: ", err)
2048             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
2049         d.addCallback(_check1)
2050
2051         targetf = os.path.join(self.basedir, "output")
2052         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
2053         def _check2((rc, out, err)):
2054             self.failIfEqual(rc, 0)
2055             self.failUnless("410 Gone" in err, err)
2056             self.failUnlessIn("NotEnoughSharesError: ", err)
2057             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
2058             self.failIf(os.path.exists(targetf))
2059         d.addCallback(_check2)
2060
2061         return d
2062
2063
2064 class Get(GridTestMixin, CLITestMixin, unittest.TestCase):
2065     def test_get_without_alias(self):
2066         # 'tahoe get' should output a useful error message when invoked
2067         # without an explicit alias and when the default 'tahoe' alias
2068         # hasn't been created yet.
2069         self.basedir = "cli/Get/get_without_alias"
2070         self.set_up_grid()
2071         d = self.do_cli('get', 'file')
2072         def _check((rc, out, err)):
2073             self.failUnlessEqual(rc, 1)
2074             self.failUnlessIn("error:", err)
2075         d.addCallback(_check)
2076         return d
2077
2078     def test_get_with_nonexistent_alias(self):
2079         # 'tahoe get' should output a useful error message when invoked with
2080         # an explicit alias that doesn't exist.
2081         self.basedir = "cli/Get/get_with_nonexistent_alias"
2082         self.set_up_grid()
2083         d = self.do_cli("get", "nonexistent:file")
2084         def _check((rc, out, err)):
2085             self.failUnlessEqual(rc, 1)
2086             self.failUnlessIn("error:", err)
2087             self.failUnlessIn("nonexistent", err)
2088         d.addCallback(_check)
2089         return d
2090
2091
2092 class Manifest(GridTestMixin, CLITestMixin, unittest.TestCase):
2093     def test_manifest_without_alias(self):
2094         # 'tahoe manifest' should output a useful error message when invoked
2095         # without an explicit alias when the default 'tahoe' alias is
2096         # missing.
2097         self.basedir = "cli/Manifest/manifest_without_alias"
2098         self.set_up_grid()
2099         d = self.do_cli("manifest")
2100         def _check((rc, out, err)):
2101             self.failUnlessEqual(rc, 1)
2102             self.failUnlessIn("error:", err)
2103         d.addCallback(_check)
2104         return d
2105
2106     def test_manifest_with_nonexistent_alias(self):
2107         # 'tahoe manifest' should output a useful error message when invoked
2108         # with an explicit alias that doesn't exist.
2109         self.basedir = "cli/Manifest/manifest_with_nonexistent_alias"
2110         self.set_up_grid()
2111         d = self.do_cli("manifest", "nonexistent:")
2112         def _check((rc, out, err)):
2113             self.failUnlessEqual(rc, 1)
2114             self.failUnlessIn("error:", err)
2115             self.failUnlessIn("nonexistent", err)
2116         d.addCallback(_check)
2117         return d
2118
2119
2120 class Mkdir(GridTestMixin, CLITestMixin, unittest.TestCase):
2121     def test_mkdir_with_nonexistent_alias(self):
2122         # when invoked with an alias that doesn't exist, 'tahoe mkdir' should
2123         # output a sensible error message rather than a stack trace.
2124         self.basedir = "cli/Mkdir/mkdir_with_nonexistent_alias"
2125         self.set_up_grid()
2126         d = self.do_cli("mkdir", "havasu:")
2127         def _check((rc, out, err)):
2128             self.failUnlessEqual(rc, 1)
2129             self.failUnlessIn("error:", err)
2130         d.addCallback(_check)
2131         return d
2132
2133
2134 class Rm(GridTestMixin, CLITestMixin, unittest.TestCase):
2135     def test_rm_without_alias(self):
2136         # 'tahoe rm' should behave sensibly when invoked without an explicit
2137         # alias before the default 'tahoe' alias has been created.
2138         self.basedir = "cli/Rm/rm_without_alias"
2139         self.set_up_grid()
2140         d = self.do_cli("rm", "afile")
2141         def _check((rc, out, err)):
2142             self.failUnlessIn("error:", err)
2143             self.failUnlessEqual(rc, 1)
2144         d.addCallback(_check)
2145         return d
2146
2147     def test_rm_with_nonexistent_alias(self):
2148         # 'tahoe rm' should behave sensibly when invoked with an explicit
2149         # alias that doesn't exist.
2150         self.basedir = "cli/Rm/rm_with_nonexistent_alias"
2151         self.set_up_grid()
2152         d = self.do_cli("rm", "nonexistent:afile")
2153         def _check((rc, out, err)):
2154             self.failUnlessEqual(rc, 1)
2155             self.failUnlessIn("error:", err)
2156             self.failUnlessIn("nonexistent", err)
2157         d.addCallback(_check)
2158         return d
2159
2160
2161 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
2162     def test_empty_directory(self):
2163         self.basedir = "cli/Stats/empty_directory"
2164         self.set_up_grid()
2165         c0 = self.g.clients[0]
2166         self.fileurls = {}
2167         d = c0.create_dirnode()
2168         def _stash_root(n):
2169             self.rootnode = n
2170             self.rooturi = n.get_uri()
2171         d.addCallback(_stash_root)
2172
2173         # make sure we can get stats on an empty directory too
2174         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
2175         def _check_stats((rc, out, err)):
2176             self.failUnlessEqual(err, "")
2177             self.failUnlessEqual(rc, 0)
2178             lines = out.splitlines()
2179             self.failUnlessIn(" count-immutable-files: 0", lines)
2180             self.failUnlessIn("   count-mutable-files: 0", lines)
2181             self.failUnlessIn("   count-literal-files: 0", lines)
2182             self.failUnlessIn("     count-directories: 1", lines)
2183             self.failUnlessIn("  size-immutable-files: 0", lines)
2184             self.failIfIn("Size Histogram:", lines)
2185         d.addCallback(_check_stats)
2186
2187         return d
2188
2189     def test_stats_without_alias(self):
2190         # when invoked with no explicit alias and before the default 'tahoe'
2191         # alias is created, 'tahoe stats' should output an informative error
2192         # message, not a stack trace.
2193         self.basedir = "cli/Stats/stats_without_alias"
2194         self.set_up_grid()
2195         d = self.do_cli("stats")
2196         def _check((rc, out, err)):
2197             self.failUnlessEqual(rc, 1)
2198             self.failUnlessIn("error:", err)
2199         d.addCallback(_check)
2200         return d
2201
2202     def test_stats_with_nonexistent_alias(self):
2203         # when invoked with an explicit alias that doesn't exist,
2204         # 'tahoe stats' should output a useful error message.
2205         self.basedir = "cli/Stats/stats_with_nonexistent_alias"
2206         self.set_up_grid()
2207         d = self.do_cli("stats", "havasu:")
2208         def _check((rc, out, err)):
2209             self.failUnlessEqual(rc, 1)
2210             self.failUnlessIn("error:", err)
2211         d.addCallback(_check)
2212         return d
2213
2214
2215 class Webopen(GridTestMixin, CLITestMixin, unittest.TestCase):
2216     def test_webopen_with_nonexistent_alias(self):
2217         # when invoked with an alias that doesn't exist, 'tahoe webopen'
2218         # should output an informative error message instead of a stack
2219         # trace.
2220         self.basedir = "cli/Webopen/webopen_with_nonexistent_alias"
2221         self.set_up_grid()
2222         d = self.do_cli("webopen", "fake:")
2223         def _check((rc, out, err)):
2224             self.failUnlessEqual(rc, 1)
2225             self.failUnlessIn("error:", err)
2226         d.addCallback(_check)
2227         return d