Add tests for legacy API

Author: tony

tests/legacy_api/__init__.py

@@ -0,0 +1,212 @@
+"""Tests for utility functions in libtmux."""
+
+import re
+import sys
+import typing as t
+from typing import Optional
+
+import pytest
+
+import libtmux
+from libtmux._compat import LooseVersion
+from libtmux.common import (
+    TMUX_MAX_VERSION,
+    TMUX_MIN_VERSION,
+    get_libtmux_version,
+    get_version,
+    has_gt_version,
+    has_gte_version,
+    has_lt_version,
+    has_lte_version,
+    has_minimum_version,
+    has_version,
+    session_check_name,
+    tmux_cmd,
+)
+from libtmux.exc import BadSessionName, LibTmuxException, TmuxCommandNotFound
+from libtmux.session import Session
+
+version_regex = re.compile(r"([0-9]\.[0-9])|(master)")
+
+
+def test_allows_master_version(monkeypatch: pytest.MonkeyPatch) -> None:
+    class Hi:
+        stdout = ["tmux master"]
+        stderr = None
+
+    def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> Hi:
+        return Hi()
+
+    monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
+
+    assert has_minimum_version()
+    assert has_gte_version(TMUX_MIN_VERSION)
+    assert has_gt_version(TMUX_MAX_VERSION), "Greater than the max-supported version"
+    assert (
+        "%s-master" % TMUX_MAX_VERSION == get_version()
+    ), "Is the latest supported version with -master appended"
+
+
+def test_allows_next_version(monkeypatch: pytest.MonkeyPatch) -> None:
+    TMUX_NEXT_VERSION = str(float(TMUX_MAX_VERSION) + 0.1)
+
+    class Hi:
+        stdout = [f"tmux next-{TMUX_NEXT_VERSION}"]
+        stderr = None
+
+    def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> Hi:
+        return Hi()
+
+    monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
+
+    assert has_minimum_version()
+    assert has_gte_version(TMUX_MIN_VERSION)
+    assert has_gt_version(TMUX_MAX_VERSION), "Greater than the max-supported version"
+    assert TMUX_NEXT_VERSION == get_version()
+
+
+def test_get_version_openbsd(monkeypatch: pytest.MonkeyPatch) -> None:
+    class Hi:
+        stderr = ["tmux: unknown option -- V"]
+
+    def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> Hi:
+        return Hi()
+
+    monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
+    monkeypatch.setattr(sys, "platform", "openbsd 5.2")
+    assert has_minimum_version()
+    assert has_gte_version(TMUX_MIN_VERSION)
+    assert has_gt_version(TMUX_MAX_VERSION), "Greater than the max-supported version"
+    assert (
+        "%s-openbsd" % TMUX_MAX_VERSION == get_version()
+    ), "Is the latest supported version with -openbsd appended"
+
+
+def test_get_version_too_low(monkeypatch: pytest.MonkeyPatch) -> None:
+    class Hi:
+        stderr = ["tmux: unknown option -- V"]
+
+    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:
+        get_version()
+    exc_info.match("is running tmux 1.3 or earlier")
+
+
+def test_ignores_letter_versions(monkeypatch: pytest.MonkeyPatch) -> None:
+    """Ignore letters such as 1.8b.
+
+    See ticket https://github.com/tmux-python/tmuxp/issues/55.
+
+    In version 0.1.7 this is adjusted to use LooseVersion, in order to
+    allow letters.
+
+    """
+    monkeypatch.setattr(libtmux.common, "TMUX_MIN_VERSION", "1.9a")
+    result = has_minimum_version()
+    assert result
+
+    monkeypatch.setattr(libtmux.common, "TMUX_MIN_VERSION", "1.8a")
+    result = has_minimum_version()
+    assert result
+
+    # Should not throw
+    assert type(has_version("1.8")) is bool
+    assert type(has_version("1.8a")) is bool
+    assert type(has_version("1.9a")) is bool
+
+
+def test_error_version_less_1_7(monkeypatch: pytest.MonkeyPatch) -> None:
+    def mock_get_version() -> LooseVersion:
+        return LooseVersion("1.7")
+
+    monkeypatch.setattr(libtmux.common, "get_version", mock_get_version)
+    with pytest.raises(LibTmuxException) as excinfo:
+        has_minimum_version()
+        excinfo.match(r"libtmux only supports")
+
+    with pytest.raises(LibTmuxException) as excinfo:
+        has_minimum_version()
+
+        excinfo.match(r"libtmux only supports")
+
+
+def test_has_version() -> None:
+    assert has_version(str(get_version()))
+
+
+def test_has_gt_version() -> None:
+    assert has_gt_version("1.6")
+    assert has_gt_version("1.6b")
+
+    assert not has_gt_version("4.0")
+    assert not has_gt_version("4.0b")
+
+
+def test_has_gte_version() -> None:
+    assert has_gte_version("1.6")
+    assert has_gte_version("1.6b")
+    assert has_gte_version(str(get_version()))
+
+    assert not has_gte_version("4.0")
+    assert not has_gte_version("4.0b")
+
+
+def test_has_lt_version() -> None:
+    assert has_lt_version("4.0a")
+    assert has_lt_version("4.0")
+
+    assert not has_lt_version("1.7")
+    assert not has_lt_version(str(get_version()))
+
+
+def test_has_lte_version() -> None:
+    assert has_lte_version("4.0a")
+    assert has_lte_version("4.0")
+    assert has_lte_version(str(get_version()))
+
+    assert not has_lte_version("1.7")
+    assert not has_lte_version("1.7b")
+
+
+def test_tmux_cmd_raises_on_not_found(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setenv("PATH", "")
+    with pytest.raises(TmuxCommandNotFound):
+        tmux_cmd("-V")
+
+
+def test_tmux_cmd_unicode(session: Session) -> None:
+    session.cmd("new-window", "-t", 3, "-n", "юникод", "-F", "Ελληνικά")
+
+
+@pytest.mark.parametrize(
+    "session_name,raises,exc_msg_regex",
+    [
+        ("", True, "may not be empty"),
+        (None, True, "may not be empty"),
+        ("my great session.", True, "may not contain periods"),
+        ("name: great session", True, "may not contain colons"),
+        ("new great session", False, None),
+        ("ajf8a3fa83fads,,,a", False, None),
+    ],
+)
+def test_session_check_name(
+    session_name: Optional[str], raises: bool, exc_msg_regex: Optional[str]
+) -> None:
+    if raises:
+        with pytest.raises(BadSessionName) as exc_info:
+            session_check_name(session_name)
+        if exc_msg_regex is not None:
+            assert exc_info.match(exc_msg_regex)
+    else:
+        session_check_name(session_name)
+
+
+def test_get_libtmux_version() -> None:
+    from libtmux.__about__ import __version__
+
+    version = get_libtmux_version()
+    assert isinstance(version, LooseVersion)
+    assert LooseVersion(__version__) == version

tests/legacy_api/test_common.py

@@ -0,0 +1,88 @@
+"""Tests for libtmux Pane object."""
+import logging
+import shutil
+
+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()
+
+    pane1.resize_pane(height=4)
+    assert pane1["pane_height"] != pane1_height
+    assert int(pane1["pane_height"]) == 4
+
+    pane1.resize_pane(height=3)
+    assert int(pane1["pane_height"]) == 3
+
+
+def test_send_keys(session: Session) -> None:
+    pane = session.attached_window.attached_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
+
+    pane.send_keys("c-a", literal=False)
+    assert "c-a" not in pane_contents, "should not print to pane"
+
+
+def test_set_height(session: Session) -> None:
+    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
+
+
+def test_set_width(session: Session) -> None:
+    window = session.new_window(window_name="test_set_width")
+    window.split_window()
+
+    window.select_layout("main-vertical")
+    pane1 = window.attached_pane
+    assert pane1 is not None
+    pane1_width = pane1["pane_width"]
+
+    pane1.set_width(10)
+    assert pane1["pane_width"] != pane1_width
+    assert int(pane1["pane_width"]) == 10
+
+    pane1.reset()
+
+
+def test_capture_pane(session: Session) -> None:
+    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
+    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$"
+    )