|
| 1 | +"""Tests to verify docstring code examples in common_async.py work correctly. |
| 2 | +
|
| 3 | +These tests ensure that all the code examples shown in docstrings are valid and |
| 4 | +executable. They replace the SKIP'd doctests that provided no verification. |
| 5 | +""" |
| 6 | + |
| 7 | +from __future__ import annotations |
| 8 | + |
| 9 | +import asyncio |
| 10 | +import typing as t |
| 11 | + |
| 12 | +import pytest |
| 13 | + |
| 14 | +from libtmux import Server |
| 15 | +from libtmux.common_async import get_version, tmux_cmd_async |
| 16 | + |
| 17 | +if t.TYPE_CHECKING: |
| 18 | + from libtmux._compat import LooseVersion |
| 19 | + |
| 20 | + |
| 21 | +@pytest.mark.asyncio |
| 22 | +async def test_module_docstring_pattern_a(async_server: Server) -> None: |
| 23 | + """Verify Pattern A example from module docstring works. |
| 24 | +
|
| 25 | + From src/libtmux/common_async.py:14-25 (Pattern A example). |
| 26 | + """ |
| 27 | + import asyncio |
| 28 | + |
| 29 | + import libtmux |
| 30 | + |
| 31 | + async def example() -> list[str]: |
| 32 | + server = libtmux.Server(socket_name=async_server.socket_name) |
| 33 | + result = await server.acmd("list-sessions") |
| 34 | + return result.stdout |
| 35 | + |
| 36 | + result = await example() |
| 37 | + assert isinstance(result, list) |
| 38 | + # Result may be empty if no sessions exist on this socket yet |
| 39 | + |
| 40 | + |
| 41 | +@pytest.mark.asyncio |
| 42 | +async def test_module_docstring_pattern_b(async_server: Server) -> None: |
| 43 | + """Verify Pattern B example from module docstring works. |
| 44 | +
|
| 45 | + From src/libtmux/common_async.py:27-37 (Pattern B example). |
| 46 | + """ |
| 47 | + import asyncio |
| 48 | + |
| 49 | + from libtmux.common_async import tmux_cmd_async |
| 50 | + |
| 51 | + async def example() -> list[str]: |
| 52 | + sock = async_server.socket_name |
| 53 | + result = await tmux_cmd_async("-L", sock, "list-sessions") |
| 54 | + return result.stdout |
| 55 | + |
| 56 | + result = await example() |
| 57 | + assert isinstance(result, list) |
| 58 | + # Result may be empty if no sessions exist on this socket yet |
| 59 | + |
| 60 | + |
| 61 | +@pytest.mark.asyncio |
| 62 | +async def test_module_docstring_concurrent(async_server: Server) -> None: |
| 63 | + """Verify concurrent example from module docstring works. |
| 64 | +
|
| 65 | + From src/libtmux/common_async.py:45-59 (Performance example). |
| 66 | + """ |
| 67 | + import asyncio |
| 68 | + |
| 69 | + from libtmux.common_async import tmux_cmd_async |
| 70 | + |
| 71 | + async def concurrent() -> list[tmux_cmd_async]: |
| 72 | + sock = async_server.socket_name |
| 73 | + results = await asyncio.gather( |
| 74 | + tmux_cmd_async("-L", sock, "list-sessions"), |
| 75 | + tmux_cmd_async("-L", sock, "list-windows", "-a"), |
| 76 | + tmux_cmd_async("-L", sock, "list-panes", "-a"), |
| 77 | + ) |
| 78 | + return results |
| 79 | + |
| 80 | + results = await concurrent() |
| 81 | + assert len(results) == 3 |
| 82 | + # Commands may fail if no sessions exist, but should execute |
| 83 | + assert all(isinstance(r.stdout, list) for r in results) |
| 84 | + |
| 85 | + |
| 86 | +@pytest.mark.asyncio |
| 87 | +async def test_tmux_cmd_async_concurrent_example(async_server: Server) -> None: |
| 88 | + """Verify concurrent operations example from tmux_cmd_async class docstring. |
| 89 | +
|
| 90 | + From src/libtmux/common_async.py:274-289 (Concurrent Operations example). |
| 91 | + """ |
| 92 | + import asyncio |
| 93 | + |
| 94 | + from libtmux.common_async import tmux_cmd_async |
| 95 | + |
| 96 | + async def concurrent_example() -> list[int]: |
| 97 | + sock = async_server.socket_name |
| 98 | + # All commands run concurrently |
| 99 | + results = await asyncio.gather( |
| 100 | + tmux_cmd_async("-L", sock, "list-sessions"), |
| 101 | + tmux_cmd_async("-L", sock, "list-windows", "-a"), |
| 102 | + tmux_cmd_async("-L", sock, "list-panes", "-a"), |
| 103 | + ) |
| 104 | + return [len(r.stdout) for r in results] |
| 105 | + |
| 106 | + counts = await concurrent_example() |
| 107 | + assert len(counts) == 3 |
| 108 | + assert all(isinstance(count, int) for count in counts) |
| 109 | + assert all(count >= 0 for count in counts) |
| 110 | + |
| 111 | + |
| 112 | +@pytest.mark.asyncio |
| 113 | +async def test_tmux_cmd_async_error_handling(async_server: Server) -> None: |
| 114 | + """Verify error handling example from tmux_cmd_async class docstring. |
| 115 | +
|
| 116 | + From src/libtmux/common_async.py:291-304 (Error Handling example). |
| 117 | + """ |
| 118 | + import asyncio |
| 119 | + |
| 120 | + from libtmux.common_async import tmux_cmd_async |
| 121 | + |
| 122 | + async def check_session() -> bool: |
| 123 | + sock = async_server.socket_name |
| 124 | + result = await tmux_cmd_async( |
| 125 | + "-L", |
| 126 | + sock, |
| 127 | + "has-session", |
| 128 | + "-t", |
| 129 | + "nonexistent_session_12345", |
| 130 | + ) |
| 131 | + if result.returncode != 0: |
| 132 | + return False |
| 133 | + return True |
| 134 | + |
| 135 | + result = await check_session() |
| 136 | + assert result is False # Session should not exist |
| 137 | + |
| 138 | + |
| 139 | +@pytest.mark.asyncio |
| 140 | +async def test_get_version_basic() -> None: |
| 141 | + """Verify basic get_version example from function docstring. |
| 142 | +
|
| 143 | + From src/libtmux/common_async.py:428-438 (basic example). |
| 144 | + """ |
| 145 | + import asyncio |
| 146 | + |
| 147 | + from libtmux.common_async import get_version |
| 148 | + |
| 149 | + async def check_version() -> LooseVersion: |
| 150 | + version = await get_version() |
| 151 | + return version |
| 152 | + |
| 153 | + version = await check_version() |
| 154 | + # Verify it's a version object with a string representation |
| 155 | + assert isinstance(str(version), str) |
| 156 | + # Should be something like "3.4" or "3.5" |
| 157 | + assert len(str(version)) > 0 |
| 158 | + # Verify it can be compared |
| 159 | + from libtmux._compat import LooseVersion |
| 160 | + |
| 161 | + assert version >= LooseVersion("1.8") # TMUX_MIN_VERSION |
| 162 | + |
| 163 | + |
| 164 | +@pytest.mark.asyncio |
| 165 | +async def test_get_version_concurrent(async_server: Server) -> None: |
| 166 | + """Verify concurrent get_version example from function docstring. |
| 167 | +
|
| 168 | + From src/libtmux/common_async.py:440-453 (concurrent operations example). |
| 169 | + """ |
| 170 | + import asyncio |
| 171 | + |
| 172 | + from libtmux.common_async import get_version, tmux_cmd_async |
| 173 | + |
| 174 | + async def check_all() -> tuple[LooseVersion, int]: |
| 175 | + sock = async_server.socket_name |
| 176 | + version, sessions = await asyncio.gather( |
| 177 | + get_version(), |
| 178 | + tmux_cmd_async("-L", sock, "list-sessions"), |
| 179 | + ) |
| 180 | + return version, len(sessions.stdout) |
| 181 | + |
| 182 | + version, count = await check_all() |
| 183 | + # Verify version is valid |
| 184 | + assert isinstance(str(version), str) |
| 185 | + # Verify sessions count is reasonable |
| 186 | + assert isinstance(count, int) |
| 187 | + assert count >= 0 # May be 0 if no sessions on socket yet |
| 188 | + |
| 189 | + |
| 190 | +@pytest.mark.asyncio |
| 191 | +async def test_pattern_a_with_error_handling(async_server: Server) -> None: |
| 192 | + """Test Pattern A with proper error handling and verification.""" |
| 193 | + import asyncio |
| 194 | + |
| 195 | + import libtmux |
| 196 | + |
| 197 | + async def example() -> bool: |
| 198 | + server = libtmux.Server(socket_name=async_server.socket_name) |
| 199 | + |
| 200 | + # Create a new session |
| 201 | + result = await server.acmd("new-session", "-d", "-P", "-F#{session_id}") |
| 202 | + session_id = result.stdout[0] |
| 203 | + |
| 204 | + # Verify session exists |
| 205 | + result = await server.acmd("has-session", "-t", session_id) |
| 206 | + success = result.returncode == 0 |
| 207 | + |
| 208 | + # Cleanup |
| 209 | + await server.acmd("kill-session", "-t", session_id) |
| 210 | + |
| 211 | + return success |
| 212 | + |
| 213 | + success = await example() |
| 214 | + assert success is True |
| 215 | + |
| 216 | + |
| 217 | +@pytest.mark.asyncio |
| 218 | +async def test_pattern_b_with_socket_isolation(async_server: Server) -> None: |
| 219 | + """Test Pattern B ensures proper socket isolation.""" |
| 220 | + from libtmux.common_async import tmux_cmd_async |
| 221 | + |
| 222 | + sock = async_server.socket_name |
| 223 | + |
| 224 | + # Create session on isolated socket |
| 225 | + result = await tmux_cmd_async("-L", sock, "new-session", "-d", "-P", "-F#{session_id}") |
| 226 | + session_id = result.stdout[0] |
| 227 | + |
| 228 | + # Verify it exists on the isolated socket |
| 229 | + result = await tmux_cmd_async("-L", sock, "has-session", "-t", session_id) |
| 230 | + assert result.returncode == 0 |
| 231 | + |
| 232 | + # Cleanup |
| 233 | + await tmux_cmd_async("-L", sock, "kill-session", "-t", session_id) |
| 234 | + |
| 235 | + |
| 236 | +@pytest.mark.asyncio |
| 237 | +async def test_concurrent_operations_performance(async_server: Server) -> None: |
| 238 | + """Verify concurrent operations are actually faster than sequential. |
| 239 | +
|
| 240 | + This test demonstrates the 2-3x performance benefit mentioned in docs. |
| 241 | + """ |
| 242 | + import time |
| 243 | + |
| 244 | + from libtmux.common_async import tmux_cmd_async |
| 245 | + |
| 246 | + sock = async_server.socket_name |
| 247 | + |
| 248 | + # Measure sequential execution |
| 249 | + start = time.time() |
| 250 | + await tmux_cmd_async("-L", sock, "list-sessions") |
| 251 | + await tmux_cmd_async("-L", sock, "list-windows", "-a") |
| 252 | + await tmux_cmd_async("-L", sock, "list-panes", "-a") |
| 253 | + await tmux_cmd_async("-L", sock, "show-options", "-g") |
| 254 | + sequential_time = time.time() - start |
| 255 | + |
| 256 | + # Measure concurrent execution |
| 257 | + start = time.time() |
| 258 | + await asyncio.gather( |
| 259 | + tmux_cmd_async("-L", sock, "list-sessions"), |
| 260 | + tmux_cmd_async("-L", sock, "list-windows", "-a"), |
| 261 | + tmux_cmd_async("-L", sock, "list-panes", "-a"), |
| 262 | + tmux_cmd_async("-L", sock, "show-options", "-g"), |
| 263 | + ) |
| 264 | + concurrent_time = time.time() - start |
| 265 | + |
| 266 | + # Concurrent should be faster (allow for some variance) |
| 267 | + # We're not asserting a specific speedup since it depends on system load |
| 268 | + # but concurrent should at least not be slower |
| 269 | + assert concurrent_time <= sequential_time * 1.1 # Allow 10% variance |
| 270 | + |
| 271 | + |
| 272 | +@pytest.mark.asyncio |
| 273 | +async def test_all_examples_use_isolated_sockets(async_server: Server) -> None: |
| 274 | + """Verify that examples properly isolate from developer's tmux session. |
| 275 | +
|
| 276 | + This is critical to ensure tests never affect the developer's working session. |
| 277 | + """ |
| 278 | + sock = async_server.socket_name |
| 279 | + |
| 280 | + # Verify socket is unique test socket |
| 281 | + assert "libtmux_test" in sock or "pytest" in sock.lower() |
| 282 | + |
| 283 | + # Verify we can create and destroy sessions without affecting other sockets |
| 284 | + result = await tmux_cmd_async("-L", sock, "new-session", "-d", "-P", "-F#{session_id}") |
| 285 | + session_id = result.stdout[0] |
| 286 | + |
| 287 | + # Session exists on our socket |
| 288 | + result = await tmux_cmd_async("-L", sock, "has-session", "-t", session_id) |
| 289 | + assert result.returncode == 0 |
| 290 | + |
| 291 | + # Cleanup |
| 292 | + await tmux_cmd_async("-L", sock, "kill-session", "-t", session_id) |
| 293 | + |
| 294 | + # Session no longer exists |
| 295 | + result = await tmux_cmd_async("-L", sock, "has-session", "-t", session_id) |
| 296 | + assert result.returncode != 0 |
0 commit comments