Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom hooks specifications for overriding setup_timeout and teardown_timeout methods #117

Merged
merged 9 commits into from
Jan 16, 2022
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,85 @@ debugging frameworks modules OR if pytest itself drops you into a pdb
session using ``--pdb`` or similar.


Extending pytest-timeout with plugings
======================================

``pytest-timeout`` provides two hooks that can be used for extending the tool. There
asvetlov marked this conversation as resolved.
Show resolved Hide resolved
hooks are used for for setting the timeout timer and cancelling it it the timeout is not
reached.

For example, ``pytest-asyncio`` can provide asyncio-specific code that generates better
traceback and points on timed out ``await`` instead of the running loop ieration.

See `pytest hooks documentation
<https://docs.pytest.org/en/latest/how-to/writing_hook_functions.html>`_ for more info
regarding to use custom hooks.

``pytest_timeout_set_timer``
----------------------------

@pytest.hookspec(firstresult=True)
def pytest_timeout_set_timer(item, settings):
"""Called at timeout setup.

'item' is a pytest node to setup timeout for.

'settings' is Settings namedtuple (described below).

Can be overridden by plugins for alternative timeout implementation strategies.

"""


``Settings``
------------

When ``pytest_timeout_set_timer`` is called, ``settings`` argument is passed.

The argument has ``Settings`` namedtuple type with the following fields:

+-----------+-------+--------------------------------------------------------+
|Attribute | Index | Value |
+===========+=======+========================================================+
| timeout | 0 | timeout in seconds or ``None`` for no timeout |
+-----------+-------+--------------------------------------------------------+
| method | 1 | Method mechanism, |
| | | ``'signal'`` and ``'thread'`` are supported by default |
+-----------+-------+--------------------------------------------------------+
| func_only | 2 | Apply timeout to test function only if ``True``, |
| | | wrap all test function and its fixtures otherwise |
+-----------+-------+--------------------------------------------------------+

``pytest_timeout_cancel_timer``
-------------------------------


@pytest.hookspec(firstresult=True)
def pytest_timeout_cancel_timer(item):
"""Called at timeout teardown.

'item' is a pytest node which was used for timeout setup.

Can be overridden by plugins for alternative timeout implementation strategies.

"""

``is_debugging``
----------------

The the timeout occurs, user can open the debugger session. In this case, the timeout
asvetlov marked this conversation as resolved.
Show resolved Hide resolved
should be discarded. A custom hook can check this case by calling ``is_debugging()``
function::

import pytest
import pytest_timeout

def on_timeout():
if pytest_timeout.is_debugging():
return
pytest.fail("+++ Timeout +++")


flub marked this conversation as resolved.
Show resolved Hide resolved
Changelog
=========

Expand Down
99 changes: 63 additions & 36 deletions pytest_timeout.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@
import pytest


__all__ = ("is_debugging", "Settings")


HAVE_SIGALRM = hasattr(signal, "SIGALRM")
if HAVE_SIGALRM:
DEFAULT_METHOD = "signal"
Expand Down Expand Up @@ -70,6 +73,35 @@ def pytest_addoption(parser):
parser.addini("timeout_func_only", FUNC_ONLY_DESC, type="bool")


class TimeoutHooks:
"""Timeout specific hooks."""

@pytest.hookspec(firstresult=True)
def pytest_timeout_set_timer(item, settings):
"""Called at timeout setup.

'item' is a pytest node to setup timeout for.

Can be overridden by plugins for alternative timeout implementation strategies.

"""

@pytest.hookspec(firstresult=True)
def pytest_timeout_cancel_timer(item):
"""Called at timeout teardown.

'item' is a pytest node which was used for timeout setup.

Can be overridden by plugins for alternative timeout implementation strategies.

"""


def pytest_addhooks(pluginmanager):
"""Register timeout-specific hooks."""
pluginmanager.add_hookspecs(TimeoutHooks)


@pytest.hookimpl
def pytest_configure(config):
"""Register the marker so it shows up in --markers output."""
Expand Down Expand Up @@ -98,12 +130,14 @@ def pytest_runtest_protocol(item):
teardown, then this hook installs the timeout. Otherwise
pytest_runtest_call is used.
"""
func_only = get_func_only_setting(item)
if func_only is False:
timeout_setup(item)
hooks = item.config.pluginmanager.hook
settings = _get_item_settings(item)
is_timeout = settings.timeout is not None and settings.timeout > 0
if is_timeout and settings.func_only is False:
hooks.pytest_timeout_set_timer(item=item, settings=settings)
yield
if func_only is False:
timeout_teardown(item)
if is_timeout and settings.func_only is False:
hooks.pytest_timeout_cancel_timer(item=item)


@pytest.hookimpl(hookwrapper=True)
Expand All @@ -113,12 +147,14 @@ def pytest_runtest_call(item):
If the timeout is set on only the test function this hook installs
the timeout, otherwise pytest_runtest_protocol is used.
"""
func_only = get_func_only_setting(item)
if func_only is True:
timeout_setup(item)
hooks = item.config.pluginmanager.hook
settings = _get_item_settings(item)
is_timeout = settings.timeout is not None and settings.timeout > 0
if is_timeout and settings.func_only is True:
hooks.pytest_timeout_set_timer(item=item, settings=settings)
yield
if func_only is True:
timeout_teardown(item)
if is_timeout and settings.func_only is True:
hooks.pytest_timeout_cancel_timer(item=item)


