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