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.RanSetupManager
  40         protocol            entities.E2ApplicationProtocol
  41         e2tInstancesManager managers.IE2TInstancesManager
  42 }
  43
  44 func NewSetupRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService,
  45         ranSetupManager *managers.RanSetupManager, 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 (handler *SetupRequestHandler) Handle(request models.Request) (models.IResponse, error) {
  56
  57         setupRequest := request.(models.SetupRequest)
  58
  59         err := handler.validateRequestDetails(setupRequest)
  60         if err != nil {
  61                 return nil, err
  62         }
  63
  64         nodebInfo, err := handler.rNibDataService.GetNodeb(setupRequest.RanName)
  65
  66         if err != nil {
  67                 _, ok := err.(*common.ResourceNotFoundError)
  68                 if !ok {
  69                         handler.logger.Errorf("#SetupRequestHandler.Handle - failed to get nodeB entity for ran name: %v from RNIB. Error: %s",
  70                                 setupRequest.RanName, err.Error())
  71                         return nil, e2managererrors.NewRnibDbError()
  72                 }
  73
  74                 result := handler.connectNewRan(&setupRequest, handler.protocol)
  75                 return nil, result
  76         }
  77
  78         if len(nodebInfo.AssociatedE2TInstanceAddress) != 0 {
  79                 result := handler.connectExistingRanWithAssociatedE2TAddress(nodebInfo)
  80                 return nil, result
  81         }
  82
  83         result := handler.connectExistingRanWithoutAssociatedE2TAddress(nodebInfo)
  84         return nil, result
  85 }
  86
  87 func createInitialNodeInfo(requestDetails *models.SetupRequest, protocol entities.E2ApplicationProtocol, e2tAddress string) (*entities.NodebInfo, *entities.NbIdentity) {
  88
  89         nodebInfo := &entities.NodebInfo{
  90                 Ip:                           requestDetails.RanIp,
  91                 Port:                         uint32(requestDetails.RanPort),
  92                 ConnectionStatus:             entities.ConnectionStatus_CONNECTING,
  93                 E2ApplicationProtocol:        protocol,
  94                 RanName:                      requestDetails.RanName,
  95                 ConnectionAttempts:           0,
  96                 AssociatedE2TInstanceAddress: e2tAddress,
  97         }
  98
  99         nbIdentity := &entities.NbIdentity{
 100                 InventoryName: requestDetails.RanName,
 101         }
 102
 103         return nodebInfo, nbIdentity
 104 }
 105
 106 func (h *SetupRequestHandler) connectExistingRanWithoutAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 107         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 108
 109         if err != nil {
 110                 //TODO: handle
 111                 return err
 112         }
 113
 114         err = h.e2tInstancesManager.AssociateRan(nodebInfo.RanName, e2tAddress)
 115
 116         if err != nil {
 117                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed associating ran to e2t address %s. error: %s", nodebInfo.RanName, e2tAddress, err)
 118                 return e2managererrors.NewRnibDbError()
 119         }
 120
 121         nodebInfo.AssociatedE2TInstanceAddress = e2tAddress
 122         nodebInfo.ConnectionAttempts = 0
 123
 124         err = h.rNibDataService.UpdateNodebInfo(nodebInfo)
 125
 126         if err != nil {
 127                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
 128                 return e2managererrors.NewRnibDbError()
 129         }
 130
 131         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithoutAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
 132
 133         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 134         return result
 135 }
 136
 137 func (h *SetupRequestHandler) connectExistingRanWithAssociatedE2TAddress(nodebInfo *entities.NodebInfo) error {
 138
 139         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_SHUTTING_DOWN {
 140                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN: %s in wrong state (%s)", nodebInfo.RanName, entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
 141                 return e2managererrors.NewWrongStateError(h.getActivityName(h.protocol), entities.ConnectionStatus_name[int32(nodebInfo.ConnectionStatus)])
 142         }
 143
 144         status := entities.ConnectionStatus_CONNECTING
 145         if nodebInfo.ConnectionStatus == entities.ConnectionStatus_CONNECTED {
 146                 status = nodebInfo.ConnectionStatus
 147         }
 148
 149         nodebInfo.ConnectionAttempts = 0
 150
 151         err := h.rNibDataService.UpdateNodebInfo(nodebInfo)
 152
 153         if err != nil {
 154                 h.logger.Errorf("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - failed updating nodeb in rNib. error: %s", nodebInfo.RanName, err)
 155                 return e2managererrors.NewRnibDbError()
 156         }
 157
 158         h.logger.Infof("#SetupRequestHandler.connectExistingRanWithAssociatedE2TAddress - RAN name: %s - successfully updated nodeb in rNib", nodebInfo.RanName)
 159
 160         result := h.ranSetupManager.ExecuteSetup(nodebInfo, status)
 161         return result
 162 }
 163
 164 func (h *SetupRequestHandler) connectNewRan(request *models.SetupRequest, protocol entities.E2ApplicationProtocol) error {
 165
 166         e2tAddress, err := h.e2tInstancesManager.SelectE2TInstance()
 167
 168         if err != nil {
 169                 //TODO: handle
 170                 return err
 171         }
 172
 173         err = h.e2tInstancesManager.AssociateRan(request.RanName, e2tAddress)
 174
 175         if err != nil {
 176                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed associating ran to e2t address %s. error: %s", request.RanName, e2tAddress, err)
 177                 return e2managererrors.NewRnibDbError()
 178         }
 179
 180         nodebInfo, nodebIdentity := createInitialNodeInfo(request, protocol, e2tAddress)
 181
 182         err = h.rNibDataService.SaveNodeb(nodebIdentity, nodebInfo)
 183
 184         if err != nil {
 185                 h.logger.Errorf("#SetupRequestHandler.connectNewRan - RAN name: %s - failed to save initial nodeb entity in RNIB. error: %s", request.RanName, err)
 186                 return e2managererrors.NewRnibDbError()
 187         }
 188
 189         h.logger.Infof("#SetupRequestHandler.connectNewRan - RAN name: %s - initial nodeb entity was saved to rNib", request.RanName)
 190
 191         result := h.ranSetupManager.ExecuteSetup(nodebInfo, entities.ConnectionStatus_CONNECTING)
 192
 193         return result
 194 }
 195
 196 func (handler *SetupRequestHandler) validateRequestDetails(request models.SetupRequest) error {
 197
 198         if request.RanPort == 0 {
 199                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure: port cannot be zero")
 200                 return e2managererrors.NewRequestValidationError()
 201         }
 202         err := validation.ValidateStruct(&request,
 203                 validation.Field(&request.RanIp, validation.Required, is.IP),
 204                 validation.Field(&request.RanName, validation.Required),
 205         )
 206
 207         if err != nil {
 208                 handler.logger.Errorf("#SetupRequestHandler.validateRequestDetails - validation failure, error: %v", err)
 209                 return e2managererrors.NewRequestValidationError()
 210         }
 211
 212         return nil
 213 }
 214
 215 func (handler *SetupRequestHandler) getActivityName(protocol entities.E2ApplicationProtocol) string {
 216         if protocol == entities.E2ApplicationProtocol_X2_SETUP_REQUEST {
 217                 return X2SetupActivityName
 218         }
 219         return EndcSetupActivityName
 220 }