[UT] [Portsyncd] Added Unit Tests for portsyncd

portsyncd/Makefile.am

@@ -8,7 +8,7 @@ else
 DBGFLAGS = -g
 endif
 
-portsyncd_SOURCES = $(top_srcdir)/lib/gearboxutils.cpp portsyncd.cpp linksync.cpp  $(top_srcdir)/cfgmgr/shellcmd.h
+portsyncd_SOURCES = $(top_srcdir)/lib/gearboxutils.cpp portsyncd.cpp linksync.cpp portsyncd_helper.cpp $(top_srcdir)/cfgmgr/shellcmd.h
 
 portsyncd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_ASAN)
 portsyncd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_ASAN)

portsyncd/linksync.cpp

@@ -6,8 +6,6 @@
 #include <netlink/route/link.h>
 #include "logger.h"
 #include "netmsg.h"
-#include "dbconnector.h"
-#include "producerstatetable.h"
 #include "tokenize.h"
 #include "exec.h"
 
@@ -90,7 +88,7 @@ LinkSync::LinkSync(DBConnector *appl_db, DBConnector *state_db) :
 
     if (!WarmStart::isWarmStart())
     {
-        /* See the comments for g_portSet in portsyncd.cpp */
+        /* See the comments for g_portSet  */
         for (auto port_iter = g_portSet.begin(); port_iter != g_portSet.end();)
         {
             string port = *port_iter;
@@ -260,3 +258,4 @@ void LinkSync::onMsg(int nlmsg_type, struct nl_object *obj)
         SWSS_LOG_NOTICE("Cannot find %s in port table", key.c_str());
     }
 }
+

portsyncd/linksync.h

@@ -4,8 +4,16 @@
 #include "dbconnector.h"
 #include "producerstatetable.h"
 #include "netmsg.h"
+#include "exec.h"
+#include "warm_restart.h"
+#include "shellcmd.h"
 
 #include <map>
+#include <set>
+#include <vector>
+#include <set>
+#include <map>
+#include <list>
 
 namespace swss {
 
@@ -28,4 +36,6 @@ class LinkSync : public NetMsg
 
 }
 
+void handlePortConfigFromConfigDB(swss::ProducerStateTable &, swss::DBConnector &, bool );
+
 #endif

portsyncd/portsyncd.cpp

@@ -2,38 +2,22 @@
 #include <iostream>
 #include <fstream>
 #include <sstream>
-#include <vector>
-#include <set>
-#include <map>
-#include <list>
 #include <sys/stat.h>
 #include "dbconnector.h"
 #include "select.h"
 #include "netdispatcher.h"
 #include "netlink.h"
-#include "producerstatetable.h"
 #include "portsyncd/linksync.h"
 #include "subscriberstatetable.h"
-#include "exec.h"
 #include "warm_restart.h"
 
 using namespace std;
 using namespace swss;
 
 #define DEFAULT_SELECT_TIMEOUT 1000 /* ms */
 
-/*
- * This g_portSet contains all the front panel ports that the corresponding
- * host interfaces needed to be created. When this LinkSync class is
- * initialized, we check the database to see if some of the ports' host
- * interfaces are already created and remove them from this set. We will
- * remove the rest of the ports in the set when receiving the first netlink
- * message indicating that the host interfaces are created. After the set
- * is empty, we send out the signal PortInitDone. g_init is used to limit the
- * command to be run only once.
- */
-set<string> g_portSet;
-bool g_init = false;
+extern set<string> g_portSet;
+extern bool g_init;
 
 void usage()
 {
@@ -42,11 +26,6 @@ void usage()
     cout << "       this program will exit if configDB does not contain that info" << endl;
 }
 
-void handlePortConfigFile(ProducerStateTable &p, string file, bool warm);
-void handlePortConfigFromConfigDB(ProducerStateTable &p, DBConnector &cfgDb, bool warm);
-void handleVlanIntfFile(string file);
-void checkPortInitDone(DBConnector *appl_db);
-
 int main(int argc, char **argv)
 {
     Logger::linkToDbNative("portsyncd");
@@ -152,50 +131,3 @@ int main(int argc, char **argv)
 
     return 1;
 }
