test_common.py

# -*- coding: utf-8 -*-
"""Tests for utility functions in tmux."""

import re
import sys
from distutils.version import LooseVersion

import pytest

import libtmux
from libtmux.common import (
    TMUX_MAX_VERSION,
    TMUX_MIN_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,
    which,
)
from libtmux.exc import BadSessionName, LibTmuxException, TmuxCommandNotFound

version_regex = re.compile(r'([0-9]\.[0-9])|(master)')


def test_allows_master_version(monkeypatch):
    def mock_tmux_cmd(param):
        class Hi(object):
            stdout = ['tmux master']
            stderr = None

        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):
    def mock_tmux_cmd(param):
        class Hi(object):
            stdout = ['tmux next-2.9']
            stderr = None

        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 '2.9' == get_version()


def test_get_version_openbsd(monkeypatch):
    def mock_tmux_cmd(param):
        class Hi(object):
            stderr = ['tmux: unknown option -- V']

        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):
    def mock_tmux_cmd(param):
        class Hi(object):
            stderr = ['tmux: unknown option -- V']

        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():
    """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.

    """
    result = has_minimum_version('1.9a')
    assert result

    result = has_minimum_version('1.8a')
    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):
    def mock_get_version():
        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():
    assert has_version(str(get_version()))


def test_has_gt_version():
    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():
    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():
    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():
    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_which_no_bin_found():
    assert which('top')
    assert which('top', default_paths=[])
    assert not which('top', default_paths=[], append_env_path=False)
    assert not which('top', default_paths=['/'], append_env_path=False)


def test_tmux_cmd_raises_on_not_found():
    with pytest.raises(TmuxCommandNotFound):
        tmux_cmd('-V', tmux_search_paths=[], append_env_path=False)

    tmux_cmd('-V')


def test_tmux_cmd_unicode(session):
    session.cmd('new-window', '-t', 3, '-n', 'юникод', '-F', u'Ελληνικά')


@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, raises, exc_msg_regex):
    if raises:
        with pytest.raises(BadSessionName) as exc_info:
            session_check_name(session_name)
        assert exc_info.match(exc_msg_regex)
    else:
        session_check_name(session_name)