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.
17 // This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 // platform project (RICP).
21 package rmrmsghandlers
26 "e2mgr/e2managererrors"
34 "e2mgr/services/rmrsender"
37 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
38 "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
39 "github.com/pkg/errors"
40 "github.com/stretchr/testify/assert"
41 "github.com/stretchr/testify/mock"
48 X2SetupResponsePackedPdu = "2006002a000002001500080002f82900007a8000140017000000630002f8290007ab50102002f829000001000133"
49 EndcSetupResponsePackedPdu = "202400808e00000100f600808640000200fc00090002f829504a952a0a00fd007200010c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a000211e148033e4e5e4c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a00021a0044033e4e5e000000002c001e3f271f2e3d4ff0031e3f274400010000150400000a00020000"
50 X2SetupFailureResponsePackedPdu = "4006001a0000030005400200000016400100001140087821a00000008040"
51 EndcSetupFailureResponsePackedPdu = "4024001a0000030005400200000016400100001140087821a00000008040"
54 type setupSuccessResponseTestCase struct {
56 setupResponseManager managers.ISetupResponseManager
58 saveNodebMockError error
60 statusChangeMbuf *rmrCgo.MBuf
63 type setupFailureResponseTestCase struct {
65 setupResponseManager managers.ISetupResponseManager
67 saveNodebMockError error
70 type setupResponseTestContext struct {
72 readerMock *mocks.RnibReaderMock
73 writerMock *mocks.RnibWriterMock
74 rnibDataService services.RNibDataService
75 setupResponseManager managers.ISetupResponseManager
76 ranStatusChangeManager managers.IRanStatusChangeManager
77 rmrSender *rmrsender.RmrSender
78 rmrMessengerMock *mocks.RmrMessengerMock
81 func NewSetupResponseTestContext(manager managers.ISetupResponseManager) *setupResponseTestContext {
83 logger, _ := logger.InitLogger(InfoLevel)
84 config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
85 readerMock := &mocks.RnibReaderMock{}
86 writerMock := &mocks.RnibWriterMock{}
88 rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
90 rmrMessengerMock := &mocks.RmrMessengerMock{}
91 rmrSender := initRmrSender(rmrMessengerMock, logger)
93 ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
95 return &setupResponseTestContext{
97 readerMock: readerMock,
98 writerMock: writerMock,
99 rnibDataService: rnibDataService,
100 setupResponseManager: manager,
101 ranStatusChangeManager: ranStatusChangeManager,
102 rmrMessengerMock: rmrMessengerMock,
103 rmrSender: rmrSender,
107 func TestSetupResponseGetNodebFailure(t *testing.T) {
108 notificationRequest := models.NotificationRequest{RanName: RanName}
109 testContext := NewSetupResponseTestContext(nil)
110 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
111 testContext.readerMock.On("GetNodeb", RanName).Return(&entities.NodebInfo{}, common.NewInternalError(errors.New("Error")))
112 handler.Handle(¬ificationRequest)
113 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
114 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
115 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
118 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
120 notificationRequest := models.NotificationRequest{RanName: ranName}
121 testContext := NewSetupResponseTestContext(nil)
122 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
124 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
125 handler.Handle(¬ificationRequest)
126 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
127 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
128 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
131 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
133 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
135 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
138 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
139 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
141 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
145 nodebInfo := &entities.NodebInfo{
146 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
152 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
153 testContext.writerMock.On("SaveNodeb", mock.Anything).Return(tc.saveNodebMockError)
154 testContext.rmrMessengerMock.On("SendMsg", tc.statusChangeMbuf, true).Return(&rmrCgo.MBuf{}, tc.sendMsgError)
155 handler.Handle(¬ificationRequest)
157 return testContext, nodebInfo
160 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
162 resourceStatusPayload := models.NewResourceStatusPayload(nodeType, enums.RIC_TO_RAN)
163 resourceStatusJson, _ := json.Marshal(resourceStatusPayload)
164 var msgSrc unsafe.Pointer
165 return rmrCgo.NewMBuf(rmrCgo.RAN_CONNECTED, len(resourceStatusJson), RanName, &resourceStatusJson, &xAction, msgSrc)
168 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
170 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
172 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
175 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
176 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
178 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
182 nodebInfo := &entities.NodebInfo{
183 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
189 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
190 testContext.writerMock.On("SaveNodeb", mock.Anything).Return(tc.saveNodebMockError)
191 handler.Handle(¬ificationRequest)
193 return testContext, nodebInfo
196 func TestX2SetupResponse(t *testing.T) {
198 var saveNodebMockError error
199 var sendMsgError error
200 tc := setupSuccessResponseTestCase{
201 X2SetupResponsePackedPdu,
202 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
203 rmrCgo.RIC_X2_SETUP_RESP,
206 getRanConnectedMbuf(entities.Node_ENB),
209 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
210 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
211 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
212 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
213 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
215 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
216 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
217 assert.NotNil(t, i.Enb)
218 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
221 func TestX2SetupFailureResponse(t *testing.T) {
223 var saveNodebMockError error
224 tc := setupFailureResponseTestCase{
225 X2SetupFailureResponsePackedPdu,
226 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
227 rmrCgo.RIC_X2_SETUP_FAILURE,
231 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
232 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
233 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
234 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
235 assert.EqualValues(t, entities.Failure_X2_SETUP_FAILURE, nodebInfo.FailureType)
236 assert.NotNil(t, nodebInfo.SetupFailure)
237 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
240 func TestEndcSetupResponse(t *testing.T) {
242 var saveNodebMockError error
243 var sendMsgError error
244 tc := setupSuccessResponseTestCase{
245 EndcSetupResponsePackedPdu,
246 managers.NewEndcSetupResponseManager(converters.NewEndcSetupResponseConverter(logger)),
247 rmrCgo.RIC_ENDC_X2_SETUP_RESP,
250 getRanConnectedMbuf(entities.Node_GNB),
253 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
254 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
255 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
256 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
257 assert.EqualValues(t, entities.Node_GNB, nodebInfo.NodeType)
258 assert.IsType(t, &entities.NodebInfo_Gnb{}, nodebInfo.Configuration)
260 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
261 assert.NotNil(t, i.Gnb)
262 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
265 func TestEndcSetupFailureResponse(t *testing.T) {
267 var saveNodebMockError error
268 tc := setupFailureResponseTestCase{
269 EndcSetupFailureResponsePackedPdu,
270 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
271 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
275 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
276 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
277 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
278 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
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}, 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", 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", nodebInfo)
333 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
334 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
336 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
337 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
338 assert.NotNil(t, i.Enb)
339 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)