E2Manager/controllers/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
  18 package controllers
  19
  20 import (
  21         "e2mgr/configuration"
  22         "e2mgr/e2managererrors"
  23         "e2mgr/logger"
  24         "e2mgr/models"
  25         "e2mgr/providers"
  26         "e2mgr/rNibWriter"
  27         "e2mgr/services"
  28         "encoding/json"
  29         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  30         "github.com/julienschmidt/httprouter"
  31         "net/http"
  32 )
  33
  34 const (
  35         ParamRanName = "ranName"
  36 )
  37 type Controller struct {
  38         logger         *logger.Logger
  39         handlerProvider *providers.IncomingRequestHandlerProvider
  40 }
  41
  42 func NewController(logger *logger.Logger, rmrService *services.RmrService, rNibReaderProvider func() reader.RNibReader, rNibWriterProvider func() rNibWriter.RNibWriter,
  43         config *configuration.Configuration) *Controller {
  44
  45         provider := providers.NewIncomingRequestHandlerProvider(logger, rmrService, config, rNibWriterProvider, rNibReaderProvider)
  46         return &Controller{
  47                 logger: logger,
  48                 handlerProvider: provider,
  49         }
  50 }
  51
  52 func (c *Controller)ShutdownHandler(writer http.ResponseWriter, r *http.Request, params httprouter.Params){
  53         c.logger.Infof("[Client -> E2 Manager] #controller.ShutdownHandler - request: %v", prettifyRequest(r))
  54         c.handleRequest(writer, &r.Header, providers.ShutdownRequest,nil, false, http.StatusNoContent)
  55 }
  56
  57 func (c *Controller) X2ResetHandler(writer http.ResponseWriter, r *http.Request, params httprouter.Params){
  58         c.logger.Infof("[Client -> E2 Manager] #controller.X2ResetHandler - request: %v", prettifyRequest(r))
  59         request:= models.ResetRequest{}
  60         ranName:= params.ByName(ParamRanName)
  61
  62         if !c.extractJsonBody(r, &request, writer){
  63                 return
  64         }
  65         request.RanName = ranName
  66         c.handleRequest(writer, &r.Header, providers.ResetRequest, request, false, http.StatusNoContent)
  67 }
  68
  69 func (c *Controller) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool{
  70         if r.ContentLength <= 0 {
  71                 return true
  72         }
  73
  74         decoder := json.NewDecoder(r.Body)
  75         if err := decoder.Decode(request); err != nil {
  76                 if err != nil {
  77                         c.logger.Errorf("[Client -> E2 Manager] #controller.extractJsonBody - unable to extract json body - error: %s", err)
  78                         c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
  79                         return false
  80                 }
  81         }
  82
  83         return true
  84 }
  85
  86 func (c *Controller) handleRequest(writer http.ResponseWriter, header *http.Header, requestName providers.IncomingRequest,
  87         request models.Request, validateHeader bool, httpStatusResponse int) {
  88
  89         if validateHeader {
  90
  91                 err := c.validateRequestHeader(header)
  92                 if err != nil {
  93                         c.handleErrorResponse(err, writer)
  94                         return
  95                 }
  96         }
  97
  98         handler,err := c.handlerProvider.GetHandler(requestName)
  99         if err != nil {
 100                 c.handleErrorResponse(err, writer)
 101                 return
 102         }
 103
 104         err = handler.Handle(c.logger, request)
 105
 106         if err != nil {
 107                 c.handleErrorResponse(err, writer)
 108                 return
 109         }
 110
 111         writer.WriteHeader(httpStatusResponse)
 112         c.logger.Infof("[E2 Manager -> Client] #controller.handleRequest - status response: %v", httpStatusResponse)
 113 }
 114
 115 func (c *Controller) validateRequestHeader( header *http.Header) error {
 116
 117         if header.Get("Content-Type") != "application/json"{
 118                 c.logger.Errorf("#controller.validateRequestHeader - validation failure, incorrect content type")
 119
 120                 return  e2managererrors.NewHeaderValidationError()
 121         }
 122         return nil
 123 }
 124
 125 func (c *Controller) handleErrorResponse(err error, writer http.ResponseWriter){
 126
 127         var errorResponseDetails models.ErrorResponse
 128         var httpError int
 129
 130         if err != nil {
 131                 switch err.(type) {
 132                 case *e2managererrors.RnibDbError:
 133                         e2Error, _ := err.(*e2managererrors.RnibDbError)
 134                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 135                         httpError = http.StatusInternalServerError
 136                 case *e2managererrors.CommandAlreadyInProgressError:
 137                         e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
 138                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 139                         httpError = http.StatusMethodNotAllowed
 140                 case *e2managererrors.HeaderValidationError:
 141                         e2Error, _ := err.(*e2managererrors.HeaderValidationError)
 142                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 143                         httpError = http.StatusUnsupportedMediaType
 144                 case *e2managererrors.WrongStateError:
 145                         e2Error, _ := err.(*e2managererrors.WrongStateError)
 146                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 147                         httpError = http.StatusBadRequest
 148                 case *e2managererrors.RequestValidationError:
 149                         e2Error, _ := err.(*e2managererrors.RequestValidationError)
 150                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 151                         httpError = http.StatusBadRequest
 152                 case *e2managererrors.InvalidJsonError:
 153                         e2Error, _ := err.(*e2managererrors.InvalidJsonError)
 154                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 155                         httpError = http.StatusBadRequest
 156                 case *e2managererrors.RmrError:
 157                         e2Error, _ := err.(*e2managererrors.RmrError)
 158                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 159                         httpError = http.StatusInternalServerError
 160                 case *e2managererrors.ResourceNotFoundError:
 161                         e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
 162                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 163                         httpError = http.StatusNotFound
 164
 165                 default:
 166                         e2Error := e2managererrors.NewInternalError()
 167                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 168                         httpError = http.StatusInternalServerError
 169                 }
 170         }
 171         errorResponse, _ := json.Marshal(errorResponseDetails)
 172
 173         c.logger.Errorf("[E2 Manager -> Client] #controller.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 174
 175         writer.Header().Set("Content-Type", "application/json")
 176         writer.WriteHeader(httpError)
 177         _, err = writer.Write(errorResponse)
 178
 179         if err != nil {
 180                 c.logger.Errorf("#controller.handleErrorResponse - Cannot send response. writer:%v", writer)
 181         }
 182 }