dmaap-mediator-producer/internal/server/server_test.go

// -
//   ========================LICENSE_START=================================
//   O-RAN-SC
//   %%
//   Copyright (C) 2021: Nordix Foundation
//   %%
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//        http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//   ========================LICENSE_END===================================
//

package server

import (
	"bytes"
	"encoding/json"
	"errors"
	"io"
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"testing"

	"github.com/gorilla/mux"
	"github.com/stretchr/testify/mock"
	"github.com/stretchr/testify/require"
	"oransc.org/nonrtric/dmaapmediatorproducer/internal/jobs"
	"oransc.org/nonrtric/dmaapmediatorproducer/mocks/jobshandler"
)

func TestNewRouter(t *testing.T) {
	assertions := require.New(t)

	r := NewRouter(nil, nil)
	statusRoute := r.Get("health_check")
	assertions.NotNil(statusRoute)
	supportedMethods, err := statusRoute.GetMethods()
	assertions.Equal([]string{http.MethodGet}, supportedMethods)
	assertions.Nil(err)
	path, _ := statusRoute.GetPathTemplate()
	assertions.Equal("/health_check", path)

	addJobRoute := r.Get("add")
	assertions.NotNil(addJobRoute)
	supportedMethods, err = addJobRoute.GetMethods()
	assertions.Equal([]string{http.MethodPost}, supportedMethods)
	assertions.Nil(err)
	path, _ = addJobRoute.GetPathTemplate()
	assertions.Equal("/info_job", path)

	deleteJobRoute := r.Get("delete")
	assertions.NotNil(deleteJobRoute)
	supportedMethods, err = deleteJobRoute.GetMethods()
	assertions.Equal([]string{http.MethodDelete}, supportedMethods)
	assertions.Nil(err)
	path, _ = deleteJobRoute.GetPathTemplate()
	assertions.Equal("/info_job/{infoJobId}", path)

	notFoundHandler := r.NotFoundHandler
	handler := http.HandlerFunc(notFoundHandler.ServeHTTP)
	responseRecorder := httptest.NewRecorder()
	handler.ServeHTTP(responseRecorder, newRequest("GET", "/wrong", nil, t))
	assertions.Equal(http.StatusNotFound, responseRecorder.Code)
	assertions.Contains(responseRecorder.Body.String(), "404 not found.")

	methodNotAllowedHandler := r.MethodNotAllowedHandler
	handler = http.HandlerFunc(methodNotAllowedHandler.ServeHTTP)
	responseRecorder = httptest.NewRecorder()
	handler.ServeHTTP(responseRecorder, newRequest(http.MethodPut, "/status", nil, t))
	assertions.Equal(http.StatusMethodNotAllowed, responseRecorder.Code)
	assertions.Contains(responseRecorder.Body.String(), "Method is not supported.")

	setLogLevelRoute := r.Get("setLogLevel")
	assertions.NotNil(setLogLevelRoute)
	supportedMethods, err = setLogLevelRoute.GetMethods()
	assertions.Equal([]string{http.MethodPut}, supportedMethods)
	assertions.Nil(err)
	path, _ = setLogLevelRoute.GetPathTemplate()
	assertions.Equal("/admin/log", path)
}

func TestAddInfoJobToJobsHandler(t *testing.T) {
	assertions := require.New(t)

	type args struct {
		job        jobs.JobInfo
		mockReturn error
	}
	tests := []struct {
		name            string
		args            args
		wantedStatus    int
		wantedErrorInfo *ErrorInfo
	}{
		{
			name: "AddInfoJobToJobsHandler with correct job, should return OK",
			args: args{
				job: jobs.JobInfo{
					Owner:            "owner",
					LastUpdated:      "now",
					InfoJobIdentity:  "jobId",
					TargetUri:        "target",
					InfoJobData:      jobs.Parameters{},
					InfoTypeIdentity: "type",
				},
			},
			wantedStatus: http.StatusOK,
		},
		{
			name: "AddInfoJobToJobsHandler with incorrect job info, should return BadRequest",
			args: args{
				job: jobs.JobInfo{
					Owner: "bad",
				},
				mockReturn: errors.New("error"),
			},
			wantedStatus: http.StatusBadRequest,
			wantedErrorInfo: &ErrorInfo{
				Status: http.StatusBadRequest,
				Detail: "Invalid job info. Cause: error",
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			jobsHandlerMock := jobshandler.JobsHandler{}
			jobsHandlerMock.On("AddJobFromRESTCall", tt.args.job).Return(tt.args.mockReturn)

			callbackHandlerUnderTest := NewProducerCallbackHandler(&jobsHandlerMock)

			handler := http.HandlerFunc(callbackHandlerUnderTest.addInfoJobHandler)
			responseRecorder := httptest.NewRecorder()
			r := newRequest(http.MethodPost, "/jobs", &tt.args.job, t)

			handler.ServeHTTP(responseRecorder, r)

			assertions.Equal(tt.wantedStatus, responseRecorder.Code, tt.name)
			if tt.wantedErrorInfo != nil {
				var actualErrInfo ErrorInfo
				err := json.Unmarshal(getBody(responseRecorder, t), &actualErrInfo)
				if err != nil {
					t.Error("Unable to unmarshal error body", err)
					t.Fail()
				}
				assertions.Equal(*tt.wantedErrorInfo, actualErrInfo, tt.name)
				assertions.Equal("application/problem+json", responseRecorder.Result().Header.Get("Content-Type"))
			}
			jobsHandlerMock.AssertCalled(t, "AddJobFromRESTCall", tt.args.job)
		})
	}
}

