Remove todo and remove test that is not working anymore because of the changes. Add documentation

Signed-off-by: Maaike Zijderveld, iolar <git.mail@iolar.nl>

Author: maaikez

include/ocpp/v201/ocpp_types.hpp

@@ -2236,12 +2236,24 @@ void to_json(json& j, const Firmware& k);
 /// \brief Conversion from a given json object \p j to a given Firmware \p k
 void from_json(const json& j, Firmware& k);
 
-// \brief Writes the string representation of the given Firmware \p k to the given output stream \p os
+/// \brief Writes the string representation of the given Firmware \p k to the given output stream \p os
 /// \returns an output stream with the Firmware written to
 std::ostream& operator<<(std::ostream& os, const Firmware& k);
 
+///
+/// \brief Required ComponentVariable.
+///
 struct RequiredComponentVariable : ComponentVariable {
+    /// \brief Constructor
     RequiredComponentVariable() : required_for({OcppProtocolVersion::v201, OcppProtocolVersion::v21}) {};
+
+    ///
+    /// \brief RequiredComponentVariable
+    /// \param component    Component
+    /// \param variable     Variable
+    /// \param custom_data  Custom data (default nullopt)
+    /// \param required_for Required for which version. Multiple versions can be given.
+    ///
     RequiredComponentVariable(const Component component, const std::optional<Variable> variable,
                               const std::optional<CustomData> custom_data = std::nullopt,
                               const std::set<OcppProtocolVersion> required_for = {OcppProtocolVersion::v201,
@@ -2251,6 +2263,8 @@ struct RequiredComponentVariable : ComponentVariable {
         this->variable = variable;
         this->customData = custom_data;
     };
+
+    /// \brief For which ocpp protocol version(s) this component variable is required.
     std::set<OcppProtocolVersion> required_for;
 };
 } // namespace v201

lib/ocpp/v201/device_model.cpp

@@ -492,8 +492,6 @@ void DeviceModel::check_integrity(const std::map<int32_t, int32_t>& evse_connect
         this->check_required_variables();
         this->device_model->check_integrity();
 
-        // TODO: add required variable check here.
-
         int32_t nr_evse_components = 0;
         std::map<int32_t, int32_t> evse_id_nr_connector_components;
 

tests/lib/ocpp/v201/test_device_model.cpp

@@ -455,8 +455,7 @@ TEST_F(DeviceModelTest, test_check_integrity_missing_required_evse_power) {
     EXPECT_THROW(dm->check_integrity(evse_connector_structure), DeviceModelError);
 
     // Now remove the complete variable.
-    device_model_test_helper.remove_variable_from_db("EVSE", std::nullopt, 1, std::nullopt, "Power",
-                                                     std::nullopt);
+    device_model_test_helper.remove_variable_from_db("EVSE", std::nullopt, 1, std::nullopt, "Power", std::nullopt);
     dm = device_model_test_helper.get_device_model();
     // This should also throw an exception.
     EXPECT_THROW(dm->check_integrity(evse_connector_structure), DeviceModelError);

tests/lib/ocpp/v201/test_init_device_model_db.cpp

@@ -427,25 +427,6 @@ TEST_F(InitDeviceModelDbTest, default_device_model_config) {
     EXPECT_NO_THROW(db.initialize_database(CONFIG_PATH_DEFAULT, true));
 }
 
-TEST_F(InitDeviceModelDbTest, missing_required_values) {
-    // Test if initializing fails when there is a missing required value.
-    InitDeviceModelDb db(DATABASE_PATH, MIGRATION_FILES_PATH);
-    try {
-        db.initialize_database(CONFIGS_PATH_REQUIRED_NO_VALUE, true);
-        FAIL() << "Expected InitDeviceModelDbError, but no exception was thrown";
-    } catch (const InitDeviceModelDbError& exception) {
-        EXPECT_EQ(std::string(exception.what()), "Check integrity failed:\n"
-                                                 "- Component UnitTestCtrlr, evse 2, connector 3\n"
-                                                 "  - Variable UnitTestPropertyAName, errors:\n"
-                                                 "    - No value set for Actual attribute for required variable.\n"
-                                                 "  - Variable UnitTestPropertyCName, errors:\n"
-                                                 "    - Could not find required Actual attribute.\n");
-    } catch (const std::exception& exception) {
-        FAIL() << "Expected InitDeviceModelDbError, but exception of type " << typeid(exception).name()
-               << " was thrown";
-    }
-}
-
 TEST_F(InitDeviceModelDbTest, wrong_type) {
     // Test if initializing fails when there is a missing required value.
     InitDeviceModelDb db(DATABASE_PATH, MIGRATION_FILES_PATH);