TUI: enable arrows + Enter navigation: Assisted by AI

Andersson007 · Andersson007 · commit 1ed7871cfb2e · 2025-09-09T14:53:54.000+02:00
diff --git a/.github/workflows/tox.yml b/.github/workflows/tox.yml
@@ -166,7 +166,7 @@ jobs:
           path: .
 
       - name: Upload coverage data
-        uses: codecov/codecov-action@v5.4.3
+        uses: codecov/codecov-action@v5.5.0
         with:
           name: ${{ matrix.name }}
           fail_ci_if_error: true
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,7 +44,7 @@ repos:
       - id: tox-ini-fmt
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.12.10"
+    rev: "v0.12.12"
     hooks:
       - id: ruff
         entry: sh -c 'ruff check --fix --force-exclude && ruff format --force-exclude'
@@ -146,7 +146,7 @@ repos:
           - flake8-docstrings # uses pydocstyle
 
   - repo: https://github.com/jsh9/pydoclint
-    rev: 0.6.10
+    rev: 0.7.3
     hooks:
       - id: pydoclint
 
diff --git a/src/ansible_navigator/data/ansible-navigator.json b/src/ansible_navigator/data/ansible-navigator.json
@@ -525,7 +525,7 @@
     "required": [
         "ansible-navigator"
     ],
-    "title": "ansible-navigator settings v25",
+    "title": "ansible-navigator settings v24",
     "type": "object",
-    "version": "25"
+    "version": "24"
 }
diff --git a/src/ansible_navigator/data/help.md b/src/ansible_navigator/data/help.md
@@ -33,12 +33,15 @@
 - `[0-9]`                                         Go to menu item
 - `:<number> `                                    Go to menu item
 - `:{{ n|filter }} `                              Template the menu item
+- `arrow up, arrow down`                          Move cursor
+- `enter`                                         Select highlighted item
 
 # Content and tasks
 
 - `[0-9]`                                         Go to task number
 - `:<number>`                                     Go to task number
 - `+, - `                                         Next/Previous task
+- `arrow up, arrow down`                          Next/Previous task
 - `_, :_`                                         Toggle hidden keys
 - `:{{ key|filter }}`                             Template the key's value
 - `:d, :doc`                                      Show the doc for the current task's module
diff --git a/src/ansible_navigator/ui_framework/ui.py b/src/ansible_navigator/ui_framework/ui.py
@@ -1,4 +1,5 @@
 # cspell:ignore KEY_NPAGE, KEY_PPAGE
+# pylint: disable=too-many-lines
 """The main UI renderer."""
 
 from __future__ import annotations
