E2Manager/handlers/httpmsghandlers/setup_request_handler.go

   1 //
   2 // Copyright 2019 AT&T Intellectual Property
   3 // Copyright 2019 Nokia
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //      http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 package httpmsghandlers
  18
  19 import (
  20         "e2mgr/e2managererrors"
  21         "e2mgr/logger"
  22         "e2mgr/managers"
  23         "e2mgr/models"
  24         "e2mgr/services"
  25         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  26         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  27         "github.com/go-ozzo/ozzo-validation"
  28         "github.com/go-ozzo/ozzo-validation/is"
  29 )
  30
  31 const (
  32         X2SetupActivityName   = "X2_SETUP"
  33         EndcSetupActivityName = "ENDC_SETUP"
  34 )
  35
  36 type SetupRequestHandler struct {
  37         rNibDataService     services.RNibDataService
  38         logger              *logger.Logger
  39         ranSetupManager     managers.IRanSetupManager
  40         protocol            entities.E2ApplicationProtocol
  41         e2tInstancesManager managers.IE2TInstancesManager
  42 }
  43
  44 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
  45         ranSetupManager managers.IRanSetupManager, protocol entities.E2ApplicationProtocol, e2tInstancesManager managers.IE2TInstancesManager) *SetupRequestHandler {
  46         return &SetupRequestHandler{
  47                 logger:              logger,
  48                 rNibDataService:     rNibDataService,
  49                 ranSetupManager:     ranSetupManager,
  50                 protocol:            protocol,
  51                 e2tInstancesManager: e2tInstancesManager,
  52         }
  53 }
  54
  55 func (h *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
  56
  57         setupRequest := request.(models.SetupRequest)
  58
  59         err := h.validateRequestDetails(setupRequest)
  60         if err != nil {
  61                 return nil, err
  62         }
  63
  64         nodebInfo, err := h.rNibDataService.GetNodeb(setupRequest.RanName)
  65
  66         if err != nil {
  67                 _, ok := err.(*common.ResourceNotFoundError)
  68                 if !ok {
  69                         h.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s", setupRequest.RanName, err)
  70                         return nil, e2managererrors.NewRnibDbError()
  71                 }
  72
  73                 result := h.connectNewRan(&setupRequest, h.protocol)
  74                 return nil, result
  75         }
  76
  77         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
  78                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
  79                 result := e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
  80                 return nil, result
  81         }
  82
  83         if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
  84                 result := h.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
  85                 return nil, result
  86         }
  87
  88         result := h.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
  89         return nil, result
  90 }
  91
  92 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol, e2tAddress string) (*entities.NodebInfo, *entities.NbIdentity) {
  93
  94         nodebInfo := &entities.NodebInfo{
  95                 Ip:                           requestDetails.RanIp,
  96                 Port:                         uint32(requestDetails.RanPort),
  97                 ConnectionStatus:             entities.ConnectionStatus_CONNECTING,
  98                 E2ApplicationProtocol:        protocol,
  99                 RanName:                      requestDetails.RanName,
 100                 ConnectionAttempts:           0,
 101                 AssociatedE2TInstanceAddress: e2tAddress,
 102         }
 103
 104         nbIdentity := &entities.NbIdentity{
 105                 InventoryName: requestDetails.RanName,
 106         }
 107
 108         return nodebInfo, nbIdentity
 109 }
 110
 111 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 112         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 113
 114         if err != nil {
 115                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed selecting E2T instance", nodebInfo.RanName)
 116
 117                 // TODO: reset connection attempts?
 118
 119                 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_DISCONNECTED {
 120                         return err
 121                 }
 122
 123                 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
 124                 updateError := h.rNibDataService.UpdateNodebInfo(nodebInfo)
 125
 126                 if updateError != nil {
 127                         h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb. error: %s", nodebInfo.RanName, updateError)
 128                 }
 129
 130                 return err
 131         }
 132
 133         err = h.e2tInstancesManager.AssociateRan(nodebInfo.RanName, e2tAddress)
 134
 135         if err != nil {
 136                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
 137                 return err
 138         }
 139
 140         nodebInfo.AssociatedE2TInstanceAddress = e2tAddress
 141         nodebInfo.ConnectionAttempts = 0
 142
 143         err = h.rNibDataService.UpdateNodebInfo(nodebInfo)
 144
 145         if err != nil {
 146                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
 147                 return e2managererrors.NewRnibDbError()
 148         }
 149
 150         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
 151
 152         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 153         return result
 154 }
 155
 156 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 157         status := entities.ConnectionStatus_CONNECTING
 158         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
 159                 status = nodebInfo.ConnectionStatus
 160         }
 161         nodebInfo.ConnectionAttempts = 0
 162         err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
 163
 164         if err != nil {
 165                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
 166                 return e2managererrors.NewRnibDbError()
 167         }
 168
 169         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
 170
 171
 172         result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
 173         return result
 174 }
 175
 176 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
 177
 178         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 179
 180         if err != nil {
 181                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed selecting E2T instance", request.RanName)
 182                 return err
 183         }
 184
 185         err = h.e2tInstancesManager.AssociateRan(request.RanName, e2tAddress)
 186
 187         if err != nil {
 188                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
 189                 return err
 190         }
 191
 192         nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol, e2tAddress)
 193
 194         err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
 195
 196         if err != nil {
 197                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
 198                 return e2managererrors.NewRnibDbError()
 199         }
 200
 201         h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
 202
 203         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 204
 205         return result
 206 }
 207
 208 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
 209
 210         if request.RanPort == 0 {
 211                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
 212                 return e2managererrors.NewRequestValidationError()
 213         }
 214         err := validation.ValidateStruct(&request,
 215                 validation.Field(&request.RanIp, validation.Required, is.IP),
 216                 validation.Field(&request.RanName, validation.Required),
 217         )
 218
 219         if err != nil {
 220                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
 221                 return e2managererrors.NewRequestValidationError()
 222         }
 223
 224         return nil
 225 }
 226
 227 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
 228         if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
 229                 return X2SetupActivityName
 230         }
 231         return EndcSetupActivityName
 232 }