Skip to content

Commit

Permalink
Emit warning for unknown marks
Browse files Browse the repository at this point in the history
  • Loading branch information
Zac-HD committed Mar 31, 2019
1 parent 407d74b commit 9121138
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 17 deletions.
2 changes: 2 additions & 0 deletions changelog/4826.feature.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
A warning is now emitted when unknown marks are used as a decorator.
This is often due to a typo, which can lead to silently broken tests.
5 changes: 4 additions & 1 deletion doc/en/mark.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ which also serve as documentation.
Raising errors on unknown marks
-------------------------------

Marks can be registered in ``pytest.ini`` like this:
Unknown marks applied with the ``@pytest.mark.name_of_the_mark`` decorator
will always emit a warning, in order to avoid silently doing something
surprising due to mis-typed names. You can disable the warning for custom
marks by registering them in ``pytest.ini`` like this:

.. code-block:: ini
Expand Down
3 changes: 1 addition & 2 deletions src/_pytest/mark/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,7 @@ def pytest_collection_modifyitems(items, config):

def pytest_configure(config):
config._old_mark_config = MARK_GEN._config
if config.option.strict:
MARK_GEN._config = config
MARK_GEN._config = config

empty_parameterset = config.getini(EMPTY_PARAMETERSET_OPTION)

Expand Down
38 changes: 24 additions & 14 deletions src/_pytest/mark/structures.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from ..compat import MappingMixin
from ..compat import NOTSET
from _pytest.outcomes import fail
from _pytest.warning_types import PytestWarning

EMPTY_PARAMETERSET_OPTION = "empty_parameter_set_mark"

Expand Down Expand Up @@ -283,28 +284,37 @@ def test_function():
on the ``test_function`` object. """

_config = None
_markers = set()

def __getattr__(self, name):
if name[0] == "_":
raise AttributeError("Marker name must NOT start with underscore")

if self._config is not None:
self._check(name)
self._update_markers(name)
if name not in self._markers:
warnings.warn(
"Unknown mark %r. You can register custom marks to avoid this "
"warning, without risking typos that break your tests. See "
"https://docs.pytest.org/en/latest/mark.html for details." % name,
PytestWarning,
)
if self._config.option.strict:
fail("{!r} not a registered marker".format(name), pytrace=False)

return MarkDecorator(Mark(name, (), {}))

def _check(self, name):
try:
if name in self._markers:
return
except AttributeError:
pass
self._markers = values = set()
for line in self._config.getini("markers"):
marker = line.split(":", 1)[0]
marker = marker.rstrip()
x = marker.split("(", 1)[0]
values.add(x)
def _update_markers(self, name):
# We store a set of registered markers as a performance optimisation,
# but more could be added to `self._config` by other plugins at runtime.
# If we see an unknown marker, we therefore update the set and try again!
if name not in self._markers:
fail("{!r} not a registered marker".format(name), pytrace=False)
for line in self._config.getini("markers"):
# example lines: "skipif(condition): skip the given test if..."
# or "hypothesis: tests which use Hypothesis", so to get the
# marker name we we split on both `:` and `(`.
marker = line.split(":")[0].split("(")[0].strip()
self._markers.add(marker)


MARK_GEN = MarkGenerator()
Expand Down

0 comments on commit 9121138

Please sign in to comment.