Add route to create or update execution environments

2021-05-25 12:43:12 +02:00
parent 3d395f0a38
commit b990df7b9d
11 changed files with 483 additions and 127 deletions
--- a/environment/manager_test.go
+++ b/environment/manager_test.go
@@ -0,0 +1,136 @@
+package environment
+
+import (
+	nomadApi "github.com/hashicorp/nomad/api"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+	"gitlab.hpi.de/codeocean/codemoon/poseidon/api/dto"
+	"gitlab.hpi.de/codeocean/codemoon/poseidon/nomad"
+	"gitlab.hpi.de/codeocean/codemoon/poseidon/runner"
+	"gitlab.hpi.de/codeocean/codemoon/poseidon/tests"
+	"math"
+	"strconv"
+	"testing"
+)
+
+type CreateOrUpdateTestSuite struct {
+	suite.Suite
+	runnerManagerMock        runner.ManagerMock
+	apiMock                  nomad.ExecutorApiMock
+	registerNomadJobMockCall *mock.Call
+	request                  dto.ExecutionEnvironmentRequest
+	manager                  *NomadEnvironmentManager
+}
+
+func TestCreateOrUpdateTestSuite(t *testing.T) {
+	suite.Run(t, new(CreateOrUpdateTestSuite))
+}
+
+func (s *CreateOrUpdateTestSuite) SetupTest() {
+	s.runnerManagerMock = runner.ManagerMock{}
+	s.apiMock = nomad.ExecutorApiMock{}
+	s.request = dto.ExecutionEnvironmentRequest{
+		PrewarmingPoolSize: 10,
+		CPULimit:           20,
+		MemoryLimit:        30,
+		Image:              "my-image",
+		NetworkAccess:      false,
+		ExposedPorts:       nil,
+	}
+
+	s.registerNomadJobMockCall = s.apiMock.On("RegisterNomadJob", mock.AnythingOfType("*api.Job")).Return("eval-id", nil)
+	s.apiMock.On("MonitorEvaluation", mock.AnythingOfType("string"), mock.AnythingOfType("*context.emptyCtx")).Return(nil)
+
+	s.manager = &NomadEnvironmentManager{
+		runnerManager: &s.runnerManagerMock,
+		api:           &s.apiMock,
+	}
+}
+
+func (s *CreateOrUpdateTestSuite) mockEnvironmentExists(exists bool) {
+	s.runnerManagerMock.On("EnvironmentExists", mock.AnythingOfType("EnvironmentId")).Return(exists)
+}
+
+func (s *CreateOrUpdateTestSuite) mockRegisterEnvironment() *mock.Call {
+	return s.runnerManagerMock.On("RegisterEnvironment",
+		mock.AnythingOfType("EnvironmentId"), mock.AnythingOfType("NomadJobId"), mock.AnythingOfType("int")).
+		Return()
+}
+
+func (s *CreateOrUpdateTestSuite) createJobForRequest() *nomadApi.Job {
+	return createJob(s.manager.defaultJob, tests.DefaultEnvironmentIdAsString,
+		s.request.PrewarmingPoolSize, s.request.CPULimit, s.request.MemoryLimit,
+		s.request.Image, s.request.NetworkAccess, s.request.ExposedPorts)
+}
+
+func (s *CreateOrUpdateTestSuite) TestFailsOnInvalidID() {
+	_, err := s.manager.CreateOrUpdate("invalid-id", s.request)
+	s.Error(err)
+}
+
+func (s *CreateOrUpdateTestSuite) TestFailsOnTooLargeID() {
+	tooLargeIntStr := strconv.Itoa(math.MaxInt64) + "0"
+	_, err := s.manager.CreateOrUpdate(tooLargeIntStr, s.request)
+	s.Error(err)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentExistsRegistersCorrectJob() {
+	s.mockEnvironmentExists(true)
+	expectedJob := s.createJobForRequest()
+
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.NoError(err)
+	s.False(created)
+	s.apiMock.AssertCalled(s.T(), "RegisterNomadJob", expectedJob)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentExistsOccurredErrorIsPassed() {
+	s.mockEnvironmentExists(true)
+
+	s.registerNomadJobMockCall.Return("", tests.DefaultError)
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.False(created)
+	s.Equal(tests.DefaultError, err)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentExistsReturnsFalse() {
+	s.mockEnvironmentExists(true)
+
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.NoError(err)
+	s.False(created)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentDoesNotExistRegistersCorrectJob() {
+	s.mockEnvironmentExists(false)
+	s.mockRegisterEnvironment()
+
+	expectedJob := s.createJobForRequest()
+
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.NoError(err)
+	s.True(created)
+	s.apiMock.AssertCalled(s.T(), "RegisterNomadJob", expectedJob)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentDoesNotExistRegistersCorrectEnvironment() {
+	s.mockEnvironmentExists(false)
+	s.mockRegisterEnvironment()
+
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.True(created)
+	s.NoError(err)
+	s.runnerManagerMock.AssertCalled(s.T(), "RegisterEnvironment",
+		runner.EnvironmentId(tests.DefaultEnvironmentIdAsInteger), runner.NomadJobId(tests.DefaultEnvironmentIdAsString), s.request.PrewarmingPoolSize)
+}
+
+func (s *CreateOrUpdateTestSuite) TestWhenEnvironmentDoesNotExistOccurredErrorIsPassedAndNoEnvironmentRegistered() {
+	s.mockEnvironmentExists(false)
+	s.mockRegisterEnvironment()
+
+	s.registerNomadJobMockCall.Return("", tests.DefaultError)
+	created, err := s.manager.CreateOrUpdate(tests.DefaultEnvironmentIdAsString, s.request)
+	s.False(created)
+	s.Equal(tests.DefaultError, err)
+	s.runnerManagerMock.AssertNotCalled(s.T(), "RegisterEnvironment")
+}