src/allmydata/test/test_client.py

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