-
Notifications
You must be signed in to change notification settings - Fork 894
refactor(agent): add agenttest.New helper function #9812
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
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
af64f27
fix(cli): call agent directly in gitssh tests
johnstcn d99e29c
add agenttest.New test helper
johnstcn 3d2788e
return wrapper instead of func
johnstcn 5b4cad9
refactor existing unit tests
johnstcn 81a3a78
ignore duplicated code in unit tests
johnstcn 3316b99
address code review comments
johnstcn c2cba9d
fixup! address code review comments
johnstcn 6aa4bbe
Merge remote-tracking branch 'origin/main' into cj/agenttest
johnstcn d55c797
address PR comments
johnstcn 903fe3e
skip flaky test
johnstcn 9f3f6ff
Merge remote-tracking branch 'origin/main' into cj/agenttest
johnstcn 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package agenttest | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/url" | ||
| "sync" | ||
| "testing" | ||
|
|
||
| "github.com/google/uuid" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "cdr.dev/slog" | ||
| "cdr.dev/slog/sloggers/slogtest" | ||
| "github.com/coder/coder/v2/agent" | ||
| "github.com/coder/coder/v2/coderd/coderdtest" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| "github.com/coder/coder/v2/codersdk/agentsdk" | ||
| ) | ||
|
|
||
| // Agent is a small wrapper around an agent for use in tests. | ||
| type Agent struct { | ||
| agent agent.Agent | ||
| agentClient *agentsdk.Client | ||
| resources []codersdk.WorkspaceResource | ||
| waiter func(*codersdk.Client, uuid.UUID, ...string) []codersdk.WorkspaceResource | ||
| waitOnce sync.Once | ||
| } | ||
|
|
||
| // Wait waits for the agent to connect to the workspace and returns the | ||
| // resources for the connected workspace. | ||
| // Calls coderdtest.AwaitWorkspaceAgents under the hood. | ||
| // Multiple calls to Wait() are idempotent. | ||
| func (a *Agent) Wait(client *codersdk.Client, workspaceID uuid.UUID, agentNames ...string) []codersdk.WorkspaceResource { | ||
| a.waitOnce.Do(func() { | ||
| a.resources = a.waiter(client, workspaceID, agentNames...) | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| }) | ||
| return a.resources | ||
| } | ||
|
|
||
| // Client returns the agent client. | ||
| func (a *Agent) Client() *agentsdk.Client { | ||
| return a.agentClient | ||
| } | ||
|
|
||
| // Agent returns the agent itself. | ||
| func (a *Agent) Agent() agent.Agent { | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return a.agent | ||
| } | ||
|
|
||
| // New starts a new agent for use in tests. | ||
| // The agent will use the provided coder URL and session token. | ||
| // The options passed to agent.New() can be modified by passing an optional | ||
| // variadic func(*agent.Options). | ||
| // Returns a wrapper that can be used to wait for the agent to connect to the | ||
| // workspace by calling Wait(). The arguments to Wait() are passed to | ||
| // coderdtest.AwaitWorkspaceAgents. | ||
| // Closing the agent is handled by the test cleanup. | ||
| func New(t testing.TB, coderURL *url.URL, agentToken string, opts ...func(*agent.Options)) *Agent { | ||
| t.Helper() | ||
|
|
||
| var o agent.Options | ||
| log := slogtest.Make(t, nil).Leveled(slog.LevelDebug).Named("agent") | ||
| o.Logger = log | ||
|
|
||
| for _, opt := range opts { | ||
| opt(&o) | ||
| } | ||
|
|
||
| if o.Client == nil { | ||
| agentClient := agentsdk.New(coderURL) | ||
| agentClient.SetSessionToken(agentToken) | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| o.Client = agentClient | ||
| } | ||
johnstcn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| if o.ExchangeToken == nil { | ||
| o.ExchangeToken = func(_ context.Context) (string, error) { | ||
| return agentToken, nil | ||
| } | ||
| } | ||
|
|
||
| if o.LogDir == "" { | ||
| o.LogDir = t.TempDir() | ||
| } | ||
|
|
||
| agentCloser := agent.New(o) | ||
| t.Cleanup(func() { | ||
| assert.NoError(t, agentCloser.Close(), "failed to close agent during cleanup") | ||
| }) | ||
|
|
||
| return &Agent{ | ||
| agent: agentCloser, | ||
| agentClient: o.Client.(*agentsdk.Client), // nolint:forcetypeassert | ||
| waiter: func(c *codersdk.Client, workspaceID uuid.UUID, agentNames ...string) []codersdk.WorkspaceResource { | ||
| return coderdtest.AwaitWorkspaceAgents(t, c, workspaceID, agentNames...) | ||
| }, | ||
| } | ||
| } | ||
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
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
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.