E2Manager/handlers/rmrmsghandlers/e2_term_init_notification_handler_test.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 package rmrmsghandlers
  18
  19 import (
  20         "e2mgr/configuration"
  21         "e2mgr/e2pdus"
  22         "e2mgr/logger"
  23         "e2mgr/managers"
  24         "e2mgr/mocks"
  25         "e2mgr/models"
  26         "e2mgr/rmrCgo"
  27         "e2mgr/services"
  28         "e2mgr/services/rmrsender"
  29         "e2mgr/tests"
  30         "fmt"
  31         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  32         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  33         "github.com/stretchr/testify/mock"
  34         "testing"
  35 )
  36
  37 func initRanLostConnectionTest(t *testing.T) (*logger.Logger, E2TermInitNotificationHandler, *mocks.RnibReaderMock, *mocks.RnibWriterMock, *mocks.RmrMessengerMock) {
  38
  39         logger := initLog(t)
  40         config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
  41
  42         rmrMessengerMock := &mocks.RmrMessengerMock{}
  43         rmrSender := initRmrSender(rmrMessengerMock, logger)
  44
  45         readerMock := &mocks.RnibReaderMock{}
  46
  47         writerMock := &mocks.RnibWriterMock{}
  48
  49         rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
  50         ranSetupManager := managers.NewRanSetupManager(logger, rmrSender, rnibDataService)
  51         ranReconnectionManager := managers.NewRanReconnectionManager(logger, configuration.ParseConfiguration(), rnibDataService, ranSetupManager)
  52         handler := NewE2TermInitNotificationHandler(logger, ranReconnectionManager, rnibDataService)
  53         return logger, handler, readerMock, writerMock, rmrMessengerMock
  54 }
  55
  56 func TestE2TerminInitHandlerSuccessOneRan(t *testing.T) {
  57         _, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
  58         var rnibErr error
  59
  60         ids := []*entities.NbIdentity{{InventoryName: "test1"}}
  61         readerMock.On("GetListNodebIds").Return(ids, rnibErr)
  62
  63         var initialNodeb = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
  64         readerMock.On("GetNodeb", ids[0].InventoryName).Return(initialNodeb, rnibErr)
  65
  66         var argNodeb = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
  67         writerMock.On("UpdateNodebInfo", argNodeb).Return(rnibErr)
  68
  69         payload := e2pdus.PackedX2setupRequest
  70         xaction := []byte(ids[0].InventoryName)
  71         msg := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[0].InventoryName, &payload, &xaction)
  72
  73         rmrMessengerMock.On("SendMsg", mock.Anything).Return(msg, nil)
  74
  75         handler.Handle(nil)
  76
  77         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 1)
  78         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 1)
  79 }
  80
  81 func TestE2TerminInitHandlerSuccessTwoRans(t *testing.T) {
  82         _, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
  83         var rnibErr error
  84
  85         ids := []*entities.NbIdentity{{InventoryName: "test1"}, {InventoryName: "test2"}}
  86         readerMock.On("GetListNodebIds").Return(ids, rnibErr)
  87
  88         var initialNodeb0 = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
  89         var initialNodeb1 = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
  90         readerMock.On("GetNodeb", ids[0].InventoryName).Return(initialNodeb0, rnibErr)
  91         readerMock.On("GetNodeb", ids[1].InventoryName).Return(initialNodeb1, rnibErr)
  92
  93         var argNodeb = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
  94         writerMock.On("UpdateNodebInfo", argNodeb).Return(rnibErr)
  95
  96         payload := e2pdus.PackedX2setupRequest
  97         xaction := []byte(ids[0].InventoryName)
  98         msg := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[0].InventoryName, &payload, &xaction)
  99
 100         rmrMessengerMock.On("SendMsg", mock.Anything).Return(msg, nil)
 101
 102         handler.Handle(nil)
 103
 104         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 2)
 105         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 2)
 106 }
 107
 108 func TestE2TerminInitHandlerSuccessThreeRansFirstRmrFailure(t *testing.T) {
 109         log, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
 110         var rnibErr error
 111
 112         ids := []*entities.NbIdentity{{InventoryName: "test1"}, {InventoryName: "test2"}, {InventoryName: "test3"}}
 113         readerMock.On("GetListNodebIds").Return(ids, rnibErr)
 114
 115         var initialNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 116         var initialNodeb1 = &entities.NodebInfo{RanName: ids[1].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 117         var initialNodeb2 = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 118         readerMock.On("GetNodeb", ids[0].InventoryName).Return(initialNodeb0, rnibErr)
 119         readerMock.On("GetNodeb", ids[1].InventoryName).Return(initialNodeb1, rnibErr)
 120         readerMock.On("GetNodeb", ids[2].InventoryName).Return(initialNodeb2, rnibErr)
 121
 122         var argNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 123         var argNodeb0Fail = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_DISCONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 0}
 124         writerMock.On("UpdateNodebInfo", argNodeb0).Return(rnibErr)
 125         writerMock.On("UpdateNodebInfo", argNodeb0Fail).Return(rnibErr)
 126
 127         payload := models.NewE2RequestMessage(ids[0].InventoryName /*tid*/, "", 0, ids[0].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 128         xaction := []byte(ids[0].InventoryName)
 129         msg0 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[0].InventoryName, &payload, &xaction)
 130
 131         // Cannot use Mock because request MBuf contains pointers
 132         //payload =models.NewE2RequestMessage(ids[1].InventoryName /*tid*/, "", 0,ids[1].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 133         //xaction = []byte(ids[1].InventoryName)
 134         //msg1 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[1].InventoryName, &payload, &xaction)
 135
 136         rmrMessengerMock.On("SendMsg", mock.Anything).Return(msg0, fmt.Errorf("RMR Error"))
 137
 138         handler.Handle(nil)
 139
 140         //test1 (before send +1, after failure +1), test2 (0) test3 (0)
 141         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 2)
 142         //test1 failure (+1), test2  (0). test3 (0)
 143         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 1)
 144 }
 145
 146 func TestE2TerminInitHandlerSuccessThreeRansSecondNotFoundFailure(t *testing.T) {
 147         log, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
 148         var rnibErr error
 149
 150         ids := []*entities.NbIdentity{{InventoryName: "test1"}, {InventoryName: "test2"}, {InventoryName: "test3"}}
 151         readerMock.On("GetListNodebIds").Return(ids, rnibErr)
 152
 153         var initialNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 154         var initialNodeb1 = &entities.NodebInfo{RanName: ids[1].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 155         var initialNodeb2 = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 156         readerMock.On("GetNodeb", ids[0].InventoryName).Return(initialNodeb0, rnibErr)
 157         readerMock.On("GetNodeb", ids[1].InventoryName).Return(initialNodeb1, common.NewResourceNotFoundError("not found"))
 158         readerMock.On("GetNodeb", ids[2].InventoryName).Return(initialNodeb2, rnibErr)
 159
 160         var argNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 161         var argNodeb0Success = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 162         writerMock.On("UpdateNodebInfo", argNodeb0).Return(rnibErr)
 163         writerMock.On("UpdateNodebInfo", argNodeb0Success).Return(rnibErr)
 164
 165         var argNodeb2 = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 166         var argNodeb2Success = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 167         writerMock.On("UpdateNodebInfo", argNodeb2).Return(rnibErr)
 168         writerMock.On("UpdateNodebInfo", argNodeb2Success).Return(rnibErr)
 169
 170         payload := models.NewE2RequestMessage(ids[0].InventoryName /*tid*/, "", 0, ids[0].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 171         xaction := []byte(ids[0].InventoryName)
 172         msg0 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[0].InventoryName, &payload, &xaction)
 173
 174         // Cannot use Mock because request MBuf contains pointers
 175         //payload =models.NewE2RequestMessage(ids[1].InventoryName /*tid*/, "", 0,ids[1].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 176         //xaction = []byte(ids[1].InventoryName)
 177         //msg1 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[1].InventoryName, &payload, &xaction)
 178
 179         rmrMessengerMock.On("SendMsg", mock.Anything).Return(msg0, nil)
 180
 181         handler.Handle(nil)
 182
 183         readerMock.AssertNumberOfCalls(t, "GetNodeb", 3)
 184         //test1 (+1), test2 failure (0) test3 (+1)
 185         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 2)
 186         //test1 success (+1), test2  (0). test3 (+1)
 187         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 2)
 188 }
 189
 190 func TestE2TerminInitHandlerSuccessThreeRansSecondRnibInternalErrorFailure(t *testing.T) {
 191         log, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
 192         var rnibErr error
 193
 194         ids := []*entities.NbIdentity{{InventoryName: "test1"}, {InventoryName: "test2"}, {InventoryName: "test3"}}
 195         readerMock.On("GetListNodebIds").Return(ids, rnibErr)
 196
 197         var initialNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 198         var initialNodeb1 = &entities.NodebInfo{RanName: ids[1].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 199         var initialNodeb2 = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST}
 200         readerMock.On("GetNodeb", ids[0].InventoryName).Return(initialNodeb0, rnibErr)
 201         readerMock.On("GetNodeb", ids[1].InventoryName).Return(initialNodeb1, common.NewInternalError(fmt.Errorf("internal error")))
 202         readerMock.On("GetNodeb", ids[2].InventoryName).Return(initialNodeb2, rnibErr)
 203
 204         var argNodeb0 = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 205         var argNodeb0Success = &entities.NodebInfo{RanName: ids[0].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 206         writerMock.On("UpdateNodebInfo", argNodeb0).Return(rnibErr)
 207         writerMock.On("UpdateNodebInfo", argNodeb0Success).Return(rnibErr)
 208
 209         var argNodeb2 = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTING, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 210         var argNodeb2Success = &entities.NodebInfo{RanName: ids[2].InventoryName, ConnectionStatus: entities.ConnectionStatus_CONNECTED, E2ApplicationProtocol: entities.E2ApplicationProtocol_X2_SETUP_REQUEST, ConnectionAttempts: 1}
 211         writerMock.On("UpdateNodebInfo", argNodeb2).Return(rnibErr)
 212         writerMock.On("UpdateNodebInfo", argNodeb2Success).Return(rnibErr)
 213
 214         payload := models.NewE2RequestMessage(ids[0].InventoryName /*tid*/, "", 0, ids[0].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 215         xaction := []byte(ids[0].InventoryName)
 216         msg0 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[0].InventoryName, &payload, &xaction)
 217
 218         // Cannot use Mock because request MBuf contains pointers
 219         //payload =models.NewE2RequestMessage(ids[1].InventoryName /*tid*/, "", 0,ids[1].InventoryName, e2pdus.PackedX2setupRequest).GetMessageAsBytes(log)
 220         //xaction = []byte(ids[1].InventoryName)
 221         //msg1 := rmrCgo.NewMBuf(rmrCgo.RIC_X2_SETUP_REQ, len(payload), ids[1].InventoryName, &payload, &xaction)
 222
 223         rmrMessengerMock.On("SendMsg", mock.Anything).Return(msg0, nil)
 224
 225         handler.Handle(nil)
 226
 227         readerMock.AssertNumberOfCalls(t, "GetNodeb", 2)
 228         //test1 (+1), test2 failure (0) test3 (0)
 229         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 1)
 230         //test1 success (+1), test2  (0). test3 (+1)
 231         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 1)
 232 }
 233
 234 func TestE2TerminInitHandlerSuccessZeroRans(t *testing.T) {
 235         _, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
 236         var rnibErr error
 237
 238         readerMock.On("GetListNodebIds").Return([]*entities.NbIdentity{}, rnibErr)
 239
 240         handler.Handle(nil)
 241
 242         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 0)
 243         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 0)
 244 }
 245
 246 func TestE2TerminInitHandlerFailureGetListNodebIds(t *testing.T) {
 247         _, handler, readerMock, writerMock, rmrMessengerMock := initRanLostConnectionTest(t)
 248
 249         readerMock.On("GetListNodebIds").Return([]*entities.NbIdentity{}, common.NewInternalError(fmt.Errorf("internal error")))
 250
 251         handler.Handle(nil)
 252
 253         writerMock.AssertNumberOfCalls(t, "UpdateNodebInfo", 0)
 254         rmrMessengerMock.AssertNumberOfCalls(t, "SendMsg", 0)
 255 }
 256
 257 // TODO: extract to test_utils
 258 func initRmrSender(rmrMessengerMock *mocks.RmrMessengerMock, log *logger.Logger) *rmrsender.RmrSender {
 259         rmrMessenger := rmrCgo.RmrMessenger(rmrMessengerMock)
 260         rmrMessengerMock.On("Init", tests.GetPort(), tests.MaxMsgSize, tests.Flags, log).Return(&rmrMessenger)
 261         return rmrsender.NewRmrSender(log, rmrMessenger)
 262 }
 263
 264 // TODO: extract to test_utils
 265 func initLog(t *testing.T) *logger.Logger {
 266         log, err := logger.InitLogger(logger.InfoLevel)
 267         if err != nil {
 268                 t.Errorf("#delete_all_request_handler_test.TestHandleSuccessFlow - failed to initialize logger, error: %s", err)
 269         }
 270         return log
 271 }