MUSE_OS/tests/test_fullsim_regression.py at 3179a2ce4fdf37df609d45b7b3e3d92564e8a6e8 · EnergySystemsModellingLab/MUSE_OS · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
from pathlib import Path

from conftest import chdir
from pytest import mark, xfail

from muse.examples import AVAILABLE_EXAMPLES

# temporary skip for default_new_input as this is not yet working
AVAILABLE_EXAMPLES.remove("default_new_input")


@mark.regression
@mark.example
@mark.parametrize("model", AVAILABLE_EXAMPLES)
def test_fullsim_regression(model, tmp_path, compare_dirs):
    from warnings import simplefilter

    from pandas.errors import DtypeWarning

    from muse.examples import copy_model
    from muse.mca import MCA

    # fail the test if this warning crops up
    simplefilter("error", DtypeWarning)

    # Copy the data to tmp_path
    model_path = copy_model(name=model, path=tmp_path)

    # main() will output to cwd
    with chdir(tmp_path):
        MCA.factory(model_path / "settings.toml").run()

    compare_dirs(
        tmp_path / "Results",
        Path(__file__).parent / "example_outputs" / model.replace("-", "_") / "Results",
        rtol=1e-4,
        atol=1e-7,
    )


def available_tutorials():
    base_path = Path(__file__).parent.parent / "docs" / "tutorial-code"
    return [p.parent for p in base_path.rglob("settings.toml")]


@mark.regression
@mark.tutorial
@mark.parametrize("tutorial_path", available_tutorials())
def test_tutorial_regression(tutorial_path, tmp_path, compare_dirs):
    import shutil
    from warnings import simplefilter

    from pandas.errors import DtypeWarning

    from muse.mca import MCA

    # Mark as xfail for a specific tutorial
    if "modify-time-framework" in str(tutorial_path):
        xfail(reason="Known issue with this tutorial (#371)")

    # fail the test if this warning crops up
    simplefilter("error", DtypeWarning)

    # Copy the data to tmp_path
    shutil.copytree(tutorial_path, tmp_path, dirs_exist_ok=True)

    # Get the toml file to run. There should be only one settings file
    settings = list(tmp_path.glob("*.toml"))
    assert len(settings) == 1

    # Rename existing results directory for comparison
    expected = tmp_path / "Expected"
    (tmp_path / "Results").rename(expected)

    # main() will output to cwd
    # Change working directory to tmp_path
    with chdir(tmp_path):
        MCA.factory(settings[0]).run()

    compare_dirs(
        tmp_path / "Results",
        expected,
        rtol=1e-4,
        atol=1e-7,
    )