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         resp, err := handler.Handle(models.HealthCheckRequest{ranNames})
  79
  80         assert.IsType(t, &models.HealthCheckSuccessResponse{}, resp)
  81         assert.Nil(t, err)
  82         readerMock.AssertExpectations(t)
  83 }
  84
  85 func TestHealthCheckRequestHandlerArguementHasNoRanNameSuccess(t *testing.T) {
  86         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
  87
  88         nbIdentityList := []*entities.NbIdentity{{InventoryName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_CONNECTED},
  89                 {InventoryName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}}
  90
  91         ranListManagerMock.On("GetNbIdentityList").Return(nbIdentityList)
  92
  93         nb1:= createNbIdentity(t,"RanName_1", entities.ConnectionStatus_CONNECTED)
  94         oldnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  95         newnbIdentity := &entities.NbIdentity{InventoryName: nb1.RanName, ConnectionStatus: nb1.ConnectionStatus}
  96
  97         readerMock.On("GetNodeb", nb1.RanName).Return(nb1, nil)
  98
  99         mbuf:= createRMRMbuf(t, nb1)
 100         rmrMessengerMock.On("SendMsg",mbuf,true).Return(mbuf,nil)
 101         ranListManagerMock.On("UpdateHealthcheckTimeStampSent",nb1.RanName).Return(oldnbIdentity, newnbIdentity)
 102         ranListManagerMock.On("UpdateNbIdentities",nb1.NodeType, []*entities.NbIdentity{oldnbIdentity}, []*entities.NbIdentity{newnbIdentity}).Return(nil)
 103
 104         nb2 := &entities.NodebInfo{RanName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}
 105         readerMock.On("GetNodeb", "RanName_2").Return(nb2, nil)
 106
 107         resp, err := handler.Handle(models.HealthCheckRequest{[]string{}})
 108
 109         assert.Nil(t, err)
 110         assert.IsType(t, &models.HealthCheckSuccessResponse{}, resp)
 111
 112 }
 113
 114 func TestHealthCheckRequestHandlerArguementHasNoRanConnectedFailure(t *testing.T) {
 115         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
 116
 117         nbIdentityList := []*entities.NbIdentity{{InventoryName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED},
 118                 {InventoryName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}}
 119         ranListManagerMock.On("GetNbIdentityList").Return(nbIdentityList)
 120
 121         nb1 := &entities.NodebInfo{RanName: "RanName_1", ConnectionStatus: entities.ConnectionStatus_DISCONNECTED}
 122         readerMock.On("GetNodeb", "RanName_1").Return(nb1, nil)
 123
 124         nb2 := &entities.NodebInfo{RanName: "RanName_2", ConnectionStatus: entities.ConnectionStatus_SHUT_DOWN}
 125         readerMock.On("GetNodeb", "RanName_2").Return(nb2, nil)
 126
 127         _, err := handler.Handle(models.HealthCheckRequest{[]string{}})
 128
 129         rmrMessengerMock.AssertNotCalled(t, "SendMsg", mock.Anything, mock.Anything)
 130         ranListManagerMock.AssertNotCalled(t,"UpdateHealthcheckTimeStampSent",mock.Anything)
 131         ranListManagerMock.AssertNotCalled(t,"UpdateNbIdentities",mock.Anything, mock.Anything, mock.Anything)
 132         assert.IsType(t, &e2managererrors.NoConnectedRanError{}, err)
 133
 134 }
 135
 136 func TestHealthCheckRequestHandlerArguementHasRanNameDBErrorFailure(t *testing.T) {
 137         handler, _, readerMock, ranListManagerMock, rmrMessengerMock := setupHealthCheckHandlerTest(t)
 138
 139         ranNames := []string{"RanName_1"}
 140         readerMock.On("GetNodeb", "RanName_1").Return(&entities.NodebInfo{}, errors.New("error"))
 141
 142         _, err := handler.Handle(models.HealthCheckRequest{ranNames})
 143
 144         rmrMessengerMock.AssertNotCalled(t, "SendMsg", mock.Anything, mock.Anything)
 145         ranListManagerMock.AssertNotCalled(t,"UpdateHealthcheckTimeStampSent",mock.Anything)
 146         ranListManagerMock.AssertNotCalled(t,"UpdateNbIdentities",mock.Anything, mock.Anything, mock.Anything)
 147         assert.IsType(t, &e2managererrors.RnibDbError{}, err)
 148         readerMock.AssertExpectations(t)
 149 }
 150
 151 func createRMRMbuf(t *testing.T, nodebInfo *entities.NodebInfo) *rmrCgo.MBuf{
 152         serviceQuery := models.NewRicServiceQueryMessage(nodebInfo.GetGnb().RanFunctions)
 153         payLoad, err := xml.Marshal(&serviceQuery.E2APPDU)
 154         payLoad = utils.NormalizeXml(payLoad)
 155         tagsToReplace := []string{"reject","ignore","protocolIEs"}
 156         payLoad = utils.ReplaceEmptyTagsWithSelfClosing(payLoad, tagsToReplace)
 157
 158         if err != nil {
 159                 t.Fatal(err)
 160         }
 161
 162         var xAction []byte
 163         var msgSrc unsafe.Pointer
 164
 165         rmrMessage := models.NewRmrMessage(rmrCgo.RIC_SERVICE_QUERY, nodebInfo.RanName, payLoad, xAction, msgSrc)
 166         return rmrCgo.NewMBuf(rmrMessage.MsgType, len(rmrMessage.Payload), rmrMessage.RanName, &rmrMessage.Payload, &rmrMessage.XAction, rmrMessage.GetMsgSrc())
 167 }
 168
 169 func createNbIdentity(t *testing.T, RanName string,  connectionStatus entities.ConnectionStatus) *entities.NodebInfo {
 170         xmlgnb := utils.ReadXmlFile(t, GnbSetupRequestXmlPath)
 171         payload := append([]byte(e2SetupMsgPrefix), xmlgnb...)
 172         pipInd := bytes.IndexByte(payload, '|')
 173         setupRequest := &models.E2SetupRequestMessage{}
 174         err := xml.Unmarshal(utils.NormalizeXml(payload[pipInd+1:]), &setupRequest.E2APPDU)
 175         if err != nil {
 176                 t.Fatal(err)
 177         }
 178
 179         nodeb := &entities.NodebInfo{
 180                 AssociatedE2TInstanceAddress: e2tInstanceFullAddress,
 181                 RanName:                      RanName,
 182                 SetupFromNetwork:             true,
 183                 NodeType:                     entities.Node_GNB,
 184                 ConnectionStatus:                         connectionStatus,
 185                 Configuration: &entities.NodebInfo_Gnb{
 186                         Gnb: &entities.Gnb{
 187                                 GnbType:      entities.GnbType_GNB,
 188                                 RanFunctions: setupRequest.ExtractRanFunctionsList(),
 189                         },
 190                 },
 191                 GlobalNbId: &entities.GlobalNbId{
 192                         PlmnId: setupRequest.GetPlmnId(),
 193                         NbId:   setupRequest.GetNbId(),
 194                 },
 195         }
 196         return nodeb
 197 }
 198
 199 func normalizeXml(payload []byte) []byte {
 200         xmlStr := string(payload)
 201         normalized := strings.NewReplacer("&lt;", "<", "&gt;", ">",
 202                 "<reject></reject>","<reject/>","<ignore></ignore>","<ignore/>",
 203                 "<protocolIEs></protocolIEs>","<protocolIEs/>").Replace(xmlStr)
 204         return []byte(normalized)
 205 }