[RIC-346] update ng-eNB and eNB node types and add tests
[ric-plt/e2mgr.git] / E2Manager / handlers / rmrmsghandlers / e2_setup_request_notification_handler.go
index f40636b..9ea0ef5 100644 (file)
@@ -22,43 +22,45 @@ package rmrmsghandlers
 import (
        "bytes"
        "e2mgr/configuration"
+       "e2mgr/e2managererrors"
        "e2mgr/logger"
        "e2mgr/managers"
        "e2mgr/models"
        "e2mgr/rmrCgo"
        "e2mgr/services"
        "e2mgr/services/rmrsender"
-       "e2mgr/utils"
        "encoding/xml"
        "errors"
        "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"
+       "strconv"
+       "strings"
 )
 
 type E2SetupRequestNotificationHandler struct {
-       logger                 *logger.Logger
-       config                 *configuration.Configuration
-       e2tInstancesManager    managers.IE2TInstancesManager
-       rmrSender              *rmrsender.RmrSender
+       logger                *logger.Logger
+       config                *configuration.Configuration
+       e2tInstancesManager   managers.IE2TInstancesManager
+       rmrSender             *rmrsender.RmrSender
        rNibDataService       services.RNibDataService
        e2tAssociationManager *managers.E2TAssociationManager
 }
 
 func NewE2SetupRequestNotificationHandler(logger *logger.Logger, config *configuration.Configuration, e2tInstancesManager managers.IE2TInstancesManager, rmrSender *rmrsender.RmrSender, rNibDataService services.RNibDataService, e2tAssociationManager *managers.E2TAssociationManager) E2SetupRequestNotificationHandler {
        return E2SetupRequestNotificationHandler{
-               logger:                 logger,
-               config:                 config,
-               e2tInstancesManager:    e2tInstancesManager,
-               rmrSender: rmrSender,
-               rNibDataService: rNibDataService,
+               logger:                logger,
+               config:                config,
+               e2tInstancesManager:   e2tInstancesManager,
+               rmrSender:             rmrSender,
+               rNibDataService:       rNibDataService,
                e2tAssociationManager: e2tAssociationManager,
        }
 }
 
