-
Notifications
You must be signed in to change notification settings - Fork 894
chore: add agentapi tests #11269
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
chore: add agentapi tests #11269
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
36bfcbd
chore: add agentapi tests
deansheather 24f6614
Remaining tests
deansheather 3b9d365
avoid race in test
deansheather c7f8fcc
Merge branch 'main' into dean/agent-api-test
deansheather 0b1aa12
PR comments
deansheather 08b6780
fixup! PR comments
deansheather 7a165dd
fixup! PR comments
deansheather File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,253 @@ | ||
| package agentapi_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "sync/atomic" | ||
| "testing" | ||
|
|
||
| "github.com/golang/mock/gomock" | ||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "cdr.dev/slog/sloggers/slogtest" | ||
|
|
||
| agentproto "github.com/coder/coder/v2/agent/proto" | ||
| "github.com/coder/coder/v2/coderd/agentapi" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbmock" | ||
| ) | ||
|
|
||
| func TestBatchUpdateAppHealths(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| var ( | ||
| agent = database.WorkspaceAgent{ | ||
| ID: uuid.New(), | ||
| } | ||
| app1 = database.WorkspaceApp{ | ||
| ID: uuid.New(), | ||
| AgentID: agent.ID, | ||
| Slug: "code-server-1", | ||
| DisplayName: "code-server 1", | ||
| HealthcheckUrl: "http://localhost:3000", | ||
| Health: database.WorkspaceAppHealthInitializing, | ||
| } | ||
| app2 = database.WorkspaceApp{ | ||
| ID: uuid.New(), | ||
| AgentID: agent.ID, | ||
| Slug: "code-server-2", | ||
| DisplayName: "code-server 2", | ||
| HealthcheckUrl: "http://localhost:3001", | ||
| Health: database.WorkspaceAppHealthHealthy, | ||
| } | ||
| ) | ||
|
|
||
| t.Run("OK", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
| dbM.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{app1, app2}, nil) | ||
| dbM.EXPECT().UpdateWorkspaceAppHealthByID(gomock.Any(), database.UpdateWorkspaceAppHealthByIDParams{ | ||
| ID: app1.ID, | ||
| Health: database.WorkspaceAppHealthHealthy, | ||
| }).Return(nil) | ||
| dbM.EXPECT().UpdateWorkspaceAppHealthByID(gomock.Any(), database.UpdateWorkspaceAppHealthByIDParams{ | ||
| ID: app2.ID, | ||
| Health: database.WorkspaceAppHealthUnhealthy, | ||
| }).Return(nil) | ||
|
|
||
| var publishCalled int64 | ||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: func(ctx context.Context, wa *database.WorkspaceAgent) error { | ||
| atomic.AddInt64(&publishCalled, 1) | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| // Set both to healthy, only one should be updated in the DB. | ||
deansheather marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{ | ||
| { | ||
| Id: app1.ID[:], | ||
| Health: agentproto.AppHealth_HEALTHY, | ||
| }, | ||
| { | ||
| Id: app2.ID[:], | ||
| Health: agentproto.AppHealth_UNHEALTHY, | ||
| }, | ||
| }, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.Equal(t, &agentproto.BatchUpdateAppHealthResponse{}, resp) | ||
|
|
||
| require.EqualValues(t, 1, atomic.LoadInt64(&publishCalled)) | ||
| }) | ||
|
|
||
| t.Run("Unchanged", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
| dbM.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{app1, app2}, nil) | ||
|
|
||
| var publishCalled int64 | ||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: func(ctx context.Context, wa *database.WorkspaceAgent) error { | ||
| atomic.AddInt64(&publishCalled, 1) | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| // Set both to their current status, neither should be updated in the | ||
| // DB. | ||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{ | ||
| { | ||
| Id: app1.ID[:], | ||
| Health: agentproto.AppHealth_INITIALIZING, | ||
| }, | ||
| { | ||
| Id: app2.ID[:], | ||
| Health: agentproto.AppHealth_HEALTHY, | ||
| }, | ||
| }, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.Equal(t, &agentproto.BatchUpdateAppHealthResponse{}, resp) | ||
|
|
||
| require.EqualValues(t, 0, atomic.LoadInt64(&publishCalled)) | ||
| }) | ||
|
|
||
| t.Run("Empty", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| // No DB queries are made if there are no updates to process. | ||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
|
|
||
| var publishCalled int64 | ||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: func(ctx context.Context, wa *database.WorkspaceAgent) error { | ||
| atomic.AddInt64(&publishCalled, 1) | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| // Do nothing. | ||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{}, | ||
| }) | ||
| require.NoError(t, err) | ||
| require.Equal(t, &agentproto.BatchUpdateAppHealthResponse{}, resp) | ||
|
|
||
| require.EqualValues(t, 0, atomic.LoadInt64(&publishCalled)) | ||
| }) | ||
|
|
||
| t.Run("AppNoHealthcheck", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| app3 := database.WorkspaceApp{ | ||
| ID: uuid.New(), | ||
| AgentID: agent.ID, | ||
| Slug: "code-server-3", | ||
| DisplayName: "code-server 3", | ||
| } | ||
|
|
||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
| dbM.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{app3}, nil) | ||
|
|
||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: nil, | ||
| } | ||
|
|
||
| // Set app3 to healthy, should error. | ||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{ | ||
| { | ||
| Id: app3.ID[:], | ||
| Health: agentproto.AppHealth_HEALTHY, | ||
| }, | ||
| }, | ||
| }) | ||
| require.Error(t, err) | ||
| require.ErrorContains(t, err, "does not have healthchecks enabled") | ||
| require.Nil(t, resp) | ||
| }) | ||
|
|
||
| t.Run("UnknownApp", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
| dbM.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{app1, app2}, nil) | ||
|
|
||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: nil, | ||
| } | ||
|
|
||
| // Set an unknown app to healthy, should error. | ||
| id := uuid.New() | ||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{ | ||
| { | ||
| Id: id[:], | ||
| Health: agentproto.AppHealth_HEALTHY, | ||
| }, | ||
| }, | ||
| }) | ||
| require.Error(t, err) | ||
| require.ErrorContains(t, err, "not found") | ||
| require.Nil(t, resp) | ||
| }) | ||
|
|
||
| t.Run("InvalidHealth", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| dbM := dbmock.NewMockStore(gomock.NewController(t)) | ||
| dbM.EXPECT().GetWorkspaceAppsByAgentID(gomock.Any(), agent.ID).Return([]database.WorkspaceApp{app1, app2}, nil) | ||
|
|
||
| api := &agentapi.AppsAPI{ | ||
| AgentFn: func(context.Context) (database.WorkspaceAgent, error) { | ||
| return agent, nil | ||
| }, | ||
| Database: dbM, | ||
| Log: slogtest.Make(t, nil), | ||
| PublishWorkspaceUpdateFn: nil, | ||
| } | ||
|
|
||
| // Set an unknown app to healthy, should error. | ||
| resp, err := api.BatchUpdateAppHealths(context.Background(), &agentproto.BatchUpdateAppHealthRequest{ | ||
| Updates: []*agentproto.BatchUpdateAppHealthRequest_HealthUpdate{ | ||
| { | ||
| Id: app1.ID[:], | ||
| Health: -999, | ||
| }, | ||
| }, | ||
| }) | ||
| require.Error(t, err) | ||
| require.ErrorContains(t, err, "unknown health status") | ||
| require.Nil(t, resp) | ||
| }) | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.