Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

fix(cli)!: enforce selection for multiple agents and select sub agent if available#18427

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
mafredri wants to merge2 commits intomain
base:main
Choose a base branch
Loading
frommafredri/fix-cli-agent-selection
Open
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletionscli/ssh.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -925,36 +925,44 @@ func getWorkspaceAndAgent(ctx context.Context, inv *serpent.Invocation, client *
func getWorkspaceAgent(workspace codersdk.Workspace, agentName string) (workspaceAgent codersdk.WorkspaceAgent, err error) {
resources := workspace.LatestBuild.Resources

agents := make([]codersdk.WorkspaceAgent, 0)
var (
availableNames []string
agents []codersdk.WorkspaceAgent
subAgents []codersdk.WorkspaceAgent
)
for _, resource := range resources {
agents = append(agents, resource.Agents...)
for _, agent := range resource.Agents {
availableNames = append(availableNames, agent.Name)
if agent.ParentID.UUID == uuid.Nil {
agents = append(agents, agent)
} else {
subAgents = append(subAgents, agent)
}
}
}
if len(agents) == 0 {
return codersdk.WorkspaceAgent{}, xerrors.Errorf("workspace %q has no agents", workspace.Name)
}
slices.Sort(availableNames)
if agentName != "" {
agents = append(agents, subAgents...)
for _, otherAgent := range agents {
if otherAgent.Name != agentName {
continue
}
workspaceAgent = otherAgent
break
}
if workspaceAgent.ID == uuid.Nil {
return codersdk.WorkspaceAgent{}, xerrors.Errorf("agent not found by name %q", agentName)
return otherAgent, nil
}
return codersdk.WorkspaceAgent{}, xerrors.Errorf("agent not found by name %q, available agents: %v", agentName, availableNames)
}
if workspaceAgent.ID == uuid.Nil {
if len(agents) > 1 {
workspaceAgent, err = cryptorand.Element(agents)
if err != nil {
return codersdk.WorkspaceAgent{}, err
}
} else {
workspaceAgent = agents[0]
}
if len(subAgents) == 1 {
return subAgents[0], nil
} else if len(subAgents) > 1 {
return codersdk.WorkspaceAgent{}, xerrors.Errorf("multiple sub-agents found, please specify the agent name, available agents: %v", availableNames)
}
if len(agents) == 1 {
return agents[0], nil
}
returnworkspaceAgent, nil
returncodersdk.WorkspaceAgent{}, xerrors.Errorf("multiple agents found, please specify the agent name, available agents: %v", availableNames)
}

// Attempt to poll workspace autostop. We write a per-workspace lockfile to
Expand Down
193 changes: 193 additions & 0 deletionscli/ssh_internal_test.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ import (
"time"

gliderssh "github.com/gliderlabs/ssh"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"golang.org/x/crypto/ssh"
Expand DownExpand Up@@ -346,3 +347,195 @@ func newAsyncCloser(ctx context.Context, t *testing.T) *asyncCloser {
started: make(chan struct{}),
}
}

func Test_getWorkspaceAgent(t *testing.T) {
t.Parallel()

createWorkspaceWithAgents := func(agents []codersdk.WorkspaceAgent) codersdk.Workspace {
return codersdk.Workspace{
Name: "test-workspace",
LatestBuild: codersdk.WorkspaceBuild{
Resources: []codersdk.WorkspaceResource{
{
Agents: agents,
},
},
},
}
}

createAgent := func(name string) codersdk.WorkspaceAgent {
return codersdk.WorkspaceAgent{
ID: uuid.New(),
Name: name,
ParentID: uuid.NullUUID{},
}
}

createSubAgent := func(name string, parentID uuid.UUID) codersdk.WorkspaceAgent {
return codersdk.WorkspaceAgent{
ID: uuid.New(),
Name: name,
ParentID: uuid.NullUUID{
UUID: parentID,
Valid: true,
},
}
}

t.Run("SingleAgent_NoNameSpecified", func(t *testing.T) {
t.Parallel()
agent := createAgent("main")
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent})

result, err := getWorkspaceAgent(workspace, "")
require.NoError(t, err)
assert.Equal(t, agent.ID, result.ID)
assert.Equal(t, "main", result.Name)
})

t.Run("SingleSubAgent_NoNameSpecified", func(t *testing.T) {
t.Parallel()
parentAgent := createAgent("main")
subAgent := createSubAgent("devcontainer", parentAgent.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{parentAgent, subAgent})

// Should prefer the sub-agent when no name is specified.
result, err := getWorkspaceAgent(workspace, "")
require.NoError(t, err)
assert.Equal(t, subAgent.ID, result.ID)
assert.Equal(t, "devcontainer", result.Name)
})

t.Run("MultipleAgents_NoSubAgents_NoNameSpecified", func(t *testing.T) {
t.Parallel()
agent1 := createAgent("main1")
agent2 := createAgent("main2")
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

_, err := getWorkspaceAgent(workspace, "")
require.Error(t, err)
assert.Contains(t, err.Error(), "multiple agents found")
assert.Contains(t, err.Error(), "available agents: [main1 main2]")
})

t.Run("MultipleSubAgents_NoNameSpecified", func(t *testing.T) {
t.Parallel()
parentAgent := createAgent("main")
subAgent1 := createSubAgent("devcontainer1", parentAgent.ID)
subAgent2 := createSubAgent("devcontainer2", parentAgent.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{parentAgent, subAgent1, subAgent2})

_, err := getWorkspaceAgent(workspace, "")
require.Error(t, err)
assert.Contains(t, err.Error(), "multiple sub-agents found")
assert.Contains(t, err.Error(), "available agents: [devcontainer1 devcontainer2 main]")
})

t.Run("AgentNameSpecified_Found_RegularAgent", func(t *testing.T) {
t.Parallel()
agent1 := createAgent("main1")
agent2 := createAgent("main2")
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

result, err := getWorkspaceAgent(workspace, "main1")
require.NoError(t, err)
assert.Equal(t, agent1.ID, result.ID)
assert.Equal(t, "main1", result.Name)
})

t.Run("AgentNameSpecified_Found_SubAgent", func(t *testing.T) {
t.Parallel()
agent := createAgent("main")
subAgent := createSubAgent("devcontainer", agent.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent, subAgent})

result, err := getWorkspaceAgent(workspace, "devcontainer")
require.NoError(t, err)
assert.Equal(t, subAgent.ID, result.ID)
assert.Equal(t, "devcontainer", result.Name)
})

