Fix one history test

TODO:
- prompt-toolkit history isn't properly initialized with history from a persistent history file, as shown by the remaining failing history test

Author: tleonhardt

cmd2/cmd2.py

@@ -413,7 +413,15 @@ def __init__(
         # Commands to exclude from the help menu and tab completion
         self.hidden_commands = ['eof', '_relative_run_script']
 
-        # Initialize history
+        # Initialize prompt-toolkit PromptSession
+        self.history_adapter = Cmd2History(self)
+        self.completer = Cmd2Completer(self)
+        self.session: PromptSession[str] = PromptSession(
+            history=self.history_adapter,
+            completer=self.completer,
+        )
+
+        # Initialize history from a persistent history file (if present)
         self.persistent_history_file = ''
         self._persistent_history_length = persistent_history_length
         self._initialize_history(persistent_history_file)
@@ -462,14 +470,6 @@ def __init__(
         # The multiline command currently being typed which is used to tab complete multiline commands.
         self._multiline_in_progress = ''
 
-        # Initialize PromptSession
-        self.history_adapter = Cmd2History(self)
-        self.completer = Cmd2Completer(self)
-        self.session: PromptSession[str] = PromptSession(
-            history=self.history_adapter,
-            completer=self.completer,
-        )
-
         # Characters used to draw a horizontal rule. Should not be blank.
         self.ruler = "─"
 

tests/test_history.py

@@ -28,19 +28,25 @@ def verify_hi_last_result(app: cmd2.Cmd, expected_length: int) -> None:
 
 
 #
-# readline tests
+# prompt-toolkit tests
 #
-def test_readline_remove_history_item() -> None:
-    from cmd2.rl_utils import (
-        readline,
-    )
+def test_pt_add_history_item() -> None:
+    from prompt_toolkit import PromptSession
+    from prompt_toolkit.history import InMemoryHistory
+
+    # Create a history object and add some initial items
+    history = InMemoryHistory()
+    history.append_string('command one')
+    history.append_string('command two')
+    assert 'command one' in history.get_strings()
+    assert len(history.get_strings()) == 2
+
+    # Start a session and use this history
+    session = PromptSession(history=history)
 
-    readline.clear_history()
-    assert readline.get_current_history_length() == 0
-    readline.add_history('this is a test')
-    assert readline.get_current_history_length() == 1
-    readline.remove_history_item(0)
-    assert readline.get_current_history_length() == 0
+    session.history.get_strings().append('new command')
+    assert 'new command' not in session.history.get_strings()
+    assert len(history.get_strings()) == 2
 
 
 #
@@ -949,7 +955,7 @@ def test_history_file_bad_json(mocker, capsys) -> None:
     assert 'Error processing persistent history data' in err
 
 
-def test_history_populates_readline(hist_file) -> None:
+def test_history_populates_pt(hist_file) -> None:
     # - create a cmd2 with persistent history
     app = cmd2.Cmd(persistent_history_file=hist_file)
     run_cmd(app, 'help')
@@ -967,17 +973,14 @@ def test_history_populates_readline(hist_file) -> None:
     assert app.history.get(3).statement.raw == 'shortcuts'
     assert app.history.get(4).statement.raw == 'alias'
 
-    # readline only adds a single entry for multiple sequential identical commands
+    # prompt-toolkit only adds a single entry for multiple sequential identical commands
     # so we check to make sure that cmd2 populated the readline history
     # using the same rules
-    from cmd2.rl_utils import (
-        readline,
-    )
-
-    assert readline.get_current_history_length() == 3
-    assert readline.get_history_item(1) == 'help'
-    assert readline.get_history_item(2) == 'shortcuts'
-    assert readline.get_history_item(3) == 'alias'
+    pt_history = app.session.history.get_strings()
+    assert len(pt_history) == 3
+    assert pt_history.get(1) == 'help'
+    assert pt_history.get(2) == 'shortcuts'
+    assert pt_history.get(3) == 'alias'
 
 
 #