func TestDeleteJob(t *testing.T) {
	assertions := require.New(t)
	jobsHandlerMock := jobshandler.JobsHandler{}
	jobsHandlerMock.On("DeleteJobFromRESTCall", mock.Anything).Return(nil)

	callbackHandlerUnderTest := NewProducerCallbackHandler(&jobsHandlerMock)

	responseRecorder := httptest.NewRecorder()
	r := mux.SetURLVars(newRequest(http.MethodDelete, "/jobs/", nil, t), map[string]string{"infoJobId": "job1"})
	handler := http.HandlerFunc(callbackHandlerUnderTest.deleteInfoJobHandler)
	handler.ServeHTTP(responseRecorder, r)
	assertions.Equal(http.StatusOK, responseRecorder.Result().StatusCode)

	assertions.Equal("", responseRecorder.Body.String())

	jobsHandlerMock.AssertCalled(t, "DeleteJobFromRESTCall", "job1")
}

func TestSetLogLevel(t *testing.T) {
	assertions := require.New(t)

	type args struct {
		logLevel string
	}
	tests := []struct {
		name            string
		args            args
		wantedStatus    int
		wantedErrorInfo *ErrorInfo
	}{
		{
			name: "Set to valid log level, should return OK",
			args: args{
				logLevel: "Debug",
			},
			wantedStatus: http.StatusOK,
		},
		{
			name: "Set to invalid log level, should return BadRequest",
			args: args{
				logLevel: "bad",
			},
			wantedStatus: http.StatusBadRequest,
			wantedErrorInfo: &ErrorInfo{
				Detail: "Invalid log level: bad. Log level will not be changed!",
				Status: http.StatusBadRequest,
			},
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			callbackHandlerUnderTest := NewProducerCallbackHandler(nil)

			handler := http.HandlerFunc(callbackHandlerUnderTest.setLogLevel)
			responseRecorder := httptest.NewRecorder()
			r, _ := http.NewRequest(http.MethodPut, "/admin/log?level="+tt.args.logLevel, nil)

			handler.ServeHTTP(responseRecorder, r)

			assertions.Equal(tt.wantedStatus, responseRecorder.Code, tt.name)
			if tt.wantedErrorInfo != nil {
				var actualErrInfo ErrorInfo
				err := json.Unmarshal(getBody(responseRecorder, t), &actualErrInfo)
				if err != nil {
					t.Error("Unable to unmarshal error body", err)
					t.Fail()
				}
				assertions.Equal(*tt.wantedErrorInfo, actualErrInfo, tt.name)
				assertions.Equal("application/problem+json", responseRecorder.Result().Header.Get("Content-Type"))
			}
		})
	}
}

func newRequest(method string, url string, jobInfo *jobs.JobInfo, t *testing.T) *http.Request {
	var body io.Reader
	if jobInfo != nil {
		bodyAsBytes, _ := json.Marshal(jobInfo)
		body = ioutil.NopCloser(bytes.NewReader(bodyAsBytes))
	}
	if req, err := http.NewRequest(method, url, body); err == nil {
		return req
	} else {
		t.Fatalf("Could not create request due to: %v", err)
		return nil
	}
}

func getBody(responseRecorder *httptest.ResponseRecorder, t *testing.T) []byte {
	buf := new(bytes.Buffer)
	if _, err := buf.ReadFrom(responseRecorder.Body); err != nil {
		t.Error("Unable to read error body", err)
		t.Fail()
	}
	return buf.Bytes()
}