-
-static void notifyPortConfigDone(ProducerStateTable &p)
-{
-    /* Notify that all ports added */
-    FieldValueTuple finish_notice("count", to_string(g_portSet.size()));
-    vector<FieldValueTuple> attrs = { finish_notice };
-    p.set("PortConfigDone", attrs);
-}
-
-void handlePortConfigFromConfigDB(ProducerStateTable &p, DBConnector &cfgDb, bool warm)
-{
-    SWSS_LOG_ENTER();
-
-    SWSS_LOG_NOTICE("Getting port configuration from ConfigDB...");
-
-    Table table(&cfgDb, CFG_PORT_TABLE_NAME);
-    std::vector<FieldValueTuple> ovalues;
-    std::vector<string> keys;
-    table.getKeys(keys);
-
-    if (keys.empty())
-    {
-        SWSS_LOG_NOTICE("ConfigDB does not have port information, "
-                        "however ports can be added later on, continuing...");
-    }
-
-    for ( auto &k : keys )
-    {
-        table.get(k, ovalues);
-        vector<FieldValueTuple> attrs;
-        for ( auto &v : ovalues )
-        {
-            FieldValueTuple attr(v.first, v.second);
-            attrs.push_back(attr);
-        }
-        if (!warm)
-        {
-            p.set(k, attrs);
-        }
-        g_portSet.insert(k);
-    }
-    if (!warm)
-    {
-        notifyPortConfigDone(p);
-    }
-
-}

portsyncd/portsyncd_helper.cpp

@@ -0,0 +1,64 @@
+#include "portsyncd/linksync.h"
+
+using namespace std;
+using namespace swss;
+
+/*
+ * This g_portSet contains all the front panel ports that the corresponding
+ * host interfaces needed to be created. When this LinkSync class is
+ * initialized, we check the database to see if some of the ports' host
+ * interfaces are already created and remove them from this set. We will
+ * remove the rest of the ports in the set when receiving the first netlink
+ * message indicating that the host interfaces are created. After the set
+ * is empty, we send out the signal PortInitDone. g_init is used to limit the
+ * command to be run only once.
+ */
+set<string> g_portSet;
+bool g_init;
+
+static void notifyPortConfigDone(ProducerStateTable &p)
+{
+    /* Notify that all ports added */
+    FieldValueTuple finish_notice("count", to_string(g_portSet.size()));
+    vector<FieldValueTuple> attrs = { finish_notice };
+    p.set("PortConfigDone", attrs);
+}
+
+void handlePortConfigFromConfigDB(ProducerStateTable &p, DBConnector &cfgDb, bool warm)
+{
+    SWSS_LOG_ENTER();
+
+    SWSS_LOG_NOTICE("Getting port configuration from ConfigDB...");
+
+    Table table(&cfgDb, CFG_PORT_TABLE_NAME);
+    std::vector<FieldValueTuple> ovalues;
+    std::vector<string> keys;
+    table.getKeys(keys);
+
+    if (keys.empty())
+    {
+        SWSS_LOG_NOTICE("ConfigDB does not have port information, "
+                        "however ports can be added later on, continuing...");
+    }
+
+    for ( auto &k : keys )
+    {
+        table.get(k, ovalues);
+        vector<FieldValueTuple> attrs;
+        for ( auto &v : ovalues )
+        {
+            FieldValueTuple attr(v.first, v.second);
+            attrs.push_back(attr);
+        }
+        if (!warm)
+        {
+            p.set(k, attrs);
+        }
+        g_portSet.insert(k);
+    }
+    if (!warm)
+    {
+        notifyPortConfigDone(p);
+    }
+
+}

tests/mock_tests/Makefile.am

@@ -2,13 +2,11 @@ FLEX_CTR_DIR = $(top_srcdir)/orchagent/flex_counter
 DEBUG_CTR_DIR = $(top_srcdir)/orchagent/debug_counter
 P4_ORCH_DIR = $(top_srcdir)/orchagent/p4orch
 
