tests(refactor): Update tests for DeprecatedError behavior (#611)

why: Tests need to verify DeprecatedError is raised for legacy APIs.
what:
- Update legacy_api tests to use pytest.raises(DeprecatedError)
- Update other tests to use new APIs instead of deprecated ones
- Use namespace imports for exception classes

Author: tony

tests/legacy_api/test_common.py

@@ -1,4 +1,8 @@
-"""Tests for utility functions in libtmux."""
+"""Tests for utility functions in libtmux.
+
+Note: This file tests common utilities, not deprecated APIs.
+The tests use the current API.
+"""
 
 from __future__ import annotations
 
@@ -9,6 +13,7 @@
 import pytest
 
 import libtmux
+from libtmux import exc
 from libtmux._compat import LooseVersion
 from libtmux.common import (
     TMUX_MAX_VERSION,
@@ -24,7 +29,6 @@
     session_check_name,
     tmux_cmd,
 )
-from libtmux.exc import BadSessionName, LibTmuxException, TmuxCommandNotFound
 
 if t.TYPE_CHECKING:
     from libtmux.session import Session
@@ -100,7 +104,7 @@ def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> Hi:
         return Hi()
 
     monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
-    with pytest.raises(LibTmuxException) as exc_info:
+    with pytest.raises(exc.LibTmuxException) as exc_info:
         get_version()
     exc_info.match("does not meet the minimum tmux version requirement")
 
@@ -135,11 +139,11 @@ def mock_get_version() -> LooseVersion:
         return LooseVersion("1.7")
 
     monkeypatch.setattr(libtmux.common, "get_version", mock_get_version)
-    with pytest.raises(LibTmuxException) as excinfo:
+    with pytest.raises(exc.LibTmuxException) as excinfo:
         has_minimum_version()
         excinfo.match(r"libtmux only supports")
 
-    with pytest.raises(LibTmuxException) as excinfo:
+    with pytest.raises(exc.LibTmuxException) as excinfo:
         has_minimum_version()
 
         excinfo.match(r"libtmux only supports")
@@ -191,7 +195,7 @@ def test_has_lte_version() -> None:
 def test_tmux_cmd_raises_on_not_found(monkeypatch: pytest.MonkeyPatch) -> None:
     """Verify raises if tmux command not found."""
     monkeypatch.setenv("PATH", "")
-    with pytest.raises(TmuxCommandNotFound):
+    with pytest.raises(exc.TmuxCommandNotFound):
         tmux_cmd("-V")
 
 
@@ -226,7 +230,7 @@ def test_session_check_name(
 ) -> None:
     """Verify session_check_name()."""
     if raises:
-        with pytest.raises(BadSessionName) as exc_info:
+        with pytest.raises(exc.BadSessionName) as exc_info:
             session_check_name(session_name)
         if exc_msg_regex is not None:
             assert exc_info.match(exc_msg_regex)

tests/legacy_api/test_pane.py

@@ -1,98 +1,71 @@
-"""Tests for libtmux Pane object."""
+"""Tests for deprecated libtmux Pane APIs.
+
+These tests verify that deprecated methods raise DeprecatedError.
+"""
 
 from __future__ import annotations
 
-import logging
-import shutil
 import typing as t
 
-if t.TYPE_CHECKING:
-    from libtmux.session import Session
-
-logger = logging.getLogger(__name__)
-
-
-def test_resize_pane(session: Session) -> None:
-    """Test Pane.resize_pane()."""
-    window = session.attached_window
-    window.rename_window("test_resize_pane")
-
-    pane1 = window.attached_pane
-    assert pane1 is not None
-    pane1_height = pane1["pane_height"]
-    window.split_window()
+import pytest
 
-    pane1.resize_pane(height=4)
-    assert pane1["pane_height"] != pane1_height
-    assert int(pane1["pane_height"]) == 4
+from libtmux import exc
 
-    pane1.resize_pane(height=3)
-    assert int(pane1["pane_height"]) == 3
+if t.TYPE_CHECKING:
+    from libtmux.session import Session
 
 
-def test_send_keys(session: Session) -> None:
-    """Verify Pane.send_keys()."""
-    pane = session.attached_window.attached_pane
+def test_resize_pane_raises_deprecated_error(session: Session) -> None:
+    """Test Pane.resize_pane() raises DeprecatedError."""
+    window = session.active_window
+    pane = window.active_pane
     assert pane is not None
-    pane.send_keys("c-c", literal=True)
 
-    pane_contents = "\n".join(pane.cmd("capture-pane", "-p").stdout)
-    assert "c-c" in pane_contents
+    with pytest.raises(
+        exc.DeprecatedError, match=r"Pane\.resize_pane\(\) was deprecated"
+    ):
+        pane.resize_pane(height=4)
 
-    pane.send_keys("c-a", literal=False)
-    assert "c-a" not in pane_contents, "should not print to pane"
 
+def test_select_pane_raises_deprecated_error(session: Session) -> None:
+    """Test Pane.select_pane() raises DeprecatedError."""
+    window = session.active_window
+    pane = window.active_pane
+    assert pane is not None
 
-def test_set_height(session: Session) -> None:
-    """Verify Pane.set_height()."""
-    window = session.new_window(window_name="test_set_height")
-    window.split_window()
-    pane1 = window.attached_pane
-    assert pane1 is not None
-    pane1_height = pane1["pane_height"]
-
-    pane1.set_height(4)
-    assert pane1["pane_height"] != pane1_height
-    assert int(pane1["pane_height"]) == 4
+    with pytest.raises(
+        exc.DeprecatedError, match=r"Pane\.select_pane\(\) was deprecated"
+    ):
+        pane.select_pane()
 
 
-def test_set_width(session: Session) -> None:
-    """Verify Pane.set_width()."""
-    window = session.new_window(window_name="test_set_width")
-    window.split_window()
+def test_split_window_raises_deprecated_error(session: Session) -> None:
+    """Test Pane.split_window() raises DeprecatedError."""
+    window = session.active_window
+    pane = window.active_pane
+    assert pane is not None
 
-    window.select_layout("main-vertical")
-    pane1 = window.attached_pane
-    assert pane1 is not None
-    pane1_width = pane1["pane_width"]
+    with pytest.raises(
+        exc.DeprecatedError, match=r"Pane\.split_window\(\) was deprecated"
+    ):
+        pane.split_window()
 
-    pane1.set_width(10)
-    assert pane1["pane_width"] != pane1_width
-    assert int(pane1["pane_width"]) == 10
 
-    pane1.reset()
+def test_pane_get_raises_deprecated_error(session: Session) -> None:
+    """Test Pane.get() raises DeprecatedError."""
+    window = session.active_window
+    pane = window.active_pane
+    assert pane is not None
 
+    with pytest.raises(exc.DeprecatedError, match=r"Pane\.get\(\) was deprecated"):
+        pane.get("pane_id")
 
-def test_capture_pane(session: Session) -> None:
-    """Verify Pane.capture_pane()."""
-    env = shutil.which("env")
-    assert env is not None, "Cannot find usable `env` in PATH."
 
-    session.new_window(
-        attach=True,
-        window_name="capture_pane",
-        window_shell=f"{env} PS1='$ ' sh",
-    )
-    pane = session.attached_window.attached_pane
+def test_pane_getitem_raises_deprecated_error(session: Session) -> None:
+    """Test Pane.__getitem__() raises DeprecatedError."""
+    window = session.active_window
+    pane = window.active_pane
     assert pane is not None
-    pane_contents = "\n".join(pane.capture_pane())
-    assert pane_contents == "$"
-    pane.send_keys(
-        r'printf "\n%s\n" "Hello World !"',
-        literal=True,
-        suppress_history=False,
-    )
-    pane_contents = "\n".join(pane.capture_pane())
-    assert pane_contents == r'$ printf "\n%s\n" "Hello World !"{}'.format(
-        "\n\nHello World !\n$",
-    )
+
+    with pytest.raises(exc.DeprecatedError, match=r"Pane\[key\] lookup was deprecated"):
+        _ = pane["pane_id"]