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         SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request)
  55 }
  56
  57 type NodebController struct {
  58         logger          *logger.Logger
  59         handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider
  60 }
  61
  62 func NewNodebController(logger *logger.Logger, handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider) *NodebController {
  63         return &NodebController{
  64                 logger:          logger,
  65                 handlerProvider: handlerProvider,
  66         }
  67 }
  68
  69 func (c *NodebController) GetNodebIdList(writer http.ResponseWriter, r *http.Request) {
  70         c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodebIdList - request: %v", c.prettifyRequest(r))
  71
  72         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebIdListRequest, nil, false)
  73 }
  74
  75 func (c *NodebController) GetNodeb(writer http.ResponseWriter, r *http.Request) {
  76         c.logger.Infof("[Client -> E2 Manager] #NodebController.GetNodeb - request: %v", c.prettifyRequest(r))
  77         vars := mux.Vars(r)
  78         ranName := vars["ranName"]
  79         request := models.GetNodebRequest{RanName: ranName}
  80         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.GetNodebRequest, request, false)
  81 }
  82
  83 func (c *NodebController) UpdateGnb(writer http.ResponseWriter, r *http.Request) {
  84         c.logger.Infof("[Client -> E2 Manager] #NodebController.UpdateGnb - request: %v", c.prettifyRequest(r))
  85         vars := mux.Vars(r)
  86         ranName := vars[ParamRanName]
  87
  88         request := models.UpdateGnbRequest{}
  89
  90         gnb := entities.Gnb{}
  91
  92         if !c.extractRequestBodyToProto(r, &gnb, writer) {
  93                 return
  94         }
  95
  96         request.Gnb = &gnb
  97         request.RanName = ranName
  98         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.UpdateGnbRequest, request, true)
  99 }
 100
 101 func (c *NodebController) SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request) {
 102         c.logger.Infof("[Client -> E2 Manager] #NodebController.SetGeneralConfiguration - request: %v", c.prettifyRequest(r))
 103
 104         request := models.GeneralConfigurationRequest{}
 105
 106         if !c.extractJsonBodyDisallowUnknownFields(r, &request, writer){
 107                 return
 108         }
 109         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.SetGeneralConfigurationRequest, request, false)
 110 }
 111
 112 func (c *NodebController) Shutdown(writer http.ResponseWriter, r *http.Request) {
 113         c.logger.Infof("[Client -> E2 Manager] #NodebController.Shutdown - request: %v", c.prettifyRequest(r))
 114         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false)
 115 }
 116
 117 func (c *NodebController) X2Reset(writer http.ResponseWriter, r *http.Request) {
 118         c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Reset - request: %v", c.prettifyRequest(r))
 119         request := models.ResetRequest{}
 120         vars := mux.Vars(r)
 121         ranName := vars[ParamRanName]
 122
 123         if r.ContentLength > 0 && !c.extractJsonBody(r, &request, writer) {
 124                 return
 125         }
 126         request.RanName = ranName
 127         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false)
 128 }
 129
 130 func (c *NodebController) X2Setup(writer http.ResponseWriter, r *http.Request) {
 131         c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Setup - 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.X2SetupRequest, request, true)
 140 }
 141
 142 func (c *NodebController) EndcSetup(writer http.ResponseWriter, r *http.Request) {
 143         c.logger.Infof("[Client -> E2 Manager] #NodebController.EndcSetup - request: %v", c.prettifyRequest(r))
 144
 145         request := models.SetupRequest{}
 146
 147         if !c.extractJsonBody(r, &request, writer) {
 148                 return
 149         }
 150
 151         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.EndcSetupRequest, request, true)
 152 }
 153
 154 func (c *NodebController) extractRequestBodyToProto(r *http.Request, pb proto.Message , writer http.ResponseWriter) bool {
 155         defer r.Body.Close()
 156
 157         err := jsonpb.Unmarshal(r.Body, pb)
 158
 159         if err != nil {
 160                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 161                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 162                 return false
 163         }
 164
 165         return true
 166 }
 167
 168 func (c *NodebController) extractJsonBodyDisallowUnknownFields(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
 169         defer r.Body.Close()
 170
 171         decoder := json.NewDecoder(r.Body)
 172         decoder.DisallowUnknownFields()
 173
 174         if err := decoder.Decode(&request); err != nil {
 175                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 176                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 177                 return false
 178         }
 179
 180         return true
 181 }
 182
 183 func (c *NodebController) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
 184         defer r.Body.Close()
 185         body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
 186
 187         if err != nil {
 188                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 189                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 190                 return false
 191         }
 192
 193         err = json.Unmarshal(body, &request)
 194         if err != nil {
 195                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 196                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 197                 return false
 198         }
 199
 200         return true
 201 }
 202
 203 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool) {
 204
 205         if validateRequestHeaders {
 206
 207                 err := c.validateRequestHeader(header)
 208                 if err != nil {
 209                         c.handleErrorResponse(err, writer)
 210                         return
 211                 }
 212         }
 213
 214         handler, err := c.handlerProvider.GetHandler(requestName)
 215
 216         if err != nil {
 217                 c.handleErrorResponse(err, writer)
 218                 return
 219         }
 220
 221         response, err := handler.Handle(request)
 222
 223         if err != nil {
 224                 c.handleErrorResponse(err, writer)
 225                 return
 226         }
 227
 228         if response == nil {
 229                 writer.WriteHeader(http.StatusNoContent)
 230                 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
 231                 return
 232         }
 233
 234         result, err := response.Marshal()
 235
 236         if err != nil {
 237                 c.handleErrorResponse(err, writer)
 238                 return
 239         }
 240
 241         c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
 242         writer.Header().Set(ContentType, ApplicationJson)
 243         writer.Write(result)
 244 }
 245
 246 func (c *NodebController) validateRequestHeader(header *http.Header) error {
 247
 248         if header.Get(ContentType) != ApplicationJson {
 249                 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
 250
 251                 return e2managererrors.NewHeaderValidationError()
 252         }
 253         return nil
 254 }
 255
 256 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
 257
 258         var errorResponseDetails models.ErrorResponse
 259         var httpError int
 260
 261         if err != nil {
 262                 switch err.(type) {
 263                 case *e2managererrors.RnibDbError:
 264                         e2Error, _ := err.(*e2managererrors.RnibDbError)
 265                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 266                         httpError = http.StatusInternalServerError
 267                 case *e2managererrors.CommandAlreadyInProgressError:
 268                         e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
 269                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 270                         httpError = http.StatusMethodNotAllowed
 271                 case *e2managererrors.HeaderValidationError:
 272                         e2Error, _ := err.(*e2managererrors.HeaderValidationError)
 273                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 274                         httpError = http.StatusUnsupportedMediaType
 275                 case *e2managererrors.WrongStateError:
 276                         e2Error, _ := err.(*e2managererrors.WrongStateError)
 277                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 278                         httpError = http.StatusBadRequest
 279                 case *e2managererrors.RequestValidationError:
 280                         e2Error, _ := err.(*e2managererrors.RequestValidationError)
 281                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 282                         httpError = http.StatusBadRequest
 283                 case *e2managererrors.InvalidJsonError:
 284                         e2Error, _ := err.(*e2managererrors.InvalidJsonError)
 285                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 286                         httpError = http.StatusBadRequest
 287                 case *e2managererrors.RmrError:
 288                         e2Error, _ := err.(*e2managererrors.RmrError)
 289                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 290                         httpError = http.StatusInternalServerError
 291                 case *e2managererrors.ResourceNotFoundError:
 292                         e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
 293                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 294                         httpError = http.StatusNotFound
 295                 case *e2managererrors.E2TInstanceAbsenceError:
 296                         e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
 297                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 298                         httpError = http.StatusServiceUnavailable
 299                 case *e2managererrors.RoutingManagerError:
 300                         e2Error, _ := err.(*e2managererrors.RoutingManagerError)
 301                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 302                         httpError = http.StatusServiceUnavailable
 303                 default:
 304                         e2Error := e2managererrors.NewInternalError()
 305                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 306                         httpError = http.StatusInternalServerError
 307                 }
 308         }
 309         errorResponse, _ := json.Marshal(errorResponseDetails)
 310
 311         c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 312
 313         writer.Header().Set(ContentType, ApplicationJson)
 314         writer.WriteHeader(httpError)
 315         _, err = writer.Write(errorResponse)
 316 }
 317
 318 func (c *NodebController) prettifyRequest(request *http.Request) string {
 319         dump, _ := httputil.DumpRequest(request, true)
 320         requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
 321         return strings.Replace(requestPrettyPrint, "\n", "", -1)
 322 }