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/managers"
  25         "e2mgr/models"
  26         "e2mgr/providers/httpmsghandlerprovider"
  27         "e2mgr/services"
  28         "encoding/json"
  29         "github.com/gorilla/mux"
  30         "io"
  31         "io/ioutil"
  32         "net/http"
  33         "net/http/httputil"
  34         "strings"
  35 )
  36
  37 const (
  38         ParamRanName = "ranName"
  39         LimitRequest = 2000
  40 )
  41
  42 type IController interface {
  43         ShutdownHandler(writer http.ResponseWriter, r *http.Request)
  44         X2ResetHandler(writer http.ResponseWriter, r *http.Request)
  45         X2SetupHandler(writer http.ResponseWriter, r *http.Request)
  46         EndcSetupHandler(writer http.ResponseWriter, r *http.Request)
  47 }
  48
  49 type Controller struct {
  50         logger          *logger.Logger
  51         handlerProvider *httpmsghandlerprovider.IncomingRequestHandlerProvider
  52 }
  53
  54 func NewController(logger *logger.Logger, rmrService *services.RmrService, rnibDataService services.RNibDataService,
  55         config *configuration.Configuration, ranSetupManager *managers.RanSetupManager) *Controller {
  56
  57         provider := httpmsghandlerprovider.NewIncomingRequestHandlerProvider(logger, rmrService, config, rnibDataService, ranSetupManager)
  58         return &Controller{
  59                 logger:          logger,
  60                 handlerProvider: provider,
  61         }
  62 }
  63
  64 func (c *Controller) ShutdownHandler(writer http.ResponseWriter, r *http.Request) {
  65         c.logger.Infof("[Client -> E2 Manager] #controller.ShutdownHandler - request: %v", c.prettifyRequest(r))
  66         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ShutdownRequest, nil, false)
  67 }
  68
  69 func (c *Controller) X2ResetHandler(writer http.ResponseWriter, r *http.Request) {
  70         c.logger.Infof("[Client -> E2 Manager] #controller.X2ResetHandler - request: %v", c.prettifyRequest(r))
  71         request := models.ResetRequest{}
  72         vars := mux.Vars(r)
  73         ranName := vars[ParamRanName]
  74
  75         if r.ContentLength > 0 && !c.extractJsonBody(r, &request, writer) {
  76                 return
  77         }
  78         request.RanName = ranName
  79         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.ResetRequest, request, false)
  80 }
  81
  82 func (c *Controller) X2SetupHandler(writer http.ResponseWriter, r *http.Request) {
  83         c.logger.Infof("[Client -> E2 Manager] #controller.X2SetupHandler - request: %v", c.prettifyRequest(r))
  84
  85         request := models.SetupRequest{}
  86
  87         if !c.extractJsonBody(r, &request, writer) {
  88                 return
  89         }
  90
  91         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.X2SetupRequest, request, true)
  92 }
  93
  94 func (c *Controller) EndcSetupHandler(writer http.ResponseWriter, r *http.Request) {
  95         c.logger.Infof("[Client -> E2 Manager] #controller.EndcSetupHandler - request: %v", c.prettifyRequest(r))
  96
  97         request := models.SetupRequest{}
  98
  99         if !c.extractJsonBody(r, &request, writer) {
 100                 return
 101         }
 102
 103         c.handleRequest(writer, &r.Header, httpmsghandlerprovider.EndcSetupRequest, request, true)
 104 }
 105
 106 func (c *Controller) extractJsonBody(r *http.Request, request models.Request, writer http.ResponseWriter) bool {
 107         defer r.Body.Close()
 108         body, err := ioutil.ReadAll(io.LimitReader(r.Body, LimitRequest))
 109
 110         if err != nil {
 111                 c.logger.Errorf("[Client -> E2 Manager] #controller.extractJsonBody - unable to extract json body - error: %s", err)
 112                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 113                 return false
 114         }
 115
 116         err = json.Unmarshal(body, &request)
 117         if err != nil {
 118                 c.logger.Errorf("[Client -> E2 Manager] #controller.extractJsonBody - unable to extract json body - error: %s", err)
 119                 c.handleErrorResponse(e2managererrors.NewInvalidJsonError(), writer)
 120                 return false
 121         }
 122
 123         return true
 124 }
 125
 126 func (c *Controller) handleRequest(writer http.ResponseWriter, header *http.Header, requestName httpmsghandlerprovider.IncomingRequest,
 127         request models.Request, validateHeader bool) {
 128
 129         if validateHeader {
 130
 131                 err := c.validateRequestHeader(header)
 132                 if err != nil {
 133                         c.handleErrorResponse(err, writer)
 134                         return
 135                 }
 136         }
 137
 138         handler, err := c.handlerProvider.GetHandler(requestName)
 139
 140         if err != nil {
 141                 c.handleErrorResponse(err, writer)
 142                 return
 143         }
 144
 145         err = handler.Handle(request)
 146
 147         if err != nil {
 148                 c.handleErrorResponse(err, writer)
 149                 return
 150         }
 151
 152         writer.WriteHeader(http.StatusNoContent)
 153         c.logger.Infof("[E2 Manager -> Client] #controller.handleRequest - status response: %v", http.StatusNoContent)
 154 }
 155
 156 func (c *Controller) validateRequestHeader(header *http.Header) error {
 157
 158         if header.Get("Content-Type") != "application/json" {
 159                 c.logger.Errorf("#controller.validateRequestHeader - validation failure, incorrect content type")
 160
 161                 return e2managererrors.NewHeaderValidationError()
 162         }
 163         return nil
 164 }
 165
 166 func (c *Controller) handleErrorResponse(err error, writer http.ResponseWriter) {
 167
 168         var errorResponseDetails models.ErrorResponse
 169         var httpError int
 170
 171         if err != nil {
 172                 switch err.(type) {
 173                 case *e2managererrors.RnibDbError:
 174                         e2Error, _ := err.(*e2managererrors.RnibDbError)
 175                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 176                         httpError = http.StatusInternalServerError
 177                 case *e2managererrors.CommandAlreadyInProgressError:
 178                         e2Error, _ := err.(*e2managererrors.CommandAlreadyInProgressError)
 179                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 180                         httpError = http.StatusMethodNotAllowed
 181                 case *e2managererrors.HeaderValidationError:
 182                         e2Error, _ := err.(*e2managererrors.HeaderValidationError)
 183                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 184                         httpError = http.StatusUnsupportedMediaType
 185                 case *e2managererrors.WrongStateError:
 186                         e2Error, _ := err.(*e2managererrors.WrongStateError)
 187                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 188                         httpError = http.StatusBadRequest
 189                 case *e2managererrors.RequestValidationError:
 190                         e2Error, _ := err.(*e2managererrors.RequestValidationError)
 191                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 192                         httpError = http.StatusBadRequest
 193                 case *e2managererrors.InvalidJsonError:
 194                         e2Error, _ := err.(*e2managererrors.InvalidJsonError)
 195                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 196                         httpError = http.StatusBadRequest
 197                 case *e2managererrors.RmrError:
 198                         e2Error, _ := err.(*e2managererrors.RmrError)
 199                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 200                         httpError = http.StatusInternalServerError
 201                 case *e2managererrors.ResourceNotFoundError:
 202                         e2Error, _ := err.(*e2managererrors.ResourceNotFoundError)
 203                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 204                         httpError = http.StatusNotFound
 205
 206                 default:
 207                         e2Error := e2managererrors.NewInternalError()
 208                         errorResponseDetails = models.ErrorResponse{Code: e2Error.Code, Message: e2Error.Message}
 209                         httpError = http.StatusInternalServerError
 210                 }
 211         }
 212         errorResponse, _ := json.Marshal(errorResponseDetails)
 213
 214         c.logger.Errorf("[E2 Manager -> Client] #controller.handleErrorResponse - http status: %d, error response: %+v", httpError, errorResponseDetails)
 215
 216         writer.Header().Set("Content-Type", "application/json")
 217         writer.WriteHeader(httpError)
 218         _, err = writer.Write(errorResponse)
 219
 220         if err != nil {
 221                 c.logger.Errorf("#controller.handleErrorResponse - Cannot send response. writer:%v", writer)
 222         }
 223 }
 224
 225 func (c *Controller) prettifyRequest(request *http.Request) string {
 226         dump, _ := httputil.DumpRequest(request, true)
 227         requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
 228         return strings.Replace(requestPrettyPrint, "\n", "", -1)
 229 }