add checks for uniqeness of mode and species names (#246)

Author: slayoo

src/aero_data.hpp

@@ -32,6 +32,8 @@ struct AeroData {
     AeroData(const nlohmann::json &json) :
         ptr(f_aero_data_ctor, f_aero_data_dtor)
     {
+        if (!InputGimmick::unique_keys(json))
+            throw std::runtime_error("Species names must be unique");
         gimmick_ptr() = std::make_unique<InputGimmick>(json);
         f_aero_data_from_json(this->ptr.f_arg());
         gimmick_ptr().reset(); // TODO #117: guard

src/aero_dist.hpp

@@ -49,6 +49,8 @@ struct AeroDist {
         ptr(f_aero_dist_ctor, f_aero_dist_dtor),
         aero_data(aero_data)
     {
+        if (!InputGimmick::unique_keys(json))
+            throw std::runtime_error("Mode names must be unique");
         gimmick_ptr() = std::make_unique<InputGimmick>(json, "", "mode_name", 1);
         f_aero_dist_from_json(ptr.f_arg_non_const(), aero_data->ptr.f_arg_non_const());
         gimmick_ptr().reset();

src/aero_mode.hpp

@@ -128,6 +128,8 @@ struct AeroMode {
     AeroMode(AeroData &aero_data, const nlohmann::json &json) :
         ptr(f_aero_mode_ctor, f_aero_mode_dtor)
     {
+        if (json.size() != 1)
+            throw std::runtime_error("Single element expected");
         gimmick_ptr() = std::make_unique<InputGimmick>(json, "", "mode_name");
         f_aero_mode_from_json(ptr.f_arg_non_const(), aero_data.ptr.f_arg_non_const());
         gimmick_ptr().reset();

src/gimmicks.hpp

@@ -272,6 +272,18 @@ struct InputGimmick: Gimmick {
         }
         return 1;
     }
+
+    static bool unique_keys(const nlohmann::json &json) {
+        std::set<std::string> keys;
+        for (auto i=0u; i<json.size(); ++i) {
+            for (auto &entry : json.at(i).items()) {
+                if (keys.find(entry.key()) != keys.end())
+                    return false;
+                keys.insert(entry.key());
+            }
+        }
+        return true;
+    }
 };
 
 struct OutputGimmick: Gimmick {

tests/test_aero_data.py

@@ -353,3 +353,12 @@ def test_aero_data_density():
 
             # assert
             assert density == val[0]
+
+    @staticmethod
+    def test_ctor_error_on_nonunique_keys():
+        # act
+        with pytest.raises(Exception) as exc_info:
+            ppmc.AeroData([AERO_DATA_CTOR_ARG_MINIMAL[0]] * 2)
+
+        # assert
+        assert str(exc_info.value) == "Species names must be unique"

tests/test_aero_dist.py

@@ -32,8 +32,8 @@
 ]
 
 
-@pytest.fixture
-def sut_minimal():
+@pytest.fixture(name="sut_minimal")
+def sut_minimal_fixture():
     aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
     sut = ppmc.AeroDist(aero_data, AERO_DIST_CTOR_ARG_MINIMAL)
     aero_data = None
@@ -113,9 +113,7 @@ def test_ctor_modes_in_order(n_modes=4):
 
     @staticmethod
     @pytest.mark.parametrize("idx", (-1, 500))
-    def test_get_mode_out_of_range(
-        sut_minimal, idx
-    ):  # pylint: disable=redefined-outer-name
+    def test_get_mode_out_of_range(sut_minimal, idx):
         # act
         try:
             _ = sut_minimal.mode(idx)
@@ -128,7 +126,7 @@ def test_get_mode_out_of_range(
     @staticmethod
     def test_get_mode_result_lifetime(
         sut_minimal,
-    ):  # pylint: disable=redefined-outer-name
+    ):
         # arrange
         mode = sut_minimal.mode(0)
         mode_type = mode.type
@@ -141,7 +139,7 @@ def test_get_mode_result_lifetime(
         assert mode.type == mode_type
 
     @staticmethod
-    def test_get_mode_is_a_copy(sut_minimal):  # pylint: disable=redefined-outer-name
+    def test_get_mode_is_a_copy(sut_minimal):
         # arrange
         new_type = "mono"
         mode_idx = 0
@@ -153,3 +151,15 @@ def test_get_mode_is_a_copy(sut_minimal):  # pylint: disable=redefined-outer-nam
 
         # assert
         assert sut_minimal.mode(mode_idx).type != new_type
+
+    @staticmethod
+    def test_ctor_multimode_error_on_repeated_mode_names():
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+
+        # act
+        with pytest.raises(Exception) as exc_info:
+            ppmc.AeroDist(aero_data, AERO_DIST_CTOR_ARG_MINIMAL * 2)
+
+        # assert
+        assert str(exc_info.value) == "Mode names must be unique"

tests/test_aero_mode.py

@@ -237,3 +237,35 @@ def test_set_name():
 
         # assert
         assert sut.name == val
+
+    @staticmethod
+    def test_ctor_fails_with_multiple_modes():
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+        fishy_ctor_arg = AERO_MODE_CTOR_LOG_NORMAL
+        fishy_ctor_arg["xxx"] = fishy_ctor_arg["test_mode"]
+
+        # act
+        with pytest.raises(Exception) as exc_info:
+            ppmc.AeroMode(aero_data, fishy_ctor_arg)
+
+        # assert
+        assert str(exc_info.value) == "Single element expected"
+
+    @staticmethod
+    def test_ctor_fails_with_nonunique_mass_fracs():
+        pytest.skip("TODO #240")
+
+        # arrange
+        aero_data = ppmc.AeroData(AERO_DATA_CTOR_ARG_MINIMAL)
+        fishy_ctor_arg = AERO_MODE_CTOR_LOG_NORMAL
+        fishy_ctor_arg["test_mode"]["mass_frac"].append(
+            fishy_ctor_arg["test_mode"]["mass_frac"]
+        )
+
+        # act
+        with pytest.raises(Exception) as exc_info:
+            ppmc.AeroMode(aero_data, fishy_ctor_arg)
+
+        # assert
+        assert str(exc_info.value) == ""