package environment import ( "context" nomadApi "github.com/hashicorp/nomad/api" "github.com/hashicorp/nomad/nomad/structs" "github.com/openHPI/poseidon/internal/nomad" "github.com/openHPI/poseidon/internal/runner" "github.com/openHPI/poseidon/pkg/dto" "github.com/openHPI/poseidon/tests" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/mock" "github.com/stretchr/testify/require" "github.com/stretchr/testify/suite" "os" "testing" "time" ) type CreateOrUpdateTestSuite struct { suite.Suite runnerManagerMock runner.ManagerMock apiMock nomad.ExecutorAPIMock request dto.ExecutionEnvironmentRequest manager *NomadEnvironmentManager environmentID dto.EnvironmentID } 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.manager = &NomadEnvironmentManager{ runnerManager: &s.runnerManagerMock, api: &s.apiMock, templateEnvironmentHCL: templateEnvironmentJobHCL, } s.environmentID = dto.EnvironmentID(tests.DefaultEnvironmentIDAsInteger) } func (s *CreateOrUpdateTestSuite) TestReturnsErrorIfCreatesOrUpdateEnvironmentReturnsError() { s.apiMock.On("RegisterNomadJob", mock.AnythingOfType("*api.Job")).Return("", tests.ErrDefault) s.runnerManagerMock.On("GetEnvironment", mock.AnythingOfType("dto.EnvironmentID")).Return(nil, false) s.runnerManagerMock.On("SetEnvironment", mock.AnythingOfType("*environment.NomadEnvironment")).Return(true) _, err := s.manager.CreateOrUpdate(dto.EnvironmentID(tests.DefaultEnvironmentIDAsInteger), s.request) s.ErrorIs(err, tests.ErrDefault) } func TestNewNomadEnvironmentManager(t *testing.T) { executorAPIMock := &nomad.ExecutorAPIMock{} executorAPIMock.On("LoadEnvironmentJobs").Return([]*nomadApi.Job{}, nil) runnerManagerMock := &runner.ManagerMock{} runnerManagerMock.On("Load").Return() previousTemplateEnvironmentJobHCL := templateEnvironmentJobHCL t.Run("returns error if template file does not exist", func(t *testing.T) { _, err := NewNomadEnvironmentManager(runnerManagerMock, executorAPIMock, "/non-existent/file") assert.Error(t, err) }) t.Run("loads template environment job from file", func(t *testing.T) { templateJobHCL := "job \"test\" {}" _, err := NewNomadEnvironment(templateJobHCL) require.NoError(t, err) f := createTempFile(t, templateJobHCL) defer os.Remove(f.Name()) m, err := NewNomadEnvironmentManager(runnerManagerMock, executorAPIMock, f.Name()) assert.NoError(t, err) assert.NotNil(t, m) assert.Equal(t, templateJobHCL, m.templateEnvironmentHCL) }) t.Run("returns error if template file is invalid", func(t *testing.T) { templateJobHCL := "invalid hcl file" f := createTempFile(t, templateJobHCL) defer os.Remove(f.Name()) m, err := NewNomadEnvironmentManager(runnerManagerMock, executorAPIMock, f.Name()) require.NoError(t, err) _, err = NewNomadEnvironment(m.templateEnvironmentHCL) assert.Error(t, err) }) templateEnvironmentJobHCL = previousTemplateEnvironmentJobHCL } func TestNomadEnvironmentManager_Get(t *testing.T) { apiMock := &nomad.ExecutorAPIMock{} mockWatchAllocations(apiMock) call := apiMock.On("LoadEnvironmentJobs") call.Run(func(args mock.Arguments) { call.ReturnArguments = mock.Arguments{[]*nomadApi.Job{}, nil} }) runnerManager := runner.NewNomadRunnerManager(apiMock, context.Background()) m, err := NewNomadEnvironmentManager(runnerManager, apiMock, "") require.NoError(t, err) t.Run("Returns error when not found", func(t *testing.T) { _, err := m.Get(tests.DefaultEnvironmentIDAsInteger, false) assert.Error(t, err) }) t.Run("Returns environment when it was added before", func(t *testing.T) { expectedEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) expectedEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) require.NoError(t, err) runnerManager.SetEnvironment(expectedEnvironment) environment, err := m.Get(tests.DefaultEnvironmentIDAsInteger, false) assert.NoError(t, err) assert.Equal(t, expectedEnvironment, environment) }) t.Run("Fetch", func(t *testing.T) { apiMock.On("DeleteJob", mock.AnythingOfType("string")).Return(nil) t.Run("Returns error when not found", func(t *testing.T) { _, err := m.Get(tests.DefaultEnvironmentIDAsInteger, true) assert.Error(t, err) }) t.Run("Updates values when environment already known by Poseidon", func(t *testing.T) { fetchedEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) require.NoError(t, err) fetchedEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) fetchedEnvironment.SetImage("random docker image") call.Run(func(args mock.Arguments) { call.ReturnArguments = mock.Arguments{[]*nomadApi.Job{fetchedEnvironment.job}, nil} }) localEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) require.NoError(t, err) localEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) runnerManager.SetEnvironment(localEnvironment) environment, err := m.Get(tests.DefaultEnvironmentIDAsInteger, false) assert.NoError(t, err) assert.NotEqual(t, fetchedEnvironment.Image(), environment.Image()) environment, err = m.Get(tests.DefaultEnvironmentIDAsInteger, true) assert.NoError(t, err) assert.Equal(t, fetchedEnvironment.Image(), environment.Image()) }) runnerManager.DeleteEnvironment(tests.DefaultEnvironmentIDAsInteger) t.Run("Adds environment when not already known by Poseidon", func(t *testing.T) { fetchedEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) require.NoError(t, err) fetchedEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) fetchedEnvironment.SetImage("random docker image") call.Run(func(args mock.Arguments) { call.ReturnArguments = mock.Arguments{[]*nomadApi.Job{fetchedEnvironment.job}, nil} }) _, err = m.Get(tests.DefaultEnvironmentIDAsInteger, false) assert.Error(t, err) environment, err := m.Get(tests.DefaultEnvironmentIDAsInteger, true) assert.NoError(t, err) assert.Equal(t, fetchedEnvironment.Image(), environment.Image()) }) }) } func TestNomadEnvironmentManager_List(t *testing.T) { apiMock := &nomad.ExecutorAPIMock{} mockWatchAllocations(apiMock) call := apiMock.On("LoadEnvironmentJobs") call.Run(func(args mock.Arguments) { call.ReturnArguments = mock.Arguments{[]*nomadApi.Job{}, nil} }) runnerManager := runner.NewNomadRunnerManager(apiMock, context.Background()) m, err := NewNomadEnvironmentManager(runnerManager, apiMock, "") require.NoError(t, err) t.Run("with no environments", func(t *testing.T) { environments, err := m.List(true) assert.NoError(t, err) assert.Empty(t, environments) }) t.Run("Returns added environment", func(t *testing.T) { localEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) require.NoError(t, err) localEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) runnerManager.SetEnvironment(localEnvironment) environments, err := m.List(false) assert.NoError(t, err) assert.Equal(t, 1, len(environments)) assert.Equal(t, localEnvironment, environments[0]) }) runnerManager.DeleteEnvironment(tests.DefaultEnvironmentIDAsInteger) t.Run("Fetches new Runners via the api client", func(t *testing.T) { fetchedEnvironment, err := NewNomadEnvironment(templateEnvironmentJobHCL) require.NoError(t, err) fetchedEnvironment.SetID(tests.DefaultEnvironmentIDAsInteger) status := structs.JobStatusRunning fetchedEnvironment.job.Status = &status call.Run(func(args mock.Arguments) { call.ReturnArguments = mock.Arguments{[]*nomadApi.Job{fetchedEnvironment.job}, nil} }) environments, err := m.List(false) assert.NoError(t, err) assert.Empty(t, environments) environments, err = m.List(true) assert.NoError(t, err) assert.Equal(t, 1, len(environments)) assert.Equal(t, fetchedEnvironment, environments[0]) }) } func mockWatchAllocations(apiMock *nomad.ExecutorAPIMock) { call := apiMock.On("WatchEventStream", mock.Anything, mock.Anything, mock.Anything) call.Run(func(args mock.Arguments) { <-time.After(10 * time.Minute) // 10 minutes is the default test timeout call.ReturnArguments = mock.Arguments{nil} }) } func createTempFile(t *testing.T, content string) *os.File { t.Helper() f, err := os.CreateTemp("", "test") require.NoError(t, err) n, err := f.WriteString(content) require.NoError(t, err) require.Equal(t, len(content), n) return f }