-INCLUDES = -I $(FLEX_CTR_DIR) -I $(DEBUG_CTR_DIR) -I $(top_srcdir)/lib -I $(top_srcdir)/cfgmgr
-
 CFLAGS_SAI = -I /usr/include/sai
 
-TESTS = tests tests_intfmgrd
+TESTS = tests tests_intfmgrd tests_portsyncd
 
-noinst_PROGRAMS = tests tests_intfmgrd
+noinst_PROGRAMS = tests tests_intfmgrd tests_portsyncd
 
 LDADD_SAI = -lsaimeta -lsaimetadata -lsaivs -lsairedis
 
@@ -21,6 +19,10 @@ endif
 CFLAGS_GTEST =
 LDADD_GTEST = -L/usr/src/gtest
 
+## Orchagent Unit Tests
+
+tests_INCLUDES = -I $(FLEX_CTR_DIR) -I $(DEBUG_CTR_DIR) -I $(top_srcdir)/lib -I$(top_srcdir)/cfgmgr -I$(top_srcdir)/orchagent 
+
 tests_SOURCES = aclorch_ut.cpp \
                 portsorch_ut.cpp \
                 routeorch_ut.cpp \
@@ -36,10 +38,10 @@ tests_SOURCES = aclorch_ut.cpp \
                 mock_orchagent_main.cpp \
                 mock_dbconnector.cpp \
                 mock_consumerstatetable.cpp \
+                common/mock_shell_command.cpp \
                 mock_table.cpp \
                 mock_hiredis.cpp \
                 mock_redisreply.cpp \
-                mock_shell_command.cpp \
                 bulker_ut.cpp \
                 portmgr_ut.cpp \
                 fake_response_publisher.cpp \
@@ -118,26 +120,46 @@ tests_SOURCES += $(P4_ORCH_DIR)/p4orch.cpp \
 		 $(P4_ORCH_DIR)/wcmp_manager.cpp \
 		 $(P4_ORCH_DIR)/mirror_session_manager.cpp
 
-tests_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI)
-tests_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI) -I$(top_srcdir)/orchagent
+tests_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI) 
+tests_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI) $(tests_INCLUDES)
 tests_LDADD = $(LDADD_GTEST) $(LDADD_SAI) -lnl-genl-3 -lhiredis -lhiredis -lpthread \
         -lswsscommon -lswsscommon -lgtest -lgtest_main -lzmq -lnl-3 -lnl-route-3
 
+## portsyncd unit tests
+
+tests_portsyncd_SOURCES = portsyncd/portsyncd_ut.cpp \
+                          $(top_srcdir)/portsyncd/linksync.cpp \
+                          $(top_srcdir)/portsyncd/portsyncd_helper.cpp \
+                          mock_dbconnector.cpp \
+                          common/mock_shell_command.cpp \
+                          mock_table.cpp \
+                          mock_hiredis.cpp \
+                          mock_redisreply.cpp
+
+tests_portsyncd_INCLUDES = -I $(top_srcdir)/portsyncd -I $(top_srcdir)/cfgmgr
+tests_portsyncd_CXXFLAGS = -Wl,-wrap,if_nameindex -Wl,-wrap,if_freenameindex
+tests_portsyncd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST)
+tests_portsyncd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(tests_portsyncd_INCLUDES)
+tests_portsyncd_LDADD = $(LDADD_GTEST) -lnl-genl-3 -lhiredis -lhiredis \
+        -lswsscommon -lswsscommon -lgtest -lgtest_main -lnl-3 -lnl-route-3 -lpthread
+
 ## intfmgrd unit tests
 
 tests_intfmgrd_SOURCES = intfmgrd/add_ipv6_prefix_ut.cpp \
