|
| 1 | +import logging |
| 2 | +import os |
| 3 | +import typing as t |
| 4 | + |
| 5 | +import pytest |
| 6 | + |
| 7 | +from _pytest.fixtures import SubRequest |
| 8 | +from _pytest.monkeypatch import MonkeyPatch |
| 9 | + |
| 10 | +from libtmux import exc |
| 11 | +from libtmux.common import which |
| 12 | +from libtmux.server import Server |
| 13 | +from libtmux.test import TEST_SESSION_PREFIX, get_test_session_name, namer |
| 14 | + |
| 15 | +if t.TYPE_CHECKING: |
| 16 | + from libtmux.session import Session |
| 17 | + |
| 18 | +logger = logging.getLogger(__name__) |
| 19 | + |
| 20 | + |
| 21 | +@pytest.fixture(autouse=True) |
| 22 | +def clear_env(monkeypatch: MonkeyPatch) -> None: |
| 23 | + """Clear out any unnecessary environment variables that could interrupt tests. |
| 24 | +
|
| 25 | + tmux show-environment tests were being interrupted due to a lot of crazy env vars. |
| 26 | + """ |
| 27 | + for k, v in os.environ.items(): |
| 28 | + if not any( |
| 29 | + needle in k.lower() |
| 30 | + for needle in [ |
| 31 | + "window", |
| 32 | + "tmux", |
| 33 | + "pane", |
| 34 | + "session", |
| 35 | + "pytest", |
| 36 | + "path", |
| 37 | + "pwd", |
| 38 | + "shell", |
| 39 | + "home", |
| 40 | + "xdg", |
| 41 | + "disable_auto_title", |
| 42 | + "lang", |
| 43 | + "term", |
| 44 | + ] |
| 45 | + ): |
| 46 | + monkeypatch.delenv(k) |
| 47 | + |
| 48 | + |
| 49 | +@pytest.fixture(scope="function") |
| 50 | +def server(request: SubRequest, monkeypatch: MonkeyPatch) -> Server: |
| 51 | + |
| 52 | + t = Server() |
| 53 | + t.socket_name = "tmuxp_test%s" % next(namer) |
| 54 | + |
| 55 | + def fin() -> None: |
| 56 | + t.kill_server() |
| 57 | + |
| 58 | + request.addfinalizer(fin) |
| 59 | + |
| 60 | + return t |
| 61 | + |
| 62 | + |
| 63 | +@pytest.fixture(scope="function") |
| 64 | +def session(request: SubRequest, server: Server) -> "Session": |
| 65 | + session_name = "tmuxp" |
| 66 | + |
| 67 | + if not server.has_session(session_name): |
| 68 | + server.cmd("new-session", "-d", "-s", session_name) |
| 69 | + |
| 70 | + # find current sessions prefixed with tmuxp |
| 71 | + old_test_sessions = [] |
| 72 | + for s in server._sessions: |
| 73 | + old_name = s.get("session_name") |
| 74 | + if old_name is not None and old_name.startswith(TEST_SESSION_PREFIX): |
| 75 | + old_test_sessions.append(old_name) |
| 76 | + |
| 77 | + TEST_SESSION_NAME = get_test_session_name(server=server) |
| 78 | + |
| 79 | + try: |
| 80 | + session = server.new_session(session_name=TEST_SESSION_NAME) |
| 81 | + except exc.LibTmuxException as e: |
| 82 | + raise e |
| 83 | + |
| 84 | + """ |
| 85 | + Make sure that tmuxp can :ref:`test_builder_visually` and switches to |
| 86 | + the newly created session for that testcase. |
| 87 | + """ |
| 88 | + session_id = session.get("session_id") |
| 89 | + assert session_id is not None |
| 90 | + |
| 91 | + try: |
| 92 | + server.switch_client(target_session=session_id) |
| 93 | + except exc.LibTmuxException: |
| 94 | + # server.attach_session(session.get('session_id')) |
| 95 | + pass |
| 96 | + |
| 97 | + for old_test_session in old_test_sessions: |
| 98 | + logger.debug("Old test test session %s found. Killing it." % old_test_session) |
| 99 | + server.kill_session(old_test_session) |
| 100 | + assert TEST_SESSION_NAME == session.get("session_name") |
| 101 | + assert TEST_SESSION_NAME != "tmuxp" |
| 102 | + |
| 103 | + return session |
| 104 | + |
| 105 | + |
| 106 | +@pytest.fixture(autouse=True) |
| 107 | +def add_doctest_fixtures( |
| 108 | + doctest_namespace: t.Dict[str, t.Any], |
| 109 | + # usefixtures / autouse |
| 110 | + clear_env: t.Any, |
| 111 | + # Normal fixtures |
| 112 | + server: "Server", |
| 113 | + session: "Session", |
| 114 | +) -> None: |
| 115 | + if which("tmux"): |
| 116 | + doctest_namespace["server"] = server |
| 117 | + doctest_namespace["session"] = session |
| 118 | + doctest_namespace["window"] = session.attached_window |
| 119 | + doctest_namespace["pane"] = session.attached_pane |
0 commit comments