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,
151 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
152 testContext.writerMock.On("SaveNodeb", mock.Anything).Return(tc.saveNodebMockError)
153 testContext.rmrMessengerMock.On("SendMsg", tc.statusChangeMbuf, true).Return(&rmrCgo.MBuf{}, tc.sendMsgError)
154 handler.Handle(¬ificationRequest)
156 return testContext, nodebInfo
159 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
161 resourceStatusPayload := models.NewResourceStatusPayload(nodeType, enums.RIC_TO_RAN)
162 resourceStatusJson, _ := json.Marshal(resourceStatusPayload)
163 var msgSrc unsafe.Pointer
164 return rmrCgo.NewMBuf(rmrCgo.RAN_CONNECTED, len(resourceStatusJson), RanName, &resourceStatusJson, &xAction, msgSrc)
167 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
169 _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
171 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
174 notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
175 testContext := NewSetupResponseTestContext(tc.setupResponseManager)
177 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
181 nodebInfo := &entities.NodebInfo{
182 ConnectionStatus: entities.ConnectionStatus_CONNECTING,
188 testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
189 testContext.writerMock.On("SaveNodeb", mock.Anything).Return(tc.saveNodebMockError)
190 handler.Handle(¬ificationRequest)
192 return testContext, nodebInfo
195 func TestX2SetupResponse(t *testing.T) {
197 var saveNodebMockError error
198 var sendMsgError error
199 tc := setupSuccessResponseTestCase{
200 X2SetupResponsePackedPdu,
201 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
202 rmrCgo.RIC_X2_SETUP_RESP,
205 getRanConnectedMbuf(entities.Node_ENB),
208 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
209 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
210 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
211 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
212 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
214 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
215 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
216 assert.NotNil(t, i.Enb)
217 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
220 func TestX2SetupFailureResponse(t *testing.T) {
222 var saveNodebMockError error
223 tc := setupFailureResponseTestCase{
224 X2SetupFailureResponsePackedPdu,
225 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
226 rmrCgo.RIC_X2_SETUP_FAILURE,
230 testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
231 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
232 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
233 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
234 assert.EqualValues(t, entities.Failure_X2_SETUP_FAILURE, nodebInfo.FailureType)
235 assert.NotNil(t, nodebInfo.SetupFailure)
236 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
239 func TestEndcSetupResponse(t *testing.T) {
241 var saveNodebMockError error
242 var sendMsgError error
243 tc := setupSuccessResponseTestCase{
244 EndcSetupResponsePackedPdu,
245 managers.NewEndcSetupResponseManager(converters.NewEndcSetupResponseConverter(logger)),
246 rmrCgo.RIC_ENDC_X2_SETUP_RESP,
249 getRanConnectedMbuf(entities.Node_GNB),
252 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
253 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
254 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
255 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
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, true)
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", nodebInfo)
277 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
278 assert.EqualValues(t, entities.Failure_ENDC_X2_SETUP_FAILURE, nodebInfo.FailureType)
279 assert.NotNil(t, nodebInfo.SetupFailure)
280 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
283 func TestSetupResponseInvalidPayload(t *testing.T) {
286 notificationRequest := models.NotificationRequest{RanName: ranName, Payload: []byte("123")}
287 testContext := NewSetupResponseTestContext(nil)
288 handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)), testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
290 testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING}, rnibErr)
291 handler.Handle(¬ificationRequest)
292 testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
293 testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
294 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
297 func TestSetupResponseSaveNodebFailure(t *testing.T) {
299 saveNodebMockError := common.NewInternalError(errors.New("Error"))
300 var sendMsgError error
301 tc := setupSuccessResponseTestCase{
302 X2SetupResponsePackedPdu,
303 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
304 rmrCgo.RIC_X2_SETUP_RESP,
307 getRanConnectedMbuf(entities.Node_ENB),
310 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
311 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
312 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
313 testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
316 func TestSetupResponseStatusChangeSendFailure(t *testing.T) {
318 var saveNodebMockError error
319 sendMsgError := e2managererrors.NewRmrError()
320 tc := setupSuccessResponseTestCase{
321 X2SetupResponsePackedPdu,
322 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
323 rmrCgo.RIC_X2_SETUP_RESP,
326 getRanConnectedMbuf(entities.Node_ENB),
329 testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
330 testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
331 testContext.writerMock.AssertCalled(t, "SaveNodeb", nodebInfo)
332 assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
333 assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
335 assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
336 i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
337 assert.NotNil(t, i.Enb)
338 testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)