2022-04-11 21:06:15 +00:00
|
|
|
package coderd_test
|
|
|
|
|
|
|
|
import (
|
2022-05-18 17:06:17 +00:00
|
|
|
"bufio"
|
2022-04-11 21:06:15 +00:00
|
|
|
"context"
|
2022-04-29 22:30:10 +00:00
|
|
|
"encoding/json"
|
2022-05-02 15:27:34 +00:00
|
|
|
"runtime"
|
2022-04-29 22:30:10 +00:00
|
|
|
"strings"
|
2022-04-11 21:06:15 +00:00
|
|
|
"testing"
|
2022-05-18 17:06:17 +00:00
|
|
|
"time"
|
2022-04-11 21:06:15 +00:00
|
|
|
|
|
|
|
"github.com/google/uuid"
|
2022-04-18 22:40:25 +00:00
|
|
|
"github.com/pion/webrtc/v3"
|
2022-04-11 21:06:15 +00:00
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
|
|
|
|
"cdr.dev/slog"
|
|
|
|
"cdr.dev/slog/sloggers/slogtest"
|
|
|
|
"github.com/coder/coder/agent"
|
|
|
|
"github.com/coder/coder/coderd/coderdtest"
|
|
|
|
"github.com/coder/coder/codersdk"
|
|
|
|
"github.com/coder/coder/peer"
|
|
|
|
"github.com/coder/coder/provisioner/echo"
|
|
|
|
"github.com/coder/coder/provisionersdk/proto"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestWorkspaceAgent(t *testing.T) {
|
|
|
|
t.Parallel()
|
2022-05-02 15:27:34 +00:00
|
|
|
t.Run("Connect", func(t *testing.T) {
|
|
|
|
t.Parallel()
|
2022-06-27 18:50:52 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
IncludeProvisionerD: true,
|
|
|
|
})
|
2022-05-02 15:27:34 +00:00
|
|
|
user := coderdtest.CreateFirstUser(t, client)
|
|
|
|
authToken := uuid.NewString()
|
2022-07-25 13:55:06 +00:00
|
|
|
tmpDir := t.TempDir()
|
2022-05-02 15:27:34 +00:00
|
|
|
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
2022-07-25 13:55:06 +00:00
|
|
|
Directory: tmpDir,
|
2022-05-02 15:27:34 +00:00
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: authToken,
|
|
|
|
},
|
|
|
|
}},
|
2022-04-11 21:06:15 +00:00
|
|
|
}},
|
2022-05-02 15:27:34 +00:00
|
|
|
},
|
2022-04-11 21:06:15 +00:00
|
|
|
},
|
2022-05-02 15:27:34 +00:00
|
|
|
}},
|
|
|
|
})
|
|
|
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
|
|
|
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
|
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
|
2022-04-11 21:06:15 +00:00
|
|
|
|
2022-05-02 15:27:34 +00:00
|
|
|
resources, err := client.WorkspaceResourcesByBuild(context.Background(), workspace.LatestBuild.ID)
|
|
|
|
require.NoError(t, err)
|
2022-07-25 13:55:06 +00:00
|
|
|
require.Equal(t, tmpDir, resources[0].Agents[0].Directory)
|
2022-05-02 15:27:34 +00:00
|
|
|
_, err = client.WorkspaceAgent(context.Background(), resources[0].Agents[0].ID)
|
|
|
|
require.NoError(t, err)
|
|
|
|
})
|
2022-04-11 21:06:15 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestWorkspaceAgentListen(t *testing.T) {
|
|
|
|
t.Parallel()
|
2022-06-02 20:03:01 +00:00
|
|
|
|
|
|
|
t.Run("Connect", func(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
|
2022-06-27 18:50:52 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
IncludeProvisionerD: true,
|
|
|
|
})
|
2022-06-02 20:03:01 +00:00
|
|
|
user := coderdtest.CreateFirstUser(t, client)
|
|
|
|
authToken := uuid.NewString()
|
|
|
|
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: authToken,
|
|
|
|
},
|
|
|
|
}},
|
2022-04-11 21:06:15 +00:00
|
|
|
}},
|
2022-06-02 20:03:01 +00:00
|
|
|
},
|
2022-04-11 21:06:15 +00:00
|
|
|
},
|
2022-06-02 20:03:01 +00:00
|
|
|
}},
|
|
|
|
})
|
|
|
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
|
|
|
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
|
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
|
|
|
|
|
|
|
|
agentClient := codersdk.New(client.URL)
|
|
|
|
agentClient.SessionToken = authToken
|
|
|
|
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
|
|
|
|
Logger: slogtest.Make(t, nil).Named("agent").Leveled(slog.LevelDebug),
|
|
|
|
})
|
2022-07-25 16:22:02 +00:00
|
|
|
defer func() {
|
2022-06-02 20:03:01 +00:00
|
|
|
_ = agentCloser.Close()
|
2022-07-25 16:22:02 +00:00
|
|
|
}()
|
2022-06-02 20:03:01 +00:00
|
|
|
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
|
|
|
|
conn, err := client.DialWorkspaceAgent(context.Background(), resources[0].Agents[0].ID, nil)
|
|
|
|
require.NoError(t, err)
|
2022-07-25 16:22:02 +00:00
|
|
|
defer func() {
|
2022-06-02 20:03:01 +00:00
|
|
|
_ = conn.Close()
|
2022-07-25 16:22:02 +00:00
|
|
|
}()
|
2022-06-02 20:03:01 +00:00
|
|
|
_, err = conn.Ping()
|
|
|
|
require.NoError(t, err)
|
2022-04-11 21:06:15 +00:00
|
|
|
})
|
2022-06-02 20:03:01 +00:00
|
|
|
|
|
|
|
t.Run("FailNonLatestBuild", func(t *testing.T) {
|
|
|
|
t.Parallel()
|
|
|
|
|
|
|
|
ctx := context.Background()
|
2022-06-27 18:50:52 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
IncludeProvisionerD: true,
|
|
|
|
})
|
2022-06-02 20:03:01 +00:00
|
|
|
|
2022-06-27 18:50:52 +00:00
|
|
|
user := coderdtest.CreateFirstUser(t, client)
|
2022-06-02 20:03:01 +00:00
|
|
|
authToken := uuid.NewString()
|
|
|
|
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: authToken,
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
}},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
})
|
|
|
|
|
|
|
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
|
|
|
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
|
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
|
|
|
|
|
|
|
|
version = coderdtest.UpdateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: uuid.NewString(),
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
}},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
}, template.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
|
|
|
|
|
|
|
stopBuild, err := client.CreateWorkspaceBuild(context.Background(), workspace.ID, codersdk.CreateWorkspaceBuildRequest{
|
|
|
|
TemplateVersionID: version.ID,
|
|
|
|
Transition: codersdk.WorkspaceTransitionStop,
|
|
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, stopBuild.ID)
|
|
|
|
|
|
|
|
agentClient := codersdk.New(client.URL)
|
|
|
|
agentClient.SessionToken = authToken
|
|
|
|
|
|
|
|
_, _, err = agentClient.ListenWorkspaceAgent(ctx, slogtest.Make(t, nil))
|
|
|
|
require.Error(t, err)
|
|
|
|
require.ErrorContains(t, err, "build is outdated")
|
2022-04-11 21:06:15 +00:00
|
|
|
})
|
2022-04-18 22:40:25 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func TestWorkspaceAgentTURN(t *testing.T) {
|
|
|
|
t.Parallel()
|
2022-06-27 18:50:52 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
IncludeProvisionerD: true,
|
|
|
|
})
|
|
|
|
|
2022-04-18 22:40:25 +00:00
|
|
|
user := coderdtest.CreateFirstUser(t, client)
|
|
|
|
authToken := uuid.NewString()
|
|
|
|
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: authToken,
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
}},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
})
|
|
|
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
2022-04-25 21:11:03 +00:00
|
|
|
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
|
2022-04-18 22:40:25 +00:00
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
|
|
|
|
|
|
|
|
agentClient := codersdk.New(client.URL)
|
|
|
|
agentClient.SessionToken = authToken
|
2022-04-29 22:30:10 +00:00
|
|
|
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
|
|
|
|
Logger: slogtest.Make(t, nil),
|
|
|
|
})
|
2022-07-25 16:22:02 +00:00
|
|
|
defer func() {
|
2022-04-18 22:40:25 +00:00
|
|
|
_ = agentCloser.Close()
|
2022-07-25 16:22:02 +00:00
|
|
|
}()
|
2022-04-18 22:40:25 +00:00
|
|
|
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
|
|
|
|
opts := &peer.ConnOptions{
|
|
|
|
Logger: slogtest.Make(t, nil).Named("client"),
|
|
|
|
}
|
|
|
|
// Force a TURN connection!
|
|
|
|
opts.SettingEngine.SetNetworkTypes([]webrtc.NetworkType{webrtc.NetworkTypeTCP4})
|
|
|
|
conn, err := client.DialWorkspaceAgent(context.Background(), resources[0].Agents[0].ID, opts)
|
2022-04-11 21:06:15 +00:00
|
|
|
require.NoError(t, err)
|
2022-07-25 16:22:02 +00:00
|
|
|
defer func() {
|
2022-04-11 21:06:15 +00:00
|
|
|
_ = conn.Close()
|
2022-07-25 16:22:02 +00:00
|
|
|
}()
|
2022-04-11 21:06:15 +00:00
|
|
|
_, err = conn.Ping()
|
|
|
|
require.NoError(t, err)
|
|
|
|
}
|
2022-04-29 22:30:10 +00:00
|
|
|
|
|
|
|
func TestWorkspaceAgentPTY(t *testing.T) {
|
|
|
|
t.Parallel()
|
2022-05-02 15:27:34 +00:00
|
|
|
if runtime.GOOS == "windows" {
|
|
|
|
// This might be our implementation, or ConPTY itself.
|
|
|
|
// It's difficult to find extensive tests for it, so
|
|
|
|
// it seems like it could be either.
|
|
|
|
t.Skip("ConPTY appears to be inconsistent on Windows.")
|
|
|
|
}
|
2022-06-27 18:50:52 +00:00
|
|
|
client := coderdtest.New(t, &coderdtest.Options{
|
|
|
|
IncludeProvisionerD: true,
|
|
|
|
})
|
2022-04-29 22:30:10 +00:00
|
|
|
user := coderdtest.CreateFirstUser(t, client)
|
|
|
|
authToken := uuid.NewString()
|
|
|
|
version := coderdtest.CreateTemplateVersion(t, client, user.OrganizationID, &echo.Responses{
|
|
|
|
Parse: echo.ParseComplete,
|
|
|
|
ProvisionDryRun: echo.ProvisionComplete,
|
|
|
|
Provision: []*proto.Provision_Response{{
|
|
|
|
Type: &proto.Provision_Response_Complete{
|
|
|
|
Complete: &proto.Provision_Complete{
|
|
|
|
Resources: []*proto.Resource{{
|
|
|
|
Name: "example",
|
|
|
|
Type: "aws_instance",
|
|
|
|
Agents: []*proto.Agent{{
|
|
|
|
Id: uuid.NewString(),
|
|
|
|
Auth: &proto.Agent_Token{
|
|
|
|
Token: authToken,
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
}},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}},
|
|
|
|
})
|
|
|
|
template := coderdtest.CreateTemplate(t, client, user.OrganizationID, version.ID)
|
|
|
|
coderdtest.AwaitTemplateVersionJob(t, client, version.ID)
|
|
|
|
workspace := coderdtest.CreateWorkspace(t, client, user.OrganizationID, template.ID)
|
|
|
|
coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
|
|
|
|
|
|
|
|
agentClient := codersdk.New(client.URL)
|
|
|
|
agentClient.SessionToken = authToken
|
|
|
|
agentCloser := agent.New(agentClient.ListenWorkspaceAgent, &agent.Options{
|
|
|
|
Logger: slogtest.Make(t, nil),
|
|
|
|
})
|
2022-07-25 16:22:02 +00:00
|
|
|
defer func() {
|
2022-04-29 22:30:10 +00:00
|
|
|
_ = agentCloser.Close()
|
2022-07-25 16:22:02 +00:00
|
|
|
}()
|
2022-04-29 22:30:10 +00:00
|
|
|
resources := coderdtest.AwaitWorkspaceAgents(t, client, workspace.LatestBuild.ID)
|
|
|
|
|
2022-06-04 20:13:37 +00:00
|
|
|
conn, err := client.WorkspaceAgentReconnectingPTY(context.Background(), resources[0].Agents[0].ID, uuid.New(), 80, 80, "/bin/bash")
|
2022-04-29 22:30:10 +00:00
|
|
|
require.NoError(t, err)
|
|
|
|
defer conn.Close()
|
|
|
|
|
|
|
|
// First attempt to resize the TTY.
|
|
|
|
// The websocket will close if it fails!
|
|
|
|
data, err := json.Marshal(agent.ReconnectingPTYRequest{
|
|
|
|
Height: 250,
|
|
|
|
Width: 250,
|
|
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
|
|
_, err = conn.Write(data)
|
|
|
|
require.NoError(t, err)
|
2022-05-18 17:06:17 +00:00
|
|
|
bufRead := bufio.NewReader(conn)
|
|
|
|
|
|
|
|
// Brief pause to reduce the likelihood that we send keystrokes while
|
|
|
|
// the shell is simultaneously sending a prompt.
|
|
|
|
time.Sleep(100 * time.Millisecond)
|
2022-04-29 22:30:10 +00:00
|
|
|
|
|
|
|
data, err = json.Marshal(agent.ReconnectingPTYRequest{
|
|
|
|
Data: "echo test\r\n",
|
|
|
|
})
|
|
|
|
require.NoError(t, err)
|
|
|
|
_, err = conn.Write(data)
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
2022-05-18 17:06:17 +00:00
|
|
|
expectLine := func(matcher func(string) bool) {
|
2022-04-29 22:30:10 +00:00
|
|
|
for {
|
2022-05-18 17:06:17 +00:00
|
|
|
line, err := bufRead.ReadString('\n')
|
2022-04-29 22:30:10 +00:00
|
|
|
require.NoError(t, err)
|
2022-05-18 17:06:17 +00:00
|
|
|
if matcher(line) {
|
|
|
|
break
|
2022-04-29 22:30:10 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2022-05-18 17:06:17 +00:00
|
|
|
matchEchoCommand := func(line string) bool {
|
|
|
|
return strings.Contains(line, "echo test")
|
|
|
|
}
|
|
|
|
matchEchoOutput := func(line string) bool {
|
|
|
|
return strings.Contains(line, "test") && !strings.Contains(line, "echo")
|
|
|
|
}
|
2022-04-29 22:30:10 +00:00
|
|
|
|
2022-05-18 17:06:17 +00:00
|
|
|
expectLine(matchEchoCommand)
|
|
|
|
expectLine(matchEchoOutput)
|
2022-04-29 22:30:10 +00:00
|
|
|
}
|