Handle quitting from pdb with --trace

This raises ``outcomes.exit`` via ``set_quit``, and ``post_mortem``
directly already.

It merges ``test_pdb_interaction``, ``test_pdb_print_captured_stdout``,
and ``test_pdb_print_captured_stderr`` into
``test_pdb_print_captured_stdout_and_stderr`` (clarity and performance,
especially since pexpect tests are slow).

Author: blueyed

changelog/4280.bugfix.rst

@@ -0,0 +1,4 @@
+Handle quitting from pdb with ``--trace`` by exiting pytest.
+
+Pressing q when in pdb will now exit pytest, instead of continue to run the
+remaining tests.

src/_pytest/debugging.py

@@ -101,6 +101,10 @@ def do_continue(self, arg):
 
                 do_c = do_cont = do_continue
 
+                def set_quit(self):
+                    super(_PdbWrapper, self).set_quit()
+                    outcomes.exit("Quitting debugger")
+
                 def setup(self, f, tb):
                     """Suspend on setup().
 
@@ -122,6 +126,7 @@ def setup(self, f, tb):
 
         if set_break:
             _pdb.set_trace(frame)
+        return _pdb
 
 
 class PdbInvoke(object):
@@ -147,9 +152,9 @@ def pytest_pyfunc_call(self, pyfuncitem):
 
 
 def _test_pytest_function(pyfuncitem):
-    pytestPDB.set_trace(set_break=False)
+    _pdb = pytestPDB.set_trace(set_break=False)
     testfunction = pyfuncitem.obj
-    pyfuncitem.obj = pdb.runcall
+    pyfuncitem.obj = _pdb.runcall
     if pyfuncitem._isyieldedfunction():
         arg_list = list(pyfuncitem._args)
         arg_list.insert(0, testfunction)
@@ -188,8 +193,7 @@ def _enter_pdb(node, excinfo, rep):
     tw.sep(">", "entering PDB")
     tb = _postmortem_traceback(excinfo)
     rep._pdbshown = True
-    if post_mortem(tb):
-        outcomes.exit("Quitting debugger")
+    post_mortem(tb)
     return rep
 
 
@@ -220,4 +224,5 @@ def get_stack(self, f, t):
     p = Pdb()
     p.reset()
     p.interaction(None, t)
-    return p.quitting
+    if p.quitting:
+        outcomes.exit("Quitting debugger")

testing/test_pdb.py

@@ -147,29 +147,6 @@ def test_func():
         assert rep.failed
         assert len(pdblist) == 1
 
-    def test_pdb_interaction(self, testdir):
-        p1 = testdir.makepyfile(
-            """
-            def test_1():
-                i = 0
-                assert i == 1
-
-            def test_not_called_due_to_quit():
-                pass
-        """
-        )
-        child = testdir.spawn_pytest("--pdb %s" % p1)
-        child.expect(".*def test_1")
-        child.expect(".*i = 0")
-        child.expect("Pdb")
-        child.sendeof()
-        rest = child.read().decode("utf8")
-        assert "= 1 failed in" in rest
-        assert "def test_1" not in rest
-        assert "Exit: Quitting debugger" in rest
-        assert "PDB continue (IO-capturing resumed)" not in rest
-        self.flush(child)
-
     @staticmethod
     def flush(child):
         if platform.system() == "Darwin":
@@ -214,40 +191,32 @@ def test_one(self):
         child.sendeof()
         self.flush(child)
 
-    def test_pdb_print_captured_stdout(self, testdir):
+    def test_pdb_print_captured_stdout_and_stderr(self, testdir):
         p1 = testdir.makepyfile(
             """
             def test_1():
+                import sys
+                sys.stderr.write("get\\x20rekt")
                 print("get\\x20rekt")
                 assert False
