2 from twisted.trial import unittest
3 from twisted.application import service
6 from allmydata.node import OldConfigError, OldConfigOptionError, MissingConfigEntry
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 @mock.patch('twisted.python.log.msg')
34 def test_error_on_old_config_files(self, mock_log_msg):
35 basedir = "test_client.Basic.test_error_on_old_config_files"
37 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
41 "reserved_space = bogus\n")
42 fileutil.write(os.path.join(basedir, "introducer.furl"), "")
43 fileutil.write(os.path.join(basedir, "no_storage"), "")
44 fileutil.write(os.path.join(basedir, "readonly_storage"), "")
45 fileutil.write(os.path.join(basedir, "debug_discard_storage"), "")
47 e = self.failUnlessRaises(OldConfigError, client.Client, basedir)
48 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "introducer.furl")), e.args[0])
49 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "no_storage")), e.args[0])
50 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "readonly_storage")), e.args[0])
51 self.failUnlessIn(os.path.abspath(os.path.join(basedir, "debug_discard_storage")), e.args[0])
53 for oldfile in ['introducer.furl', 'no_storage', 'readonly_storage',
54 'debug_discard_storage']:
55 logged = [ m for m in mock_log_msg.call_args_list if
56 ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
57 self.failUnless(logged, (oldfile, mock_log_msg.call_args_list))
60 'nickname', 'webport', 'keepalive_timeout', 'log_gatherer.furl',
61 'disconnect_timeout', 'advertised_ip_addresses', 'helper.furl',
62 'key_generator.furl', 'stats_gatherer.furl', 'sizelimit',
64 logged = [ m for m in mock_log_msg.call_args_list if
65 ("Found pre-Tahoe-LAFS-v1.3 configuration file" in str(m[0][0]) and oldfile in str(m[0][0])) ]
66 self.failIf(logged, oldfile)
68 def test_secrets(self):
69 basedir = "test_client.Basic.test_secrets"
71 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
73 c = client.Client(basedir)
74 secret_fname = os.path.join(basedir, "private", "secret")
75 self.failUnless(os.path.exists(secret_fname), secret_fname)
76 renew_secret = c.get_renewal_secret()
77 self.failUnless(base32.b2a(renew_secret))
78 cancel_secret = c.get_cancel_secret()
79 self.failUnless(base32.b2a(cancel_secret))
81 def test_reserved_1(self):
82 basedir = "client.Basic.test_reserved_1"
84 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
87 "enabled = true\n" + \
88 "reserved_space = 1000\n")
89 c = client.Client(basedir)
90 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 1000)
92 def test_reserved_2(self):
93 basedir = "client.Basic.test_reserved_2"
95 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
98 "enabled = true\n" + \
99 "reserved_space = 10K\n")
100 c = client.Client(basedir)
101 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 10*1000)
103 def test_reserved_3(self):
104 basedir = "client.Basic.test_reserved_3"
106 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
109 "enabled = true\n" + \
110 "reserved_space = 5mB\n")
111 c = client.Client(basedir)
112 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
115 def test_reserved_4(self):
116 basedir = "client.Basic.test_reserved_4"
118 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
121 "enabled = true\n" + \
122 "reserved_space = 78Gb\n")
123 c = client.Client(basedir)
124 self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
127 def test_reserved_bad(self):
128 basedir = "client.Basic.test_reserved_bad"
130 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
133 "enabled = true\n" + \
134 "reserved_space = bogus\n")
135 self.failUnlessRaises(ValueError, client.Client, basedir)
137 def _permute(self, sb, key):
138 return [ s.get_longname() for s in sb.get_servers_for_psi(key) ]
140 def test_permute(self):
141 sb = StorageFarmBroker(None, True)
142 for k in ["%d" % i for i in range(5)]:
143 ann = {"anonymous-storage-FURL": "pb://abcde@nowhere/fake",
144 "permutation-seed-base32": base32.b2a(k) }
145 sb.test_add_rref(k, "rref", ann)
147 self.failUnlessReallyEqual(self._permute(sb, "one"), ['3','1','0','4','2'])
148 self.failUnlessReallyEqual(self._permute(sb, "two"), ['0','4','2','1','3'])
150 self.failUnlessReallyEqual(self._permute(sb, "one"), [])
152 def test_versions(self):
153 basedir = "test_client.Basic.test_versions"
155 fileutil.write(os.path.join(basedir, "tahoe.cfg"), \
159 c = client.Client(basedir)
160 ss = c.getServiceNamed("storage")
161 verdict = ss.remote_get_version()
162 self.failUnlessReallyEqual(verdict["application-version"],
163 str(allmydata.__full_version__))
164 self.failIfEqual(str(allmydata.__version__), "unknown")
165 self.failUnless("." in str(allmydata.__full_version__),
166 "non-numeric version in '%s'" % allmydata.__version__)
167 all_versions = allmydata.get_package_versions_string()
168 self.failUnless(allmydata.__appname__ in all_versions)
170 stats = c.get_stats()
171 self.failUnless("node.uptime" in stats)
172 self.failUnless(isinstance(stats["node.uptime"], float))
174 def test_helper_furl(self):
175 basedir = "test_client.Basic.test_helper_furl"
178 def _check(config, expected_furl):
179 fileutil.write(os.path.join(basedir, "tahoe.cfg"),
181 c = client.Client(basedir)
182 uploader = c.getServiceNamed("uploader")
183 furl, connected = uploader.get_helper_info()
184 self.failUnlessEqual(furl, expected_furl)
187 _check("helper.furl =\n", None)
188 _check("helper.furl = \n", None)
189 _check("helper.furl = None", None)
190 _check("helper.furl = pb://blah\n", "pb://blah")
192 @mock.patch('allmydata.util.log.msg')
193 @mock.patch('allmydata.frontends.drop_upload.DropUploader')
194 def test_create_drop_uploader(self, mock_drop_uploader, mock_log_msg):
195 class MockDropUploader(service.MultiService):
198 def __init__(self, client, upload_dircap, local_dir_utf8, inotify=None):
199 service.MultiService.__init__(self)
201 self.upload_dircap = upload_dircap
202 self.local_dir_utf8 = local_dir_utf8
203 self.inotify = inotify
205 mock_drop_uploader.side_effect = MockDropUploader
207 upload_dircap = "URI:DIR2:blah"
208 local_dir_utf8 = u"loc\u0101l_dir".encode('utf-8')
209 config = (BASECONFIG +
211 "enabled = false\n" +
215 basedir1 = "test_client.Basic.test_create_drop_uploader1"
217 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
218 config + "local.directory = " + local_dir_utf8 + "\n")
219 self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
221 fileutil.write(os.path.join(basedir1, "tahoe.cfg"), config)
222 fileutil.write(os.path.join(basedir1, "private", "drop_upload_dircap"), "URI:DIR2:blah")
223 self.failUnlessRaises(MissingConfigEntry, client.Client, basedir1)
225 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
226 config + "upload.dircap = " + upload_dircap + "\n")
227 self.failUnlessRaises(OldConfigOptionError, client.Client, basedir1)
229 fileutil.write(os.path.join(basedir1, "tahoe.cfg"),
230 config + "local.directory = " + local_dir_utf8 + "\n")
231 c1 = client.Client(basedir1)
232 uploader = c1.getServiceNamed('drop-upload')
233 self.failUnless(isinstance(uploader, MockDropUploader), uploader)
234 self.failUnlessReallyEqual(uploader.client, c1)
235 self.failUnlessReallyEqual(uploader.upload_dircap, upload_dircap)
236 self.failUnlessReallyEqual(uploader.local_dir_utf8, local_dir_utf8)
237 self.failUnless(uploader.inotify is None, uploader.inotify)
238 self.failUnless(uploader.running)
240 class Boom(Exception):
242 mock_drop_uploader.side_effect = Boom()
244 basedir2 = "test_client.Basic.test_create_drop_uploader2"
246 os.mkdir(os.path.join(basedir2, "private"))
247 fileutil.write(os.path.join(basedir2, "tahoe.cfg"),
251 "local.directory = " + local_dir_utf8 + "\n")
252 fileutil.write(os.path.join(basedir2, "private", "drop_upload_dircap"), "URI:DIR2:blah")
253 c2 = client.Client(basedir2)
254 self.failUnlessRaises(KeyError, c2.getServiceNamed, 'drop-upload')
255 self.failUnless([True for arg in mock_log_msg.call_args_list if "Boom" in repr(arg)],
256 mock_log_msg.call_args_list)
259 def flush_but_dont_ignore(res):
260 d = flushEventualQueue()
266 class Run(unittest.TestCase, testutil.StallMixin):
269 self.sparent = service.MultiService()
270 self.sparent.startService()
272 d = self.sparent.stopService()
273 d.addBoth(flush_but_dont_ignore)
276 def test_loadable(self):
277 basedir = "test_client.Run.test_loadable"
279 dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
280 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
281 fileutil.write(os.path.join(basedir, "suicide_prevention_hotline"), "")
282 client.Client(basedir)
284 def test_reloadable(self):
285 basedir = "test_client.Run.test_reloadable"
287 dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
288 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG_I % dummy)
289 c1 = client.Client(basedir)
290 c1.setServiceParent(self.sparent)
292 # delay to let the service start up completely. I'm not entirely sure
294 d = self.stall(delay=2.0)
295 d.addCallback(lambda res: c1.disownServiceParent())
296 # the cygwin buildslave seems to need more time to let the old
297 # service completely shut down. When delay=0.1, I saw this test fail,
298 # probably due to the logport trying to reclaim the old socket
299 # number. This suggests that either we're dropping a Deferred
300 # somewhere in the shutdown sequence, or that cygwin is just cranky.
301 d.addCallback(self.stall, delay=2.0)
303 # TODO: pause for slightly over one second, to let
304 # Client._check_hotline poll the file once. That will exercise
305 # another few lines. Then add another test in which we don't
306 # update the file at all, and watch to see the node shutdown. (to
307 # do this, use a modified node which overrides Node.shutdown(),
308 # also change _check_hotline to use it instead of a raw
309 # reactor.stop, also instrument the shutdown event in an
310 # attribute that we can check)
311 c2 = client.Client(basedir)
312 c2.setServiceParent(self.sparent)
313 return c2.disownServiceParent()
314 d.addCallback(_restart)
317 class NodeMaker(testutil.ReallyEqualMixin, unittest.TestCase):
318 def test_maker(self):
319 basedir = "client/NodeMaker/maker"
320 fileutil.make_dirs(basedir)
321 fileutil.write(os.path.join(basedir, "tahoe.cfg"), BASECONFIG)
322 c = client.Client(basedir)
324 n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
325 self.failUnless(IFilesystemNode.providedBy(n))
326 self.failUnless(IFileNode.providedBy(n))
327 self.failUnless(IImmutableFileNode.providedBy(n))
328 self.failIf(IMutableFileNode.providedBy(n))
329 self.failIf(IDirectoryNode.providedBy(n))
330 self.failUnless(n.is_readonly())
331 self.failIf(n.is_mutable())
333 # Testing #1679. There was a bug that would occur when downloader was
334 # downloading the same readcap more than once concurrently, so the
335 # filenode object was cached, and there was a failure from one of the
336 # servers in one of the download attempts. No subsequent download
337 # attempt would attempt to use that server again, which would lead to
338 # the file being undownloadable until the gateway was restarted. The
339 # current fix for this (hopefully to be superceded by a better fix
340 # eventually) is to prevent re-use of filenodes, so the NodeMaker is
341 # hereby required *not* to cache and re-use filenodes for CHKs.
342 other_n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
343 self.failIf(n is other_n, (n, other_n))
345 n = c.create_node_from_uri("URI:LIT:n5xgk")
346 self.failUnless(IFilesystemNode.providedBy(n))
347 self.failUnless(IFileNode.providedBy(n))
348 self.failUnless(IImmutableFileNode.providedBy(n))
349 self.failIf(IMutableFileNode.providedBy(n))
350 self.failIf(IDirectoryNode.providedBy(n))
351 self.failUnless(n.is_readonly())
352 self.failIf(n.is_mutable())
354 n = c.create_node_from_uri("URI:SSK:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
355 self.failUnless(IFilesystemNode.providedBy(n))
356 self.failUnless(IFileNode.providedBy(n))
357 self.failIf(IImmutableFileNode.providedBy(n))
358 self.failUnless(IMutableFileNode.providedBy(n))
359 self.failIf(IDirectoryNode.providedBy(n))
360 self.failIf(n.is_readonly())
361 self.failUnless(n.is_mutable())
363 n = c.create_node_from_uri("URI:SSK-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
364 self.failUnless(IFilesystemNode.providedBy(n))
365 self.failUnless(IFileNode.providedBy(n))
366 self.failIf(IImmutableFileNode.providedBy(n))
367 self.failUnless(IMutableFileNode.providedBy(n))
368 self.failIf(IDirectoryNode.providedBy(n))
369 self.failUnless(n.is_readonly())
370 self.failUnless(n.is_mutable())
372 n = c.create_node_from_uri("URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
373 self.failUnless(IFilesystemNode.providedBy(n))
374 self.failIf(IFileNode.providedBy(n))
375 self.failIf(IImmutableFileNode.providedBy(n))
376 self.failIf(IMutableFileNode.providedBy(n))
377 self.failUnless(IDirectoryNode.providedBy(n))
378 self.failIf(n.is_readonly())
379 self.failUnless(n.is_mutable())
381 n = c.create_node_from_uri("URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
382 self.failUnless(IFilesystemNode.providedBy(n))
383 self.failIf(IFileNode.providedBy(n))
384 self.failIf(IImmutableFileNode.providedBy(n))
385 self.failIf(IMutableFileNode.providedBy(n))
386 self.failUnless(IDirectoryNode.providedBy(n))
387 self.failUnless(n.is_readonly())
388 self.failUnless(n.is_mutable())
390 unknown_rw = "lafs://from_the_future"
391 unknown_ro = "lafs://readonly_from_the_future"
392 n = c.create_node_from_uri(unknown_rw, unknown_ro)
393 self.failUnless(IFilesystemNode.providedBy(n))
394 self.failIf(IFileNode.providedBy(n))
395 self.failIf(IImmutableFileNode.providedBy(n))
396 self.failIf(IMutableFileNode.providedBy(n))
397 self.failIf(IDirectoryNode.providedBy(n))
398 self.failUnless(n.is_unknown())
399 self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
400 self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
401 self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)
403 # Note: it isn't that we *intend* to deploy non-ASCII caps in
404 # the future, it is that we want to make sure older Tahoe-LAFS
405 # versions wouldn't choke on them if we were to do so. See
406 # #1051 and wiki:NewCapDesign for details.
407 unknown_rw = u"lafs://from_the_future_rw_\u263A".encode('utf-8')
408 unknown_ro = u"lafs://readonly_from_the_future_ro_\u263A".encode('utf-8')
409 n = c.create_node_from_uri(unknown_rw, unknown_ro)
410 self.failUnless(IFilesystemNode.providedBy(n))
411 self.failIf(IFileNode.providedBy(n))
412 self.failIf(IImmutableFileNode.providedBy(n))
413 self.failIf(IMutableFileNode.providedBy(n))
414 self.failIf(IDirectoryNode.providedBy(n))
415 self.failUnless(n.is_unknown())
416 self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
417 self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
418 self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)