~james/core

core/spindle/engines/microvm/debug_e2e_test.go -rw-r--r-- 8.0 KiB
452f17b7 — james chore(import): snapshot james.dad.town/core at f70c71c7696a 16 hours ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
//go:build linux

package microvm

import (
	"bytes"
	"context"
	"crypto/ed25519"
	"crypto/rand"
	"encoding/pem"
	"fmt"
	"io"
	"log/slog"
	"net"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"testing"
	"time"

	gliderssh "github.com/gliderlabs/ssh"
	gossh "golang.org/x/crypto/ssh"
	agentv1 "tangled.org/core/spindle/agentproto/gen"
	"tangled.org/core/spindle/models"
)

func TestDebugShellStaysOpenWhileIdleE2E(t *testing.T) {
	imageSpecPath := os.Getenv("SPINDLE_E2E_IMAGE_SPEC")
	if imageSpecPath == "" {
		t.Skip("SPINDLE_E2E_IMAGE_SPEC is not set")
	}

	ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
	defer cancel()

	imageSpec, err := LoadImageSpec(imageSpecPath)
	if err != nil {
		t.Fatal(err)
	}

	agentListener, agentPort, err := listenRandomVsockPort(ctx)
	if err != nil {
		t.Fatal(err)
	}
	defer agentListener.Close()
	imageSpec.BootArgs = fmt.Sprintf("%s shuttle.vsock_port=%d", imageSpec.BootArgs, agentPort)

	workDir, err := os.MkdirTemp("/tmp", "spindle-debug-e2e-")
	if err != nil {
		t.Fatal(err)
	}
	defer os.RemoveAll(workDir)

	logger := slog.Default()
	vm, err := StartVM(ctx, VMConfig{
		Image:       imageSpec,
		BootTimeout: 30 * time.Second,
		EnableKVM:   true,
		WorkDir:     workDir,
		Dev:         true,
	}, logger)
	if err != nil {
		t.Fatal(err)
	}
	defer vm.Close()

	conn, err := acceptWithTimeout(ctx, &cidFilteredVsockListener{
		Listener: agentListener,
		cid:      vm.CID(),
		logger:   logger,
	}, 60*time.Second)
	if err != nil {
		t.Fatal(err)
	}
	defer conn.Close()

	agent := NewAgentSession(conn, vm.CID(), logger)
	if err := agent.Init(ctx, &agentv1.Init{JobId: "debug-idle-e2e"}); err != nil {
		t.Fatal(err)
	}

	failedStep := &agentv1.ExecStart{
		Argv: []string{
			"/run/current-system/sw/bin/bash",
			"-lc",
			"exit 37",
		},
		Env: []string{
			"HOME=/workspace",
			"LOGNAME=spindle-workflow",
			"PATH=/run/current-system/sw/bin:/usr/bin:/bin",
			"USER=spindle-workflow",
			"CI=true",
			"WF_ONLY=workflow",
			"STEP_ONLY=step",
			"OVERRIDE=step",
		},
		Cwd:  "/workspace/repo",
		User: "spindle-workflow",
	}
	if exitCode, err := agent.Exec(ctx, AgentExec{
		ID:        "failed-step",
		ExecStart: failedStep,
		Stdout:    io.Discard,
		Stderr:    io.Discard,
	}); err != nil || exitCode != 37 {
		t.Fatalf("failed step: exit code %d, error %v", exitCode, err)
	}
	if failedStep.TimeoutSeconds == 0 {
		t.Fatal("AgentSession.Exec did not retain the effective step timeout")
	}

	wid := models.WorkflowId{
		PipelineId: models.PipelineId("pipeline"),
		Name:       "debug-idle-e2e.yml",
	}
	engine := &Engine{l: logger, debug: make(map[string]debugTarget)}
	engine.registerDebugTarget(wid, debugTarget{
		cid:       vm.CID(),
		agent:     agent,
		connected: make(chan struct{}),
		released:  make(chan struct{}),
	})
	handle := newDebugHandle(wid)

	sshListener, err := net.Listen("tcp", "127.0.0.1:0")
	if err != nil {
		t.Fatal(err)
	}
	sshServer := &gliderssh.Server{
		Handler: engine.debugHandle,
		PublicKeyHandler: func(gliderssh.Context, gliderssh.PublicKey) bool {
			return true
		},
	}
	hostKeyPath := filepath.Join(workDir, "host-key")
	if err := ensureDebugHostKey(hostKeyPath); err != nil {
		t.Fatal(err)
	}
	if err := sshServer.SetOption(gliderssh.HostKeyFile(hostKeyPath)); err != nil {
		t.Fatal(err)
	}
	serverDone := make(chan error, 1)
	go func() { serverDone <- sshServer.Serve(sshListener) }()
	defer func() {
		_ = sshServer.Close()
		if err := <-serverDone; err != nil && err != gliderssh.ErrServerClosed {
			t.Errorf("debug SSH server: %v", err)
		}
	}()

	_, privateKey, err := ed25519.GenerateKey(rand.Reader)
	if err != nil {
		t.Fatal(err)
	}
	privateKeyBlock, err := gossh.MarshalPrivateKey(privateKey, "")
	if err != nil {
		t.Fatal(err)
	}
	clientKeyPath := filepath.Join(workDir, "client-key")
	if err := os.WriteFile(clientKeyPath, pem.EncodeToMemory(privateKeyBlock), 0o600); err != nil {
		t.Fatal(err)
	}

	host, port, err := net.SplitHostPort(sshListener.Addr().String())
	if err != nil {
		t.Fatal(err)
	}
	target := handle + "@" + host
	controlPath := filepath.Join(workDir, "control")
	commonArgs := []string{
		"-o", "BatchMode=yes",
		"-o", "IdentitiesOnly=yes",
		"-o", "StrictHostKeyChecking=no",
		"-o", "UserKnownHostsFile=/dev/null",
		"-i", clientKeyPath,
		"-p", port,
	}
	missingContextArgs := append([]string{"-S", "none", "-tt"}, commonArgs...)
	missingContextArgs = append(missingContextArgs, target)
	missingContextOutput, err := exec.CommandContext(ctx, "ssh", missingContextArgs...).CombinedOutput()
	if err == nil {
		t.Fatalf("debug shell without failed step context exited successfully\noutput:\n%s", missingContextOutput)
	}
	wantMissingContext := "error: debug shell failed: debug shell request is missing failed step context"
	if !strings.Contains(string(missingContextOutput), wantMissingContext) {
		t.Fatalf(
			"missing-context error did not reach SSH client\nwant: %s\noutput:\n%s",
			wantMissingContext,
			missingContextOutput,
		)
	}
	if _, ok := engine.lookupDebugTarget(handle); ok {
		t.Fatal("debug target remained registered after missing-context failure")
	}
	engine.registerDebugTarget(wid, debugTarget{
		cid:        vm.CID(),
		agent:      agent,
		failedStep: failedStep,
		connected:  make(chan struct{}),
		released:   make(chan struct{}),
	})
	masterArgs := append([]string{"-M", "-N", "-S", controlPath}, commonArgs...)
	masterArgs = append(masterArgs, target)
	master := exec.CommandContext(ctx, "ssh", masterArgs...)
	var masterOutput bytes.Buffer
	master.Stdout = &masterOutput
	master.Stderr = &masterOutput
	if err := master.Start(); err != nil {
		t.Fatal(err)
	}
	masterDone := make(chan error, 1)
	go func() { masterDone <- master.Wait() }()
	masterStopped := false
	defer func() {
		if !masterStopped {
			_ = master.Process.Kill()
			<-masterDone
		}
	}()

	controlDeadline := time.Now().Add(10 * time.Second)
	for {
		if _, err := os.Stat(controlPath); err == nil {
			break
		}
		select {
		case err := <-masterDone:
			masterStopped = true
			t.Fatalf("SSH control master exited before creating its socket: %v\noutput:\n%s", err, masterOutput.String())
		case <-time.After(10 * time.Millisecond):
		}
		if time.Now().After(controlDeadline) {
			t.Fatalf("SSH control master did not create %s\noutput:\n%s", controlPath, masterOutput.String())
		}
	}

	sessionArgs := append([]string{"-S", controlPath, "-tt"}, commonArgs...)
	sessionArgs = append(sessionArgs, target)
	session := exec.CommandContext(ctx, "ssh", sessionArgs...)
	stdin, err := session.StdinPipe()
	if err != nil {
		t.Fatal(err)
	}
	var output bytes.Buffer
	session.Stdout = &output
	session.Stderr = &output
	session.Env = append(os.Environ(), "TERM=xterm-idle-e2e")
	if err := session.Start(); err != nil {
		t.Fatal(err)
	}
	waitDone := make(chan error, 1)
	go func() { waitDone <- session.Wait() }()

	const idleTime = 5 * time.Second
	select {
	case err := <-waitDone:
		t.Fatalf("debug shell exited while idle before %s: %v\noutput:\n%s", idleTime, err, output.String())
	case <-time.After(idleTime):
	}

	probe := `printf '__DEBUG_IDLE_E2E__|CI=%s|WF=%s|STEP=%s|OVERRIDE=%s|XDG=%s|PWD=%s|USER=%s|LOGNAME=%s|HOME=%s|TERM=%s|\n' "$CI" "$WF_ONLY" "$STEP_ONLY" "$OVERRIDE" "$XDG_CACHE_HOME" "$PWD" "$USER" "$LOGNAME" "$HOME" "$TERM"; exit` + "\n"
	if _, err := io.WriteString(stdin, probe); err != nil {
		t.Fatal(err)
	}

	select {
	case err := <-waitDone:
		if err != nil {
			t.Fatalf("debug shell exit: %v\noutput:\n%s", err, output.String())
		}
	case <-time.After(15 * time.Second):
		t.Fatal("debug shell did not exit after probe")
	}

	if err := master.Process.Kill(); err != nil {
		t.Fatal(err)
	}
	<-masterDone
	masterStopped = true

	want := "__DEBUG_IDLE_E2E__|CI=true|WF=workflow|STEP=step|OVERRIDE=step|XDG=/workspace/.cache|PWD=/workspace/repo|USER=spindle-workflow|LOGNAME=spindle-workflow|HOME=/workspace|TERM=xterm-idle-e2e|"
	if !strings.Contains(output.String(), want) {
		t.Fatalf("debug shell did not preserve the failed step context\nwant: %s\noutput:\n%s", want, output.String())
	}
	if _, ok := engine.lookupDebugTarget(handle); ok {
		t.Fatal("debug target remained registered after shell exit")
	}
}