/usr/lib/python2.7/dist-packages/autobahn/wamp/test/test_user_handler_errors.py is in python-autobahn 17.10.1+dfsg1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 | ###############################################################################
#
# The MIT License (MIT)
#
# Copyright (c) Crossbar.io Technologies GmbH
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
###############################################################################
from __future__ import absolute_import
import os
if os.environ.get('USE_TWISTED', False):
from twisted.trial import unittest
from twisted.internet import defer
from twisted.python.failure import Failure
from autobahn.wamp import message, role
from autobahn.wamp.exception import ProtocolError
from autobahn.twisted.wamp import ApplicationSession
class MockTransport:
def __init__(self):
self.messages = []
def send(self, msg):
self.messages.append(msg)
def close(self, *args, **kw):
pass
class MockApplicationSession(ApplicationSession):
'''
This is used by tests, which typically attach their own handler to
on*() methods. This just collects any errors from onUserError
'''
def __init__(self, *args, **kw):
ApplicationSession.__init__(self, *args, **kw)
self.errors = []
self._realm = u'dummy'
self._transport = MockTransport()
def onUserError(self, e, msg):
self.errors.append((e.value, msg))
def exception_raiser(exc):
'''
Create a method that takes any args and always raises the given
Exception instance.
'''
assert isinstance(exc, Exception), "Must derive from Exception"
def method(*args, **kw):
raise exc
return method
def async_exception_raiser(exc):
'''
Create a method that takes any args, and always returns a Deferred
that has failed.
'''
assert isinstance(exc, Exception), "Must derive from Exception"
def method(*args, **kw):
try:
raise exc
except:
return defer.fail(Failure())
return method
def create_mock_welcome():
return message.Welcome(
1234,
{
u'broker': role.RoleBrokerFeatures(),
},
)
class TestSessionCallbacks(unittest.TestCase):
'''
These test that callbacks on user-overridden ApplicationSession
methods that produce errors are handled correctly.
XXX should do state-diagram documenting where we are when each
of these cases arises :/
'''
# XXX sure would be nice to use py.test @fixture to do the
# async/sync exception-raising stuff (i.e. make each test run
# twice)...but that would mean switching all test-running over
# to py-test
skip = True
def test_on_join(self):
session = MockApplicationSession()
exception = RuntimeError("blammo")
session.onJoin = exception_raiser(exception)
msg = create_mock_welcome()
# give the sesion a WELCOME, from which it should call onJoin
session.onMessage(msg)
# make sure we got the right error out of onUserError
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_join_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("blammo")
session.onJoin = async_exception_raiser(exception)
msg = create_mock_welcome()
# give the sesion a WELCOME, from which it should call onJoin
session.onMessage(msg)
# make sure we got the right error out of onUserError
# import traceback
# traceback.print_exception(*session.errors[0][:3])
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_leave(self):
session = MockApplicationSession()
exception = RuntimeError("boom")
session.onLeave = exception_raiser(exception)
msg = message.Abort(u"testing")
# we haven't done anything, so this is "abort before we've
# connected"
session.onMessage(msg)
# make sure we got the right error out of onUserError
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_leave_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("boom")
session.onLeave = async_exception_raiser(exception)
msg = message.Abort(u"testing")
# we haven't done anything, so this is "abort before we've
# connected"
session.onMessage(msg)
# make sure we got the right error out of onUserError
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_leave_valid_session(self):
'''
cover when onLeave called after we have a valid session
'''
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onLeave = exception_raiser(exception)
# we have to get to an established connection first...
session.onMessage(create_mock_welcome())
self.assertTrue(session._session_id is not None)
# okay we have a session ("because ._session_id is not None")
msg = message.Goodbye()
session.onMessage(msg)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_leave_valid_session_deferred(self):
'''
cover when onLeave called after we have a valid session
'''
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onLeave = async_exception_raiser(exception)
# we have to get to an established connection first...
session.onMessage(create_mock_welcome())
self.assertTrue(session._session_id is not None)
# okay we have a session ("because ._session_id is not None")
msg = message.Goodbye()
session.onMessage(msg)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_leave_after_bad_challenge(self):
'''
onLeave raises error after onChallenge fails
'''
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onLeave = exception_raiser(exception)
session.onChallenge = exception_raiser(exception)
# make a challenge (which will fail, and then the
# subsequent onLeave will also fail)
msg = message.Challenge(u"foo")
session.onMessage(msg)
self.assertEqual(2, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_disconnect_via_close(self):
session = MockApplicationSession()
exception = RuntimeError("sideways")
session.onDisconnect = exception_raiser(exception)
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_disconnect_via_close_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("sideways")
session.onDisconnect = async_exception_raiser(exception)
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
# XXX FIXME Probably more ways to call onLeave!
def test_on_challenge(self):
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onChallenge = exception_raiser(exception)
msg = message.Challenge(u"foo")
# execute
session.onMessage(msg)
# we already handle any onChallenge errors as "abort the
# connection". So make sure our error showed up in the
# fake-transport.
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
self.assertEqual(1, len(session._transport.messages))
reply = session._transport.messages[0]
self.assertIsInstance(reply, message.Abort)
self.assertEqual("such challenge", reply.message)
def test_on_challenge_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onChallenge = async_exception_raiser(exception)
msg = message.Challenge(u"foo")
# execute
session.onMessage(msg)
# we already handle any onChallenge errors as "abort the
# connection". So make sure our error showed up in the
# fake-transport.
self.assertEqual(1, len(session.errors))
self.assertEqual(session.errors[0][0], exception)
self.assertEqual(1, len(session._transport.messages))
reply = session._transport.messages[0]
self.assertIsInstance(reply, message.Abort)
self.assertEqual("such challenge", reply.message)
def test_no_session(self):
'''
test "all other cases" when we don't yet have a session
established, which should all raise ProtocolErrors and
*not* go through the onUserError handler. We cheat and
just test one.
'''
session = MockApplicationSession()
exception = RuntimeError("such challenge")
session.onConnect = exception_raiser(exception)
for msg in [message.Goodbye()]:
self.assertRaises(ProtocolError, session.onMessage, (msg,))
self.assertEqual(0, len(session.errors))
def test_on_disconnect(self):
session = MockApplicationSession()
exception = RuntimeError("oh sadness")
session.onDisconnect = exception_raiser(exception)
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_disconnect_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("oh sadness")
session.onDisconnect = async_exception_raiser(exception)
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_disconnect_with_session(self):
session = MockApplicationSession()
exception = RuntimeError("the pain runs deep")
session.onDisconnect = exception_raiser(exception)
# create a valid session
session.onMessage(create_mock_welcome())
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_disconnect_with_session_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("the pain runs deep")
session.onDisconnect = async_exception_raiser(exception)
# create a valid session
session.onMessage(create_mock_welcome())
# we short-cut the whole state-machine traversal here by
# just calling onClose directly, which would normally be
# called via a Protocol, e.g.,
# autobahn.wamp.websocket.WampWebSocketProtocol
session.onClose(False)
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_connect(self):
session = MockApplicationSession()
exception = RuntimeError("the pain runs deep")
session.onConnect = exception_raiser(exception)
trans = MockTransport()
# normally would be called from a Protocol?
session.onOpen(trans)
# shouldn't have done the .join()
self.assertEqual(0, len(trans.messages))
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
def test_on_connect_deferred(self):
session = MockApplicationSession()
exception = RuntimeError("the pain runs deep")
session.onConnect = async_exception_raiser(exception)
trans = MockTransport()
# normally would be called from a Protocol?
session.onOpen(trans)
# shouldn't have done the .join()
self.assertEqual(0, len(trans.messages))
self.assertEqual(1, len(session.errors))
self.assertEqual(exception, session.errors[0][0])
# XXX likely missing other ways to invoke the above. need to
# cover, for sure:
#
# onChallenge
# onJoin
# onLeave
# onDisconnect
#
# what about other ISession ones?
# onConnect
# onDisconnect
# NOTE: for Event stuff, that is publish() handlers,
# test_publish_callback_exception in test_protocol.py already
# covers exceptions coming from user-code.
|