@@ -199,7 +200,12 @@ def __init__(
         self._status_color = 0
         self._screen: Window = curses.initscr()
         self._screen.timeout(refresh)
+        self._screen.keypad(True)  # Enable keypad mode for proper key handling
         self._one_line_input = FormHandlerText(screen=self._screen, ui_config=self._ui_config)
+        # This tracks which visible row to highlight
+        self._highlight_line_offset: int | None = None
+        # This tracks the cursor position in menus
+        self._menu_cursor_pos: int = 0
 
     def clear(self) -> None:
         """Clear the screen."""
@@ -464,7 +470,7 @@ def _display(
         index_width = len(str(count))
 
         keypad = {str(x) for x in range(10)}
-        other_valid_keys = ["+", "-", "_", "KEY_F(5)", "^[", "\x1b"]
+        other_valid_keys = ["+", "-", "_", "KEY_F(5)", "^[", "\x1b", "CURSOR_ENTER"]
 
         while True:
             self._screen.erase()
@@ -479,10 +485,29 @@ def _display(
                 line_index = line_numbers[idx]
                 line_index_str = str(line_index).rjust(index_width)
                 prefix = f"{line_index_str}\u2502"
+                # Apply highlight decoration when this is the selected row
+                if (
+                    indent_heading
+                    and self._highlight_line_offset is not None
+                    and idx == self._highlight_line_offset
+                ):
+                    # Rebuild the line with reverse-video decoration added
+                    highlighted_parts = tuple(
+                        CursesLinePart(
+                            column=lp.column,
+                            string=lp.string,
+                            color=lp.color,
+                            decoration=lp.decoration | curses.A_REVERSE,
+                        )
+                        for lp in line
+                    )
+                    line_to_draw = CursesLine(highlighted_parts)
+                else:
+                    line_to_draw = line
                 self._add_line(
                     window=self._screen,
                     lineno=idx + len(heading),
-                    line=line,
+                    line=line_to_draw,
                     prefix=prefix,
                 )
 
@@ -504,6 +529,14 @@ def _display(
             if await_input:
                 char = self._screen.getch()
                 key = "KEY_F(5)" if char == -1 else curses.keyname(char).decode()
+                # Debug: log the raw char and converted key for troubleshooting
+                self._logger.debug("Raw char: %s, Converted key: '%s'", char, key)
+                # Check for Enter key codes and return a special value for cursor navigation
+                if char in [10, 13]:  # Enter key codes: 10=LF, 13=CR
+                    self._logger.debug(
+                        "Enter key detected! Raw char: %s, setting key to CURSOR_ENTER", char
+                    )
+                    key = "CURSOR_ENTER"
             else:
                 key = "KEY_F(5)"
 
@@ -915,6 +948,19 @@ def _show_menu(
                 showing_indices,
             )
 
+            # Determine which row to highlight, if enabled
+            self._highlight_line_offset = None
+            if self._menu_indices:
+                self._menu_cursor_pos = max(
+                    0,
+                    min(self._menu_cursor_pos, len(self._menu_indices) - 1),
+                )
+                selected_global_index = self._menu_indices[self._menu_cursor_pos]
+                try:
+                    self._highlight_line_offset = showing_indices.index(selected_global_index)
+                except ValueError:
+                    self._highlight_line_offset = None
+
             entry = self._display(
                 lines=menu_lines,
                 line_numbers=line_numbers,
@@ -925,9 +971,52 @@ def _show_menu(
                 await_input=await_input,
             )
 
+            # Debug: log what entry we received
+            self._logger.debug("Received entry: '%s'", entry)
+
+            # Handle arrow navigation for menus when enabled
             if entry in ["KEY_RESIZE", "KEY_DOWN", "KEY_UP", "KEY_NPAGE", "KEY_PPAGE", "^F", "^B"]:
+                if entry in ["KEY_DOWN", "KEY_UP"] and self._menu_indices:
+                    # Move the cursor position
+                    if entry == "KEY_DOWN" and self._menu_cursor_pos < len(self._menu_indices) - 1:
+                        self._menu_cursor_pos += 1
+                        # If moved past the last visible item, scroll down one
+                        if (
+                            self._highlight_line_offset is None
+                            or self._highlight_line_offset >= len(showing_indices) - 1
+                        ):
+                            # Mimic _display scroll down
+                            viewport_height = self._screen_height - len(menu_heading) - 1
+                            self.scroll(
+                                max(
+                                    min(self.scroll() + 1, len(self._menu_indices)),
+                                    viewport_height,
+                                ),
+                            )
+                    elif entry == "KEY_UP" and self._menu_cursor_pos > 0:
+                        self._menu_cursor_pos -= 1
+                        # If moved before the first visible item, scroll up one
+                        if self._highlight_line_offset is None or self._highlight_line_offset <= 0:
+                            viewport_height = self._screen_height - len(menu_heading) - 1
+                            self.scroll(max(self.scroll() - 1, viewport_height))
+                    # Re-render with updated highlight
+                    continue
+                # Otherwise, preserve prior behavior
                 continue
 
+            # Enter key should select the highlighted item for cursor navigation
+            if (
+                entry == "CURSOR_ENTER" or entry in ["^J", "^M", "KEY_ENTER", "KEY_RETURN"]
+            ) and self._menu_indices:
+                self._logger.debug(
+                    "Enter key selection triggered! Entry: '%s', Selecting index %s",
+                    entry,
+                    self._menu_cursor_pos,
+                )
+                index_to_select = self._menu_indices[self._menu_cursor_pos]
+                entry = str(index_to_select)
+                self._logger.debug("Changed entry to: '%s'", entry)
+
             name, action = self._template_match_action(entry, current)
             if name and action:
                 if name == "select":
diff --git a/tests/integration/_interactions.py b/tests/integration/_interactions.py
@@ -6,6 +6,7 @@
 
 from enum import Enum
 from typing import NamedTuple
+from typing import TypedDict
 
 
 class SearchFor(Enum):
@@ -61,6 +62,64 @@ def join(self) -> str:
         return cmd
 
 
+class Action(TypedDict):
+    """A definition of an action."""
+
+    #: The action to be performed
+    value: str
+    #: A comment to be added to the fixture file
+    comment: str | None
+    #: The key to be pressed
+    keystroke: str
+
+
+# A list of actions that can be performed
+# The value is the name of the action, which is also the name of the file
+# The keystroke is the key that will be sent to the TUI
+# The comment is a comment that will be added to the fixture file
+# The last entry in the list is the one that will be used for the test
+# if the test is run with the --update-fixtures option
+ACTIONS: dict[str, list[Action]] = {
+    "0": [{"value": "0", "keystroke": "0", "comment": None}],
+    "1": [{"value": "1", "keystroke": "1", "comment": None}],
+    "2": [{"value": "2", "keystroke": "2", "comment": None}],
+    "3": [{"value": "3", "keystroke": "3", "comment": None}],
+    "4": [{"value": "4", "keystroke": "4", "comment": None}],
+    "5": [{"value": "5", "keystroke": "5", "comment": None}],
+    "6": [{"value": "6", "keystroke": "6", "comment": None}],
+    "7": [{"value": "7", "keystroke": "7", "comment": None}],
+    "8": [{"value": "8", "keystroke": "8", "comment": None}],
+    "9": [{"value": "9", "keystroke": "9", "comment": None}],
+    "10": [{"value": "10", "keystroke": "10", "comment": None}],
+    "11": [{"value": "11", "keystroke": "11", "comment": None}],
+    "12": [{"value": "12", "keystroke": "12", "comment": None}],
+    "13": [{"value": "13", "keystroke": "13", "comment": None}],
+    "14": [{"value": "14", "keystroke": "14", "comment": None}],
+    "15": [{"value": "15", "keystroke": "15", "comment": None}],
+    "16": [{"value": "16", "keystroke": "16", "comment": None}],
+    "17": [{"value": "17", "keystroke": "17", "comment": None}],
+    "18": [{"value": "18", "keystroke": "18", "comment": None}],
+    "19": [{"value": "19", "keystroke": "19", "comment": None}],
+    "20": [{"value": "20", "keystroke": "20", "comment": None}],
+    "21": [{"value": "21", "keystroke": "21", "comment": None}],
+    "22": [{"value": "22", "keystroke": "22", "comment": None}],
+    "23": [{"value": "23", "keystroke": "23", "comment": None}],
+    "24": [{"value": "24", "keystroke": "24", "comment": None}],
+    "25": [{"value": "25", "keystroke": "25", "comment": None}],
+    "26": [{"value": "26", "keystroke": "26", "comment": None}],
+    "27": [{"value": "27", "keystroke": "27", "comment": None}],
+    "28": [{"value": "28", "keystroke": "28", "comment": None}],
+    "29": [{"value": "29", "keystroke": "29", "comment": None}],
+    "30": [{"value": "30", "keystroke": "30", "comment": None}],
+    "down": [{"value": "down", "keystroke": "KEY_DOWN", "comment": "menu down"}],
+    "up": [{"value": "up", "keystroke": "KEY_UP", "comment": "menu up"}],
+    "esc": [{"value": "escape", "keystroke": "KEY_ESCAPE", "comment": "escape"}],
+    "top": [{"value": "top", "keystroke": "KEY_HOME", "comment": "home"}],
+    "bottom": [{"value": "bottom", "keystroke": "KEY_END", "comment": "end"}],
+    "enter": [{"value": "enter", "keystroke": "KEY_ENTER", "comment": "enter"}],
+}
+
+
 class UiTestStep(NamedTuple):
     """A simulated user interaction with the user interface."""
 
diff --git a/tests/integration/actions/collections/base.py b/tests/integration/actions/collections/base.py
@@ -21,27 +21,46 @@
 EXPECTED_COLLECTIONS = ["ansible.builtin", "company_name.coll_1", "company_name.coll_2"]
 
 base_steps = (
-    UiTestStep(user_input=":1", comment="Browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":0", comment="filter_1 plugin docs window"),
+    # In collections list, start at ansible.builtin (0)
+    # Select company_name.coll_1 (1)
+    UiTestStep(user_input="down", comment="select company_name.coll_1"),
+    UiTestStep(user_input="enter", comment="Browse company_name.coll_1 plugins window"),
+    # In company_name.coll_1 plugins list, start at filter_1 (0)
+    UiTestStep(user_input="enter", comment="filter_1 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":1", comment="lookup_1 plugin docs window"),
+    # from filter_1 (0) to lookup_1 (1)
+    UiTestStep(user_input="down", comment="select lookup_1"),
+    UiTestStep(user_input="enter", comment="lookup_1 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":2", comment="mod_1 plugin docs window"),
+    # from lookup_1 (1) to mod_1 (2)
+    UiTestStep(user_input="down", comment="select mod_1"),
+    UiTestStep(user_input="enter", comment="mod_1 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":3", comment="role_full details window"),
+    # from mod_1 (2) to role_full (3)
+    UiTestStep(user_input="down", comment="select role_full"),
+    UiTestStep(user_input="enter", comment="role_full details window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":4", comment="role_minimal details window"),
+    # from role_full (3) to role_minimal (4)
+    UiTestStep(user_input="down", comment="select role_minimal"),
+    UiTestStep(user_input="enter", comment="role_minimal details window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
+    # Back to collections list window
     UiTestStep(
         user_input=":back",
         comment="Back to ansible-navigator collections browse window",
         present=EXPECTED_COLLECTIONS,
     ),
-    UiTestStep(user_input=":2", comment="Browse company_name.coll_2 plugins window"),
-    UiTestStep(user_input=":0", comment="lookup_2 plugin docs window"),
+    # From company_name.coll_1 (1) to company_name.coll_2 (2)
+    UiTestStep(user_input="down", comment="select company_name.coll_2"),
+    UiTestStep(user_input="enter", comment="Browse company_name.coll_2 plugins window"),
+    # In company_name.coll_2, start at lookup_2 (0)
+    UiTestStep(user_input="enter", comment="lookup_2 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_2 plugins window"),
-    UiTestStep(user_input=":1", comment="mod_2 plugin docs window"),
+    # From lookup_2 (0) to mod_2 (1)
+    UiTestStep(user_input="down", comment="select mod_2"),
+    UiTestStep(user_input="enter", comment="mod_2 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_2 plugins window"),
+    # Back to collections list window
     UiTestStep(
         user_input=":back",
         comment="Back to ansible-navigator collections browse window",
@@ -56,28 +75,40 @@
     ),
     # Dismiss the warning
     UiTestStep(
-        user_input="Enter",
+        user_input="enter",
         comment="ansible-navigator collections browse window",
         present=EXPECTED_COLLECTIONS,
     ),
     # and repeat some basic browsing
-    UiTestStep(user_input=":1", comment="Browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":0", comment="filter_1 plugin docs window"),
+    # Select company_name.coll_1 (1)
+    UiTestStep(user_input="down", comment="select company_name.coll_1"),
+    UiTestStep(user_input="enter", comment="Browse company_name.coll_1 plugins window"),
+    # In company_name.coll_1, start at filter_1 (0)
+    UiTestStep(user_input="enter", comment="filter_1 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
-    UiTestStep(user_input=":1", comment="lookup_1 plugin docs window"),
+    # from filter_1 (0) to lookup_1 (1)
+    UiTestStep(user_input="down", comment="select lookup_1"),
+    UiTestStep(user_input="enter", comment="lookup_1 plugin docs window"),
     UiTestStep(user_input=":back", comment="Back to browse company_name.coll_1 plugins window"),
+    # Back to collections list window
     UiTestStep(
         user_input=":back",
         comment="Back to ansible-navigator collections browse window",
         present=EXPECTED_COLLECTIONS,
     ),
+    # From company_name.coll_1 (1) to ansible.builtin (0)
+    UiTestStep(user_input="up", comment="select ansible.builtin"),
     UiTestStep(
-        user_input=":0",
+        user_input="enter",
         comment="Browse ansible.builtin plugins window",
         present=["yum_repository"],
     ),
     UiTestStep(
-        user_input=":1",
+        user_input="down",
+        comment="Browse ansible.builtin.add_host module",
+    ),
+    UiTestStep(
+        user_input="enter",
         comment="Browse ansible.builtin.add_host module",
         present=["ansible.builtin.add_host"],
     ),
