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