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         GetNodeb(writer http.ResponseWriter, r *http.Request)
  50         UpdateGnb(writer http.ResponseWriter, r *http.Request)
  51         GetNodebIdList(writer http.ResponseWriter, r *http.Request)
  52         SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request)
  53         AddEnb(writer http.ResponseWriter, r *http.Request)
  54         DeleteEnb(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, http.StatusOK)
  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, http.StatusOK)
  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, http.StatusOK)
  99 }
 100
 101 func (c *NodebController) AddEnb(writer http.ResponseWriter, r *http.Request) {
 102         c.logger.Infof("[Client -> E2 Manager] #NodebController.AddEnb - request: %v", c.prettifyRequest(r))
 103
 104         defer r.Body.Close()
 105         body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
 106
 107         if err != nil {
 108                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.AddEnb - unable to read request body - error: %s", err)
 109                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 110                 return
 111         }
 112
 113         addEnbRequest := models.AddEnbRequest{}
 114         err = json.Unmarshal(body, &addEnbRequest)
 115
 116         if err != nil {
 117                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.AddEnb - unable to unmarshal json - error: %s", err)
 118                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 119                 return
 120         }
 121
 122         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.AddEnbRequest, &addEnbRequest, true, http.StatusCreated)
 123 }
 124
 125 func (c *NodebController) DeleteEnb(writer http.ResponseWriter, r *http.Request) {
 126         c.logger.Infof("[Client -> E2 Manager] #NodebController.DeleteEnb - request: %v", c.prettifyRequest(r))
 127         vars := mux.Vars(r)
 128         ranName := vars["ranName"]
 129         request := models.DeleteEnbRequest{RanName: ranName}
 130         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.DeleteEnbRequest, request, true, http.StatusNoContent)
 131 }
 132
 133 func (c *NodebController) SetGeneralConfiguration(writer http.ResponseWriter, r *http.Request) {
 134         c.logger.Infof("[Client -> E2 Manager] #NodebController.SetGeneralConfiguration - request: %v", c.prettifyRequest(r))
 135
 136         request := models.GeneralConfigurationRequest{}
 137
 138         if !c.extractJsonBodyDisallowUnknownFields(r, &request, writer) {
 139                 return
 140         }
 141         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.SetGeneralConfigurationRequest, request, false, http.StatusOK)
 142 }
 143
 144 func (c *NodebController) Shutdown(writer http.ResponseWriter, r *http.Request) {
 145         c.logger.Infof("[Client -> E2 Manager] #NodebController.Shutdown - request: %v", c.prettifyRequest(r))
 146         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false, http.StatusNoContent)
 147 }
 148
 149 func (c *NodebController) X2Reset(writer http.ResponseWriter, r *http.Request) {
 150         c.logger.Infof("[Client -> E2 Manager] #NodebController.X2Reset - request: %v", c.prettifyRequest(r))
 151         request := models.ResetRequest{}
 152         vars := mux.Vars(r)
 153         ranName := vars[ParamRanName]
 154
 155         if err := c.extractJsonBody(r, &request); err != nil {
 156                 c.handleErrorResponse(err, writer)
 157                 return
 158         }
 159         request.RanName = ranName
 160         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false, http.StatusNoContent)
 161 }
 162
 163 func (c *NodebController) extractRequestBodyToProto(r *http.Request, pb proto.Message, writer http.ResponseWriter) bool {
 164         defer r.Body.Close()
 165
 166         err := jsonpb.Unmarshal(r.Body, pb)
 167
 168         if err != nil {
 169                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 170                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 171                 return false
 172         }
 173
 174         return true
 175 }
 176
 177 func (c *NodebController) extractJsonBodyDisallowUnknownFields(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
 178         defer r.Body.Close()
 179
 180         decoder := json.NewDecoder(r.Body)
 181         decoder.DisallowUnknownFields()
 182
 183         if err := decoder.Decode(&request); err != nil {
 184                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 185                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 186                 return false
 187         }
 188
 189         return true
 190 }
 191
 192 func (c *NodebController) extractJsonBody(r *http.Request, request models.Request) error {
 193         defer r.Body.Close()
 194         body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
 195
 196         if err != nil {
 197                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 198                 return e2managererrors.NewInvalidJsonError()
 199         }
 200
 201         err = json.Unmarshal(body, &request)
 202         if err != nil {
 203                 c.logger.Errorf("[Client -> E2 Manager] #NodebController.extractJsonBody - unable to extract json body - error: %s", err)
 204                 return e2managererrors.NewInvalidJsonError()
 205         }
 206
 207         return nil
 208 }
 209
 210 func (c *NodebController) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest, request models.Request, validateRequestHeaders bool, successStatusCode int) {
 211
 212         if validateRequestHeaders {
 213
 214                 err := c.validateRequestHeader(header)
 215                 if err != nil {
 216                         c.handleErrorResponse(err, writer)
 217                         return
 218                 }
 219         }
 220
 221         handler, err := c.handlerProvider.GetHandler(requestName)
 222
 223         if err != nil {
 224                 c.handleErrorResponse(err, writer)
 225                 return
 226         }
 227
 228         response, err := handler.Handle(request)
 229
 230         if err != nil {
 231                 c.handleErrorResponse(err, writer)
 232                 return
 233         }
 234
 235         if successStatusCode == http.StatusNoContent {
 236                 writer.WriteHeader(successStatusCode)
 237                 c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - status response: %v", http.StatusNoContent)
 238                 return
 239         }
 240
 241         result, err := response.Marshal()
 242
 243         if err != nil {
 244                 c.handleErrorResponse(err, writer)
 245                 return
 246         }
 247
 248         c.logger.Infof("[E2 Manager -> Client] #NodebController.handleRequest - response: %s", result)
 249         writer.Header().Set(ContentType, ApplicationJson)
 250         writer.WriteHeader(successStatusCode)
 251         writer.Write(result)
 252 }
 253
 254 func (c *NodebController) validateRequestHeader(header *http.Header) error {
 255
 256         if header.Get(ContentType) != ApplicationJson {
 257                 c.logger.Errorf("#NodebController.validateRequestHeader - validation failure, incorrect content type")
 258
 259                 return e2managererrors.NewHeaderValidationError()
 260         }
 261         return nil
 262 }
 263
 264 func (c *NodebController) handleErrorResponse(err error, writer http.ResponseWriter) {
 265
 266         var errorResponseDetails models.ErrorResponse
 267         var httpError int
 268
 269         if err != nil {
 270                 switch err.(type) {
 271                 case *e2managererrors.RnibDbError:
 272                         e2Error, _ := err.(*e2managererrors.RnibDbError)
 273                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 274                         httpError = http.StatusInternalServerError
 275                 case *e2managererrors.CommandAlreadyInProgressError:
 276                         e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
 277                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 278                         httpError = http.StatusMethodNotAllowed
 279                 case *e2managererrors.HeaderValidationError:
 280                         e2Error, _ := err.(*e2managererrors.HeaderValidationError)
 281                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 282                         httpError = http.StatusUnsupportedMediaType
 283                 case *e2managererrors.WrongStateError:
 284                         e2Error, _ := err.(*e2managererrors.WrongStateError)
 285                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 286                         httpError = http.StatusBadRequest
 287                 case *e2managererrors.RequestValidationError:
 288                         e2Error, _ := err.(*e2managererrors.RequestValidationError)
 289                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 290                         httpError = http.StatusBadRequest
 291                 case *e2managererrors.InvalidJsonError:
 292                         e2Error, _ := err.(*e2managererrors.InvalidJsonError)
 293                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 294                         httpError = http.StatusBadRequest
 295                 case *e2managererrors.RmrError:
 296                         e2Error, _ := err.(*e2managererrors.RmrError)
 297                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 298                         httpError = http.StatusInternalServerError
 299                 case *e2managererrors.ResourceNotFoundError:
 300                         e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
 301                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 302                         httpError = http.StatusNotFound
 303                 case *e2managererrors.E2TInstanceAbsenceError:
 304                         e2Error, _ := err.(*e2managererrors.E2TInstanceAbsenceError)
 305                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 306                         httpError = http.StatusServiceUnavailable
 307                 case *e2managererrors.RoutingManagerError:
 308                         e2Error, _ := err.(*e2managererrors.RoutingManagerError)
 309                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 310                         httpError = http.StatusServiceUnavailable
 311                 case *e2managererrors.NodebExistsError:
 312                         e2Error, _ := err.(*e2managererrors.NodebExistsError)
 313                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 314                         httpError = http.StatusBadRequest
 315                 default:
 316                         e2Error := e2managererrors.NewInternalError()
 317                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 318                         httpError = http.StatusInternalServerError
 319                 }
 320         }
 321         errorResponse, _ := json.Marshal(errorResponseDetails)
 322
 323         c.logger.Errorf("[E2 Manager -> Client] #NodebController.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 324
 325         writer.Header().Set(ContentType, ApplicationJson)
 326         writer.WriteHeader(httpError)
 327         _, err = writer.Write(errorResponse)
 328 }
 329
 330 func (c *NodebController) prettifyRequest(request *http.Request) string {
 331         dump, _ := httputil.DumpRequest(request, true)
 332         requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
 333         return strings.Replace(requestPrettyPrint, "\n", "", -1)
 334 }