ramalama/test/unit/test_toml_parser.py

"""
Unit tests for the TOMLParser class
"""

import pytest

import ramalama.toml_parser


@pytest.mark.parametrize(
    "toml, expected",
    [
        (
            """
            [store]
            container = "docker"
            engine = "docker"
            image = "my_image"
            transport = "oci"
            """,
            {
                "store": {
                    "container": "docker",
                    "engine": "docker",
                    "image": "my_image",
                    "transport": "oci",
                },
            },
        ),
    ],
)
def test_toml_parser_basic_parse(toml, expected):
    """
    Test the basic parsing of TOML files
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    assert toml_parser.parse(toml) == expected


@pytest.mark.parametrize(
    "toml, expected",
    [
        (
            """
            [store]
            processes = 1
            float_value = 1.0
            use_engine = True
            image = "my_image"
            numbers = [1, 2, 3]
            """,
            {
                "store": {
                    "processes": 1,
                    "float_value": 1.0,
                    "use_engine": True,
                    "image": "my_image",
                    "numbers": [1, 2, 3],
                },
            },
        ),
    ],
)
def test_toml_parser_basic_parse_different_types(toml, expected):
    """
    Test the basic parsing of TOML files
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    assert toml_parser.parse(toml) == expected
    assert toml_parser.get("store.processes") == expected["store"]["processes"]
    assert toml_parser.get("store.use_engine") == expected["store"]["use_engine"]
    assert toml_parser.get("store.image") == expected["store"]["image"]


@pytest.mark.parametrize(
    "toml, expected",
    [
        (
            """
            [store]
            container = "podman"
            engine = "podman"
            image = "example_image"
            transport = "oci"
            [store.extra]
            extra_key = "extra_value"
            """,
            {
                "store": {
                    "container": "podman",
                    "engine": "podman",
                    "image": "example_image",
                    "transport": "oci",
                    "extra": {"extra_key": "extra_value"},
                },
            },
        ),
    ],
)
def test_toml_parser_get(toml, expected):
    """
    Test the get method of the TOMLParser class
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    toml_parser.parse(toml)
    assert toml_parser.get("store") == expected["store"]
    assert toml_parser.get("store.container") == expected["store"]["container"]
    assert toml_parser.get("store.engine") == expected["store"]["engine"]
    assert toml_parser.get("store.image") == expected["store"]["image"]
    assert toml_parser.get("store.transport") == expected["store"]["transport"]
    assert toml_parser.get("store.non_existent_key") is None
    if "extra" in expected["store"]:
        assert toml_parser.get("store.extra") == expected["store"]["extra"]
        assert toml_parser.get("store.extra.extra_key") == expected["store"]["extra"]["extra_key"]
    else:
        assert toml_parser.get("store.extra") is None


@pytest.mark.parametrize(
    "toml_error_string",
    [
        ("""
            This is not a valid TOML file.
            """),
    ],
)
def test_toml_parser_wrong_parse(toml_error_string):
    """
    Test the parsing of invalid TOML files
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    with pytest.raises(ValueError, match="Invalid TOML line: This is not a valid TOML file."):
        toml_parser.parse(toml_error_string)
    assert toml_parser.get("store") is None
    assert toml_parser.get("store.container") is None
    assert toml_parser.get("store.engine") is None
    assert toml_parser.get("store.image") is None
    assert toml_parser.get("store.transport") is None
    assert toml_parser.get("store.extra") is None
    assert toml_parser.get("store.extra.extra_key") is None


@pytest.mark.parametrize(
    "toml, expected",
    [
        (
            """
            [store]
            container = "container_value"
            engine = "engine_value"
            image = "image_value"
            transport = "transport_value"
            """,
            {
                "store": {
                    "container": "container_value",
                    "engine": "engine_value",
                    "image": "image_value",
                    "transport": "transport_value",
                }
            },
        )
    ],
)
def test_get_method_without_extra(toml, expected):
    """
    Test the get method of the TOMLParser class when the store.extra section is missing.
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    toml_parser.parse(toml)
    assert toml_parser.get("store") == expected["store"]
    assert toml_parser.get("store.container") == expected["store"]["container"]
    assert toml_parser.get("store.engine") == expected["store"]["engine"]
    assert toml_parser.get("store.image") == expected["store"]["image"]
    assert toml_parser.get("store.transport") == expected["store"]["transport"]
    assert toml_parser.get("store.extra") is None


@pytest.mark.parametrize(
    "toml_error_string, expected_match",
    [
        ("This is not a valid TOML file.", "Invalid TOML line: This is not a valid TOML file."),
        ('key = "value', "Unsupported value type: \"value"),
        ("key = unquoted string", "Unsupported value type: unquoted string"),
    ],
)
def test_toml_parser_wrong_toml_entries(toml_error_string, expected_match):
    """
    Test the parsing of invalid TOML files with specific error messages for each case
    """
    toml_parser = ramalama.toml_parser.TOMLParser()
    with pytest.raises(ValueError, match=expected_match):
        toml_parser.parse(toml_error_string)