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         rmrResponseChannel chan<- *models.NotificationResponse
  43 }
  44
  45 func NewController(logger *logger.Logger, rmrService *services.RmrService, rNibReaderProvider func() reader.RNibReader, rNibWriterProvider func() rNibWriter.RNibWriter,
  46         config *configuration.Configuration, rmrResponseChannel chan<- *models.NotificationResponse) *Controller {
  47
  48         provider := providers.NewIncomingRequestHandlerProvider(logger, rmrService, config, rNibWriterProvider, rNibReaderProvider)
  49         return &Controller{
  50                 logger: logger,
  51                 handlerProvider: provider,
  52                 rmrResponseChannel: rmrResponseChannel,
  53         }
  54 }
  55
  56 func (c *Controller)ShutdownHandler(writer http.ResponseWriter, r *http.Request, params httprouter.Params){
  57
  58         c.handleRequest(writer, &r.Header, providers.ShutdownRequest,nil, false, http.StatusNoContent)
  59 }
  60
  61 func (c *Controller) X2ResetHandler(writer http.ResponseWriter, r *http.Request, params httprouter.Params){
  62         startTime := time.Now()
  63         request:= models.ResetRequest{}
  64         ranName:= params.ByName(ParamRanName)
  65         if !c.extractJsonBody(r.Body, &request, writer){
  66                 return
  67         }
  68         request.RanName = ranName
  69         request.StartTime = startTime
  70         c.handleRequest(writer, &r.Header, providers.ResetRequest, request, false, http.StatusNoContent)
  71 }
  72
  73 func (c *Controller) extractJsonBody(body io.Reader, request models.Request, writer http.ResponseWriter) bool{
  74         decoder := json.NewDecoder(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.NewRequestValidationError(), writer)
  79                         return false
  80                 }
  81         }
  82         return true
  83 }
  84
  85 func (c *Controller) handleRequest(writer http.ResponseWriter, header *http.Header, requestName providers.IncomingRequest,
  86         request models.Request, validateHeader bool, httpStatusResponse int) {
  87
  88         c.logger.Infof("[Client -> E2 Manager] #controller.handleRequest - request: %v", requestName) //TODO print request if exist
  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, c.rmrResponseChannel)
 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.RmrError:
 154                         e2Error, _ := err.(*e2managererrors.RmrError)
 155                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 156                         httpError = http.StatusInternalServerError
 157
 158                 default:
 159                         e2Error, _ := err.(*e2managererrors.InternalError)
 160                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Err.Code, Message: e2Error.Err.Message}
 161                         httpError = http.StatusInternalServerError
 162                 }
 163         }
 164         errorResponse, _ := json.Marshal(errorResponseDetails)
 165
 166         c.logger.Errorf("[E2 Manager -> Client] #controller.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 167
 168         writer.Header().Set("Content-Type", "application/json")
 169         writer.WriteHeader(httpError)
 170         _, err = writer.Write(errorResponse)
 171
 172         if err != nil {
 173                 c.logger.Errorf("#controller.handleErrorResponse - Cannot send response. writer:%v", writer)
 174         }
 175 }