commit 6fc301fbc3775730a0e69f215110ec93bd9026f3
author Jason Ling <jasonling@google.com> Thu Jul 23 12:39:57 2020 -0700
committer Jason Ling <jasonling@google.com> Thu Jul 23 15:31:54 2020 -0700
tree 916d533b0cd00c12961cd5680f2924155acf8167
parent 991ebd80e10e4ecc6e4959f36d574385e13bd38d

dbus:config: add descriptive failures for missing attributes

dbus configuration expects a minimum set of attributes to be present in
the configuration. When one of these configurations are missing throw a
more descriptive error.

Tested:
modified entity-manager configuration to intentionally omit a required
attribute.

swampd[3402]: terminate called after throwing an instance of
'std::runtime_error'
swampd[3402]:   what():  missing attribute FFGainCoefficient

Signed-off-by: Jason Ling <jasonling@google.com>
Change-Id: I427ec343198d8e2b8db8cf6d8dc616c14dcbca9b

dbus/dbusconfiguration.cpp

diff --git a/dbus/dbusconfiguration.cpp b/dbus/dbusconfiguration.cpp
index 671a436..bfa2a7c 100644
--- a/dbus/dbusconfiguration.cpp
+++ b/dbus/dbusconfiguration.cpp
@@ -84,7 +84,6 @@
             matches.push_back(sensor);
         }
     }
-
     return matches.size() > 0;
 }
 
@@ -324,22 +323,40 @@
         eventHandler, &timer);
 }
 
+/**
+ * retrieve an attribute from the pid configuration map
+ * @param[in] base - the PID configuration map, keys are the attributes and
+ * value is the variant associated with that attribute.
+ * @param attributeName - the name of the attribute
+ * @return a variant holding the value associated with a key
+ * @throw runtime_error : attributeName is not in base
+ */
+inline DbusVariantType getPIDAttribute(
+    const std::unordered_map<std::string, DbusVariantType>& base,
+    const std::string& attributeName)
+{
+    auto search = base.find(attributeName);
+    if (search == base.end())
+    {
+        throw std::runtime_error("missing attribute " + attributeName);
+    }
+    return search->second;
+}
+
 void populatePidInfo(
     sdbusplus::bus::bus& bus,
     const std::unordered_map<std::string, DbusVariantType>& base,
     struct conf::ControllerInfo& info, const std::string* thresholdProperty)
 {
-
-    info.type = std::get<std::string>(base.at("Class"));
-
+    info.type = std::get<std::string>(getPIDAttribute(base, "Class"));
     if (info.type == "fan")
     {
         info.setpoint = 0;
     }
     else
     {
-        info.setpoint =
-            std::visit(VariantToDoubleVisitor(), base.at("SetPoint"));
+        info.setpoint = std::visit(VariantToDoubleVisitor(),
+                                   getPIDAttribute(base, "SetPoint"));
     }
 
     if (thresholdProperty != nullptr)
@@ -373,26 +390,26 @@
     }
 
     info.pidInfo.ts = 1.0; // currently unused
-    info.pidInfo.proportionalCoeff =
-        std::visit(VariantToDoubleVisitor(), base.at("PCoefficient"));
-    info.pidInfo.integralCoeff =
-        std::visit(VariantToDoubleVisitor(), base.at("ICoefficient"));
-    info.pidInfo.feedFwdOffset =
-        std::visit(VariantToDoubleVisitor(), base.at("FFOffCoefficient"));
-    info.pidInfo.feedFwdGain =
-        std::visit(VariantToDoubleVisitor(), base.at("FFGainCoefficient"));
-    info.pidInfo.integralLimit.max =
-        std::visit(VariantToDoubleVisitor(), base.at("ILimitMax"));
-    info.pidInfo.integralLimit.min =
-        std::visit(VariantToDoubleVisitor(), base.at("ILimitMin"));
-    info.pidInfo.outLim.max =
-        std::visit(VariantToDoubleVisitor(), base.at("OutLimitMax"));
-    info.pidInfo.outLim.min =
-        std::visit(VariantToDoubleVisitor(), base.at("OutLimitMin"));
+    info.pidInfo.proportionalCoeff = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "PCoefficient"));
+    info.pidInfo.integralCoeff = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "ICoefficient"));
+    info.pidInfo.feedFwdOffset = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "FFOffCoefficient"));
+    info.pidInfo.feedFwdGain = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "FFGainCoefficient"));
+    info.pidInfo.integralLimit.max = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "ILimitMax"));
+    info.pidInfo.integralLimit.min = std::visit(
+        VariantToDoubleVisitor(), getPIDAttribute(base, "ILimitMin"));
+    info.pidInfo.outLim.max = std::visit(VariantToDoubleVisitor(),
+                                         getPIDAttribute(base, "OutLimitMax"));
+    info.pidInfo.outLim.min = std::visit(VariantToDoubleVisitor(),
+                                         getPIDAttribute(base, "OutLimitMin"));
     info.pidInfo.slewNeg =
-        std::visit(VariantToDoubleVisitor(), base.at("SlewNeg"));
+        std::visit(VariantToDoubleVisitor(), getPIDAttribute(base, "SlewNeg"));
     info.pidInfo.slewPos =
-        std::visit(VariantToDoubleVisitor(), base.at("SlewPos"));
+        std::visit(VariantToDoubleVisitor(), getPIDAttribute(base, "SlewPos"));
     double negativeHysteresis = 0;
     double positiveHysteresis = 0;
 
@@ -410,7 +427,6 @@
         positiveHysteresis =
             std::visit(VariantToDoubleVisitor(), findPos->second);
     }
-
     info.pidInfo.negativeHysteresis = negativeHysteresis;
     info.pidInfo.positiveHysteresis = positiveHysteresis;
 }