test_main.py

# contextual: providing context for shell command invocations
# Copyright 2008-2015  Samuele Pedroni
#
# This file is part of contextual.
#
# contextual is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# contextual is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with contextual.  If not, see <http://www.gnu.org/licenses/>.
#
import pytest

from _contextual import main


@pytest.fixture(scope="function")
def home_and_projs(request, tmpdir):
    """=> home, proj1/a, proj2/b, proj2/p1 -> proj1"""
    request.addfinalizer(lambda: tmpdir.remove(rec=1, ignore_errors=True))
    home = tmpdir.join("home", "user0")
    a = home.join("proj1", "a").ensure_dir()
    b = home.join("proj2", "b").ensure_dir()
    p2p1 = home.join("proj2", "p1")
    p2p1.mksymlinkto(a.dirpath())
    return home, a, b, p2p1


def test_match(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
""".format(
        a.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(a.strpath)
    monkeypatch.setenv("PWD", a.strpath)
    main([confp.strpath, "cmd"])
    out, err = capsys.readouterr()
    assert out == "PROJ=1\n"


def test_no_match(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
""".format(
        a.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(b.strpath)
    monkeypatch.setenv("PWD", b.strpath)
    with pytest.raises(SystemExit) as exit_info:
        main([confp.strpath, "cmd"])
    assert exit_info.value.code == 1
    out, err = capsys.readouterr()
    assert out == "exit 1\n"
    assert err.startswith("contextual: failed to infer context:")


def test_void_context(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
/  :=
""".format(
        a.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(b.strpath)
    monkeypatch.setenv("PWD", b.strpath)
    main([confp.strpath, "cmd"])
    out, err = capsys.readouterr()
    assert out == "\n"
    assert err == ""


def test_rules_used_once(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ={{ctx_dir}}
""".format(
        a.dirpath().dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(p2p1.strpath)
    monkeypatch.setenv("PWD", p2p1.strpath)
    main([confp.strpath, "cmd"])
    out, err = capsys.readouterr()
    assert out == "PROJ={}\n".format(home)


def test_diverged_PWD(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
{} := PROJ=2
""".format(
        a.dirpath().strpath, b.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(p2p1.strpath)
    monkeypatch.setenv("PWD", p2p1.strpath)
    main([confp.strpath, "cmd"])
    out, err = capsys.readouterr()
    assert out == "PROJ=1;PROJ=2\n"


def test_consider_command_path(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
{} := PROJ=2
""".format(
        a.dirpath().strpath, b.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(a.strpath)
    monkeypatch.setenv("PWD", a.strpath)
    main([confp.strpath, b.join("cmd").strpath])
    out, err = capsys.readouterr()
    assert out == "PROJ=1;PROJ=2\n"


def test_broken_placeholder(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    conf = u"""
{} := PROJ=1
{} := PROJ={{2}}
""".format(
        a.dirpath().strpath, b.dirpath().strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(p2p1.strpath)
    monkeypatch.setenv("PWD", p2p1.strpath)
    main([confp.strpath, "cmd"])
    out, err = capsys.readouterr()
    assert out == "PROJ=1\n"
    assert err == "contextual: 'PROJ={2}' has unbound/unknown placeholder\n"


def test_trace(home_and_projs, monkeypatch, capsys):
    home, a, b, p2p1 = home_and_projs
    p1 = a.dirpath()
    p2 = b.dirpath()
    conf = u"""
{} := PROJ=1
{} := PROJ=2
/  :=
""".format(
        p1.strpath, p2.strpath
    )
    confp = home.join("ctx.conf")
    confp.write_text(conf, encoding="ascii")
    monkeypatch.chdir(a.strpath)
    monkeypatch.setenv("PWD", a.strpath)
    with pytest.raises(SystemExit) as exit_info:
        main([confp.strpath, "cmd", ":trace"])
    assert exit_info.value.code == 0
    out, err = capsys.readouterr()
    assert out == "exit 0\n"
    trace_lines = err.splitlines()
    assert trace_lines == [
        u"start-dir[PWD]: {}".format(a.strpath),
        u" ~~ {} := PROJ=1 => {!r}".format(p1.strpath, [p1.strpath]),
        u" ~~ {} := PROJ=2 => no".format(p2.strpath),
        u" ~~ /  := => void_context",
        u"start-dir[getcwd]: {}".format(a.strpath),
        u" ~~ {} := PROJ=2 => no".format(p2.strpath),
        u"CONTEXT => PROJ=1",
    ]