Adding new states in WarmState Adapter.

Author: divyagayathri-hcl

common/warm_restart.cpp

@@ -14,22 +14,34 @@ const std::string WarmStart::kRegistrationCheckpointKey = "checkpoint";
 const std::string WarmStart::kRegistrationReconciliationKey = "reconciliation";
 const std::string WarmStart::kRegistrationTimestampKey = "timestamp";
 
-const WarmStart::WarmStartStateNameMap WarmStart::warmStartStateNameMap =
+const WarmStart::WarmStartStateNameMap* WarmStart::warmStartStateNameMap()
 {
-    {INITIALIZED,   "initialized"},
-    {RESTORED,      "restored"},
-    {REPLAYED,      "replayed"},
-    {RECONCILED,    "reconciled"},
-    {WSDISABLED,    "disabled"},
-    {WSUNKNOWN,     "unknown"}
-};
-
-const WarmStart::DataCheckStateNameMap WarmStart::dataCheckStateNameMap =
+    static const auto* const warmStartStateNameMap =
+        new WarmStartStateNameMap({
+            {INITIALIZED,   "initialized"},
+            {RESTORED,      "restored"},
+            {REPLAYED,      "replayed"},
+            {RECONCILED,    "reconciled"},
+            {WSDISABLED,    "disabled"},
+            {WSUNKNOWN,     "unknown"},
+            {FROZEN,        "frozen"},
+            {QUIESCENT,     "quiescent"},
+            {CHECKPOINTED,  "checkpointed"},
+            {FAILED,        "failed"}
+        });
+    return warmStartStateNameMap;
+}
+
+const WarmStart::DataCheckStateNameMap* WarmStart::dataCheckStateNameMap()
 {
-    {CHECK_IGNORED,   "ignored"},
-    {CHECK_PASSED,    "passed"},
-    {CHECK_FAILED,    "failed"}
-};
+    static const auto* const dataCheckStateNameMap =
+        new DataCheckStateNameMap({
+            {CHECK_IGNORED,   "ignored"},
+            {CHECK_PASSED,    "passed"},
+            {CHECK_FAILED,    "failed"}
+        });
+    return dataCheckStateNameMap;
+}
 
 const WarmStart::WarmBootNotificationNameMap* WarmStart::warmBootNotificationNameMap()
 {
@@ -309,7 +321,7 @@ void WarmStart::getWarmStartState(const std::string &app_name, WarmStartState &s
      */
     state = WSUNKNOWN;
 
-    for (auto it = warmStartStateNameMap.begin(); it != warmStartStateNameMap.end(); it++)
+    for (auto it = warmStartStateNameMap()->begin(); it != warmStartStateNameMap()->end(); it++)
     {
         if (it->second == statestr)
         {
@@ -336,7 +348,7 @@ void WarmStart::setWarmStartState(const std::string &app_name, WarmStartState st
 
     warmStart.m_stateWarmRestartTable->hset(app_name,
                                             "state",
-                                            warmStartStateNameMap.at(state).c_str());
+                                            warmStartStateNameMap()->at(state).c_str());
 
     if (app_name == warmStart.m_appName)
     {
@@ -346,7 +358,7 @@ void WarmStart::setWarmStartState(const std::string &app_name, WarmStartState st
 
     SWSS_LOG_NOTICE("%s warm start state changed to %s",
                     app_name.c_str(),
-                    warmStartStateNameMap.at(state).c_str());
+                    warmStartStateNameMap()->at(state).c_str());
 }
 
 // Set the WarmStart data check state for a particular application.
@@ -362,12 +374,12 @@ void WarmStart::setDataCheckState(const std::string &app_name, DataCheckStage st
     }
     warmStart.m_stateWarmRestartTable->hset(app_name,
                                             stageField,
-                                            dataCheckStateNameMap.at(state).c_str());
+                                            dataCheckStateNameMap()->at(state).c_str());
 
     SWSS_LOG_NOTICE("%s %s result %s",
                     app_name.c_str(),
                     stageField.c_str(),
-                    dataCheckStateNameMap.at(state).c_str());
+                    dataCheckStateNameMap()->at(state).c_str());
 }
 
 WarmStart::DataCheckState WarmStart::getDataCheckState(const std::string &app_name, DataCheckStage stage)
@@ -387,7 +399,7 @@ WarmStart::DataCheckState WarmStart::getDataCheckState(const std::string &app_na
 
     DataCheckState state = CHECK_IGNORED;
 
-    for (auto it = dataCheckStateNameMap.begin(); it != dataCheckStateNameMap.end(); it++)
+    for (auto it = dataCheckStateNameMap()->begin(); it != dataCheckStateNameMap()->end(); it++)
     {
         if (it->second == stateStr)
         {

common/warm_restart.h

@@ -27,6 +27,10 @@ class WarmStart
         RECONCILED,
         WSDISABLED,
         WSUNKNOWN,
+        FROZEN,
+        QUIESCENT,
+        CHECKPOINTED,
+        FAILED,
     };
 
     enum DataCheckState
@@ -49,10 +53,10 @@ class WarmStart
     };
 
     typedef std::map<WarmStartState, std::string>  WarmStartStateNameMap;
-    static const WarmStartStateNameMap warmStartStateNameMap;
+    static const WarmStartStateNameMap* warmStartStateNameMap();
 
     typedef std::map<DataCheckState, std::string>  DataCheckStateNameMap;
-    static const DataCheckStateNameMap dataCheckStateNameMap;
+    static const DataCheckStateNameMap* dataCheckStateNameMap();
 
     typedef std::map<WarmBootNotification, std::string>  WarmBootNotificationNameMap;
     static const WarmBootNotificationNameMap* warmBootNotificationNameMap();

tests/warm_restart_ut.cpp

@@ -168,6 +168,49 @@ TEST(WarmRestart, getWarmStartTimer)
     EXPECT_EQ(timer, 5000u);
 }
 
+TEST(WarmRestart, set_get_WarmStartState)
+{
+    DBConnector stateDb("STATE_DB", 0, true);
+    Table stateWarmRestartTable(&stateDb, STATE_WARM_RESTART_TABLE_NAME);
+    Table stateWarmRestartEnableTable(&stateDb, STATE_WARM_RESTART_ENABLE_TABLE_NAME);
+
+    DBConnector configDb("CONFIG_DB", 0, true);
+    Table cfgWarmRestartTable(&configDb, CFG_WARM_RESTART_TABLE_NAME);
+
+    //Clean up warm restart state for testAppName and warm restart config for testDockerName
+    stateWarmRestartTable.del(testAppName);
+    cfgWarmRestartTable.del(testDockerName);
+
+    //Initialize WarmStart class for TestApp
+    WarmStart::initialize(testAppName, testDockerName, 0, true);
+
+    WarmStart::WarmStartState warmStartStates[] =
+        {
+            WarmStart::INITIALIZED,
+            WarmStart::RESTORED,
+            WarmStart::REPLAYED,
+            WarmStart::RECONCILED,
+            WarmStart::WSDISABLED,
+            WarmStart::WSUNKNOWN,
+            WarmStart::FROZEN,
+            WarmStart::QUIESCENT,
+            WarmStart::CHECKPOINTED,
+            WarmStart::FAILED,
+        };
+
+    for (const auto &currState : warmStartStates) {
+        WarmStart::setWarmStartState(testAppName, currState);
+
+        string state;
+        stateWarmRestartTable.hget(testAppName, "state", state);
+        EXPECT_EQ(state, WarmStart::warmStartStateNameMap()->at(currState).c_str());
+
+        WarmStart::WarmStartState ret_state;
+        WarmStart::getWarmStartState(testAppName, ret_state);
+        EXPECT_EQ(ret_state, currState);
+    }
+}
+
 TEST(WarmRestart, set_get_DataCheckState)
 {
     DBConnector stateDb("STATE_DB", 0, true);