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 )
  44
  45 const (
  46         RanName                           = "test"
  47         X2SetupResponsePackedPdu          = "2006002a000002001500080002f82900007a8000140017000000630002f8290007ab50102002f829000001000133"
  48         EndcSetupResponsePackedPdu        = "202400808e00000100f600808640000200fc00090002f829504a952a0a00fd007200010c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a000211e148033e4e5e4c0005001e3f271f2e3d4ff03d44d34e4f003e4e5e4400010000150400000a00021a0044033e4e5e000000002c001e3f271f2e3d4ff0031e3f274400010000150400000a00020000"
  49         X2SetupFailureResponsePackedPdu   = "4006001a0000030005400200000016400100001140087821a00000008040"
  50         EndcSetupFailureResponsePackedPdu = "4024001a0000030005400200000016400100001140087821a00000008040"
  51 )
  52
  53 type setupSuccessResponseTestCase struct {
  54         packedPdu            string
  55         setupResponseManager managers.ISetupResponseManager
  56         msgType              int
  57         saveNodebMockError   error
  58         sendMsgError         error
  59         statusChangeMbuf     *rmrCgo.MBuf
  60 }
  61
  62 type setupFailureResponseTestCase struct {
  63         packedPdu            string
  64         setupResponseManager managers.ISetupResponseManager
  65         msgType              int
  66         saveNodebMockError   error
  67 }
  68
  69 type setupResponseTestContext struct {
  70         logger                 *logger.Logger
  71         readerMock             *mocks.RnibReaderMock
  72         writerMock             *mocks.RnibWriterMock
  73         rnibDataService        services.RNibDataService
  74         setupResponseManager   managers.ISetupResponseManager
  75         ranStatusChangeManager managers.IRanStatusChangeManager
  76         rmrSender              *rmrsender.RmrSender
  77         rmrMessengerMock       *mocks.RmrMessengerMock
  78 }
  79
  80 func NewSetupResponseTestContext(manager managers.ISetupResponseManager) *setupResponseTestContext {
  81         logger, _ := logger.InitLogger(logger.InfoLevel)
  82         config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
  83         readerMock := &mocks.RnibReaderMock{}
  84         writerMock := &mocks.RnibWriterMock{}
  85
  86         rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
  87
  88         rmrMessengerMock := &mocks.RmrMessengerMock{}
  89         rmrSender := initRmrSender(rmrMessengerMock, logger)
  90
  91         ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
  92
  93         return &setupResponseTestContext{
  94                 logger:                 logger,
  95                 readerMock:             readerMock,
  96                 writerMock:             writerMock,
  97                 rnibDataService:        rnibDataService,
  98                 setupResponseManager:   manager,
  99                 ranStatusChangeManager: ranStatusChangeManager,
 100                 rmrMessengerMock:       rmrMessengerMock,
 101                 rmrSender:              rmrSender,
 102         }
 103 }
 104
 105 func TestSetupResponseGetNodebFailure(t *testing.T) {
 106         notificationRequest := models.NotificationRequest{RanName: RanName}
 107         testContext := NewSetupResponseTestContext(nil)
 108         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
 109         testContext.readerMock.On("GetNodeb", RanName).Return(&entities.NodebInfo{}, common.NewInternalError(errors.New("Error")))
 110         handler.Handle(&notificationRequest)
 111         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 112         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 113         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 114 }
 115
 116 func TestSetupResponseInvalidConnectionStatus(t *testing.T) {
 117         ranName := "test"
 118         notificationRequest := models.NotificationRequest{RanName: ranName}
 119         testContext := NewSetupResponseTestContext(nil)
 120         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, &managers.X2SetupResponseManager{}, testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
 121         var rnibErr error
 122         testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}, rnibErr)
 123         handler.Handle(&notificationRequest)
 124         testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
 125         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 126         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 127 }
 128
 129 func executeHandleSetupSuccessResponse(t *testing.T, tc setupSuccessResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 130         var payload []byte
 131         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 132         if err != nil {
 133                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 134         }
 135
 136         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 137         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 138
 139         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 140
 141         var rnibErr error
 142
 143         nodebInfo := &entities.NodebInfo{
 144                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 145                 ConnectionAttempts: 1,
 146                 RanName:            RanName,
 147                 Ip:                 "10.0.2.2",
 148                 Port:               1231,
 149         }
 150
 151         testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
 152         testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
 153         testContext.rmrMessengerMock.On("SendMsg", tc.statusChangeMbuf, true).Return(&rmrCgo.MBuf{}, tc.sendMsgError)
 154         handler.Handle(&notificationRequest)
 155
 156         return testContext, nodebInfo
 157 }
 158
 159 func getRanConnectedMbuf(nodeType entities.Node_Type) *rmrCgo.MBuf {
 160         var xAction []byte
 161         resourceStatusPayload := models.NewResourceStatusPayload(nodeType, enums.RIC_TO_RAN)
 162         resourceStatusJson, _ := json.Marshal(resourceStatusPayload)
 163         return rmrCgo.NewMBuf(rmrCgo.RAN_CONNECTED, len(resourceStatusJson), RanName, &resourceStatusJson, &xAction)
 164 }
 165
 166 func executeHandleSetupFailureResponse(t *testing.T, tc setupFailureResponseTestCase) (*setupResponseTestContext, *entities.NodebInfo) {
 167         var payload []byte
 168         _, err := fmt.Sscanf(tc.packedPdu, "%x", &payload)
 169         if err != nil {
 170                 t.Fatalf("Failed converting packed pdu. Error: %v\n", err)
 171         }
 172
 173         notificationRequest := models.NotificationRequest{RanName: RanName, Payload: payload}
 174         testContext := NewSetupResponseTestContext(tc.setupResponseManager)
 175
 176         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, testContext.setupResponseManager, testContext.ranStatusChangeManager, tc.msgType)
 177
 178         var rnibErr error
 179
 180         nodebInfo := &entities.NodebInfo{
 181                 ConnectionStatus:   entities.ConnectionStatus_CONNECTING,
 182                 ConnectionAttempts: 1,
 183                 RanName:            RanName,
 184                 Ip:                 "10.0.2.2",
 185                 Port:               1231,
 186         }
 187
 188         testContext.readerMock.On("GetNodeb", RanName).Return(nodebInfo, rnibErr)
 189         testContext.writerMock.On("SaveNodeb", mock.Anything, mock.Anything).Return(tc.saveNodebMockError)
 190         handler.Handle(&notificationRequest)
 191
 192         return testContext, nodebInfo
 193 }
 194
 195 func TestX2SetupResponse(t *testing.T) {
 196         logger := initLog(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,
 203                 saveNodebMockError,
 204                 sendMsgError,
 205                 getRanConnectedMbuf(entities.Node_ENB),
 206         }
 207
 208         testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
 209         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 210         testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
 211         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
 212         assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
 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", mock.Anything, nodebInfo)
 234         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
 235         assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
 236         assert.EqualValues(t, entities.Failure_X2_SETUP_FAILURE, nodebInfo.FailureType)
 237         assert.NotNil(t, nodebInfo.SetupFailure)
 238         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 239 }
 240
 241 func TestEndcSetupResponse(t *testing.T) {
 242         logger := initLog(t)
 243         var saveNodebMockError error
 244         var sendMsgError error
 245         tc := setupSuccessResponseTestCase{
 246                 EndcSetupResponsePackedPdu,
 247                 managers.NewEndcSetupResponseManager(converters.NewEndcSetupResponseConverter(logger)),
 248                 rmrCgo.RIC_ENDC_X2_SETUP_RESP,
 249                 saveNodebMockError,
 250                 sendMsgError,
 251                 getRanConnectedMbuf(entities.Node_GNB),
 252         }
 253
 254         testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
 255         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 256         testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
 257         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
 258         assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
 259         assert.EqualValues(t, entities.Node_GNB, nodebInfo.NodeType)
 260         assert.IsType(t, &entities.NodebInfo_Gnb{}, nodebInfo.Configuration)
 261
 262         i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Gnb)
 263         assert.NotNil(t, i.Gnb)
 264         testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
 265 }
 266
 267 func TestEndcSetupFailureResponse(t *testing.T) {
 268         logger := initLog(t)
 269         var saveNodebMockError error
 270         tc := setupFailureResponseTestCase{
 271                 EndcSetupFailureResponsePackedPdu,
 272                 managers.NewEndcSetupFailureResponseManager(converters.NewEndcSetupFailureResponseConverter(logger)),
 273                 rmrCgo.RIC_ENDC_X2_SETUP_FAILURE,
 274                 saveNodebMockError,
 275         }
 276
 277         testContext, nodebInfo := executeHandleSetupFailureResponse(t, tc)
 278         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 279         testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
 280         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED_SETUP_FAILED, nodebInfo.ConnectionStatus)
 281         assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
 282         assert.EqualValues(t, entities.Failure_ENDC_X2_SETUP_FAILURE, nodebInfo.FailureType)
 283         assert.NotNil(t, nodebInfo.SetupFailure)
 284         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 285 }
 286
 287 func TestSetupResponseInvalidPayload(t *testing.T) {
 288         logger := initLog(t)
 289         ranName := "test"
 290         notificationRequest := models.NotificationRequest{RanName: ranName, Payload: []byte("123")}
 291         testContext := NewSetupResponseTestContext(nil)
 292         handler := NewSetupResponseNotificationHandler(testContext.logger, testContext.rnibDataService, managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)), testContext.ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)
 293         var rnibErr error
 294         testContext.readerMock.On("GetNodeb", ranName).Return(&entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTING, ConnectionAttempts: 1}, rnibErr)
 295         handler.Handle(&notificationRequest)
 296         testContext.readerMock.AssertCalled(t, "GetNodeb", ranName)
 297         testContext.writerMock.AssertNotCalled(t, "SaveNodeb")
 298         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 299 }
 300
 301 func TestSetupResponseSaveNodebFailure(t *testing.T) {
 302         logger := initLog(t)
 303         saveNodebMockError := common.NewInternalError(errors.New("Error"))
 304         var sendMsgError error
 305         tc := setupSuccessResponseTestCase{
 306                 X2SetupResponsePackedPdu,
 307                 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
 308                 rmrCgo.RIC_X2_SETUP_RESP,
 309                 saveNodebMockError,
 310                 sendMsgError,
 311                 getRanConnectedMbuf(entities.Node_ENB),
 312         }
 313
 314         testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
 315         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 316         testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
 317         testContext.rmrMessengerMock.AssertNotCalled(t, "SendMsg")
 318 }
 319
 320 func TestSetupResponseStatusChangeSendFailure(t *testing.T) {
 321         logger := initLog(t)
 322         var saveNodebMockError error
 323         sendMsgError := e2managererrors.NewRmrError()
 324         tc := setupSuccessResponseTestCase{
 325                 X2SetupResponsePackedPdu,
 326                 managers.NewX2SetupResponseManager(converters.NewX2SetupResponseConverter(logger)),
 327                 rmrCgo.RIC_X2_SETUP_RESP,
 328                 saveNodebMockError,
 329                 sendMsgError,
 330                 getRanConnectedMbuf(entities.Node_ENB),
 331         }
 332
 333         testContext, nodebInfo := executeHandleSetupSuccessResponse(t, tc)
 334         testContext.readerMock.AssertCalled(t, "GetNodeb", RanName)
 335         testContext.writerMock.AssertCalled(t, "SaveNodeb", mock.Anything, nodebInfo)
 336         assert.EqualValues(t, entities.ConnectionStatus_CONNECTED, nodebInfo.ConnectionStatus)
 337         assert.EqualValues(t, 0, nodebInfo.ConnectionAttempts)
 338         assert.EqualValues(t, entities.Node_ENB, nodebInfo.NodeType)
 339
 340         assert.IsType(t, &entities.NodebInfo_Enb{}, nodebInfo.Configuration)
 341         i, _ := nodebInfo.Configuration.(*entities.NodebInfo_Enb)
 342         assert.NotNil(t, i.Enb)
 343         testContext.rmrMessengerMock.AssertCalled(t, "SendMsg", tc.statusChangeMbuf, true)
 344 }