176 lines
6.9 KiB
Python
176 lines
6.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
"""
|
|
websocket - WebSocket client library for Python
|
|
|
|
Copyright (C) 2010 Hiroki Ohtani(liris)
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free Software
|
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
|
|
"""
|
|
|
|
import os
|
|
import os.path
|
|
import websocket as ws
|
|
import sys
|
|
import ssl
|
|
import unittest
|
|
sys.path[0:0] = [""]
|
|
|
|
# Skip test to access the internet.
|
|
TEST_WITH_INTERNET = os.environ.get('TEST_WITH_INTERNET', '0') == '1'
|
|
TRACEABLE = True
|
|
|
|
|
|
class WebSocketAppTest(unittest.TestCase):
|
|
|
|
class NotSetYet(object):
|
|
""" A marker class for signalling that a value hasn't been set yet.
|
|
"""
|
|
|
|
def setUp(self):
|
|
ws.enableTrace(TRACEABLE)
|
|
|
|
WebSocketAppTest.keep_running_open = WebSocketAppTest.NotSetYet()
|
|
WebSocketAppTest.keep_running_close = WebSocketAppTest.NotSetYet()
|
|
WebSocketAppTest.get_mask_key_id = WebSocketAppTest.NotSetYet()
|
|
|
|
def tearDown(self):
|
|
WebSocketAppTest.keep_running_open = WebSocketAppTest.NotSetYet()
|
|
WebSocketAppTest.keep_running_close = WebSocketAppTest.NotSetYet()
|
|
WebSocketAppTest.get_mask_key_id = WebSocketAppTest.NotSetYet()
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testKeepRunning(self):
|
|
""" A WebSocketApp should keep running as long as its self.keep_running
|
|
is not False (in the boolean context).
|
|
"""
|
|
|
|
def on_open(self, *args, **kwargs):
|
|
""" Set the keep_running flag for later inspection and immediately
|
|
close the connection.
|
|
"""
|
|
WebSocketAppTest.keep_running_open = self.keep_running
|
|
self.close()
|
|
|
|
def on_close(self, *args, **kwargs):
|
|
""" Set the keep_running flag for the test to use.
|
|
"""
|
|
WebSocketAppTest.keep_running_close = self.keep_running
|
|
self.send("connection should be closed here")
|
|
|
|
app = ws.WebSocketApp('ws://echo.websocket.org/', on_open=on_open, on_close=on_close)
|
|
app.run_forever()
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testSockMaskKey(self):
|
|
""" A WebSocketApp should forward the received mask_key function down
|
|
to the actual socket.
|
|
"""
|
|
|
|
def my_mask_key_func():
|
|
return "\x00\x00\x00\x00"
|
|
|
|
app = ws.WebSocketApp('wss://stream.meetup.com/2/rsvps', get_mask_key=my_mask_key_func)
|
|
|
|
# if numpy is installed, this assertion fail
|
|
# Note: We can't use 'is' for comparing the functions directly, need to use 'id'.
|
|
self.assertEqual(id(app.get_mask_key), id(my_mask_key_func))
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testInvalidPingIntervalPingTimeout(self):
|
|
""" Test exception handling if ping_interval < ping_timeout
|
|
"""
|
|
|
|
def on_ping(app, msg):
|
|
print("Got a ping!")
|
|
app.close()
|
|
|
|
def on_pong(app, msg):
|
|
print("Got a pong! No need to respond")
|
|
app.close()
|
|
|
|
app = ws.WebSocketApp('wss://api-pub.bitfinex.com/ws/1', on_ping=on_ping, on_pong=on_pong)
|
|
self.assertRaises(ws.WebSocketException, app.run_forever, ping_interval=1, ping_timeout=2, sslopt={"cert_reqs": ssl.CERT_NONE})
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testPingInterval(self):
|
|
""" Test WebSocketApp proper ping functionality
|
|
"""
|
|
|
|
def on_ping(app, msg):
|
|
print("Got a ping!")
|
|
app.close()
|
|
|
|
def on_pong(app, msg):
|
|
print("Got a pong! No need to respond")
|
|
app.close()
|
|
|
|
app = ws.WebSocketApp('wss://api-pub.bitfinex.com/ws/1', on_ping=on_ping, on_pong=on_pong)
|
|
app.run_forever(ping_interval=2, ping_timeout=1, sslopt={"cert_reqs": ssl.CERT_NONE})
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testOpcodeClose(self):
|
|
""" Test WebSocketApp close opcode
|
|
"""
|
|
|
|
app = ws.WebSocketApp('wss://tsock.us1.twilio.com/v3/wsconnect')
|
|
app.run_forever(ping_interval=2, ping_timeout=1, ping_payload="Ping payload")
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testOpcodeBinary(self):
|
|
""" Test WebSocketApp binary opcode
|
|
"""
|
|
|
|
app = ws.WebSocketApp('streaming.vn.teslamotors.com/streaming/')
|
|
app.run_forever(ping_interval=2, ping_timeout=1, ping_payload="Ping payload")
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testBadPingInterval(self):
|
|
""" A WebSocketApp handling of negative ping_interval
|
|
"""
|
|
app = ws.WebSocketApp('wss://api-pub.bitfinex.com/ws/1')
|
|
self.assertRaises(ws.WebSocketException, app.run_forever, ping_interval=-5, sslopt={"cert_reqs": ssl.CERT_NONE})
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testBadPingTimeout(self):
|
|
""" A WebSocketApp handling of negative ping_timeout
|
|
"""
|
|
app = ws.WebSocketApp('wss://api-pub.bitfinex.com/ws/1')
|
|
self.assertRaises(ws.WebSocketException, app.run_forever, ping_timeout=-3, sslopt={"cert_reqs": ssl.CERT_NONE})
|
|
|
|
@unittest.skipUnless(TEST_WITH_INTERNET, "Internet-requiring tests are disabled")
|
|
def testCloseStatusCode(self):
|
|
""" Test extraction of close frame status code and close reason in WebSocketApp
|
|
"""
|
|
def on_close(wsapp, close_status_code, close_msg):
|
|
print("on_close reached")
|
|
|
|
app = ws.WebSocketApp('wss://tsock.us1.twilio.com/v3/wsconnect', on_close=on_close)
|
|
closeframe = ws.ABNF(opcode=ws.ABNF.OPCODE_CLOSE, data=b'\x03\xe8no-init-from-client')
|
|
self.assertEqual([1000, 'no-init-from-client'], app._get_close_args(closeframe))
|
|
|
|
closeframe = ws.ABNF(opcode=ws.ABNF.OPCODE_CLOSE, data=b'')
|
|
self.assertEqual([None, None], app._get_close_args(closeframe))
|
|
|
|
app2 = ws.WebSocketApp('wss://tsock.us1.twilio.com/v3/wsconnect')
|
|
closeframe = ws.ABNF(opcode=ws.ABNF.OPCODE_CLOSE, data=b'')
|
|
self.assertEqual([None, None], app2._get_close_args(closeframe))
|
|
|
|
self.assertRaises(ws.WebSocketConnectionClosedException, app.send, data="test if connection is closed")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|