Refactor interfaces to use a runner manager and an environment manager.

See https://gitlab.hpi.de/codeocean/codemoon/poseidon/-/issues/44.
2021-05-12 15:00:48 +02:00
parent 0d697bfd67
commit 83ea552cf7
27 changed files with 816 additions and 567 deletions
--- a/runner/manager_test.go
+++ b/runner/manager_test.go
@@ -0,0 +1,172 @@
+package runner
+
+import (
+	"errors"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+	"gitlab.hpi.de/codeocean/codemoon/poseidon/nomad"
+	"testing"
+	"time"
+)
+
+const anotherRunnerId = "4n0th3r-runn3r-1d"
+const defaultEnvironmentId = EnvironmentId(0)
+const otherEnvironmentId = EnvironmentId(42)
+const jobId = "4n0th3r-j0b-1d"
+const waitTime = 100 * time.Millisecond
+
+func TestGetNextRunnerTestSuite(t *testing.T) {
+	suite.Run(t, new(ManagerTestSuite))
+}
+
+type ManagerTestSuite struct {
+	suite.Suite
+	apiMock            *nomad.ExecutorApiMock
+	nomadRunnerManager *NomadRunnerManager
+	exerciseRunner     Runner
+}
+
+func (suite *ManagerTestSuite) setUp(returnedRunnerIds []string) {
+	suite.apiMock = &nomad.ExecutorApiMock{}
+	suite.nomadRunnerManager = NewNomadRunnerManager(suite.apiMock)
+	suite.exerciseRunner = CreateTestRunner()
+	suite.mockRunnerQueries(returnedRunnerIds)
+	suite.registerDefaultEnvironment()
+}
+
+func (suite *ManagerTestSuite) mockRunnerQueries(returnedRunnerIds []string) {
+	suite.apiMock.On("LoadRunners", jobId).Return(returnedRunnerIds, nil)
+	suite.apiMock.On("JobScale", jobId).Return(len(returnedRunnerIds), nil)
+	suite.apiMock.On("SetJobScale", jobId, mock.AnythingOfType("int"), "Runner Requested").Return(nil)
+}
+
+func (suite *ManagerTestSuite) registerDefaultEnvironment() {
+	suite.nomadRunnerManager.RegisterEnvironment(defaultEnvironmentId, jobId, 5)
+}
+
+func (suite *ManagerTestSuite) TestRegisterEnvironmentAddsANewJob() {
+	suite.NotNil(suite.nomadRunnerManager.jobs[defaultEnvironmentId])
+}
+
+func (suite *ManagerTestSuite) TestUseReturnsNotFoundErrorIfEnvironmentNotFound() {
+	runner, err := suite.nomadRunnerManager.Use(EnvironmentId(42))
+	suite.Nil(runner)
+	suite.Equal(ErrUnknownExecutionEnvironment, err)
+}
+
+func (suite *ManagerTestSuite) TestUseReturnsRunnerIfAvailable() {
+	suite.nomadRunnerManager.jobs[defaultEnvironmentId].idleRunners.Add(suite.exerciseRunner)
+	receivedRunner, err := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	suite.NoError(err)
+	suite.Equal(suite.exerciseRunner, receivedRunner)
+}
+
+func (suite *ManagerTestSuite) TestUseReturnsErrorIfNoRunnerAvailable() {
+	suite.setUp([]string{})
+	time.Sleep(waitTime)
+	runner, err := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	suite.Nil(runner)
+	suite.Equal(ErrNoRunnersAvailable, err)
+}
+
+func (suite *ManagerTestSuite) TestUseReturnsNoRunnerOfDifferentEnvironment() {
+	suite.setUp([]string{})
+	suite.nomadRunnerManager.jobs[defaultEnvironmentId].idleRunners.Add(suite.exerciseRunner)
+	receivedRunner, err := suite.nomadRunnerManager.Use(otherEnvironmentId)
+	suite.Nil(receivedRunner)
+	suite.Error(err)
+}
+
+func (suite *ManagerTestSuite) TestUseDoesNotReturnTheSameRunnerTwice() {
+	suite.nomadRunnerManager.jobs[defaultEnvironmentId].idleRunners.Add(suite.exerciseRunner)
+	suite.nomadRunnerManager.jobs[defaultEnvironmentId].idleRunners.Add(NewRunner(anotherRunnerId))
+
+	firstReceivedRunner, _ := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	secondReceivedRunner, _ := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	suite.NotEqual(firstReceivedRunner, secondReceivedRunner)
+}
+
+func (suite *ManagerTestSuite) TestUseThrowsAnErrorIfNoRunnersAvailable() {
+	receivedRunner, err := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	suite.Nil(receivedRunner)
+	suite.Error(err)
+}
+
+func (suite *ManagerTestSuite) TestUseAddsRunnerToUsedRunners() {
+	suite.setUp([]string{RunnerId})
+	time.Sleep(waitTime)
+	receivedRunner, _ := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	savedRunner, ok := suite.nomadRunnerManager.usedRunners.Get(receivedRunner.Id())
+	suite.True(ok)
+	suite.Equal(savedRunner, receivedRunner)
+}
+
+func (suite *ManagerTestSuite) TestGetReturnsRunnerIfRunnerIsUsed() {
+	suite.setUp([]string{})
+	suite.nomadRunnerManager.usedRunners.Add(suite.exerciseRunner)
+	savedRunner, err := suite.nomadRunnerManager.Get(suite.exerciseRunner.Id())
+	suite.NoError(err)
+	suite.Equal(savedRunner, suite.exerciseRunner)
+}
+
+func (suite *ManagerTestSuite) TestGetReturnsErrorIfRunnerNotFound() {
+	suite.setUp([]string{})
+	savedRunner, err := suite.nomadRunnerManager.Get(RunnerId)
+	suite.Nil(savedRunner)
+	suite.Error(err)
+}
+
+func (suite *ManagerTestSuite) TestReturnRemovesRunnerFromUsedRunners() {
+	suite.setUp([]string{})
+	suite.apiMock.On("DeleteRunner", mock.AnythingOfType("string")).Return(nil)
+	suite.nomadRunnerManager.usedRunners.Add(suite.exerciseRunner)
+	err := suite.nomadRunnerManager.Return(suite.exerciseRunner)
+	suite.Nil(err)
+	_, ok := suite.nomadRunnerManager.usedRunners.Get(suite.exerciseRunner.Id())
+	suite.False(ok)
+}
+
+func (suite *ManagerTestSuite) TestReturnCallsDeleteRunnerApiMethod() {
+	suite.setUp([]string{})
+	suite.apiMock.On("DeleteRunner", mock.AnythingOfType("string")).Return(nil)
+	err := suite.nomadRunnerManager.Return(suite.exerciseRunner)
+	suite.Nil(err)
+	suite.apiMock.AssertCalled(suite.T(), "DeleteRunner", suite.exerciseRunner.Id())
+}
+
+func (suite *ManagerTestSuite) TestReturnThrowsErrorWhenApiCallFailed() {
+	suite.setUp([]string{})
+	suite.apiMock.On("DeleteRunner", mock.AnythingOfType("string")).Return(errors.New("return failed"))
+	err := suite.nomadRunnerManager.Return(suite.exerciseRunner)
+	suite.Error(err)
+}
+
+func (suite *ManagerTestSuite) TestRefreshFetchesRunners() {
+	suite.setUp([]string{RunnerId})
+	time.Sleep(waitTime)
+	suite.apiMock.AssertCalled(suite.T(), "LoadRunners", jobId)
+}
+
+func (suite *ManagerTestSuite) TestNewRunnersFoundInRefreshAreAddedToUnusedRunners() {
+	suite.setUp([]string{RunnerId})
+	time.Sleep(waitTime)
+	availableRunner, _ := suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	suite.Equal(availableRunner.Id(), RunnerId)
+}
+
+func (suite *ManagerTestSuite) TestRefreshScalesJob() {
+	suite.setUp([]string{RunnerId})
+	time.Sleep(waitTime)
+	// use one runner
+	_, _ = suite.nomadRunnerManager.Use(defaultEnvironmentId)
+	time.Sleep(waitTime)
+	suite.apiMock.AssertCalled(suite.T(), "SetJobScale", jobId, 6, "Runner Requested")
+}
+
+func (suite *ManagerTestSuite) TestRefreshAddsRunnerToPool() {
+	suite.setUp([]string{RunnerId})
+	time.Sleep(waitTime)
+	poolRunner, ok := suite.nomadRunnerManager.jobs[defaultEnvironmentId].idleRunners.Get(RunnerId)
+	suite.True(ok)
+	suite.Equal(RunnerId, poolRunner.Id())
+}