[RIC-297] Update GNB Request REST API - Validation
[ric-plt/e2mgr.git] / E2Manager / handlers / httpmsghandlers / update_gnb_request_handler.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 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 //  platform project (RICP).
19
20 package httpmsghandlers
21
22 import (
23         "e2mgr/e2managererrors"
24         "e2mgr/logger"
25         "e2mgr/models"
26         "e2mgr/services"
27         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
28         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
29         "github.com/pkg/errors"
30 )
31
32 const VALIDATION_FAILURE_MESSAGE = "#UpdateGnbRequestHandler.Handle - validation failure: %s is a mandatory field"
33
34 type UpdateGnbRequestHandler struct {
35         logger          *logger.Logger
36         rNibDataService services.RNibDataService
37 }
38
39 func NewUpdateGnbRequestHandler(logger *logger.Logger, rNibDataService services.RNibDataService) *UpdateGnbRequestHandler {
40         return &UpdateGnbRequestHandler{
41                 logger:          logger,
42                 rNibDataService: rNibDataService,
43         }
44 }
45
46 func (h *UpdateGnbRequestHandler) Handle(request models.Request) (models.IResponse, error) {
47
48         updateGnbRequest := request.(models.UpdateGnbRequest)
49
50         h.logger.Infof("#UpdateGnbRequestHandler.Handle - Ran name: %s", updateGnbRequest.RanName)
51
52         err := h.validateRequestBody(updateGnbRequest)
53
54         if err != nil {
55                 return nil, err
56         }
57
58         nodebInfo, err := h.rNibDataService.GetNodeb(updateGnbRequest.RanName)
59
60         if err != nil {
61                 _, ok := err.(*common.ResourceNotFoundError)
62                 if !ok {
63                         h.logger.Errorf("#UpdateGnbRequestHandler.Handle - RAN name: %s - failed to get nodeb entity from RNIB. Error: %s", updateGnbRequest.RanName, err)
64                         return nil, e2managererrors.NewRnibDbError()
65                 }
66
67                 h.logger.Errorf("#UpdateGnbRequestHandler.Handle - RAN name: %s - RAN not found on RNIB. Error: %s", updateGnbRequest.RanName, err)
68                 return nil, e2managererrors.NewResourceNotFoundError()
69         }
70
71         //gnb := nodebInfo.GetGnb()
72         //
73         //if gnb == nil {
74         //      // TODO: log and return appropriate error
75         //      return nil, e2managererrors.NewRnibDbError()
76         //}
77         //
78         //gnb.ServedNrCells = updateGnbRequest.ServedNrCells
79         //
80         //err = h.rNibDataService.UpdateGnbCells(nodebInfo, updateGnbRequest.ServedNrCells)
81         //
82         //if err != nil {
83         //      // TODO: handle error
84         //      return nil, err
85         //}
86
87         return models.NewUpdateGnbResponse(nodebInfo), nil
88 }
89
90 func (h *UpdateGnbRequestHandler) validateRequestBody(updateGnbRequest models.UpdateGnbRequest) (error) {
91
92         if len(updateGnbRequest.ServedNrCells) == 0 {
93                 h.logger.Errorf(VALIDATION_FAILURE_MESSAGE+" and cannot be empty", "servedCells")
94                 return e2managererrors.NewRequestValidationError()
95         }
96
97         for _, servedNrCell := range updateGnbRequest.ServedNrCells {
98                 if servedNrCell.ServedNrCellInformation == nil {
99                         h.logger.Errorf(VALIDATION_FAILURE_MESSAGE+" and cannot be empty", "servedNrCellInformation")
100                         return e2managererrors.NewRequestValidationError()
101                 }
102
103                 err := isServedNrCellInformationValid(servedNrCell.ServedNrCellInformation)
104
105                 if err != nil {
106                         h.logger.Errorf(VALIDATION_FAILURE_MESSAGE, err)
107                         return e2managererrors.NewRequestValidationError()
108                 }
109
110                 if len(servedNrCell.NrNeighbourInfos) == 0 {
111                         continue
112                 }
113
114                 for _, nrNeighbourInformation := range servedNrCell.NrNeighbourInfos {
115
116                         err := isNrNeighbourInformationValid(nrNeighbourInformation)
117
118                         if err != nil {
119                                 h.logger.Errorf(VALIDATION_FAILURE_MESSAGE, err)
120                                 return e2managererrors.NewRequestValidationError()
121                         }
122
123                 }
124         }
125
126         return nil
127 }
128
129 func isServedNrCellInformationValid(servedNrCellInformation *entities.ServedNRCellInformation) error {
130         if servedNrCellInformation.CellId == "" {
131                 return errors.New("cellId");
132         }
133
134         if servedNrCellInformation.ChoiceNrMode == nil {
135                 return errors.New("choiceNrMode");
136         }
137
138         if servedNrCellInformation.NrMode == entities.Nr_UNKNOWN {
139                 return errors.New("nrMode");
140         }
141
142         if servedNrCellInformation.NrPci == 0 {
143                 return errors.New("nrPci");
144         }
145
146         if len(servedNrCellInformation.ServedPlmns) == 0 {
147                 return errors.New("servedPlmns");
148         }
149
150         return isServedNrCellInfoChoiceNrModeValid(servedNrCellInformation.ChoiceNrMode)
151 }
152
153 func isServedNrCellInfoChoiceNrModeValid(choiceNrMode *entities.ServedNRCellInformation_ChoiceNRMode) error {
154         if choiceNrMode.Fdd != nil {
155                 return isServedNrCellInfoFddValid(choiceNrMode.Fdd)
156         }
157
158         if choiceNrMode.Tdd != nil {
159                 return isServedNrCellInfoTddValid(choiceNrMode.Tdd)
160         }
161
162         return errors.New("served nr cell fdd / tdd")
163 }
164
165 func isServedNrCellInfoTddValid(tdd *entities.ServedNRCellInformation_ChoiceNRMode_TddInfo) error {
166         return nil
167 }
168
169 func isServedNrCellInfoFddValid(fdd *entities.ServedNRCellInformation_ChoiceNRMode_FddInfo) error {
170         return nil
171 }
172
173 func isNrNeighbourInformationValid(nrNeighbourInformation *entities.NrNeighbourInformation) error {
174         if nrNeighbourInformation.NrCgi == "" {
175                 return errors.New("nrCgi")
176         }
177
178         if nrNeighbourInformation.ChoiceNrMode == nil {
179                 return errors.New("choiceNrMode")
180         }
181
182         if nrNeighbourInformation.NrMode == entities.Nr_UNKNOWN {
183                 return errors.New("nrMode")
184         }
185
186         if nrNeighbourInformation.NrPci == 0 {
187                 return errors.New("nrPci")
188         }
189
190         return isNrNeighbourInfoChoiceNrModeValid(nrNeighbourInformation.ChoiceNrMode)
191 }
192
193 func isNrNeighbourInfoChoiceNrModeValid(choiceNrMode *entities.NrNeighbourInformation_ChoiceNRMode) error {
194         if choiceNrMode.Fdd != nil {
195                 return isNrNeighbourInfoFddValid(choiceNrMode.Fdd)
196         }
197
198         if choiceNrMode.Tdd != nil {
199                 return isNrNeighbourInfoTddValid(choiceNrMode.Tdd)
200         }
201
202         return errors.New("nr neighbour fdd / tdd")
203 }
204
205 func isNrNeighbourInfoTddValid(tdd *entities.NrNeighbourInformation_ChoiceNRMode_TddInfo) error {
206         return nil
207 }
208
209 func isNrNeighbourInfoFddValid(fdd *entities.NrNeighbourInformation_ChoiceNRMode_FddInfo) error {
210         return nil
211 }