1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
"""Tests for tmuxp's utility functions."""
from __future__ import annotations
import sys
import typing as t
import pytest
from tmuxp import exc
from tmuxp.exc import BeforeLoadScriptError, BeforeLoadScriptNotExists
from tmuxp.util import get_session, run_before_script
from .constants import FIXTURE_PATH
if t.TYPE_CHECKING:
import pathlib
from libtmux.server import Server
def test_run_before_script_raise_BeforeLoadScriptNotExists_if_not_exists() -> None:
"""run_before_script() raises BeforeLoadScriptNotExists if script not found."""
script_file = FIXTURE_PATH / "script_noexists.sh"
with pytest.raises(BeforeLoadScriptNotExists):
run_before_script(script_file)
with pytest.raises(OSError):
run_before_script(script_file)
def test_run_before_script_raise_BeforeLoadScriptError_if_retcode() -> None:
"""run_before_script() raises BeforeLoadScriptNotExists if script fails."""
script_file = FIXTURE_PATH / "script_failed.sh"
with pytest.raises(BeforeLoadScriptError):
run_before_script(script_file)
@pytest.fixture
def temp_script(tmp_path: pathlib.Path) -> pathlib.Path:
"""Fixture of an example script that prints "Hello, world!"."""
script = tmp_path / "test_script.sh"
script.write_text(
"""#!/bin/sh
echo "Hello, World!"
exit 0
""",
)
script.chmod(0o755)
return script
class TTYTestFixture(t.NamedTuple):
"""Test fixture for isatty behavior verification."""
test_id: str
isatty_value: bool
expected_output: str
TTY_TEST_FIXTURES: list[TTYTestFixture] = [
TTYTestFixture(
test_id="tty_enabled_shows_output",
isatty_value=True,
expected_output="Hello, World!",
),
TTYTestFixture(
test_id="tty_disabled_suppresses_output",
isatty_value=False,
expected_output="",
),
]
@pytest.mark.parametrize(
list(TTYTestFixture._fields),
TTY_TEST_FIXTURES,
ids=[test.test_id for test in TTY_TEST_FIXTURES],
)
def test_run_before_script_isatty(
temp_script: pathlib.Path,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
test_id: str,
isatty_value: bool,
expected_output: str,
) -> None:
"""Verify behavior of ``isatty()``, which we mock in `run_before_script()`."""
# Mock sys.stdout.isatty() to return the desired value.
monkeypatch.setattr(sys.stdout, "isatty", lambda: isatty_value)
# Run the script.
returncode = run_before_script(temp_script)
# Assert that the script ran successfully.
assert returncode == 0
out, _err = capsys.readouterr()
# In TTY mode, we expect the output; in non-TTY mode, we expect it to be suppressed.
assert expected_output in out
def test_return_stdout_if_ok(
capsys: pytest.CaptureFixture[str],
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""run_before_script() returns stdout if script succeeds."""
# Simulate sys.stdout.isatty() + sys.stderr.isatty()
monkeypatch.setattr(sys.stdout, "isatty", lambda: True)
monkeypatch.setattr(sys.stderr, "isatty", lambda: True)
script_file = FIXTURE_PATH / "script_complete.sh"
run_before_script(script_file)
out, _err = capsys.readouterr()
assert "hello" in out
def test_beforeload_returncode() -> None:
"""run_before_script() returns returncode if script fails."""
script_file = FIXTURE_PATH / "script_failed.sh"
with pytest.raises(exc.BeforeLoadScriptError) as excinfo:
run_before_script(script_file)
assert excinfo.match(r"113")
def test_beforeload_returns_stderr_messages() -> None:
"""run_before_script() returns stderr messages if script fails."""
script_file = FIXTURE_PATH / "script_failed.sh"
with pytest.raises(exc.BeforeLoadScriptError) as excinfo:
run_before_script(script_file)
assert excinfo.match(r"failed with returncode")
def test_get_session_should_default_to_local_attached_session(
server: Server,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""get_session() should launch current terminal's tmux session, if inside one."""
server.new_session(session_name="myfirstsession")
second_session = server.new_session(session_name="mysecondsession")
# Assign an active pane to the session
first_pane_on_second_session_id = second_session.windows[0].panes[0].pane_id
assert first_pane_on_second_session_id is not None
monkeypatch.setenv("TMUX_PANE", first_pane_on_second_session_id)
assert get_session(server) == second_session
def test_get_session_should_return_first_session_if_no_active_session(
server: Server,
) -> None:
"""get_session() should return first session if no active session."""
first_session = server.new_session(session_name="myfirstsession")
server.new_session(session_name="mysecondsession")
assert get_session(server) == first_session
|
