E2Manager/controllers/controller_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 controllers
  19
  20 import (
  21         "bytes"
  22         "e2mgr/configuration"
  23         "e2mgr/e2managererrors"
  24         "e2mgr/logger"
  25         "e2mgr/managers"
  26         "e2mgr/mocks"
  27         "e2mgr/models"
  28         "e2mgr/providers/httpmsghandlerprovider"
  29         "e2mgr/rNibWriter"
  30         "e2mgr/rmrCgo"
  31         "e2mgr/tests"
  32         "encoding/json"
  33         "fmt"
  34         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/common"
  35         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/entities"
  36         "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib.git/reader"
  37         "github.com/gorilla/mux"
  38         "github.com/stretchr/testify/assert"
  39         "github.com/stretchr/testify/mock"
  40         "io"
  41         "io/ioutil"
  42         "net/http"
  43         "net/http/httptest"
  44         "strings"
  45         "testing"
  46 )
  47
  48 func TestX2SetupSuccess(t *testing.T) {
  49 /*      log := initLog(t)
  50
  51         rmrMessengerMock := &mocks.RmrMessengerMock{}
  52         readerMock := &mocks.RnibReaderMock{}
  53         readerProvider := func() reader.RNibReader {
  54                 return readerMock
  55         }
  56         writerMock := &mocks.RnibWriterMock{}
  57         writerProvider := func() rNibWriter.RNibWriter {
  58                 return writerMock
  59         }
  60         config := configuration.ParseConfiguration()
  61
  62         header := http.Header{}
  63         header.Set("Content-Type", "application/json")
  64
  65         writer := httptest.NewRecorder()
  66         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
  67         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
  68
  69         httpRequest := tests.GetHttpRequest()
  70         httpRequest.Header = header
  71         controller.X2SetupHandler(writer, httpRequest)
  72
  73         assert.Equal(t, http.StatusNoContent, writer.Result().StatusCode)*/
  74 }
  75
  76 func TestShutdownHandlerRnibError(t *testing.T) {
  77         log := initLog(t)
  78         config := configuration.ParseConfiguration()
  79
  80         rmrMessengerMock := &mocks.RmrMessengerMock{}
  81         readerMock := &mocks.RnibReaderMock{}
  82         readerProvider := func() reader.RNibReader {
  83                 return readerMock
  84         }
  85         writerMock := &mocks.RnibWriterMock{}
  86         writerProvider := func() rNibWriter.RNibWriter {
  87                 return writerMock
  88         }
  89
  90         rnibErr := &common.ResourceNotFoundError{}
  91         var nbIdentityList []*entities.NbIdentity
  92         readerMock.On("GetListNodebIds").Return(nbIdentityList, rnibErr)
  93
  94         writer := httptest.NewRecorder()
  95         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
  96         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
  97         controller.ShutdownHandler(writer, tests.GetHttpRequest())
  98
  99         var errorResponse = parseJsonRequest(t, writer.Body)
 100
 101         assert.Equal(t, http.StatusInternalServerError, writer.Result().StatusCode)
 102         assert.Equal(t, errorResponse.Code, e2managererrors.NewRnibDbError().Code)
 103 }
 104
 105 func TestHeaderValidationFailed(t *testing.T) {
 106         log := initLog(t)
 107         config := configuration.ParseConfiguration()
 108
 109         rmrMessengerMock := &mocks.RmrMessengerMock{}
 110         readerMock := &mocks.RnibReaderMock{}
 111         readerProvider := func() reader.RNibReader {
 112                 return readerMock
 113         }
 114         writerMock := &mocks.RnibWriterMock{}
 115         writerProvider := func() rNibWriter.RNibWriter {
 116                 return writerMock
 117         }
 118
 119         writer := httptest.NewRecorder()
 120         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 121         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
 122
 123         header := &http.Header{}
 124
 125         controller.handleRequest(writer, header, httpmsghandlerprovider.ShutdownRequest, nil, true)
 126
 127         var errorResponse = parseJsonRequest(t, writer.Body)
 128         err := e2managererrors.NewHeaderValidationError()
 129
 130         assert.Equal(t, http.StatusUnsupportedMediaType, writer.Result().StatusCode)
 131         assert.Equal(t, errorResponse.Code, err.Code)
 132         assert.Equal(t, errorResponse.Message, err.Message)
 133 }
 134
 135 func TestShutdownStatusNoContent(t *testing.T) {
 136         log := initLog(t)
 137
 138         rmrMessengerMock := &mocks.RmrMessengerMock{}
 139         readerMock := &mocks.RnibReaderMock{}
 140         readerProvider := func() reader.RNibReader {
 141                 return readerMock
 142         }
 143         writerMock := &mocks.RnibWriterMock{}
 144         writerProvider := func() rNibWriter.RNibWriter {
 145                 return writerMock
 146         }
 147         config := configuration.ParseConfiguration()
 148
 149         var rnibError error
 150         nbIdentityList := []*entities.NbIdentity{}
 151         readerMock.On("GetListNodebIds").Return(nbIdentityList, rnibError)
 152
 153         writer := httptest.NewRecorder()
 154         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 155         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
 156         controller.ShutdownHandler(writer, tests.GetHttpRequest())
 157
 158         assert.Equal(t, http.StatusNoContent, writer.Result().StatusCode)
 159 }
 160
 161 func TestHandleInternalError(t *testing.T) {
 162         log := initLog(t)
 163         config := configuration.ParseConfiguration()
 164
 165         rmrMessengerMock := &mocks.RmrMessengerMock{}
 166         readerMock := &mocks.RnibReaderMock{}
 167         readerProvider := func() reader.RNibReader {
 168                 return readerMock
 169         }
 170         writerMock := &mocks.RnibWriterMock{}
 171         writerProvider := func() rNibWriter.RNibWriter {
 172                 return writerMock
 173         }
 174
 175         writer := httptest.NewRecorder()
 176         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 177         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
 178         err := e2managererrors.NewInternalError()
 179
 180         controller.handleErrorResponse(err, writer)
 181         var errorResponse = parseJsonRequest(t, writer.Body)
 182
 183         assert.Equal(t, http.StatusInternalServerError, writer.Result().StatusCode)
 184         assert.Equal(t, errorResponse.Code, err.Code)
 185         assert.Equal(t, errorResponse.Message, err.Message)
 186 }
 187
 188 func TestHandleCommandAlreadyInProgressError(t *testing.T) {
 189         log := initLog(t)
 190         config := configuration.ParseConfiguration()
 191
 192         rmrMessengerMock := &mocks.RmrMessengerMock{}
 193         readerMock := &mocks.RnibReaderMock{}
 194         readerProvider := func() reader.RNibReader {
 195                 return readerMock
 196         }
 197         writerMock := &mocks.RnibWriterMock{}
 198         writerProvider := func() rNibWriter.RNibWriter {
 199                 return writerMock
 200         }
 201         writer := httptest.NewRecorder()
 202         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 203         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
 204         err := e2managererrors.NewCommandAlreadyInProgressError()
 205
 206         controller.handleErrorResponse(err, writer)
 207         var errorResponse = parseJsonRequest(t, writer.Body)
 208
 209         assert.Equal(t, http.StatusMethodNotAllowed, writer.Result().StatusCode)
 210         assert.Equal(t, errorResponse.Code, err.Code)
 211         assert.Equal(t, errorResponse.Message, err.Message)
 212 }
 213
 214 func TestValidateHeaders(t *testing.T) {
 215         log := initLog(t)
 216
 217         rmrMessengerMock := &mocks.RmrMessengerMock{}
 218         readerMock := &mocks.RnibReaderMock{}
 219         readerProvider := func() reader.RNibReader {
 220                 return readerMock
 221         }
 222         writerMock := &mocks.RnibWriterMock{}
 223         writerProvider := func() rNibWriter.RNibWriter {
 224                 return writerMock
 225         }
 226         config := configuration.ParseConfiguration()
 227         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 228         controller := NewController(log, getRmrService(rmrMessengerMock, log), readerProvider, writerProvider, config, ranSetupManager)
 229
 230         header := http.Header{}
 231         header.Set("Content-Type", "application/json")
 232         result := controller.validateRequestHeader(&header)
 233
 234         assert.Nil(t, result)
 235 }
 236
 237 func parseJsonRequest(t *testing.T, r io.Reader) models.ErrorResponse {
 238
 239         var errorResponse models.ErrorResponse
 240         body, err := ioutil.ReadAll(r)
 241         if err != nil {
 242                 t.Errorf("Error cannot deserialize json request")
 243         }
 244         json.Unmarshal(body, &errorResponse)
 245
 246         return errorResponse
 247 }
 248
 249 func initLog(t *testing.T) *logger.Logger {
 250         log, err := logger.InitLogger(logger.InfoLevel)
 251         if err != nil {
 252                 t.Errorf("#delete_all_request_handler_test.TestHandleSuccessFlow - failed to initialize logger, error: %s", err)
 253         }
 254         return log
 255 }
 256
 257 func TestX2ResetHandleSuccessfulRequestedCause(t *testing.T) {
 258         log := initLog(t)
 259
 260         ranName := "test1"
 261
 262         readerMock := &mocks.RnibReaderMock{}
 263         readerProvider := func() reader.RNibReader {
 264                 return readerMock
 265         }
 266         writerMock := &mocks.RnibWriterMock{}
 267         writerProvider := func() rNibWriter.RNibWriter {
 268                 return writerMock
 269         }
 270         payload := []byte{0x00, 0x07, 0x00, 0x08, 0x00, 0x00, 0x01, 0x00, 0x05, 0x40, 0x01, 0x40}
 271         xaction := []byte(ranName)
 272         msg := rmrCgo.NewMBuf(rmrCgo.RIC_X2_RESET, len(payload), ranName, &payload, &xaction)
 273         rmrMessengerMock := &mocks.RmrMessengerMock{}
 274         rmrMessengerMock.On("SendMsg", msg, mock.Anything).Return(msg, nil)
 275
 276         config := configuration.ParseConfiguration()
 277         rmrService := getRmrService(rmrMessengerMock, log)
 278
 279         writer := httptest.NewRecorder()
 280         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 281         controller := NewController(log, rmrService, readerProvider, writerProvider, config, ranSetupManager)
 282
 283         var nodeb = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTED}
 284         readerMock.On("GetNodeb", ranName).Return(nodeb, nil)
 285
 286         data4Req := map[string]interface{}{"cause": "protocol:transfer-syntax-error"}
 287         b := new(bytes.Buffer)
 288         _ = json.NewEncoder(b).Encode(data4Req)
 289         req, _ := http.NewRequest("PUT", "https://localhost:3800/nodeb-reset", b)
 290         req = mux.SetURLVars(req, map[string]string{"ranName": ranName})
 291
 292         controller.X2ResetHandler(writer, req)
 293         assert.Equal(t, http.StatusNoContent, writer.Result().StatusCode)
 294
 295 }
 296
 297 func TestX2ResetHandleSuccessfulRequestedDefault(t *testing.T) {
 298         log := initLog(t)
 299
 300         ranName := "test1"
 301
 302         readerMock := &mocks.RnibReaderMock{}
 303         readerProvider := func() reader.RNibReader {
 304                 return readerMock
 305         }
 306         writerMock := &mocks.RnibWriterMock{}
 307         writerProvider := func() rNibWriter.RNibWriter {
 308                 return writerMock
 309         }
 310         // o&m intervention
 311         payload := []byte{0x00, 0x07, 0x00, 0x08, 0x00, 0x00, 0x01, 0x00, 0x05, 0x40, 0x01, 0x64}
 312         xaction := []byte(ranName)
 313         msg := rmrCgo.NewMBuf(rmrCgo.RIC_X2_RESET, len(payload), ranName, &payload, &xaction)
 314         rmrMessengerMock := &mocks.RmrMessengerMock{}
 315         rmrMessengerMock.On("SendMsg", msg, mock.Anything).Return(msg, nil)
 316
 317         config := configuration.ParseConfiguration()
 318         rmrService := getRmrService(rmrMessengerMock, log)
 319
 320         writer := httptest.NewRecorder()
 321         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 322         controller := NewController(log, rmrService, readerProvider, writerProvider, config, ranSetupManager)
 323
 324         var nodeb = &entities.NodebInfo{ConnectionStatus: entities.ConnectionStatus_CONNECTED}
 325         readerMock.On("GetNodeb", ranName).Return(nodeb, nil)
 326
 327         // no body
 328         b := new(bytes.Buffer)
 329         req, _ := http.NewRequest("PUT", "https://localhost:3800/nodeb-reset", b)
 330         req = mux.SetURLVars(req, map[string]string{"ranName": ranName})
 331
 332         controller.X2ResetHandler(writer, req)
 333         assert.Equal(t, http.StatusNoContent, writer.Result().StatusCode)
 334
 335 }
 336
 337 func TestX2ResetHandleFailureInvalidBody(t *testing.T) {
 338         log := initLog(t)
 339
 340         ranName := "test1"
 341
 342         readerMock := &mocks.RnibReaderMock{}
 343         readerProvider := func() reader.RNibReader {
 344                 return readerMock
 345         }
 346         writerMock := &mocks.RnibWriterMock{}
 347         writerProvider := func() rNibWriter.RNibWriter {
 348                 return writerMock
 349         }
 350         rmrMessengerMock := &mocks.RmrMessengerMock{}
 351
 352         config := configuration.ParseConfiguration()
 353         rmrService := getRmrService(rmrMessengerMock, log)
 354
 355         writer := httptest.NewRecorder()
 356         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 357         controller := NewController(log, rmrService, readerProvider, writerProvider, config, ranSetupManager)
 358
 359         // Invalid json: attribute name without quotes (should be "cause":).
 360         b := strings.NewReader("{cause:\"protocol:transfer-syntax-error\"")
 361         req, _ := http.NewRequest("PUT", "https://localhost:3800/nodeb-reset", b)
 362         req = mux.SetURLVars(req, map[string]string{"ranName": ranName})
 363
 364         controller.X2ResetHandler(writer, req)
 365         assert.Equal(t, http.StatusBadRequest, writer.Result().StatusCode)
 366 }
 367
 368 func TestHandleErrorResponse(t *testing.T) {
 369         log := initLog(t)
 370
 371         readerMock := &mocks.RnibReaderMock{}
 372         readerProvider := func() reader.RNibReader {
 373                 return readerMock
 374         }
 375         writerMock := &mocks.RnibWriterMock{}
 376         writerProvider := func() rNibWriter.RNibWriter {
 377                 return writerMock
 378         }
 379         rmrMessengerMock := &mocks.RmrMessengerMock{}
 380
 381         config := configuration.ParseConfiguration()
 382         rmrService := getRmrService(rmrMessengerMock, log)
 383         ranSetupManager := managers.NewRanSetupManager(log, getRmrService(rmrMessengerMock, log), rNibWriter.GetRNibWriter)
 384         controller := NewController(log, rmrService, readerProvider, writerProvider, config, ranSetupManager)
 385
 386         writer := httptest.NewRecorder()
 387         controller.handleErrorResponse(e2managererrors.NewRnibDbError(), writer)
 388         assert.Equal(t, http.StatusInternalServerError, writer.Result().StatusCode)
 389
 390         writer = httptest.NewRecorder()
 391         controller.handleErrorResponse(e2managererrors.NewCommandAlreadyInProgressError(), writer)
 392         assert.Equal(t, http.StatusMethodNotAllowed, writer.Result().StatusCode)
 393
 394         writer = httptest.NewRecorder()
 395         controller.handleErrorResponse(e2managererrors.NewHeaderValidationError(), writer)
 396         assert.Equal(t, http.StatusUnsupportedMediaType, writer.Result().StatusCode)
 397
 398         writer = httptest.NewRecorder()
 399         controller.handleErrorResponse(e2managererrors.NewWrongStateError("", ""), writer)
 400         assert.Equal(t, http.StatusBadRequest, writer.Result().StatusCode)
 401
 402         writer = httptest.NewRecorder()
 403         controller.handleErrorResponse(e2managererrors.NewRequestValidationError(), writer)
 404         assert.Equal(t, http.StatusBadRequest, writer.Result().StatusCode)
 405
 406         writer = httptest.NewRecorder()
 407         controller.handleErrorResponse(e2managererrors.NewRmrError(), writer)
 408         assert.Equal(t, http.StatusInternalServerError, writer.Result().StatusCode)
 409
 410         writer = httptest.NewRecorder()
 411         controller.handleErrorResponse(e2managererrors.NewResourceNotFoundError(), writer)
 412         assert.Equal(t, http.StatusNotFound, writer.Result().StatusCode)
 413
 414         writer = httptest.NewRecorder()
 415         controller.handleErrorResponse(fmt.Errorf("ErrorError"), writer)
 416         assert.Equal(t, http.StatusInternalServerError, writer.Result().StatusCode)
 417 }