@pytest.hookimpl(tryfirst=True)
Expand All @@ -138,7 +174,8 @@ def pytest_report_header(config):
@pytest.hookimpl(tryfirst=True)
def pytest_exception_interact(node):
"""Stop the timeout when pytest enters pdb in post-mortem mode."""
timeout_teardown(node)
hooks = node.config.pluginmanager.hook
hooks.pytest_timeout_cancel_timer(item=node)


@pytest.hookimpl
Expand Down Expand Up @@ -187,13 +224,10 @@ def is_debugging(trace_func=None):
SUPPRESS_TIMEOUT = False


def timeout_setup(item):
@pytest.hookimpl(trylast=True)
def pytest_timeout_set_timer(item, settings):
"""Setup up a timeout trigger and handler."""
params = get_params(item)
if params.timeout is None or params.timeout <= 0:
return

timeout_method = params.method
timeout_method = settings.method
if (
timeout_method == "signal"
and threading.current_thread() is not threading.main_thread()
Expand All @@ -204,17 +238,19 @@ def timeout_setup(item):

def handler(signum, frame):
__tracebackhide__ = True
timeout_sigalrm(item, params.timeout)
timeout_sigalrm(item, settings.timeout)

def cancel():
signal.setitimer(signal.ITIMER_REAL, 0)
signal.signal(signal.SIGALRM, signal.SIG_DFL)

item.cancel_timeout = cancel
signal.signal(signal.SIGALRM, handler)
signal.setitimer(signal.ITIMER_REAL, params.timeout)
signal.setitimer(signal.ITIMER_REAL, settings.timeout)
elif timeout_method == "thread":
timer = threading.Timer(params.timeout, timeout_timer, (item, params.timeout))
timer = threading.Timer(
settings.timeout, timeout_timer, (item, settings.timeout)
)
timer.name = "%s %s" % (__name__, item.nodeid)

def cancel():
Expand All @@ -223,9 +259,11 @@ def cancel():

item.cancel_timeout = cancel
timer.start()
return True
flub marked this conversation as resolved.
Show resolved Hide resolved


def timeout_teardown(item):
@pytest.hookimpl(trylast=True)
def pytest_timeout_cancel_timer(item):
"""Cancel the timeout trigger if it was set."""
# When skipping is raised from a pytest_runtest_setup function
# (as is the case when using the pytest.mark.skipif marker) we
Expand All @@ -234,6 +272,7 @@ def timeout_teardown(item):
cancel = getattr(item, "cancel_timeout", None)
if cancel:
cancel()
return True


def get_env_settings(config):
Expand Down Expand Up @@ -268,21 +307,7 @@ def get_env_settings(config):
return Settings(timeout, method, func_only or False)


def get_func_only_setting(item):
"""Return the func_only setting for an item."""
func_only = None
marker = item.get_closest_marker("timeout")
if marker:
settings = get_params(item, marker=marker)
func_only = _validate_func_only(settings.func_only, "marker")
if func_only is None:
func_only = item.config._env_timeout_func_only
if func_only is None:
func_only = False
return func_only


def get_params(item, marker=None):
def _get_item_settings(item, marker=None):
"""Return (timeout, method) for an item."""
timeout = method = func_only = None
if not marker:
Expand All @@ -298,6 +323,8 @@ def get_params(item, marker=None):
method = item.config._env_timeout_method
if func_only is None:
func_only = item.config._env_timeout_func_only
if func_only is None:
func_only = False
return Settings(timeout, method, func_only)


Expand Down
36 changes: 36 additions & 0 deletions test_pytest_timeout.py
Original file line number Diff line number Diff line change
Expand Up @@ -506,3 +506,39 @@ def test_x(): pass
result.stdout.fnmatch_lines(
["timeout: 1.0s", "timeout method:*", "timeout func_only:*"]
)


def test_plugin_interface(testdir):
testdir.makeconftest(
"""
import pytest

@pytest.mark.tryfirst
def pytest_timeout_set_timer(item, settings):
print()
print("pytest_timeout_set_timer")
return True

@pytest.mark.tryfirst
def pytest_timeout_cancel_timer(item):
print()
print("pytest_timeout_cancel_timer")
return True
"""
)
testdir.makepyfile(
"""
import pytest

@pytest.mark.timeout(1)
def test_foo():
pass
"""
)
result = testdir.runpytest("-s")
result.stdout.fnmatch_lines(
[
"pytest_timeout_set_timer",
"pytest_timeout_cancel_timer",
]
)