+
+            def test_not_called_due_to_quit():
+                pass
         """
         )
         child = testdir.spawn_pytest("--pdb %s" % p1)
         child.expect("captured stdout")
         child.expect("get rekt")
-        child.expect("Pdb")
-        child.sendeof()
-        rest = child.read().decode("utf8")
-        assert "1 failed" in rest
-        assert "get rekt" not in rest
-        self.flush(child)
-
-    def test_pdb_print_captured_stderr(self, testdir):
-        p1 = testdir.makepyfile(
-            """
-            def test_1():
-                import sys
-                sys.stderr.write("get\\x20rekt")
-                assert False
-        """
-        )
-        child = testdir.spawn_pytest("--pdb %s" % p1)
         child.expect("captured stderr")
         child.expect("get rekt")
+        child.expect("traceback")
+        child.expect("def test_1")
         child.expect("Pdb")
         child.sendeof()
         rest = child.read().decode("utf8")
-        assert "1 failed" in rest
+        assert "Exit: Quitting debugger" in rest
+        assert "= 1 failed in" in rest
+        assert "def test_1" not in rest
         assert "get rekt" not in rest
         self.flush(child)
 
@@ -375,15 +344,17 @@ def test_1():
                 i = 0
                 print("hello17")
                 pytest.set_trace()
-                x = 3
+                i == 1
+                assert 0
         """
         )
         child = testdir.spawn_pytest(str(p1))
-        child.expect("test_1")
-        child.expect("x = 3")
+        child.expect(r"test_1\(\)")
+        child.expect("i == 1")
         child.expect("Pdb")
-        child.sendeof()
+        child.sendline("c")
         rest = child.read().decode("utf-8")
+        assert "AssertionError" in rest
         assert "1 failed" in rest
         assert "def test_1" in rest
         assert "hello17" in rest  # out is captured
@@ -402,9 +373,9 @@ def test_1():
         child.expect("Pdb")
         child.sendeof()
         rest = child.read().decode("utf8")
-        assert "1 failed" in rest
+        assert "no tests ran" in rest
         assert "reading from stdin while output" not in rest
-        assert "BdbQuit" in rest
+        assert "BdbQuit" not in rest
         self.flush(child)
 
     def test_pdb_and_capsys(self, testdir):
@@ -496,6 +467,7 @@ def test_1():
                 print("hello18")
                 pytest.set_trace()
                 x = 4
+                assert 0
         """
         )
         child = testdir.spawn_pytest(str(p1))
@@ -508,11 +480,11 @@ def test_1():
         child.expect(r"PDB set_trace \(IO-capturing turned off\)")
         child.expect("x = 4")
         child.expect("Pdb")
-        child.sendeof()
+        child.sendline("c")
         child.expect("_ test_1 _")
         child.expect("def test_1")
-        child.expect("Captured stdout call")
         rest = child.read().decode("utf8")
+        assert "Captured stdout call" in rest
         assert "hello17" in rest  # out is captured
         assert "hello18" in rest  # out is captured
         assert "1 failed" in rest
@@ -781,15 +753,26 @@ def test_trace_sets_breakpoint(self, testdir):
             """
             def test_1():
                 assert True
+
+            def test_2():
+                pass
+
+            def test_3():
+                pass
             """
         )
         child = testdir.spawn_pytest("--trace " + str(p1))
         child.expect("test_1")
         child.expect("Pdb")
-        child.sendeof()
+        child.sendline("c")
+        child.expect("test_2")
+        child.expect("Pdb")
+        child.sendline("q")
+        child.expect_exact("Exit: Quitting debugger")
         rest = child.read().decode("utf8")
-        assert "1 passed" in rest
+        assert "1 passed in" in rest
         assert "reading from stdin while output" not in rest
+        assert "Exit: Quitting debugger" in child.before.decode("utf8")
         TestPDB.flush(child)
 
     def test_trace_against_yield_test(self, testdir):
@@ -805,7 +788,7 @@ def test_1():
         child = testdir.spawn_pytest("--trace " + str(p1))
         child.expect("is_equal")
         child.expect("Pdb")
-        child.sendeof()
+        child.sendline("c")
         rest = child.read().decode("utf8")
         assert "1 passed" in rest
         assert "reading from stdin while output" not in rest