mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
feat: Add vscodeipc subcommand for VS Code Extension (#5326)
* Add extio * feat: Add `vscodeipc` subcommand for VS Code Extension This enables the VS Code extension to communicate with a Coder client. The extension will download the slim binary from `/bin/*` for the respective client architecture and OS, then execute `coder vscodeipc` for the connecting workspace. * Add authentication header, improve comments, and add tests for the CLI * Update cli/vscodeipc_test.go Co-authored-by: Mathias Fredriksson <mafredri@gmail.com> * Update cli/vscodeipc_test.go Co-authored-by: Mathias Fredriksson <mafredri@gmail.com> * Update cli/vscodeipc/vscodeipc_test.go Co-authored-by: Mathias Fredriksson <mafredri@gmail.com> * Fix requested changes * Fix IPC tests * Fix shell execution * Fix nix flake * Silence usage Co-authored-by: Mathias Fredriksson <mafredri@gmail.com>
This commit is contained in:
Kyle Carberry
GitHub
202
cli/vscodeipc/vscodeipc_test.go
Normal file
202
cli/vscodeipc/vscodeipc_test.go
Normal file
@ -0,0 +1,202 @@
|
||||
package vscodeipc_test
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"net/url"
|
||||
"runtime"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/spf13/afero"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
"go.uber.org/goleak"
|
||||
"nhooyr.io/websocket"
|
||||
|
||||
"github.com/coder/coder/agent"
|
||||
"github.com/coder/coder/cli/vscodeipc"
|
||||
"github.com/coder/coder/coderd/httpapi"
|
||||
"github.com/coder/coder/codersdk"
|
||||
"github.com/coder/coder/tailnet"
|
||||
"github.com/coder/coder/tailnet/tailnettest"
|
||||
"github.com/coder/coder/testutil"
|
||||
)
|
||||
|
||||
func TestMain(m *testing.M) {
|
||||
goleak.VerifyTestMain(m)
|
||||
}
|
||||
|
||||
func TestVSCodeIPC(t *testing.T) {
|
||||
t.Parallel()
|
||||
ctx := context.Background()
|
||||
|
||||
id := uuid.New()
|
||||
derpMap := tailnettest.RunDERPAndSTUN(t)
|
||||
coordinator := tailnet.NewCoordinator()
|
||||
t.Cleanup(func() {
|
||||
_ = coordinator.Close()
|
||||
})
|
||||
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
switch r.URL.Path {
|
||||
case fmt.Sprintf("/api/v2/workspaceagents/%s/connection", id):
|
||||
assert.Equal(t, r.Method, http.MethodGet)
|
||||
httpapi.Write(ctx, w, http.StatusOK, codersdk.WorkspaceAgentConnectionInfo{
|
||||
DERPMap: derpMap,
|
||||
})
|
||||
return
|
||||
case fmt.Sprintf("/api/v2/workspaceagents/%s/coordinate", id):
|
||||
assert.Equal(t, r.Method, http.MethodGet)
|
||||
ws, err := websocket.Accept(w, r, nil)
|
||||
require.NoError(t, err)
|
||||
conn := websocket.NetConn(ctx, ws, websocket.MessageBinary)
|
||||
_ = coordinator.ServeClient(conn, uuid.New(), id)
|
||||
return
|
||||
case "/api/v2/workspaceagents/me/version":
|
||||
assert.Equal(t, r.Method, http.MethodPost)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
case "/api/v2/workspaceagents/me/metadata":
|
||||
assert.Equal(t, r.Method, http.MethodGet)
|
||||
httpapi.Write(ctx, w, http.StatusOK, codersdk.WorkspaceAgentMetadata{
|
||||
DERPMap: derpMap,
|
||||
})
|
||||
return
|
||||
case "/api/v2/workspaceagents/me/coordinate":
|
||||
assert.Equal(t, r.Method, http.MethodGet)
|
||||
ws, err := websocket.Accept(w, r, nil)
|
||||
require.NoError(t, err)
|
||||
conn := websocket.NetConn(ctx, ws, websocket.MessageBinary)
|
||||
_ = coordinator.ServeAgent(conn, id)
|
||||
return
|
||||
case "/api/v2/workspaceagents/me/report-stats":
|
||||
assert.Equal(t, r.Method, http.MethodPost)
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
case "/":
|
||||
w.WriteHeader(http.StatusOK)
|
||||
return
|
||||
default:
|
||||
t.Fatalf("unexpected request %s", r.URL.Path)
|
||||
}
|
||||
}))
|
||||
t.Cleanup(srv.Close)
|
||||
srvURL, _ := url.Parse(srv.URL)
|
||||
|
||||
client := codersdk.New(srvURL)
|
||||
token := uuid.New().String()
|
||||
client.SetSessionToken(token)
|
||||
agentConn := agent.New(agent.Options{
|
||||
Client: client,
|
||||
Filesystem: afero.NewMemMapFs(),
|
||||
TempDir: t.TempDir(),
|
||||
})
|
||||
t.Cleanup(func() {
|
||||
_ = agentConn.Close()
|
||||
})
|
||||
|
||||
handler, closer, err := vscodeipc.New(ctx, client, id, nil)
|
||||
require.NoError(t, err)
|
||||
t.Cleanup(func() {
|
||||
_ = closer.Close()
|
||||
})
|
||||
|
||||
// Ensure that we're actually connected!
|
||||
require.Eventually(t, func() bool {
|
||||
res := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, "/v1/network", nil)
|
||||
req.Header.Set(vscodeipc.AuthHeader, token)
|
||||
handler.ServeHTTP(res, req)
|
||||
network := &vscodeipc.NetworkResponse{}
|
||||
err = json.NewDecoder(res.Body).Decode(&network)
|
||||
assert.NoError(t, err)
|
||||
return network.Latency != 0
|
||||
}, testutil.WaitLong, testutil.IntervalFast)
|
||||
|
||||
_, port, err := net.SplitHostPort(srvURL.Host)
|
||||
require.NoError(t, err)
|
||||
|
||||
t.Run("NoSessionToken", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
res := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, fmt.Sprintf("/v1/port/%s", port), nil)
|
||||
handler.ServeHTTP(res, req)
|
||||
require.Equal(t, http.StatusUnauthorized, res.Code)
|
||||
})
|
||||
|
||||
t.Run("MismatchedSessionToken", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
res := httptest.NewRecorder()
|
||||
req := httptest.NewRequest(http.MethodGet, fmt.Sprintf("/v1/port/%s", port), nil)
|
||||
req.Header.Set(vscodeipc.AuthHeader, uuid.NewString())
|
||||
handler.ServeHTTP(res, req)
|
||||
require.Equal(t, http.StatusUnauthorized, res.Code)
|
||||
})
|
||||
|
||||
t.Run("Port", func(t *testing.T) {
|
||||
// Tests that the port endpoint can be used for forward traffic.
|
||||
// For this test, we simply use the already listening httptest server.
|
||||
t.Parallel()
|
||||
input, output := net.Pipe()
|
||||
defer input.Close()
|
||||
defer output.Close()
|
||||
res := &hijackable{httptest.NewRecorder(), output}
|
||||
req := httptest.NewRequest(http.MethodGet, fmt.Sprintf("/v1/port/%s", port), nil)
|
||||
req.Header.Set(vscodeipc.AuthHeader, token)
|
||||
go handler.ServeHTTP(res, req)
|
||||
|
||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "http://127.0.0.1/", nil)
|
||||
require.NoError(t, err)
|
||||
client := http.Client{
|
||||
Transport: &http.Transport{
|
||||
DialContext: func(ctx context.Context, network, addr string) (net.Conn, error) {
|
||||
return input, nil
|
||||
},
|
||||
},
|
||||
}
|
||||
resp, err := client.Do(req)
|
||||
require.NoError(t, err)
|
||||
defer resp.Body.Close()
|
||||
require.Equal(t, http.StatusOK, resp.StatusCode)
|
||||
})
|
||||
|
||||
t.Run("Execute", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
if runtime.GOOS == "windows" {
|
||||
t.Skip("Execute isn't supported on Windows yet!")
|
||||
return
|
||||
}
|
||||
|
||||
res := httptest.NewRecorder()
|
||||
data, _ := json.Marshal(vscodeipc.ExecuteRequest{
|
||||
Command: "echo test",
|
||||
})
|
||||
req := httptest.NewRequest(http.MethodPost, "/v1/execute", bytes.NewReader(data))
|
||||
req.Header.Set(vscodeipc.AuthHeader, token)
|
||||
handler.ServeHTTP(res, req)
|
||||
|
||||
decoder := json.NewDecoder(res.Body)
|
||||
var msg vscodeipc.ExecuteResponse
|
||||
err = decoder.Decode(&msg)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "test\n", msg.Data)
|
||||
err = decoder.Decode(&msg)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, 0, *msg.ExitCode)
|
||||
})
|
||||
}
|
||||
|
||||
type hijackable struct {
|
||||
*httptest.ResponseRecorder
|
||||
conn net.Conn
|
||||
}
|
||||
|
||||
func (h *hijackable) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
||||
return h.conn, bufio.NewReadWriter(bufio.NewReader(h.conn), bufio.NewWriter(h.conn)), nil
|
||||
}
|
||||
Reference in New Issue
Block a user