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 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 //  platform project (RICP).
  19
  20 package httpmsghandlers
  21
  22 import (
  23         "e2mgr/e2managererrors"
  24         "e2mgr/logger"
  25         "e2mgr/managers"
  26         "e2mgr/models"
  27         "e2mgr/services"
  28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  29         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  30         "github.com/go-ozzo/ozzo-validation"
  31         "github.com/go-ozzo/ozzo-validation/is"
  32 )
  33
  34 const (
  35         X2SetupActivityName   = "X2_SETUP"
  36         EndcSetupActivityName = "ENDC_SETUP"
  37 )
  38
  39 type SetupRequestHandler struct {
  40         rNibDataService     services.RNibDataService
  41         logger              *logger.Logger
  42         ranSetupManager     managers.IRanSetupManager
  43         protocol            entities.E2ApplicationProtocol
  44         e2tInstancesManager managers.IE2TInstancesManager
  45 }
  46
  47 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
  48         ranSetupManager managers.IRanSetupManager, protocol entities.E2ApplicationProtocol, e2tInstancesManager managers.IE2TInstancesManager) *SetupRequestHandler {
  49         return &SetupRequestHandler{
  50                 logger:              logger,
  51                 rNibDataService:     rNibDataService,
  52                 ranSetupManager:     ranSetupManager,
  53                 protocol:            protocol,
  54                 e2tInstancesManager: e2tInstancesManager,
  55         }
  56 }
  57
  58 func (h *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
  59
  60         setupRequest := request.(models.SetupRequest)
  61
  62         err := h.validateRequestDetails(setupRequest)
  63         if err != nil {
  64                 return nil, err
  65         }
  66
  67         nodebInfo, err := h.rNibDataService.GetNodeb(setupRequest.RanName)
  68
  69         if err != nil {
  70                 _, ok := err.(*common.ResourceNotFoundError)
  71                 if !ok {
  72                         h.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s", setupRequest.RanName, err)
  73                         return nil, e2managererrors.NewRnibDbError()
  74                 }
  75
  76                 result := h.connectNewRan(&setupRequest, h.protocol)
  77                 return nil, result
  78         }
  79
  80         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
  81                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
  82                 result := e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
  83                 return nil, result
  84         }
  85
  86         if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
  87                 result := h.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
  88                 return nil, result
  89         }
  90
  91         result := h.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
  92         return nil, result
  93 }
  94
  95 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol, e2tAddress string) (*entities.NodebInfo, *entities.NbIdentity) {
  96
  97         nodebInfo := &entities.NodebInfo{
  98                 Ip:                           requestDetails.RanIp,
  99                 Port:                         uint32(requestDetails.RanPort),
 100                 ConnectionStatus:             entities.ConnectionStatus_CONNECTING,
 101                 E2ApplicationProtocol:        protocol,
 102                 RanName:                      requestDetails.RanName,
 103                 ConnectionAttempts:           0,
 104                 AssociatedE2TInstanceAddress: e2tAddress,
 105         }
 106
 107         nbIdentity := &entities.NbIdentity{
 108                 InventoryName: requestDetails.RanName,
 109         }
 110
 111         return nodebInfo, nbIdentity
 112 }
 113
 114 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 115         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 116
 117         if err != nil {
 118                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed selecting E2T instance", nodebInfo.RanName)
 119
 120                 if nodebInfo.ConnectionStatus == entities.ConnectionStatus_DISCONNECTED && nodebInfo.ConnectionAttempts == 0 {
 121                         return err
 122                 }
 123
 124                 nodebInfo.ConnectionStatus = entities.ConnectionStatus_DISCONNECTED
 125                 nodebInfo.ConnectionAttempts = 0
 126                 updateError := h.rNibDataService.UpdateNodebInfo(nodebInfo)
 127
 128                 if updateError != nil {
 129                         h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb. error: %s", nodebInfo.RanName, updateError)
 130                 }
 131
 132                 return err
 133         }
 134
 135         err = h.e2tInstancesManager.AssociateRan(nodebInfo.RanName, e2tAddress)
 136
 137         if err != nil {
 138                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
 139                 return err
 140         }
 141
 142         nodebInfo.AssociatedE2TInstanceAddress = e2tAddress
 143         nodebInfo.ConnectionAttempts = 0
 144
 145         err = h.rNibDataService.UpdateNodebInfo(nodebInfo)
 146
 147         if err != nil {
 148                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
 149                 return e2managererrors.NewRnibDbError()
 150         }
 151
 152         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
 153
 154         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 155         return result
 156 }
 157
 158 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 159         status := entities.ConnectionStatus_CONNECTING
 160         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
 161                 status = nodebInfo.ConnectionStatus
 162         }
 163         nodebInfo.ConnectionAttempts = 0
 164         err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
 165
 166         if err != nil {
 167                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed resetting connection attempts of RAN. error: %s", nodebInfo.RanName, err)
 168                 return e2managererrors.NewRnibDbError()
 169         }
 170
 171         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully reset connection attempts of RAN", nodebInfo.RanName)
 172
 173
 174         result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
 175         return result
 176 }
 177
 178 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
 179
 180         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 181
 182         if err != nil {
 183                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed selecting E2T instance", request.RanName)
 184                 return err
 185         }
 186
 187         err = h.e2tInstancesManager.AssociateRan(request.RanName, e2tAddress)
 188
 189         if err != nil {
 190                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
 191                 return err
 192         }
 193
 194         nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol, e2tAddress)
 195
 196         err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
 197
 198         if err != nil {
 199                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
 200                 return e2managererrors.NewRnibDbError()
 201         }
 202
 203         h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
 204
 205         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 206
 207         return result
 208 }
 209
 210 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
 211
 212         if request.RanPort == 0 {
 213                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
 214                 return e2managererrors.NewRequestValidationError()
 215         }
 216         err := validation.ValidateStruct(&request,
 217                 validation.Field(&request.RanIp, validation.Required, is.IP),
 218                 validation.Field(&request.RanName, validation.Required),
 219         )
 220
 221         if err != nil {
 222                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
 223                 return e2managererrors.NewRequestValidationError()
 224         }
 225
 226         return nil
 227 }
 228
 229 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
 230         if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
 231                 return X2SetupActivityName
 232         }
 233         return EndcSetupActivityName
 234 }