E2Manager/controllers/nodeb_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/logger"
  22         "e2mgr/models"
  23         "e2mgr/providers/httpmsghandlerprovider"
  24         "e2mgr/rNibWriter"
  25         "e2mgr/services"
  26         "e2mgr/sessions"
  27         "e2mgr/utils"
  28         "encoding/json"
  29         "errors"
  30         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  31         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  32         "github.com/go-ozzo/ozzo-validation"
  33         "github.com/go-ozzo/ozzo-validation/is"
  34         "github.com/golang/protobuf/jsonpb"
  35         "github.com/gorilla/mux"
  36         "net/http"
  37         "net/http/httputil"
  38         "strings"
  39         "sync"
  40         "time"
  41 )
  42
  43 const (
  44         parseErrorCode            int = 401
  45         validationErrorCode       int = 402
  46         notFoundErrorCode         int = 404
  47         internalErrorCode         int = 501
  48         requiredInputErrorMessage     = "Mandatory fields are missing"
  49         validationFailedMessage       = "Validation failed"
  50         parseErrorMessage             = "Parse failure"
  51         notFoundErrorMessage          = "Resource not found"
  52         internalErrorMessage          = "Internal Server Error. Please try again later"
  53         sendMessageErrorMessage       = "Failed to send message. For more information please check logs"
  54 )
  55
  56 var E2Sessions = make(sessions.E2Sessions)
  57
  58 var messageChannel chan *models.E2RequestMessage
  59 var errorChannel chan error
  60
  61 type INodebController interface {
  62         HandleRequest(writer http.ResponseWriter, request *http.Request)
  63         GetNodebIdList (writer http.ResponseWriter, request *http.Request)
  64         GetNodeb(writer http.ResponseWriter, request *http.Request)
  65         HandleHealthCheckRequest(writer http.ResponseWriter, request *http.Request)
  66 }
  67
  68 type NodebController struct {
  69         rmrService         *services.RmrService
  70         Logger             *logger.Logger
  71         rnibReaderProvider func() reader.RNibReader
  72         rnibWriterProvider func() rNibWriter.RNibWriter
  73 }
  74
  75 func NewNodebController(logger *logger.Logger, rmrService *services.RmrService, rnibReaderProvider func() reader.RNibReader, rnibWriterProvider func() rNibWriter.RNibWriter) *NodebController {
  76         messageChannel = make(chan *models.E2RequestMessage)
  77         errorChannel = make(chan error)
  78         return &NodebController{
  79                 rmrService:         rmrService,
  80                 Logger:             logger,
  81                 rnibReaderProvider: rnibReaderProvider,
  82                 rnibWriterProvider: rnibWriterProvider,
  83         }
  84 }
  85
  86 func prettifyRequest(request *http.Request) string {
  87         dump, _ := httputil.DumpRequest(request, true)
  88         requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
  89         return strings.Replace(requestPrettyPrint, "\n", "", -1)
  90 }
  91
  92 func (rc NodebController) HandleRequest(writer http.ResponseWriter, request *http.Request) {
  93         startTime := time.Now()
  94         rc.Logger.Infof("[Client -> E2 Manager] #nodeb_controller.HandleRequest - request: %v", prettifyRequest(request))
  95
  96         vars := mux.Vars(request)
  97         messageTypeParam := vars["messageType"]
  98         requestHandlerProvider := httpmsghandlerprovider.NewRequestHandlerProvider(rc.rnibWriterProvider)
  99         handler, err := requestHandlerProvider.GetHandler(rc.Logger, messageTypeParam)
 100
 101         if err != nil {
 102                 handleErrorResponse(rc.Logger, http.StatusNotFound, notFoundErrorCode, notFoundErrorMessage, writer, startTime)
 103                 return
 104         }
 105
 106         requestDetails, err := parseJson(rc.Logger, request)
 107
 108         if err != nil {
 109                 handleErrorResponse(rc.Logger, http.StatusBadRequest, parseErrorCode, parseErrorMessage, writer, startTime)
 110                 return
 111         }
 112
 113         rc.Logger.Infof("#nodeb_controller.HandleRequest - request: %+v", requestDetails)
 114
 115         if err := validateRequestDetails(rc.Logger, requestDetails); err != nil {
 116                 handleErrorResponse(rc.Logger, http.StatusBadRequest, validationErrorCode, requiredInputErrorMessage, writer, startTime)
 117                 return
 118         }
 119
 120         err = handler.PreHandle(rc.Logger, &requestDetails)
 121
 122         if err != nil {
 123                 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, err.Error(), writer, startTime)
 124                 return
 125         }
 126
 127         rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.HandleRequest - http status: 200")
 128         writer.WriteHeader(http.StatusOK)
 129
 130         var wg sync.WaitGroup
 131
 132         go handler.CreateMessage(rc.Logger, &requestDetails, messageChannel, E2Sessions, startTime, wg)
 133
 134         go rc.rmrService.SendMessage(handler.GetMessageType(), messageChannel, errorChannel, wg)
 135
 136         wg.Wait()
 137
 138         err = <-errorChannel
 139
 140         if err != nil {
 141                 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, sendMessageErrorMessage, writer, startTime)
 142                 return
 143         }
 144
 145         printHandlingRequestElapsedTimeInMs(rc.Logger, startTime)
 146 }
 147
 148 func (rc NodebController) GetNodebIdList (writer http.ResponseWriter, request *http.Request) {
 149         startTime := time.Now()
 150         rnibReaderService := services.NewRnibReaderService(rc.rnibReaderProvider)
 151         nodebIdList, rnibError := rnibReaderService.GetNodebIdList()
 152
 153         if rnibError != nil {
 154                 rc.Logger.Errorf("%v", rnibError);
 155                 httpStatusCode, errorCode, errorMessage := rnibErrorToHttpError(rnibError)
 156                 handleErrorResponse(rc.Logger, httpStatusCode, errorCode, errorMessage, writer, startTime)
 157                 return;
 158         }
 159
 160         pmList := utils.ConvertNodebIdListToProtoMessageList(nodebIdList)
 161         result, err := utils.MarshalProtoMessageListToJsonArray(pmList)
 162
 163         if err != nil {
 164                 rc.Logger.Errorf("%v", err);
 165                 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, internalErrorMessage, writer, startTime)
 166                 return;
 167         }
 168
 169         writer.Header().Set("Content-Type", "application/json")
 170         rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.GetNodebIdList - response: %s", result)
 171         writer.Write([]byte(result))
 172 }
 173
 174 func (rc NodebController) GetNodeb(writer http.ResponseWriter, request *http.Request) {
 175         startTime := time.Now()
 176         vars := mux.Vars(request)
 177         ranName := vars["ranName"]
 178         // WAS: respondingNode, rnibError := reader.GetRNibReader().GetNodeb(ranName)
 179         rnibReaderService := services.NewRnibReaderService(rc.rnibReaderProvider);
 180         respondingNode, rnibError := rnibReaderService.GetNodeb(ranName)
 181         if rnibError != nil {
 182                 rc.Logger.Errorf("%v", rnibError)
 183                 httpStatusCode, errorCode, errorMessage := rnibErrorToHttpError(rnibError)
 184                 handleErrorResponse(rc.Logger, httpStatusCode, errorCode, errorMessage, writer, startTime)
 185                 return
 186         }
 187
 188         m := jsonpb.Marshaler{}
 189         result, err := m.MarshalToString(respondingNode)
 190
 191         if err != nil {
 192                 rc.Logger.Errorf("%v", err)
 193                 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, internalErrorMessage, writer, startTime)
 194                 return
 195         }
 196
 197         writer.Header().Set("Content-Type", "application/json")
 198         rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.GetNodeb - response: %s", result)
 199         writer.Write([]byte(result))
 200 }
 201
 202 func (rc NodebController) HandleHealthCheckRequest(writer http.ResponseWriter, request *http.Request) {
 203         //fmt.Println("[X-APP -> Client] #HandleHealthCheckRequest - http status: 200")
 204         writer.WriteHeader(http.StatusOK)
 205 }
 206
 207 func parseJson(logger *logger.Logger, request *http.Request) (models.RequestDetails, error) {
 208         var requestDetails models.RequestDetails
 209         if err := json.NewDecoder(request.Body).Decode(&requestDetails); err != nil {
 210                 logger.Errorf("#nodeb_controller.parseJson - cannot deserialize incoming request. request: %v, error: %v", request, err)
 211                 return requestDetails, err
 212         }
 213         return requestDetails, nil
 214 }
 215
 216 func validateRequestDetails(logger *logger.Logger, requestDetails models.RequestDetails) error {
 217
 218         if requestDetails.RanPort == 0 {
 219                 logger.Errorf("#nodeb_controller.validateRequestDetails - validation failure: port cannot be zero")
 220                 return errors.New("port: cannot be blank")
 221         }
 222         err := validation.ValidateStruct(&requestDetails,
 223                 validation.Field(&requestDetails.RanIp, validation.Required, is.IP),
 224                 validation.Field(&requestDetails.RanName, validation.Required),
 225         )
 226         if err != nil {
 227                 logger.Errorf("#nodeb_controller.validateRequestDetails - validation failure, error: %v", err)
 228         }
 229
 230         return err
 231 }
 232
 233 func handleErrorResponse(logger *logger.Logger, httpStatus int, errorCode int, errorMessage string, writer http.ResponseWriter, startTime time.Time) {
 234         errorResponseDetails := models.ErrorResponse{errorCode, errorMessage}
 235         errorResponse, _ := json.Marshal(errorResponseDetails)
 236         printHandlingRequestElapsedTimeInMs(logger, startTime)
 237         logger.Infof("[E2 Manager -> Client] #nodeb_controller.handleErrorResponse - http status: %d, error response: %+v", httpStatus, errorResponseDetails)
 238         writer.Header().Set("Content-Type", "application/json")
 239         writer.WriteHeader(httpStatus)
 240         _, err := writer.Write(errorResponse)
 241
 242         if err != nil {
 243                 logger.Errorf("#nodeb_controller.handleErrorResponse - Cannot send response. writer:%v", writer)
 244         }
 245 }
 246
 247 func printHandlingRequestElapsedTimeInMs(logger *logger.Logger, startTime time.Time) {
 248         logger.Infof("Summary: #nodeb_controller.printElapsedTimeInMs - Elapsed time for handling request from client to E2 termination: %f ms",
 249                 float64(time.Since(startTime))/float64(time.Millisecond))
 250 }
 251
 252 func rnibErrorToHttpError(rnibError error) (int, int, string) {
 253         switch rnibError.(type) {
 254         case *common.ResourceNotFoundError:
 255                 return http.StatusNotFound, notFoundErrorCode, notFoundErrorMessage
 256         case *common.InternalError:
 257                 return http.StatusInternalServerError, internalErrorCode, internalErrorMessage
 258         case *common.ValidationError:
 259                 return http.StatusBadRequest, validationErrorCode, validationFailedMessage
 260         default:
 261                 return http.StatusInternalServerError, internalErrorCode, internalErrorMessage
 262         }
 263 }