2 from twisted.trial import unittest
3 from twisted.application import service
6 from allmydata.node import Node, OldConfigError, OldConfigOptionError, MissingConfigEntry, UnescapedHashError
7 from allmydata import client
8 from allmydata.storage_client import StorageFarmBroker
9 from allmydata.util import base32, fileutil
10 from allmydata.interfaces import IFilesystemNode, IFileNode, \
11 IImmutableFileNode, IMutableFileNode, IDirectoryNode
12 from foolscap.api import flushEventualQueue
13 import allmydata.test.common_util as testutil
17 BASECONFIG = ("[client]\n"
18 "introducer.furl = \n"
21 BASECONFIG_I = ("[client]\n"
22 "introducer.furl = %s\n"
25 class Basic(testutil.ReallyEqualMixin, unittest.TestCase):
26 def test_loadable(self):
27 basedir = "test_client.Basic.test_loadable"
29 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
31 client.Client(basedir)
33 def test_comment(self):
34 should_fail = [r"test#test", r"#testtest", r"test\\#test"]
35 should_not_fail = [r"test\#test", r"test\\\#test", r"testtest"]
37 basedir = "test_client.Basic.test_comment"
41 config = ("[client]\n"
42 "introducer.furl = %s\n" % s)
43 fileutil.write(os.path.join(basedir, "tahoe.cfg"), config)
46 self.failUnless(Node._contains_unescaped_hash(s))
48 self.failUnlessRaises(UnescapedHashError, client.Client, basedir)
50 for s in should_not_fail:
51 self.failIf(Node._contains_unescaped_hash(s))
53 client.Client(basedir)
56 @mock.patch('twisted.python.log.msg')
57 def test_error_on_old_config_files(self, mock_log_msg):
58 basedir = "test_client.Basic.test_error_on_old_config_files"
60 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
64 "reserved_space = bogus\n")
65 fileutil.write(os.path.join(basedir, "introducer.furl"), "")
66 fileutil.write(os.path.join(basedir, "no_storage"), "")
67 fileutil.write(os.path.join(basedir, "readonly_storage"), "")
68 fileutil.write(os.path.join(basedir, "debug_discard_storage"), "")
70 e = self.failUnlessRaises(OldConfigError, client.Client, basedir)
71 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "introducer.furl")), e.args[0])
72 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "no_storage")), e.args[0])
73 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "readonly_storage")), e.args[0])
74 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "debug_discard_storage")), e.args[0])
76 for oldfile in ['introducer.furl', 'no_storage', 'readonly_storage',
77 'debug_discard_storage']:
78 logged = [ m for m in mock_log_msg.call_args_list if
79 ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
80 self.failUnless(logged, (oldfile, mock_log_msg.call_args_list))
83 'nickname', 'webport', 'keepalive_timeout', 'log_gatherer.furl',
84 'disconnect_timeout', 'advertised_ip_addresses', 'helper.furl',
85 'key_generator.furl', 'stats_gatherer.furl', 'sizelimit',
87 logged = [ m for m in mock_log_msg.call_args_list if
88 ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
89 self.failIf(logged, oldfile)
91 def test_secrets(self):
92 basedir = "test_client.Basic.test_secrets"
94 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
96 c = client.Client(basedir)
97 secret_fname = os.path.join(basedir, "private", "secret")
98 self.failUnless(os.path.exists(secret_fname), secret_fname)
99 renew_secret = c.get_renewal_secret()
100 self.failUnless(base32.b2a(renew_secret))
101 cancel_secret = c.get_cancel_secret()
102 self.failUnless(base32.b2a(cancel_secret))
104 def test_nodekey_yes_storage(self):
105 basedir = "test_client.Basic.test_nodekey_yes_storage"
107 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
109 c = client.Client(basedir)
110 self.failUnless(c.get_long_nodeid().startswith("v0-"))
112 def test_nodekey_no_storage(self):
113 basedir = "test_client.Basic.test_nodekey_no_storage"
115 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
116 BASECONFIG + "[storage]\n" + "enabled = false\n")
117 c = client.Client(basedir)
118 self.failUnless(c.get_long_nodeid().startswith("v0-"))
120 def test_reserved_1(self):
121 basedir = "client.Basic.test_reserved_1"
123 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
126 "enabled = true\n" + \
127 "reserved_space = 1000\n")
128 c = client.Client(basedir)
129 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 1000)
131 def test_reserved_2(self):
132 basedir = "client.Basic.test_reserved_2"
134 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
137 "enabled = true\n" + \
138 "reserved_space = 10K\n")
139 c = client.Client(basedir)
140 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 10*1000)
142 def test_reserved_3(self):
143 basedir = "client.Basic.test_reserved_3"
145 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
148 "enabled = true\n" + \
149 "reserved_space = 5mB\n")
150 c = client.Client(basedir)
151 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
154 def test_reserved_4(self):
155 basedir = "client.Basic.test_reserved_4"
157 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
160 "enabled = true\n" + \
161 "reserved_space = 78Gb\n")
162 c = client.Client(basedir)
163 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
166 def test_reserved_bad(self):
167 basedir = "client.Basic.test_reserved_bad"
169 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
172 "enabled = true\n" + \
173 "reserved_space = bogus\n")
174 self.failUnlessRaises(ValueError, client.Client, basedir)
176 def _permute(self, sb, key):
177 return [ s.get_longname() for s in sb.get_servers_for_psi(key) ]
179 def test_permute(self):
180 sb = StorageFarmBroker(None, True)
181 for k in ["%d" % i for i in range(5)]:
182 ann = {"anonymous-storage-FURL": "pb://abcde@nowhere/fake",
183 "permutation-seed-base32": base32.b2a(k) }
184 sb.test_add_rref(k, "rref", ann)
186 self.failUnlessReallyEqual(self._permute(sb, "one"), ['3','1','0','4','2'])
187 self.failUnlessReallyEqual(self._permute(sb, "two"), ['0','4','2','1','3'])
189 self.failUnlessReallyEqual(self._permute(sb, "one"), [])
191 def test_versions(self):
192 basedir = "test_client.Basic.test_versions"
194 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
198 c = client.Client(basedir)
199 ss = c.getServiceNamed("storage")
200 verdict = ss.remote_get_version()
201 self.failUnlessReallyEqual(verdict["application-version"],
202 str(allmydata.__full_version__))
203 self.failIfEqual(str(allmydata.__version__), "unknown")
204 self.failUnless("." in str(allmydata.__full_version__),
205 "non-numeric version in '%s'" % allmydata.__version__)
206 all_versions = allmydata.get_package_versions_string()
207 self.failUnless(allmydata.__appname__ in all_versions)
209 stats = c.get_stats()
210 self.failUnless("node.uptime" in stats)
211 self.failUnless(isinstance(stats["node.uptime"], float))
213 def test_helper_furl(self):
214 basedir = "test_client.Basic.test_helper_furl"
217 def _check(config, expected_furl):
218 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
220 c = client.Client(basedir)
221 uploader = c.getServiceNamed("uploader")
222 furl, connected = uploader.get_helper_info()
223 self.failUnlessEqual(furl, expected_furl)
226 _check("helper.furl =\n", None)
227 _check("helper.furl = \n", None)
228 _check("helper.furl = None", None)
229 _check("helper.furl = pb://blah\n", "pb://blah")
231 @mock.patch('allmydata.util.log.msg')
232 @mock.patch('allmydata.frontends.drop_upload.DropUploader')
233 def test_create_drop_uploader(self, mock_drop_uploader, mock_log_msg):
234 class MockDropUploader(service.MultiService):
237 def __init__(self, client, upload_dircap, local_dir_utf8, inotify=None):
238 service.MultiService.__init__(self)
240 self.upload_dircap = upload_dircap
241 self.local_dir_utf8 = local_dir_utf8
242 self.inotify = inotify
244 mock_drop_uploader.side_effect = MockDropUploader
246 upload_dircap = "URI:DIR2:blah"
247 local_dir_utf8 = u"loc\u0101l_dir".encode('utf-8')
248 config = (BASECONFIG +
250 "enabled = false\n" +
254 basedir1 = "test_client.Basic.test_create_drop_uploader1"
256 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
257 config + "local.directory = " + local_dir_utf8 + "\n")
258 self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
260 fileutil.write(os.path.join(basedir1, "tahoe.cfg"), config)
261 fileutil.write(os.path.join(basedir1, "private", "drop_upload_dircap"), "URI:DIR2:blah")
262 self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
264 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
265 config + "upload.dircap = " + upload_dircap + "\n")
266 self.failUnlessRaises(OldConfigOptionError, client.Client, basedir1)
268 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
269 config + "local.directory = " + local_dir_utf8 + "\n")
270 c1 = client.Client(basedir1)
271 uploader = c1.getServiceNamed('drop-upload')
272 self.failUnless(isinstance(uploader, MockDropUploader), uploader)
273 self.failUnlessReallyEqual(uploader.client, c1)
274 self.failUnlessReallyEqual(uploader.upload_dircap, upload_dircap)
275 self.failUnlessReallyEqual(uploader.local_dir_utf8, local_dir_utf8)
276 self.failUnless(uploader.inotify is None, uploader.inotify)
277 self.failUnless(uploader.running)
279 class Boom(Exception):
281 mock_drop_uploader.side_effect = Boom()
283 basedir2 = "test_client.Basic.test_create_drop_uploader2"
285 os.mkdir(os.path.join(basedir2, "private"))
286 fileutil.write(os.path.join(basedir2, "tahoe.cfg"),
290 "local.directory = " + local_dir_utf8 + "\n")
291 fileutil.write(os.path.join(basedir2, "private", "drop_upload_dircap"), "URI:DIR2:blah")
292 c2 = client.Client(basedir2)
293 self.failUnlessRaises(KeyError, c2.getServiceNamed, 'drop-upload')
294 self.failUnless([True for arg in mock_log_msg.call_args_list if "Boom" in repr(arg)],
295 mock_log_msg.call_args_list)
298 def flush_but_dont_ignore(res):
299 d = flushEventualQueue()
305 class Run(unittest.TestCase, testutil.StallMixin):
308 self.sparent = service.MultiService()
309 self.sparent.startService()
311 d = self.sparent.stopService()
312 d.addBoth(flush_but_dont_ignore)
315 def test_loadable(self):
316 basedir = "test_client.Run.test_loadable"
318 dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
319 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
320 fileutil.write(os.path.join(basedir, "suicide_prevention_hotline"), "")
321 client.Client(basedir)
323 def test_reloadable(self):
324 basedir = "test_client.Run.test_reloadable"
326 dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
327 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
328 c1 = client.Client(basedir)
329 c1.setServiceParent(self.sparent)
331 # delay to let the service start up completely. I'm not entirely sure
333 d = self.stall(delay=2.0)
334 d.addCallback(lambda res: c1.disownServiceParent())
335 # the cygwin buildslave seems to need more time to let the old
336 # service completely shut down. When delay=0.1, I saw this test fail,
337 # probably due to the logport trying to reclaim the old socket
338 # number. This suggests that either we're dropping a Deferred
339 # somewhere in the shutdown sequence, or that cygwin is just cranky.
340 d.addCallback(self.stall, delay=2.0)
342 # TODO: pause for slightly over one second, to let
343 # Client._check_hotline poll the file once. That will exercise
344 # another few lines. Then add another test in which we don't
345 # update the file at all, and watch to see the node shutdown. (to
346 # do this, use a modified node which overrides Node.shutdown(),
347 # also change _check_hotline to use it instead of a raw
348 # reactor.stop, also instrument the shutdown event in an
349 # attribute that we can check)
350 c2 = client.Client(basedir)
351 c2.setServiceParent(self.sparent)
352 return c2.disownServiceParent()
353 d.addCallback(_restart)
356 class NodeMaker(testutil.ReallyEqualMixin, unittest.TestCase):
357 def test_maker(self):
358 basedir = "client/NodeMaker/maker"
359 fileutil.make_dirs(basedir)
360 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG)
361 c = client.Client(basedir)
363 n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
364 self.failUnless(IFilesystemNode.providedBy(n))
365 self.failUnless(IFileNode.providedBy(n))
366 self.failUnless(IImmutableFileNode.providedBy(n))
367 self.failIf(IMutableFileNode.providedBy(n))
368 self.failIf(IDirectoryNode.providedBy(n))
369 self.failUnless(n.is_readonly())
370 self.failIf(n.is_mutable())
372 # Testing #1679. There was a bug that would occur when downloader was
373 # downloading the same readcap more than once concurrently, so the
374 # filenode object was cached, and there was a failure from one of the
375 # servers in one of the download attempts. No subsequent download
376 # attempt would attempt to use that server again, which would lead to
377 # the file being undownloadable until the gateway was restarted. The
378 # current fix for this (hopefully to be superceded by a better fix
379 # eventually) is to prevent re-use of filenodes, so the NodeMaker is
380 # hereby required *not* to cache and re-use filenodes for CHKs.
381 other_n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
382 self.failIf(n is other_n, (n, other_n))
384 n = c.create_node_from_uri("URI:LIT:n5xgk")
385 self.failUnless(IFilesystemNode.providedBy(n))
386 self.failUnless(IFileNode.providedBy(n))
387 self.failUnless(IImmutableFileNode.providedBy(n))
388 self.failIf(IMutableFileNode.providedBy(n))
389 self.failIf(IDirectoryNode.providedBy(n))
390 self.failUnless(n.is_readonly())
391 self.failIf(n.is_mutable())
393 n = c.create_node_from_uri("URI:SSK:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
394 self.failUnless(IFilesystemNode.providedBy(n))
395 self.failUnless(IFileNode.providedBy(n))
396 self.failIf(IImmutableFileNode.providedBy(n))
397 self.failUnless(IMutableFileNode.providedBy(n))
398 self.failIf(IDirectoryNode.providedBy(n))
399 self.failIf(n.is_readonly())
400 self.failUnless(n.is_mutable())
402 n = c.create_node_from_uri("URI:SSK-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
403 self.failUnless(IFilesystemNode.providedBy(n))
404 self.failUnless(IFileNode.providedBy(n))
405 self.failIf(IImmutableFileNode.providedBy(n))
406 self.failUnless(IMutableFileNode.providedBy(n))
407 self.failIf(IDirectoryNode.providedBy(n))
408 self.failUnless(n.is_readonly())
409 self.failUnless(n.is_mutable())
411 n = c.create_node_from_uri("URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
412 self.failUnless(IFilesystemNode.providedBy(n))
413 self.failIf(IFileNode.providedBy(n))
414 self.failIf(IImmutableFileNode.providedBy(n))
415 self.failIf(IMutableFileNode.providedBy(n))
416 self.failUnless(IDirectoryNode.providedBy(n))
417 self.failIf(n.is_readonly())
418 self.failUnless(n.is_mutable())
420 n = c.create_node_from_uri("URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
421 self.failUnless(IFilesystemNode.providedBy(n))
422 self.failIf(IFileNode.providedBy(n))
423 self.failIf(IImmutableFileNode.providedBy(n))
424 self.failIf(IMutableFileNode.providedBy(n))
425 self.failUnless(IDirectoryNode.providedBy(n))
426 self.failUnless(n.is_readonly())
427 self.failUnless(n.is_mutable())
429 unknown_rw = "lafs://from_the_future"
430 unknown_ro = "lafs://readonly_from_the_future"
431 n = c.create_node_from_uri(unknown_rw, unknown_ro)
432 self.failUnless(IFilesystemNode.providedBy(n))
433 self.failIf(IFileNode.providedBy(n))
434 self.failIf(IImmutableFileNode.providedBy(n))
435 self.failIf(IMutableFileNode.providedBy(n))
436 self.failIf(IDirectoryNode.providedBy(n))
437 self.failUnless(n.is_unknown())
438 self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
439 self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
440 self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)
442 # Note: it isn't that we *intend* to deploy non-ASCII caps in
443 # the future, it is that we want to make sure older Tahoe-LAFS
444 # versions wouldn't choke on them if we were to do so. See
445 # #1051 and wiki:NewCapDesign for details.
446 unknown_rw = u"lafs://from_the_future_rw_\u263A".encode('utf-8')
447 unknown_ro = u"lafs://readonly_from_the_future_ro_\u263A".encode('utf-8')
448 n = c.create_node_from_uri(unknown_rw, unknown_ro)
449 self.failUnless(IFilesystemNode.providedBy(n))
450 self.failIf(IFileNode.providedBy(n))
451 self.failIf(IImmutableFileNode.providedBy(n))
452 self.failIf(IMutableFileNode.providedBy(n))
453 self.failIf(IDirectoryNode.providedBy(n))
454 self.failUnless(n.is_unknown())
455 self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
456 self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
457 self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)