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 {
82 logger, _ := logger.InitLogger(logger.InfoLevel)
83 config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
84 readerMock := &mocks.RnibReaderMock{}
85 writerMock := &mocks.RnibWriterMock{}
87 rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
89 rmrMessengerMock := &mocks.RmrMessengerMock{}
90 rmrSender := initRmrSender(rmrMessengerMock, logger)
92 ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
94 return &setupResponseTestContext{
96 readerMock: readerMock,
97 writerMock: writerMock,
98 rnibDataService: rnibDataService,
99 setupResponseManager: manager,
100 ranStatusChangeManager: ranStatusChangeManager,
101 rmrMessengerMock: rmrMessengerMock,
102 rmrSender: rmrSender,
106 func TestSetupResponseGetNodebFailure(t *testing.T) {
107 notificationRequest := models.NotificationRequest{RanName: RanName}
108 testContext := NewSetupResponseTestContext(nil)
109 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
110 testContext.readerMock.On("GetNodeb", RanName).Return(&entities.NodebInfo{}, common.NewInternalError(errors.New("Error")))
111 handler.Handle(¬ificationRequest)
112 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
113 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
114 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
117 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
119 notificationRequest := models.NotificationRequest{RanName: ranName}
120 testContext := NewSetupResponseTestContext(nil)
121 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
123 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
124 handler.Handle(¬ificationRequest)
125 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
126 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
127 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
130 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
132 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
134 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
137 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
138 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
140 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
144 nodebInfo := &entities.NodebInfo{
145 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
146 ConnectionAttempts: 1,
152 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
153 testContext.writerMock.On("SaveNodeb", mock.Anything, 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,
184 ConnectionAttempts: 1,
190 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
191 testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
192 handler.Handle(¬ificationRequest)
194 return testContext, nodebInfo
197 func TestX2SetupResponse(t *testing.T) {
199 var saveNodebMockError error
200 var sendMsgError error
201 tc := setupSuccessResponseTestCase{
202 X2SetupResponsePackedPdu,
203 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
204 rmrCgo.RIC_X2_SETUP_RESP,
207 getRanConnectedMbuf(entities.Node_ENB),
210 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
211 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
212 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
213 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
214 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
215 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
217 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
218 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
219 assert.NotNil(t, i.Enb)
220 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
223 func TestX2SetupFailureResponse(t *testing.T) {
225 var saveNodebMockError error
226 tc := setupFailureResponseTestCase{
227 X2SetupFailureResponsePackedPdu,
228 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
229 rmrCgo.RIC_X2_SETUP_FAILURE,
233 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
234 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
235 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
236 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
237 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
238 assert.EqualValues(t, entities.Failure_X2_SETUP_FAILURE, nodebInfo.FailureType)
239 assert.NotNil(t, nodebInfo.SetupFailure)
240 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
243 func TestEndcSetupResponse(t *testing.T) {
245 var saveNodebMockError error
246 var sendMsgError error
247 tc := setupSuccessResponseTestCase{
248 EndcSetupResponsePackedPdu,
249 managers.NewEndcSetupResponseManager(converters.NewEndcSetupResponseConverter(logger)),
250 rmrCgo.RIC_ENDC_X2_SETUP_RESP,
253 getRanConnectedMbuf(entities.Node_GNB),
256 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
257 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
258 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
259 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
260 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
261 assert.EqualValues(t, entities.Node_GNB, nodebInfo.NodeType)
262 assert.IsType(t, &entities.NodebInfo_Gnb{}, nodebInfo.Configuration)
264 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
265 assert.NotNil(t, i.Gnb)
266 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
269 func TestEndcSetupFailureResponse(t *testing.T) {
271 var saveNodebMockError error
272 tc := setupFailureResponseTestCase{
273 EndcSetupFailureResponsePackedPdu,
274 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
275 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
279 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
280 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
281 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
282 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
283 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
284 assert.EqualValues(t, entities.Failure_ENDC_X2_SETUP_FAILURE, nodebInfo.FailureType)
285 assert.NotNil(t, nodebInfo.SetupFailure)
286 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
289 func TestSetupResponseInvalidPayload(t *testing.T) {
292 notificationRequest := models.NotificationRequest{RanName: ranName, Payload: []byte("123")}
293 testContext := NewSetupResponseTestContext(nil)
294 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)), testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
296 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, ConnectionAttempts: 1}, rnibErr)
297 handler.Handle(¬ificationRequest)
298 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
299 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
300 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
303 func TestSetupResponseSaveNodebFailure(t *testing.T) {
305 saveNodebMockError := common.NewInternalError(errors.New("Error"))
306 var sendMsgError error
307 tc := setupSuccessResponseTestCase{
308 X2SetupResponsePackedPdu,
309 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
310 rmrCgo.RIC_X2_SETUP_RESP,
313 getRanConnectedMbuf(entities.Node_ENB),
316 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
317 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
318 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
319 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
322 func TestSetupResponseStatusChangeSendFailure(t *testing.T) {
324 var saveNodebMockError error
325 sendMsgError := e2managererrors.NewRmrError()
326 tc := setupSuccessResponseTestCase{
327 X2SetupResponsePackedPdu,
328 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
329 rmrCgo.RIC_X2_SETUP_RESP,
332 getRanConnectedMbuf(entities.Node_ENB),
335 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
336 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
337 testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
338 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
339 assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
340 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
342 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
343 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
344 assert.NotNil(t, i.Enb)
345 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)