Source code for message_ix_models.tests.model.test_build

import logging

import pytest
from message_ix import make_df
from message_ix.testing import make_dantzig

from message_ix_models import ScenarioInfo
from message_ix_models.model.build import apply_spec


@pytest.fixture
def scenario(test_context):
    mp = test_context.get_platform()
    yield make_dantzig(mp)


@pytest.fixture(scope="function")
def spec():
    yield dict(add=ScenarioInfo(), require=ScenarioInfo(), remove=ScenarioInfo())


def test_apply_spec0(caplog, scenario, spec):
    """Require missing element raises ValueError."""
    spec["require"].set["node"].append("vienna")

    with pytest.raises(ValueError):
        apply_spec(scenario, spec)

    assert (
        "message_ix_models.model.build",
        logging.ERROR,
        "  1 elements not found: ['vienna']",
    ) in caplog.record_tuples


def test_apply_spec1(caplog, scenario, spec):
    """Add data using the data= argument."""

    def add_data_func(scenario, dry_run):
        return dict(
            demand=make_df(
                "demand",
                commodity="cases",
                level="consumption",
                node="chicago",
                time="year",
                unit="case",
                value=301.0,
                year=1963,
            )
        )

    apply_spec(scenario, spec, data=add_data_func, dry_run=True)

    # Messages are logged about additions
    assert "1 rows in 'demand'" in caplog.messages, caplog.messages
    # …but no change because `dry_run`
    assert not any(301.0 == scenario.par("demand")["value"])

    caplog.clear()

    apply_spec(scenario, spec, data=add_data_func)

    # Messages are logged about additions
    assert "1 rows in 'demand'" in caplog.messages, caplog.messages
    # Value was actually changed
    assert 1 == sum(301.0 == scenario.par("demand")["value"])


def test_apply_spec2(caplog, scenario, spec):
    """Remove an element, with fast=True."""
    spec["remove"].set["node"] = ["new-york"]

    apply_spec(scenario, spec, fast=True)

    # Messages are logged about removals
    assert all(
        msg in caplog.messages
        for msg in (
            "  Skip removing 'new-york' and associated parameter elements (fast=True)",
            "0 parameter elements removed",
        )
    ), caplog.messages


def test_apply_spec3(caplog, scenario, spec):
    """Actually remove data."""
    spec["remove"].set["node"] = ["new-york"]

    apply_spec(scenario, spec)

    # Messages are logged about removals
    assert all(
        msg in caplog.messages
        for msg in (
            "  Remove 'new-york' and associated parameter elements",
            "Remove 1 rows in 'demand'",
            "Remove 2 rows in 'output'",
            "3 parameter elements removed",
        )
    ), caplog.messages