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