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