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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
|
"""Tests for utility functions in libtmux."""
from __future__ import annotations
import re
import sys
import typing as t
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
if t.TYPE_CHECKING:
from libtmux.session import Session
version_regex = re.compile(r"([0-9]\.[0-9])|(master)")
def test_has_version() -> None:
"""Test has_version()."""
assert has_version(str(get_version()))
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):
tmux_cmd("-V")
def test_tmux_cmd_unicode(session: Session) -> None:
"""Verify tmux commands with unicode."""
session.cmd("new-window", "-t", 3, "-n", "юникод", "-F", "Ελληνικά")
class SessionCheckName(t.NamedTuple):
"""Test fixture for test_session_check_name()."""
test_id: str
session_name: str | None
raises: bool
exc_msg_regex: str | None
SESSION_CHECK_NAME_FIXTURES: list[SessionCheckName] = [
SessionCheckName(
test_id="empty_string",
session_name="",
raises=True,
exc_msg_regex="empty",
),
SessionCheckName(
test_id="none_value",
session_name=None,
raises=True,
exc_msg_regex="empty",
),
SessionCheckName(
test_id="contains_period",
session_name="my great session.",
raises=True,
exc_msg_regex="contains periods",
),
SessionCheckName(
test_id="contains_colon",
session_name="name: great session",
raises=True,
exc_msg_regex="contains colons",
),
SessionCheckName(
test_id="valid_name",
session_name="new great session",
raises=False,
exc_msg_regex=None,
),
SessionCheckName(
test_id="valid_with_special_chars",
session_name="ajf8a3fa83fads,,,a",
raises=False,
exc_msg_regex=None,
),
]
@pytest.mark.parametrize(
list(SessionCheckName._fields),
SESSION_CHECK_NAME_FIXTURES,
ids=[test.test_id for test in SESSION_CHECK_NAME_FIXTURES],
)
def test_session_check_name(
test_id: str,
session_name: str | None,
raises: bool,
exc_msg_regex: str | None,
) -> None:
"""Verify session_check_name()."""
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:
"""Verify get_libtmux_version()."""
from libtmux.__about__ import __version__
version = get_libtmux_version()
assert isinstance(version, LooseVersion)
assert LooseVersion(__version__) == version
class VersionComparisonFixture(t.NamedTuple):
"""Test fixture for version comparison functions."""
test_id: str
version: str
comparison_type: t.Literal["gt", "gte", "lt", "lte"]
expected: bool
VERSION_COMPARISON_FIXTURES: list[VersionComparisonFixture] = [
# Greater than tests
VersionComparisonFixture(
test_id="gt_older_version",
version="1.6",
comparison_type="gt",
expected=True,
),
VersionComparisonFixture(
test_id="gt_older_version_with_letter",
version="1.6b",
comparison_type="gt",
expected=True,
),
VersionComparisonFixture(
test_id="gt_newer_version",
version="4.0",
comparison_type="gt",
expected=False,
),
VersionComparisonFixture(
test_id="gt_newer_version_with_letter",
version="4.0b",
comparison_type="gt",
expected=False,
),
# Greater than or equal tests
VersionComparisonFixture(
test_id="gte_older_version",
version="1.6",
comparison_type="gte",
expected=True,
),
VersionComparisonFixture(
test_id="gte_older_version_with_letter",
version="1.6b",
comparison_type="gte",
expected=True,
),
VersionComparisonFixture(
test_id="gte_current_version",
version=str(get_version()),
comparison_type="gte",
expected=True,
),
VersionComparisonFixture(
test_id="gte_newer_version",
version="4.0",
comparison_type="gte",
expected=False,
),
VersionComparisonFixture(
test_id="gte_newer_version_with_letter",
version="4.0b",
comparison_type="gte",
expected=False,
),
# Less than tests
VersionComparisonFixture(
test_id="lt_newer_version_with_letter",
version="4.0a",
comparison_type="lt",
expected=True,
),
VersionComparisonFixture(
test_id="lt_newer_version",
version="4.0",
comparison_type="lt",
expected=True,
),
VersionComparisonFixture(
test_id="lt_older_version",
version="1.7",
comparison_type="lt",
expected=False,
),
VersionComparisonFixture(
test_id="lt_current_version",
version=str(get_version()),
comparison_type="lt",
expected=False,
),
# Less than or equal tests
VersionComparisonFixture(
test_id="lte_newer_version_with_letter",
version="4.0a",
comparison_type="lte",
expected=True,
),
VersionComparisonFixture(
test_id="lte_newer_version",
version="4.0",
comparison_type="lte",
expected=True,
),
VersionComparisonFixture(
test_id="lte_current_version",
version=str(get_version()),
comparison_type="lte",
expected=True,
),
VersionComparisonFixture(
test_id="lte_older_version",
version="1.7",
comparison_type="lte",
expected=False,
),
VersionComparisonFixture(
test_id="lte_older_version_with_letter",
version="1.7b",
comparison_type="lte",
expected=False,
),
]
@pytest.mark.parametrize(
list(VersionComparisonFixture._fields),
VERSION_COMPARISON_FIXTURES,
ids=[test.test_id for test in VERSION_COMPARISON_FIXTURES],
)
def test_version_comparison(
test_id: str,
version: str,
comparison_type: t.Literal["gt", "gte", "lt", "lte"],
expected: bool,
) -> None:
"""Test version comparison functions."""
comparison_funcs = {
"gt": has_gt_version,
"gte": has_gte_version,
"lt": has_lt_version,
"lte": has_lte_version,
}
assert comparison_funcs[comparison_type](version) == expected
class VersionParsingFixture(t.NamedTuple):
"""Test fixture for version parsing and validation."""
test_id: str
mock_stdout: list[str] | None
mock_stderr: list[str] | None
mock_platform: str | None
expected_version: str | None
raises: bool
exc_msg_regex: str | None
VERSION_PARSING_FIXTURES: list[VersionParsingFixture] = [
VersionParsingFixture(
test_id="master_version",
mock_stdout=["tmux master"],
mock_stderr=None,
mock_platform=None,
expected_version=f"{TMUX_MAX_VERSION}-master",
raises=False,
exc_msg_regex=None,
),
VersionParsingFixture(
test_id="next_version",
mock_stdout=[f"tmux next-{float(TMUX_MAX_VERSION) + 0.1!s}"],
mock_stderr=None,
mock_platform=None,
expected_version=str(float(TMUX_MAX_VERSION) + 0.1),
raises=False,
exc_msg_regex=None,
),
VersionParsingFixture(
test_id="openbsd_version",
mock_stdout=None,
mock_stderr=["tmux: unknown option -- V"],
mock_platform="openbsd 5.2",
expected_version=f"{TMUX_MAX_VERSION}-openbsd",
raises=False,
exc_msg_regex=None,
),
VersionParsingFixture(
test_id="too_low_version",
mock_stdout=None,
mock_stderr=["tmux: unknown option -- V"],
mock_platform=None,
expected_version=None,
raises=True,
exc_msg_regex="is running tmux 1.3 or earlier",
),
]
@pytest.mark.parametrize(
list(VersionParsingFixture._fields),
VERSION_PARSING_FIXTURES,
ids=[test.test_id for test in VERSION_PARSING_FIXTURES],
)
def test_version_parsing(
monkeypatch: pytest.MonkeyPatch,
test_id: str,
mock_stdout: list[str] | None,
mock_stderr: list[str] | None,
mock_platform: str | None,
expected_version: str | None,
raises: bool,
exc_msg_regex: str | None,
) -> None:
"""Test version parsing and validation."""
class MockTmuxOutput:
stdout = mock_stdout
stderr = mock_stderr
def mock_tmux_cmd(*args: t.Any, **kwargs: t.Any) -> MockTmuxOutput:
return MockTmuxOutput()
monkeypatch.setattr(libtmux.common, "tmux_cmd", mock_tmux_cmd)
if mock_platform is not None:
monkeypatch.setattr(sys, "platform", mock_platform)
if raises:
with pytest.raises(LibTmuxException) as exc_info:
get_version()
if exc_msg_regex is not None:
exc_info.match(exc_msg_regex)
else:
assert get_version() == expected_version
assert has_minimum_version()
assert has_gte_version(TMUX_MIN_VERSION)
assert has_gt_version(TMUX_MAX_VERSION)
class VersionValidationFixture(t.NamedTuple):
"""Test fixture for version validation tests."""
test_id: str
mock_min_version: str | None
mock_version: str | None
check_type: t.Literal["min_version", "has_version", "type_check"]
raises: bool
exc_msg_regex: str | None
VERSION_VALIDATION_FIXTURES: list[VersionValidationFixture] = [
# Letter version tests
VersionValidationFixture(
test_id="accepts_letter_in_min_version_1_9a",
mock_min_version="1.9a",
mock_version=None,
check_type="min_version",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_letter_in_min_version_1_8a",
mock_min_version="1.8a",
mock_version=None,
check_type="min_version",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_version_1_8",
mock_min_version=None,
mock_version="1.8",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_version_1_8a",
mock_min_version=None,
mock_version="1.8a",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_version_1_9a",
mock_min_version=None,
mock_version="1.9a",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
# Version too low tests
VersionValidationFixture(
test_id="rejects_version_1_7",
mock_min_version=None,
mock_version="1.7",
check_type="min_version",
raises=True,
exc_msg_regex=r"libtmux only supports",
),
# Additional test cases for version validation
VersionValidationFixture(
test_id="accepts_master_version",
mock_min_version=None,
mock_version="master",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_next_version",
mock_min_version=None,
mock_version="next-3.4",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_openbsd_version",
mock_min_version=None,
mock_version="3.3-openbsd",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_dev_version",
mock_min_version=None,
mock_version="3.3-dev",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
VersionValidationFixture(
test_id="accepts_rc_version",
mock_min_version=None,
mock_version="3.3-rc2",
check_type="type_check",
raises=False,
exc_msg_regex=None,
),
]
@pytest.mark.parametrize(
list(VersionValidationFixture._fields),
VERSION_VALIDATION_FIXTURES,
ids=[test.test_id for test in VERSION_VALIDATION_FIXTURES],
)
def test_version_validation(
monkeypatch: pytest.MonkeyPatch,
test_id: str,
mock_min_version: str | None,
mock_version: str | None,
check_type: t.Literal["min_version", "has_version", "type_check"],
raises: bool,
exc_msg_regex: str | None,
) -> None:
"""Test version validation."""
if mock_min_version is not None:
monkeypatch.setattr(libtmux.common, "TMUX_MIN_VERSION", mock_min_version)
if mock_version is not None:
def mock_get_version() -> LooseVersion:
return LooseVersion(mock_version)
monkeypatch.setattr(libtmux.common, "get_version", mock_get_version)
if check_type == "min_version":
if raises:
with pytest.raises(LibTmuxException) as exc_info:
has_minimum_version()
if exc_msg_regex is not None:
exc_info.match(exc_msg_regex)
else:
assert has_minimum_version()
elif check_type == "type_check":
assert mock_version is not None # For type checker
assert isinstance(has_version(mock_version), bool)
|