-func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest){
+func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRequest) {
        ranName := request.RanName
-       h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2 Setup Request. Payload: %x", ranName, request.Payload)
+       h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - received E2_SETUP_REQUEST. Payload: %x", ranName, request.Payload)
 
        setupRequest, e2tIpAddress, err := h.parseSetupRequest(request.Payload)
        if err != nil {
@@ -67,6 +69,7 @@ func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRe
        }
 
        h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - E2T Address: %s - handling E2_SETUP_REQUEST", e2tIpAddress)
+       h.logger.Debugf("#E2SetupRequestNotificationHandler.Handle - E2_SETUP_REQUEST has been parsed successfully %+v", setupRequest)
 
        _, err = h.e2tInstancesManager.GetE2TInstance(e2tIpAddress)
 
@@ -76,74 +79,159 @@ func (h E2SetupRequestNotificationHandler) Handle(request *models.NotificationRe
        }
 
        nodebInfo, err := h.rNibDataService.GetNodeb(ranName)
-       if err != nil{
-               if _, ok := err.(*common.ResourceNotFoundError); ok{
-                       nbIdentity := h.buildNbIdentity(ranName, setupRequest)
-                       nodebInfo, err = h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
-                       if err != nil{
-                               h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
-                               return
-                       }
-                       err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
-                       if err != nil{
-                               h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
-                               return
-                       }
-               } else{
+
+       if err != nil {
+
+               if _, ok := err.(*common.ResourceNotFoundError); !ok {
                        h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to retrieve nodebInfo entity. Error: %s", ranName, err)
                        return
+
                }
 
-       } else {
-               if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
-                       h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", nodebInfo.RanName, nodebInfo.ConnectionStatus)
-                       h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - Summary: elapsed time for receiving and handling setup request message from E2 terminator: %f ms", utils.ElapsedTime(request.StartTime))
+               if nodebInfo, err = h.handleNewRan(ranName, e2tIpAddress, setupRequest); err != nil {
                        return
                }
-               nodebInfo.GetGnb().RanFunctions, err = setupRequest.GetExtractRanFunctionsList()
-               if err != nil{
-                       h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to update nodebInfo entity. Error: %s", ranName, err)
+
+       } else {
+               if err = h.handleExistingRan(ranName, nodebInfo, setupRequest); err != nil {
                        return
                }
        }
+
        err = h.e2tAssociationManager.AssociateRan(e2tIpAddress, nodebInfo)
-       if err != nil{
+
+       if err != nil {
+
                h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - failed to associate E2T to nodeB entity. Error: %s", ranName, err)
+               if _, ok := err.(*e2managererrors.RoutingManagerError); ok {
+                       h.handleUnsuccessfulResponse(nodebInfo, request)
+               }
                return
        }
-       successResponse := models.NewE2SetupSuccessResponseMessage()
-       successResponse.SetPlmnId(h.config.GlobalRicId.PlmnId)
-       successResponse.SetRicId(h.config.GlobalRicId.RicNearRtId)
-       successResponse.SetExtractRanFunctionsIDList(setupRequest)
-       responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
 
-       if err != nil{
-               h.logger.Warnf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - Error marshalling E2 Setup Response. Response: %x", ranName, responsePayload)
+       h.handleSuccessfulResponse(ranName, request, setupRequest)
+}
+
+func (h E2SetupRequestNotificationHandler) handleNewRan(ranName string, e2tIpAddress string, setupRequest *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
+
+       nodebInfo, err := h.buildNodebInfo(ranName, e2tIpAddress, setupRequest)
+
+       if err != nil {
+               h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to build nodebInfo entity. Error: %s", ranName, err)
+               return nil, err
        }
-       msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, request.TransactionId)
-       h.logger.Infof("#E2SetupRequestNotificationHandler.Handle - RAN name: %s - E2 Setup Request has been built. Message: %x", ranName, msg)
-       _ = h.rmrSender.Send(msg)
+
+       nbIdentity := h.buildNbIdentity(ranName, setupRequest)
+       err = h.rNibDataService.SaveNodeb(nbIdentity, nodebInfo)
+
+       if err != nil {
+               h.logger.Errorf("#E2SetupRequestNotificationHandler.handleNewRan - RAN name: %s - failed to save nodebInfo entity. Error: %s", ranName, err)
+               return nil, err
+       }
+
+       return nodebInfo, nil
 }
 
-func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte)(*models.E2SetupRequestMessage, string, error){
+func (h E2SetupRequestNotificationHandler) setGnbFunctions(nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
+       ranFunctions, err := setupRequest.ExtractRanFunctionsList()
 
-       colonInd := bytes.IndexByte(payload, ':')
-       if colonInd < 0 {
-               return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request, failed extract E2T IP Address: no ':' separator found")
+       if err != nil {
+               h.logger.Errorf("#E2SetupRequestNotificationHandler.setGnbFunctions - RAN name: %s - failed to update nodebInfo entity. Error: %s", nodebInfo.GetRanName(), err)
+               return err
        }
 
-       e2tIpAddress := string(payload[:colonInd])
-       if len(e2tIpAddress) == 0 {
-               return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
+       nodebInfo.GetGnb().RanFunctions = ranFunctions
+       return nil
+}
+
+func (h E2SetupRequestNotificationHandler) handleExistingRan(ranName string, nodebInfo *entities.NodebInfo, setupRequest *models.E2SetupRequestMessage) error {
+       if nodebInfo.GetConnectionStatus() == entities.ConnectionStatus_SHUTTING_DOWN {
+               h.logger.Errorf("#E2SetupRequestNotificationHandler.Handle - RAN name: %s, connection status: %s - nodeB entity in incorrect state", ranName, nodebInfo.ConnectionStatus)
+               return errors.New("nodeB entity in incorrect state")
+       }
+
+       err := h.setGnbFunctions(nodebInfo, setupRequest)
+       return err
+}
+
+func (h E2SetupRequestNotificationHandler) handleUnsuccessfulResponse(nodebInfo *entities.NodebInfo, req *models.NotificationRequest) {
+       failureResponse := models.NewE2SetupFailureResponseMessage(models.TimeToWaitEnum.V60s)
+       h.logger.Debugf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", failureResponse)
+
+       responsePayload, err := xml.Marshal(&failureResponse.E2APPDU)
+       if err != nil {
+               h.logger.Warnf("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", nodebInfo.RanName, responsePayload)
        }
 
+       responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
+
+       msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_FAILURE, nodebInfo.RanName, responsePayload, req.TransactionId, req.GetMsgSrc())
+       h.logger.Infof("#E2SetupRequestNotificationHandler.handleUnsuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", nodebInfo.RanName, msg)
+       _ = h.rmrSender.WhSend(msg)
+
+}
+
+func (h E2SetupRequestNotificationHandler) handleSuccessfulResponse(ranName string, req *models.NotificationRequest, setupRequest *models.E2SetupRequestMessage) {
+
+       ricNearRtId, err := convertTo20BitString(h.config.GlobalRicId.RicNearRtId)
+       if err != nil {
+               h.logger.Errorf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - failed to convert RicNearRtId value %s to 20 bit string . Error: %s", ranName, h.config.GlobalRicId.RicNearRtId, err)
+               return
+       }
+       successResponse := models.NewE2SetupSuccessResponseMessage(h.config.GlobalRicId.PlmnId, ricNearRtId, setupRequest)
+       h.logger.Debugf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - E2_SETUP_RESPONSE has been built successfully %+v", successResponse)
+
+       responsePayload, err := xml.Marshal(&successResponse.E2APPDU)
+       if err != nil {
+               h.logger.Warnf("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - Error marshalling RIC_E2_SETUP_RESP. Payload: %s", ranName, responsePayload)
+       }
+
+       responsePayload = replaceEmptyTagsWithSelfClosing(responsePayload)
+
+       msg := models.NewRmrMessage(rmrCgo.RIC_E2_SETUP_RESP, ranName, responsePayload, req.TransactionId, req.GetMsgSrc())
+       h.logger.Infof("#E2SetupRequestNotificationHandler.handleSuccessfulResponse - RAN name: %s - RIC_E2_SETUP_RESP message has been built successfully. Message: %x", ranName, msg)
+       _ = h.rmrSender.Send(msg)
+}
+
+func replaceEmptyTagsWithSelfClosing(responsePayload []byte) []byte {
+       responseString := strings.NewReplacer(
+               "<reject></reject>", "<reject/>",
+               "<ignore></ignore>", "<ignore/>",
+               "<transport-resource-unavailable></transport-resource-unavailable>", "<transport-resource-unavailable/>",
+               "<v60s></v60s>", "<v60s/>",
+               "<v20s></v20s>", "<v20s/>",
+               "<v10s></v10s>", "<v10s/>",
+               "<v5s></v5s>", "<v5s/>",
+               "<v2s></v2s>", "<v2s/>",
+               "<v1s></v1s>", "<v1s/>",
+       ).Replace(string(responsePayload))
+       return []byte(responseString)
+}
+
+func convertTo20BitString(ricNearRtId string) (string, error) {
+       r, err := strconv.ParseUint(ricNearRtId, 16, 32)
+       if err != nil {
+               return "", err
+       }
+       return fmt.Sprintf("%020b", r)[:20], nil
+}
+
+func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte) (*models.E2SetupRequestMessage, string, error) {
+
        pipInd := bytes.IndexByte(payload, '|')
        if pipInd < 0 {
-               return nil, "", errors.New( "#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
+               return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Error parsing E2 Setup Request failed extract Payload: no | separator found")
        }
 
+       e2tIpAddress := string(payload[:pipInd])
+       if len(e2tIpAddress) == 0 {
+               return nil, "", errors.New("#E2SetupRequestNotificationHandler.parseSetupRequest - Empty E2T Address received")
+       }
+
+       h.logger.Infof("#E2SetupRequestNotificationHandler.parseSetupRequest - payload: %s", payload[pipInd+1:])
+
        setupRequest := &models.E2SetupRequestMessage{}
-       err := xml.Unmarshal(payload[pipInd + 1:], &setupRequest.E2APPDU)
+       err := xml.Unmarshal(payload[pipInd+1:], &setupRequest.E2APPDU)
        if err != nil {
                return nil, "", errors.New(fmt.Sprintf("#E2SetupRequestNotificationHandler.parseSetupRequest - Error unmarshalling E2 Setup Request payload: %x", payload))
        }
@@ -151,25 +239,32 @@ func (h E2SetupRequestNotificationHandler) parseSetupRequest(payload []byte)(*mo
        return setupRequest, e2tIpAddress, nil
 }
 
-func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error){
+func (h E2SetupRequestNotificationHandler) buildNodebInfo(ranName string, e2tAddress string, request *models.E2SetupRequestMessage) (*entities.NodebInfo, error) {
+
        var err error
        nodebInfo := &entities.NodebInfo{
                AssociatedE2TInstanceAddress: e2tAddress,
-               ConnectionStatus: entities.ConnectionStatus_CONNECTED,
-               RanName: ranName,
-               NodeType: entities.Node_GNB,
-               Configuration: &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
+               ConnectionStatus:             entities.ConnectionStatus_CONNECTED,
+               RanName:                      ranName,
+               NodeType:                     entities.Node_GNB,
+               Configuration:                &entities.NodebInfo_Gnb{Gnb: &entities.Gnb{}},
+               GlobalNbId: h.buildGlobalNbId(request),
        }
-       nodebInfo.GetGnb().RanFunctions, err = request.GetExtractRanFunctionsList()
+
+       err = h.setGnbFunctions(nodebInfo, request)
        return nodebInfo, err
 }
 
-func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage)*entities.NbIdentity{
+func (h E2SetupRequestNotificationHandler) buildGlobalNbId(setupRequest *models.E2SetupRequestMessage) *entities.GlobalNbId {
+       return &entities.GlobalNbId{
+               PlmnId: setupRequest.GetPlmnId(),
+               NbId:   setupRequest.GetNbId(),
+       }
+}
+
+func (h E2SetupRequestNotificationHandler) buildNbIdentity(ranName string, setupRequest *models.E2SetupRequestMessage) *entities.NbIdentity {
        return &entities.NbIdentity{
-               InventoryName:ranName,
-               GlobalNbId: &entities.GlobalNbId{
-                       PlmnId: setupRequest.GetPlmnId(),
-                       NbId:   setupRequest.GetNbId(),
-               },
+               InventoryName: ranName,
+               GlobalNbId: h.buildGlobalNbId(setupRequest),
        }
-}
\ No newline at end of file
+}