setup tests for the debugger.Debugger class

python · terryjreedy · Nov 19, 2023 · Jan 6, 2019 · Jan 6, 2019 · Jan 6, 2019
commit 35915dafeab0df98dd48e5cd8c1b218d3df718aa
@@ -68,10 +68,30 @@ def __frame2message(self, frame):


 class Debugger:
-
-    vstack = vsource = vlocals = vglobals = None
+    """
+    The debugger interface.
+
+    This class handles the drawing of the debugger window and
+    the interactions with the underlying debugger session.
+    """
+    vstack = None
+    vsource = None
+    vlocals = None
+    vglobals = None
+    stackviewer = None
+    localsviewer = None
+    globalsviewer = None

    def __init__(self, pyshell, idb=None):
+        """
+        Instantiate and draw a debugger window.
+
+        :param pyshell: An instance of the PyShell Window
+        :type  pyshell: :class:`idlelib.pyshell.PyShell`
+
+        :param idb: An instance of the IDLE debugger (optional)
+        :type  idb: :class:`idlelib.debugger.Idb`
+        """
        if idb is None:
            idb = Idb(self)
        self.pyshell = pyshell
@@ -299,8 +319,6 @@ def quit(self):
    def abort_loop(self):
        self.root.tk.call('set', '::idledebugwait', '1')

-    stackviewer = None
-
    def show_stack(self):
        if not self.stackviewer and self.vstack.get():
            self.stackviewer = sv = StackViewer(self.fstack, self.flist, self)
@@ -322,9 +340,6 @@ def show_frame(self, stackitem):
        self.frame = stackitem[0]  # lineno is stackitem[1]
        self.show_variables()

-    localsviewer = None
-    globalsviewer = None
-
    def show_locals(self):
        lv = self.localsviewer
        if self.vlocals.get():
@@ -375,7 +390,7 @@ def clear_file_breaks(self, filename):
        self.idb.clear_all_file_breaks(filename)

    def load_breakpoints(self):
-        "Load PyShellEditorWindow breakpoints into subprocess debugger"
+        """Load PyShellEditorWindow breakpoints into subprocess debugger."""
        for editwin in self.pyshell.flist.inversedict:
            filename = editwin.io.filename
            try:

@@ -4,7 +4,7 @@
 import unittest
 from unittest import mock
 from test.support import requires
-requires('gui')
+# requires('gui')
 from tkinter import Tk
 from textwrap import dedent

@@ -174,5 +174,32 @@ def test_in_rpc_code_debugger_star_dot_py(self):
            assert not idb.in_rpc_code(test_frame2)


+def make_pyshell_mock():
+    """Factory for generating test fixtures of PyShell."""
+    pyshell = mock.Mock()
+    pyshell.root = None
+    return pyshell
+
+
+class DebuggerTest(unittest.TestCase):
+    """Tests for the idlelib.debugger.Debugger class."""
+
+    def test_setup_debugger(self):
+        """Test that Debugger can be instantiated with a mock PyShell."""
+        pyshell = make_pyshell_mock()
+        test_debugger = debugger.Debugger(pyshell)
+
+        assert test_debugger.pyshell == pyshell
+        assert test_debugger.frame is None
+
+    def test_run_debugger(self):
+        """Test Debugger.run() with an Idb instance."""
+        mock_idb = mock.Mock()  # Mocked debugger.Idb
+        test_debugger = debugger.Debugger(make_pyshell_mock(), idb=mock_idb)
+        test_debugger.run()
+        mock_idb.run.assert_called_once()
+        assert test_debugger.interacting == 0
+
+
 if __name__ == '__main__':
    unittest.main(verbosity=2)