]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - src/allmydata/test/test_cli.py
test_cli: verify fix for "tahoe get" not creating empty file on error (#121)
[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         small = "small"
752         d = c0.create_dirnode()
753         def _stash_root_and_create_file(n):
754             self.rootnode = n
755             self.rooturi = n.get_uri()
756             return n.add_file(u"good", upload.Data(small, convergence=""))
757         d.addCallback(_stash_root_and_create_file)
758         def _stash_goodcap(n):
759             self.goodcap = n.get_uri()
760         d.addCallback(_stash_goodcap)
761         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"1share"))
762         d.addCallback(lambda n:
763                       self.delete_shares_numbered(n.get_uri(), range(1,10)))
764         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"0share"))
765         d.addCallback(lambda n:
766                       self.delete_shares_numbered(n.get_uri(), range(0,10)))
767         d.addCallback(lambda ign:
768                       self.do_cli("add-alias", "tahoe", self.rooturi))
769         d.addCallback(lambda ign: self.do_cli("ls"))
770         def _check1((rc,out,err)):
771             self.failUnlessEqual(err, "")
772             self.failUnlessEqual(rc, 0)
773             self.failUnlessEqual(out.splitlines(), ["0share", "1share", "good"])
774         d.addCallback(_check1)
775         d.addCallback(lambda ign: self.do_cli("ls", "missing"))
776         def _check2((rc,out,err)):
777             self.failIfEqual(rc, 0)
778             self.failUnlessEqual(err.strip(), "No such file or directory")
779             self.failUnlessEqual(out, "")
780         d.addCallback(_check2)
781         d.addCallback(lambda ign: self.do_cli("ls", "1share"))
782         def _check3((rc,out,err)):
783             self.failIfEqual(rc, 0)
784             self.failUnlessIn("Error during GET: 410 Gone ", err)
785             self.failUnlessIn("UnrecoverableFileError:", err)
786             self.failUnlessIn("could not be retrieved, because there were "
787                               "insufficient good shares.", err)
788             self.failUnlessEqual(out, "")
789         d.addCallback(_check3)
790         d.addCallback(lambda ign: self.do_cli("ls", "0share"))
791         d.addCallback(_check3)
792         def _check4((rc, out, err)):
793             # listing a file (as dir/filename) should have the edge metadata,
794             # including the filename
795             self.failUnlessEqual(rc, 0)
796             self.failUnlessIn("good", out)
797             self.failIfIn("-r-- %d -" % len(small), out,
798                           "trailing hyphen means unknown date")
799         d.addCallback(lambda ign: self.do_cli("ls", "-l", "good"))
800         d.addCallback(_check4)
801         def _check5((rc, out, err)):
802             # listing a raw filecap should not explode, but it will have no
803             # metadata, just the size
804             self.failUnlessEqual(rc, 0)
805             self.failUnlessEqual("-r-- %d -" % len(small), out.strip())
806         d.addCallback(lambda ign: self.do_cli("ls", "-l", self.goodcap))
807         d.addCallback(_check5)
808         return d
809
810 class Mv(GridTestMixin, CLITestMixin, unittest.TestCase):
811     def test_mv_behavior(self):
812         self.basedir = "cli/Mv/mv_behavior"
813         self.set_up_grid()
814         fn1 = os.path.join(self.basedir, "file1")
815         DATA1 = "Nuclear launch codes"
816         open(fn1, "wb").write(DATA1)
817         fn2 = os.path.join(self.basedir, "file2")
818         DATA2 = "UML diagrams"
819         open(fn2, "wb").write(DATA2)
820         # copy both files to the grid
821         d = self.do_cli("create-alias", "tahoe")
822         d.addCallback(lambda res:
823             self.do_cli("cp", fn1, "tahoe:"))
824         d.addCallback(lambda res:
825             self.do_cli("cp", fn2, "tahoe:"))
826
827         # do mv file1 file3
828         # (we should be able to rename files)
829         d.addCallback(lambda res:
830             self.do_cli("mv", "tahoe:file1", "tahoe:file3"))
831         d.addCallback(lambda (rc, out, err):
832             self.failUnlessIn("OK", out, "mv didn't rename a file"))
833
834         # do mv file3 file2
835         # (This should succeed without issue)
836         d.addCallback(lambda res:
837             self.do_cli("mv", "tahoe:file3", "tahoe:file2"))
838         # Out should contain "OK" to show that the transfer worked.
839         d.addCallback(lambda (rc,out,err):
840             self.failUnlessIn("OK", out, "mv didn't output OK after mving"))
841
842         # Next, make a remote directory.
843         d.addCallback(lambda res:
844             self.do_cli("mkdir", "tahoe:directory"))
845
846         # mv file2 directory
847         # (should fail with a descriptive error message; the CLI mv
848         #  client should support this)
849         d.addCallback(lambda res:
850             self.do_cli("mv", "tahoe:file2", "tahoe:directory"))
851         d.addCallback(lambda (rc, out, err):
852             self.failUnlessIn(
853                 "Error: You can't overwrite a directory with a file", err,
854                 "mv shouldn't overwrite directories" ))
855
856         # mv file2 directory/
857         # (should succeed by making file2 a child node of directory)
858         d.addCallback(lambda res:
859             self.do_cli("mv", "tahoe:file2", "tahoe:directory/"))
860         # We should see an "OK"...
861         d.addCallback(lambda (rc, out, err):
862             self.failUnlessIn("OK", out,
863                             "mv didn't mv a file into a directory"))
864         # ... and be able to GET the file
865         d.addCallback(lambda res:
866             self.do_cli("get", "tahoe:directory/file2", self.basedir + "new"))
867         d.addCallback(lambda (rc, out, err):
868             self.failUnless(os.path.exists(self.basedir + "new"),
869                             "mv didn't write the destination file"))
870         # ... and not find the file where it was before.
871         d.addCallback(lambda res:
872             self.do_cli("get", "tahoe:file2", "file2"))
873         d.addCallback(lambda (rc, out, err):
874             self.failUnlessIn("404", err,
875                             "mv left the source file intact"))
876
877         # Let's build:
878         # directory/directory2/some_file
879         # directory3
880         d.addCallback(lambda res:
881             self.do_cli("mkdir", "tahoe:directory/directory2"))
882         d.addCallback(lambda res:
883             self.do_cli("cp", fn2, "tahoe:directory/directory2/some_file"))
884         d.addCallback(lambda res:
885             self.do_cli("mkdir", "tahoe:directory3"))
886
887         # Let's now try to mv directory/directory2/some_file to
888         # directory3/some_file
889         d.addCallback(lambda res:
890             self.do_cli("mv", "tahoe:directory/directory2/some_file",
891                         "tahoe:directory3/"))
892         # We should have just some_file in tahoe:directory3
893         d.addCallback(lambda res:
894             self.do_cli("get", "tahoe:directory3/some_file", "some_file"))
895         d.addCallback(lambda (rc, out, err):
896             self.failUnless("404" not in err,
897                               "mv didn't handle nested directories correctly"))
898         d.addCallback(lambda res:
899             self.do_cli("get", "tahoe:directory3/directory", "directory"))
900         d.addCallback(lambda (rc, out, err):
901             self.failUnlessIn("404", err,
902                               "mv moved the wrong thing"))
903         return d
904
905 class Cp(GridTestMixin, CLITestMixin, unittest.TestCase):
906
907     def test_not_enough_args(self):
908         o = cli.CpOptions()
909         self.failUnlessRaises(usage.UsageError,
910                               o.parseOptions, ["onearg"])
911
912     def test_unicode_filename(self):
913         self.basedir = "cli/Cp/unicode_filename"
914         self.set_up_grid()
915
916         fn1 = os.path.join(self.basedir, "Ärtonwall")
917         DATA1 = "unicode file content"
918         open(fn1, "wb").write(DATA1)
919
920         fn2 = os.path.join(self.basedir, "Metallica")
921         DATA2 = "non-unicode file content"
922         open(fn2, "wb").write(DATA2)
923
924         # Bug #534
925         # Assure that uploading a file whose name contains unicode character doesn't
926         # prevent further uploads in the same directory
927         d = self.do_cli("create-alias", "tahoe")
928         d.addCallback(lambda res: self.do_cli("cp", fn1, "tahoe:"))
929         d.addCallback(lambda res: self.do_cli("cp", fn2, "tahoe:"))
930
931         d.addCallback(lambda res: self.do_cli("get", "tahoe:Ärtonwall"))
932         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA1))
933
934         d.addCallback(lambda res: self.do_cli("get", "tahoe:Metallica"))
935         d.addCallback(lambda (rc,out,err): self.failUnlessEqual(out, DATA2))
936
937         return d
938     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."
939
940     def test_dangling_symlink_vs_recursion(self):
941         if not hasattr(os, 'symlink'):
942             raise unittest.SkipTest("There is no symlink on this platform.")
943         # cp -r on a directory containing a dangling symlink shouldn't assert
944         self.basedir = "cli/Cp/dangling_symlink_vs_recursion"
945         self.set_up_grid()
946         dn = os.path.join(self.basedir, "dir")
947         os.mkdir(dn)
948         fn = os.path.join(dn, "Fakebandica")
949         ln = os.path.join(dn, "link")
950         os.symlink(fn, ln)
951
952         d = self.do_cli("create-alias", "tahoe")
953         d.addCallback(lambda res: self.do_cli("cp", "--recursive",
954                                               dn, "tahoe:"))
955         return d
956
957     def test_copy_using_filecap(self):
958         self.basedir = "cli/Cp/test_copy_using_filecap"
959         self.set_up_grid()
960         outdir = os.path.join(self.basedir, "outdir")
961         os.mkdir(outdir)
962         self.do_cli("create-alias", "tahoe")
963         fn1 = os.path.join(self.basedir, "Metallica")
964         fn2 = os.path.join(outdir, "Not Metallica")
965         fn3 = os.path.join(outdir, "test2")
966         DATA1 = "puppies" * 10000
967         open(fn1, "wb").write(DATA1)
968         d = self.do_cli("put", fn1)
969         def _put_file((rc, out, err)):
970             self.failUnlessEqual(rc, 0)
971             # keep track of the filecap
972             self.filecap = out.strip()
973         d.addCallback(_put_file)
974         # Let's try copying this to the disk using the filecap
975         #  cp FILECAP filename
976         d.addCallback(lambda res: self.do_cli("cp", self.filecap, fn2))
977         def _copy_file((rc, out, err)):
978             self.failUnlessEqual(rc, 0)
979             results = open(fn2, "r").read()
980             self.failUnlessEqual(results, DATA1)
981         # Test with ./ (see #761)
982         #  cp FILECAP localdir
983         d.addCallback(lambda res: self.do_cli("cp", self.filecap, outdir))
984         def _resp((rc, out, err)):
985             self.failUnlessEqual(rc, 1)
986             self.failUnlessIn("error: you must specify a destination filename",
987                               err)
988         d.addCallback(_resp)
989         # Create a directory, linked at tahoe:test
990         d.addCallback(lambda res: self.do_cli("mkdir", "tahoe:test"))
991         def _get_dir((rc, out, err)):
992             self.failUnlessEqual(rc, 0)
993             self.dircap = out.strip()
994         d.addCallback(_get_dir)
995         # Upload a file to the directory
996         d.addCallback(lambda res:
997             self.do_cli("put", fn1, "tahoe:test/test_file"))
998         d.addCallback(lambda (rc, out, err): self.failUnlessEqual(rc, 0))
999         #  cp DIRCAP/filename localdir
1000         d.addCallback(lambda res:
1001                       self.do_cli("cp",  self.dircap + "/test_file", outdir))
1002         def _get_resp((rc, out, err)):
1003             self.failUnlessEqual(rc, 0)
1004             results = open(os.path.join(outdir, "test_file"), "r").read()
1005             self.failUnlessEqual(results, DATA1)
1006         d.addCallback(_get_resp)
1007         #  cp -r DIRCAP/filename filename2
1008         d.addCallback(lambda res:
1009                       self.do_cli("cp",  self.dircap + "/test_file", fn3))
1010         def _get_resp2((rc, out, err)):
1011             self.failUnlessEqual(rc, 0)
1012             results = open(fn3, "r").read()
1013             self.failUnlessEqual(results, DATA1)
1014         d.addCallback(_get_resp2)
1015         return d
1016
1017 class Backup(GridTestMixin, CLITestMixin, StallMixin, unittest.TestCase):
1018
1019     def writeto(self, path, data):
1020         d = os.path.dirname(os.path.join(self.basedir, "home", path))
1021         fileutil.make_dirs(d)
1022         f = open(os.path.join(self.basedir, "home", path), "w")
1023         f.write(data)
1024         f.close()
1025
1026     def count_output(self, out):
1027         mo = re.search(r"(\d)+ files uploaded \((\d+) reused\), (\d+) directories created \((\d+) reused\)", out)
1028         return [int(s) for s in mo.groups()]
1029
1030     def count_output2(self, out):
1031         mo = re.search(r"(\d)+ files checked, (\d+) directories checked", out)
1032         return [int(s) for s in mo.groups()]
1033
1034     def test_backup(self):
1035         self.basedir = "cli/Backup/backup"
1036         self.set_up_grid()
1037
1038         # is the backupdb available? If so, we test that a second backup does
1039         # not create new directories.
1040         hush = StringIO()
1041         have_bdb = backupdb.get_backupdb(os.path.join(self.basedir, "dbtest"),
1042                                          hush)
1043
1044         # create a small local directory with a couple of files
1045         source = os.path.join(self.basedir, "home")
1046         fileutil.make_dirs(os.path.join(source, "empty"))
1047         self.writeto("parent/subdir/foo.txt", "foo")
1048         self.writeto("parent/subdir/bar.txt", "bar\n" * 1000)
1049         self.writeto("parent/blah.txt", "blah")
1050
1051         def do_backup(verbose=False):
1052             cmd = ["backup"]
1053             if verbose:
1054                 cmd.append("--verbose")
1055             cmd.append(source)
1056             cmd.append("tahoe:backups")
1057             return self.do_cli(*cmd)
1058
1059         d = self.do_cli("create-alias", "tahoe")
1060
1061         if not have_bdb:
1062             d.addCallback(lambda res: self.do_cli("backup", source, "tahoe:backups"))
1063             def _should_complain((rc, out, err)):
1064                 self.failUnless("I was unable to import a python sqlite library" in err, err)
1065             d.addCallback(_should_complain)
1066             d.addCallback(self.stall, 1.1) # make sure the backups get distinct timestamps
1067
1068         d.addCallback(lambda res: do_backup())
1069         def _check0((rc, out, err)):
1070             self.failUnlessEqual(err, "")
1071             self.failUnlessEqual(rc, 0)
1072             fu, fr, dc, dr = self.count_output(out)
1073             # foo.txt, bar.txt, blah.txt
1074             self.failUnlessEqual(fu, 3)
1075             self.failUnlessEqual(fr, 0)
1076             # empty, home, home/parent, home/parent/subdir
1077             self.failUnlessEqual(dc, 4)
1078             self.failUnlessEqual(dr, 0)
1079         d.addCallback(_check0)
1080
1081         d.addCallback(lambda res: self.do_cli("ls", "--uri", "tahoe:backups"))
1082         def _check1((rc, out, err)):
1083             self.failUnlessEqual(err, "")
1084             self.failUnlessEqual(rc, 0)
1085             lines = out.split("\n")
1086             children = dict([line.split() for line in lines if line])
1087             latest_uri = children["Latest"]
1088             self.failUnless(latest_uri.startswith("URI:DIR2-CHK:"), latest_uri)
1089             childnames = children.keys()
1090             self.failUnlessEqual(sorted(childnames), ["Archives", "Latest"])
1091         d.addCallback(_check1)
1092         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest"))
1093         def _check2((rc, out, err)):
1094             self.failUnlessEqual(err, "")
1095             self.failUnlessEqual(rc, 0)
1096             self.failUnlessEqual(sorted(out.split()), ["empty", "parent"])
1097         d.addCallback(_check2)
1098         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Latest/empty"))
1099         def _check2a((rc, out, err)):
1100             self.failUnlessEqual(err, "")
1101             self.failUnlessEqual(rc, 0)
1102             self.failUnlessEqual(out.strip(), "")
1103         d.addCallback(_check2a)
1104         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1105         def _check3((rc, out, err)):
1106             self.failUnlessEqual(err, "")
1107             self.failUnlessEqual(rc, 0)
1108             self.failUnlessEqual(out, "foo")
1109         d.addCallback(_check3)
1110         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1111         def _check4((rc, out, err)):
1112             self.failUnlessEqual(err, "")
1113             self.failUnlessEqual(rc, 0)
1114             self.old_archives = out.split()
1115             self.failUnlessEqual(len(self.old_archives), 1)
1116         d.addCallback(_check4)
1117
1118
1119         d.addCallback(self.stall, 1.1)
1120         d.addCallback(lambda res: do_backup())
1121         def _check4a((rc, out, err)):
1122             # second backup should reuse everything, if the backupdb is
1123             # available
1124             self.failUnlessEqual(err, "")
1125             self.failUnlessEqual(rc, 0)
1126             if have_bdb:
1127                 fu, fr, dc, dr = self.count_output(out)
1128                 # foo.txt, bar.txt, blah.txt
1129                 self.failUnlessEqual(fu, 0)
1130                 self.failUnlessEqual(fr, 3)
1131                 # empty, home, home/parent, home/parent/subdir
1132                 self.failUnlessEqual(dc, 0)
1133                 self.failUnlessEqual(dr, 4)
1134         d.addCallback(_check4a)
1135
1136         if have_bdb:
1137             # sneak into the backupdb, crank back the "last checked"
1138             # timestamp to force a check on all files
1139             def _reset_last_checked(res):
1140                 dbfile = os.path.join(self.get_clientdir(),
1141                                       "private", "backupdb.sqlite")
1142                 self.failUnless(os.path.exists(dbfile), dbfile)
1143                 bdb = backupdb.get_backupdb(dbfile)
1144                 bdb.cursor.execute("UPDATE last_upload SET last_checked=0")
1145                 bdb.cursor.execute("UPDATE directories SET last_checked=0")
1146                 bdb.connection.commit()
1147
1148             d.addCallback(_reset_last_checked)
1149
1150             d.addCallback(self.stall, 1.1)
1151             d.addCallback(lambda res: do_backup(verbose=True))
1152             def _check4b((rc, out, err)):
1153                 # we should check all files, and re-use all of them. None of
1154                 # the directories should have been changed, so we should
1155                 # re-use all of them too.
1156                 self.failUnlessEqual(err, "")
1157                 self.failUnlessEqual(rc, 0)
1158                 fu, fr, dc, dr = self.count_output(out)
1159                 fchecked, dchecked = self.count_output2(out)
1160                 self.failUnlessEqual(fchecked, 3)
1161                 self.failUnlessEqual(fu, 0)
1162                 self.failUnlessEqual(fr, 3)
1163                 self.failUnlessEqual(dchecked, 4)
1164                 self.failUnlessEqual(dc, 0)
1165                 self.failUnlessEqual(dr, 4)
1166             d.addCallback(_check4b)
1167
1168         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1169         def _check5((rc, out, err)):
1170             self.failUnlessEqual(err, "")
1171             self.failUnlessEqual(rc, 0)
1172             self.new_archives = out.split()
1173             expected_new = 2
1174             if have_bdb:
1175                 expected_new += 1
1176             self.failUnlessEqual(len(self.new_archives), expected_new, out)
1177             # the original backup should still be the oldest (i.e. sorts
1178             # alphabetically towards the beginning)
1179             self.failUnlessEqual(sorted(self.new_archives)[0],
1180                                  self.old_archives[0])
1181         d.addCallback(_check5)
1182
1183         d.addCallback(self.stall, 1.1)
1184         def _modify(res):
1185             self.writeto("parent/subdir/foo.txt", "FOOF!")
1186             # and turn a file into a directory
1187             os.unlink(os.path.join(source, "parent/blah.txt"))
1188             os.mkdir(os.path.join(source, "parent/blah.txt"))
1189             self.writeto("parent/blah.txt/surprise file", "surprise")
1190             self.writeto("parent/blah.txt/surprisedir/subfile", "surprise")
1191             # turn a directory into a file
1192             os.rmdir(os.path.join(source, "empty"))
1193             self.writeto("empty", "imagine nothing being here")
1194             return do_backup()
1195         d.addCallback(_modify)
1196         def _check5a((rc, out, err)):
1197             # second backup should reuse bar.txt (if backupdb is available),
1198             # and upload the rest. None of the directories can be reused.
1199             self.failUnlessEqual(err, "")
1200             self.failUnlessEqual(rc, 0)
1201             if have_bdb:
1202                 fu, fr, dc, dr = self.count_output(out)
1203                 # new foo.txt, surprise file, subfile, empty
1204                 self.failUnlessEqual(fu, 4)
1205                 # old bar.txt
1206                 self.failUnlessEqual(fr, 1)
1207                 # home, parent, subdir, blah.txt, surprisedir
1208                 self.failUnlessEqual(dc, 5)
1209                 self.failUnlessEqual(dr, 0)
1210         d.addCallback(_check5a)
1211         d.addCallback(lambda res: self.do_cli("ls", "tahoe:backups/Archives"))
1212         def _check6((rc, out, err)):
1213             self.failUnlessEqual(err, "")
1214             self.failUnlessEqual(rc, 0)
1215             self.new_archives = out.split()
1216             expected_new = 3
1217             if have_bdb:
1218                 expected_new += 1
1219             self.failUnlessEqual(len(self.new_archives), expected_new)
1220             self.failUnlessEqual(sorted(self.new_archives)[0],
1221                                  self.old_archives[0])
1222         d.addCallback(_check6)
1223         d.addCallback(lambda res: self.do_cli("get", "tahoe:backups/Latest/parent/subdir/foo.txt"))
1224         def _check7((rc, out, err)):
1225             self.failUnlessEqual(err, "")
1226             self.failUnlessEqual(rc, 0)
1227             self.failUnlessEqual(out, "FOOF!")
1228             # the old snapshot should not be modified
1229             return self.do_cli("get", "tahoe:backups/Archives/%s/parent/subdir/foo.txt" % self.old_archives[0])
1230         d.addCallback(_check7)
1231         def _check8((rc, out, err)):
1232             self.failUnlessEqual(err, "")
1233             self.failUnlessEqual(rc, 0)
1234             self.failUnlessEqual(out, "foo")
1235         d.addCallback(_check8)
1236
1237         return d
1238
1239     # on our old dapper buildslave, this test takes a long time (usually
1240     # 130s), so we have to bump up the default 120s timeout. The create-alias
1241     # and initial backup alone take 60s, probably because of the handful of
1242     # dirnodes being created (RSA key generation). The backup between check4
1243     # and check4a takes 6s, as does the backup before check4b.
1244     test_backup.timeout = 3000
1245
1246     def test_exclude_options(self):
1247         root_listdir = ('lib.a', '_darcs', 'subdir', 'nice_doc.lyx')
1248         subdir_listdir = ('another_doc.lyx', 'run_snake_run.py', 'CVS', '.svn', '_darcs')
1249         basedir = "cli/Backup/exclude_options"
1250         fileutil.make_dirs(basedir)
1251         nodeurl_path = os.path.join(basedir, 'node.url')
1252         nodeurl = file(nodeurl_path, 'w')
1253         nodeurl.write('http://example.net:2357/')
1254         nodeurl.close()
1255
1256         def _check_filtering(filtered, all, included, excluded):
1257             filtered = set(filtered)
1258             all = set(all)
1259             included = set(included)
1260             excluded = set(excluded)
1261             self.failUnlessEqual(filtered, included)
1262             self.failUnlessEqual(all.difference(filtered), excluded)
1263
1264         # test simple exclude
1265         backup_options = cli.BackupOptions()
1266         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1267                                      basedir, 'from', 'to'])
1268         filtered = list(backup_options.filter_listdir(root_listdir))
1269         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1270                          ('nice_doc.lyx',))
1271         # multiple exclude
1272         backup_options = cli.BackupOptions()
1273         backup_options.parseOptions(['--exclude', '*lyx', '--exclude', 'lib.?', '--node-directory',
1274                                      basedir, 'from', 'to'])
1275         filtered = list(backup_options.filter_listdir(root_listdir))
1276         _check_filtering(filtered, root_listdir, ('_darcs', 'subdir'),
1277                          ('nice_doc.lyx', 'lib.a'))
1278         # vcs metadata exclusion
1279         backup_options = cli.BackupOptions()
1280         backup_options.parseOptions(['--exclude-vcs', '--node-directory',
1281                                      basedir, 'from', 'to'])
1282         filtered = list(backup_options.filter_listdir(subdir_listdir))
1283         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'run_snake_run.py',),
1284                          ('CVS', '.svn', '_darcs'))
1285         # read exclude patterns from file
1286         exclusion_string = "_darcs\n*py\n.svn"
1287         excl_filepath = os.path.join(basedir, 'exclusion')
1288         excl_file = file(excl_filepath, 'w')
1289         excl_file.write(exclusion_string)
1290         excl_file.close()
1291         backup_options = cli.BackupOptions()
1292         backup_options.parseOptions(['--exclude-from', excl_filepath, '--node-directory',
1293                                      basedir, 'from', 'to'])
1294         filtered = list(backup_options.filter_listdir(subdir_listdir))
1295         _check_filtering(filtered, subdir_listdir, ('another_doc.lyx', 'CVS'),
1296                          ('.svn', '_darcs', 'run_snake_run.py'))
1297         # text BackupConfigurationError
1298         self.failUnlessRaises(cli.BackupConfigurationError,
1299                               backup_options.parseOptions,
1300                               ['--exclude-from', excl_filepath + '.no', '--node-directory',
1301                                basedir, 'from', 'to'])
1302
1303         # test that an iterator works too
1304         backup_options = cli.BackupOptions()
1305         backup_options.parseOptions(['--exclude', '*lyx', '--node-directory',
1306                                      basedir, 'from', 'to'])
1307         filtered = list(backup_options.filter_listdir(iter(root_listdir)))
1308         _check_filtering(filtered, root_listdir, ('lib.a', '_darcs', 'subdir'),
1309                          ('nice_doc.lyx',))
1310
1311 class Check(GridTestMixin, CLITestMixin, unittest.TestCase):
1312
1313     def test_check(self):
1314         self.basedir = "cli/Check/check"
1315         self.set_up_grid()
1316         c0 = self.g.clients[0]
1317         DATA = "data" * 100
1318         d = c0.create_mutable_file(DATA)
1319         def _stash_uri(n):
1320             self.uri = n.get_uri()
1321         d.addCallback(_stash_uri)
1322
1323         d.addCallback(lambda ign: self.do_cli("check", self.uri))
1324         def _check1((rc, out, err)):
1325             self.failUnlessEqual(err, "")
1326             self.failUnlessEqual(rc, 0)
1327             lines = out.splitlines()
1328             self.failUnless("Summary: Healthy" in lines, out)
1329             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1330         d.addCallback(_check1)
1331
1332         d.addCallback(lambda ign: self.do_cli("check", "--raw", self.uri))
1333         def _check2((rc, out, err)):
1334             self.failUnlessEqual(err, "")
1335             self.failUnlessEqual(rc, 0)
1336             data = simplejson.loads(out)
1337             self.failUnlessEqual(data["summary"], "Healthy")
1338         d.addCallback(_check2)
1339
1340         def _clobber_shares(ignored):
1341             # delete one, corrupt a second
1342             shares = self.find_shares(self.uri)
1343             self.failUnlessEqual(len(shares), 10)
1344             os.unlink(shares[0][2])
1345             cso = debug.CorruptShareOptions()
1346             cso.stdout = StringIO()
1347             cso.parseOptions([shares[1][2]])
1348             storage_index = uri.from_string(self.uri).get_storage_index()
1349             self._corrupt_share_line = "  server %s, SI %s, shnum %d" % \
1350                                        (base32.b2a(shares[1][1]),
1351                                         base32.b2a(storage_index),
1352                                         shares[1][0])
1353             debug.corrupt_share(cso)
1354         d.addCallback(_clobber_shares)
1355
1356         d.addCallback(lambda ign: self.do_cli("check", "--verify", self.uri))
1357         def _check3((rc, out, err)):
1358             self.failUnlessEqual(err, "")
1359             self.failUnlessEqual(rc, 0)
1360             lines = out.splitlines()
1361             summary = [l for l in lines if l.startswith("Summary")][0]
1362             self.failUnless("Summary: Unhealthy: 8 shares (enc 3-of-10)"
1363                             in summary, summary)
1364             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1365             self.failUnless(" corrupt shares:" in lines, out)
1366             self.failUnless(self._corrupt_share_line in lines, out)
1367         d.addCallback(_check3)
1368
1369         d.addCallback(lambda ign:
1370                       self.do_cli("check", "--verify", "--repair", self.uri))
1371         def _check4((rc, out, err)):
1372             self.failUnlessEqual(err, "")
1373             self.failUnlessEqual(rc, 0)
1374             lines = out.splitlines()
1375             self.failUnless("Summary: not healthy" in lines, out)
1376             self.failUnless(" good-shares: 8 (encoding is 3-of-10)" in lines, out)
1377             self.failUnless(" corrupt shares:" in lines, out)
1378             self.failUnless(self._corrupt_share_line in lines, out)
1379             self.failUnless(" repair successful" in lines, out)
1380         d.addCallback(_check4)
1381
1382         d.addCallback(lambda ign:
1383                       self.do_cli("check", "--verify", "--repair", self.uri))
1384         def _check5((rc, out, err)):
1385             self.failUnlessEqual(err, "")
1386             self.failUnlessEqual(rc, 0)
1387             lines = out.splitlines()
1388             self.failUnless("Summary: healthy" in lines, out)
1389             self.failUnless(" good-shares: 10 (encoding is 3-of-10)" in lines, out)
1390             self.failIf(" corrupt shares:" in lines, out)
1391         d.addCallback(_check5)
1392
1393         return d
1394
1395     def test_deep_check(self):
1396         self.basedir = "cli/Check/deep_check"
1397         self.set_up_grid()
1398         c0 = self.g.clients[0]
1399         self.uris = {}
1400         self.fileurls = {}
1401         DATA = "data" * 100
1402         d = c0.create_dirnode()
1403         def _stash_root_and_create_file(n):
1404             self.rootnode = n
1405             self.rooturi = n.get_uri()
1406             return n.add_file(u"good", upload.Data(DATA, convergence=""))
1407         d.addCallback(_stash_root_and_create_file)
1408         def _stash_uri(fn, which):
1409             self.uris[which] = fn.get_uri()
1410             return fn
1411         d.addCallback(_stash_uri, "good")
1412         d.addCallback(lambda ign:
1413                       self.rootnode.add_file(u"small",
1414                                              upload.Data("literal",
1415                                                         convergence="")))
1416         d.addCallback(_stash_uri, "small")
1417         d.addCallback(lambda ign: c0.create_mutable_file(DATA+"1"))
1418         d.addCallback(lambda fn: self.rootnode.set_node(u"mutable", fn))
1419         d.addCallback(_stash_uri, "mutable")
1420
1421         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1422         def _check1((rc, out, err)):
1423             self.failUnlessEqual(err, "")
1424             self.failUnlessEqual(rc, 0)
1425             lines = out.splitlines()
1426             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1427                             in lines, out)
1428         d.addCallback(_check1)
1429
1430         # root
1431         # root/good
1432         # root/small
1433         # root/mutable
1434
1435         d.addCallback(lambda ign: self.do_cli("deep-check", "--verbose",
1436                                               self.rooturi))
1437         def _check2((rc, out, err)):
1438             self.failUnlessEqual(err, "")
1439             self.failUnlessEqual(rc, 0)
1440             lines = out.splitlines()
1441             self.failUnless("<root>: Healthy" in lines, out)
1442             self.failUnless("small: Healthy (LIT)" in lines, out)
1443             self.failUnless("good: Healthy" in lines, out)
1444             self.failUnless("mutable: Healthy" in lines, out)
1445             self.failUnless("done: 4 objects checked, 4 healthy, 0 unhealthy"
1446                             in lines, out)
1447         d.addCallback(_check2)
1448
1449         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1450         def _check_stats((rc, out, err)):
1451             self.failUnlessEqual(err, "")
1452             self.failUnlessEqual(rc, 0)
1453             lines = out.splitlines()
1454             self.failUnlessIn(" count-immutable-files: 1", lines)
1455             self.failUnlessIn("   count-mutable-files: 1", lines)
1456             self.failUnlessIn("   count-literal-files: 1", lines)
1457             self.failUnlessIn("     count-directories: 1", lines)
1458             self.failUnlessIn("  size-immutable-files: 400", lines)
1459             self.failUnlessIn("Size Histogram:", lines)
1460             self.failUnlessIn("   4-10   : 1    (10 B, 10 B)", lines)
1461             self.failUnlessIn(" 317-1000 : 1    (1000 B, 1000 B)", lines)
1462         d.addCallback(_check_stats)
1463
1464         def _clobber_shares(ignored):
1465             shares = self.find_shares(self.uris["good"])
1466             self.failUnlessEqual(len(shares), 10)
1467             os.unlink(shares[0][2])
1468
1469             shares = self.find_shares(self.uris["mutable"])
1470             cso = debug.CorruptShareOptions()
1471             cso.stdout = StringIO()
1472             cso.parseOptions([shares[1][2]])
1473             storage_index = uri.from_string(self.uris["mutable"]).get_storage_index()
1474             self._corrupt_share_line = " corrupt: server %s, SI %s, shnum %d" % \
1475                                        (base32.b2a(shares[1][1]),
1476                                         base32.b2a(storage_index),
1477                                         shares[1][0])
1478             debug.corrupt_share(cso)
1479         d.addCallback(_clobber_shares)
1480
1481         # root
1482         # root/good  [9 shares]
1483         # root/small
1484         # root/mutable [1 corrupt share]
1485
1486         d.addCallback(lambda ign:
1487                       self.do_cli("deep-check", "--verbose", self.rooturi))
1488         def _check3((rc, out, err)):
1489             self.failUnlessEqual(err, "")
1490             self.failUnlessEqual(rc, 0)
1491             lines = out.splitlines()
1492             self.failUnless("<root>: Healthy" in lines, out)
1493             self.failUnless("small: Healthy (LIT)" in lines, out)
1494             self.failUnless("mutable: Healthy" in lines, out) # needs verifier
1495             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1496                             in lines, out)
1497             self.failIf(self._corrupt_share_line in lines, out)
1498             self.failUnless("done: 4 objects checked, 3 healthy, 1 unhealthy"
1499                             in lines, out)
1500         d.addCallback(_check3)
1501
1502         d.addCallback(lambda ign:
1503                       self.do_cli("deep-check", "--verbose", "--verify",
1504                                   self.rooturi))
1505         def _check4((rc, out, err)):
1506             self.failUnlessEqual(err, "")
1507             self.failUnlessEqual(rc, 0)
1508             lines = out.splitlines()
1509             self.failUnless("<root>: Healthy" in lines, out)
1510             self.failUnless("small: Healthy (LIT)" in lines, out)
1511             mutable = [l for l in lines if l.startswith("mutable")][0]
1512             self.failUnless(mutable.startswith("mutable: Unhealthy: 9 shares (enc 3-of-10)"),
1513                             mutable)
1514             self.failUnless(self._corrupt_share_line in lines, out)
1515             self.failUnless("good: Not Healthy: 9 shares (enc 3-of-10)"
1516                             in lines, out)
1517             self.failUnless("done: 4 objects checked, 2 healthy, 2 unhealthy"
1518                             in lines, out)
1519         d.addCallback(_check4)
1520
1521         d.addCallback(lambda ign:
1522                       self.do_cli("deep-check", "--raw",
1523                                   self.rooturi))
1524         def _check5((rc, out, err)):
1525             self.failUnlessEqual(err, "")
1526             self.failUnlessEqual(rc, 0)
1527             lines = out.splitlines()
1528             units = [simplejson.loads(line) for line in lines]
1529             # root, small, good, mutable,  stats
1530             self.failUnlessEqual(len(units), 4+1)
1531         d.addCallback(_check5)
1532
1533         d.addCallback(lambda ign:
1534                       self.do_cli("deep-check",
1535                                   "--verbose", "--verify", "--repair",
1536                                   self.rooturi))
1537         def _check6((rc, out, err)):
1538             self.failUnlessEqual(err, "")
1539             self.failUnlessEqual(rc, 0)
1540             lines = out.splitlines()
1541             self.failUnless("<root>: healthy" in lines, out)
1542             self.failUnless("small: healthy" in lines, out)
1543             self.failUnless("mutable: not healthy" in lines, out)
1544             self.failUnless(self._corrupt_share_line in lines, out)
1545             self.failUnless("good: not healthy" in lines, out)
1546             self.failUnless("done: 4 objects checked" in lines, out)
1547             self.failUnless(" pre-repair: 2 healthy, 2 unhealthy" in lines, out)
1548             self.failUnless(" 2 repairs attempted, 2 successful, 0 failed"
1549                             in lines, out)
1550             self.failUnless(" post-repair: 4 healthy, 0 unhealthy" in lines,out)
1551         d.addCallback(_check6)
1552
1553         # now add a subdir, and a file below that, then make the subdir
1554         # unrecoverable
1555
1556         d.addCallback(lambda ign: self.rootnode.create_subdirectory(u"subdir"))
1557         d.addCallback(_stash_uri, "subdir")
1558         d.addCallback(lambda fn:
1559                       fn.add_file(u"subfile", upload.Data(DATA+"2", "")))
1560         d.addCallback(lambda ign:
1561                       self.delete_shares_numbered(self.uris["subdir"],
1562                                                   range(10)))
1563
1564         # root
1565         # root/good
1566         # root/small
1567         # root/mutable
1568         # root/subdir [unrecoverable: 0 shares]
1569         # root/subfile
1570
1571         d.addCallback(lambda ign: self.do_cli("manifest", self.rooturi))
1572         def _manifest_failed((rc, out, err)):
1573             self.failIfEqual(rc, 0)
1574             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1575             # the fatal directory should still show up, as the last line
1576             self.failUnlessIn(" subdir\n", out)
1577         d.addCallback(_manifest_failed)
1578
1579         d.addCallback(lambda ign: self.do_cli("deep-check", self.rooturi))
1580         def _deep_check_failed((rc, out, err)):
1581             self.failIfEqual(rc, 0)
1582             self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1583             # we want to make sure that the error indication is the last
1584             # thing that gets emitted
1585             self.failIf("done:" in out, out)
1586         d.addCallback(_deep_check_failed)
1587
1588         # this test is disabled until the deep-repair response to an
1589         # unrepairable directory is fixed. The failure-to-repair should not
1590         # throw an exception, but the failure-to-traverse that follows
1591         # should throw UnrecoverableFileError.
1592
1593         #d.addCallback(lambda ign:
1594         #              self.do_cli("deep-check", "--repair", self.rooturi))
1595         #def _deep_check_repair_failed((rc, out, err)):
1596         #    self.failIfEqual(rc, 0)
1597         #    print err
1598         #    self.failUnlessIn("ERROR: UnrecoverableFileError", err)
1599         #    self.failIf("done:" in out, out)
1600         #d.addCallback(_deep_check_repair_failed)
1601
1602         return d
1603
1604 class Errors(GridTestMixin, CLITestMixin, unittest.TestCase):
1605     def test_get(self):
1606         self.basedir = "cli/Errors/get"
1607         self.set_up_grid()
1608         c0 = self.g.clients[0]
1609         self.fileurls = {}
1610         DATA = "data" * 100
1611         d = c0.upload(upload.Data(DATA, convergence=""))
1612         def _stash_bad(ur):
1613             self.uri_1share = ur.uri
1614             self.delete_shares_numbered(ur.uri, range(1,10))
1615         d.addCallback(_stash_bad)
1616
1617         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share))
1618         def _check1((rc, out, err)):
1619             self.failIfEqual(rc, 0)
1620             self.failUnless("410 Gone" in err, err)
1621             self.failUnlessIn("NotEnoughSharesError: ", err)
1622             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
1623         d.addCallback(_check1)
1624
1625         targetf = os.path.join(self.basedir, "output")
1626         d.addCallback(lambda ign: self.do_cli("get", self.uri_1share, targetf))
1627         def _check2((rc, out, err)):
1628             self.failIfEqual(rc, 0)
1629             self.failUnless("410 Gone" in err, err)
1630             self.failUnlessIn("NotEnoughSharesError: ", err)
1631             self.failUnlessIn("Failed to get enough shareholders: have 1, need 3", err)
1632             self.failIf(os.path.exists(targetf))
1633         d.addCallback(_check2)
1634
1635         return d
1636
1637 class Stats(GridTestMixin, CLITestMixin, unittest.TestCase):
1638     def test_empty_directory(self):
1639         self.basedir = "cli/Stats/empty_directory"
1640         self.set_up_grid()
1641         c0 = self.g.clients[0]
1642         self.fileurls = {}
1643         d = c0.create_dirnode()
1644         def _stash_root(n):
1645             self.rootnode = n
1646             self.rooturi = n.get_uri()
1647         d.addCallback(_stash_root)
1648
1649         # make sure we can get stats on an empty directory too
1650         d.addCallback(lambda ign: self.do_cli("stats", self.rooturi))
1651         def _check_stats((rc, out, err)):
1652             self.failUnlessEqual(err, "")
1653             self.failUnlessEqual(rc, 0)
1654             lines = out.splitlines()
1655             self.failUnlessIn(" count-immutable-files: 0", lines)
1656             self.failUnlessIn("   count-mutable-files: 0", lines)
1657             self.failUnlessIn("   count-literal-files: 0", lines)
1658             self.failUnlessIn("     count-directories: 1", lines)
1659             self.failUnlessIn("  size-immutable-files: 0", lines)
1660             self.failIfIn("Size Histogram:", lines)
1661         d.addCallback(_check_stats)
1662
1663         return d