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