add gNMI wildcard subscription support for OTN devices

Author: kmathewm

models/yang/annotations/openconfig-channel-monitor-annot.yang

@@ -18,6 +18,7 @@ module openconfig-channel-monitor-annot {
     deviation /oc-chan-monitor:channel-monitors/oc-chan-monitor:channel-monitor {
       deviate add {
         sonic-ext:key-transformer "oc_name_key_xfmr";
+        sonic-ext:table-transformer "otn_table_xfmr";
       }
     }
 
@@ -60,13 +61,15 @@ module openconfig-channel-monitor-annot {
 
     deviation /oc-chan-monitor:channel-monitors/oc-chan-monitor:channel-monitor/oc-chan-monitor:channels {
       deviate add {
-        sonic-ext:db-name "STATE_DB";
-        sonic-ext:table-name "OTN_OCM_CHANNEL_TABLE";
+        sonic-ext:table-transformer "otn_table_xfmr";
       }
     }
 
     deviation /oc-chan-monitor:channel-monitors/oc-chan-monitor:channel-monitor/oc-chan-monitor:channels/oc-chan-monitor:channel {
       deviate add {
+        sonic-ext:db-name "STATE_DB";
+        sonic-ext:table-name "OTN_OCM_CHANNEL_TABLE";               
+        sonic-ext:table-transformer "otn_table_xfmr";
         sonic-ext:key-transformer "ocm_channel_key_xfmr";
       }
     }

models/yang/annotations/openconfig-optical-amplifier-annot.yang

@@ -22,6 +22,7 @@ module openconfig-optical-amplifier-annot {
     deviation /oc-opt-amp:optical-amplifier/oc-opt-amp:amplifiers/oc-opt-amp:amplifier {
       deviate add {
         sonic-ext:key-transformer "oc_name_key_xfmr";
+        sonic-ext:table-transformer "otn_table_xfmr";
       }
     }
 
@@ -325,6 +326,7 @@ module openconfig-optical-amplifier-annot {
     deviation /oc-opt-amp:optical-amplifier/oc-opt-amp:supervisory-channels/oc-opt-amp:supervisory-channel {
       deviate add {
         sonic-ext:key-transformer "osc_key_xfmr";
+        sonic-ext:table-transformer "otn_table_xfmr";
       }
     }
 

models/yang/annotations/openconfig-optical-attenuator-annot.yang

@@ -22,6 +22,7 @@ module openconfig-optical-attenuator-annot {
     deviation /oc-opt-att:optical-attenuator/oc-opt-att:attenuators/oc-opt-att:attenuator {
       deviate add {
         sonic-ext:key-transformer "oc_name_key_xfmr";
+        sonic-ext:table-transformer "otn_table_xfmr";
       }
     }
 

translib/transformer/xfmr_otn_openconfig.go

@@ -1,6 +1,8 @@
 package transformer
 
 import (
+	"errors"
+	"github.com/Azure/sonic-mgmt-common/translib/db"
 	log "github.com/golang/glog"
 	"strings"
 )
@@ -17,6 +19,7 @@ func init() {
 	XlateFuncBind("DbToYang_osc_key_xfmr", DbToYang_osc_key_xfmr)
 	XlateFuncBind("YangToDb_osc_interface_xfmr", YangToDb_osc_interface_xfmr)
 	XlateFuncBind("DbToYang_osc_interface_xfmr", DbToYang_osc_interface_xfmr)
+	XlateFuncBind("otn_table_xfmr", otn_table_xfmr)
 }
 
 // Generic KeyXfmr for openconfig "name"
@@ -74,30 +77,48 @@ var YangToDb_ocm_channel_key_xfmr KeyXfmrYangToDb = func(inParams XfmrParams) (s
 }
 
 var DbToYang_ocm_channel_key_xfmr KeyXfmrDbToYang = func(inParams XfmrParams) (map[string]interface{}, error) {
-	var err error
 	rmap := make(map[string]interface{})
-	key := inParams.key
-	TableKeys := strings.Split(key, "|")
+	tableKeys := strings.Split(inParams.key, "|")
+
+	if len(tableKeys) >= 2 {
+		rmap["lower-frequency"] = tableKeys[1]
+	}
 
-	if len(TableKeys) >= 2 {
-		//TableKeys[0] = name, TableKeys[1] = lower-frequency
-		rmap["lower-frequency"] = TableKeys[1]
+	tableName := ""
+	if strings.Contains(inParams.uri, "channels/channel") {
+		tableName = "OTN_OCM_CHANNEL_TABLE"
 	}
 
-	// Find the row for this key in the cached DB data
-	data := (*inParams.dbDataMap)[inParams.curDb] // map[string]TblData
+	upperFreq := ""
 
-	for _, tbl := range data {
-		if row, ok := tbl[inParams.key]; ok {
-			if val, ok2 := row.Field["upper-frequency"]; ok2 {
-				rmap["upper-frequency"] = val
+	// 1. Try Cache
+	if inParams.dbDataMap != nil && tableName != "" {
+		if tblData, ok := (*inParams.dbDataMap)[inParams.curDb][tableName]; ok {
+			if row, ok2 := tblData[inParams.key]; ok2 {
+				upperFreq = row.Field["upper-frequency"]
 			}
-			break
 		}
 	}
-	log.Info("DbToYang_ocm_channel_key_xfmr : - ", rmap)
 
-	return rmap, err
+	// 2. Direct Redis Fetch (fixes the undefined: db error and the type mismatch)
+	if upperFreq == "" && tableName != "" {
+		ts := &db.TableSpec{Name: tableName}
+		// Using Comp for composite keys allows the driver to handle the '|' separator correctly
+		rowKey := db.Key{Comp: strings.Split(inParams.key, "|")}
+
+		entry, err := inParams.dbs[inParams.curDb].GetEntry(ts, rowKey)
+		if err == nil {
+			upperFreq = entry.Field["upper-frequency"]
+		}
+	}
+
+	if upperFreq != "" {
+		rmap["upper-frequency"] = upperFreq
+	} else {
+		log.Warningf("DbToYang_ocm_channel_key_xfmr: Could not resolve upper-frequency for %s", inParams.key)
+	}
+
+	return rmap, nil
 }
 
 var YangToDb_ocm_lower_frequency_xfmr FieldXfmrYangToDb = func(inParams XfmrParams) (map[string]string, error) {
@@ -147,3 +168,49 @@ var DbToYang_osc_interface_xfmr FieldXfmrDbtoYang = func(inParams XfmrParams) (m
 
 	return rmap, err
 }
+
+var otn_table_xfmr TableXfmrFunc = func(inParams XfmrParams) ([]string, error) {
+
+	// Check for nil
+	if inParams.uri == "" {
+		log.Error("otn_table_xfmr: uri is empty!")
+		return nil, errors.New("otn_table_xfmr: uri is empty")
+	}
+
+	pathInfo := NewPathInfo(inParams.uri)
+	targetUriPath := pathInfo.YangPath
+
+	tblList := []string{}
+
+	switch {
+	case strings.HasPrefix(targetUriPath, "/openconfig-optical-attenuator:optical-attenuator/attenuators/attenuator"):
+		tblList = append(tblList, "OTN_ATTENUATOR")
+
+		// 1. Check the specific LIST first (Longer path)
+	case strings.HasPrefix(targetUriPath, "/openconfig-channel-monitor:channel-monitors/channel-monitor/channels/channel"):
+		tblList = append(tblList, "OTN_OCM_CHANNEL_TABLE")
+
+	// 2. Check the CONTAINER next (Shorter path)
+	case strings.HasPrefix(targetUriPath, "/openconfig-channel-monitor:channel-monitors/channel-monitor/channels"):
+		// Returning empty here forces the framework to recurse
+		// down to the 'channel' list where it will find the table above.
+		return tblList, nil
+
+	// 3. Check the PARENT MONITOR
+	case strings.HasPrefix(targetUriPath, "/openconfig-channel-monitor:channel-monitors/channel-monitor"):
+		tblList = append(tblList, "OTN_OCM")
+
+	case strings.HasPrefix(targetUriPath, "/openconfig-optical-amplifier:optical-amplifier/amplifiers/amplifier"):
+		tblList = append(tblList, "OTN_OA")
+
+	case strings.HasPrefix(targetUriPath, "/openconfig-optical-amplifier:optical-amplifier/supervisory-channels/supervisory-channel"):
+		tblList = append(tblList, "OTN_OSC")
+	}
+
+	if len(tblList) == 0 {
+		log.Errorf("otn_table_xfmr: NO MATCHING TABLE for yangPath=%s", targetUriPath)
+		return nil, errors.New("otn_table_xfmr: no matching table")
+	}
+
+	return tblList, nil
+}