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
  18 package rmrmsghandlerprovider
  19
  20 import (
  21         "e2mgr/configuration"
  22         "e2mgr/handlers/rmrmsghandlers"
  23         "e2mgr/logger"
  24         "e2mgr/managers"
  25         "e2mgr/mocks"
  26         "e2mgr/models"
  27         "e2mgr/rNibWriter"
  28         "e2mgr/services"
  29         "e2mgr/tests"
  30         "fmt"
  31         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  32         "strings"
  33         "testing"
  34
  35         "e2mgr/rmrCgo"
  36 )
  37
  38 /*
  39  * Verify support for known providers.
  40  */
  41
  42 func TestGetNotificationHandlerSuccess(t *testing.T) {
  43
  44         logger := initLog(t)
  45
  46         readerMock := &mocks.RnibReaderMock{}
  47         rnibReaderProvider := func() reader.RNibReader {
  48                 return readerMock
  49         }
  50         writerMock := &mocks.RnibWriterMock{}
  51         rnibWriterProvider := func() rNibWriter.RNibWriter {
  52                 return writerMock
  53         }
  54         ranSetupManager := managers.NewRanSetupManager(logger, getRmrService(&mocks.RmrMessengerMock{}, logger), rNibWriter.GetRNibWriter)
  55         ranReconnectionManager := managers.NewRanReconnectionManager(logger, configuration.ParseConfiguration(), rnibReaderProvider, rnibWriterProvider, ranSetupManager)
  56
  57         var testCases = []struct {
  58                 msgType int
  59                 handler rmrmsghandlers.NotificationHandler
  60         }{
  61                 {rmrCgo.RIC_X2_SETUP_RESP, rmrmsghandlers.NewSetupResponseNotificationHandler(rnibReaderProvider, rnibWriterProvider, managers.NewX2SetupResponseManager(), "X2 Setup Response")},
  62                 {rmrCgo.RIC_X2_SETUP_FAILURE, rmrmsghandlers.NewSetupResponseNotificationHandler(rnibReaderProvider, rnibWriterProvider, managers.NewX2SetupFailureResponseManager(), "X2 Setup Failure Response")},
  63                 {rmrCgo.RIC_ENDC_X2_SETUP_RESP, rmrmsghandlers.NewSetupResponseNotificationHandler(rnibReaderProvider, rnibWriterProvider, managers.NewEndcSetupResponseManager(), "ENDC Setup Response")},
  64                 {rmrCgo.RIC_ENDC_X2_SETUP_FAILURE, rmrmsghandlers.NewSetupResponseNotificationHandler(rnibReaderProvider, rnibWriterProvider, managers.NewEndcSetupFailureResponseManager(), "ENDC Setup Failure Response"),},
  65                 {rmrCgo.RIC_SCTP_CONNECTION_FAILURE, rmrmsghandlers.NewRanLostConnectionHandler(ranReconnectionManager)},
  66                 {rmrCgo.RIC_ENB_LOAD_INFORMATION, rmrmsghandlers.NewEnbLoadInformationNotificationHandler(rnibWriterProvider)},
  67                 {rmrCgo.RIC_ENB_CONF_UPDATE, rmrmsghandlers.X2EnbConfigurationUpdateHandler{}},
  68                 {rmrCgo.RIC_ENDC_CONF_UPDATE, rmrmsghandlers.EndcConfigurationUpdateHandler{}},
  69                 {rmrCgo.RIC_E2_TERM_INIT, rmrmsghandlers.NewE2TermInitNotificationHandler(ranReconnectionManager, rnibReaderProvider)},
  70         }
  71
  72         for _, tc := range testCases {
  73
  74                 provider := NewNotificationHandlerProvider(rnibReaderProvider, rnibWriterProvider, ranReconnectionManager)
  75                 t.Run(fmt.Sprintf("%d", tc.msgType), func(t *testing.T) {
  76                         handler, err := provider.GetNotificationHandler(tc.msgType)
  77                         if err != nil {
  78                                 t.Errorf("want: handler for message type %d, got: error %s", tc.msgType, err)
  79                         }
  80                         //Note struct is empty, so it will match any other empty struct.
  81                         // 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.
  82                         if /*handler != tc.handler &&*/ strings.Compare(fmt.Sprintf("%T", handler), fmt.Sprintf("%T", tc.handler)) != 0 {
  83                                 t.Errorf("want: handler %T for message type %d, got: %T", tc.handler, tc.msgType, handler)
  84                         }
  85                 })
  86         }
  87 }
  88
  89 /*
  90  * Verify handling of a request for an unsupported message.
  91  */
  92
  93 func TestGetNotificationHandlerFailure(t *testing.T) {
  94
  95         logger := initLog(t)
  96
  97         var testCases = []struct {
  98                 msgType   int
  99                 errorText string
 100         }{
 101                 {9999 /*unknown*/, "notification handler not found"},
 102         }
 103         for _, tc := range testCases {
 104                 readerMock := &mocks.RnibReaderMock{}
 105                 rnibReaderProvider := func() reader.RNibReader {
 106                         return readerMock
 107                 }
 108                 writerMock := &mocks.RnibWriterMock{}
 109                 rnibWriterProvider := func() rNibWriter.RNibWriter {
 110                         return writerMock
 111                 }
 112
 113                 ranSetupManager := managers.NewRanSetupManager(logger, getRmrService(&mocks.RmrMessengerMock{}, logger), rNibWriter.GetRNibWriter)
 114                 ranReconnectionManager := managers.NewRanReconnectionManager(logger, configuration.ParseConfiguration(), rnibReaderProvider, rnibWriterProvider, ranSetupManager)
 115
 116                 provider := NewNotificationHandlerProvider(rnibReaderProvider, rnibWriterProvider, ranReconnectionManager)
 117                 t.Run(fmt.Sprintf("%d", tc.msgType), func(t *testing.T) {
 118                         _, err := provider.GetNotificationHandler(tc.msgType)
 119                         if err == nil {
 120                                 t.Errorf("want: no handler for message type %d, got: success", tc.msgType)
 121                         }
 122                         if !strings.Contains(fmt.Sprintf("%s", err), tc.errorText) {
 123                                 t.Errorf("want: error [%s] for message type %d, got: %s", tc.errorText, tc.msgType, err)
 124                         }
 125                 })
 126         }
 127 }
 128
 129 // TODO: extract to test_utils
 130 func getRmrService(rmrMessengerMock *mocks.RmrMessengerMock, log *logger.Logger) *services.RmrService {
 131         rmrMessenger := rmrCgo.RmrMessenger(rmrMessengerMock)
 132         messageChannel := make(chan *models.NotificationResponse)
 133         rmrMessengerMock.On("Init", tests.GetPort(), tests.MaxMsgSize, tests.Flags, log).Return(&rmrMessenger)
 134         return services.NewRmrService(services.NewRmrConfig(tests.Port, tests.MaxMsgSize, tests.Flags, log), rmrMessenger, messageChannel)
 135 }
 136
 137 // TODO: extract to test_utils
 138 func initLog(t *testing.T) *logger.Logger {
 139         log, err := logger.InitLogger(logger.InfoLevel)
 140         if err != nil {
 141                 t.Errorf("#delete_all_request_handler_test.TestHandleSuccessFlow - failed to initialize logger, error: %s", err)
 142         }
 143         return log
 144 }