2 // Copyright 2019 AT&T Intellectual Property
3 // Copyright 2019 Nokia
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
9 // http://www.apache.org/licenses/LICENSE-2.0
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.
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/julienschmidt/httprouter"
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"
56 var E2Sessions = make(sessions.E2Sessions)
58 var messageChannel chan *models.E2RequestMessage
59 var errorChannel chan error
61 type NodebController struct {
62 rmrService *services.RmrService
64 rnibReaderProvider func() reader.RNibReader
65 rnibWriterProvider func() rNibWriter.RNibWriter
68 func NewNodebController(logger *logger.Logger, rmrService *services.RmrService, rnibReaderProvider func() reader.RNibReader,
69 rnibWriterProvider func() rNibWriter.RNibWriter) *NodebController {
70 messageChannel = make(chan *models.E2RequestMessage)
71 errorChannel = make(chan error)
72 return &NodebController{
73 rmrService: rmrService,
75 rnibReaderProvider: rnibReaderProvider,
76 rnibWriterProvider: rnibWriterProvider,
81 func prettifyRequest(request *http.Request) string {
82 dump, _ := httputil.DumpRequest(request, true)
83 requestPrettyPrint := strings.Replace(string(dump), "\r\n", " ", -1)
84 return strings.Replace(requestPrettyPrint, "\n", "", -1)
87 func (rc NodebController) HandleRequest(writer http.ResponseWriter, request *http.Request, params httprouter.Params) {
88 startTime := time.Now()
89 rc.Logger.Infof("[Client -> E2 Manager] #nodeb_controller.HandleRequest - request: %v", prettifyRequest(request))
91 messageTypeParam := params.ByName("messageType")
92 requestHandlerProvider := providers.NewRequestHandlerProvider(rc.rnibWriterProvider)
93 handler, err := requestHandlerProvider.GetHandler(rc.Logger, messageTypeParam)
96 handleErrorResponse(rc.Logger, http.StatusNotFound, notFoundErrorCode, notFoundErrorMessage, writer, startTime)
100 requestDetails, err := parseJson(rc.Logger, request)
103 handleErrorResponse(rc.Logger, http.StatusBadRequest, parseErrorCode, parseErrorMessage, writer, startTime)
107 rc.Logger.Infof("#nodeb_controller.HandleRequest - request: %+v", requestDetails)
109 if err := validateRequestDetails(rc.Logger, requestDetails); err != nil {
110 handleErrorResponse(rc.Logger, http.StatusBadRequest, validationErrorCode, requiredInputErrorMessage, writer, startTime)
114 err = handler.PreHandle(rc.Logger, &requestDetails)
117 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, err.Error(), writer, startTime)
121 rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.HandleRequest - http status: 200")
122 writer.WriteHeader(http.StatusOK)
124 var wg sync.WaitGroup
126 go handler.CreateMessage(rc.Logger, &requestDetails, messageChannel, E2Sessions, startTime, wg)
128 go rc.rmrService.SendMessage(handler.GetMessageType(), messageChannel, errorChannel, wg)
135 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, sendMessageErrorMessage, writer, startTime)
139 printHandlingRequestElapsedTimeInMs(rc.Logger, startTime)
142 func (rc NodebController) GetNodebIdList (writer http.ResponseWriter, request *http.Request, params httprouter.Params) {
143 startTime := time.Now()
144 rnibReaderService := services.NewRnibReaderService(rc.rnibReaderProvider)
145 nodebIdList, rnibError := rnibReaderService.GetNodebIdList()
147 if rnibError != nil {
148 rc.Logger.Errorf("%v", rnibError);
149 httpStatusCode, errorCode, errorMessage := rnibErrorToHttpError(rnibError)
150 handleErrorResponse(rc.Logger,httpStatusCode,errorCode,errorMessage,writer,startTime )
154 pmList:= utils.ConvertNodebIdListToProtoMessageList(*nodebIdList)
155 result, err := utils.MarshalProtoMessageListToJsonArray(pmList)
158 rc.Logger.Errorf("%v", err);
159 handleErrorResponse(rc.Logger,http.StatusInternalServerError,internalErrorCode,internalErrorMessage,writer,startTime )
163 writer.Header().Set("Content-Type", "application/json")
164 rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.GetNodebIdList - response: %s", result)
165 writer.Write([]byte(result))
168 func (rc NodebController) GetNodeb(writer http.ResponseWriter, request *http.Request, params httprouter.Params) {
169 startTime := time.Now()
170 ranName := params.ByName("ranName")
171 // WAS: respondingNode, rnibError := reader.GetRNibReader().GetNodeb(ranName)
172 rnibReaderService := services.NewRnibReaderService(rc.rnibReaderProvider);
173 respondingNode, rnibError := rnibReaderService.GetNodeb(ranName)
174 if rnibError != nil {
175 rc.Logger.Errorf("%v", rnibError)
176 httpStatusCode, errorCode, errorMessage := rnibErrorToHttpError(rnibError)
177 handleErrorResponse(rc.Logger, httpStatusCode, errorCode, errorMessage, writer, startTime)
181 m := jsonpb.Marshaler{}
182 result, err := m.MarshalToString(respondingNode)
185 rc.Logger.Errorf("%v", err)
186 handleErrorResponse(rc.Logger, http.StatusInternalServerError, internalErrorCode, internalErrorMessage, writer, startTime)
190 writer.Header().Set("Content-Type", "application/json")
191 rc.Logger.Infof("[E2 Manager -> Client] #nodeb_controller.GetNodeb - response: %s", result)
192 writer.Write([]byte(result))
195 func (rc NodebController) HandleHealthCheckRequest(writer http.ResponseWriter, request *http.Request, params httprouter.Params) {
196 //fmt.Println("[X-APP -> Client] #HandleHealthCheckRequest - http status: 200")
197 writer.WriteHeader(http.StatusOK)
200 func parseJson(logger *logger.Logger, request *http.Request) (models.RequestDetails, error) {
201 var requestDetails models.RequestDetails
202 if err := json.NewDecoder(request.Body).Decode(&requestDetails); err != nil {
203 logger.Errorf("#nodeb_controller.parseJson - cannot deserialize incoming request. request: %v, error: %v", request, err)
204 return requestDetails, err
206 return requestDetails, nil
209 func validateRequestDetails(logger *logger.Logger, requestDetails models.RequestDetails) error {
211 if requestDetails.RanPort == 0 {
212 logger.Errorf("#nodeb_controller.validateRequestDetails - validation failure: port cannot be zero")
213 return errors.New("port: cannot be blank")
215 err := validation.ValidateStruct(&requestDetails,
216 validation.Field(&requestDetails.RanIp, validation.Required, is.IP),
217 validation.Field(&requestDetails.RanName, validation.Required),
220 logger.Errorf("#nodeb_controller.validateRequestDetails - validation failure, error: %v", err)
226 func handleErrorResponse(logger *logger.Logger, httpStatus int, errorCode int, errorMessage string, writer http.ResponseWriter, startTime time.Time) {
227 errorResponseDetails := models.ErrorResponse{errorCode, errorMessage}
228 errorResponse, _ := json.Marshal(errorResponseDetails)
229 printHandlingRequestElapsedTimeInMs(logger, startTime)
230 logger.Infof("[E2 Manager -> Client] #nodeb_controller.handleErrorResponse - http status: %d, error response: %+v", httpStatus, errorResponseDetails)
231 writer.Header().Set("Content-Type", "application/json")
232 writer.WriteHeader(httpStatus)
233 _, err := writer.Write(errorResponse)
236 logger.Errorf("#nodeb_controller.handleErrorResponse - Cannot send response. writer:%v", writer)
240 func printHandlingRequestElapsedTimeInMs(logger *logger.Logger, startTime time.Time) {
241 logger.Infof("Summary: #nodeb_controller.printElapsedTimeInMs - Elapsed time for handling request from client to E2 termination: %f ms",
242 float64(time.Since(startTime))/float64(time.Millisecond))
245 func rnibErrorToHttpError(rnibError common.IRNibError) (int, int, string) {
246 switch rnibError.GetCode() {
247 case common.RESOURCE_NOT_FOUND:
248 return http.StatusNotFound, notFoundErrorCode, notFoundErrorMessage
249 case common.INTERNAL_ERROR:
250 return http.StatusInternalServerError, internalErrorCode, internalErrorMessage
251 case common.VALIDATION_ERROR:
252 return http.StatusBadRequest, validationErrorCode, validationFailedMessage
254 return http.StatusInternalServerError, internalErrorCode, internalErrorMessage