Refactor runners and websocket tests

This commit is contained in:
Jan-Eric Hellenberg
2021-05-19 09:30:22 +02:00
parent fe2ec4df35
commit 17c9839fac
2 changed files with 108 additions and 73 deletions

View File

@ -3,12 +3,12 @@ package api
import ( import (
"bytes" "bytes"
"encoding/json" "encoding/json"
"errors"
"fmt" "fmt"
"github.com/gorilla/mux" "github.com/gorilla/mux"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/mock"
"github.com/stretchr/testify/suite" "github.com/stretchr/testify/suite"
"gitlab.hpi.de/codeocean/codemoon/poseidon/api/dto" "gitlab.hpi.de/codeocean/codemoon/poseidon/api/dto"
"gitlab.hpi.de/codeocean/codemoon/poseidon/environment"
"gitlab.hpi.de/codeocean/codemoon/poseidon/runner" "gitlab.hpi.de/codeocean/codemoon/poseidon/runner"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
@ -19,69 +19,65 @@ import (
type MiddlewareTestSuite struct { type MiddlewareTestSuite struct {
suite.Suite suite.Suite
manager *runner.ManagerMock manager *runner.ManagerMock
router *mux.Router router *mux.Router
runnerController *RunnerController runner runner.Runner
testRunner runner.Runner capturedRunner runner.Runner
runnerRequest func(string) *http.Request
} }
func (suite *MiddlewareTestSuite) SetupTest() { func (suite *MiddlewareTestSuite) SetupTest() {
suite.manager = &runner.ManagerMock{} suite.manager = &runner.ManagerMock{}
suite.router = mux.NewRouter() suite.runner = runner.NewRunner("runner")
suite.runnerController = &RunnerController{suite.manager, suite.router} suite.capturedRunner = nil
suite.testRunner = runner.NewRunner("runner") suite.runnerRequest = func(runnerId string) *http.Request {
} path, err := suite.router.Get("test-runner-id").URL(RunnerIdKey, runnerId)
if err != nil {
func TestMiddlewareTestSuite(t *testing.T) { suite.T().Fatal(err)
suite.Run(t, new(MiddlewareTestSuite)) }
} request, err := http.NewRequest(http.MethodPost, path.String(), nil)
if err != nil {
func (suite *MiddlewareTestSuite) TestFindRunnerMiddleware() { suite.T().Fatal(err)
var capturedRunner runner.Runner }
return request
testRunnerIdRoute := func(writer http.ResponseWriter, request *http.Request) { }
runnerRouteHandler := func(writer http.ResponseWriter, request *http.Request) {
var ok bool var ok bool
capturedRunner, ok = runner.FromContext(request.Context()) suite.capturedRunner, ok = runner.FromContext(request.Context())
if ok { if ok {
writer.WriteHeader(http.StatusOK) writer.WriteHeader(http.StatusOK)
} else { } else {
writer.WriteHeader(http.StatusInternalServerError) writer.WriteHeader(http.StatusInternalServerError)
} }
} }
testRunnerRequest := func(t *testing.T, runnerId string) *http.Request { suite.router = mux.NewRouter()
path, err := suite.router.Get("test-runner-id").URL(RunnerIdKey, runnerId) runnerController := &RunnerController{suite.manager, suite.router}
if err != nil { suite.router.Use(runnerController.findRunnerMiddleware)
t.Fatal(err) suite.router.HandleFunc(fmt.Sprintf("/test/{%s}", RunnerIdKey), runnerRouteHandler).Name("test-runner-id")
} }
request, err := http.NewRequest(http.MethodPost, path.String(), nil)
if err != nil {
t.Fatal(err)
}
return request
}
suite.router.Use(suite.runnerController.findRunnerMiddleware) func TestMiddlewareTestSuite(t *testing.T) {
suite.router.HandleFunc(fmt.Sprintf("/test/{%s}", RunnerIdKey), testRunnerIdRoute).Name("test-runner-id") suite.Run(t, new(MiddlewareTestSuite))
}
suite.manager.On("Get", suite.testRunner.Id()).Return(suite.testRunner, nil) func (suite *MiddlewareTestSuite) TestFindRunnerMiddlewareIfRunnerExists() {
suite.T().Run("sets runner in context if runner exists", func(t *testing.T) { suite.manager.On("Get", suite.runner.Id()).Return(suite.runner, nil)
capturedRunner = nil
recorder := httptest.NewRecorder() recorder := httptest.NewRecorder()
suite.router.ServeHTTP(recorder, testRunnerRequest(t, suite.testRunner.Id())) suite.router.ServeHTTP(recorder, suite.runnerRequest(suite.runner.Id()))
assert.Equal(t, http.StatusOK, recorder.Code) suite.Equal(http.StatusOK, recorder.Code)
assert.Equal(t, suite.testRunner, capturedRunner) suite.Equal(suite.runner, suite.capturedRunner)
}) }
func (suite *MiddlewareTestSuite) TestFindRunnerMiddlewareIfRunnerDoesNotExist() {
invalidID := "some-invalid-runner-id" invalidID := "some-invalid-runner-id"
suite.manager.On("Get", invalidID).Return(nil, runner.ErrRunnerNotFound) suite.manager.On("Get", invalidID).Return(nil, runner.ErrRunnerNotFound)
suite.T().Run("returns 404 if runner does not exist", func(t *testing.T) {
recorder := httptest.NewRecorder()
suite.router.ServeHTTP(recorder, testRunnerRequest(t, invalidID))
assert.Equal(t, http.StatusNotFound, recorder.Code) recorder := httptest.NewRecorder()
}) suite.router.ServeHTTP(recorder, suite.runnerRequest(invalidID))
suite.Equal(http.StatusNotFound, recorder.Code)
} }
func TestRunnerRouteTestSuite(t *testing.T) { func TestRunnerRouteTestSuite(t *testing.T) {
@ -90,16 +86,14 @@ func TestRunnerRouteTestSuite(t *testing.T) {
type RunnerRouteTestSuite struct { type RunnerRouteTestSuite struct {
suite.Suite suite.Suite
runnerManager *runner.ManagerMock runnerManager *runner.ManagerMock
environmentManager *environment.ManagerMock router *mux.Router
router *mux.Router runner runner.Runner
runner runner.Runner
} }
func (suite *RunnerRouteTestSuite) SetupTest() { func (suite *RunnerRouteTestSuite) SetupTest() {
suite.runnerManager = &runner.ManagerMock{} suite.runnerManager = &runner.ManagerMock{}
suite.environmentManager = &environment.ManagerMock{} suite.router = NewRouter(suite.runnerManager, nil)
suite.router = NewRouter(suite.runnerManager, suite.environmentManager)
suite.runner = runner.NewRunner("test_runner") suite.runner = runner.NewRunner("test_runner")
suite.runnerManager.On("Get", suite.runner.Id()).Return(suite.runner, nil) suite.runnerManager.On("Get", suite.runner.Id()).Return(suite.runner, nil)
} }
@ -162,27 +156,71 @@ func (suite *RunnerRouteTestSuite) TestExecuteRoute() {
}) })
} }
func (suite *RunnerRouteTestSuite) TestDeleteRoute() { func TestDeleteRunnerRouteTestSuite(t *testing.T) {
suite.Run(t, new(DeleteRunnerRouteTestSuite))
}
type DeleteRunnerRouteTestSuite struct {
RunnerRouteTestSuite
path string
}
func (suite *DeleteRunnerRouteTestSuite) SetupTest() {
suite.RunnerRouteTestSuite.SetupTest()
deleteURL, err := suite.router.Get(DeleteRoute).URL(RunnerIdKey, suite.runner.Id()) deleteURL, err := suite.router.Get(DeleteRoute).URL(RunnerIdKey, suite.runner.Id())
if err != nil { if err != nil {
suite.T().Fatal(err) suite.T().Fatal(err)
} }
deletePath := deleteURL.String() suite.path = deleteURL.String()
}
func (suite *DeleteRunnerRouteTestSuite) TestValidRequestReturnsNoContent() {
suite.runnerManager.On("Return", suite.runner).Return(nil) suite.runnerManager.On("Return", suite.runner).Return(nil)
suite.Run("valid request", func() { recorder := httptest.NewRecorder()
recorder := httptest.NewRecorder() request, err := http.NewRequest(http.MethodDelete, suite.path, nil)
request, err := http.NewRequest(http.MethodDelete, deletePath, nil) if err != nil {
if err != nil { suite.T().Fatal(err)
suite.T().Fatal(err) }
}
suite.router.ServeHTTP(recorder, request) suite.router.ServeHTTP(recorder, request)
suite.Equal(http.StatusNoContent, recorder.Code) suite.Equal(http.StatusNoContent, recorder.Code)
suite.Run("runner was returned to runner manager", func() { suite.Run("runner was returned to runner manager", func() {
suite.runnerManager.AssertCalled(suite.T(), "Return", suite.runner) suite.runnerManager.AssertCalled(suite.T(), "Return", suite.runner)
})
}) })
} }
func (suite *DeleteRunnerRouteTestSuite) TestReturnInternalServerErrorWhenApiCallToNomadFailed() {
suite.runnerManager.On("Return", suite.runner).Return(errors.New("API call failed"))
recorder := httptest.NewRecorder()
request, err := http.NewRequest(http.MethodDelete, suite.path, nil)
if err != nil {
suite.T().Fatal(err)
}
suite.router.ServeHTTP(recorder, request)
suite.Equal(http.StatusInternalServerError, recorder.Code)
}
func (suite *DeleteRunnerRouteTestSuite) TestDeleteInvalidRunnerIdReturnsNotFound() {
suite.runnerManager.On("Get", mock.AnythingOfType("string")).Return(nil, errors.New("API call failed"))
deleteURL, err := suite.router.Get(DeleteRoute).URL(RunnerIdKey, "1nv4l1dID")
if err != nil {
suite.T().Fatal(err)
}
deletePath := deleteURL.String()
recorder := httptest.NewRecorder()
request, err := http.NewRequest(http.MethodDelete, deletePath, nil)
if err != nil {
suite.T().Fatal(err)
}
suite.router.ServeHTTP(recorder, request)
suite.Equal(http.StatusNotFound, recorder.Code)
}

View File

@ -5,7 +5,6 @@ import (
"github.com/gorilla/websocket" "github.com/gorilla/websocket"
"github.com/stretchr/testify/suite" "github.com/stretchr/testify/suite"
"gitlab.hpi.de/codeocean/codemoon/poseidon/api/dto" "gitlab.hpi.de/codeocean/codemoon/poseidon/api/dto"
"gitlab.hpi.de/codeocean/codemoon/poseidon/environment"
"gitlab.hpi.de/codeocean/codemoon/poseidon/runner" "gitlab.hpi.de/codeocean/codemoon/poseidon/runner"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
@ -13,20 +12,19 @@ import (
"testing" "testing"
) )
func TestWebsocketTestSuite(t *testing.T) {
suite.Run(t, new(WebsocketTestSuite))
}
type WebsocketTestSuite struct { type WebsocketTestSuite struct {
RunnerRouteTestSuite RunnerRouteTestSuite
server *httptest.Server server *httptest.Server
executionId runner.ExecutionId executionId runner.ExecutionId
} }
func TestWebsocketTestSuite(t *testing.T) {
suite.Run(t, new(WebsocketTestSuite))
}
func (suite *WebsocketTestSuite) SetupTest() { func (suite *WebsocketTestSuite) SetupTest() {
suite.runnerManager = &runner.ManagerMock{} suite.runnerManager = &runner.ManagerMock{}
suite.environmentManager = &environment.ManagerMock{} suite.router = NewRouter(suite.runnerManager, nil)
suite.router = NewRouter(suite.runnerManager, suite.environmentManager)
suite.runner = runner.NewRunner("test_runner") suite.runner = runner.NewRunner("test_runner")
suite.runnerManager.On("Get", suite.runner.Id()).Return(suite.runner, nil) suite.runnerManager.On("Get", suite.runner.Id()).Return(suite.runner, nil)
var err error var err error
@ -37,7 +35,6 @@ func (suite *WebsocketTestSuite) SetupTest() {
}) })
suite.Require().NoError(err) suite.Require().NoError(err)
// router.HandleFunc(fmt.Sprintf("%s/{%s}%s", RouteRunners, RunnerIdKey, WebsocketPath), connectToRunner).Methods(http.MethodGet).Name(WebsocketPath)
suite.server = httptest.NewServer(suite.router) suite.server = httptest.NewServer(suite.router)
} }