[RIC-475] [RIC-507] Inject RanStatusChangeManager | Enhance E2 Setup flow | Remove...
[ric-plt/e2mgr.git] / E2Manager / rNibWriter / rNibWriter.go
index c996a1e..7322035 100644 (file)
 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
 //  platform project (RICP).
 
-
 package rNibWriter
 
 import (
+       "encoding/json"
        "fmt"
        "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
        "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
-       "gerrit.o-ran-sc.org/r/ric-plt/sdlgo"
        "github.com/golang/protobuf/proto"
 )
 
-var writerPool *common.Pool
+const E2TAddressesKey = "E2TAddresses"
 
 type rNibWriterInstance struct {
-       sdl       *common.ISdlInstance
-       namespace string
+       sdl common.ISdlInstance
 }
 
 /*
@@ -42,45 +40,55 @@ type RNibWriter interface {
        SaveNodeb(nbIdentity *entities.NbIdentity, nb *entities.NodebInfo) error
        UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
        SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error
+       SaveE2TInstance(e2tInstance *entities.E2TInstance) error
+       SaveE2TAddresses(addresses []string) error
+       RemoveE2TInstance(e2tAddress string) error
+       UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error
+       RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error
+       UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, stateChangeMessageChannel string, event string) error
+       SaveGeneralConfiguration(config *entities.GeneralConfiguration) error
 }
 
 /*
-Init initializes the infrastructure required for the RNibWriter instance
+GetRNibWriter returns reference to RNibWriter
 */
