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 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 //  platform project (RICP).
  19
  20
  21 package rmrmsghandlers
  22
  23 import (
  24         "e2mgr/configuration"
  25         "e2mgr/converters"
  26         "e2mgr/e2managererrors"
  27         "e2mgr/enums"
  28         "e2mgr/logger"
  29         "e2mgr/managers"
  30         "e2mgr/mocks"
  31         "e2mgr/models"
  32         "e2mgr/rmrCgo"
  33         "e2mgr/services"
  34         "e2mgr/services/rmrsender"
  35         "encoding/json"
  36         "fmt"
  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"
  42         "testing"
  43         "unsafe"
  44 )
  45
  46 const (
  47         RanName                           = "test"
  48         X2SetupResponsePackedPdu          = "2006002a000002001500080002f82900007a8000140017000000630002f8290007ab50102002f829000001000133"
  49         EndcSetupResponsePackedPdu        = "202400808e00000100f600808640000200fc00090002f829504a952a0a00fd007200010c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a000211e148033e4e5e4c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a00021a0044033e4e5e000000002c001e3f271f2e3d4ff0031e3f274400010000150400000a00020000"
  50         X2SetupFailureResponsePackedPdu   = "4006001a0000030005400200000016400100001140087821a00000008040"
  51         EndcSetupFailureResponsePackedPdu = "4024001a0000030005400200000016400100001140087821a00000008040"
  52 )
  53
  54 type setupSuccessResponseTestCase struct {
  55         packedPdu            string
  56         setupResponseManager managers.ISetupResponseManager
  57         msgType              int
  58         saveNodebMockError   error
  59         sendMsgError         error
  60         statusChangeMbuf     *rmrCgo.MBuf
  61 }
  62
  63 type setupFailureResponseTestCase struct {
  64         packedPdu            string
  65         setupResponseManager managers.ISetupResponseManager
  66         msgType              int
  67         saveNodebMockError   error
  68 }
  69
  70 type setupResponseTestContext struct {
  71         logger                 *logger.Logger
  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
  79 }
  80
  81 func NewSetupResponseTestContext(manager managers.ISetupResponseManager) *setupResponseTestContext {
  82         InfoLevel := int8(3)
  83         logger, _ := logger.InitLogger(InfoLevel)
  84         config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
  85         readerMock := &mocks.RnibReaderMock{}
  86         writerMock := &mocks.RnibWriterMock{}
  87
  88         rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
  89
  90         rmrMessengerMock := &mocks.RmrMessengerMock{}
  91         rmrSender := initRmrSender(rmrMessengerMock, logger)
  92
  93         ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
  94
  95         return &setupResponseTestContext{
  96                 logger:                 logger,
  97                 readerMock:             readerMock,
  98                 writerMock:             writerMock,
  99                 rnibDataService:        rnibDataService,
 100                 setupResponseManager:   manager,
 101                 ranStatusChangeManager: ranStatusChangeManager,
 102                 rmrMessengerMock:       rmrMessengerMock,
 103                 rmrSender:              rmrSender,
 104         }
 105 }
 106
 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(&notificationRequest)
 113         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 114         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 115         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 116 }
 117
 118 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
 119         ranName := "test"
 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)
 123         var rnibErr error
 124         testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
 125         handler.Handle(&notificationRequest)
 126         testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
 127         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 128         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 129 }
 130
 131 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 132         var payload []byte
 133         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 134         if err != nil {
 135                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 136         }
 137
 138         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 139         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 140
 141         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 142
 143         var rnibErr error
 144
 145         nodebInfo := &entities.NodebInfo{
 146                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 147                 RanName:            RanName,
 148                 Ip:                 "10.0.2.2",
 149                 Port:               1231,
 150         }
 151
 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(&notificationRequest)
 156
 157         return testContext, nodebInfo
 158 }
 159
 160 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
 161         var xAction []byte
 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)
 166 }
 167
 168 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 169         var payload []byte
 170         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 171         if err != nil {
 172                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 173         }
 174
 175         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 176         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 177
 178         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 179
 180         var rnibErr error
 181
 182         nodebInfo := &entities.NodebInfo{
 183                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 184                 RanName:            RanName,
 185                 Ip:                 "10.0.2.2",
 186                 Port:               1231,
 187         }
 188
 189         testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
 190         testContext.writerMock.On("SaveNodeb", mock.Anything).Return(tc.saveNodebMockError)
 191         handler.Handle(&notificationRequest)
 192
 193         return testContext, nodebInfo
 194 }
 195
 196 func TestX2SetupResponse(t *testing.T) {
 197         logger := initLog(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,
 204                 saveNodebMockError,
 205                 sendMsgError,
 206                 getRanConnectedMbuf(entities.Node_ENB),
 207         }
 208
 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)
 214
 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)
 219 }
 220
 221 func TestX2SetupFailureResponse(t *testing.T) {
 222         logger := initLog(t)
 223         var saveNodebMockError error
 224         tc := setupFailureResponseTestCase{
 225                 X2SetupFailureResponsePackedPdu,
 226                 managers.NewX2SetupFailureResponseManager(converters.NewX2SetupFailureResponseConverter(logger)),
 227                 rmrCgo.RIC_X2_SETUP_FAILURE,
 228                 saveNodebMockError,
 229         }
 230
 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")
 238 }
 239
 240 func TestEndcSetupResponse(t *testing.T) {
 241         logger := initLog(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,
 248                 saveNodebMockError,
 249                 sendMsgError,
 250                 getRanConnectedMbuf(entities.Node_GNB),
 251         }
 252
 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)
 259
 260         i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
 261         assert.NotNil(t, i.Gnb)
 262         testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
 263 }
 264
 265 func TestEndcSetupFailureResponse(t *testing.T) {
 266         logger := initLog(t)
 267         var saveNodebMockError error
 268         tc := setupFailureResponseTestCase{
 269                 EndcSetupFailureResponsePackedPdu,
 270                 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
 271                 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
 272                 saveNodebMockError,
 273         }
 274
 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")
 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}, 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", 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", nodebInfo)
 333         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
 334         assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
 335
 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)
 340 }