blob: ab3f8c1a1c0358dd600ba7a337d629657a7ca817 [file] [log] [blame]
Earl Lee2e463fb2025-04-17 11:22:22 -07001// Package dockerimg
2package dockerimg
3
4import (
5 "bytes"
6 "context"
Philip Zeyliger5e227dd2025-04-21 15:55:29 -07007 "crypto/rand"
Earl Lee2e463fb2025-04-17 11:22:22 -07008 "crypto/sha256"
9 "encoding/hex"
10 "encoding/json"
11 "fmt"
12 "io"
13 "log/slog"
14 "net"
15 "net/http"
16 "os"
17 "os/exec"
18 "path/filepath"
19 "runtime"
20 "strings"
Josh Bleecher Snyder99570462025-05-05 10:26:14 -070021 "sync/atomic"
Earl Lee2e463fb2025-04-17 11:22:22 -070022 "time"
23
Sean McCullough7013e9e2025-05-14 02:03:58 +000024 "golang.org/x/crypto/ssh"
Josh Bleecher Snyder78707d62025-04-30 21:06:49 +000025 "sketch.dev/browser"
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -070026 "sketch.dev/llm/ant"
Sean McCulloughbaa2b592025-04-23 10:40:08 -070027 "sketch.dev/loop/server"
Earl Lee2e463fb2025-04-17 11:22:22 -070028 "sketch.dev/skribe"
Philip Zeyliger5d6af872025-04-23 19:48:34 -070029 "sketch.dev/webui"
Earl Lee2e463fb2025-04-17 11:22:22 -070030)
31
32// ContainerConfig holds all configuration for launching a container
33type ContainerConfig struct {
34 // SessionID is the unique identifier for this session
35 SessionID string
36
37 // LocalAddr is the initial address to use (though it may be overwritten later)
38 LocalAddr string
39
40 // SkabandAddr is the address of the skaband service if available
41 SkabandAddr string
42
David Crawshaw5a7b3692025-05-05 16:49:15 -070043 // Model is the name of the LLM model to use.
44 Model string
Earl Lee2e463fb2025-04-17 11:22:22 -070045
David Crawshaw5a7b3692025-05-05 16:49:15 -070046 // ModelURL is the URL of the LLM service.
47 ModelURL string
48
49 // ModelAPIKey is the API key for LLM service.
50 ModelAPIKey string
Earl Lee2e463fb2025-04-17 11:22:22 -070051
52 // Path is the local filesystem path to use
53 Path string
54
55 // GitUsername is the username to use for git operations
56 GitUsername string
57
58 // GitEmail is the email to use for git operations
59 GitEmail string
60
61 // OpenBrowser determines whether to open a browser automatically
62 OpenBrowser bool
63
64 // NoCleanup prevents container cleanup when set to true
65 NoCleanup bool
66
67 // ForceRebuild forces rebuilding of the Docker image even if it exists
68 ForceRebuild bool
69
70 // Host directory to copy container logs into, if not set to ""
71 ContainerLogDest string
72
73 // Path to pre-built linux sketch binary, or build a new one if set to ""
74 SketchBinaryLinux string
75
76 // Sketch client public key.
77 SketchPubKey string
Philip Zeyligerd1402952025-04-23 03:54:37 +000078
Sean McCulloughbaa2b592025-04-23 10:40:08 -070079 // Host port for the container's ssh server
80 SSHPort int
81
Philip Zeyliger18532b22025-04-23 21:11:46 +000082 // Outside information to pass to the container
83 OutsideHostname string
84 OutsideOS string
85 OutsideWorkingDir string
Philip Zeyligerb74c4f62025-04-25 19:18:49 -070086
Pokey Rule0dcebe12025-04-28 14:51:04 +010087 // If true, exit after the first turn
88 OneShot bool
89
90 // Initial prompt
91 Prompt string
Philip Zeyliger1b47aa22025-04-28 19:25:38 +000092
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -070093 // Initial commit to use as starting point. Resolved into Commit on the host.
Philip Zeyliger1b47aa22025-04-28 19:25:38 +000094 InitialCommit string
David Crawshawb5f6a002025-05-05 08:27:16 -070095
96 // Verbose enables verbose output
97 Verbose bool
Philip Zeyliger1dc21372025-05-05 19:54:44 +000098
99 // DockerArgs are additional arguments to pass to the docker create command
100 DockerArgs string
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000101
Josh Bleecher Snyderac761c92025-05-16 18:58:45 +0000102 // Mounts specifies volumes to mount in the container in format /path/on/host:/path/in/container
103 Mounts []string
104
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000105 // ExperimentFlag contains the experimental features to enable
106 ExperimentFlag string
Philip Zeyliger613c0f52025-05-15 16:36:22 -0700107
108 // TermUI enables terminal UI
109 TermUI bool
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700110
111 GitRemoteUrl string
112
113 // Commit hash to checkout from GetRemoteUrl
114 Commit string
115
116 // Outtie's HTTP server
117 OutsideHTTP string
Earl Lee2e463fb2025-04-17 11:22:22 -0700118}
119
120// LaunchContainer creates a docker container for a project, installs sketch and opens a connection to it.
121// It writes status to stdout.
David Crawshawb5f6a002025-05-05 08:27:16 -0700122func LaunchContainer(ctx context.Context, config ContainerConfig) error {
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700123 slog.Debug("Container Config", slog.String("config", fmt.Sprintf("%+v", config)))
Earl Lee2e463fb2025-04-17 11:22:22 -0700124 if _, err := exec.LookPath("docker"); err != nil {
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700125 if runtime.GOOS == "darwin" {
126 return fmt.Errorf("cannot find `docker` binary; run: brew install docker colima && colima start")
127 } else {
128 return fmt.Errorf("cannot find `docker` binary; install docker (e.g., apt-get install docker.io)")
129 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700130 }
131
132 if out, err := combinedOutput(ctx, "docker", "ps"); err != nil {
133 // `docker ps` provides a good error message here that can be
134 // easily chatgpt'ed by users, so send it to the user as-is:
135 // Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
136 return fmt.Errorf("docker ps: %s (%w)", out, err)
137 }
138
139 _, hostPort, err := net.SplitHostPort(config.LocalAddr)
140 if err != nil {
141 return err
142 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700143 gitRoot, err := findGitRoot(ctx, config.Path)
144 if err != nil {
145 return err
146 }
Philip Zeyligerd6d12d12025-05-19 19:19:21 -0700147 err = checkForEmptyGitRepo(ctx, config.Path)
148 if err != nil {
149 return err
150 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700151
David Crawshaw5a7b3692025-05-05 16:49:15 -0700152 imgName, err := findOrBuildDockerImage(ctx, config.Path, gitRoot, config.Model, config.ModelURL, config.ModelAPIKey, config.ForceRebuild, config.Verbose)
Earl Lee2e463fb2025-04-17 11:22:22 -0700153 if err != nil {
154 return err
155 }
156
157 linuxSketchBin := config.SketchBinaryLinux
158 if linuxSketchBin == "" {
David Crawshawb5f6a002025-05-05 08:27:16 -0700159 linuxSketchBin, err = buildLinuxSketchBin(ctx)
Earl Lee2e463fb2025-04-17 11:22:22 -0700160 if err != nil {
161 return err
162 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700163 }
164
Philip Zeyligerc72fff52025-04-29 20:17:54 +0000165 cntrName := "sketch-" + config.SessionID
Earl Lee2e463fb2025-04-17 11:22:22 -0700166 defer func() {
167 if config.NoCleanup {
168 return
169 }
170 if out, err := combinedOutput(ctx, "docker", "kill", cntrName); err != nil {
171 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
172 _ = out
173 }
174 if out, err := combinedOutput(ctx, "docker", "rm", cntrName); err != nil {
175 // TODO: print in verbose mode? fmt.Fprintf(os.Stderr, "docker kill: %s: %v\n", out, err)
176 _ = out
177 }
178 }()
179
180 // errCh receives errors from operations that this function calls in separate goroutines.
181 errCh := make(chan error)
182
183 // Start the git server
184 gitSrv, err := newGitServer(gitRoot)
185 if err != nil {
186 return fmt.Errorf("failed to start git server: %w", err)
187 }
188 defer gitSrv.shutdown(ctx)
189
190 go func() {
191 errCh <- gitSrv.serve(ctx)
192 }()
193
194 // Get the current host git commit
195 var commit string
Philip Zeyliger1b47aa22025-04-28 19:25:38 +0000196 if out, err := combinedOutput(ctx, "git", "rev-parse", config.InitialCommit); err != nil {
197 return fmt.Errorf("git rev-parse %s: %w", config.InitialCommit, err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700198 } else {
199 commit = strings.TrimSpace(string(out))
200 }
201 if out, err := combinedOutput(ctx, "git", "config", "http.receivepack", "true"); err != nil {
202 return fmt.Errorf("git config http.receivepack true: %s: %w", out, err)
203 }
204
205 relPath, err := filepath.Rel(gitRoot, config.Path)
206 if err != nil {
207 return err
208 }
209
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700210 config.OutsideHTTP = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s", gitSrv.pass, gitSrv.gitPort)
211 config.GitRemoteUrl = fmt.Sprintf("http://sketch:%s@host.docker.internal:%s/.git", gitSrv.pass, gitSrv.gitPort)
212 config.Commit = commit
213
Earl Lee2e463fb2025-04-17 11:22:22 -0700214 // Create the sketch container
215 if err := createDockerContainer(ctx, cntrName, hostPort, relPath, imgName, config); err != nil {
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +0000216 return fmt.Errorf("failed to create docker container: %w", err)
Earl Lee2e463fb2025-04-17 11:22:22 -0700217 }
218
219 // Copy the sketch linux binary into the container
220 if out, err := combinedOutput(ctx, "docker", "cp", linuxSketchBin, cntrName+":/bin/sketch"); err != nil {
221 return fmt.Errorf("docker cp: %s, %w", out, err)
222 }
Sean McCulloughf5bb3d32025-04-18 10:47:59 -0700223
224 // Make sure that the webui is built so we can copy the results to the container.
225 _, err = webui.Build()
226 if err != nil {
227 return fmt.Errorf("failed to build webui: %w", err)
228 }
229
David Crawshaw8bff16a2025-04-18 01:16:49 -0700230 webuiZipPath, err := webui.ZipPath()
231 if err != nil {
232 return err
233 }
234 if out, err := combinedOutput(ctx, "docker", "cp", webuiZipPath, cntrName+":/root/.cache/sketch/webui/"+filepath.Base(webuiZipPath)); err != nil {
235 return fmt.Errorf("docker cp: %s, %w", out, err)
236 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700237
David Crawshaw53786ef2025-04-24 12:52:51 -0700238 fmt.Printf("📦 running in container %s\n", cntrName)
Earl Lee2e463fb2025-04-17 11:22:22 -0700239
240 // Start the sketch container
241 if out, err := combinedOutput(ctx, "docker", "start", cntrName); err != nil {
242 return fmt.Errorf("docker start: %s, %w", out, err)
243 }
244
245 // Copies structured logs from the container to the host.
246 copyLogs := func() {
247 if config.ContainerLogDest == "" {
248 return
249 }
250 out, err := combinedOutput(ctx, "docker", "logs", cntrName)
251 if err != nil {
252 fmt.Fprintf(os.Stderr, "docker logs failed: %v\n", err)
253 return
254 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700255 prefix := []byte("structured logs:")
256 for line := range bytes.Lines(out) {
257 rest, ok := bytes.CutPrefix(line, prefix)
258 if !ok {
Earl Lee2e463fb2025-04-17 11:22:22 -0700259 continue
260 }
Josh Bleecher Snyder7660e4e2025-04-24 10:34:17 -0700261 logFile := string(bytes.TrimSpace(rest))
Earl Lee2e463fb2025-04-17 11:22:22 -0700262 srcPath := fmt.Sprintf("%s:%s", cntrName, logFile)
263 logFileName := filepath.Base(logFile)
264 dstPath := filepath.Join(config.ContainerLogDest, logFileName)
265 _, err := combinedOutput(ctx, "docker", "cp", srcPath, dstPath)
266 if err != nil {
267 fmt.Fprintf(os.Stderr, "docker cp %s %s failed: %v\n", srcPath, dstPath, err)
268 }
269 fmt.Fprintf(os.Stderr, "\ncopied container log %s to %s\n", srcPath, dstPath)
270 }
271 }
272
273 // NOTE: we want to see what the internal sketch binary prints
274 // regardless of the setting of the verbosity flag on the external
275 // binary, so reading "docker logs", which is the stdout/stderr of
276 // the internal binary is not conditional on the verbose flag.
277 appendInternalErr := func(err error) error {
278 if err == nil {
279 return nil
280 }
281 out, logsErr := combinedOutput(ctx, "docker", "logs", cntrName)
Philip Zeyligerd1402952025-04-23 03:54:37 +0000282 if logsErr != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700283 return fmt.Errorf("%w; and docker logs failed: %s, %v", err, out, logsErr)
284 }
285 out = bytes.TrimSpace(out)
286 if len(out) > 0 {
287 return fmt.Errorf("docker logs: %s;\n%w", out, err)
288 }
289 return err
290 }
291
292 // Get the sketch server port from the container
Sean McCulloughae3480f2025-04-23 15:28:20 -0700293 localAddr, err := getContainerPort(ctx, cntrName, "80")
Earl Lee2e463fb2025-04-17 11:22:22 -0700294 if err != nil {
295 return appendInternalErr(err)
296 }
297
Philip Zeyliger00442412025-05-14 11:03:23 -0700298 if config.Verbose {
299 fmt.Fprintf(os.Stderr, "Host web server: http://%s/\n", localAddr)
300 }
301
Sean McCulloughae3480f2025-04-23 15:28:20 -0700302 localSSHAddr, err := getContainerPort(ctx, cntrName, "22")
303 if err != nil {
304 return appendInternalErr(err)
305 }
306 sshHost, sshPort, err := net.SplitHostPort(localSSHAddr)
307 if err != nil {
David Crawshawb5f6a002025-05-05 08:27:16 -0700308 return appendInternalErr(fmt.Errorf("failed to split ssh host and port: %w", err))
Sean McCulloughae3480f2025-04-23 15:28:20 -0700309 }
Sean McCullough4854c652025-04-24 18:37:02 -0700310
Sean McCullough7013e9e2025-05-14 02:03:58 +0000311 var sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate []byte
Sean McCullough4854c652025-04-24 18:37:02 -0700312
Sean McCullough078e85a2025-05-08 17:28:34 -0700313 cst, err := NewSSHTheater(cntrName, sshHost, sshPort)
314 if err != nil {
315 return appendInternalErr(fmt.Errorf("NewContainerSSHTheather: %w", err))
316 }
317
318 sshErr := CheckSSHReachability(cntrName)
Sean McCullough15c95282025-05-08 16:48:38 -0700319 sshAvailable := false
320 sshErrMsg := ""
321 if sshErr != nil {
322 fmt.Println(sshErr.Error())
323 sshErrMsg = sshErr.Error()
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700324 // continue - ssh config is not required for the rest of sketch to function locally.
325 } else {
Sean McCullough15c95282025-05-08 16:48:38 -0700326 sshAvailable = true
Sean McCulloughea3fc202025-04-28 12:53:37 -0700327 // Note: The vscode: link uses an undocumented request parameter that I really had to dig to find:
328 // https://github.com/microsoft/vscode/blob/2b9486161abaca59b5132ce3c59544f3cc7000f6/src/vs/code/electron-main/app.ts#L878
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700329 fmt.Printf(`Connect to this container via any of these methods:
Sean McCullough4854c652025-04-24 18:37:02 -0700330🖥️ ssh %s
331🖥️ code --remote ssh-remote+root@%s /app -n
Sean McCulloughea3fc202025-04-28 12:53:37 -0700332🔗 vscode://vscode-remote/ssh-remote+root@%s/app?windowId=_blank
Sean McCullough4854c652025-04-24 18:37:02 -0700333`, cntrName, cntrName, cntrName)
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700334 sshUserIdentity = cst.userIdentity
335 sshServerIdentity = cst.serverIdentity
Sean McCullough7013e9e2025-05-14 02:03:58 +0000336
337 // Get the Container CA public key for mutual auth
338 if cst.containerCAPublicKey != nil {
339 containerCAPublicKey = ssh.MarshalAuthorizedKey(cst.containerCAPublicKey)
340 fmt.Println("🔒 SSH Mutual Authentication enabled (container will verify host)")
341 }
342
343 // Get the host certificate for mutual auth
344 hostCertificate = cst.hostCertificate
345
Sean McCulloughf5e28f62025-04-25 10:48:00 -0700346 defer func() {
347 if err := cst.Cleanup(); err != nil {
348 appendInternalErr(err)
349 }
350 }()
351 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700352
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700353 // Tell the sketch container to Init(), which starts the SSH server
354 // and checks out the right commit.
355 // TODO: I'm trying to move as much configuration as possible into the command-line
356 // arguments to avoid splitting them up. "localAddr" is the only difficult one:
357 // we run (effectively) "docker run -p 0:80 image sketch -flags" and you can't
358 // get the port Docker chose until after the process starts. The SSH config is
359 // mostly available ahead of time, but whether it works ("sshAvailable"/"sshErrMsg")
360 // may also empirically need to be done after the SSH server is up and running.
Earl Lee2e463fb2025-04-17 11:22:22 -0700361 go func() {
362 // TODO: Why is this called in a goroutine? I have found that when I pull this out
363 // of the goroutine and call it inline, then the terminal UI clears itself and all
364 // the scrollback (which is not good, but also not fatal). I can't see why it does this
365 // though, since none of the calls in postContainerInitConfig obviously write to stdout
366 // or stderr.
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700367 if err := postContainerInitConfig(ctx, localAddr, sshAvailable, sshErrMsg, sshServerIdentity, sshUserIdentity, containerCAPublicKey, hostCertificate); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700368 slog.ErrorContext(ctx, "LaunchContainer.postContainerInitConfig", slog.String("err", err.Error()))
369 errCh <- appendInternalErr(err)
370 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700371
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700372 // We open the browser after the init config because the above waits for the web server to be serving.
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700373 ps1URL := "http://" + localAddr
374 if config.SkabandAddr != "" {
375 ps1URL = fmt.Sprintf("%s/s/%s", config.SkabandAddr, config.SessionID)
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700376 }
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700377 if config.OpenBrowser {
378 browser.Open(ps1URL)
379 }
380 gitSrv.ps1URL.Store(&ps1URL)
Philip Zeyliger6ed6adb2025-04-23 19:56:38 -0700381 }()
Earl Lee2e463fb2025-04-17 11:22:22 -0700382
383 go func() {
384 cmd := exec.CommandContext(ctx, "docker", "attach", cntrName)
385 cmd.Stdin = os.Stdin
386 cmd.Stdout = os.Stdout
387 cmd.Stderr = os.Stderr
388 errCh <- run(ctx, "docker attach", cmd)
389 }()
390
391 defer copyLogs()
392
393 for {
394 select {
395 case <-ctx.Done():
396 return ctx.Err()
397 case err := <-errCh:
398 if err != nil {
399 return appendInternalErr(fmt.Errorf("container process: %w", err))
400 }
401 return nil
402 }
403 }
404}
405
406func combinedOutput(ctx context.Context, cmdName string, args ...string) ([]byte, error) {
407 cmd := exec.CommandContext(ctx, cmdName, args...)
Earl Lee2e463fb2025-04-17 11:22:22 -0700408 start := time.Now()
409
410 out, err := cmd.CombinedOutput()
411 if err != nil {
David Crawshawc7e77962025-05-03 13:20:18 -0700412 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700413 } else {
David Crawshawc7e77962025-05-03 13:20:18 -0700414 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700415 }
416 return out, err
417}
418
419func run(ctx context.Context, cmdName string, cmd *exec.Cmd) error {
420 start := time.Now()
421 err := cmd.Run()
422 if err != nil {
David Crawshawc7e77962025-05-03 13:20:18 -0700423 slog.ErrorContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700424 } else {
David Crawshawc7e77962025-05-03 13:20:18 -0700425 slog.DebugContext(ctx, cmdName, slog.Duration("elapsed", time.Since(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700426 }
427 return err
428}
429
430type gitServer struct {
431 gitLn net.Listener
432 gitPort string
433 srv *http.Server
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700434 pass string
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700435 ps1URL atomic.Pointer[string]
Earl Lee2e463fb2025-04-17 11:22:22 -0700436}
437
438func (gs *gitServer) shutdown(ctx context.Context) {
439 gs.srv.Shutdown(ctx)
440 gs.gitLn.Close()
441}
442
443// Serve a git remote from the host for the container to fetch from and push to.
444func (gs *gitServer) serve(ctx context.Context) error {
445 slog.DebugContext(ctx, "starting git server", slog.String("git_remote_addr", "http://host.docker.internal:"+gs.gitPort+"/.git"))
446 return gs.srv.Serve(gs.gitLn)
447}
448
449func newGitServer(gitRoot string) (*gitServer, error) {
Josh Bleecher Snyder9f6a9982025-04-22 17:34:15 -0700450 ret := &gitServer{
451 pass: rand.Text(),
452 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700453
Earl Lee2e463fb2025-04-17 11:22:22 -0700454 gitLn, err := net.Listen("tcp4", ":0")
455 if err != nil {
456 return nil, fmt.Errorf("git listen: %w", err)
457 }
458 ret.gitLn = gitLn
459
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700460 browserC := make(chan bool, 1) // channel of browser open requests
461
Josh Bleecher Snyder3e2111b2025-04-30 17:53:28 +0000462 go func() {
Josh Bleecher Snyder99570462025-05-05 10:26:14 -0700463 for range browserC {
464 browser.Open(*ret.ps1URL.Load())
Josh Bleecher Snyder3e2111b2025-04-30 17:53:28 +0000465 }
466 }()
467
468 srv := http.Server{Handler: &gitHTTP{gitRepoRoot: gitRoot, pass: []byte(ret.pass), browserC: browserC}}
Earl Lee2e463fb2025-04-17 11:22:22 -0700469 ret.srv = &srv
470
471 _, gitPort, err := net.SplitHostPort(gitLn.Addr().String())
472 if err != nil {
473 return nil, fmt.Errorf("git port: %w", err)
474 }
475 ret.gitPort = gitPort
476 return ret, nil
477}
478
479func createDockerContainer(ctx context.Context, cntrName, hostPort, relPath, imgName string, config ContainerConfig) error {
David Crawshaw69c67312025-04-17 13:42:00 -0700480 cmdArgs := []string{
481 "create",
David Crawshaw66cf74e2025-05-05 08:48:39 -0700482 "-i",
Earl Lee2e463fb2025-04-17 11:22:22 -0700483 "--name", cntrName,
484 "-p", hostPort + ":80", // forward container port 80 to a host port
David Crawshaw3659d872025-05-05 17:52:23 -0700485 "-e", "SKETCH_MODEL_API_KEY=" + config.ModelAPIKey,
Earl Lee2e463fb2025-04-17 11:22:22 -0700486 }
Philip Zeyliger3d2eff02025-05-27 09:30:31 -0700487 if !(config.OneShot || !config.TermUI) {
David Crawshaw66cf74e2025-05-05 08:48:39 -0700488 cmdArgs = append(cmdArgs, "-t")
489 }
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +0000490
491 for _, envVar := range getEnvForwardingFromGitConfig(ctx) {
492 cmdArgs = append(cmdArgs, "-e", envVar)
493 }
David Crawshaw5a7b3692025-05-05 16:49:15 -0700494 if config.ModelURL != "" {
David Crawshaw3659d872025-05-05 17:52:23 -0700495 cmdArgs = append(cmdArgs, "-e", "SKETCH_MODEL_URL="+config.ModelURL)
Earl Lee2e463fb2025-04-17 11:22:22 -0700496 }
497 if config.SketchPubKey != "" {
498 cmdArgs = append(cmdArgs, "-e", "SKETCH_PUB_KEY="+config.SketchPubKey)
499 }
Sean McCulloughae3480f2025-04-23 15:28:20 -0700500 if config.SSHPort > 0 {
501 cmdArgs = append(cmdArgs, "-p", fmt.Sprintf("%d:22", config.SSHPort)) // forward container ssh port to host ssh port
502 } else {
Philip Zeyliger87d29ef2025-05-16 20:25:28 -0700503 cmdArgs = append(cmdArgs, "-p", "0:22") // use an ephemeral host port for ssh.
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700504 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700505 if relPath != "." {
506 cmdArgs = append(cmdArgs, "-w", "/app/"+relPath)
507 }
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700508 // colima does this by default, but Linux docker seems to need this set explicitly
509 cmdArgs = append(cmdArgs, "--add-host", "host.docker.internal:host-gateway")
Josh Bleecher Snyderac761c92025-05-16 18:58:45 +0000510
511 // Add volume mounts if specified
512 for _, mount := range config.Mounts {
513 if mount != "" {
514 cmdArgs = append(cmdArgs, "-v", mount)
515 }
516 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700517 cmdArgs = append(
518 cmdArgs,
519 imgName,
520 "/bin/sketch",
521 "-unsafe",
522 "-addr=:80",
523 "-session-id="+config.SessionID,
Philip Zeyligerd1402952025-04-23 03:54:37 +0000524 "-git-username="+config.GitUsername,
525 "-git-email="+config.GitEmail,
Philip Zeyliger18532b22025-04-23 21:11:46 +0000526 "-outside-hostname="+config.OutsideHostname,
527 "-outside-os="+config.OutsideOS,
528 "-outside-working-dir="+config.OutsideWorkingDir,
Josh Bleecher Snyder3cae7d92025-04-30 09:54:29 -0700529 "-open=false",
Philip Zeyliger613c0f52025-05-15 16:36:22 -0700530 "-termui="+fmt.Sprintf("%t", config.TermUI),
Philip Zeyligercabfa552025-05-19 16:14:28 -0700531 "-verbose="+fmt.Sprintf("%t", config.Verbose),
Josh Bleecher Snyderb1cca6f2025-05-06 01:52:55 +0000532 "-x="+config.ExperimentFlag,
Earl Lee2e463fb2025-04-17 11:22:22 -0700533 )
David Crawshaw5a7b3692025-05-05 16:49:15 -0700534 if config.Model != "" {
535 cmdArgs = append(cmdArgs, "-model="+config.Model)
536 }
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700537 if config.GitRemoteUrl != "" {
538 cmdArgs = append(cmdArgs, "-git-remote-url="+config.GitRemoteUrl)
539 if config.Commit == "" {
540 panic("Commit should have been set when GitRemoteUrl was set")
541 }
542 cmdArgs = append(cmdArgs, "-commit="+config.Commit)
543 }
544 if config.OutsideHTTP != "" {
545 cmdArgs = append(cmdArgs, "-outside-http="+config.OutsideHTTP)
546 }
Josh Bleecher Snydere3c2f222025-05-15 20:54:52 +0000547 cmdArgs = append(cmdArgs, "-skaband-addr="+config.SkabandAddr)
Pokey Rule0dcebe12025-04-28 14:51:04 +0100548 if config.Prompt != "" {
549 cmdArgs = append(cmdArgs, "-prompt", config.Prompt)
550 }
551 if config.OneShot {
552 cmdArgs = append(cmdArgs, "-one-shot")
Philip Zeyligerb74c4f62025-04-25 19:18:49 -0700553 }
Josh Bleecher Snydere3c2f222025-05-15 20:54:52 +0000554 if config.ModelURL == "" {
555 // Forward ANTHROPIC_API_KEY for direct use.
556 // TODO: have outtie run an http proxy?
557 // TODO: select and forward the relevant API key based on the model
558 cmdArgs = append(cmdArgs, "-llm-api-key="+os.Getenv("ANTHROPIC_API_KEY"))
559 }
Philip Zeyliger1dc21372025-05-05 19:54:44 +0000560
561 // Add additional docker arguments if provided
562 if config.DockerArgs != "" {
563 // Parse space-separated docker arguments with support for quotes and escaping
564 args := parseDockerArgs(config.DockerArgs)
565 // Insert arguments after "create" but before other arguments
566 for i := len(args) - 1; i >= 0; i-- {
567 cmdArgs = append(cmdArgs[:1], append([]string{args[i]}, cmdArgs[1:]...)...)
568 }
569 }
570
Earl Lee2e463fb2025-04-17 11:22:22 -0700571 if out, err := combinedOutput(ctx, "docker", cmdArgs...); err != nil {
572 return fmt.Errorf("docker create: %s, %w", out, err)
573 }
574 return nil
575}
576
David Crawshawb5f6a002025-05-05 08:27:16 -0700577func buildLinuxSketchBin(ctx context.Context) (string, error) {
Philip Zeyliger4acf0062025-05-22 13:53:46 -0700578 // Detect if race detector is enabled and use a different cache path
579 raceEnabled := RaceEnabled()
580 cacheSuffix := ""
581 if raceEnabled {
582 cacheSuffix = "-race"
583 }
584
585 homeDir, err := os.UserHomeDir()
586 if err != nil {
587 return "", err
588 }
589
590 linuxGopath := filepath.Join(homeDir, ".cache", "sketch", "linuxgo"+cacheSuffix)
591 if err := os.MkdirAll(linuxGopath, 0o777); err != nil {
592 return "", err
593 }
594
595 // When race detector is enabled, use Docker to build the Linux binary
596 if raceEnabled {
597 return buildLinuxSketchBinWithDocker(ctx, linuxGopath)
598 }
599
600 // Standard non-race build using cross-compilation
Pokey Rulea9a786b2025-05-12 10:52:34 +0100601 // Change to directory containing dockerimg.go for module detection
602 _, codeFile, _, _ := runtime.Caller(0)
603 codeDir := filepath.Dir(codeFile)
604 if currentDir, err := os.Getwd(); err != nil {
605 slog.WarnContext(ctx, "could not get current directory", "err", err)
606 } else {
607 if err := os.Chdir(codeDir); err != nil {
608 slog.WarnContext(ctx, "could not change to code directory for module check", "err", err)
609 } else {
610 defer func() {
611 _ = os.Chdir(currentDir)
612 }()
613 }
614 }
615
David Crawshaw8a617cb2025-04-18 01:28:43 -0700616 verToInstall := "@latest"
617 if out, err := exec.Command("go", "list", "-m").CombinedOutput(); err != nil {
618 return "", fmt.Errorf("failed to run go list -m: %s: %v", out, err)
619 } else {
620 if strings.TrimSpace(string(out)) == "sketch.dev" {
David Crawshaw094e4d22025-04-24 11:35:14 -0700621 slog.DebugContext(ctx, "built linux agent from currently checked out module")
David Crawshaw8a617cb2025-04-18 01:28:43 -0700622 verToInstall = ""
623 }
624 }
David Crawshaw69c67312025-04-17 13:42:00 -0700625
Earl Lee2e463fb2025-04-17 11:22:22 -0700626 start := time.Now()
Philip Zeyliger4acf0062025-05-22 13:53:46 -0700627 args := []string{"install"}
628 args = append(args, "sketch.dev/cmd/sketch"+verToInstall)
629
630 cmd := exec.CommandContext(ctx, "go", args...)
David Crawshawb9eaef52025-04-17 15:23:18 -0700631 cmd.Env = append(
632 os.Environ(),
633 "GOOS=linux",
634 "CGO_ENABLED=0",
635 "GOTOOLCHAIN=auto",
David Crawshaw8a617cb2025-04-18 01:28:43 -0700636 "GOPATH="+linuxGopath,
Josh Bleecher Snyderfae17572025-04-21 11:48:05 -0700637 "GOBIN=",
David Crawshawb9eaef52025-04-17 15:23:18 -0700638 )
Earl Lee2e463fb2025-04-17 11:22:22 -0700639
Earl Lee2e463fb2025-04-17 11:22:22 -0700640 out, err := cmd.CombinedOutput()
641 if err != nil {
David Crawshawc7e77962025-05-03 13:20:18 -0700642 slog.ErrorContext(ctx, "go", slog.Duration("elapsed", time.Since(start)), slog.String("err", err.Error()), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700643 return "", fmt.Errorf("failed to build linux sketch binary: %s: %w", out, err)
644 } else {
David Crawshawc7e77962025-05-03 13:20:18 -0700645 slog.DebugContext(ctx, "go", slog.Duration("elapsed", time.Since(start)), slog.String("path", cmd.Path), slog.String("args", fmt.Sprintf("%v", skribe.Redact(cmd.Args))))
Earl Lee2e463fb2025-04-17 11:22:22 -0700646 }
647
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700648 if runtime.GOOS != "linux" {
David Crawshawc7e77962025-05-03 13:20:18 -0700649 return filepath.Join(linuxGopath, "bin", "linux_"+runtime.GOARCH, "sketch"), nil
Philip Zeyliger5e227dd2025-04-21 15:55:29 -0700650 }
David Crawshawc7e77962025-05-03 13:20:18 -0700651 // If we are already on Linux, there's no extra platform name in the path
652 return filepath.Join(linuxGopath, "bin", "sketch"), nil
Earl Lee2e463fb2025-04-17 11:22:22 -0700653}
654
Sean McCulloughae3480f2025-04-23 15:28:20 -0700655func getContainerPort(ctx context.Context, cntrName, cntrPort string) (string, error) {
Earl Lee2e463fb2025-04-17 11:22:22 -0700656 localAddr := ""
Sean McCulloughae3480f2025-04-23 15:28:20 -0700657 if out, err := combinedOutput(ctx, "docker", "port", cntrName, cntrPort); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700658 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
659 } else {
660 v4, _, found := strings.Cut(string(out), "\n")
661 if !found {
662 return "", fmt.Errorf("failed to find container port: %s: %v", out, err)
663 }
664 localAddr = v4
665 if strings.HasPrefix(localAddr, "0.0.0.0") {
666 localAddr = "127.0.0.1" + strings.TrimPrefix(localAddr, "0.0.0.0")
667 }
668 }
669 return localAddr, nil
670}
671
672// Contact the container and configure it.
Philip Zeyligerbc8c8dc2025-05-21 13:19:13 -0700673func postContainerInitConfig(ctx context.Context, localAddr string, sshAvailable bool, sshError string, sshServerIdentity, sshAuthorizedKeys, sshContainerCAKey, sshHostCertificate []byte) error {
Earl Lee2e463fb2025-04-17 11:22:22 -0700674 localURL := "http://" + localAddr
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700675
676 initMsg, err := json.Marshal(
677 server.InitRequest{
Sean McCullough7013e9e2025-05-14 02:03:58 +0000678 HostAddr: localAddr,
679 SSHAuthorizedKeys: sshAuthorizedKeys,
680 SSHServerIdentity: sshServerIdentity,
681 SSHContainerCAKey: sshContainerCAKey,
682 SSHHostCertificate: sshHostCertificate,
683 SSHAvailable: sshAvailable,
684 SSHError: sshError,
Sean McCulloughbaa2b592025-04-23 10:40:08 -0700685 })
Earl Lee2e463fb2025-04-17 11:22:22 -0700686 if err != nil {
687 return fmt.Errorf("init msg: %w", err)
688 }
689
Earl Lee2e463fb2025-04-17 11:22:22 -0700690 // Note: this /init POST is handled in loop/server/loophttp.go:
691 initMsgByteReader := bytes.NewReader(initMsg)
692 req, err := http.NewRequest("POST", localURL+"/init", initMsgByteReader)
693 if err != nil {
694 return err
695 }
696
697 var res *http.Response
698 for i := 0; ; i++ {
699 time.Sleep(100 * time.Millisecond)
700 // If you DON'T reset this byteReader, then subsequent retries may end up sending 0 bytes.
701 initMsgByteReader.Reset(initMsg)
702 res, err = http.DefaultClient.Do(req)
703 if err != nil {
David Crawshaw99231ba2025-05-03 10:48:26 -0700704 if i < 100 {
705 if i%10 == 0 {
706 slog.DebugContext(ctx, "postContainerInitConfig retrying", slog.Int("retry", i), slog.String("err", err.Error()))
707 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700708 continue
709 }
710 return fmt.Errorf("failed to %s/init sketch in container, NOT retrying: err: %v", localURL, err)
711 }
712 break
713 }
714 resBytes, _ := io.ReadAll(res.Body)
715 if res.StatusCode != http.StatusOK {
716 return fmt.Errorf("failed to initialize sketch in container, response status code %d: %s", res.StatusCode, resBytes)
717 }
718 return nil
719}
720
David Crawshaw5a7b3692025-05-05 16:49:15 -0700721func findOrBuildDockerImage(ctx context.Context, cwd, gitRoot, model, modelURL, modelAPIKey string, forceRebuild, verbose bool) (imgName string, err error) {
Earl Lee2e463fb2025-04-17 11:22:22 -0700722 h := sha256.Sum256([]byte(gitRoot))
723 imgName = "sketch-" + hex.EncodeToString(h[:6])
724
725 var curImgInitFilesHash string
726 if out, err := combinedOutput(ctx, "docker", "inspect", "--format", "{{json .Config.Labels}}", imgName); err != nil {
727 if strings.Contains(string(out), "No such object") {
728 // Image does not exist, continue and build it.
729 curImgInitFilesHash = ""
730 } else {
731 return "", fmt.Errorf("docker inspect failed: %s, %v", out, err)
732 }
733 } else {
734 m := map[string]string{}
735 if err := json.Unmarshal(bytes.TrimSpace(out), &m); err != nil {
736 return "", fmt.Errorf("docker inspect output unparsable: %s, %v", out, err)
737 }
738 curImgInitFilesHash = m["sketch_context"]
739 }
740
741 candidates, err := findRepoDockerfiles(cwd, gitRoot)
742 if err != nil {
743 return "", fmt.Errorf("find dockerfile: %w", err)
744 }
745
746 var initFiles map[string]string
747 var dockerfilePath string
David Crawshawff2df6a2025-05-12 14:45:29 -0700748 var generatedDockerfile string
Earl Lee2e463fb2025-04-17 11:22:22 -0700749
750 // TODO: prefer a "Dockerfile.sketch" so users can tailor any env to this tool.
751 if len(candidates) == 1 && strings.ToLower(filepath.Base(candidates[0])) == "dockerfile" {
752 dockerfilePath = candidates[0]
753 contents, err := os.ReadFile(dockerfilePath)
754 if err != nil {
755 return "", err
756 }
757 fmt.Printf("using %s as dev env\n", candidates[0])
758 if hashInitFiles(map[string]string{dockerfilePath: string(contents)}) == curImgInitFilesHash && !forceRebuild {
Earl Lee2e463fb2025-04-17 11:22:22 -0700759 return imgName, nil
760 }
761 } else {
762 initFiles, err = readInitFiles(os.DirFS(gitRoot))
763 if err != nil {
764 return "", err
765 }
766 subPathWorkingDir, err := filepath.Rel(gitRoot, cwd)
767 if err != nil {
768 return "", err
769 }
770 initFileHash := hashInitFiles(initFiles)
771 if curImgInitFilesHash == initFileHash && !forceRebuild {
Earl Lee2e463fb2025-04-17 11:22:22 -0700772 return imgName, nil
773 }
774
David Crawshaw5a7b3692025-05-05 16:49:15 -0700775 if model == "gemini" {
776 if strings.HasSuffix(modelURL, "/gemmsgs") {
777 // Horrible hack! Switch back to anthropic for container building.
David Crawshaw3659d872025-05-05 17:52:23 -0700778 // We can do this because we are talking to skaband and know the address.
David Crawshaw5a7b3692025-05-05 16:49:15 -0700779 modelURL = strings.Replace(modelURL, "/gemmsgs", "/antmsgs", 1)
780 } else {
781 return "", fmt.Errorf("building docker image with gemini model is not supported yet; start with -model=anthropic first then use gemini")
782 }
783 }
784
Earl Lee2e463fb2025-04-17 11:22:22 -0700785 start := time.Now()
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700786 srv := &ant.Service{
David Crawshaw5a7b3692025-05-05 16:49:15 -0700787 URL: modelURL,
788 APIKey: modelAPIKey,
Josh Bleecher Snyder4f84ab72025-04-22 16:40:54 -0700789 HTTPC: http.DefaultClient,
790 }
Pokey Rulec31e2962025-05-13 10:53:33 +0000791 generatedDockerfile, err = createDockerfile(ctx, srv, initFiles, subPathWorkingDir, verbose)
Earl Lee2e463fb2025-04-17 11:22:22 -0700792 if err != nil {
793 return "", fmt.Errorf("create dockerfile: %w", err)
794 }
Josh Bleecher Snyder7c58b022025-05-14 17:30:39 +0000795 // Create a unique temporary directory for the Dockerfile
796 tmpDir, err := os.MkdirTemp("", "sketch-docker-*")
797 if err != nil {
798 return "", fmt.Errorf("failed to create temporary directory: %w", err)
799 }
800 dockerfilePath = filepath.Join(tmpDir, tmpSketchDockerfile)
David Crawshawff2df6a2025-05-12 14:45:29 -0700801 if err := os.WriteFile(dockerfilePath, []byte(generatedDockerfile), 0o666); err != nil {
Earl Lee2e463fb2025-04-17 11:22:22 -0700802 return "", err
803 }
Josh Bleecher Snyder7c58b022025-05-14 17:30:39 +0000804 // Remove the temporary directory and all contents when done
805 defer os.RemoveAll(tmpDir)
Earl Lee2e463fb2025-04-17 11:22:22 -0700806
David Crawshawb5f6a002025-05-05 08:27:16 -0700807 if verbose {
David Crawshawff2df6a2025-05-12 14:45:29 -0700808 fmt.Fprintf(os.Stderr, "generated Dockerfile in %s:\n\t%s\n\n", time.Since(start).Round(time.Millisecond), strings.Replace(generatedDockerfile, "\n", "\n\t", -1))
David Crawshawb5f6a002025-05-05 08:27:16 -0700809 }
Earl Lee2e463fb2025-04-17 11:22:22 -0700810 }
811
812 var gitUserEmail, gitUserName string
813 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.email"); err != nil {
814 return "", fmt.Errorf("git config: %s: %v", out, err)
815 } else {
816 gitUserEmail = strings.TrimSpace(string(out))
817 }
818 if out, err := combinedOutput(ctx, "git", "config", "--get", "user.name"); err != nil {
819 return "", fmt.Errorf("git config: %s: %v", out, err)
820 } else {
821 gitUserName = strings.TrimSpace(string(out))
822 }
823
824 start := time.Now()
825 cmd := exec.CommandContext(ctx,
826 "docker", "build",
827 "-t", imgName,
828 "-f", dockerfilePath,
829 "--build-arg", "GIT_USER_EMAIL="+gitUserEmail,
830 "--build-arg", "GIT_USER_NAME="+gitUserName,
David Crawshaw31f15242025-05-06 16:03:49 -0700831 ".",
Earl Lee2e463fb2025-04-17 11:22:22 -0700832 )
David Crawshawb5f6a002025-05-05 08:27:16 -0700833 cmd.Dir = gitRoot
David Crawshaw31f15242025-05-06 16:03:49 -0700834 // We print the docker build output whether or not the user
835 // has selected --verbose. Building an image takes a while
836 // and this gives good context.
David Crawshawb5f6a002025-05-05 08:27:16 -0700837 cmd.Stdout = os.Stdout
838 cmd.Stderr = os.Stderr
839 fmt.Printf("🏗️ building docker image %s... (use -verbose to see build output)\n", imgName)
Earl Lee2e463fb2025-04-17 11:22:22 -0700840
841 err = run(ctx, "docker build", cmd)
842 if err != nil {
David Crawshawff2df6a2025-05-12 14:45:29 -0700843 var msg string
844 if generatedDockerfile != "" {
845 if !verbose {
846 fmt.Fprintf(os.Stderr, "Generated Dockerfile:\n\t%s\n\n", strings.Replace(generatedDockerfile, "\n", "\n\t", -1))
847 }
848 msg = fmt.Sprintf("\n\nThe generated Dockerfile failed to build.\nYou can override it by committing a Dockerfile to your project.")
849 }
850 return "", fmt.Errorf("docker build failed: %v%s", err, msg)
Earl Lee2e463fb2025-04-17 11:22:22 -0700851 }
852 fmt.Printf("built docker image %s in %s\n", imgName, time.Since(start).Round(time.Millisecond))
853 return imgName, nil
854}
855
856func findRepoDockerfiles(cwd, gitRoot string) ([]string, error) {
857 files, err := findDirDockerfiles(cwd)
858 if err != nil {
859 return nil, err
860 }
861 if len(files) > 0 {
862 return files, nil
863 }
864
865 path := cwd
866 for path != gitRoot {
867 path = filepath.Dir(path)
868 files, err := findDirDockerfiles(path)
869 if err != nil {
870 return nil, err
871 }
872 if len(files) > 0 {
873 return files, nil
874 }
875 }
876 return files, nil
877}
878
879// findDirDockerfiles finds all "Dockerfile*" files in a directory.
880func findDirDockerfiles(root string) (res []string, err error) {
881 err = filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
882 if err != nil {
883 return err
884 }
885 if info.IsDir() && root != path {
886 return filepath.SkipDir
887 }
888 name := strings.ToLower(info.Name())
889 if name == "dockerfile" || strings.HasPrefix(name, "dockerfile.") {
890 res = append(res, path)
891 }
892 return nil
893 })
894 if err != nil {
895 return nil, err
896 }
897 return res, nil
898}
899
Philip Zeyligerd6d12d12025-05-19 19:19:21 -0700900func checkForEmptyGitRepo(ctx context.Context, path string) error {
901 cmd := exec.CommandContext(ctx, "git", "rev-parse", "-q", "--verify", "HEAD")
902 cmd.Dir = path
903 _, err := cmd.CombinedOutput()
904 if err != nil {
905 return fmt.Errorf("sketch needs to run from within a git repo with at least one commit.\nRun: %s",
906 "git commit --allow-empty -m 'initial commit'")
907 }
908 return nil
909}
910
Earl Lee2e463fb2025-04-17 11:22:22 -0700911func findGitRoot(ctx context.Context, path string) (string, error) {
912 cmd := exec.CommandContext(ctx, "git", "rev-parse", "--git-common-dir")
913 cmd.Dir = path
914 out, err := cmd.CombinedOutput()
915 if err != nil {
916 if strings.Contains(string(out), "not a git repository") {
917 return "", fmt.Errorf(`sketch needs to run from within a git repo, but %s is not part of a git repo.
918Consider one of the following options:
919 - cd to a different dir that is already part of a git repo first, or
920 - to create a new git repo from this directory (%s), run this command:
921
922 git init . && git commit --allow-empty -m "initial commit"
923
924and try running sketch again.
925`, path, path)
926 }
927 return "", fmt.Errorf("git rev-parse --git-common-dir: %s: %w", out, err)
928 }
929 gitDir := strings.TrimSpace(string(out)) // location of .git dir, often as a relative path
930 absGitDir := filepath.Join(path, gitDir)
931 return filepath.Dir(absGitDir), err
932}
933
Josh Bleecher Snyder2772f632025-05-01 21:42:35 +0000934// getEnvForwardingFromGitConfig retrieves environment variables to pass through to Docker
935// from git config using the sketch.envfwd multi-valued key.
936func getEnvForwardingFromGitConfig(ctx context.Context) []string {
937 outb, err := exec.CommandContext(ctx, "git", "config", "--get-all", "sketch.envfwd").CombinedOutput()
938 out := string(outb)
939 if err != nil {
940 if strings.Contains(out, "key does not exist") {
941 return nil
942 }
943 slog.ErrorContext(ctx, "failed to get sketch.envfwd from git config", "err", err, "output", out)
944 return nil
945 }
946
947 var envVars []string
948 for envVar := range strings.Lines(out) {
949 envVar = strings.TrimSpace(envVar)
950 if envVar == "" {
951 continue
952 }
953 envVars = append(envVars, envVar+"="+os.Getenv(envVar))
954 }
955 return envVars
956}
Philip Zeyliger1dc21372025-05-05 19:54:44 +0000957
958// parseDockerArgs parses a string containing space-separated Docker arguments into an array of strings.
959// It handles quoted arguments and escaped characters.
960//
961// Examples:
962//
963// --memory=2g --cpus=2 -> ["--memory=2g", "--cpus=2"]
964// --label="my label" --env=FOO=bar -> ["--label=my label", "--env=FOO=bar"]
965// --env="KEY=\"quoted value\"" -> ["--env=KEY=\"quoted value\""]
966func parseDockerArgs(args string) []string {
967 if args = strings.TrimSpace(args); args == "" {
968 return []string{}
969 }
970
971 var result []string
972 var current strings.Builder
973 inQuotes := false
974 escapeNext := false
975 quoteChar := rune(0)
976
977 for _, char := range args {
978 if escapeNext {
979 current.WriteRune(char)
980 escapeNext = false
981 continue
982 }
983
984 if char == '\\' {
985 escapeNext = true
986 continue
987 }
988
989 if char == '"' || char == '\'' {
990 if !inQuotes {
991 inQuotes = true
992 quoteChar = char
993 continue
994 } else if char == quoteChar {
995 inQuotes = false
996 quoteChar = rune(0)
997 continue
998 }
999 // Non-matching quote character inside quotes
1000 current.WriteRune(char)
1001 continue
1002 }
1003
1004 // Space outside of quotes is an argument separator
1005 if char == ' ' && !inQuotes {
1006 if current.Len() > 0 {
1007 result = append(result, current.String())
1008 current.Reset()
1009 }
1010 continue
1011 }
1012
1013 current.WriteRune(char)
1014 }
1015
1016 // Add the last argument if there is one
1017 if current.Len() > 0 {
1018 result = append(result, current.String())
1019 }
1020
1021 return result
1022}
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001023
1024// buildLinuxSketchBinWithDocker builds the Linux sketch binary using Docker when race detector is enabled.
1025// This avoids cross-compilation issues with CGO which is required for the race detector.
Josh Bleecher Snyder3e6a4c42025-05-23 17:29:57 +00001026// Mounts host Go module cache and build cache for faster subsequent builds.
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001027func buildLinuxSketchBinWithDocker(ctx context.Context, linuxGopath string) (string, error) {
1028 // Find the git repo root
1029 currentDir, err := os.Getwd()
1030 if err != nil {
1031 return "", fmt.Errorf("could not get current directory: %w", err)
1032 }
1033
1034 gitRoot, err := findGitRoot(ctx, currentDir)
1035 if err != nil {
1036 return "", fmt.Errorf("could not find git root, cannot build with race detector outside a git repo: %w", err)
1037 }
1038
Josh Bleecher Snyder3e6a4c42025-05-23 17:29:57 +00001039 // Get host Go cache directories to mount for faster builds
1040 goCacheDir, err := getHostGoCacheDir(ctx)
1041 if err != nil {
1042 return "", fmt.Errorf("failed to get host GOCACHE: %w", err)
1043 }
1044 goModCacheDir, err := getHostGoModCacheDir(ctx)
1045 if err != nil {
1046 return "", fmt.Errorf("failed to get host GOMODCACHE: %w", err)
1047 }
1048
1049 slog.DebugContext(ctx, "building Linux sketch binary with race detector using Docker", "git_root", gitRoot, "gocache", goCacheDir, "gomodcache", goModCacheDir)
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001050
1051 // Use the published Docker image tag
1052 imageTag := dockerfileBaseHash()
1053 imgName := fmt.Sprintf("%s:%s", dockerImgName, imageTag)
1054
1055 // Create destination directory for the binary
1056 destPath := filepath.Join(linuxGopath, "bin")
1057 if err := os.MkdirAll(destPath, 0o777); err != nil {
1058 return "", fmt.Errorf("failed to create destination directory: %w", err)
1059 }
1060 destFile := filepath.Join(destPath, "sketch")
1061
1062 // Create a unique container name
1063 containerID := fmt.Sprintf("sketch-race-build-%d", time.Now().UnixNano())
1064
Josh Bleecher Snyder3e6a4c42025-05-23 17:29:57 +00001065 // Run a container with the repo mounted and Go caches for faster builds
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001066 start := time.Now()
1067 slog.DebugContext(ctx, "running Docker container to build sketch with race detector")
1068
1069 // Use explicit output path for clarity
1070 runArgs := []string{
1071 "run",
1072 "--name", containerID,
1073 "-v", gitRoot + ":/app",
Josh Bleecher Snyder3e6a4c42025-05-23 17:29:57 +00001074 "-v", goCacheDir + ":/root/.cache/go-build",
1075 "-v", goModCacheDir + ":/go/pkg/mod",
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001076 "-w", "/app",
1077 imgName,
Josh Bleecher Snyderf4f929a2025-05-23 17:19:26 +00001078 "sh", "-c", "cd /app && mkdir -p /tmp/sketch-out && go build -buildvcs=false -race -o /tmp/sketch-out/sketch sketch.dev/cmd/sketch",
Philip Zeyliger4acf0062025-05-22 13:53:46 -07001079 }
1080
1081 out, err := combinedOutput(ctx, "docker", runArgs...)
1082 if err != nil {
1083 // Print the output to help with debugging
1084 slog.ErrorContext(ctx, "docker run for race build failed",
1085 slog.String("output", string(out)),
1086 slog.String("error", err.Error()))
1087 return "", fmt.Errorf("docker run failed: %s: %w", out, err)
1088 }
1089
1090 slog.DebugContext(ctx, "built sketch with race detector in Docker", "elapsed", time.Since(start))
1091
1092 // Copy the binary from the container using the explicit path
1093 out, err = combinedOutput(ctx, "docker", "cp", containerID+":/tmp/sketch-out/sketch", destFile)
1094 if err != nil {
1095 return "", fmt.Errorf("docker cp failed: %s: %w", out, err)
1096 }
1097
1098 // Clean up the container
1099 if out, err := combinedOutput(ctx, "docker", "rm", containerID); err != nil {
1100 slog.WarnContext(ctx, "failed to remove container", "container", containerID, "error", err, "output", string(out))
1101 }
1102
1103 // Make the binary executable
1104 if err := os.Chmod(destFile, 0o755); err != nil {
1105 return "", fmt.Errorf("failed to make binary executable: %w", err)
1106 }
1107
1108 return destFile, nil
1109}
Josh Bleecher Snyder3e6a4c42025-05-23 17:29:57 +00001110
1111// getHostGoCacheDir returns the host's GOCACHE directory
1112func getHostGoCacheDir(ctx context.Context) (string, error) {
1113 out, err := exec.CommandContext(ctx, "go", "env", "GOCACHE").CombinedOutput()
1114 if err != nil {
1115 return "", fmt.Errorf("failed to get GOCACHE: %s: %w", out, err)
1116 }
1117 return strings.TrimSpace(string(out)), nil
1118}
1119
1120// getHostGoModCacheDir returns the host's GOMODCACHE directory
1121func getHostGoModCacheDir(ctx context.Context) (string, error) {
1122 out, err := exec.CommandContext(ctx, "go", "env", "GOMODCACHE").CombinedOutput()
1123 if err != nil {
1124 return "", fmt.Errorf("failed to get GOMODCACHE: %s: %w", out, err)
1125 }
1126 return strings.TrimSpace(string(out)), nil
1127}