tembo/tests/test_cli/test_cli.py

import importlib
import os
import pathlib

import pytest

import tembo.exceptions
import tembo.cli
from tembo.cli.cli import (
    _new_verify_name_exists,
    _new_get_config_scope,
    _new_show_example,
    new_create_scoped_page,
    new,
    list_all,
)


def test_new_verify_name_exists_success(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    importlib.reload(tembo.cli)

    # act
    verified_name = _new_verify_name_exists("some_scope")

    # assert
    assert verified_name is None

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_verify_name_exists_scope_not_found(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    importlib.reload(tembo.cli)
    from tembo.cli.cli import _new_verify_name_exists

    # act
    with pytest.raises(tembo.exceptions.ScopeNotFound) as scope_not_found:
        _new_verify_name_exists("some_missing_scope")

    # assert
    assert (
        str(scope_not_found.value) == "Scope some_missing_scope not found in config.yml"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_verify_name_exists_empty_config(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "empty")
    importlib.reload(tembo.cli)
    from tembo.cli.cli import _new_verify_name_exists

    # act
    with pytest.raises(tembo.exceptions.EmptyConfigYML) as empty_config_yml:
        _new_verify_name_exists("some_missing_scope")

    # assert
    assert (
        str(empty_config_yml.value)
        == f'Config.yml found in {os.environ["TEMBO_CONFIG"]} is empty'
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_verify_name_exists_missing_config(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "missing")
    importlib.reload(tembo.cli)
    from tembo.cli.cli import _new_verify_name_exists

    # act
    with pytest.raises(tembo.exceptions.MissingConfigYML) as missing_config_yml:
        _new_verify_name_exists("some_missing_scope")

    # assert
    assert (
        str(missing_config_yml.value)
        == f'No config.yml found in {os.environ["TEMBO_CONFIG"]}'
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_get_config_scope_success(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "optional_keys")
    importlib.reload(tembo.cli)

    # act
    config_scope = _new_get_config_scope("some_scope")

    # assert
    assert config_scope == {
        "name": "some_scope",
        "path": "some_scope",
        "filename": "{name}",
        "extension": "md",
        "example": None,
        "template_filename": None,
    }

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_get_config_scope_key_not_found(shared_datadir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "missing_keys")
    importlib.reload(tembo.cli)

    # act
    with pytest.raises(
        tembo.exceptions.MandatoryKeyNotFound
    ) as mandatory_key_not_found:
        config_scope = _new_get_config_scope("some_scope")

    # assert
    assert (
        str(mandatory_key_not_found.value) == "Key 'filename' not found in config.yml"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]


@pytest.mark.parametrize(
    "path,message",
    [
        ("success", "[TEMBO] Example for some_scope: tembo new some_scope 🐘\n"),
        ("optional_keys", "[TEMBO] No example in config.yml 🐘\n"),
    ],
)
def test_new_show_example(path, message, shared_datadir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / path)
    importlib.reload(tembo.cli)
    config_scope = _new_get_config_scope("some_scope")

    # act
    with pytest.raises(SystemExit) as system_exit:
        _new_show_example(True, config_scope)

    # assert
    assert capsys.readouterr().out == message
    assert system_exit.value.code == 0

    # cleanup
    del os.environ["TEMBO_CONFIG"]


def test_new_create_scoped_page_success(shared_datadir, tmpdir):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    config_scope = _new_get_config_scope("some_scope")
    inputs = ()
    scoped_page_file = pathlib.Path(tmpdir / "some_scope" / "some_scope").with_suffix(
        ".md"
    )

    # act
    scoped_page = new_create_scoped_page(config_scope, inputs)

    # assert
    assert scoped_page.path == scoped_page_file
    assert scoped_page.page_content == ""

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_create_scoped_page_base_path_does_not_exist(
    shared_datadir, tmpdir, capsys
):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir / "nonexistent" / "path")
    importlib.reload(tembo.cli)

    config_scope = _new_get_config_scope("some_scope")
    inputs = ()

    # act
    with pytest.raises(SystemExit) as system_exit:
        new_create_scoped_page(config_scope, inputs)

    # assert
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out
        == f'[TEMBO] Tembo base path of {os.environ["TEMBO_BASE_PATH"]} does not exist. 🐘\n'
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_create_scoped_page_template_file_does_not_exist(
    shared_datadir, tmpdir, capsys
):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    os.environ["TEMBO_TEMPLATE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    config_scope = _new_get_config_scope("some_scope")
    config_scope["template_filename"] = "some_nonexistent_template.md.tpl"
    inputs = ()

    # act
    with pytest.raises(SystemExit) as system_exit:
        new_create_scoped_page(config_scope, inputs)

    # assert
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out
        == f'[TEMBO] Template file {os.environ["TEMBO_TEMPLATE_PATH"]}/{config_scope["template_filename"]} does not exist. 🐘\n'
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


@pytest.mark.parametrize("example", [(True,), (False,)])
def test_new_create_scoped_page_mismatched_token(
    example, shared_datadir, tmpdir, capsys
):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    config_scope = _new_get_config_scope("some_scope")
    inputs = ("some_input",)
    if not example[0]:
        config_scope["example"] = None

    # act
    with pytest.raises(SystemExit) as system_exit:
        new_create_scoped_page(config_scope, inputs)

    # assert
    assert system_exit.value.code == 1
    if not example[0]:
        assert (
            capsys.readouterr().out
            == f"[TEMBO] Your tembo config.yml/template specifies 0 input tokens, you gave 1 🐘\n"
        )
    else:
        assert (
            capsys.readouterr().out
            == f"[TEMBO] Your tembo config.yml/template specifies 0 input tokens, you gave 1. Example: tembo new some_scope 🐘\n"
        )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_dry_run(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)
    scope = "some_scope"
    dry_run = "--dry-run"

    # act
    with pytest.raises(SystemExit) as system_exit:
        new([scope, dry_run])

    # assert
    assert system_exit.value.code == 0
    assert (
        capsys.readouterr().out
        == f"[TEMBO] {tmpdir}/some_scope/some_scope.md will be created 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_success(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)
    scoped_page_file = pathlib.Path(tmpdir / "some_scope" / "some_scope").with_suffix(
        ".md"
    )

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_scope"])

    # assert
    assert scoped_page_file.exists()
    assert system_exit.value.code == 0
    assert capsys.readouterr().out == f"[TEMBO] Saved {scoped_page_file} to disk 🐘\n"

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_success_already_exists(shared_datadir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(shared_datadir)
    importlib.reload(tembo.cli)
    scoped_page_file = pathlib.Path(
        shared_datadir / "some_scope" / "some_scope"
    ).with_suffix(".md")

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_scope"])

    # assert
    assert scoped_page_file.exists()
    assert system_exit.value.code == 0
    assert (
        capsys.readouterr().out == f"[TEMBO] File {scoped_page_file} already exists 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_scope_not_found(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)
    scoped_page_file = pathlib.Path(tmpdir / "some_scope" / "some_scope").with_suffix(
        ".md"
    )

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_nonexistent_scope"])

    # assert
    assert not scoped_page_file.exists()
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out
        == f"[TEMBO] Scope some_nonexistent_scope not found in config.yml 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_empty_config(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "empty")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_nonexistent_scope"])

    # assert
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out
        == f"[TEMBO] Config.yml found in {shared_datadir}/config/empty is empty 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_missing_config(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "missing")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_nonexistent_scope"])

    # assert
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out
        == f"[TEMBO] No config.yml found in {shared_datadir}/config/missing 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_new_missing_mandatory_key(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "missing_keys")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)

    # act
    with pytest.raises(SystemExit) as system_exit:
        new(["some_scope"])

    # assert
    assert system_exit.value.code == 1
    assert (
        capsys.readouterr().out == f"[TEMBO] Key 'filename' not found in config.yml 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]


def test_list_all_success(shared_datadir, tmpdir, capsys):
    # arrange
    os.environ["TEMBO_CONFIG"] = str(shared_datadir / "config" / "success")
    os.environ["TEMBO_BASE_PATH"] = str(tmpdir)
    importlib.reload(tembo.cli)
    scoped_page_file = pathlib.Path(tmpdir / "some_scope" / "some_scope").with_suffix(
        ".md"
    )

    # act
    with pytest.raises(SystemExit) as system_exit:
        list_all([])

    # assert
    assert system_exit.value.code == 0
    assert (
        capsys.readouterr().out
        == f"[TEMBO] 2 names found in config.yml: 'some_scope', 'another_some_scope' 🐘\n"
    )

    # cleanup
    del os.environ["TEMBO_CONFIG"]
    del os.environ["TEMBO_BASE_PATH"]