Add tests for device model. Remove 'required' from the database.

maaikez · Pietfried · commit c13163ed9ac4 · 2025-02-17T18:00:55.000+01:00
Signed-off-by: Maaike Zijderveld, iolar &lt;git.mail@iolar.nl&gt;
diff --git a/config/v201/component_config/custom/Connector_1_1.json b/config/v201/component_config/custom/Connector_1_1.json
@@ -19,7 +19,8 @@
         }
       ],
       "description": "This variable reports current availability state for the Connector. Optional, because already reported in StatusNotification.",
-      "type": "string"
+      "type": "string",
+      "default": ""
     },
     "ConnectorAvailable": {
       "variable_name": "Available",
diff --git a/config/v201/component_config/custom/Connector_2_1.json b/config/v201/component_config/custom/Connector_2_1.json
@@ -19,7 +19,8 @@
         }
       ],
       "description": "This variable reports current availability state for the Connector. Optional, because already reported in StatusNotification.",
-      "type": "string"
+      "type": "string",
+      "default": ""
     },
     "ConnectorAvailable": {
       "variable_name": "Available",
diff --git a/config/v201/component_config/standardized/InternalCtrlr.json b/config/v201/component_config/standardized/InternalCtrlr.json
@@ -841,17 +841,17 @@
           "characteristics": {
               "supportsMonitoring": true,
               "dataType": "SequenceList",
-              "valuesList": "ocpp2.0.1,ocpp2.1"
+              "valuesList": "2.0.1,2.1"
           },
           "attributes": [
               {
                   "type": "Actual",
                   "mutability": "ReadOnly",
-                  "value": "ocpp2.1,ocpp2.0.1"
+                  "value": "2.1,2.0.1"
               }
           ],
           "description": "List of supported OCPP versions in order of preference",
-          "default": "ocpp2.1,ocpp2.0.1",
+          "default": "2.1,2.0.1",
           "type": "string"
       }
   },
