E2Manager/handlers/rmrmsghandlers/setup_response_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
  18 package rmrmsghandlers
  19
  20 import (
  21         "e2mgr/configuration"
  22         "e2mgr/converters"
  23         "e2mgr/e2managererrors"
  24         "e2mgr/enums"
  25         "e2mgr/logger"
  26         "e2mgr/managers"
  27         "e2mgr/mocks"
  28         "e2mgr/models"
  29         "e2mgr/rmrCgo"
  30         "e2mgr/services"
  31         "e2mgr/services/rmrsender"
  32         "encoding/json"
  33         "fmt"
  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"
  39         "testing"
  40 )
  41
  42 const (
  43         RanName                           = "test"
  44         X2SetupResponsePackedPdu          = "2006002a000002001500080002f82900007a8000140017000000630002f8290007ab50102002f829000001000133"
  45         EndcSetupResponsePackedPdu        = "202400808e00000100f600808640000200fc00090002f829504a952a0a00fd007200010c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a000211e148033e4e5e4c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a00021a0044033e4e5e000000002c001e3f271f2e3d4ff0031e3f274400010000150400000a00020000"
  46         X2SetupFailureResponsePackedPdu   = "4006001a0000030005400200000016400100001140087821a00000008040"
  47         EndcSetupFailureResponsePackedPdu = "4024001a0000030005400200000016400100001140087821a00000008040"
  48 )
  49
  50 type setupSuccessResponseTestCase struct {
  51         packedPdu            string
  52         setupResponseManager managers.ISetupResponseManager
  53         msgType              int
  54         saveNodebMockError   error
  55         sendMsgError         error
  56         statusChangeMbuf     *rmrCgo.MBuf
  57 }
  58
  59 type setupFailureResponseTestCase struct {
  60         packedPdu            string
  61         setupResponseManager managers.ISetupResponseManager
  62         msgType              int
  63         saveNodebMockError   error
  64 }
  65
  66 type setupResponseTestContext struct {
  67         logger                 *logger.Logger
  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
  75 }
  76
  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{}
  82
  83         rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
  84
  85         rmrMessengerMock := &mocks.RmrMessengerMock{}
  86         rmrSender := initRmrSender(rmrMessengerMock, logger)
  87
  88         ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
  89
  90         return &setupResponseTestContext{
  91                 logger:                 logger,
  92                 readerMock:             readerMock,
  93                 writerMock:             writerMock,
  94                 rnibDataService:        rnibDataService,
  95                 setupResponseManager:   manager,
  96                 ranStatusChangeManager: ranStatusChangeManager,
  97                 rmrMessengerMock:       rmrMessengerMock,
  98                 rmrSender:              rmrSender,
  99         }
 100 }
 101
 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(&notificationRequest)
 108         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 109         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 110         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 111 }
 112
 113 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
 114         ranName := "test"
 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)
 118         var rnibErr error
 119         testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
 120         handler.Handle(&notificationRequest)
 121         testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
 122         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 123         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 124 }
 125
 126 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 127         var payload []byte
 128         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 129         if err != nil {
 130                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 131         }
 132
 133         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 134         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 135
 136         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 137
 138         var rnibErr error
 139
 140         nodebInfo := &entities.NodebInfo{
 141                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 142                 ConnectionAttempts: 1,
 143                 RanName:            RanName,
 144                 Ip:                 "10.0.2.2",
 145                 Port:               1231,
 146         }
 147
 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, true).Return(&rmrCgo.MBuf{}, tc.sendMsgError)
 151         handler.Handle(&notificationRequest)
 152
 153         return testContext, nodebInfo
 154 }
 155
 156 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
 157         var xAction []byte
 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)
 161 }
 162
 163 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 164         var payload []byte
 165         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 166         if err != nil {
 167                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 168         }
 169
 170         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 171         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 172
 173         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 174
 175         var rnibErr error
 176
 177         nodebInfo := &entities.NodebInfo{
 178                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 179                 ConnectionAttempts: 1,
 180                 RanName:            RanName,
 181                 Ip:                 "10.0.2.2",
 182                 Port:               1231,
 183         }
 184
 185         testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
 186         testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
 187         handler.Handle(&notificationRequest)
 188
 189         return testContext, nodebInfo
 190 }
 191
 192 func TestX2SetupResponse(t *testing.T) {
 193         logger := initLog(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,
 200                 saveNodebMockError,
 201                 sendMsgError,
 202                 getRanConnectedMbuf(entities.Node_ENB),
 203         }
 204
 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)
 211
 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, true)
 216 }
 217
 218 func TestX2SetupFailureResponse(t *testing.T) {
 219         logger := initLog(t)
 220         var saveNodebMockError error
 221         tc := setupFailureResponseTestCase{
 222                 X2SetupFailureResponsePackedPdu,
 223                 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
 224                 rmrCgo.RIC_X2_SETUP_FAILURE,
 225                 saveNodebMockError,
 226         }
 227
 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")
 236 }
 237
 238 func TestEndcSetupResponse(t *testing.T) {
 239         logger := initLog(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,
 246                 saveNodebMockError,
 247                 sendMsgError,
 248                 getRanConnectedMbuf(entities.Node_GNB),
 249         }
 250
 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)
 258
 259         i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
 260         assert.NotNil(t, i.Gnb)
 261         testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
 262 }
 263
 264 func TestEndcSetupFailureResponse(t *testing.T) {
 265         logger := initLog(t)
 266         var saveNodebMockError error
 267         tc := setupFailureResponseTestCase{
 268                 EndcSetupFailureResponsePackedPdu,
 269                 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
 270                 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
 271                 saveNodebMockError,
 272         }
 273
 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")
 282 }
 283
 284 func TestSetupResponseInvalidPayload(t *testing.T) {
 285         logger := initLog(t)
 286         ranName := "test"
 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)
 290         var rnibErr error
 291         testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, ConnectionAttempts: 1}, rnibErr)
 292         handler.Handle(&notificationRequest)
 293         testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
 294         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 295         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 296 }
 297
 298 func TestSetupResponseSaveNodebFailure(t *testing.T) {
 299         logger := initLog(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,
 306                 saveNodebMockError,
 307                 sendMsgError,
 308                 getRanConnectedMbuf(entities.Node_ENB),
 309         }
 310
 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")
 315 }
 316
 317 func TestSetupResponseStatusChangeSendFailure(t *testing.T) {
 318         logger := initLog(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,
 325                 saveNodebMockError,
 326                 sendMsgError,
 327                 getRanConnectedMbuf(entities.Node_ENB),
 328         }
 329
 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)
 336
 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, true)
 341 }