From 5e27ea552867830d44d436cfc54b1292da969e4a Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Fri, 15 Mar 2019 04:14:07 +0100 Subject: [PATCH] pytester: LineMatcher: assert Sequence when matching in order This can be helpful when passing a set accidentally. --- changelog/4931.feature.rst | 1 + src/_pytest/pytester.py | 2 ++ testing/test_pytester.py | 16 ++++++++++++++++ 3 files changed, 19 insertions(+) create mode 100644 changelog/4931.feature.rst diff --git a/changelog/4931.feature.rst b/changelog/4931.feature.rst new file mode 100644 index 000000000..bfc35a4b7 --- /dev/null +++ b/changelog/4931.feature.rst @@ -0,0 +1 @@ +pytester's ``LineMatcher`` asserts that the passed lines are a sequence. diff --git a/src/_pytest/pytester.py b/src/_pytest/pytester.py index 810041de7..d5faed418 100644 --- a/src/_pytest/pytester.py +++ b/src/_pytest/pytester.py @@ -25,6 +25,7 @@ from _pytest.assertion.rewrite import AssertionRewritingHook from _pytest.capture import MultiCapture from _pytest.capture import SysCapture from _pytest.compat import safe_str +from _pytest.compat import Sequence from _pytest.main import EXIT_INTERRUPTED from _pytest.main import EXIT_OK from _pytest.main import Session @@ -1325,6 +1326,7 @@ class LineMatcher(object): will be logged to stdout when a match occurs """ + assert isinstance(lines2, Sequence) lines2 = self._getlines(lines2) lines1 = self.lines[:] nextline = None diff --git a/testing/test_pytester.py b/testing/test_pytester.py index 675108460..08167ec90 100644 --- a/testing/test_pytester.py +++ b/testing/test_pytester.py @@ -17,6 +17,7 @@ from _pytest.main import EXIT_OK from _pytest.main import EXIT_TESTSFAILED from _pytest.pytester import CwdSnapshot from _pytest.pytester import HookRecorder +from _pytest.pytester import LineMatcher from _pytest.pytester import SysModulesSnapshot from _pytest.pytester import SysPathsSnapshot @@ -453,3 +454,18 @@ def test_testdir_run_timeout_expires(testdir): ) with pytest.raises(testdir.TimeoutExpired): testdir.runpytest_subprocess(testfile, timeout=1) + + +def test_linematcher_with_nonlist(): + """Test LineMatcher with regard to passing in a set (accidentally).""" + lm = LineMatcher([]) + + with pytest.raises(AssertionError): + lm.fnmatch_lines(set()) + with pytest.raises(AssertionError): + lm.fnmatch_lines({}) + lm.fnmatch_lines([]) + lm.fnmatch_lines(()) + + assert lm._getlines({}) == {} + assert lm._getlines(set()) == set()