E2Manager/handlers/httpmsghandlers/health_check_handler_test.go

   1 //
   2 // Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
   3 //
   4 // Licensed under the Apache License, Version 2.0 (the "License");
   5 // you may not use this file except in compliance with the License.
   6 // You may obtain a copy of the License at
   7 //
   8 //      http://www.apache.org/licenses/LICENSE-2.0
   9 //
  10 // Unless required by applicable law or agreed to in writing, software
  11 // distributed under the License is distributed on an "AS IS" BASIS,
  12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 // See the License for the specific language governing permissions and
  14 // limitations under the License.
  15
  16 //  This source code is part of the near-RT RIC (RAN Intelligent Controller)
  17 //  platform project (RICP).
  18
  19 package httpmsghandlers
  20
  21 import (
  22         "bytes"
  23         "e2mgr/configuration"
  24         "e2mgr/e2managererrors"
  25         "e2mgr/mocks"
  26         "e2mgr/models"
  27         "e2mgr/rmrCgo"
  28         "e2mgr/services"
  29         "e2mgr/utils"
  30         "encoding/xml"
  31         "errors"
  32         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  33         "github.com/stretchr/testify/assert"
  34         "github.com/stretchr/testify/mock"
  35         "strings"
  36         "testing"
  37         "unsafe"
  38 )
  39
  40 const (
  41         e2tInstanceFullAddress                   = "10.0.2.15:9999"
  42         e2SetupMsgPrefix                         = e2tInstanceFullAddress + "|"
  43         GnbSetupRequestXmlPath                   = "../../tests/resources/setupRequest/setupRequest_gnb.xml"
  44 )
  45
  46 func setupHealthCheckHandlerTest(t *testing.T) (*HealthCheckRequestHandler, services.RNibDataService, *mocks.RnibReaderMock, *mocks.RanListManagerMock, *mocks.RmrMessengerMock) {
  47         logger := initLog(t)
  48         config := &configuration.Configuration{RnibRetryIntervalMs: 10, MaxRnibConnectionAttempts: 3}
  49
  50         readerMock := &mocks.RnibReaderMock{}
  51         writerMock := &mocks.RnibWriterMock{}
  52
  53         rnibDataService := services.NewRnibDataService(logger, config, readerMock, writerMock)
  54         rmrMessengerMock := &mocks.RmrMessengerMock{}
  55         ranListManagerMock := &mocks.RanListManagerMock{}
  56
  57         rmrSender := getRmrSender(rmrMessengerMock, logger)
  58         handler := NewHealthCheckRequestHandler(logger, rnibDataService, ranListManagerMock, rmrSender)
  59
  60         return handler, rnibDataService, readerMock, ranListManagerMock, rmrMessengerMock
  61 }
  62
  63 func TestHealthCheckRequestHandlerArguementHasRanNameSuccess(t *testing.T) {
  64         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
  65         ranNames := []string{"RanName_1"}
  66
  67         nb1:= createNbIdentity(t,"RanName_1", entities.ConnectionStatus_CONNECTED)
  68         oldnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  69         newnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  70
  71         readerMock.On("GetNodeb", nb1.RanName).Return(nb1, nil)
  72
  73         mbuf:= createRMRMbuf(t, nb1)
  74         rmrMessengerMock.On("SendMsg",mbuf,true).Return(mbuf,nil)
  75         ranListManagerMock.On("UpdateHealthcheckTimeStampSent",nb1.RanName).Return(oldnbIdentity, newnbIdentity)
  76         ranListManagerMock.On("UpdateNbIdentities",nb1.NodeType, []*entities.NbIdentity{oldnbIdentity}, []*entities.NbIdentity{newnbIdentity}).Return(nil)
  77
  78         _, err := handler.Handle(models.HealthCheckRequest{ranNames})
  79
  80         assert.Nil(t, err)
  81         readerMock.AssertExpectations(t)
  82 }
  83
  84 func TestHealthCheckRequestHandlerArguementHasNoRanNameSuccess(t *testing.T) {
  85         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
  86
  87         nbIdentityList := []*entities.NbIdentity{{InventoryName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_CONNECTED},
  88                 {InventoryName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}}
  89
  90         ranListManagerMock.On("GetNbIdentityList").Return(nbIdentityList)
  91
  92         nb1:= createNbIdentity(t,"RanName_1", entities.ConnectionStatus_CONNECTED)
  93         oldnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  94         newnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  95
  96         readerMock.On("GetNodeb", nb1.RanName).Return(nb1, nil)
  97
  98         mbuf:= createRMRMbuf(t, nb1)
  99         rmrMessengerMock.On("SendMsg",mbuf,true).Return(mbuf,nil)
 100         ranListManagerMock.On("UpdateHealthcheckTimeStampSent",nb1.RanName).Return(oldnbIdentity, newnbIdentity)
 101         ranListManagerMock.On("UpdateNbIdentities",nb1.NodeType, []*entities.NbIdentity{oldnbIdentity}, []*entities.NbIdentity{newnbIdentity}).Return(nil)
 102
 103         nb2 := &entities.NodebInfo{RanName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}
 104         readerMock.On("GetNodeb", "RanName_2").Return(nb2, nil)
 105
 106         _, err := handler.Handle(models.HealthCheckRequest{[]string{}})
 107
 108         assert.Nil(t, err)
 109
 110 }
 111
 112 func TestHealthCheckRequestHandlerArguementHasNoRanConnectedFailure(t *testing.T) {
 113         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
 114
 115         nbIdentityList := []*entities.NbIdentity{{InventoryName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED},
 116                 {InventoryName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}}
 117         ranListManagerMock.On("GetNbIdentityList").Return(nbIdentityList)
 118
 119         nb1 := &entities.NodebInfo{RanName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}
 120         readerMock.On("GetNodeb", "RanName_1").Return(nb1, nil)
 121
 122         nb2 := &entities.NodebInfo{RanName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}
 123         readerMock.On("GetNodeb", "RanName_2").Return(nb2, nil)
 124
 125         _, err := handler.Handle(models.HealthCheckRequest{[]string{}})
 126
 127         rmrMessengerMock.AssertNotCalled(t, "SendMsg", mock.Anything, mock.Anything)
 128         ranListManagerMock.AssertNotCalled(t,"UpdateHealthcheckTimeStampSent",mock.Anything)
 129         ranListManagerMock.AssertNotCalled(t,"UpdateNbIdentities",mock.Anything, mock.Anything, mock.Anything)
 130         assert.IsType(t, &e2managererrors.NoConnectedRanError{}, err)
 131
 132 }
 133
 134 func TestHealthCheckRequestHandlerArguementHasRanNameDBErrorFailure(t *testing.T) {
 135         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
 136
 137         ranNames := []string{"RanName_1"}
 138         readerMock.On("GetNodeb", "RanName_1").Return(&entities.NodebInfo{}, errors.New("error"))
 139
 140         _, err := handler.Handle(models.HealthCheckRequest{ranNames})
 141
 142         rmrMessengerMock.AssertNotCalled(t, "SendMsg", mock.Anything, mock.Anything)
 143         ranListManagerMock.AssertNotCalled(t,"UpdateHealthcheckTimeStampSent",mock.Anything)
 144         ranListManagerMock.AssertNotCalled(t,"UpdateNbIdentities",mock.Anything, mock.Anything, mock.Anything)
 145         assert.IsType(t, &e2managererrors.RnibDbError{}, err)
 146         readerMock.AssertExpectations(t)
 147 }
 148
 149 func createRMRMbuf(t *testing.T, nodebInfo *entities.NodebInfo) *rmrCgo.MBuf{
 150         serviceQuery := models.NewRicServiceQueryMessage(nodebInfo.GetGnb().RanFunctions)
 151         payLoad, err := xml.Marshal(&serviceQuery.E2APPDU)
 152         payLoad = utils.NormalizeXml(payLoad)
 153         tagsToReplace := []string{"reject","ignore","protocolIEs"}
 154         payLoad = utils.ReplaceEmptyTagsWithSelfClosing(payLoad, tagsToReplace)
 155
 156         if err != nil {
 157                 t.Fatal(err)
 158         }
 159
 160         var xAction []byte
 161         var msgSrc unsafe.Pointer
 162
 163         rmrMessage := models.NewRmrMessage(rmrCgo.RIC_SERVICE_QUERY, nodebInfo.RanName, payLoad, xAction, msgSrc)
 164         return rmrCgo.NewMBuf(rmrMessage.MsgType, len(rmrMessage.Payload), rmrMessage.RanName, &rmrMessage.Payload, &rmrMessage.XAction, rmrMessage.GetMsgSrc())
 165 }
 166
 167 func createNbIdentity(t *testing.T, RanName string,  connectionStatus entities.ConnectionStatus) *entities.NodebInfo {
 168         xmlgnb := utils.ReadXmlFile(t, GnbSetupRequestXmlPath)
 169         payload := append([]byte(e2SetupMsgPrefix), xmlgnb...)
 170         pipInd := bytes.IndexByte(payload, '|')
 171         setupRequest := &models.E2SetupRequestMessage{}
 172         err := xml.Unmarshal(utils.NormalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
 173         if err != nil {
 174                 t.Fatal(err)
 175         }
 176
 177         nodeb := &entities.NodebInfo{
 178                 AssociatedE2TInstanceAddress: e2tInstanceFullAddress,
 179                 RanName:                      RanName,
 180                 SetupFromNetwork:             true,
 181                 NodeType:                     entities.Node_GNB,
 182                 ConnectionStatus:                         connectionStatus,
 183                 Configuration: &entities.NodebInfo_Gnb{
 184                         Gnb: &entities.Gnb{
 185                                 GnbType:      entities.GnbType_GNB,
 186                                 RanFunctions: setupRequest.ExtractRanFunctionsList(),
 187                         },
 188                 },
 189                 GlobalNbId: &entities.GlobalNbId{
 190                         PlmnId: setupRequest.GetPlmnId(),
 191                         NbId:   setupRequest.GetNbId(),
 192                 },
 193         }
 194         return nodeb
 195 }
 196
 197 func normalizeXml(payload []byte) []byte {
 198         xmlStr := string(payload)
 199         normalized := strings.NewReplacer("&lt;", "<", "&gt;", ">",
 200                 "<reject></reject>","<reject/>","<ignore></ignore>","<ignore/>",
 201                 "<protocolIEs></protocolIEs>","<protocolIEs/>").Replace(xmlStr)
 202         return []byte(normalized)
 203 }