177 lines
4.9 KiB
Python
177 lines
4.9 KiB
Python
import asyncio
|
|
import os
|
|
import signal
|
|
|
|
from queue import Queue
|
|
from types import SimpleNamespace
|
|
from typing import Optional
|
|
from unittest.mock import MagicMock
|
|
|
|
import pytest
|
|
|
|
from sanic_testing.testing import HOST, PORT
|
|
|
|
from sanic import Sanic
|
|
from sanic.compat import ctrlc_workaround_for_windows
|
|
from sanic.exceptions import BadRequest, ServerError
|
|
from sanic.response import HTTPResponse
|
|
from sanic.signals import Event
|
|
|
|
|
|
async def stop(app, loop):
|
|
await asyncio.sleep(0.1)
|
|
app.stop()
|
|
|
|
|
|
calledq = Queue()
|
|
|
|
|
|
def set_loop(app, loop):
|
|
global mock
|
|
mock = MagicMock()
|
|
if os.name == "nt":
|
|
signal.signal = mock
|
|
else:
|
|
loop.add_signal_handler = mock
|
|
|
|
|
|
def after(app, loop):
|
|
print("...")
|
|
calledq.put(mock.called)
|
|
|
|
|
|
@pytest.mark.skipif(os.name == "nt", reason="May hang CI on py38/windows")
|
|
def test_register_system_signals(app):
|
|
"""Test if sanic register system signals"""
|
|
|
|
@app.route("/hello")
|
|
async def hello_route(request):
|
|
return HTTPResponse()
|
|
|
|
app.listener("after_server_start")(stop)
|
|
app.listener("before_server_start")(set_loop)
|
|
app.listener("after_server_stop")(after)
|
|
|
|
app.run(HOST, PORT, single_process=True)
|
|
assert calledq.get() is True
|
|
|
|
|
|
@pytest.mark.skipif(os.name == "nt", reason="May hang CI on py38/windows")
|
|
def test_no_register_system_signals_fails(app):
|
|
"""Test if sanic don't register system signals"""
|
|
|
|
@app.route("/hello")
|
|
async def hello_route(request):
|
|
return HTTPResponse()
|
|
|
|
app.listener("after_server_start")(stop)
|
|
app.listener("before_server_start")(set_loop)
|
|
app.listener("after_server_stop")(after)
|
|
|
|
message = (
|
|
r"Cannot run Sanic\.serve with register_sys_signals=False\. Use "
|
|
r"Sanic.serve_single\."
|
|
)
|
|
with pytest.raises(RuntimeError, match=message):
|
|
app.prepare(HOST, PORT, register_sys_signals=False)
|
|
assert calledq.empty()
|
|
|
|
|
|
@pytest.mark.skipif(os.name == "nt", reason="May hang CI on py38/windows")
|
|
def test_dont_register_system_signals(app):
|
|
"""Test if sanic don't register system signals"""
|
|
|
|
@app.route("/hello")
|
|
async def hello_route(request):
|
|
return HTTPResponse()
|
|
|
|
app.listener("after_server_start")(stop)
|
|
app.listener("before_server_start")(set_loop)
|
|
app.listener("after_server_stop")(after)
|
|
|
|
app.run(HOST, PORT, register_sys_signals=False, single_process=True)
|
|
assert calledq.get() is False
|
|
|
|
|
|
@pytest.mark.skipif(os.name == "nt", reason="windows cannot SIGINT processes")
|
|
def test_windows_workaround():
|
|
"""Test Windows workaround (on any other OS)"""
|
|
|
|
# At least some code coverage, even though this test doesn't work on
|
|
# Windows...
|
|
class MockApp:
|
|
def __init__(self):
|
|
self.state = SimpleNamespace()
|
|
self.state.is_stopping = False
|
|
|
|
def stop(self):
|
|
assert not self.state.is_stopping
|
|
self.state.is_stopping = True
|
|
|
|
def add_task(self, func):
|
|
loop = asyncio.get_event_loop()
|
|
self.stay_active_task = loop.create_task(func(self))
|
|
|
|
async def atest(stop_first):
|
|
app = MockApp()
|
|
ctrlc_workaround_for_windows(app)
|
|
await asyncio.sleep(0.05)
|
|
if stop_first:
|
|
app.stop()
|
|
await asyncio.sleep(0.2)
|
|
assert app.state.is_stopping == stop_first
|
|
# First Ctrl+C: should call app.stop() within 0.1 seconds
|
|
os.kill(os.getpid(), signal.SIGINT)
|
|
await asyncio.sleep(0.2)
|
|
assert app.state.is_stopping
|
|
assert app.stay_active_task.result() is None
|
|
# Second Ctrl+C should raise
|
|
with pytest.raises(KeyboardInterrupt):
|
|
os.kill(os.getpid(), signal.SIGINT)
|
|
return "OK"
|
|
|
|
# Run in our private loop
|
|
loop = asyncio.new_event_loop()
|
|
asyncio.set_event_loop(loop)
|
|
res = loop.run_until_complete(atest(False))
|
|
assert res == "OK"
|
|
res = loop.run_until_complete(atest(True))
|
|
assert res == "OK"
|
|
|
|
|
|
@pytest.mark.skipif(os.name == "nt", reason="May hang CI on py38/windows")
|
|
def test_signals_with_invalid_invocation(app):
|
|
"""Test if sanic register fails with invalid invocation"""
|
|
|
|
@app.route("/hello")
|
|
async def hello_route(request):
|
|
return HTTPResponse()
|
|
|
|
with pytest.raises(
|
|
BadRequest, match="Invalid event registration: Missing event name"
|
|
):
|
|
app.listener(stop)
|
|
|
|
|
|
def test_signal_server_lifecycle_exception(app: Sanic):
|
|
trigger: Optional[Exception] = None
|
|
|
|
@app.route("/hello")
|
|
async def hello_route(request):
|
|
return HTTPResponse()
|
|
|
|
@app.signal(Event.SERVER_LIFECYCLE_EXCEPTION)
|
|
async def test_signal(exception: Exception):
|
|
nonlocal trigger
|
|
trigger = exception
|
|
|
|
@app.before_server_start
|
|
async def test_before_server_start(app):
|
|
raise ServerError("test_before_server_start")
|
|
|
|
with pytest.raises(ServerError, match="test_before_server_start"):
|
|
app.run(single_process=True)
|
|
|
|
assert isinstance(trigger, ServerError)
|
|
assert str(trigger) == "test_before_server_start"
|