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.
18 package rmrmsghandlers
23 "e2mgr/e2managererrors"
31 "e2mgr/services/rmrsender"
34 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
35 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
36 "github.com/pkg/errors"
37 "github.com/stretchr/testify/assert"
38 "github.com/stretchr/testify/mock"
44 X2SetupResponsePackedPdu = "2006002a000002001500080002f82900007a8000140017000000630002f8290007ab50102002f829000001000133"
45 EndcSetupResponsePackedPdu = "202400808e00000100f600808640000200fc00090002f829504a952a0a00fd007200010c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a000211e148033e4e5e4c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a00021a0044033e4e5e000000002c001e3f271f2e3d4ff0031e3f274400010000150400000a00020000"
46 X2SetupFailureResponsePackedPdu = "4006001a0000030005400200000016400100001140087821a00000008040"
47 EndcSetupFailureResponsePackedPdu = "4024001a0000030005400200000016400100001140087821a00000008040"
50 type setupSuccessResponseTestCase struct {
52 setupResponseManager managers.ISetupResponseManager
54 saveNodebMockError error
56 statusChangeMbuf *rmrCgo.MBuf
59 type setupFailureResponseTestCase struct {
61 setupResponseManager managers.ISetupResponseManager
63 saveNodebMockError error
66 type setupResponseTestContext struct {
68 readerMock *mocks.RnibReaderMock
69 writerMock *mocks.RnibWriterMock
70 rnibDataService services.RNibDataService
71 setupResponseManager managers.ISetupResponseManager
72 ranStatusChangeManager managers.IRanStatusChangeManager
73 rmrSender *rmrsender.RmrSender
74 rmrMessengerMock *mocks.RmrMessengerMock
77 func NewSetupResponseTestContext(manager managers.ISetupResponseManager) *setupResponseTestContext {
78 logger, _ := logger.InitLogger(logger.InfoLevel)
79 config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
80 readerMock := &mocks.RnibReaderMock{}
81 writerMock := &mocks.RnibWriterMock{}
83 rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
85 rmrMessengerMock := &mocks.RmrMessengerMock{}
86 rmrSender := initRmrSender(rmrMessengerMock, logger)
88 ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
90 return &setupResponseTestContext{
92 readerMock: readerMock,
93 writerMock: writerMock,
94 rnibDataService: rnibDataService,
95 setupResponseManager: manager,
96 ranStatusChangeManager: ranStatusChangeManager,
97 rmrMessengerMock: rmrMessengerMock,
102 func TestSetupResponseGetNodebFailure(t *testing.T) {
103 notificationRequest := models.NotificationRequest{RanName: RanName}
104 testContext := NewSetupResponseTestContext(nil)
105 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
106 testContext.readerMock.On("GetNodeb", RanName).Return(&entities.NodebInfo{}, common.NewInternalError(errors.New("Error")))
107 handler.Handle(¬ificationRequest)
108 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
109 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
110 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
113 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
115 notificationRequest := models.NotificationRequest{RanName: ranName}
116 testContext := NewSetupResponseTestContext(nil)
117 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
119 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
120 handler.Handle(¬ificationRequest)
121 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
122 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
123 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
126 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
128 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
130 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
133 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
134 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
136 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
140 nodebInfo := &entities.NodebInfo{
141 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
142 ConnectionAttempts: 1,
148 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
149 testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
150 testContext.rmrMessengerMock.On("SendMsg", tc.statusChangeMbuf).Return(&rmrCgo.MBuf{}, tc.sendMsgError)
151 handler.Handle(¬ificationRequest)
153 return testContext, nodebInfo
156 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
158 resourceStatusPayload := models.NewResourceStatusPayload(nodeType, enums.RIC_TO_RAN)
159 resourceStatusJson, _ := json.Marshal(resourceStatusPayload)
160 return rmrCgo.NewMBuf(rmrCgo.RAN_CONNECTED, len(resourceStatusJson), RanName, &resourceStatusJson, &xAction)
163 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
165 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
167 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
170 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
171 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
173 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
177 nodebInfo := &entities.NodebInfo{
178 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
179 ConnectionAttempts: 1,
185 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
186 testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
187 handler.Handle(¬ificationRequest)
189 return testContext, nodebInfo
192 func TestX2SetupResponse(t *testing.T) {
194 var saveNodebMockError error
195 var sendMsgError error
196 tc := setupSuccessResponseTestCase{
197 X2SetupResponsePackedPdu,
198 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
199 rmrCgo.RIC_X2_SETUP_RESP,
202 getRanConnectedMbuf(entities.Node_ENB),
205 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
206 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
207 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
208 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
209 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
210 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
212 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
213 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
214 assert.NotNil(t, i.Enb)
215 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf)
218 func TestX2SetupFailureResponse(t *testing.T) {
220 var saveNodebMockError error
221 tc := setupFailureResponseTestCase{
222 X2SetupFailureResponsePackedPdu,
223 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
224 rmrCgo.RIC_X2_SETUP_FAILURE,
228 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
229 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
230 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
231 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
232 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
233 assert.EqualValues(t, entities.Failure_X2_SETUP_FAILURE, nodebInfo.FailureType)
234 assert.NotNil(t, nodebInfo.SetupFailure)
235 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
238 func TestEndcSetupResponse(t *testing.T) {
240 var saveNodebMockError error
241 var sendMsgError error
242 tc := setupSuccessResponseTestCase{
243 EndcSetupResponsePackedPdu,
244 managers.NewEndcSetupResponseManager(converters.NewEndcSetupResponseConverter(logger)),
245 rmrCgo.RIC_ENDC_X2_SETUP_RESP,
248 getRanConnectedMbuf(entities.Node_GNB),
251 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
252 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
253 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
254 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
255 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
256 assert.EqualValues(t, entities.Node_GNB, nodebInfo.NodeType)
257 assert.IsType(t, &entities.NodebInfo_Gnb{}, nodebInfo.Configuration)
259 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
260 assert.NotNil(t, i.Gnb)
261 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf)
264 func TestEndcSetupFailureResponse(t *testing.T) {
266 var saveNodebMockError error
267 tc := setupFailureResponseTestCase{
268 EndcSetupFailureResponsePackedPdu,
269 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
270 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
274 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
275 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
276 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
277 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
278 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
279 assert.EqualValues(t, entities.Failure_ENDC_X2_SETUP_FAILURE, nodebInfo.FailureType)
280 assert.NotNil(t, nodebInfo.SetupFailure)
281 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
284 func TestSetupResponseInvalidPayload(t *testing.T) {
287 notificationRequest := models.NotificationRequest{RanName: ranName, Payload: []byte("123")}
288 testContext := NewSetupResponseTestContext(nil)
289 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)), testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
291 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, ConnectionAttempts: 1}, rnibErr)
292 handler.Handle(¬ificationRequest)
293 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
294 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
295 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
298 func TestSetupResponseSaveNodebFailure(t *testing.T) {
300 saveNodebMockError := common.NewInternalError(errors.New("Error"))
301 var sendMsgError error
302 tc := setupSuccessResponseTestCase{
303 X2SetupResponsePackedPdu,
304 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
305 rmrCgo.RIC_X2_SETUP_RESP,
308 getRanConnectedMbuf(entities.Node_ENB),
311 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
312 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
313 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
314 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
317 func TestSetupResponseStatusChangeSendFailure(t *testing.T) {
319 var saveNodebMockError error
320 sendMsgError := e2managererrors.NewRmrError()
321 tc := setupSuccessResponseTestCase{
322 X2SetupResponsePackedPdu,
323 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
324 rmrCgo.RIC_X2_SETUP_RESP,
327 getRanConnectedMbuf(entities.Node_ENB),
330 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
331 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
332 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
333 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
334 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
335 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
337 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
338 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
339 assert.NotNil(t, i.Enb)
340 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf)