fix: resolve pre-commit cspell, codespell, and pydoclint violations

- Add cspell:ignore directives for pytest fixture names and ANSI escape
  substrings that trigger false positives
- Replace terminal name that triggered codespell false positive
- Add Args sections to test docstrings for fixture parameters
- Rename test db file to avoid cspell-flagged word

Author: shatakshiiii

tests/unit/utils/test_ansi.py

@@ -1,3 +1,4 @@
+# cspell:ignore capsys
 """Tests for the ansi module."""
 
 from __future__ import annotations
@@ -22,7 +23,11 @@
 
 
 def test_changed_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test changed output with color enabled."""
+    """Test changed output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     changed(color=True, message="something changed")
     captured = capsys.readouterr()
     assert Color.YELLOW in captured.out
@@ -31,111 +36,175 @@ def test_changed_with_color(capsys: pytest.CaptureFixture[str]) -> None:
 
 
 def test_changed_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test changed output without color."""
+    """Test changed output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     changed(color=False, message="something changed")
     captured = capsys.readouterr()
     assert captured.out.strip() == "something changed"
     assert Color.YELLOW not in captured.out
 
 
 def test_failed_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test failed output with color enabled."""
+    """Test failed output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     failed(color=True, message="it failed")
     captured = capsys.readouterr()
     assert Color.RED in captured.out
     assert "it failed" in captured.out
 
 
 def test_failed_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test failed output without color."""
+    """Test failed output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     failed(color=False, message="it failed")
     assert capsys.readouterr().out.strip() == "it failed"
 
 
 def test_info_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test info output with color enabled."""
+    """Test info output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     info(color=True, message="some info")
     captured = capsys.readouterr()
     assert Color.CYAN in captured.out
     assert "some info" in captured.out
 
 
 def test_info_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test info output without color."""
+    """Test info output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     info(color=False, message="some info")
     assert capsys.readouterr().out.strip() == "some info"
 
 
 def test_subtle_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test subtle output with color enabled."""
+    """Test subtle output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     subtle(color=True, message="subtle msg")
     captured = capsys.readouterr()
     assert Color.GREY in captured.out
     assert "subtle msg" in captured.out
 
 
 def test_subtle_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test subtle output without color."""
+    """Test subtle output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     subtle(color=False, message="subtle msg")
     assert capsys.readouterr().out.strip() == "subtle msg"
 
 
 def test_success_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test success output with color enabled."""
+    """Test success output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     success(color=True, message="it worked")
     captured = capsys.readouterr()
     assert Color.GREEN in captured.out
     assert "it worked" in captured.out
 
 
 def test_success_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test success output without color."""
+    """Test success output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     success(color=False, message="it worked")
     assert capsys.readouterr().out.strip() == "it worked"
 
 
 def test_warning_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test warning output with color enabled."""
+    """Test warning output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     warning(color=True, message="be careful")
     captured = capsys.readouterr()
     assert Color.YELLOW in captured.out
     assert "be careful" in captured.out
 
 
 def test_warning_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test warning output without color."""
+    """Test warning output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     warning(color=False, message="be careful")
     assert capsys.readouterr().out.strip() == "be careful"
 
 
 def test_working_with_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test working output with color enabled."""
+    """Test working output with color enabled.
+
+    Args:
+        capsys: The capsys fixture
+    """
     working(color=True, message="processing")
     captured = capsys.readouterr()
     assert Color.GREY in captured.out
     assert "processing" in captured.out
 
 
 def test_working_without_color(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test working output without color."""
+    """Test working output without color.
+
+    Args:
+        capsys: The capsys fixture
+    """
     working(color=False, message="processing")
     assert capsys.readouterr().out.strip() == "processing"
 
 
 def test_blank_line(capsys: pytest.CaptureFixture[str]) -> None:
