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