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