E2Manager/providers/rmrmsghandlerprovider/notification_handler_provider_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 rmrmsghandlerprovider
  22
  23 import (
  24         "e2mgr/configuration"
  25         "e2mgr/converters"
  26         "e2mgr/handlers/rmrmsghandlers"
  27         "e2mgr/logger"
  28         "e2mgr/managers"
  29         "e2mgr/mocks"
  30         "e2mgr/rNibWriter"
  31         "e2mgr/services"
  32         "e2mgr/services/rmrsender"
  33         "e2mgr/tests"
  34         "fmt"
  35         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  36         "strings"
  37         "testing"
  38
  39         "e2mgr/rmrCgo"
  40 )
  41
  42 /*
  43  * Verify support for known providers.
  44  */
  45
  46 func initTestCase(t *testing.T) (*logger.Logger, services.RNibDataService, *managers.RanReconnectionManager, *managers.RanStatusChangeManager, *rmrsender.RmrSender, *managers.X2SetupResponseManager, *managers.X2SetupFailureResponseManager) {
  47         logger := initLog(t)
  48         config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
  49
  50         readerMock := &mocks.RnibReaderMock{}
  51         rnibReaderProvider := func() reader.RNibReader {
  52                 return readerMock
  53         }
  54         writerMock := &mocks.RnibWriterMock{}
  55         rnibWriterProvider := func() rNibWriter.RNibWriter {
  56                 return writerMock
  57         }
  58
  59         rmrSender := initRmrSender(&mocks.RmrMessengerMock{}, logger)
  60         rnibDataService := services.NewRnibDataService(logger, config, rnibReaderProvider, rnibWriterProvider)
  61         ranSetupManager := managers.NewRanSetupManager(logger, rmrSender, rnibDataService)
  62         ranReconnectionManager := managers.NewRanReconnectionManager(logger, configuration.ParseConfiguration(), rnibDataService, ranSetupManager)
  63         ranStatusChangeManager := managers.NewRanStatusChangeManager(logger, rmrSender)
  64
  65         x2SetupResponseConverter := converters.NewX2SetupResponseConverter(logger)
  66         x2SetupResponseManager := managers.NewX2SetupResponseManager(x2SetupResponseConverter)
  67
  68         x2SetupFailureResponseConverter := converters.NewX2SetupFailureResponseConverter(logger)
  69         x2SetupFailureResponseManager := managers.NewX2SetupFailureResponseManager(x2SetupFailureResponseConverter)
  70
  71
  72         return logger, rnibDataService, ranReconnectionManager, ranStatusChangeManager, rmrSender, x2SetupResponseManager, x2SetupFailureResponseManager
  73 }
  74
  75 func TestGetNotificationHandlerSuccess(t *testing.T) {
  76
  77         logger, rnibDataService, ranReconnectionManager, ranStatusChangeManager, rmrSender, x2SetupResponseManager, x2SetupFailureResponseManager := initTestCase(t)
  78
  79         var testCases = []struct {
  80                 msgType int
  81                 handler rmrmsghandlers.NotificationHandler
  82         }{
  83                 {rmrCgo.RIC_X2_SETUP_RESP, rmrmsghandlers.NewSetupResponseNotificationHandler(logger,rnibDataService, x2SetupResponseManager, ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_RESP)},
  84                 {rmrCgo.RIC_X2_SETUP_FAILURE, rmrmsghandlers.NewSetupResponseNotificationHandler(logger,rnibDataService, x2SetupFailureResponseManager, ranStatusChangeManager, rmrCgo.RIC_X2_SETUP_FAILURE)},
  85                 {rmrCgo.RIC_ENDC_X2_SETUP_RESP, rmrmsghandlers.NewSetupResponseNotificationHandler(logger,rnibDataService, managers.NewEndcSetupResponseManager(), ranStatusChangeManager, rmrCgo.RIC_ENDC_X2_SETUP_RESP)},
  86                 {rmrCgo.RIC_ENDC_X2_SETUP_FAILURE, rmrmsghandlers.NewSetupResponseNotificationHandler(logger,rnibDataService, managers.NewEndcSetupFailureResponseManager(), ranStatusChangeManager, rmrCgo.RIC_ENDC_X2_SETUP_FAILURE),},
  87                 {rmrCgo.RIC_SCTP_CONNECTION_FAILURE, rmrmsghandlers.NewRanLostConnectionHandler(logger,ranReconnectionManager)},
  88                 {rmrCgo.RIC_ENB_LOAD_INFORMATION, rmrmsghandlers.NewEnbLoadInformationNotificationHandler(logger,rnibDataService, converters.NewEnbLoadInformationExtractor(logger))},
  89                 {rmrCgo.RIC_ENB_CONF_UPDATE, rmrmsghandlers.NewX2EnbConfigurationUpdateHandler(logger, rmrSender)},
  90                 {rmrCgo.RIC_ENDC_CONF_UPDATE, rmrmsghandlers.NewEndcConfigurationUpdateHandler(logger, rmrSender)},
  91                 {rmrCgo.RIC_E2_TERM_INIT, rmrmsghandlers.NewE2TermInitNotificationHandler(logger,ranReconnectionManager, rnibDataService)},
  92                 {rmrCgo.RIC_X2_RESET_RESP, rmrmsghandlers.NewX2ResetResponseHandler(logger, rnibDataService, ranStatusChangeManager, converters.NewX2ResetResponseExtractor(logger))},
  93                 {rmrCgo.RIC_X2_RESET, rmrmsghandlers.NewX2ResetRequestNotificationHandler(logger,rnibDataService, ranStatusChangeManager, rmrSender)},
  94         }
  95
  96         for _, tc := range testCases {
  97
  98                 provider := NewNotificationHandlerProvider(logger, rnibDataService, ranReconnectionManager, ranStatusChangeManager, rmrSender, x2SetupResponseManager, x2SetupFailureResponseManager)
  99                 t.Run(fmt.Sprintf("%d", tc.msgType), func(t *testing.T) {
 100                         handler, err := provider.GetNotificationHandler(tc.msgType)
 101                         if err != nil {
 102                                 t.Errorf("want: handler for message type %d, got: error %s", tc.msgType, err)
 103                         }
 104                         //Note struct is empty, so it will match any other empty struct.
 105                         // https://golang.org/ref/spec#Comparison_operators: Struct values are comparable if all their fields are comparable. Two struct values are equal if their corresponding non-blank fields are equal.
 106                         if /*handler != tc.handler &&*/ strings.Compare(fmt.Sprintf("%T", handler), fmt.Sprintf("%T", tc.handler)) != 0 {
 107                                 t.Errorf("want: handler %T for message type %d, got: %T", tc.handler, tc.msgType, handler)
 108                         }
 109                 })
 110         }
 111 }
 112
 113 /*
 114  * Verify handling of a request for an unsupported message.
 115  */
 116
 117 func TestGetNotificationHandlerFailure(t *testing.T) {
 118
 119         var testCases = []struct {
 120                 msgType   int
 121                 errorText string
 122         }{
 123                 {9999 /*unknown*/, "notification handler not found"},
 124         }
 125         for _, tc := range testCases {
 126
 127                 logger, rnibDataService, ranReconnectionManager, ranStatusChangeManager, rmrSender, x2SetupResponseManager, x2SetupFailureResponseManager := initTestCase(t)
 128                 provider := NewNotificationHandlerProvider(logger, rnibDataService, ranReconnectionManager, ranStatusChangeManager, rmrSender, x2SetupResponseManager, x2SetupFailureResponseManager)
 129                 t.Run(fmt.Sprintf("%d", tc.msgType), func(t *testing.T) {
 130                         _, err := provider.GetNotificationHandler(tc.msgType)
 131                         if err == nil {
 132                                 t.Errorf("want: no handler for message type %d, got: success", tc.msgType)
 133                         }
 134                         if !strings.Contains(fmt.Sprintf("%s", err), tc.errorText) {
 135                                 t.Errorf("want: error [%s] for message type %d, got: %s", tc.errorText, tc.msgType, err)
 136                         }
 137                 })
 138         }
 139 }
 140
 141 // TODO: extract to test_utils
 142 func initRmrSender(rmrMessengerMock *mocks.RmrMessengerMock, log *logger.Logger) *rmrsender.RmrSender {
 143         rmrMessenger := rmrCgo.RmrMessenger(rmrMessengerMock)
 144         rmrMessengerMock.On("Init", tests.GetPort(), tests.MaxMsgSize, tests.Flags, log).Return(&rmrMessenger)
 145         return rmrsender.NewRmrSender(log, &rmrMessenger)
 146 }
 147
 148 // TODO: extract to test_utils
 149 func initLog(t *testing.T) *logger.Logger {
 150         log, err := logger.InitLogger(logger.InfoLevel)
 151         if err != nil {
 152                 t.Errorf("#delete_all_request_handler_test.TestHandleSuccessFlow - failed to initialize logger, error: %s", err)
 153         }
 154         return log
 155 }