check if all profiles have proper form in Scenario ctor. closes #115 (#318)

Author: slayoo

src/scenario.hpp

@@ -95,6 +95,34 @@ struct Scenario {
         ptr(f_scenario_ctor, f_scenario_dtor),
         json(json)
     {
+        // TODO #317 - repeat analogous checks for rates
+        for (auto &prof: std::set<std::string>({"height", "temp", "pressure"})) {
+            auto prof_key = prof + "_profile";
+            if (json.find(prof_key) != json.end()) {
+                if (!json[prof_key].is_array() || json[prof_key].size() != 2)
+                    throw std::runtime_error(prof_key + " expected to be a 2-element list (of single-element dictionaries)");
+                for (auto i=0; i<2; ++i)
+                    if (!json[prof_key][i].is_object() || json[prof_key][i].size() != 1)
+                        throw std::runtime_error(prof_key + " expected to contain only single-element dicts");
+                {
+                    auto elem = json[prof_key][0];
+                    if (elem.find("time") == elem.end())
+                        throw std::runtime_error(prof_key + " first element is expeced to be a single-element dict with 'time' key");
+                }
+                {
+                    auto elem = json[prof_key][1];
+                    if (elem.find(prof) == elem.end())
+                        throw std::runtime_error(prof_key + " second element is expeced to be a single-element dict with '" + prof + "' key");
+                }
+                if (
+                    !json[prof_key][0]["time"].is_array() || 
+                    !json[prof_key][1][prof].is_array() || 
+                    json[prof_key][0]["time"].size() != json[prof_key][1][prof].size()
+                )
+                    throw std::runtime_error(prof_key + " 'time' and '" + prof + "' arrays do not have matching size");
+            }
+        }
+
         GimmickGuard<InputGimmick> guard(json, "dist", "mode_name");
         f_scenario_from_json(
             gas_data.ptr.f_arg(),

tests/test_scenario.py

@@ -71,7 +71,7 @@ class TestScenario:
                     "temp_profile": [{"time": [0, 1, 2]}, {"temp": [1, 2, 3]}],
                     "pressure_profile": [{"time": [0, 1, 2]}, {"pressure": [1, 2, 3]}],
                     "height_profile": [
-                        {"time": [0, 1, 2, 3, 4]},  # TODO #115: should be caught
+                        {"time": [0, 1, 2]},
                         {"height": [1, 2, 3]},
                     ],
                     "gas_emissions": [
@@ -260,3 +260,62 @@ def test_time_varying_aero_multimode(key, mode_names):
                         dist.mode(i_mode).name
                     ]["num_conc"]
                 )
+
+    ERR_MSG_2_ELEM_LIST_EXPECTED = (
+        "PROF_profile expected to be a 2-element list (of single-element dictionaries)"
+    )
+    ERR_MSG_ALL_ELEMS_DICTS = (
+        "PROF_profile expected to contain only single-element dicts"
+    )
+    ERR_MSG_PROFILE_LEN_MATCH = (
+        "PROF_profile 'time' and 'PROF' arrays do not have matching size"
+    )
+    ERR_MSG_TIME_KEY_MISSING = (
+        "PROF_profile first element is expeced to be"
+        " a single-element dict with 'time' key"
+    )
+    ERR_MSG_PROF_KEY_MISSING = (
+        "PROF_profile second element is expeced to be"
+        " a single-element dict with 'PROF' key"
+    )
+
+    @staticmethod
+    @pytest.mark.parametrize("prof", ("height", "temp", "pressure"))
+    @pytest.mark.parametrize(
+        "data, msg",
+        (
+            ({}, ERR_MSG_2_ELEM_LIST_EXPECTED),
+            ([{}, {}, {}], ERR_MSG_2_ELEM_LIST_EXPECTED),
+            ([[], []], ERR_MSG_ALL_ELEMS_DICTS),
+            ([{}, []], ERR_MSG_ALL_ELEMS_DICTS),
+            ([[], {}], ERR_MSG_ALL_ELEMS_DICTS),
+            ([{"1": 1, "2": 2}, {}], ERR_MSG_ALL_ELEMS_DICTS),
+            ([{"1": 1, "2": 2, "3": 3}, {"1": 1, "2": 2}], ERR_MSG_ALL_ELEMS_DICTS),
+            ([{"xtime": ""}, {"PROF": ""}], ERR_MSG_TIME_KEY_MISSING),
+            ([{"time": ""}, {"xPROF": ""}], ERR_MSG_PROF_KEY_MISSING),
+            ([{"time": ""}, {"PROF": []}], ERR_MSG_PROFILE_LEN_MATCH),
+            ([{"time": []}, {"PROF": ""}], ERR_MSG_PROFILE_LEN_MATCH),
+            ([{"time": [1, 2]}, {"PROF": [1, 2, 3]}], ERR_MSG_PROFILE_LEN_MATCH),
+        ),
+    )
+    def test_throws_if_profile_not_of_proper_form(prof, data, msg):
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+        gas_data = ppmc.GasData(GAS_DATA_CTOR_ARG_MINIMAL)
+
+        data = copy.deepcopy(data)
+        if len(data) == 2 and isinstance(data[1], dict) and len(data[1].keys()) == 1:
+            key = tuple(data[1].keys())[0]
+            new_key = key.replace("PROF", prof)
+            if key != new_key:
+                data[1][new_key] = data[1][key]
+                del data[1][key]
+        ctor_arg = copy.deepcopy(SCENARIO_CTOR_ARG_MINIMAL)
+        ctor_arg[f"{prof}_profile"] = data
+
+        # act
+        with pytest.raises(RuntimeError) as excinfo:
+            _ = ppmc.Scenario(gas_data, aero_data, ctor_arg)
+
+        # assert
+        assert str(excinfo.value) == msg.replace("PROF", f"{prof}")