diff --git a/config/v201/device_model_migrations/3_down-variable_required.sql b/config/v201/device_model_migrations/3_down-variable_required.sql
@@ -0,0 +1,2 @@
+ALTER TABLE VARIABLE
+ADD REQUIRED INTEGER DEFAULT FALSE;
diff --git a/config/v201/device_model_migrations/3_up-variable_required.sql b/config/v201/device_model_migrations/3_up-variable_required.sql
@@ -0,0 +1,2 @@
+ALTER TABLE VARIABLE
+DROP COLUMN REQUIRED;
diff --git a/include/ocpp/v201/init_device_model_db.hpp b/include/ocpp/v201/init_device_model_db.hpp
@@ -43,15 +43,13 @@ namespace ocpp::v201 {
 /// \brief Class that holds a component.
 ///
 /// When the component is read from the database, the component id will be set.
-/// When the component is read from the component config file, the 'required' vector will be filled.
 ///
 struct ComponentKey {
     std::optional<uint64_t> db_id;       ///< \brief Component id in the database.
     std::string name;                    ///< \brief Component name.
     std::optional<std::string> instance; ///< \brief Component instance.
     std::optional<int32_t> evse_id;      ///< \brief Component evse id.
     std::optional<int32_t> connector_id; ///< \brief Component connector id.
-    std::vector<std::string> required;   ///< \brief List of required variables.
 
     ///
     /// \brief operator <, needed to add this class as key in a map.
@@ -85,8 +83,6 @@ struct DeviceModelVariable {
     VariableCharacteristics characteristics;
     /// \brief Variable attributes
     std::vector<DbVariableAttribute> attributes;
-    /// \brief True if variable is required
-    bool required;
     /// \brief Variable instance
     std::optional<std::string> instance;
     /// \brief Default value, if this is set in the component config json
@@ -221,11 +217,9 @@ class InitDeviceModelDb : public common::DatabaseHandlerCommon {
     ///
     /// \brief Get all component properties (variables) from the given (component) json.
     /// \param component_properties The json component properties
-    /// \param required_properties  The vector of required properties of this component.
     /// \return A vector with all Variables belonging to this component.
     ///
-    std::vector<DeviceModelVariable> get_all_component_properties(const json& component_properties,
-                                                                  std::vector<std::string> required_properties);
+    std::vector<DeviceModelVariable> get_all_component_properties(const json& component_properties);
 
     ///
     /// \brief Insert variable characteristics
diff --git a/lib/ocpp/common/types.cpp b/lib/ocpp/common/types.cpp
@@ -1061,11 +1061,11 @@ namespace conversions {
 std::string ocpp_protocol_version_to_string(OcppProtocolVersion e) {
     switch (e) {
     case OcppProtocolVersion::v16:
-        return "ocpp1.6";
+        return "1.6";
     case OcppProtocolVersion::v201:
-        return "ocpp2.0.1";
+        return "2.0.1";
     case OcppProtocolVersion::v21:
-        return "ocpp2.1";
+        return "2.1";
     case OcppProtocolVersion::Unknown:
         return "unknown";
     }
@@ -1074,13 +1074,13 @@ std::string ocpp_protocol_version_to_string(OcppProtocolVersion e) {
 }
 
 OcppProtocolVersion string_to_ocpp_protocol_version(const std::string& s) {
-    if (s == "ocpp1.6") {
+    if (s == "1.6") {
         return OcppProtocolVersion::v16;
     }
-    if (s == "ocpp2.0.1") {
+    if (s == "2.0.1") {
         return OcppProtocolVersion::v201;
     }
-    if (s == "ocpp2.1") {
+    if (s == "2.1") {
         return OcppProtocolVersion::v21;
     }
     if (s == "unknown") {
diff --git a/lib/ocpp/v201/ctrlr_component_variables.cpp b/lib/ocpp/v201/ctrlr_component_variables.cpp
@@ -35,104 +35,6 @@ const Variable Overload = {"Overload"};
 const Variable Fallback = {"Fallback"};
 }; // namespace StandardizedVariables
 
-const std::vector<std::pair<ComponentVariable, std::vector<RequiredComponentVariable>>>
-    required_component_available_variables{
-        {ControllerComponentVariables::AlignedDataCtrlrAvailable,
-         {ControllerComponentVariables::AlignedDataInterval, ControllerComponentVariables::AlignedDataMeasurands,
-          ControllerComponentVariables::AlignedDataTxEndedInterval,
-          ControllerComponentVariables::AlignedDataTxEndedMeasurands}},
-        {ControllerComponentVariables::LocalAuthListCtrlrAvailable,
-         {ControllerComponentVariables::LocalAuthListCtrlrEntries,
-          ControllerComponentVariables::ItemsPerMessageSendLocalList,
-          ControllerComponentVariables::BytesPerMessageSendLocalList}},
-        {ControllerComponentVariables::SampledDataCtrlrAvailable,
-         {ControllerComponentVariables::SampledDataTxEndedMeasurands,
-          ControllerComponentVariables::SampledDataTxEndedInterval,
-          ControllerComponentVariables::SampledDataTxStartedMeasurands,
-          ControllerComponentVariables::SampledDataTxUpdatedMeasurands,
-          ControllerComponentVariables::SampledDataTxUpdatedInterval}},
-        {ControllerComponentVariables::SmartChargingCtrlrAvailable,
-         {ControllerComponentVariables::ChargingProfileMaxStackLevel,
-          ControllerComponentVariables::ChargingScheduleChargingRateUnit,
-          ControllerComponentVariables::PeriodsPerSchedule, ControllerComponentVariables::EntriesChargingProfiles,
-          ControllerComponentVariables::LimitChangeSignificance,
-          ControllerComponentVariables::CompositeScheduleDefaultLimitAmps,
-          ControllerComponentVariables::CompositeScheduleDefaultLimitWatts,
-          ControllerComponentVariables::CompositeScheduleDefaultNumberPhases,
-          ControllerComponentVariables::SupplyVoltage}},
-        {ControllerComponentVariables::TariffCostCtrlrAvailableTariff,
-         {ControllerComponentVariables::TariffFallbackMessage}},
-        {ControllerComponentVariables::TariffCostCtrlrAvailableCost,
-         {ControllerComponentVariables::TotalCostFallbackMessage,
-          ControllerComponentVariables::TariffCostCtrlrCurrency}},
-        {ControllerComponentVariables::MonitoringCtrlrAvailable,
-         {ControllerComponentVariables::ItemsPerMessageSetVariableMonitoring,
-          ControllerComponentVariables::BytesPerMessageSetVariableMonitoring}},
-        {ControllerComponentVariables::DisplayMessageCtrlrAvailable,
-         {ControllerComponentVariables::NumberOfDisplayMessages,
-          ControllerComponentVariables::DisplayMessageSupportedFormats,
-          ControllerComponentVariables::DisplayMessageSupportedPriorities}}};
-
-const std::vector<RequiredComponentVariable> required_variables{
-    ControllerComponentVariables::ChargePointId,
-    ControllerComponentVariables::NetworkConnectionProfiles,
-    ControllerComponentVariables::ChargeBoxSerialNumber,
-    ControllerComponentVariables::ChargePointModel,
-    ControllerComponentVariables::ChargePointVendor,
-    ControllerComponentVariables::FirmwareVersion,
-    ControllerComponentVariables::SupportedCiphers12,
-    ControllerComponentVariables::SupportedCiphers13,
-    ControllerComponentVariables::LogMessagesFormat,
-    ControllerComponentVariables::NumberOfConnectors,
-    ControllerComponentVariables::SupportedOcppVersions,
-    ControllerComponentVariables::AuthorizeRemoteStart,
-    ControllerComponentVariables::LocalAuthorizeOffline,
-    ControllerComponentVariables::LocalPreAuthorize,
-    ControllerComponentVariables::ChargingStationAvailabilityState,
-    ControllerComponentVariables::ChargingStationAvailable,
-    ControllerComponentVariables::ChargingStationSupplyPhases,
-    ControllerComponentVariables::ClockCtrlrDateTime,
-    ControllerComponentVariables::TimeSource,
-    ControllerComponentVariables::BytesPerMessageGetReport,
-    ControllerComponentVariables::BytesPerMessageGetVariables,
-    ControllerComponentVariables::BytesPerMessageSetVariables,
-    ControllerComponentVariables::ItemsPerMessageGetReport,
-    ControllerComponentVariables::ItemsPerMessageGetVariables,
-    ControllerComponentVariables::ItemsPerMessageSetVariables,
-    ControllerComponentVariables::ContractValidationOffline,
-    ControllerComponentVariables::FileTransferProtocols,
-    ControllerComponentVariables::MessageTimeout,
-    ControllerComponentVariables::MessageAttemptInterval,
-    ControllerComponentVariables::MessageAttempts,
-    ControllerComponentVariables::NetworkConfigurationPriority,
-    ControllerComponentVariables::NetworkProfileConnectionAttempts,
-    ControllerComponentVariables::OfflineThreshold,
-    ControllerComponentVariables::ResetRetries,
-    ControllerComponentVariables::RetryBackOffRandomRange,
-    ControllerComponentVariables::RetryBackOffRepeatTimes,
-    ControllerComponentVariables::RetryBackOffWaitMinimum,
-    ControllerComponentVariables::UnlockOnEVSideDisconnect,
-    ControllerComponentVariables::WebSocketPingInterval,
-    ControllerComponentVariables::CertificateEntries,
-    ControllerComponentVariables::SecurityCtrlrIdentity,
-    ControllerComponentVariables::OrganizationName,
-    ControllerComponentVariables::SecurityProfile,
-    ControllerComponentVariables::EVConnectionTimeOut,
-    ControllerComponentVariables::StopTxOnEVSideDisconnect,
-    ControllerComponentVariables::StopTxOnInvalidId,
-    ControllerComponentVariables::TxStartPoint,
-    ControllerComponentVariables::TxStopPoint,
-    ControllerComponentVariables::TxStartPoint,
-    ControllerComponentVariables::TxStopPoint};
-
-// Note: Power is also required, but the value is not required but the maxLimit. So that is why it is not added here.
-const std::vector<Variable> required_evse_variables{
-    EvseComponentVariables::Available, EvseComponentVariables::AvailabilityState, EvseComponentVariables::SupplyPhases};
-
-const std::vector<Variable> required_connector_variables{
-    ConnectorComponentVariables::Available, ConnectorComponentVariables::AvailabilityState,
-    ConnectorComponentVariables::SupplyPhases, ConnectorComponentVariables::Type};
-
 namespace ControllerComponentVariables {
 const ComponentVariable InternalCtrlrEnabled = {
     ControllerComponents::InternalCtrlr,
@@ -1278,7 +1180,7 @@ namespace ConnectorComponentVariables {
 
 const Variable Available = {"Available"};
 const Variable AvailabilityState = {"AvailabilityState"};
-const Variable Type = {"Type"};
+const Variable Type = {"ConnectorType"};
 const Variable SupplyPhases = {"SupplyPhases"};
 
 ComponentVariable get_component_variable(const int32_t evse_id, const int32_t connector_id, const Variable& variable) {
@@ -1291,5 +1193,103 @@ ComponentVariable get_component_variable(const int32_t evse_id, const int32_t co
 }
 } // namespace ConnectorComponentVariables
 
+const std::vector<std::pair<ComponentVariable, std::vector<RequiredComponentVariable>>>
+    required_component_available_variables{
+        {ControllerComponentVariables::AlignedDataCtrlrAvailable,
+         {ControllerComponentVariables::AlignedDataInterval, ControllerComponentVariables::AlignedDataMeasurands,
+          ControllerComponentVariables::AlignedDataTxEndedInterval,
+          ControllerComponentVariables::AlignedDataTxEndedMeasurands}},
+        {ControllerComponentVariables::LocalAuthListCtrlrAvailable,
+         {ControllerComponentVariables::LocalAuthListCtrlrEntries,
+          ControllerComponentVariables::ItemsPerMessageSendLocalList,
+          ControllerComponentVariables::BytesPerMessageSendLocalList}},
+        {ControllerComponentVariables::SampledDataCtrlrAvailable,
+         {ControllerComponentVariables::SampledDataTxEndedMeasurands,
+          ControllerComponentVariables::SampledDataTxEndedInterval,
+          ControllerComponentVariables::SampledDataTxStartedMeasurands,
+          ControllerComponentVariables::SampledDataTxUpdatedMeasurands,
+          ControllerComponentVariables::SampledDataTxUpdatedInterval}},
+        {ControllerComponentVariables::SmartChargingCtrlrAvailable,
+         {ControllerComponentVariables::ChargingProfileMaxStackLevel,
+          ControllerComponentVariables::ChargingScheduleChargingRateUnit,
+          ControllerComponentVariables::PeriodsPerSchedule, ControllerComponentVariables::EntriesChargingProfiles,
+          ControllerComponentVariables::LimitChangeSignificance,
+          ControllerComponentVariables::CompositeScheduleDefaultLimitAmps,
+          ControllerComponentVariables::CompositeScheduleDefaultLimitWatts,
+          ControllerComponentVariables::CompositeScheduleDefaultNumberPhases,
+          ControllerComponentVariables::SupplyVoltage}},
+        {ControllerComponentVariables::TariffCostCtrlrAvailableTariff,
+         {ControllerComponentVariables::TariffFallbackMessage}},
+        {ControllerComponentVariables::TariffCostCtrlrAvailableCost,
+         {ControllerComponentVariables::TotalCostFallbackMessage,
+          ControllerComponentVariables::TariffCostCtrlrCurrency}},
+        {ControllerComponentVariables::MonitoringCtrlrAvailable,
+         {ControllerComponentVariables::ItemsPerMessageSetVariableMonitoring,
+          ControllerComponentVariables::BytesPerMessageSetVariableMonitoring}},
+        {ControllerComponentVariables::DisplayMessageCtrlrAvailable,
+         {ControllerComponentVariables::NumberOfDisplayMessages,
+          ControllerComponentVariables::DisplayMessageSupportedFormats,
+          ControllerComponentVariables::DisplayMessageSupportedPriorities}}};
+
+const std::vector<RequiredComponentVariable> required_variables{
+    ControllerComponentVariables::ChargePointId,
+    ControllerComponentVariables::NetworkConnectionProfiles,
+    ControllerComponentVariables::ChargeBoxSerialNumber,
+    ControllerComponentVariables::ChargePointModel,
+    ControllerComponentVariables::ChargePointVendor,
+    ControllerComponentVariables::FirmwareVersion,
+    ControllerComponentVariables::SupportedCiphers12,
+    ControllerComponentVariables::SupportedCiphers13,
+    ControllerComponentVariables::LogMessagesFormat,
+    ControllerComponentVariables::NumberOfConnectors,
+    ControllerComponentVariables::SupportedOcppVersions,
+    ControllerComponentVariables::AuthorizeRemoteStart,
+    ControllerComponentVariables::LocalAuthorizeOffline,
+    ControllerComponentVariables::LocalPreAuthorize,
+    ControllerComponentVariables::ChargingStationAvailabilityState,
+    ControllerComponentVariables::ChargingStationAvailable,
+    ControllerComponentVariables::ChargingStationSupplyPhases,
+    ControllerComponentVariables::ClockCtrlrDateTime,
+    ControllerComponentVariables::TimeSource,
+    ControllerComponentVariables::BytesPerMessageGetReport,
+    ControllerComponentVariables::BytesPerMessageGetVariables,
+    ControllerComponentVariables::BytesPerMessageSetVariables,
+    ControllerComponentVariables::ItemsPerMessageGetReport,
+    ControllerComponentVariables::ItemsPerMessageGetVariables,
+    ControllerComponentVariables::ItemsPerMessageSetVariables,
+    ControllerComponentVariables::ContractValidationOffline,
+    ControllerComponentVariables::FileTransferProtocols,
+    ControllerComponentVariables::MessageTimeout,
+    ControllerComponentVariables::MessageAttemptInterval,
+    ControllerComponentVariables::MessageAttempts,
+    ControllerComponentVariables::NetworkConfigurationPriority,
+    ControllerComponentVariables::NetworkProfileConnectionAttempts,
+    ControllerComponentVariables::OfflineThreshold,
+    ControllerComponentVariables::ResetRetries,
+    ControllerComponentVariables::RetryBackOffRandomRange,
+    ControllerComponentVariables::RetryBackOffRepeatTimes,
+    ControllerComponentVariables::RetryBackOffWaitMinimum,
+    ControllerComponentVariables::UnlockOnEVSideDisconnect,
+    ControllerComponentVariables::WebSocketPingInterval,
+    ControllerComponentVariables::CertificateEntries,
+    ControllerComponentVariables::SecurityCtrlrIdentity,
+    ControllerComponentVariables::OrganizationName,
+    ControllerComponentVariables::SecurityProfile,
+    ControllerComponentVariables::EVConnectionTimeOut,
+    ControllerComponentVariables::StopTxOnEVSideDisconnect,
+    ControllerComponentVariables::StopTxOnInvalidId,
+    ControllerComponentVariables::TxStartPoint,
+    ControllerComponentVariables::TxStopPoint,
+    ControllerComponentVariables::TxStartPoint,
+    ControllerComponentVariables::TxStopPoint};
+
+// Note: Power is also required, but the value is not required but the maxLimit. So that is why it is not added here.
+const std::vector<Variable> required_evse_variables{
+    EvseComponentVariables::Available, EvseComponentVariables::AvailabilityState, EvseComponentVariables::SupplyPhases};
+
+const std::vector<Variable> required_connector_variables{
+    ConnectorComponentVariables::Available, ConnectorComponentVariables::AvailabilityState,
+    ConnectorComponentVariables::SupplyPhases, ConnectorComponentVariables::Type};
+
 } // namespace v201
 } // namespace ocpp
diff --git a/lib/ocpp/v201/device_model.cpp b/lib/ocpp/v201/device_model.cpp
@@ -129,9 +129,9 @@ void DeviceModel::check_variable_has_value(const ComponentVariable& component_va
     const auto response = this->request_value_internal(component_variable.component,
                                                        component_variable.variable.value(), attribute, value, true);
 
-    if (response != GetVariableStatusEnum::Accepted || value.empty()) {
-        throw DeviceModelError("Required variable " + component_variable.variable->name.get() +
-                               " does not have a value in the device model");
+    if (response != GetVariableStatusEnum::Accepted) {
+        throw DeviceModelError("Required variable " + component_variable.variable->name.get() + " of component " +
+                               component_variable.component.name.get() + " does not have a value in the device model");
     }
 }
 
@@ -563,7 +563,7 @@ void DeviceModel::check_integrity(const std::map<int32_t, int32_t>& evse_connect
             }
         }
     } catch (const DeviceModelError& e) {
-        EVLOG_error << "Integrity check in Device Model failed:" << e.what();
+        EVLOG_error << "Integrity check in Device Model failed: " << e.what();
         throw e;
     }
 }
diff --git a/lib/ocpp/v201/init_device_model_db.cpp b/lib/ocpp/v201/init_device_model_db.cpp
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
diff --git a/tests/lib/ocpp/v201/test_device_model.cpp b/tests/lib/ocpp/v201/test_device_model.cpp
diff --git a/tests/lib/ocpp/v201/test_device_model_storage_sqlite.cpp b/tests/lib/ocpp/v201/test_device_model_storage_sqlite.cpp

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE VARIABLE`
	`2`	`+ADD REQUIRED INTEGER DEFAULT FALSE;`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+ALTER TABLE VARIABLE`
	`2`	`+DROP COLUMN REQUIRED;`
Original file line number	Diff line number	Diff line change
`@@ -129,9 +129,9 @@ void DeviceModel::check_variable_has_value(const ComponentVariable& component_va`
`129`	`129`	`const auto response = this->request_value_internal(component_variable.component,`
`130`	`130`	`component_variable.variable.value(), attribute, value, true);`
`131`	`131`
`132`		`- if (response != GetVariableStatusEnum::Accepted \|\| value.empty()) {`
`133`		`- throw DeviceModelError("Required variable " + component_variable.variable->name.get() +`
`134`		`- " does not have a value in the device model");`
	`132`	`+ if (response != GetVariableStatusEnum::Accepted) {`
	`133`	`+ throw DeviceModelError("Required variable " + component_variable.variable->name.get() + " of component " +`
	`134`	`+ component_variable.component.name.get() + " does not have a value in the device model");`
`135`	`135`	`}`
`136`	`136`	`}`
`137`	`137`
`@@ -563,7 +563,7 @@ void DeviceModel::check_integrity(const std::map<int32_t, int32_t>& evse_connect`
`563`	`563`	`}`
`564`	`564`	`}`
`565`	`565`	`} catch (const DeviceModelError& e) {`
`566`		`- EVLOG_error << "Integrity check in Device Model failed:" << e.what();`
	`566`	`+ EVLOG_error << "Integrity check in Device Model failed: " << e.what();`
`567`	`567`	`throw e;`
`568`	`568`	`}`
`569`	`569`	`}`