t.Run("AgentNameSpecified_NotFound", func(t *testing.T) {
t.Parallel()
agent1 := createAgent("main1")
agent2 := createAgent("main2")
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2})

_, err := getWorkspaceAgent(workspace, "nonexistent")
require.Error(t, err)
assert.Contains(t, err.Error(), `agent not found by name "nonexistent"`)
assert.Contains(t, err.Error(), "available agents: [main1 main2]")
})

t.Run("NoAgents", func(t *testing.T) {
t.Parallel()
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{})

_, err := getWorkspaceAgent(workspace, "")
require.Error(t, err)
assert.Contains(t, err.Error(), `workspace "test-workspace" has no agents`)
})

t.Run("MixedAgents_SubAgentPreferred", func(t *testing.T) {
t.Parallel()
agent := createAgent("main")
subAgent := createSubAgent("devcontainer", agent.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent, subAgent})

// When no name is specified and there's one sub-agent,
// it should be preferred.
result, err := getWorkspaceAgent(workspace, "")
require.NoError(t, err)
assert.Equal(t, subAgent.ID, result.ID)
assert.Equal(t, "devcontainer", result.Name)
})

t.Run("MixedAgents_SpecificNameFound", func(t *testing.T) {
t.Parallel()
agent := createAgent("main")
subAgent := createSubAgent("devcontainer", agent.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent, subAgent})

// Should be able to find regular agent by name.
result, err := getWorkspaceAgent(workspace, "main")
require.NoError(t, err)
assert.Equal(t, agent.ID, result.ID)
assert.Equal(t, "main", result.Name)

// Should be able to find sub-agent by name.
result, err = getWorkspaceAgent(workspace, "devcontainer")
require.NoError(t, err)
assert.Equal(t, subAgent.ID, result.ID)
assert.Equal(t, "devcontainer", result.Name)
})

t.Run("AvailableAgentNames_SortedCorrectly", func(t *testing.T) {
t.Parallel()
// Define agents in non-alphabetical order.
agent2 := createAgent("zod")
agent1 := createAgent("clark")
subAgent := createSubAgent("krypton", agent1.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent2, agent1, subAgent})

_, err := getWorkspaceAgent(workspace, "nonexistent")
require.Error(t, err)
// Available agents should be sorted alphabetically.
assert.Contains(t, err.Error(), "available agents: [clark krypton zod]")
})

t.Run("MultipleAgentsAndSubAgents_NoNameSpecified", func(t *testing.T) {
t.Parallel()
agent1 := createAgent("main1")
agent2 := createAgent("main2")
subAgent1 := createSubAgent("dev1", agent1.ID)
subAgent2 := createSubAgent("dev2", agent1.ID)
workspace := createWorkspaceWithAgents([]codersdk.WorkspaceAgent{agent1, agent2, subAgent1, subAgent2})

// Should error because there are multiple sub-agents.
_, err := getWorkspaceAgent(workspace, "")
require.Error(t, err)
assert.Contains(t, err.Error(), "multiple sub-agents found")
assert.Contains(t, err.Error(), "available agents: [dev1 dev2 main1 main2]")
})
}
Loading
[8]ページ先頭
©2009-2025 Movatter.jp