-    """Test blank line output."""
+    """Test blank line output.
+
+    Args:
+        capsys: The capsys fixture
+    """
     blank_line()
     assert capsys.readouterr().out == "\n"
 
 
 def test_prompt_enter(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_enter with normal input."""
+    """Test prompt_enter with normal input.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr("builtins.input", lambda _: "")
     prompt_enter()
 
 
 def test_prompt_enter_keyboard_interrupt(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_enter exits on KeyboardInterrupt."""
+    """Test prompt_enter exits on KeyboardInterrupt.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     def raise_keyboard_interrupt(_: str) -> None:
         raise KeyboardInterrupt
 
@@ -146,25 +215,41 @@ def raise_keyboard_interrupt(_: str) -> None:
 
 
 def test_prompt_yn_yes(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_yn returns True for 'y'."""
+    """Test prompt_yn returns True for 'y'.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr("builtins.input", lambda _: "y")
     assert prompt_yn("Continue?") is True
 
 
 def test_prompt_yn_empty(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_yn returns True for empty input (default yes)."""
+    """Test prompt_yn returns True for empty input (default yes).
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr("builtins.input", lambda _: "")
     assert prompt_yn("Continue?") is True
 
 
 def test_prompt_yn_no(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_yn returns False for 'n'."""
+    """Test prompt_yn returns False for 'n'.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr("builtins.input", lambda _: "n")
     assert prompt_yn("Continue?") is False
 
 
 def test_prompt_yn_keyboard_interrupt(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test prompt_yn exits on KeyboardInterrupt."""
+    """Test prompt_yn exits on KeyboardInterrupt.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     def raise_keyboard_interrupt(_: str) -> None:
         raise KeyboardInterrupt
 

tests/unit/utils/test_functions_extended.py

@@ -1,3 +1,4 @@
+# cspell:ignore capsys mred mcolored
 """Tests for additional functions in the functions module."""
 
 from __future__ import annotations
@@ -30,7 +31,11 @@
 
 
 def test_check_for_ansible_found(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test check_for_ansible when ansible-playbook is found."""
+    """Test check_for_ansible when ansible-playbook is found.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr(shutil, "which", lambda _: "/usr/bin/ansible-playbook")
     messages, exit_messages = check_for_ansible()
     assert len(messages) == 1
@@ -39,7 +44,11 @@ def test_check_for_ansible_found(monkeypatch: pytest.MonkeyPatch) -> None:
 
 
 def test_check_for_ansible_not_found(monkeypatch: pytest.MonkeyPatch) -> None:
-    """Test check_for_ansible when ansible-playbook is not found."""
+    """Test check_for_ansible when ansible-playbook is not found.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+    """
     monkeypatch.setattr(shutil, "which", lambda _: None)
     messages, exit_messages = check_for_ansible()
     assert not messages
@@ -48,7 +57,11 @@ def test_check_for_ansible_not_found(monkeypatch: pytest.MonkeyPatch) -> None:
 
 
 def test_check_playbook_type_file(tmp_path: Path) -> None:
-    """Test check_playbook_type with an existing file."""
+    """Test check_playbook_type with an existing file.
+
+    Args:
+        tmp_path: The tmp_path fixture
+    """
     playbook = tmp_path / "playbook.yml"
     playbook.write_text("---")
     assert check_playbook_type(str(playbook)) == "file"
@@ -68,7 +81,12 @@ def test_clear_screen_vscode(
     monkeypatch: pytest.MonkeyPatch,
     capsys: pytest.CaptureFixture[str],
 ) -> None:
-    """Test clear_screen prints blank lines in vscode terminal."""
+    """Test clear_screen prints blank lines in vscode terminal.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+        capsys: The capsys fixture
+    """
     monkeypatch.setenv("TERM_PROGRAM", "vscode")
     fake_size = type("TermSize", (), {"lines": 5, "columns": 80})()
     with patch("ansible_navigator.utils.functions.shutil.get_terminal_size", return_value=fake_size):
@@ -81,8 +99,13 @@ def test_clear_screen_normal(
     monkeypatch: pytest.MonkeyPatch,
     capsys: pytest.CaptureFixture[str],
 ) -> None:
-    """Test clear_screen does nothing in normal terminal."""
-    monkeypatch.setenv("TERM_PROGRAM", "iterm")
+    """Test clear_screen does nothing in normal terminal.
+
+    Args:
+        monkeypatch: The monkeypatch fixture
+        capsys: The capsys fixture
+    """
+    monkeypatch.setenv("TERM_PROGRAM", "gnome-terminal")
     clear_screen()
     captured = capsys.readouterr()
     assert captured.out == ""
@@ -293,7 +316,11 @@ def test_timestamp_to_iso_invalid_tz() -> None:
 
 
 def test_time_stamp_for_file_exists(tmp_path: Path) -> None:
-    """Test time_stamp_for_file with existing file."""
+    """Test time_stamp_for_file with existing file.
+
+    Args:
+        tmp_path: The tmp_path fixture
+    """
     test_file = tmp_path / "test.txt"
     test_file.write_text("content")
     modified, iso_stamp = time_stamp_for_file(str(test_file), "UTC")

tests/unit/utils/test_key_value_store_extended.py

@@ -164,6 +164,6 @@ def test_open_method(kvs: KeyValueStore) -> None:
 
 def test_init_with_path_object(tmp_path: Path) -> None:
     """Test initialization with a Path object."""
-    kvs = KeyValueStore(tmp_path / "pathobj.db")
+    kvs = KeyValueStore(tmp_path / "path_test.db")
     kvs["test"] = "value"
     assert kvs["test"] == "value"