E2Manager/controllers/nodeb_controller.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 controllers
  21
  22 import (
  23         "e2mgr/e2managererrors"
  24         "e2mgr/logger"
  25         "e2mgr/models"
  26         "e2mgr/providers/httpmsghandlerprovider"
  27         "encoding/json"
  28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  29         "github.com/golang/protobuf/jsonpb"
  30         "github.com/golang/protobuf/proto"
  31         "github.com/gorilla/mux"
  32         "io"
  33         "io/ioutil"
  34         "net/http"
  35         "net/http/httputil"
  36         "strings"
  37 )
  38
  39 const (
  40         ParamRanName = "ranName"
  41         LimitRequest = 2000
  42 )
  43 const ApplicationJson = "application/json"
  44 const ContentType = "Content-Type"
  45
  46 type INodebController interface {
  47         Shutdown(writer http.ResponseWriter, r *http.Request)
  48         X2Reset(writer http.ResponseWriter, r *http.Request)
  49         X2Setup(writer http.ResponseWriter, r *http.Request)
  50         EndcSetup(writer http.ResponseWriter, r *http.Request)
  51         GetNodeb(writer http.ResponseWriter, r *http.Request)
  52         UpdateGnb(writer http.ResponseWriter, r *http.Request)
  53         GetNodebIdList(writer http.ResponseWriter, r *http.Request)
  54 }
  55
  56 type NodebController struct {
  57         logger          *logger.Logger
  58         handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider
  59 }
  60
  61 func NewNodebController(logger *logger.Logger, handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider) *NodebController {
  62         return &NodebController{
  63                 logger:          logger,
  64                 handlerProvider: handlerProvider,
  65         }
  66 }
  67
  68 func (c *NodebController) GetNodebIdList(writer http.ResponseWriter, r *http.Request) {
  69         c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodebIdList - request: %v", c.prettifyRequest(r))
  70
  71         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebIdListRequest, nil, false)
  72 }
  73
  74 func (c *NodebController) GetNodeb(writer http.ResponseWriter, r *http.Request) {
  75         c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodeb - request: %v", c.prettifyRequest(r))
  76         vars := mux.Vars(r)
  77         ranName := vars["ranName"]
  78         request := models.GetNodebRequest{RanName: ranName}
  79         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebRequest, request, false)
  80 }
  81
  82 func (c *NodebController) UpdateGnb(writer http.ResponseWriter, r *http.Request) {
  83         c.logger.Infof("[Client -> E2 Manager] #NodebController.UpdateGnb - request: %v", c.prettifyRequest(r))
  84         vars := mux.Vars(r)
  85         ranName := vars[ParamRanName]
  86
  87         request := models.UpdateGnbRequest{}
  88
  89         gnb := entities.Gnb{}
  90
  91         if !c.extractRequestBodyToProto(r, &gnb, writer) {
  92                 return
  93         }
  94
  95         request.Gnb = &gnb;
  96         request.RanName = ranName
  97         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.UpdateGnbRequest, request, true)
  98 }
  99
 100 func (c *NodebController) Shutdown(writer http.ResponseWriter, r *http.Request) {
 101         c.logger.Infof("[Client -> E2 Manager] #NodebController.Shutdown - request: %v", c.prettifyRequest(r))
 102         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false)
 103 }
 104
 105 func (c *NodebController) X2Reset(writer http.ResponseWriter, r *http.Request) {
 106         c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Reset - request: %v", c.prettifyRequest(r))
 107         request := models.ResetRequest{}
 108         vars := mux.Vars(r)
 109         ranName := vars[ParamRanName]
 110
 111         if r.ContentLength > 0 && !c.extractJsonBody(r, &request, writer) {
 112                 return
 113         }
 114         request.RanName = ranName
 115         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false)
 116 }
 117
 118 func (c *NodebController) X2Setup(writer http.ResponseWriter, r *http.Request) {
 119         c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Setup - request: %v", c.prettifyRequest(r))
 120
 121         request := models.SetupRequest{}
 122
 123         if !c.extractJsonBody(r, &request, writer) {
 124                 return
 125         }
 126
 127         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.X2SetupRequest, request, true)
 128 }
 129
 130 func (c *NodebController) EndcSetup(writer http.ResponseWriter, r *http.Request) {
 131         c.logger.Infof("[Client -> E2 Manager] #NodebController.EndcSetup - request: %v", c.prettifyRequest(r))
 132
 133         request := models.SetupRequest{}
 134
 135         if !c.extractJsonBody(r, &request, writer) {
 136                 return
 137         }
 138
 139         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.EndcSetupRequest, request, true)
 140 }
 141
 142 func (c *NodebController) extractRequestBodyToProto(r *http.Request, pb proto.Message , writer http.ResponseWriter) bool {
 143         defer r.Body.Close()
 144
 145         err := jsonpb.Unmarshal(r.Body, pb)
 146
 147         if err != nil {
 148                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 149                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 150                 return false
 151         }
 152
 153         return true
 154 }
 155
 156 func (c *NodebController) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
 157         defer r.Body.Close()
 158         body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
 159
 160         if err != nil {
 161                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 162                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 163                 return false
 164         }
 165
 166         err = json.Unmarshal(body, &request)
 167         if err != nil {
 168                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 169                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 170                 return false
 171         }
 172
 173         return true
 174 }
 175
 176 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool) {
 177
 178         if validateRequestHeaders {
 179
 180                 err := c.validateRequestHeader(header)
 181                 if err != nil {
 182                         c.handleErrorResponse(err, writer)
 183                         return
 184                 }
 185         }
 186
 187         handler, err := c.handlerProvider.GetHandler(requestName)
 188
 189         if err != nil {
 190                 c.handleErrorResponse(err, writer)
 191                 return
 192         }
 193
 194         response, err := handler.Handle(request)
 195
 196         if err != nil {
 197                 c.handleErrorResponse(err, writer)
 198                 return
 199         }
 200
 201         if response == nil {
 202                 writer.WriteHeader(http.StatusNoContent)
 203                 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
 204                 return
 205         }
 206
 207         result, err := response.Marshal()
 208
 209         if err != nil {
 210                 c.handleErrorResponse(err, writer)
 211                 return
 212         }
 213
 214         c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
 215         writer.Header().Set(ContentType, ApplicationJson)
 216         writer.Write(result)
 217 }
 218
 219 func (c *NodebController) validateRequestHeader(header *http.Header) error {
 220
 221         if header.Get(ContentType) != ApplicationJson {
 222                 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
 223
 224                 return e2managererrors.NewHeaderValidationError()
 225         }
 226         return nil
 227 }
 228
 229 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
 230
 231         var errorResponseDetails models.ErrorResponse
 232         var httpError int
 233
 234         if err != nil {
 235                 switch err.(type) {
 236                 case *e2managererrors.RnibDbError:
 237                         e2Error, _ := err.(*e2managererrors.RnibDbError)
 238                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 239                         httpError = http.StatusInternalServerError
 240                 case *e2managererrors.CommandAlreadyInProgressError:
 241                         e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
 242                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 243                         httpError = http.StatusMethodNotAllowed
 244                 case *e2managererrors.HeaderValidationError:
 245                         e2Error, _ := err.(*e2managererrors.HeaderValidationError)
 246                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 247                         httpError = http.StatusUnsupportedMediaType
 248                 case *e2managererrors.WrongStateError:
 249                         e2Error, _ := err.(*e2managererrors.WrongStateError)
 250                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 251                         httpError = http.StatusBadRequest
 252                 case *e2managererrors.RequestValidationError:
 253                         e2Error, _ := err.(*e2managererrors.RequestValidationError)
 254                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 255                         httpError = http.StatusBadRequest
 256                 case *e2managererrors.InvalidJsonError:
 257                         e2Error, _ := err.(*e2managererrors.InvalidJsonError)
 258                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 259                         httpError = http.StatusBadRequest
 260                 case *e2managererrors.RmrError:
 261                         e2Error, _ := err.(*e2managererrors.RmrError)
 262                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 263                         httpError = http.StatusInternalServerError
 264                 case *e2managererrors.ResourceNotFoundError:
 265                         e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
 266                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 267                         httpError = http.StatusNotFound
 268                 case *e2managererrors.E2TInstanceAbsenceError:
 269                         e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
 270                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 271                         httpError = http.StatusServiceUnavailable
 272                 case *e2managererrors.RoutingManagerError:
 273                         e2Error, _ := err.(*e2managererrors.RoutingManagerError)
 274                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 275                         httpError = http.StatusServiceUnavailable
 276                 default:
 277                         e2Error := e2managererrors.NewInternalError()
 278                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 279                         httpError = http.StatusInternalServerError
 280                 }
 281         }
 282         errorResponse, _ := json.Marshal(errorResponseDetails)
 283
 284         c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 285
 286         writer.Header().Set(ContentType, ApplicationJson)
 287         writer.WriteHeader(httpError)
 288         _, err = writer.Write(errorResponse)
 289 }
 290
 291 func (c *NodebController) prettifyRequest(request *http.Request) string {
 292         dump, _ := httputil.DumpRequest(request, true)
 293         requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
 294         return strings.Replace(requestPrettyPrint, "\n", "", -1)
 295 }