src/allmydata/test/test_client.py

   1
   2 import os
   3 from twisted.trial import unittest
   4 from twisted.application import service
   5 from twisted.python import log
   6
   7 import allmydata
   8 from allmydata import client
   9 from allmydata.storage_client import StorageFarmBroker
  10 from allmydata.introducer.client import IntroducerClient
  11 from allmydata.util import base32, fileutil
  12 from allmydata.interfaces import IFilesystemNode, IFileNode, \
  13      IImmutableFileNode, IMutableFileNode, IDirectoryNode
  14 from foolscap.api import flushEventualQueue
  15 import allmydata.test.common_util as testutil
  16
  17 class FakeIntroducerClient(IntroducerClient):
  18     def __init__(self):
  19         self._connections = set()
  20     def add_peer(self, nodeid):
  21         entry = (nodeid, "storage", "rref")
  22         self._connections.add(entry)
  23     def remove_all_peers(self):
  24         self._connections.clear()
  25
  26 BASECONFIG = ("[client]\n"
  27               "introducer.furl = \n"
  28               )
  29
  30 class Basic(testutil.ReallyEqualMixin, unittest.TestCase):
  31     def test_loadable(self):
  32         basedir = "test_client.Basic.test_loadable"
  33         os.mkdir(basedir)
  34         open(os.path.join(basedir, "introducer.furl"), "w").write("")
  35         client.Client(basedir)
  36
  37     def test_loadable_old_config_bits(self):
  38         basedir = "test_client.Basic.test_loadable_old_config_bits"
  39         os.mkdir(basedir)
  40         open(os.path.join(basedir, "introducer.furl"), "w").write("")
  41         open(os.path.join(basedir, "no_storage"), "w").write("")
  42         open(os.path.join(basedir, "readonly_storage"), "w").write("")
  43         open(os.path.join(basedir, "debug_discard_storage"), "w").write("")
  44         c = client.Client(basedir)
  45         try:
  46             c.getServiceNamed("storage")
  47             self.fail("that was supposed to fail")
  48         except KeyError:
  49             pass
  50
  51     def test_loadable_old_storage_config_bits(self):
  52         basedir = "test_client.Basic.test_loadable_old_storage_config_bits"
  53         os.mkdir(basedir)
  54         open(os.path.join(basedir, "introducer.furl"), "w").write("")
  55         open(os.path.join(basedir, "readonly_storage"), "w").write("")
  56         open(os.path.join(basedir, "debug_discard_storage"), "w").write("")
  57         c = client.Client(basedir)
  58         s = c.getServiceNamed("storage")
  59         self.failUnless(s.no_storage)
  60         self.failUnless(s.readonly_storage)
  61
  62     def test_secrets(self):
  63         basedir = "test_client.Basic.test_secrets"
  64         os.mkdir(basedir)
  65         open(os.path.join(basedir, "introducer.furl"), "w").write("")
  66         c = client.Client(basedir)
  67         secret_fname = os.path.join(basedir, "private", "secret")
  68         self.failUnless(os.path.exists(secret_fname), secret_fname)
  69         renew_secret = c.get_renewal_secret()
  70         self.failUnless(base32.b2a(renew_secret))
  71         cancel_secret = c.get_cancel_secret()
  72         self.failUnless(base32.b2a(cancel_secret))
  73
  74     def test_reserved_1(self):
  75         basedir = "client.Basic.test_reserved_1"
  76         os.mkdir(basedir)
  77         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
  78         f.write(BASECONFIG)
  79         f.write("[storage]\n")
  80         f.write("enabled = true\n")
  81         f.write("reserved_space = 1000\n")
  82         f.close()
  83         c = client.Client(basedir)
  84         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 1000)
  85
  86     def test_reserved_2(self):
  87         basedir = "client.Basic.test_reserved_2"
  88         os.mkdir(basedir)
  89         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
  90         f.write(BASECONFIG)
  91         f.write("[storage]\n")
  92         f.write("enabled = true\n")
  93         f.write("reserved_space = 10K\n")
  94         f.close()
  95         c = client.Client(basedir)
  96         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 10*1000)
  97
  98     def test_reserved_3(self):
  99         basedir = "client.Basic.test_reserved_3"
 100         os.mkdir(basedir)
 101         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
 102         f.write(BASECONFIG)
 103         f.write("[storage]\n")
 104         f.write("enabled = true\n")
 105         f.write("reserved_space = 5mB\n")
 106         f.close()
 107         c = client.Client(basedir)
 108         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 109                              5*1000*1000)
 110
 111     def test_reserved_4(self):
 112         basedir = "client.Basic.test_reserved_4"
 113         os.mkdir(basedir)
 114         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
 115         f.write(BASECONFIG)
 116         f.write("[storage]\n")
 117         f.write("enabled = true\n")
 118         f.write("reserved_space = 78Gb\n")
 119         f.close()
 120         c = client.Client(basedir)
 121         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space,
 122                              78*1000*1000*1000)
 123
 124     def test_reserved_bad(self):
 125         basedir = "client.Basic.test_reserved_bad"
 126         os.mkdir(basedir)
 127         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
 128         f.write(BASECONFIG)
 129         f.write("[storage]\n")
 130         f.write("enabled = true\n")
 131         f.write("reserved_space = bogus\n")
 132         f.close()
 133         c = client.Client(basedir)
 134         self.failUnlessEqual(c.getServiceNamed("storage").reserved_space, 0)
 135
 136     def _permute(self, sb, key):
 137         return [ s.get_serverid() for s in sb.get_servers_for_psi(key) ]
 138
 139     def test_permute(self):
 140         sb = StorageFarmBroker(None, True)
 141         for k in ["%d" % i for i in range(5)]:
 142             sb.test_add_server(k, "rref")
 143
 144         self.failUnlessReallyEqual(self._permute(sb, "one"), ['3','1','0','4','2'])
 145         self.failUnlessReallyEqual(self._permute(sb, "two"), ['0','4','2','1','3'])
 146         sb.test_servers.clear()
 147         self.failUnlessReallyEqual(self._permute(sb, "one"), [])
 148
 149     def test_versions(self):
 150         basedir = "test_client.Basic.test_versions"
 151         os.mkdir(basedir)
 152         open(os.path.join(basedir, "introducer.furl"), "w").write("")
 153         c = client.Client(basedir)
 154         ss = c.getServiceNamed("storage")
 155         verdict = ss.remote_get_version()
 156         self.failUnlessReallyEqual(verdict["application-version"],
 157                                    str(allmydata.__full_version__))
 158         self.failIfEqual(str(allmydata.__version__), "unknown")
 159         self.failUnless("." in str(allmydata.__full_version__),
 160                         "non-numeric version in '%s'" % allmydata.__version__)
 161         all_versions = allmydata.get_package_versions_string()
 162         self.failUnless(allmydata.__appname__ in all_versions)
 163         log.msg("tahoe versions: %s" % all_versions)
 164         # also test stats
 165         stats = c.get_stats()
 166         self.failUnless("node.uptime" in stats)
 167         self.failUnless(isinstance(stats["node.uptime"], float))
 168
 169 def flush_but_dont_ignore(res):
 170     d = flushEventualQueue()
 171     def _done(ignored):
 172         return res
 173     d.addCallback(_done)
 174     return d
 175
 176 class Run(unittest.TestCase, testutil.StallMixin):
 177
 178     def setUp(self):
 179         self.sparent = service.MultiService()
 180         self.sparent.startService()
 181     def tearDown(self):
 182         d = self.sparent.stopService()
 183         d.addBoth(flush_but_dont_ignore)
 184         return d
 185
 186     def test_loadable(self):
 187         basedir = "test_client.Run.test_loadable"
 188         os.mkdir(basedir)
 189         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 190         open(os.path.join(basedir, "introducer.furl"), "w").write(dummy)
 191         open(os.path.join(basedir, "suicide_prevention_hotline"), "w")
 192         client.Client(basedir)
 193
 194     def test_reloadable(self):
 195         basedir = "test_client.Run.test_reloadable"
 196         os.mkdir(basedir)
 197         dummy = "pb://wl74cyahejagspqgy4x5ukrvfnevlknt@127.0.0.1:58889/bogus"
 198         open(os.path.join(basedir, "introducer.furl"), "w").write(dummy)
 199         c1 = client.Client(basedir)
 200         c1.setServiceParent(self.sparent)
 201
 202         # delay to let the service start up completely. I'm not entirely sure
 203         # this is necessary.
 204         d = self.stall(delay=2.0)
 205         d.addCallback(lambda res: c1.disownServiceParent())
 206         # the cygwin buildslave seems to need more time to let the old
 207         # service completely shut down. When delay=0.1, I saw this test fail,
 208         # probably due to the logport trying to reclaim the old socket
 209         # number. This suggests that either we're dropping a Deferred
 210         # somewhere in the shutdown sequence, or that cygwin is just cranky.
 211         d.addCallback(self.stall, delay=2.0)
 212         def _restart(res):
 213             # TODO: pause for slightly over one second, to let
 214             # Client._check_hotline poll the file once. That will exercise
 215             # another few lines. Then add another test in which we don't
 216             # update the file at all, and watch to see the node shutdown. (to
 217             # do this, use a modified node which overrides Node.shutdown(),
 218             # also change _check_hotline to use it instead of a raw
 219             # reactor.stop, also instrument the shutdown event in an
 220             # attribute that we can check)
 221             c2 = client.Client(basedir)
 222             c2.setServiceParent(self.sparent)
 223             return c2.disownServiceParent()
 224         d.addCallback(_restart)
 225         return d
 226
 227 class NodeMaker(testutil.ReallyEqualMixin, unittest.TestCase):
 228     def test_maker(self):
 229         basedir = "client/NodeMaker/maker"
 230         fileutil.make_dirs(basedir)
 231         f = open(os.path.join(basedir, "tahoe.cfg"), "w")
 232         f.write(BASECONFIG)
 233         f.close()
 234         c = client.Client(basedir)
 235
 236         n = c.create_node_from_uri("URI:CHK:6nmrpsubgbe57udnexlkiwzmlu:bjt7j6hshrlmadjyr7otq3dc24end5meo5xcr5xe5r663po6itmq:3:10:7277")
 237         self.failUnless(IFilesystemNode.providedBy(n))
 238         self.failUnless(IFileNode.providedBy(n))
 239         self.failUnless(IImmutableFileNode.providedBy(n))
 240         self.failIf(IMutableFileNode.providedBy(n))
 241         self.failIf(IDirectoryNode.providedBy(n))
 242         self.failUnless(n.is_readonly())
 243         self.failIf(n.is_mutable())
 244
 245         n = c.create_node_from_uri("URI:LIT:n5xgk")
 246         self.failUnless(IFilesystemNode.providedBy(n))
 247         self.failUnless(IFileNode.providedBy(n))
 248         self.failUnless(IImmutableFileNode.providedBy(n))
 249         self.failIf(IMutableFileNode.providedBy(n))
 250         self.failIf(IDirectoryNode.providedBy(n))
 251         self.failUnless(n.is_readonly())
 252         self.failIf(n.is_mutable())
 253
 254         n = c.create_node_from_uri("URI:SSK:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 255         self.failUnless(IFilesystemNode.providedBy(n))
 256         self.failUnless(IFileNode.providedBy(n))
 257         self.failIf(IImmutableFileNode.providedBy(n))
 258         self.failUnless(IMutableFileNode.providedBy(n))
 259         self.failIf(IDirectoryNode.providedBy(n))
 260         self.failIf(n.is_readonly())
 261         self.failUnless(n.is_mutable())
 262
 263         n = c.create_node_from_uri("URI:SSK-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 264         self.failUnless(IFilesystemNode.providedBy(n))
 265         self.failUnless(IFileNode.providedBy(n))
 266         self.failIf(IImmutableFileNode.providedBy(n))
 267         self.failUnless(IMutableFileNode.providedBy(n))
 268         self.failIf(IDirectoryNode.providedBy(n))
 269         self.failUnless(n.is_readonly())
 270         self.failUnless(n.is_mutable())
 271
 272         n = c.create_node_from_uri("URI:DIR2:n6x24zd3seu725yluj75q5boaa:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 273         self.failUnless(IFilesystemNode.providedBy(n))
 274         self.failIf(IFileNode.providedBy(n))
 275         self.failIf(IImmutableFileNode.providedBy(n))
 276         self.failIf(IMutableFileNode.providedBy(n))
 277         self.failUnless(IDirectoryNode.providedBy(n))
 278         self.failIf(n.is_readonly())
 279         self.failUnless(n.is_mutable())
 280
 281         n = c.create_node_from_uri("URI:DIR2-RO:b7sr5qsifnicca7cbk3rhrhbvq:mm6yoqjhl6ueh7iereldqxue4nene4wl7rqfjfybqrehdqmqskvq")
 282         self.failUnless(IFilesystemNode.providedBy(n))
 283         self.failIf(IFileNode.providedBy(n))
 284         self.failIf(IImmutableFileNode.providedBy(n))
 285         self.failIf(IMutableFileNode.providedBy(n))
 286         self.failUnless(IDirectoryNode.providedBy(n))
 287         self.failUnless(n.is_readonly())
 288         self.failUnless(n.is_mutable())
 289
 290         unknown_rw = "lafs://from_the_future"
 291         unknown_ro = "lafs://readonly_from_the_future"
 292         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 293         self.failUnless(IFilesystemNode.providedBy(n))
 294         self.failIf(IFileNode.providedBy(n))
 295         self.failIf(IImmutableFileNode.providedBy(n))
 296         self.failIf(IMutableFileNode.providedBy(n))
 297         self.failIf(IDirectoryNode.providedBy(n))
 298         self.failUnless(n.is_unknown())
 299         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 300         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 301         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)
 302
 303         # Note: it isn't that we *intend* to deploy non-ASCII caps in
 304         # the future, it is that we want to make sure older Tahoe-LAFS
 305         # versions wouldn't choke on them if we were to do so. See
 306         # #1051 and wiki:NewCapDesign for details.
 307         unknown_rw = u"lafs://from_the_future_rw_\u263A".encode('utf-8')
 308         unknown_ro = u"lafs://readonly_from_the_future_ro_\u263A".encode('utf-8')
 309         n = c.create_node_from_uri(unknown_rw, unknown_ro)
 310         self.failUnless(IFilesystemNode.providedBy(n))
 311         self.failIf(IFileNode.providedBy(n))
 312         self.failIf(IImmutableFileNode.providedBy(n))
 313         self.failIf(IMutableFileNode.providedBy(n))
 314         self.failIf(IDirectoryNode.providedBy(n))
 315         self.failUnless(n.is_unknown())
 316         self.failUnlessReallyEqual(n.get_uri(), unknown_rw)
 317         self.failUnlessReallyEqual(n.get_write_uri(), unknown_rw)
 318         self.failUnlessReallyEqual(n.get_readonly_uri(), "ro." + unknown_ro)