|
| 1 | +//go:build cgo |
| 2 | + |
| 3 | +package main |
| 4 | + |
| 5 | +import ( |
| 6 | + "context" |
| 7 | + "crypto/rand" |
| 8 | + "database/sql" |
| 9 | + "encoding/hex" |
| 10 | + "fmt" |
| 11 | + "net" |
| 12 | + "os" |
| 13 | + "os/exec" |
| 14 | + "strconv" |
| 15 | + "testing" |
| 16 | + "time" |
| 17 | + |
| 18 | + _ "github.com/go-sql-driver/mysql" |
| 19 | +) |
| 20 | + |
| 21 | +// testDoltServerPort is the port of the shared test Dolt server. |
| 22 | +// Set by startSharedTestDoltServer before any tests run. |
| 23 | +// When non-zero, newTestStore connects to this server instead of the default. |
| 24 | +var testDoltServerPort int |
| 25 | + |
| 26 | +func init() { |
| 27 | + beforeTestsHook = startSharedTestDoltServer |
| 28 | +} |
| 29 | + |
| 30 | +// startSharedTestDoltServer ensures a Dolt server is available for the cmd/bd test suite. |
| 31 | +// Prefers an already-running server on the default port (3307). If none is found, |
| 32 | +// starts a dedicated test server. Each test gets its own database via uniqueTestDBName. |
| 33 | +// Returns a cleanup function. |
| 34 | +func startSharedTestDoltServer() func() { |
| 35 | + // Skip if dolt is not available |
| 36 | + if _, err := exec.LookPath("dolt"); err != nil { |
| 37 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: dolt not installed, CGO tests requiring Dolt will fail\n") |
| 38 | + return func() {} |
| 39 | + } |
| 40 | + |
| 41 | + // Always start a dedicated test server for isolation. |
| 42 | + // Reusing the rig's Dolt server on 3307 is fragile: the shared server may be |
| 43 | + // overloaded by other processes, and 100+ tests creating concurrent databases |
| 44 | + // can overwhelm it. A dedicated server with --max-connections ensures reliability. |
| 45 | + return startDedicatedTestServer() |
| 46 | +} |
| 47 | + |
| 48 | +// tryExistingServer checks if a Dolt server is fully operational on the given port. |
| 49 | +// A simple Ping is insufficient — the server may accept connections but fail on actual |
| 50 | +// operations (e.g., broken/overloaded server). We verify by creating and dropping a database. |
| 51 | +func tryExistingServer(port int) int { |
| 52 | + dsn := fmt.Sprintf("root@tcp(127.0.0.1:%d)/?parseTime=true&timeout=5s", port) |
| 53 | + db, err := sql.Open("mysql", dsn) |
| 54 | + if err != nil { |
| 55 | + return 0 |
| 56 | + } |
| 57 | + defer db.Close() |
| 58 | + |
| 59 | + ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second) |
| 60 | + defer cancel() |
| 61 | + |
| 62 | + if err := db.PingContext(ctx); err != nil { |
| 63 | + return 0 |
| 64 | + } |
| 65 | + |
| 66 | + // Verify server can actually perform DDL (not just accept connections) |
| 67 | + testDB := "beads_health_check_probe" |
| 68 | + if _, err := db.ExecContext(ctx, fmt.Sprintf("CREATE DATABASE IF NOT EXISTS `%s`", testDB)); err != nil { |
| 69 | + return 0 |
| 70 | + } |
| 71 | + _, _ = db.ExecContext(ctx, fmt.Sprintf("DROP DATABASE IF EXISTS `%s`", testDB)) |
| 72 | + return port |
| 73 | +} |
| 74 | + |
| 75 | +// startDedicatedTestServer starts a new Dolt server for tests on a free port. |
| 76 | +// Uses exec.Command directly (instead of dolt.NewServer) to control all server flags |
| 77 | +// including --max-connections which dolt.ServerConfig doesn't expose. |
| 78 | +func startDedicatedTestServer() func() { |
| 79 | + tmpDir, err := os.MkdirTemp("", "beads-test-dolt-server-*") |
| 80 | + if err != nil { |
| 81 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: failed to create temp dir: %v\n", err) |
| 82 | + return func() {} |
| 83 | + } |
| 84 | + |
| 85 | + // Set up dolt identity (HOME is a temp dir in tests) |
| 86 | + for _, args := range [][]string{ |
| 87 | + {"config", "--global", "--add", "user.name", "Test User"}, |
| 88 | + {"config", "--global", "--add", "user.email", "test@test.com"}, |
| 89 | + } { |
| 90 | + cmd := exec.Command("dolt", args...) |
| 91 | + cmd.Dir = tmpDir |
| 92 | + if out, err := cmd.CombinedOutput(); err != nil { |
| 93 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: dolt %v failed: %v, output: %s\n", args, err, out) |
| 94 | + os.RemoveAll(tmpDir) |
| 95 | + return func() {} |
| 96 | + } |
| 97 | + } |
| 98 | + |
| 99 | + // Initialize dolt repo |
| 100 | + cmd := exec.Command("dolt", "init") |
| 101 | + cmd.Dir = tmpDir |
| 102 | + if out, err := cmd.CombinedOutput(); err != nil { |
| 103 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: dolt init failed: %v, output: %s\n", err, out) |
| 104 | + os.RemoveAll(tmpDir) |
| 105 | + return func() {} |
| 106 | + } |
| 107 | + |
| 108 | + // Find a free port |
| 109 | + port := findFreePort() |
| 110 | + if port == 0 { |
| 111 | + port = 13310 |
| 112 | + } |
| 113 | + |
| 114 | + // Start dolt sql-server |
| 115 | + serverLog := fmt.Sprintf("%s/server.log", tmpDir) |
| 116 | + serverArgs := []string{ |
| 117 | + "sql-server", |
| 118 | + "--host", "127.0.0.1", |
| 119 | + "--port", strconv.Itoa(port), |
| 120 | + "--max-connections", "200", |
| 121 | + } |
| 122 | + serverCmd := exec.Command("dolt", serverArgs...) |
| 123 | + serverCmd.Dir = tmpDir |
| 124 | + |
| 125 | + logFile, err := os.OpenFile(serverLog, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600) |
| 126 | + if err != nil { |
| 127 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: failed to open log: %v\n", err) |
| 128 | + os.RemoveAll(tmpDir) |
| 129 | + return func() {} |
| 130 | + } |
| 131 | + serverCmd.Stdout = logFile |
| 132 | + serverCmd.Stderr = logFile |
| 133 | + |
| 134 | + if err := serverCmd.Start(); err != nil { |
| 135 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: failed to start dolt: %v\n", err) |
| 136 | + logFile.Close() |
| 137 | + os.RemoveAll(tmpDir) |
| 138 | + return func() {} |
| 139 | + } |
| 140 | + |
| 141 | + // Wait for MySQL protocol readiness (not just TCP) |
| 142 | + readyCtx, readyCancel := context.WithTimeout(context.Background(), 30*time.Second) |
| 143 | + defer readyCancel() |
| 144 | + if err := waitForMySQL(readyCtx, port); err != nil { |
| 145 | + fmt.Fprintf(os.Stderr, "test-dolt-server: WARNING: MySQL not ready: %v\n", err) |
| 146 | + _ = serverCmd.Process.Kill() |
| 147 | + logFile.Close() |
| 148 | + os.RemoveAll(tmpDir) |
| 149 | + return func() {} |
| 150 | + } |
| 151 | + |
| 152 | + testDoltServerPort = port |
| 153 | + // Set env vars so code paths use the test server: |
| 154 | + // - BEADS_DOLT_PORT: read by applyConfigDefaults (direct dolt.New calls) |
| 155 | + // - BEADS_DOLT_SERVER_PORT: read by configfile.GetDoltServerPort (NewFromConfig calls |
| 156 | + // when metadata.json sets dolt_mode=server) |
| 157 | + // Note: do NOT set BEADS_DOLT_SERVER_MODE — that would change bd init behavior globally. |
| 158 | + // Instead, metadata.json written by writeTestMetadata sets dolt_mode=server per-store. |
| 159 | + os.Setenv("BEADS_DOLT_PORT", strconv.Itoa(port)) |
| 160 | + os.Setenv("BEADS_DOLT_SERVER_PORT", strconv.Itoa(port)) |
| 161 | + fmt.Fprintf(os.Stderr, "test-dolt-server: dedicated server ready on port %d (pid %d)\n", port, serverCmd.Process.Pid) |
| 162 | + |
| 163 | + return func() { |
| 164 | + os.Unsetenv("BEADS_DOLT_PORT") |
| 165 | + os.Unsetenv("BEADS_DOLT_SERVER_PORT") |
| 166 | + fmt.Fprintf(os.Stderr, "test-dolt-server: stopping server on port %d\n", port) |
| 167 | + _ = serverCmd.Process.Kill() |
| 168 | + _, _ = serverCmd.Process.Wait() |
| 169 | + logFile.Close() |
| 170 | + os.RemoveAll(tmpDir) |
| 171 | + } |
| 172 | +} |
| 173 | + |
| 174 | +// waitForMySQL waits until the Dolt server accepts MySQL protocol connections. |
| 175 | +func waitForMySQL(ctx context.Context, port int) error { |
| 176 | + dsn := fmt.Sprintf("root@tcp(127.0.0.1:%d)/?parseTime=true&timeout=2s", port) |
| 177 | + deadline := time.Now().Add(30 * time.Second) |
| 178 | + |
| 179 | + for time.Now().Before(deadline) { |
| 180 | + select { |
| 181 | + case <-ctx.Done(): |
| 182 | + return ctx.Err() |
| 183 | + default: |
| 184 | + } |
| 185 | + |
| 186 | + db, err := sql.Open("mysql", dsn) |
| 187 | + if err != nil { |
| 188 | + time.Sleep(200 * time.Millisecond) |
| 189 | + continue |
| 190 | + } |
| 191 | + err = db.PingContext(ctx) |
| 192 | + _ = db.Close() |
| 193 | + if err == nil { |
| 194 | + return nil |
| 195 | + } |
| 196 | + time.Sleep(200 * time.Millisecond) |
| 197 | + } |
| 198 | + return fmt.Errorf("timeout waiting for MySQL protocol on port %d", port) |
| 199 | +} |
| 200 | + |
| 201 | +// findFreePort finds a free TCP port by briefly listening on :0. |
| 202 | +func findFreePort() int { |
| 203 | + l, err := net.Listen("tcp", "127.0.0.1:0") |
| 204 | + if err != nil { |
| 205 | + return 0 |
| 206 | + } |
| 207 | + port := l.Addr().(*net.TCPAddr).Port |
| 208 | + l.Close() |
| 209 | + return port |
| 210 | +} |
| 211 | + |
| 212 | +// uniqueTestDBName generates a unique database name for test isolation. |
| 213 | +// Each test gets its own database on the shared test server. |
| 214 | +func uniqueTestDBName(t *testing.T) string { |
| 215 | + t.Helper() |
| 216 | + buf := make([]byte, 6) |
| 217 | + if _, err := rand.Read(buf); err != nil { |
| 218 | + t.Fatalf("failed to generate random bytes: %v", err) |
| 219 | + } |
| 220 | + return "testdb_" + hex.EncodeToString(buf) |
| 221 | +} |
0 commit comments