[ssw][ha] consume new ha_scope fields (sonic-net#3825)

* What I did
Address the minor changes in HA HLD:

reject ha_scope object createion if ha_set is not created first.
get ha_set_id mapping from ha_scope table
get vip from ha_scope table
Dependency: sonic-net/sonic-dash-api#44

Author: zjswhhh

orchagent/dash/dashhaorch.cpp

@@ -402,18 +402,22 @@ bool DashHaOrch::addHaScopeEntry(const std::string &key, const dash::ha_scope::H
         return success;
     }
 
-    if (m_ha_set_entries.empty())
+    std::map<std::string, HaSetEntry>::iterator ha_set_it;
+    if (!entry.ha_set_id().empty())
     {
-        SWSS_LOG_ERROR("HA Set entry does not exist for %s", key.c_str());
-        return false;
+        ha_set_it = m_ha_set_entries.find(entry.ha_set_id());
+    }
+    else
+    {
+        /* ha_set_id field in ha_scope_table was added as a revision of detailed HLD, adding backward compatibility for ha_set_id mapping. */
+        ha_set_it = m_ha_set_entries.find(key);
     }
 
-    auto ha_set_it = m_ha_set_entries.find(key);
     if (ha_set_it == m_ha_set_entries.end())
     {
-        // If it's ENI level HA, ha_set id won't map to ha_scope id.
-        // So we will use the first HA Set entry.
-        ha_set_it = m_ha_set_entries.begin();
+        // If there is no HA Set entry, we cannot create HA Scope.
+        SWSS_LOG_ERROR("HA Set entry does not exist for %s", key.c_str());
+        return false;
     }
     sai_object_id_t ha_set_oid = ha_set_it->second.ha_set_id;
 
@@ -426,18 +430,34 @@ bool DashHaOrch::addHaScopeEntry(const std::string &key, const dash::ha_scope::H
     ha_set_attr.value.oid = ha_set_oid;
     ha_scope_attrs.push_back(ha_set_attr);
 
-    // TODO: add ha_role to attribute value enum
     sai_attribute_t ha_role_attr = {};
     ha_role_attr.id = SAI_HA_SCOPE_ATTR_DASH_HA_ROLE;
     ha_role_attr.value.u16 = to_sai(entry.ha_role());
     ha_scope_attrs.push_back(ha_role_attr);
 
-    if (ha_set_it->second.metadata.has_vip_v4() && ha_set_it->second.metadata.vip_v4().has_ipv4())
+    if (entry.has_vip_v4() && entry.vip_v4().has_ipv4())
+    {
+        sai_ip_address_t sai_vip_v4 = {};
+        if(to_sai(entry.vip_v4(), sai_vip_v4))
+        {
+            sai_attribute_t vip_v4_attr = {};
+            vip_v4_attr.id = SAI_HA_SCOPE_ATTR_VIP_V4;
+            vip_v4_attr.value.ipaddr = sai_vip_v4;
+            ha_scope_attrs.push_back(vip_v4_attr);
+        }
+        else
+        {
+            SWSS_LOG_WARN("Failed to convert VIP V4 for HA Scope %s", key.c_str());
+        }
+    }
+    else if (ha_set_it->second.metadata.has_vip_v4() && ha_set_it->second.metadata.vip_v4().has_ipv4())
     {
+        SWSS_LOG_NOTICE("HA Scope entry %s does not have VIP V4, using HA Set metadata", key.c_str());
+
         sai_ip_address_t sai_vip_v4 = {};
         if (to_sai(ha_set_it->second.metadata.vip_v4(), sai_vip_v4))
         {
-            sai_attribute_t vip_v4_attr = {};  // Create new attribute for V4
+            sai_attribute_t vip_v4_attr = {};
             vip_v4_attr.id = SAI_HA_SCOPE_ATTR_VIP_V4;
             vip_v4_attr.value.ipaddr = sai_vip_v4;
             ha_scope_attrs.push_back(vip_v4_attr);
@@ -448,12 +468,27 @@ bool DashHaOrch::addHaScopeEntry(const std::string &key, const dash::ha_scope::H
         }
     }
 
-    if (ha_set_it->second.metadata.has_vip_v6() && !ha_set_it->second.metadata.vip_v6().ipv6().empty())
+    if (entry.has_vip_v6() && entry.vip_v6().has_ipv6())
+    {
+        sai_ip_address_t sai_vip_v6 = {};
+        if(to_sai(entry.vip_v6(), sai_vip_v6))
+        {
+            sai_attribute_t vip_v6_attr = {};
+            vip_v6_attr.id = SAI_HA_SCOPE_ATTR_VIP_V6;
+            vip_v6_attr.value.ipaddr = sai_vip_v6;
+            ha_scope_attrs.push_back(vip_v6_attr);
+        }
+        else
+        {
+            SWSS_LOG_WARN("Failed to convert VIP V6 for HA Scope %s", key.c_str());
+        }
+    }
+    else if (ha_set_it->second.metadata.has_vip_v6() && !ha_set_it->second.metadata.vip_v6().ipv6().empty())
     {
         sai_ip_address_t sai_vip_v6 = {};
         if (to_sai(ha_set_it->second.metadata.vip_v6(), sai_vip_v6))
         {
-            sai_attribute_t vip_v6_attr = {};  // Create new attribute for V6
+            sai_attribute_t vip_v6_attr = {};
             vip_v6_attr.id = SAI_HA_SCOPE_ATTR_VIP_V6;
             vip_v6_attr.value.ipaddr = sai_vip_v6;
             ha_scope_attrs.push_back(vip_v6_attr);
@@ -962,7 +997,6 @@ bool DashHaOrch::convertKfvToHaSetPb(const std::vector<FieldValueTuple> &kfv, da
         else
         {
             SWSS_LOG_WARN("Unknown field %s in HA Set entry", field.c_str());
-            return false;
         }
     }
     return true;
@@ -1002,10 +1036,33 @@ bool DashHaOrch::convertKfvToHaScopePb(const std::vector<FieldValueTuple> &kfv,
         {
             entry.set_activate_role_requested(value == "true" || value == "1");
         }
+        else if (field == "vip_v4")
+        {
+            dash::types::IpAddress temp_ip;
+            if (!to_pb(value, temp_ip) || !temp_ip.has_ipv4())
+            {
+                SWSS_LOG_ERROR("Invalid IPv4 address %s", value.c_str());
+                return false;
+            }
+            entry.mutable_vip_v4()->CopyFrom(temp_ip);
+        }
+        else if (field == "vip_v6")
+        {
+            dash::types::IpAddress temp_ip;
+            if (!to_pb(value, temp_ip) || !temp_ip.has_ipv6())
+            {
+                SWSS_LOG_ERROR("Invalid IPv6 address %s", value.c_str());
+                return false;
+            }
+            entry.mutable_vip_v6()->CopyFrom(temp_ip);
+        }
+        else if (field == "ha_set_id")
+        {
+            entry.set_ha_set_id(value);
+        }
         else
         {
             SWSS_LOG_WARN("Unknown field %s in HA Scope entry", field.c_str());
-            return false;
         }
     }
     return true;

tests/mock_tests/dashhaorch_ut.cpp

@@ -138,6 +138,42 @@ namespace dashhaorch_ut
             static_cast<Orch *>(m_dashHaOrch)->doTask(*consumer.get());
         }
 
+        void InvalidField()
+        {
+            auto consumer = unique_ptr<Consumer>(new Consumer(
+                new swss::ConsumerStateTable(m_dpu_app_db.get(), APP_DASH_HA_SET_TABLE_NAME, 1, 1),
+                m_dashHaOrch, APP_DASH_HA_SET_TABLE_NAME));
+
+            consumer->addToSync(
+                deque<KeyOpFieldsValuesTuple>(
+                    {
+                        {
+                            "HA_SET_1",
+                            SET_COMMAND,
+                            {
+                                {"version", "1"},
+                                {"vip_v4", "10.0.0.1"},
+                                {"vip_v6", "3:2::1:0"},
+                                {"owner", "dpu"},
+                                {"scope", "dpu"},
+                                {"local_npu_ip", "192.168.1.10"},
+                                {"local_ip", "192.168.2.1"},
+                                {"peer_ip", "192.168.2.2"},
+                                {"cp_data_channel_port", "4789"},
+                                {"dp_channel_dst_port", "4790"},
+                                {"dp_channel_src_port_min", "5000"},
+                                {"dp_channel_src_port_max", "6000"},
+                                {"dp_channel_probe_interval_ms", "1000"},
+                                {"dp_channel_probe_fail_threshold", "3"},
+                                {"invalid_field", "invalid_value"}
+                            }
+                        }
+                    }
+                )
+            );
+            static_cast<Orch *>(m_dashHaOrch)->doTask(*consumer.get());
+        }
+
         void CreateEniScopeHaSet()
         {
             auto consumer = unique_ptr<Consumer>(new Consumer(
@@ -207,7 +243,33 @@ namespace dashhaorch_ut
                             SET_COMMAND,
                             {
                                 {"version", "1"},
-                                {"ha_role", "dead"}
+                                {"ha_role", "dead"},
+                                {"ha_set_id", "HA_SET_1"},
+                                {"vip_v4", "10.0.0.1"},
+                                {"vip_v6", "3:2::1:0"}
+                            }
+                        }
+                    }
+                )
+            );
+            static_cast<Orch *>(m_dashHaOrch)->doTask(*consumer.get());
+        }
+
+        void CreateHaScopeLessFields()
+        {
+            auto consumer = unique_ptr<Consumer>(new Consumer(
+                new swss::ConsumerStateTable(m_dpu_app_db.get(), APP_DASH_HA_SCOPE_TABLE_NAME, 1, 1),
+                m_dashHaOrch, APP_DASH_HA_SCOPE_TABLE_NAME));
+
+            consumer->addToSync(
+                deque<KeyOpFieldsValuesTuple>(
+                    {
+                        {
+                            "HA_SET_1",
+                            SET_COMMAND,
+                            {
+                                {"version", "1"},
+                                {"ha_role", "dead"},
                             }
                         }
                     }
@@ -523,10 +585,18 @@ namespace dashhaorch_ut
 
     TEST_F(DashHaOrchTest, InvalidIpAddresses)
     {
+        EXPECT_CALL(*mock_sai_dash_ha_api, create_ha_set)
+        .Times(0);
+
         InvalidIpAddresses();
+    }
 
+    TEST_F(DashHaOrchTest, InvalidField)
+    {
         EXPECT_CALL(*mock_sai_dash_ha_api, create_ha_set)
-        .Times(0);
+        .Times(1);
+        
+        InvalidField();
     }
 
     TEST_F(DashHaOrchTest, HaSetAlreadyExists)
@@ -575,6 +645,35 @@ namespace dashhaorch_ut
         EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().size() == 0);
     }
 
+    TEST_F(DashHaOrchTest, AddRemoveHaScopeLessFields)
+    {
+        CreateHaSet();
+
+        EXPECT_CALL(*mock_sai_dash_ha_api, create_ha_scope)
+        .Times(1);
+
+        CreateHaScopeLessFields();
+
+        EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().size() == 1);
+        EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().find("HA_SET_1") != m_dashHaOrch->getHaScopeEntries().end());
+
+        // HA Scope already exists
+        EXPECT_CALL(*mock_sai_dash_ha_api, create_ha_scope)
+        .Times(0);
+        CreateHaScope();
+
+        EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().size() == 1);
+        EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().find("HA_SET_1") != m_dashHaOrch->getHaScopeEntries().end());
+
+        EXPECT_CALL(*mock_sai_dash_ha_api, remove_ha_scope)
+        .Times(1);
+
+        RemoveHaScope();
+
+        EXPECT_TRUE(m_dashHaOrch->getHaScopeEntries().size() == 0);
+    }
+
+
     TEST_F(DashHaOrchTest, AddRemoveEniHaScope)
     {
         CreateEniScopeHaSet();