-func Init(namespace string, poolSize int) {
-       initPool(poolSize,
-               func() interface{} {
-                       var sdlI common.ISdlInstance = sdlgo.NewSdlInstance(namespace, sdlgo.NewDatabase())
-                       return &rNibWriterInstance{sdl: &sdlI, namespace: namespace}
-               },
-               func(obj interface{}) {
-                       (*obj.(*rNibWriterInstance).sdl).Close()
-               })
+
+func GetRNibWriter(sdl common.ISdlInstance) RNibWriter {
+       return &rNibWriterInstance{sdl: sdl}
 }
 
-/*
-InitPool initializes the writer's instances pool
-*/
-func initPool(poolSize int, newObj func() interface{}, destroyObj func(interface{})) {
-       writerPool = common.NewPool(poolSize, newObj, destroyObj)
+
+func (w *rNibWriterInstance) RemoveServedNrCells(inventoryName string, servedNrCells []*entities.ServedNRCell) error {
+       cellKeysToRemove := buildCellKeysToRemove(inventoryName, servedNrCells)
+       err := w.sdl.Remove(cellKeysToRemove)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
 }
-/*
-GetRNibWriter returns reference to RNibWriter
-*/
-func GetRNibWriter() RNibWriter {
-       return &rNibWriterInstance{}
+
+func (w *rNibWriterInstance) SaveGeneralConfiguration(config *entities.GeneralConfiguration) error {
+
+       err := w.SaveWithKeyAndMarshal(common.BuildGeneralConfigurationKey(), config)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
 }
+
 /*
 SaveNodeb saves nodeB entity data in the redis DB according to the specified data model
 */
-func (*rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
-       w := writerPool.Get().(*rNibWriterInstance)
+func (w *rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *entities.NodebInfo) error {
        isNotEmptyIdentity := isNotEmpty(nbIdentity)
 
        if isNotEmptyIdentity && entity.GetNodeType() == entities.Node_UNKNOWN {
                return common.NewValidationError(fmt.Sprintf("#rNibWriter.saveNodeB - Unknown responding node type, entity: %v", entity))
        }
-       defer writerPool.Put(w)
        data, err := proto.Marshal(entity)
        if err != nil {
                return common.NewInternalError(err)
@@ -101,18 +109,18 @@ func (*rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *en
        }
 
        if entity.GetEnb() != nil {
-               pairs, rNibErr = appendEnbCells(nbIdentity, entity.GetEnb().GetServedCells(), pairs)
+               pairs, rNibErr = appendEnbCells(nbIdentity.InventoryName, entity.GetEnb().GetServedCells(), pairs)
                if rNibErr != nil {
                        return rNibErr
                }
        }
        if entity.GetGnb() != nil {
-               pairs, rNibErr = appendGnbCells(nbIdentity, entity.GetGnb().GetServedNrCells(), pairs)
+               pairs, rNibErr = appendGnbCells(nbIdentity.InventoryName, entity.GetGnb().GetServedNrCells(), pairs)
                if rNibErr != nil {
                        return rNibErr
                }
        }
-       err = (*w.sdl).Set(pairs)
+       err = w.sdl.Set(pairs)
        if err != nil {
                return common.NewInternalError(err)
        }
@@ -124,7 +132,7 @@ func (*rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *en
                if err != nil {
                        return common.NewInternalError(err)
                }
-               err = (*w.sdl).RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
+               err = w.sdl.RemoveMember(entities.Node_UNKNOWN.String(), nbIdData)
                if err != nil {
                        return common.NewInternalError(err)
                }
@@ -136,24 +144,63 @@ func (*rNibWriterInstance) SaveNodeb(nbIdentity *entities.NbIdentity, entity *en
        if err != nil {
                return common.NewInternalError(err)
        }
-       err = (*w.sdl).AddMember(entity.GetNodeType().String(), nbIdData)
+       err = w.sdl.AddMember(entity.GetNodeType().String(), nbIdData)
        if err != nil {
                return common.NewInternalError(err)
        }
        return nil
 }
 
-/*
-UpdateNodebInfo...
-*/
-func (*rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
-       w := writerPool.Get().(*rNibWriterInstance)
-       defer writerPool.Put(w)
+func (w *rNibWriterInstance) UpdateGnbCells(nodebInfo *entities.NodebInfo, servedNrCells []*entities.ServedNRCell) error {
 
+       pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
+
+       if err != nil {
+               return err
+       }
+
+       pairs, err = appendGnbCells(nodebInfo.RanName, servedNrCells, pairs)
+
+       if err != nil {
+               return err
+       }
+
+       err = w.sdl.Set(pairs)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
+}
+
+func buildCellKeysToRemove(inventoryName string, servedNrCellsToRemove []*entities.ServedNRCell) []string {
+
+       cellKeysToRemove := []string{}
+
+       for _, cell := range servedNrCellsToRemove {
+
+               key, _ := common.ValidateAndBuildNrCellIdKey(cell.GetServedNrCellInformation().GetCellId())
+
+               if len(key) != 0 {
+                       cellKeysToRemove = append(cellKeysToRemove, key)
+               }
+
+               key, _ = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
+
+               if len(key) != 0 {
+                       cellKeysToRemove = append(cellKeysToRemove, key)
+               }
+       }
+
+       return cellKeysToRemove
+}
+
+func buildUpdateNodebInfoPairs(nodebInfo *entities.NodebInfo) ([]interface{}, error) {
        nodebNameKey, rNibErr := common.ValidateAndBuildNodeBNameKey(nodebInfo.GetRanName())
 
        if rNibErr != nil {
-               return rNibErr
+               return []interface{}{}, rNibErr
        }
 
        nodebIdKey, buildNodebIdKeyError := common.ValidateAndBuildNodeBIdKey(nodebInfo.GetNodeType().String(), nodebInfo.GlobalNbId.GetPlmnId(), nodebInfo.GlobalNbId.GetNbId())
@@ -161,17 +208,30 @@ func (*rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
        data, err := proto.Marshal(nodebInfo)
 
        if err != nil {
-               return common.NewInternalError(err)
+               return []interface{}{}, common.NewInternalError(err)
        }
 
-       var pairs []interface{}
-       pairs = append(pairs, nodebNameKey, data)
+       pairs := []interface{}{nodebNameKey, data}
 
        if buildNodebIdKeyError == nil {
                pairs = append(pairs, nodebIdKey, data)
        }
 
-       err = (*w.sdl).Set(pairs)
+       return pairs, nil
+}
+
+/*
+UpdateNodebInfo...
+*/
+func (w *rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error {
+
+       pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
+
+       if err != nil {
+               return err
+       }
+
+       err = w.sdl.Set(pairs)
 
        if err != nil {
                return common.NewInternalError(err)
@@ -183,9 +243,7 @@ func (*rNibWriterInstance) UpdateNodebInfo(nodebInfo *entities.NodebInfo) error
 /*
 SaveRanLoadInformation stores ran load information for the provided ran
 */
-func (*rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
-       w := writerPool.Get().(*rNibWriterInstance)
-       defer writerPool.Put(w)
+func (w *rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadInformation *entities.RanLoadInformation) error {
 
        key, rnibErr := common.ValidateAndBuildRanLoadInformationKey(inventoryName)
 
@@ -202,7 +260,108 @@ func (*rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadI
        var pairs []interface{}
        pairs = append(pairs, key, data)
 
-       err = (*w.sdl).Set(pairs)
+       err = w.sdl.Set(pairs)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
+}
+
+func (w *rNibWriterInstance) SaveE2TInstance(e2tInstance *entities.E2TInstance) error {
+
+       key, rnibErr := common.ValidateAndBuildE2TInstanceKey(e2tInstance.Address)
+
+       if rnibErr != nil {
+               return rnibErr
+       }
+
+       data, err := json.Marshal(e2tInstance)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       var pairs []interface{}
+       pairs = append(pairs, key, data)
+
+       err = w.sdl.Set(pairs)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
+}
+
+func (w *rNibWriterInstance) SaveE2TAddresses(addresses []string) error {
+
+       data, err := json.Marshal(addresses)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       var pairs []interface{}
+       pairs = append(pairs, E2TAddressesKey, data)
+
+       err = w.sdl.Set(pairs)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
+}
+
+func (w *rNibWriterInstance) RemoveE2TInstance(address string) error {
+       key, rNibErr := common.ValidateAndBuildE2TInstanceKey(address)
+       if rNibErr != nil {
+               return rNibErr
+       }
+       err := w.sdl.Remove([]string{key})
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+       return nil
+}
+
+func (w *rNibWriterInstance) SaveWithKeyAndMarshal(key string, entity interface{}) error {
+
+       data, err := json.Marshal(entity)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       var pairs []interface{}
+       pairs = append(pairs, key, data)
+
+       err = w.sdl.Set(pairs)
+
+       if err != nil {
+               return common.NewInternalError(err)
+       }
+
+       return nil
+}
+
+/*
+UpdateNodebInfoOnConnectionStatusInversion...
+*/
+func (w *rNibWriterInstance) UpdateNodebInfoOnConnectionStatusInversion(nodebInfo *entities.NodebInfo, stateChangeMessageChannel string, event string) error {
+
+       pairs, err := buildUpdateNodebInfoPairs(nodebInfo)
+
+       if err != nil {
+               return err
+       }
+
+       //TODO: Handle "Redis deployment doesn't support MSETMPUB command" when executing SetAndPublish
+       //err = w.sdl.SetAndPublish([]string{stateChangeMessageChannel, event}, pairs)
+       err = w.sdl.Set(pairs)
 
        if err != nil {
                return common.NewInternalError(err)
@@ -212,13 +371,13 @@ func (*rNibWriterInstance) SaveRanLoadInformation(inventoryName string, ranLoadI
 }
 
 /*
-Close closes writer's pool
+Close the writer
 */
 func Close() {
-       writerPool.Close()
+       //Nothing to do
 }
 
-func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
+func appendEnbCells(inventoryName string, cells []*entities.ServedCellInfo, pairs []interface{}) ([]interface{}, error) {
        for _, cell := range cells {
                cellEntity := entities.Cell{Type: entities.Cell_LTE_CELL, Cell: &entities.Cell_ServedCellInfo{ServedCellInfo: cell}}
                cellData, err := proto.Marshal(&cellEntity)
@@ -230,7 +389,7 @@ func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCel
                        return pairs, rNibErr
                }
                pairs = append(pairs, key, cellData)
-               key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetPci())
+               key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetPci())
                if rNibErr != nil {
                        return pairs, rNibErr
                }
@@ -239,7 +398,7 @@ func appendEnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedCel
        return pairs, nil
 }
 
-func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
+func appendGnbCells(inventoryName string, cells []*entities.ServedNRCell, pairs []interface{}) ([]interface{}, error) {
        for _, cell := range cells {
                cellEntity := entities.Cell{Type: entities.Cell_NR_CELL, Cell: &entities.Cell_ServedNrCell{ServedNrCell: cell}}
                cellData, err := proto.Marshal(&cellEntity)
@@ -251,7 +410,7 @@ func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRC
                        return pairs, rNibErr
                }
                pairs = append(pairs, key, cellData)
-               key, rNibErr = common.ValidateAndBuildCellNamePciKey(nbIdentity.InventoryName, cell.GetServedNrCellInformation().GetNrPci())
+               key, rNibErr = common.ValidateAndBuildCellNamePciKey(inventoryName, cell.GetServedNrCellInformation().GetNrPci())
                if rNibErr != nil {
                        return pairs, rNibErr
                }
@@ -262,4 +421,4 @@ func appendGnbCells(nbIdentity *entities.NbIdentity, cells []*entities.ServedNRC
 
 func isNotEmpty(nbIdentity *entities.NbIdentity) bool {
        return nbIdentity.GlobalNbId != nil && nbIdentity.GlobalNbId.PlmnId != "" && nbIdentity.GlobalNbId.NbId != ""
-}
+}
\ No newline at end of file