-                        $(top_srcdir)/cfgmgr/intfmgr.cpp \
-                        $(top_srcdir)/orchagent/orch.cpp \
-                        $(top_srcdir)/orchagent/request_parser.cpp \
-                        $(top_srcdir)/lib/subintf.cpp \
-                        mock_orchagent_main.cpp \
-                        mock_dbconnector.cpp \
-                        mock_table.cpp \
-                        mock_hiredis.cpp \
-                        fake_response_publisher.cpp \
-                        mock_redisreply.cpp
+                         $(top_srcdir)/cfgmgr/intfmgr.cpp \
+                         $(top_srcdir)/lib/subintf.cpp \
+                         $(top_srcdir)/orchagent/orch.cpp \
+                         $(top_srcdir)/orchagent/request_parser.cpp \
+                         mock_orchagent_main.cpp \
+                         mock_dbconnector.cpp \
+                         mock_table.cpp \
+                         mock_hiredis.cpp \
+                         fake_response_publisher.cpp \
+                         mock_redisreply.cpp \
+                         common/mock_shell_command.cpp
 
+tests_intfmgrd_INCLUDES = $(tests_INCLUDES) -I$(top_srcdir)/cfgmgr -I$(top_srcdir)/lib
 tests_intfmgrd_CFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI)
-tests_intfmgrd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI) -I $(top_srcdir)/cfgmgr -I $(top_srcdir)/orchagent/
+tests_intfmgrd_CPPFLAGS = $(DBGFLAGS) $(AM_CFLAGS) $(CFLAGS_COMMON) $(CFLAGS_GTEST) $(CFLAGS_SAI) $(tests_intfmgrd_INCLUDES)
 tests_intfmgrd_LDADD = $(LDADD_GTEST) $(LDADD_SAI) -lnl-genl-3 -lhiredis -lhiredis \
         -lswsscommon -lswsscommon -lgtest -lgtest_main -lzmq -lnl-3 -lnl-route-3 -lpthread

tests/mock_tests/common/mock_shell_command.cpp

@@ -0,0 +1,25 @@
+#include <string>
+#include <vector>
+
+/* Override this pointer for custom behavior */
+int (*callback)(const std::string &cmd, std::string &stdout) = nullptr;
+
+int mockCmdReturn = 0;
+std::string mockCmdStdcout = "";
+std::vector<std::string> mockCallArgs;
+
+namespace swss {
+    int exec(const std::string &cmd, std::string &stdout)
+    {
+        if (callback != nullptr)
+        {
+            return callback(cmd, stdout);
+        }
+        else
+        {
+            mockCallArgs.push_back(cmd);
+            stdout = mockCmdStdcout;
+            return mockCmdReturn;
+        }
+    }
+}

tests/mock_tests/intfmgrd/add_ipv6_prefix_ut.cpp

@@ -5,25 +5,17 @@
 #include <sys/stat.h>
 #include "../mock_table.h"
 #include "warm_restart.h"
-#define private public 
+#define private public
 #include "intfmgr.h"
 #undef private
 
-/* Override this pointer for custom behavior */
-int (*callback)(const std::string &cmd, std::string &stdout) = nullptr;
-std::vector<std::string> mockCallArgs;
-
-namespace swss {
-    int exec(const std::string &cmd, std::string &stdout)
-    {
-        mockCallArgs.push_back(cmd);
-        return callback(cmd, stdout);
-    }
-}
+extern int (*callback)(const std::string &cmd, std::string &stdout);
+extern std::vector<std::string> mockCallArgs;
 
 bool Ethernet0IPv6Set = false;
 
 int cb(const std::string &cmd, std::string &stdout){
+    mockCallArgs.push_back(cmd);
     if (cmd == "sysctl -w net.ipv6.conf.\"Ethernet0\".disable_ipv6=0") Ethernet0IPv6Set = true;
     else if (cmd.find("/sbin/ip -6 address \"add\"") == 0) {
         return Ethernet0IPv6Set ? 0 : 2;

tests/mock_tests/mock_table.cpp

@@ -73,16 +73,15 @@ namespace swss
             keys.push_back(it.first);
         }
     }
-
-
+
     void Table::del(const std::string &key, const std::string& /* op */, const std::string& /*prefix*/)
     {
         auto table = gDB[m_pipe->getDbId()].find(getTableName());
         if (table != gDB[m_pipe->getDbId()].end()){
             table->second.erase(key);
         }
     }
-
+    
     void ProducerStateTable::set(const std::string &key,
                                  const std::vector<FieldValueTuple> &values,
                                  const std::string &op,