]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - src/allmydata/test/test_cli.py
Touch up #705 changes:
[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 functionality are
15 # 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 class CLI(unittest.TestCase):
32     # this test case only looks at argument-processing and simple stuff.
33     def test_options(self):
34         fileutil.rm_dir("cli/test_options")
35         fileutil.make_dirs("cli/test_options")
36         fileutil.make_dirs("cli/test_options/private")
37         open("cli/test_options/node.url","w").write("http://localhost:8080/\n")
38         filenode_uri = uri.WriteableSSKFileURI(writekey="\x00"*16,
39                                                fingerprint="\x00"*32)
40         private_uri = uri.DirectoryURI(filenode_uri).to_string()
41         open("cli/test_options/private/root_dir.cap", "w").write(private_uri + "\n")
42         o = cli.ListOptions()
43         o.parseOptions(["--node-directory", "cli/test_options"])
44         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
45         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], private_uri)
46         self.failUnlessEqual(o.where, "")
47
48         o = cli.ListOptions()
49         o.parseOptions(["--node-directory", "cli/test_options",
50                         "--node-url", "http://example.org:8111/"])
51         self.failUnlessEqual(o['node-url'], "http://example.org:8111/")
52         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], private_uri)
53         self.failUnlessEqual(o.where, "")
54
55         o = cli.ListOptions()
56         o.parseOptions(["--node-directory", "cli/test_options",
57                         "--dir-cap", "root"])
58         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
59         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], "root")
60         self.failUnlessEqual(o.where, "")
61
62         o = cli.ListOptions()
63         other_filenode_uri = uri.WriteableSSKFileURI(writekey="\x11"*16,
64                                                      fingerprint="\x11"*32)
65         other_uri = uri.DirectoryURI(other_filenode_uri).to_string()
66         o.parseOptions(["--node-directory", "cli/test_options",
67                         "--dir-cap", other_uri])
68         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
69         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], other_uri)
70         self.failUnlessEqual(o.where, "")
71
72         o = cli.ListOptions()
73         o.parseOptions(["--node-directory", "cli/test_options",
74                         "--dir-cap", other_uri, "subdir"])
75         self.failUnlessEqual(o['node-url'], "http://localhost:8080/")
76         self.failUnlessEqual(o.aliases[DEFAULT_ALIAS], other_uri)
77         self.failUnlessEqual(o.where, "subdir")
78
79         o = cli.ListOptions()
80         self.failUnlessRaises(usage.UsageError,
81                               o.parseOptions,
82                               ["--node-directory", "cli/test_options",
83                                "--node-url", "NOT-A-URL"])
84
85         o = cli.ListOptions()
86         o.parseOptions(["--node-directory", "cli/test_options",
87                         "--node-url", "http://localhost:8080"])
88         self.failUnlessEqual(o["node-url"], "http://localhost:8080/")
89
90     def _dump_cap(self, *args):
91         config = debug.DumpCapOptions()
92         config.stdout,config.stderr = StringIO(), StringIO()
93         config.parseOptions(args)
94         debug.dump_cap(config)
95         self.failIf(config.stderr.getvalue())
96         output = config.stdout.getvalue()
97         return output
98
99     def test_dump_cap_chk(self):
100         key = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f"
101         storage_index = hashutil.storage_index_hash(key)
102         uri_extension_hash = hashutil.uri_extension_hash("stuff")
103         needed_shares = 25
104         total_shares = 100
105         size = 1234
106         u = uri.CHKFileURI(key=key,
107                            uri_extension_hash=uri_extension_hash,
108                            needed_shares=needed_shares,
109                            total_shares=total_shares,
110                            size=size)
111         output = self._dump_cap(u.to_string())
112         self.failUnless("CHK File:" in output, output)
113         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
114         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
115         self.failUnless("size: 1234" in output, output)
116         self.failUnless("k/N: 25/100" in output, output)
117         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
118
119         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
120                                 u.to_string())
121         self.failUnless("client renewal secret: znxmki5zdibb5qlt46xbdvk2t55j7hibejq3i5ijyurkr6m6jkhq" in output, output)
122
123         output = self._dump_cap(u.get_verify_cap().to_string())
124         self.failIf("key: " in output, output)
125         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
126         self.failUnless("size: 1234" in output, output)
127         self.failUnless("k/N: 25/100" in output, output)
128         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
129
130         prefixed_u = "http://127.0.0.1/uri/%s" % urllib.quote(u.to_string())
131         output = self._dump_cap(prefixed_u)
132         self.failUnless("CHK File:" in output, output)
133         self.failUnless("key: aaaqeayeaudaocajbifqydiob4" in output, output)
134         self.failUnless("UEB hash: nf3nimquen7aeqm36ekgxomalstenpkvsdmf6fplj7swdatbv5oa" in output, output)
135         self.failUnless("size: 1234" in output, output)
136         self.failUnless("k/N: 25/100" in output, output)
137         self.failUnless("storage index: hdis5iaveku6lnlaiccydyid7q" in output, output)
138
139     def test_dump_cap_lit(self):
140         u = uri.LiteralFileURI("this is some data")
141         output = self._dump_cap(u.to_string())
142         self.failUnless("Literal File URI:" in output, output)
143         self.failUnless("data: this is some data" in output, output)
144
145     def test_dump_cap_ssk(self):
146         writekey = "\x01" * 16
147         fingerprint = "\xfe" * 32
148         u = uri.WriteableSSKFileURI(writekey, fingerprint)
149
150         output = self._dump_cap(u.to_string())
151         self.failUnless("SSK Writeable URI:" in output, output)
152         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output, output)
153         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
154         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
155         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
156
157         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
158                                 u.to_string())
159         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
160
161         fileutil.make_dirs("cli/test_dump_cap/private")
162         f = open("cli/test_dump_cap/private/secret", "w")
163         f.write("5s33nk3qpvnj2fw3z4mnm2y6fa\n")
164         f.close()
165         output = self._dump_cap("--client-dir", "cli/test_dump_cap",
166                                 u.to_string())
167         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
168
169         output = self._dump_cap("--client-dir", "cli/test_dump_cap_BOGUS",
170                                 u.to_string())
171         self.failIf("file renewal secret:" in output, output)
172
173         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
174                                 u.to_string())
175         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
176         self.failIf("file renewal secret:" in output, output)
177
178         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
179                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
180                                 u.to_string())
181         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
182         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
183         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
184
185         u = u.get_readonly()
186         output = self._dump_cap(u.to_string())
187         self.failUnless("SSK Read-only URI:" in output, output)
188         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
189         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
190         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
191
192         u = u.get_verify_cap()
193         output = self._dump_cap(u.to_string())
194         self.failUnless("SSK Verifier URI:" in output, output)
195         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
196         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
197
198     def test_dump_cap_directory(self):
199         writekey = "\x01" * 16
200         fingerprint = "\xfe" * 32
201         u1 = uri.WriteableSSKFileURI(writekey, fingerprint)
202         u = uri.DirectoryURI(u1)
203
204         output = self._dump_cap(u.to_string())
205         self.failUnless("Directory Writeable URI:" in output, output)
206         self.failUnless("writekey: aeaqcaibaeaqcaibaeaqcaibae" in output,
207                         output)
208         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
209         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output,
210                         output)
211         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
212
213         output = self._dump_cap("--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
214                                 u.to_string())
215         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
216
217         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
218                                 u.to_string())
219         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
220         self.failIf("file renewal secret:" in output, output)
221
222         output = self._dump_cap("--nodeid", "tqc35esocrvejvg4mablt6aowg6tl43j",
223                                 "--client-secret", "5s33nk3qpvnj2fw3z4mnm2y6fa",
224                                 u.to_string())
225         self.failUnless("write_enabler: mgcavriox2wlb5eer26unwy5cw56elh3sjweffckkmivvsxtaknq" in output, output)
226         self.failUnless("file renewal secret: arpszxzc2t6kb4okkg7sp765xgkni5z7caavj7lta73vmtymjlxq" in output, output)
227         self.failUnless("lease renewal secret: 7pjtaumrb7znzkkbvekkmuwpqfjyfyamznfz4bwwvmh4nw33lorq" in output, output)
228
229         u = u.get_readonly()
230         output = self._dump_cap(u.to_string())
231         self.failUnless("Directory Read-only URI:" in output, output)
232         self.failUnless("readkey: nvgh5vj2ekzzkim5fgtb4gey5y" in output, output)
233         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
234         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
235
236         u = u.get_verify_cap()
237         output = self._dump_cap(u.to_string())
238         self.failUnless("Directory Verifier URI:" in output, output)
239         self.failUnless("storage index: nt4fwemuw7flestsezvo2eveke" in output, output)
240         self.failUnless("fingerprint: 737p57x6737p57x6737p57x6737p57x6737p57x6737p57x6737a" in output, output)
241
242     def _catalog_shares(self, *basedirs):
243         o = debug.CatalogSharesOptions()
244         o.stdout,o.stderr = StringIO(), StringIO()
245         args = list(basedirs)
246         o.parseOptions(args)
247         debug.catalog_shares(o)
248         out = o.stdout.getvalue()
249         err = o.stderr.getvalue()
250         return out, err
251
252     def test_catalog_shares_error(self):
253         nodedir1 = "cli/test_catalog_shares/node1"
254         sharedir = os.path.join(nodedir1, "storage", "shares", "mq", "mqfblse6m5a6dh45isu2cg7oji")
255         fileutil.make_dirs(sharedir)
256         f = open(os.path.join(sharedir, "8"), "wb")
257         open("cli/test_catalog_shares/node1/storage/shares/mq/not-a-dir", "wb").close()
258         # write a bogus share that looks a little bit like CHK
259         f.write("\x00\x00\x00\x01" + "\xff" * 200) # this triggers an assert
260         f.close()
261
262         nodedir2 = "cli/test_catalog_shares/node2"
263         fileutil.make_dirs(nodedir2)
264         open("cli/test_catalog_shares/node1/storage/shares/not-a-dir", "wb").close()
265
266         # now make sure that the 'catalog-shares' commands survives the error
267         out, err = self._catalog_shares(nodedir1, nodedir2)
268         self.failUnlessEqual(out, "", out)
269         self.failUnless("Error processing " in err,
270                         "didn't see 'error processing' in '%s'" % err)
271         #self.failUnless(nodedir1 in err,
272         #                "didn't see '%s' in '%s'" % (nodedir1, err))
273         # windows mangles the path, and os.path.join isn't enough to make
274         # up for it, so just look for individual strings
275         self.failUnless("node1" in err,
276                         "didn't see 'node1' in '%s'" % err)
277         self.failUnless("mqfblse6m5a6dh45isu2cg7oji" in err,
278                         "didn't see 'mqfblse6m5a6dh45isu2cg7oji' in '%s'" % err)
279
280     def test_alias(self):
281         aliases = {"tahoe": "TA",
282                    "work": "WA",
283                    "c": "CA"}
284         def ga1(path):
285             return get_alias(aliases, path, "tahoe")
286         uses_lettercolon = common.platform_uses_lettercolon_drivename()
287         self.failUnlessEqual(ga1("bare"), ("TA", "bare"))
288         self.failUnlessEqual(ga1("baredir/file"), ("TA", "baredir/file"))
289         self.failUnlessEqual(ga1("baredir/file:7"), ("TA", "baredir/file:7"))
290         self.failUnlessEqual(ga1("tahoe:"), ("TA", ""))
291         self.failUnlessEqual(ga1("tahoe:file"), ("TA", "file"))
292         self.failUnlessEqual(ga1("tahoe:dir/file"), ("TA", "dir/file"))
293         self.failUnlessEqual(ga1("work:"), ("WA", ""))
294         self.failUnlessEqual(ga1("work:file"), ("WA", "file"))
295         self.failUnlessEqual(ga1("work:dir/file"), ("WA", "dir/file"))
296         # default != None means we really expect a tahoe path, regardless of
297         # whether we're on windows or not. This is what 'tahoe get' uses.
298         self.failUnlessEqual(ga1("c:"), ("CA", ""))
299         self.failUnlessEqual(ga1("c:file"), ("CA", "file"))
300         self.failUnlessEqual(ga1("c:dir/file"), ("CA", "dir/file"))
301         self.failUnlessEqual(ga1("URI:stuff"), ("URI:stuff", ""))
302         self.failUnlessEqual(ga1("URI:stuff:./file"), ("URI:stuff", "file"))
303         self.failUnlessEqual(ga1("URI:stuff:./dir/file"),
304                              ("URI:stuff", "dir/file"))
305         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:")
306         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:dir")
307         self.failUnlessRaises(common.UnknownAliasError, ga1, "missing:dir/file")
308
309         def ga2(path):
310             return get_alias(aliases, path, None)
311         self.failUnlessEqual(ga2("bare"), (DefaultAliasMarker, "bare"))
312         self.failUnlessEqual(ga2("baredir/file"),
313                              (DefaultAliasMarker, "baredir/file"))
314         self.failUnlessEqual(ga2("baredir/file:7"),
315                              (DefaultAliasMarker, "baredir/file:7"))
316         self.failUnlessEqual(ga2("baredir/sub:1/file:7"),
317                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
318         self.failUnlessEqual(ga2("tahoe:"), ("TA", ""))
319         self.failUnlessEqual(ga2("tahoe:file"), ("TA", "file"))
320         self.failUnlessEqual(ga2("tahoe:dir/file"), ("TA", "dir/file"))
321         # on windows, we really want c:foo to indicate a local file.
322         # default==None is what 'tahoe cp' uses.
323         if uses_lettercolon:
324             self.failUnlessEqual(ga2("c:"), (DefaultAliasMarker, "c:"))
325             self.failUnlessEqual(ga2("c:file"), (DefaultAliasMarker, "c:file"))
326             self.failUnlessEqual(ga2("c:dir/file"),
327                                  (DefaultAliasMarker, "c:dir/file"))
328         else:
329             self.failUnlessEqual(ga2("c:"), ("CA", ""))
330             self.failUnlessEqual(ga2("c:file"), ("CA", "file"))
331             self.failUnlessEqual(ga2("c:dir/file"), ("CA", "dir/file"))
332         self.failUnlessEqual(ga2("work:"), ("WA", ""))
333         self.failUnlessEqual(ga2("work:file"), ("WA", "file"))
334         self.failUnlessEqual(ga2("work:dir/file"), ("WA", "dir/file"))
335         self.failUnlessEqual(ga2("URI:stuff"), ("URI:stuff", ""))
336         self.failUnlessEqual(ga2("URI:stuff:./file"), ("URI:stuff", "file"))
337         self.failUnlessEqual(ga2("URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
338         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:")
339         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:dir")
340         self.failUnlessRaises(common.UnknownAliasError, ga2, "missing:dir/file")
341
342         def ga3(path):
343             old = common.pretend_platform_uses_lettercolon
344             try:
345                 common.pretend_platform_uses_lettercolon = True
346                 retval = get_alias(aliases, path, None)
347             finally:
348                 common.pretend_platform_uses_lettercolon = old
349             return retval
350         self.failUnlessEqual(ga3("bare"), (DefaultAliasMarker, "bare"))
351         self.failUnlessEqual(ga3("baredir/file"),
352                              (DefaultAliasMarker, "baredir/file"))
353         self.failUnlessEqual(ga3("baredir/file:7"),
354                              (DefaultAliasMarker, "baredir/file:7"))
355         self.failUnlessEqual(ga3("baredir/sub:1/file:7"),
356                              (DefaultAliasMarker, "baredir/sub:1/file:7"))
357         self.failUnlessEqual(ga3("tahoe:"), ("TA", ""))
358         self.failUnlessEqual(ga3("tahoe:file"), ("TA", "file"))
359         self.failUnlessEqual(ga3("tahoe:dir/file"), ("TA", "dir/file"))
360         self.failUnlessEqual(ga3("c:"), (DefaultAliasMarker, "c:"))
361         self.failUnlessEqual(ga3("c:file"), (DefaultAliasMarker, "c:file"))
362         self.failUnlessEqual(ga3("c:dir/file"),
363                              (DefaultAliasMarker, "c:dir/file"))
364         self.failUnlessEqual(ga3("work:"), ("WA", ""))
365         self.failUnlessEqual(ga3("work:file"), ("WA", "file"))
366         self.failUnlessEqual(ga3("work:dir/file"), ("WA", "dir/file"))
367         self.failUnlessEqual(ga3("URI:stuff"), ("URI:stuff", ""))
368         self.failUnlessEqual(ga3("URI:stuff:./file"), ("URI:stuff", "file"))
369         self.failUnlessEqual(ga3("URI:stuff:./dir/file"), ("URI:stuff", "dir/file"))
370         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:")
371         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:dir")
372         self.failUnlessRaises(common.UnknownAliasError, ga3, "missing:dir/file")
373
374
375 class Help(unittest.TestCase):
376
377     def test_get(self):
378         help = str(cli.GetOptions())
379         self.failUnless("get VDRIVE_FILE LOCAL_FILE" in help, help)
380         self.failUnless("% tahoe get FOO |less" in help, help)
381
382     def test_put(self):
383         help = str(cli.PutOptions())
384         self.failUnless("put LOCAL_FILE VDRIVE_FILE" in help, help)
385         self.failUnless("% cat FILE | tahoe put" in help, help)
386
387     def test_rm(self):
388         help = str(cli.RmOptions())
389         self.failUnless("rm VDRIVE_FILE" in help, help)
390
391     def test_mv(self):
392         help = str(cli.MvOptions())
393         self.failUnless("mv FROM TO" in help, help)
394         self.failUnless("Use 'tahoe mv' to move files" in help)
395
396     def test_ln(self):
397         help = str(cli.LnOptions())
398         self.failUnless("ln FROM TO" in help, help)
399
400     def test_backup(self):
401         help = str(cli.BackupOptions())
402         self.failUnless("backup FROM ALIAS:TO" in help, help)
403
404     def test_webopen(self):
405         help = str(cli.WebopenOptions())
406         self.failUnless("webopen [ALIAS:PATH]" in help, help)
407
408     def test_manifest(self):
409         help = str(cli.ManifestOptions())
410         self.failUnless("manifest [ALIAS:PATH]" in help, help)
411
412     def test_stats(self):
413         help = str(cli.StatsOptions())
414         self.failUnless("stats [ALIAS:PATH]" in help, help)
415
416     def test_check(self):
417         help = str(cli.CheckOptions())
418         self.failUnless("check [ALIAS:PATH]" in help, help)
419
420     def test_deep_check(self):
421         help = str(cli.DeepCheckOptions())
422         self.failUnless("deep-check [ALIAS:PATH]" in help, help)
423
424     def test_create_alias(self):
425         help = str(cli.CreateAliasOptions())
426         self.failUnless("create-alias ALIAS" in help, help)
427
428     def test_add_aliases(self):
429         help = str(cli.AddAliasOptions())
430         self.failUnless("add-alias ALIAS DIRCAP" in help, help)
431
432 class CLITestMixin:
433     def do_cli(self, verb, *args, **kwargs):
434         nodeargs = [
435             "--node-directory", self.get_clientdir(),
436             ]
437         argv = [verb] + nodeargs + list(args)
438         stdin = kwargs.get("stdin", "")
439         stdout, stderr = StringIO(), StringIO()
440         d = threads.deferToThread(runner.runner, argv, run_by_human=False,
441                                   stdin=StringIO(stdin),
442                                   stdout=stdout, stderr=stderr)
443         def _done(rc):
444             return rc, stdout.getvalue(), stderr.getvalue()
445         d.addCallback(_done)
446         return d
447
448 class CreateAlias(GridTestMixin, CLITestMixin, unittest.TestCase):
449
450     def _test_webopen(self, args, expected_url):
451         woo = cli.WebopenOptions()
452         all_args = ["--node-directory", self.get_clientdir()] + list(args)
453         woo.parseOptions(all_args)
454         urls = []
455         rc = cli.webopen(woo, urls.append)
456         self.failUnlessEqual(rc, 0)
457         self.failUnlessEqual(len(urls), 1)
458         self.failUnlessEqual(urls[0], expected_url)
459
460     def test_create(self):
461         self.basedir = "cli/CreateAlias/create"
462         self.set_up_grid()
463
464         d = self.do_cli("create-alias", "tahoe")
465         def _done((rc,stdout,stderr)):
466             self.failUnless("Alias 'tahoe' created" in stdout)
467             self.failIf(stderr)
468             aliases = get_aliases(self.get_clientdir())
469             self.failUnless("tahoe" in aliases)
470             self.failUnless(aliases["tahoe"].startswith("URI:DIR2:"))
471         d.addCallback(_done)
472         d.addCallback(lambda res: self.do_cli("create-alias", "two"))
473
474         def _stash_urls(res):
475             aliases = get_aliases(self.get_clientdir())
476             node_url_file = os.path.join(self.get_clientdir(), "node.url")
477             nodeurl = open(node_url_file, "r").read().strip()
478             self.welcome_url = nodeurl
479             uribase = nodeurl + "uri/"
480             self.tahoe_url = uribase + urllib.quote(aliases["tahoe"])
481             self.tahoe_subdir_url = self.tahoe_url + "/subdir"
482             self.two_url = uribase + urllib.quote(aliases["two"])
483             self.two_uri = aliases["two"]
484         d.addCallback(_stash_urls)
485
486         d.addCallback(lambda res: self.do_cli("create-alias", "two")) # dup
487         def _check_create_duplicate((rc,stdout,stderr)):
488             self.failIfEqual(rc, 0)
489             self.failUnless("Alias 'two' already exists!" in stderr)
490             aliases = get_aliases(self.get_clientdir())
491             self.failUnlessEqual(aliases["two"], self.two_uri)
492         d.addCallback(_check_create_duplicate)
493
494         d.addCallback(lambda res: self.do_cli("add-alias", "added", self.two_uri))
495         def _check_add((rc,stdout,stderr)):
496             self.failUnlessEqual(rc, 0)
497             self.failUnless("Alias 'added' added" in stdout)
498         d.addCallback(_check_add)
499
500         # check add-alias with a duplicate
501         d.addCallback(lambda res: self.do_cli("add-alias", "two", self.two_uri))
502         def _check_add_duplicate((rc,stdout,stderr)):
503             self.failIfEqual(rc, 0)
504             self.failUnless("Alias 'two' already exists!" in stderr)
505             aliases = get_aliases(self.get_clientdir())
506             self.failUnlessEqual(aliases["two"], self.two_uri)
507         d.addCallback(_check_add_duplicate)
508
509         def _test_urls(junk):
510             self._test_webopen([], self.welcome_url)
511             self._test_webopen(["/"], self.tahoe_url)
512             self._test_webopen(["tahoe:"], self.tahoe_url)
513             self._test_webopen(["tahoe:/"], self.tahoe_url)
514             self._test_webopen(["tahoe:subdir"], self.tahoe_subdir_url)
515             self._test_webopen(["tahoe:subdir/"], self.tahoe_subdir_url + '/')
516             self._test_webopen(["tahoe:subdir/file"], self.tahoe_subdir_url + '/file')
517             # if "file" is indeed a file, then the url produced by webopen in
518             # this case is disallowed by the webui. but by design, webopen
519             # passes through the mistake from the user to the resultant
520             # webopened url
521             self._test_webopen(["tahoe:subdir/file/"], self.tahoe_subdir_url + '/file/')
522             self._test_webopen(["two:"], self.two_url)
523         d.addCallback(_test_urls)
524
525         return d
526
527 class Put(GridTestMixin, CLITestMixin, unittest.TestCase):
528
529     def test_unlinked_immutable_stdin(self):
530         # tahoe get `echo DATA | tahoe put`
531         # tahoe get `echo DATA | tahoe put -`
532         self.basedir = "cli/Put/unlinked_immutable_stdin"
533         DATA = "data" * 100
534         self.set_up_grid()
535         d = self.do_cli("put", stdin=DATA)
536         def _uploaded(res):
537             (rc, stdout, stderr) = res
538             self.failUnless("waiting for file data on stdin.." in stderr)
539             self.failUnless("200 OK" in stderr, stderr)
540             self.readcap = stdout
541             self.failUnless(self.readcap.startswith("URI:CHK:"))
542         d.addCallback(_uploaded)
543         d.addCallback(lambda res: self.do_cli("get", self.readcap))
544         def _downloaded(res):
545             (rc, stdout, stderr) = res
546             self.failUnlessEqual(stderr, "")
547             self.failUnlessEqual(stdout, DATA)
548         d.addCallback(_downloaded)
549         d.addCallback(lambda res: self.do_cli("put", "-", stdin=DATA))
550         d.addCallback(lambda (rc,stdout,stderr):
551                       self.failUnlessEqual(stdout, self.readcap))
552         return d
553
554     def test_unlinked_immutable_from_file(self):
555         # tahoe put file.txt
556         # tahoe put ./file.txt
557         # tahoe put /tmp/file.txt
558         # tahoe put ~/file.txt
559         self.basedir = "cli/Put/unlinked_immutable_from_file"
560         self.set_up_grid()
561
562         rel_fn = os.path.join(self.basedir, "DATAFILE")
563         abs_fn = os.path.abspath(rel_fn)
564         # we make the file small enough to fit in a LIT file, for speed
565         f = open(rel_fn, "w")
566         f.write("short file")
567         f.close()
568         d = self.do_cli("put", rel_fn)
569         def _uploaded((rc,stdout,stderr)):
570             readcap = stdout
571             self.failUnless(readcap.startswith("URI:LIT:"))
572             self.readcap = readcap
573         d.addCallback(_uploaded)
574         d.addCallback(lambda res: self.do_cli("put", "./" + rel_fn))
575         d.addCallback(lambda (rc,stdout,stderr):
576                       self.failUnlessEqual(stdout, self.readcap))
577         d.addCallback(lambda res: self.do_cli("put", abs_fn))
578         d.addCallback(lambda (rc,stdout,stderr):
579                       self.failUnlessEqual(stdout, self.readcap))
580         # we just have to assume that ~ is handled properly
581         return d
582
583     def test_immutable_from_file(self):
584         # tahoe put file.txt uploaded.txt
585         # tahoe - uploaded.txt
586         # tahoe put file.txt subdir/uploaded.txt
587         # tahoe put file.txt tahoe:uploaded.txt
588         # tahoe put file.txt tahoe:subdir/uploaded.txt
589         # tahoe put file.txt DIRCAP:./uploaded.txt
590         # tahoe put file.txt DIRCAP:./subdir/uploaded.txt
591         self.basedir = "cli/Put/immutable_from_file"
592         self.set_up_grid()
593
594         rel_fn = os.path.join(self.basedir, "DATAFILE")
595         abs_fn = os.path.abspath(rel_fn)
596         # we make the file small enough to fit in a LIT file, for speed
597         DATA = "short file"
598         DATA2 = "short file two"
599         f = open(rel_fn, "w")
600         f.write(DATA)
601         f.close()
602
603         d = self.do_cli("create-alias", "tahoe")
604
605         d.addCallback(lambda res:
606                       self.do_cli("put", rel_fn, "uploaded.txt"))
607         def _uploaded((rc,stdout,stderr)):
608             readcap = stdout.strip()
609             self.failUnless(readcap.startswith("URI:LIT:"))
610             self.failUnless("201 Created" in stderr, stderr)
611             self.readcap = readcap
612         d.addCallback(_uploaded)
613         d.addCallback(lambda res:
614                       self.do_cli("get", "tahoe:uploaded.txt"))
615         d.addCallback(lambda (rc,stdout,stderr):
616                       self.failUnlessEqual(stdout, DATA))
617
618         d.addCallback(lambda res:
619                       self.do_cli("put", "-", "uploaded.txt", stdin=DATA2))
620         def _replaced((rc,stdout,stderr)):
621             readcap = stdout.strip()
622             self.failUnless(readcap.startswith("URI:LIT:"))
623             self.failUnless("200 OK" in stderr, stderr)
624         d.addCallback(_replaced)
625
626         d.addCallback(lambda res:
627                       self.do_cli("put", rel_fn, "subdir/uploaded2.txt"))
628         d.addCallback(lambda res: self.do_cli("get", "subdir/uploaded2.txt"))
629         d.addCallback(lambda (rc,stdout,stderr):
630                       self.failUnlessEqual(stdout, DATA))
631
632         d.addCallback(lambda res:
633                       self.do_cli("put", rel_fn, "tahoe:uploaded3.txt"))
634         d.addCallback(lambda res: self.do_cli("get", "tahoe:uploaded3.txt"))
635         d.addCallback(lambda (rc,stdout,stderr):
636                       self.failUnlessEqual(stdout, DATA))
637
638         d.addCallback(lambda res:
639                       self.do_cli("put", rel_fn, "tahoe:subdir/uploaded4.txt"))
640         d.addCallback(lambda res:
641                       self.do_cli("get", "tahoe:subdir/uploaded4.txt"))
642         d.addCallback(lambda (rc,stdout,stderr):
643                       self.failUnlessEqual(stdout, DATA))
644
645         def _get_dircap(res):
646             self.dircap = get_aliases(self.get_clientdir())["tahoe"]
647         d.addCallback(_get_dircap)
648
649         d.addCallback(lambda res:
650                       self.do_cli("put", rel_fn,
651                                   self.dircap+":./uploaded5.txt"))
652         d.addCallback(lambda res:
653                       self.do_cli("get", "tahoe:uploaded5.txt"))
654         d.addCallback(lambda (rc,stdout,stderr):
655                       self.failUnlessEqual(stdout, DATA))
656
657         d.addCallback(lambda res:
658                       self.do_cli("put", rel_fn,
659                                   self.dircap+":./subdir/uploaded6.txt"))
660         d.addCallback(lambda res:
661                       self.do_cli("get", "tahoe:subdir/uploaded6.txt"))
662         d.addCallback(lambda (rc,stdout,stderr):
663                       self.failUnlessEqual(stdout, DATA))
664
665         return d
666
667     def test_mutable_unlinked(self):
668         # FILECAP = `echo DATA | tahoe put --mutable`
669         # tahoe get FILECAP, compare against DATA
670         # echo DATA2 | tahoe put - FILECAP
671         # tahoe get FILECAP, compare against DATA2
672         # tahoe put file.txt FILECAP
673         self.basedir = "cli/Put/mutable_unlinked"
674         self.set_up_grid()
675
676         DATA = "data" * 100
677         DATA2 = "two" * 100
678         rel_fn = os.path.join(self.basedir, "DATAFILE")
679         abs_fn = os.path.abspath(rel_fn)
680         DATA3 = "three" * 100
681         f = open(rel_fn, "w")
682         f.write(DATA3)
683         f.close()
684
685         d = self.do_cli("put", "--mutable", stdin=DATA)
686         def _created(res):
687             (rc, stdout, stderr) = res
688             self.failUnless("waiting for file data on stdin.." in stderr)
689             self.failUnless("200 OK" in stderr)
690             self.filecap = stdout
691             self.failUnless(self.filecap.startswith("URI:SSK:"))
692         d.addCallback(_created)
693         d.addCallback(lambda res: self.do_cli("get", self.filecap))
694         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA))
695
696         d.addCallback(lambda res: self.do_cli("put", "-", self.filecap, stdin=DATA2))
697         def _replaced(res):
698             (rc, stdout, stderr) = res
699             self.failUnless("waiting for file data on stdin.." in stderr)
700             self.failUnless("200 OK" in stderr)
701             self.failUnlessEqual(self.filecap, stdout)
702         d.addCallback(_replaced)
703         d.addCallback(lambda res: self.do_cli("get", self.filecap))
704         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
705
706         d.addCallback(lambda res: self.do_cli("put", rel_fn, self.filecap))
707         def _replaced2(res):
708             (rc, stdout, stderr) = res
709             self.failUnless("200 OK" in stderr)
710             self.failUnlessEqual(self.filecap, stdout)
711         d.addCallback(_replaced2)
712         d.addCallback(lambda res: self.do_cli("get", self.filecap))
713         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA3))
714
715         return d
716
717     def test_mutable(self):
718         # echo DATA1 | tahoe put --mutable - uploaded.txt
719         # echo DATA2 | tahoe put - uploaded.txt # should modify-in-place
720         # tahoe get uploaded.txt, compare against DATA2
721
722         self.basedir = "cli/Put/mutable"
723         self.set_up_grid()
724
725         DATA1 = "data" * 100
726         fn1 = os.path.join(self.basedir, "DATA1")
727         f = open(fn1, "w")
728         f.write(DATA1)
729         f.close()
730         DATA2 = "two" * 100
731         fn2 = os.path.join(self.basedir, "DATA2")
732         f = open(fn2, "w")
733         f.write(DATA2)
734         f.close()
735
736         d = self.do_cli("create-alias", "tahoe")
737         d.addCallback(lambda res:
738                       self.do_cli("put", "--mutable", fn1, "tahoe:uploaded.txt"))
739         d.addCallback(lambda res:
740                       self.do_cli("put", fn2, "tahoe:uploaded.txt"))
741         d.addCallback(lambda res:
742                       self.do_cli("get", "tahoe:uploaded.txt"))
743         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
744         return d
745
746 class List(GridTestMixin, CLITestMixin, unittest.TestCase):
747     def test_list(self):
748         self.basedir = "cli/List/list"
749         self.set_up_grid()
750         c0 = self.g.clients[0]
751         d = c0.create_empty_dirnode()
752         def _stash_root_and_create_file(n):
753             self.rootnode = n
754             self.rooturi = n.get_uri()
755             return n.add_file(u"good", upload.Data("small", convergence=""))
756         d.addCallback(_stash_root_and_create_file)
757         d.addCallback(lambda ign:
758                       self.rootnode.create_empty_directory(u"1share"))
759         d.addCallback(lambda n:
760                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
761         d.addCallback(lambda ign:
762                       self.rootnode.create_empty_directory(u"0share"))
763         d.addCallback(lambda n:
764                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
765         d.addCallback(lambda ign:
766                       self.do_cli("add-alias", "tahoe", self.rooturi))
767         d.addCallback(lambda ign: self.do_cli("ls"))
768         def _check1((rc,out,err)):
769             self.failUnlessEqual(err, "")
770             self.failUnlessEqual(rc, 0)
771             self.failUnlessEqual(out.splitlines(), ["0share", "1share", "good"])
772         d.addCallback(_check1)
773         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
774         def _check2((rc,out,err)):
775             self.failIfEqual(rc, 0)
776             self.failUnlessEqual(err.strip(), "No such file or directory")
777             self.failUnlessEqual(out, "")
778         d.addCallback(_check2)
779         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
780         def _check3((rc,out,err)):
781             self.failIfEqual(rc, 0)
782             self.failUnlessIn("Error during GET: 410 Gone ", err)
783             self.failUnlessIn("UnrecoverableFileError:", err)
784             self.failUnlessIn("could not be retrieved, because there were "
785                               "insufficient good shares.", err)
786             self.failUnlessEqual(out, "")
787         d.addCallback(_check3)
788         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
789         d.addCallback(_check3)
790         return d
791
792 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
793     def test_mv_behavior(self):
794         self.basedir = "cli/Mv/mv_behavior"
795         self.set_up_grid()
796         fn1 = os.path.join(self.basedir, "file1")
797         DATA1 = "Nuclear launch codes"
798         open(fn1, "wb").write(DATA1)
799         fn2 = os.path.join(self.basedir, "file2")
800         DATA2 = "UML diagrams"
801         open(fn2, "wb").write(DATA2)
802         # copy both files to the grid
803         d = self.do_cli("create-alias", "tahoe")
804         d.addCallback(lambda res:
805             self.do_cli("cp", fn1, "tahoe:"))
806         d.addCallback(lambda res:
807             self.do_cli("cp", fn2, "tahoe:"))
808
809         # do mv file1 file3
810         # (we should be able to rename files)
811         d.addCallback(lambda res:
812             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
813         d.addCallback(lambda (rc, out, err):
814             self.failUnlessIn("OK", out, "mv didn't rename a file"))
815
816         # do mv file3 file2
817         # (This should succeed without issue)
818         d.addCallback(lambda res:
819             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
820         # Out should contain "OK" to show that the transfer worked.
821         d.addCallback(lambda (rc,out,err):
822             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
823
824         # Next, make a remote directory.
825         d.addCallback(lambda res:
826             self.do_cli("mkdir", "tahoe:directory"))
827
828         # mv file2 directory
829         # (should fail with a descriptive error message; the CLI mv
830         #  client should support this)
831         d.addCallback(lambda res:
832             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
833         d.addCallback(lambda (rc, out, err):
834             self.failUnlessIn(
835                 "Error: You can't overwrite a directory with a file", err,
836                 "mv shouldn't overwrite directories" ))
837
838         # mv file2 directory/
839         # (should succeed by making file2 a child node of directory)
840         d.addCallback(lambda res:
841             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
842         # We should see an "OK"...
843         d.addCallback(lambda (rc, out, err):
844             self.failUnlessIn("OK", out,
845                             "mv didn't mv a file into a directory"))
846         # ... and be able to GET the file
847         d.addCallback(lambda res:
848             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
849         d.addCallback(lambda (rc, out, err):
850             self.failUnless(os.path.exists(self.basedir + "new"),
851                             "mv didn't write the destination file"))
852         # ... and not find the file where it was before.
853         d.addCallback(lambda res:
854             self.do_cli("get", "tahoe:file2", "file2"))
855         d.addCallback(lambda (rc, out, err):
856             self.failUnlessIn("404", err,
857                             "mv left the source file intact"))
858
859         # Let's build:
860         # directory/directory2/some_file
861         # directory3
862         d.addCallback(lambda res:
863             self.do_cli("mkdir", "tahoe:directory/directory2"))
864         d.addCallback(lambda res:
865             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
866         d.addCallback(lambda res:
867             self.do_cli("mkdir", "tahoe:directory3"))
868
869         # Let's now try to mv directory/directory2/some_file to
870         # directory3/some_file
871         d.addCallback(lambda res:
872             self.do_cli("mv", "tahoe:directory/directory2/some_file",
873                         "tahoe:directory3/"))
874         # We should have just some_file in tahoe:directory3
875         d.addCallback(lambda res:
876             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
877         d.addCallback(lambda (rc, out, err):
878             self.failUnless("404" not in err,
879                               "mv didn't handle nested directories correctly"))
880         d.addCallback(lambda res:
881             self.do_cli("get", "tahoe:directory3/directory", "directory"))
882         d.addCallback(lambda (rc, out, err):
883             self.failUnlessIn("404", err,
884                               "mv moved the wrong thing"))
885         return d
886
887 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
888
889     def test_not_enough_args(self):
890         o = cli.CpOptions()
891         self.failUnlessRaises(usage.UsageError,
892                               o.parseOptions, ["onearg"])
893
894     def test_unicode_filename(self):
895         self.basedir = "cli/Cp/unicode_filename"
896         self.set_up_grid()
897
898         fn1 = os.path.join(self.basedir, "Ärtonwall")
899         DATA1 = "unicode file content"
900         open(fn1, "wb").write(DATA1)
901
902         fn2 = os.path.join(self.basedir, "Metallica")
903         DATA2 = "non-unicode file content"
904         open(fn2, "wb").write(DATA2)
905
906         # Bug #534
907         # Assure that uploading a file whose name contains unicode character doesn't
908         # prevent further uploads in the same directory
909         d = self.do_cli("create-alias", "tahoe")
910         d.addCallback(lambda res: self.do_cli("cp", fn1, "tahoe:"))
911         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
912
913         d.addCallback(lambda res: self.do_cli("get", "tahoe:Ärtonwall"))
914         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA1))
915
916         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
917         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
918
919         return d
920     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."
921
922     def test_dangling_symlink_vs_recursion(self):
923         if not hasattr(os, 'symlink'):
924             raise unittest.SkipTest("There is no symlink on this platform.")
925         # cp -r on a directory containing a dangling symlink shouldn't assert
926         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
927         self.set_up_grid()
928         dn = os.path.join(self.basedir, "dir")
929         os.mkdir(dn)
930         fn = os.path.join(dn, "Fakebandica")
931         ln = os.path.join(dn, "link")
932         os.symlink(fn, ln)
933
934         d = self.do_cli("create-alias", "tahoe")
935         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
936                                               dn, "tahoe:"))
937         return d
938
939 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
940
941     def writeto(self, path, data):
942         d = os.path.dirname(os.path.join(self.basedir, "home", path))
943         fileutil.make_dirs(d)
944         f = open(os.path.join(self.basedir, "home", path), "w")
945         f.write(data)
946         f.close()
947
948     def count_output(self, out):
949         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), (\d+) directories created \((\d+) reused\)", out)
950         return [int(s) for s in mo.groups()]
951
952     def count_output2(self, out):
953         mo = re.search(r"(\d)+ files checked, (\d+) directories checked, (\d+) directories read", out)
954         return [int(s) for s in mo.groups()]
955
956     def test_backup(self):
957         self.basedir = "cli/Backup/backup"
958         self.set_up_grid()
959
960         # is the backupdb available? If so, we test that a second backup does
961         # not create new directories.
962         hush = StringIO()
963         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
964                                          hush)
965
966         # create a small local directory with a couple of files
967         source = os.path.join(self.basedir, "home")
968         fileutil.make_dirs(os.path.join(source, "empty"))
969         self.writeto("parent/subdir/foo.txt", "foo")
970         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
971         self.writeto("parent/blah.txt", "blah")
972
973         def do_backup(verbose=False):
974             cmd = ["backup"]
975             if verbose:
976                 cmd.append("--verbose")
977             cmd.append(source)
978             cmd.append("tahoe:backups")
979             return self.do_cli(*cmd)
980
981         d = self.do_cli("create-alias", "tahoe")
982
983         if not have_bdb:
984             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
985             def _should_complain((rc, out, err)):
986                 self.failUnless("I was unable to import a python sqlite library" in err, err)
987             d.addCallback(_should_complain)
988             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
989
990         d.addCallback(lambda res: do_backup())
991         def _check0((rc, out, err)):
992             self.failUnlessEqual(err, "")
993             self.failUnlessEqual(rc, 0)
994             fu, fr, dc, dr = self.count_output(out)
995             # foo.txt, bar.txt, blah.txt
996             self.failUnlessEqual(fu, 3)
997             self.failUnlessEqual(fr, 0)
998             # empty, home, home/parent, home/parent/subdir
999             self.failUnlessEqual(dc, 4)
1000             self.failUnlessEqual(dr, 0)
1001         d.addCallback(_check0)
1002
1003         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups"))
1004         def _check1((rc, out, err)):
1005             self.failUnlessEqual(err, "")
1006             self.failUnlessEqual(rc, 0)
1007             self.failUnlessEqual(sorted(out.split()), ["Archives", "Latest"])
1008         d.addCallback(_check1)
1009         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
1010         def _check2((rc, out, err)):
1011             self.failUnlessEqual(err, "")
1012             self.failUnlessEqual(rc, 0)
1013             self.failUnlessEqual(sorted(out.split()), ["empty", "parent"])
1014         d.addCallback(_check2)
1015         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
1016         def _check2a((rc, out, err)):
1017             self.failUnlessEqual(err, "")
1018             self.failUnlessEqual(rc, 0)
1019             self.failUnlessEqual(out.strip(), "")
1020         d.addCallback(_check2a)
1021         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1022         def _check3((rc, out, err)):
1023             self.failUnlessEqual(err, "")
1024             self.failUnlessEqual(rc, 0)
1025             self.failUnlessEqual(out, "foo")
1026         d.addCallback(_check3)
1027         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1028         def _check4((rc, out, err)):
1029             self.failUnlessEqual(err, "")
1030             self.failUnlessEqual(rc, 0)
1031             self.old_archives = out.split()
1032             self.failUnlessEqual(len(self.old_archives), 1)
1033         d.addCallback(_check4)
1034
1035
1036         d.addCallback(self.stall, 1.1)
1037         d.addCallback(lambda res: do_backup())
1038         def _check4a((rc, out, err)):
1039             # second backup should reuse everything, if the backupdb is
1040             # available
1041             self.failUnlessEqual(err, "")
1042             self.failUnlessEqual(rc, 0)
1043             if have_bdb:
1044                 fu, fr, dc, dr = self.count_output(out)
1045                 # foo.txt, bar.txt, blah.txt
1046                 self.failUnlessEqual(fu, 0)
1047                 self.failUnlessEqual(fr, 3)
1048                 # empty, home, home/parent, home/parent/subdir
1049                 self.failUnlessEqual(dc, 0)
1050                 self.failUnlessEqual(dr, 4)
1051         d.addCallback(_check4a)
1052
1053         if have_bdb:
1054             # sneak into the backupdb, crank back the "last checked"
1055             # timestamp to force a check on all files
1056             def _reset_last_checked(res):
1057                 dbfile = os.path.join(self.get_clientdir(),
1058                                       "private", "backupdb.sqlite")
1059                 self.failUnless(os.path.exists(dbfile), dbfile)
1060                 bdb = backupdb.get_backupdb(dbfile)
1061                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
1062                 bdb.connection.commit()
1063
1064             d.addCallback(_reset_last_checked)
1065
1066             d.addCallback(self.stall, 1.1)
1067             d.addCallback(lambda res: do_backup(verbose=True))
1068             def _check4b((rc, out, err)):
1069                 # we should check all files, and re-use all of them. None of
1070                 # the directories should have been changed.
1071                 self.failUnlessEqual(err, "")
1072                 self.failUnlessEqual(rc, 0)
1073                 fu, fr, dc, dr = self.count_output(out)
1074                 fchecked, dchecked, dread = self.count_output2(out)
1075                 self.failUnlessEqual(fchecked, 3)
1076                 self.failUnlessEqual(fu, 0)
1077                 self.failUnlessEqual(fr, 3)
1078                 # TODO: backupdb doesn't do dirs yet; when it does, this will
1079                 # change to dchecked=4, and maybe dread=0
1080                 self.failUnlessEqual(dchecked, 0)
1081                 self.failUnlessEqual(dread, 4)
1082                 self.failUnlessEqual(dc, 0)
1083                 self.failUnlessEqual(dr, 4)
1084             d.addCallback(_check4b)
1085
1086         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1087         def _check5((rc, out, err)):
1088             self.failUnlessEqual(err, "")
1089             self.failUnlessEqual(rc, 0)
1090             self.new_archives = out.split()
1091             expected_new = 2
1092             if have_bdb:
1093                 expected_new += 1
1094             self.failUnlessEqual(len(self.new_archives), expected_new, out)
1095             # the original backup should still be the oldest (i.e. sorts
1096             # alphabetically towards the beginning)
1097             self.failUnlessEqual(sorted(self.new_archives)[0],
1098                                  self.old_archives[0])
1099         d.addCallback(_check5)
1100
1101         d.addCallback(self.stall, 1.1)
1102         def _modify(res):
1103             self.writeto("parent/subdir/foo.txt", "FOOF!")
1104             # and turn a file into a directory
1105             os.unlink(os.path.join(source, "parent/blah.txt"))
1106             os.mkdir(os.path.join(source, "parent/blah.txt"))
1107             self.writeto("parent/blah.txt/surprise file", "surprise")
1108             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
1109             # turn a directory into a file
1110             os.rmdir(os.path.join(source, "empty"))
1111             self.writeto("empty", "imagine nothing being here")
1112             return do_backup()
1113         d.addCallback(_modify)
1114         def _check5a((rc, out, err)):
1115             # second backup should reuse bar.txt (if backupdb is available),
1116             # and upload the rest. None of the directories can be reused.
1117             self.failUnlessEqual(err, "")
1118             self.failUnlessEqual(rc, 0)
1119             if have_bdb:
1120                 fu, fr, dc, dr = self.count_output(out)
1121                 # new foo.txt, surprise file, subfile, empty
1122                 self.failUnlessEqual(fu, 4)
1123                 # old bar.txt
1124                 self.failUnlessEqual(fr, 1)
1125                 # home, parent, subdir, blah.txt, surprisedir
1126                 self.failUnlessEqual(dc, 5)
1127                 self.failUnlessEqual(dr, 0)
1128         d.addCallback(_check5a)
1129         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1130         def _check6((rc, out, err)):
1131             self.failUnlessEqual(err, "")
1132             self.failUnlessEqual(rc, 0)
1133             self.new_archives = out.split()
1134             expected_new = 3
1135             if have_bdb:
1136                 expected_new += 1
1137             self.failUnlessEqual(len(self.new_archives), expected_new)
1138             self.failUnlessEqual(sorted(self.new_archives)[0],
1139                                  self.old_archives[0])
1140         d.addCallback(_check6)
1141         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1142         def _check7((rc, out, err)):
1143             self.failUnlessEqual(err, "")
1144             self.failUnlessEqual(rc, 0)
1145             self.failUnlessEqual(out, "FOOF!")
1146             # the old snapshot should not be modified
1147             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
1148         d.addCallback(_check7)
1149         def _check8((rc, out, err)):
1150             self.failUnlessEqual(err, "")
1151             self.failUnlessEqual(rc, 0)
1152             self.failUnlessEqual(out, "foo")
1153         d.addCallback(_check8)
1154
1155         return d
1156
1157     # on our old dapper buildslave, this test takes a long time (usually
1158     # 130s), so we have to bump up the default 120s timeout. The create-alias
1159     # and initial backup alone take 60s, probably because of the handful of
1160     # dirnodes being created (RSA key generation). The backup between check4
1161     # and check4a takes 6s, as does the backup before check4b.
1162     test_backup.timeout = 3000
1163
1164     def test_exclude_options(self):
1165         root_listdir = ('lib.a', '_darcs', 'subdir', 'nice_doc.lyx')
1166         subdir_listdir = ('another_doc.lyx', 'run_snake_run.py', 'CVS', '.svn', '_darcs')
1167         basedir = "cli/Backup/exclude_options"
1168         fileutil.make_dirs(basedir)
1169         nodeurl_path = os.path.join(basedir, 'node.url')
1170         nodeurl = file(nodeurl_path, 'w')
1171         nodeurl.write('http://example.net:2357/')
1172         nodeurl.close()
1173
1174         def _check_filtering(filtered, all, included, excluded):
1175             filtered = set(filtered)
1176             all = set(all)
1177             included = set(included)
1178             excluded = set(excluded)
1179             self.failUnlessEqual(filtered, included)
1180             self.failUnlessEqual(all.difference(filtered), excluded)
1181
1182         # test simple exclude
1183         backup_options = cli.BackupOptions()
1184         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1185                                      basedir, 'from', 'to'])
1186         filtered = list(backup_options.filter_listdir(root_listdir))
1187         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1188                          ('nice_doc.lyx',))
1189         # multiple exclude
1190         backup_options = cli.BackupOptions()
1191         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
1192                                      basedir, 'from', 'to'])
1193         filtered = list(backup_options.filter_listdir(root_listdir))
1194         _check_filtering(filtered, root_listdir, ('_darcs', 'subdir'),
1195                          ('nice_doc.lyx', 'lib.a'))
1196         # vcs metadata exclusion
1197         backup_options = cli.BackupOptions()
1198         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
1199                                      basedir, 'from', 'to'])
1200         filtered = list(backup_options.filter_listdir(subdir_listdir))
1201         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'run_snake_run.py',),
1202                          ('CVS', '.svn', '_darcs'))
1203         # read exclude patterns from file
1204         exclusion_string = "_darcs\n*py\n.svn"
1205         excl_filepath = os.path.join(basedir, 'exclusion')
1206         excl_file = file(excl_filepath, 'w')
1207         excl_file.write(exclusion_string)
1208         excl_file.close()
1209         backup_options = cli.BackupOptions()
1210         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1211                                      basedir, 'from', 'to'])
1212         filtered = list(backup_options.filter_listdir(subdir_listdir))
1213         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'CVS'),
1214                          ('.svn', '_darcs', 'run_snake_run.py'))
1215         # text BackupConfigurationError
1216         self.failUnlessRaises(cli.BackupConfigurationError,
1217                               backup_options.parseOptions,
1218                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
1219                                basedir, 'from', 'to'])
1220
1221         # test that an iterator works too
1222         backup_options = cli.BackupOptions()
1223         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1224                                      basedir, 'from', 'to'])
1225         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1226         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1227                          ('nice_doc.lyx',))
1228
1229 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
1230
1231     def test_check(self):
1232         self.basedir = "cli/Check/check"
1233         self.set_up_grid()
1234         c0 = self.g.clients[0]
1235         DATA = "data" * 100
1236         d = c0.create_mutable_file(DATA)
1237         def _stash_uri(n):
1238             self.uri = n.get_uri()
1239         d.addCallback(_stash_uri)
1240
1241         d.addCallback(lambda ign: self.do_cli("check", self.uri))
1242         def _check1((rc, out, err)):
1243             self.failUnlessEqual(err, "")
1244             self.failUnlessEqual(rc, 0)
1245             lines = out.splitlines()
1246             self.failUnless("Summary: Healthy" in lines, out)
1247             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1248         d.addCallback(_check1)
1249
1250         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
1251         def _check2((rc, out, err)):
1252             self.failUnlessEqual(err, "")
1253             self.failUnlessEqual(rc, 0)
1254             data = simplejson.loads(out)
1255             self.failUnlessEqual(data["summary"], "Healthy")
1256         d.addCallback(_check2)
1257
1258         def _clobber_shares(ignored):
1259             # delete one, corrupt a second
1260             shares = self.find_shares(self.uri)
1261             self.failUnlessEqual(len(shares), 10)
1262             os.unlink(shares[0][2])
1263             cso = debug.CorruptShareOptions()
1264             cso.stdout = StringIO()
1265             cso.parseOptions([shares[1][2]])
1266             storage_index = uri.from_string(self.uri).get_storage_index()
1267             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
1268                                        (base32.b2a(shares[1][1]),
1269                                         base32.b2a(storage_index),
1270                                         shares[1][0])
1271             debug.corrupt_share(cso)
1272         d.addCallback(_clobber_shares)
1273
1274         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
1275         def _check3((rc, out, err)):
1276             self.failUnlessEqual(err, "")
1277             self.failUnlessEqual(rc, 0)
1278             lines = out.splitlines()
1279             summary = [l for l in lines if l.startswith("Summary")][0]
1280             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
1281                             in summary, summary)
1282             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1283             self.failUnless(" corrupt shares:" in lines, out)
1284             self.failUnless(self._corrupt_share_line in lines, out)
1285         d.addCallback(_check3)
1286
1287         d.addCallback(lambda ign:
1288                       self.do_cli("check", "--verify", "--repair", self.uri))
1289         def _check4((rc, out, err)):
1290             self.failUnlessEqual(err, "")
1291             self.failUnlessEqual(rc, 0)
1292             lines = out.splitlines()
1293             self.failUnless("Summary: not healthy" in lines, out)
1294             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1295             self.failUnless(" corrupt shares:" in lines, out)
1296             self.failUnless(self._corrupt_share_line in lines, out)
1297             self.failUnless(" repair successful" in lines, out)
1298         d.addCallback(_check4)
1299
1300         d.addCallback(lambda ign:
1301                       self.do_cli("check", "--verify", "--repair", self.uri))
1302         def _check5((rc, out, err)):
1303             self.failUnlessEqual(err, "")
1304             self.failUnlessEqual(rc, 0)
1305             lines = out.splitlines()
1306             self.failUnless("Summary: healthy" in lines, out)
1307             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1308             self.failIf(" corrupt shares:" in lines, out)
1309         d.addCallback(_check5)
1310
1311         return d
1312
1313     def test_deep_check(self):
1314         self.basedir = "cli/Check/deep_check"
1315         self.set_up_grid()
1316         c0 = self.g.clients[0]
1317         self.uris = {}
1318         self.fileurls = {}
1319         DATA = "data" * 100
1320         d = c0.create_empty_dirnode()
1321         def _stash_root_and_create_file(n):
1322             self.rootnode = n
1323             self.rooturi = n.get_uri()
1324             return n.add_file(u"good", upload.Data(DATA, convergence=""))
1325         d.addCallback(_stash_root_and_create_file)
1326         def _stash_uri(fn, which):
1327             self.uris[which] = fn.get_uri()
1328             return fn
1329         d.addCallback(_stash_uri, "good")
1330         d.addCallback(lambda ign:
1331                       self.rootnode.add_file(u"small",
1332                                              upload.Data("literal",
1333                                                         convergence="")))
1334         d.addCallback(_stash_uri, "small")
1335         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
1336         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
1337         d.addCallback(_stash_uri, "mutable")
1338
1339         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1340         def _check1((rc, out, err)):
1341             self.failUnlessEqual(err, "")
1342             self.failUnlessEqual(rc, 0)
1343             lines = out.splitlines()
1344             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1345                             in lines, out)
1346         d.addCallback(_check1)
1347
1348         # root
1349         # root/good
1350         # root/small
1351         # root/mutable
1352
1353         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
1354                                               self.rooturi))
1355         def _check2((rc, out, err)):
1356             self.failUnlessEqual(err, "")
1357             self.failUnlessEqual(rc, 0)
1358             lines = out.splitlines()
1359             self.failUnless("<root>: Healthy" in lines, out)
1360             self.failUnless("small: Healthy (LIT)" in lines, out)
1361             self.failUnless("good: Healthy" in lines, out)
1362             self.failUnless("mutable: Healthy" in lines, out)
1363             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1364                             in lines, out)
1365         d.addCallback(_check2)
1366
1367         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1368         def _check_stats((rc, out, err)):
1369             self.failUnlessEqual(err, "")
1370             self.failUnlessEqual(rc, 0)
1371             lines = out.splitlines()
1372             self.failUnlessIn(" count-immutable-files: 1", lines)
1373             self.failUnlessIn("   count-mutable-files: 1", lines)
1374             self.failUnlessIn("   count-literal-files: 1", lines)
1375             self.failUnlessIn("     count-directories: 1", lines)
1376             self.failUnlessIn("  size-immutable-files: 400", lines)
1377             self.failUnlessIn("Size Histogram:", lines)
1378             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
1379             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
1380         d.addCallback(_check_stats)
1381
1382         def _clobber_shares(ignored):
1383             shares = self.find_shares(self.uris["good"])
1384             self.failUnlessEqual(len(shares), 10)
1385             os.unlink(shares[0][2])
1386
1387             shares = self.find_shares(self.uris["mutable"])
1388             cso = debug.CorruptShareOptions()
1389             cso.stdout = StringIO()
1390             cso.parseOptions([shares[1][2]])
1391             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
1392             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
1393                                        (base32.b2a(shares[1][1]),
1394                                         base32.b2a(storage_index),
1395                                         shares[1][0])
1396             debug.corrupt_share(cso)
1397         d.addCallback(_clobber_shares)
1398
1399         # root
1400         # root/good  [9 shares]
1401         # root/small
1402         # root/mutable [1 corrupt share]
1403
1404         d.addCallback(lambda ign:
1405                       self.do_cli("deep-check", "--verbose", self.rooturi))
1406         def _check3((rc, out, err)):
1407             self.failUnlessEqual(err, "")
1408             self.failUnlessEqual(rc, 0)
1409             lines = out.splitlines()
1410             self.failUnless("<root>: Healthy" in lines, out)
1411             self.failUnless("small: Healthy (LIT)" in lines, out)
1412             self.failUnless("mutable: Healthy" in lines, out) # needs verifier
1413             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1414                             in lines, out)
1415             self.failIf(self._corrupt_share_line in lines, out)
1416             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
1417                             in lines, out)
1418         d.addCallback(_check3)
1419
1420         d.addCallback(lambda ign:
1421                       self.do_cli("deep-check", "--verbose", "--verify",
1422                                   self.rooturi))
1423         def _check4((rc, out, err)):
1424             self.failUnlessEqual(err, "")
1425             self.failUnlessEqual(rc, 0)
1426             lines = out.splitlines()
1427             self.failUnless("<root>: Healthy" in lines, out)
1428             self.failUnless("small: Healthy (LIT)" in lines, out)
1429             mutable = [l for l in lines if l.startswith("mutable")][0]
1430             self.failUnless(mutable.startswith("mutable: Unhealthy: 9 shares (enc 3-of-10)"),
1431                             mutable)
1432             self.failUnless(self._corrupt_share_line in lines, out)
1433             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1434                             in lines, out)
1435             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
1436                             in lines, out)
1437         d.addCallback(_check4)
1438
1439         d.addCallback(lambda ign:
1440                       self.do_cli("deep-check", "--raw",
1441                                   self.rooturi))
1442         def _check5((rc, out, err)):
1443             self.failUnlessEqual(err, "")
1444             self.failUnlessEqual(rc, 0)
1445             lines = out.splitlines()
1446             units = [simplejson.loads(line) for line in lines]
1447             # root, small, good, mutable,  stats
1448             self.failUnlessEqual(len(units), 4+1)
1449         d.addCallback(_check5)
1450
1451         d.addCallback(lambda ign:
1452                       self.do_cli("deep-check",
1453                                   "--verbose", "--verify", "--repair",
1454                                   self.rooturi))
1455         def _check6((rc, out, err)):
1456             self.failUnlessEqual(err, "")
1457             self.failUnlessEqual(rc, 0)
1458             lines = out.splitlines()
1459             self.failUnless("<root>: healthy" in lines, out)
1460             self.failUnless("small: healthy" in lines, out)
1461             self.failUnless("mutable: not healthy" in lines, out)
1462             self.failUnless(self._corrupt_share_line in lines, out)
1463             self.failUnless("good: not healthy" in lines, out)
1464             self.failUnless("done: 4 objects checked" in lines, out)
1465             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
1466             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
1467                             in lines, out)
1468             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
1469         d.addCallback(_check6)
1470
1471         # now add a subdir, and a file below that, then make the subdir
1472         # unrecoverable
1473
1474         d.addCallback(lambda ign:
1475                       self.rootnode.create_empty_directory(u"subdir"))
1476         d.addCallback(_stash_uri, "subdir")
1477         d.addCallback(lambda fn:
1478                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
1479         d.addCallback(lambda ign:
1480                       self.delete_shares_numbered(self.uris["subdir"],
1481                                                   range(10)))
1482
1483         # root
1484         # root/good
1485         # root/small
1486         # root/mutable
1487         # root/subdir [unrecoverable: 0 shares]
1488         # root/subfile
1489
1490         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
1491         def _manifest_failed((rc, out, err)):
1492             self.failIfEqual(rc, 0)
1493             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1494             # the fatal directory should still show up, as the last line
1495             self.failUnlessIn(" subdir\n", out)
1496         d.addCallback(_manifest_failed)
1497
1498         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1499         def _deep_check_failed((rc, out, err)):
1500             self.failIfEqual(rc, 0)
1501             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1502             # we want to make sure that the error indication is the last
1503             # thing that gets emitted
1504             self.failIf("done:" in out, out)
1505         d.addCallback(_deep_check_failed)
1506
1507         # this test is disabled until the deep-repair response to an
1508         # unrepairable directory is fixed. The failure-to-repair should not
1509         # throw an exception, but the failure-to-traverse that follows
1510         # should throw UnrecoverableFileError.
1511
1512         #d.addCallback(lambda ign:
1513         #              self.do_cli("deep-check", "--repair", self.rooturi))
1514         #def _deep_check_repair_failed((rc, out, err)):
1515         #    self.failIfEqual(rc, 0)
1516         #    print err
1517         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1518         #    self.failIf("done:" in out, out)
1519         #d.addCallback(_deep_check_repair_failed)
1520
1521         return d
1522
1523 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
1524     def test_check(self):
1525         self.basedir = "cli/Check/check"
1526         self.set_up_grid()
1527         c0 = self.g.clients[0]
1528         self.fileurls = {}
1529         DATA = "data" * 100
1530         d = c0.upload(upload.Data(DATA, convergence=""))
1531         def _stash_bad(ur):
1532             self.uri_1share = ur.uri
1533             self.delete_shares_numbered(ur.uri, range(1,10))
1534         d.addCallback(_stash_bad)
1535
1536         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
1537         def _check1((rc, out, err)):
1538             self.failIfEqual(rc, 0)
1539             self.failUnless("410 Gone" in err, err)
1540             self.failUnlessIn("NotEnoughSharesError: ", err)
1541             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
1542         d.addCallback(_check1)
1543
1544         return d
1545
1546 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
1547     def test_empty_directory(self):
1548         self.basedir = "cli/Stats/empty_directory"
1549         self.set_up_grid()
1550         c0 = self.g.clients[0]
1551         self.fileurls = {}
1552         d = c0.create_empty_dirnode()
1553         def _stash_root(n):
1554             self.rootnode = n
1555             self.rooturi = n.get_uri()
1556         d.addCallback(_stash_root)
1557
1558         # make sure we can get stats on an empty directory too
1559         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1560         def _check_stats((rc, out, err)):
1561             self.failUnlessEqual(err, "")
1562             self.failUnlessEqual(rc, 0)
1563             lines = out.splitlines()
1564             self.failUnlessIn(" count-immutable-files: 0", lines)
1565             self.failUnlessIn("   count-mutable-files: 0", lines)
1566             self.failUnlessIn("   count-literal-files: 0", lines)
1567             self.failUnlessIn("     count-directories: 1", lines)
1568             self.failUnlessIn("  size-immutable-files: 0", lines)
1569             self.failIfIn("Size Histogram:", lines)
1570         d.addCallback(_check_stats)
1571
1572         return d