feat(examples): Use hosted MySQL databases for tests (#2982)

* feat(examples): Use hosted MySQL databases for tests

* Switch to managed mode for more examples

Author: kyleconroy

.github/workflows/ci.yml

@@ -31,16 +31,6 @@ jobs:
     name: test
     runs-on: ubuntu-latest
 
-    services:
-      mysql:
-        image: "mysql/mysql-server:8.0"
-        env:
-          MYSQL_DATABASE: mysql
-          MYSQL_ROOT_HOST: '%'
-          MYSQL_ROOT_PASSWORD: mysecretpassword
-        ports:
-        - 3306:3306
-
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-go@v4
@@ -64,10 +54,6 @@ jobs:
     - name: test ./...
       run: gotestsum --junitfile junit.xml -- --tags=examples -timeout 20m ./...
       env:
-        MYSQL_DATABASE: mysql
-        MYSQL_HOST: localhost
-        MYSQL_PORT: ${{ job.services.mysql.ports['3306'] }}
-        MYSQL_ROOT_PASSWORD: mysecretpassword
         CI_SQLC_PROJECT_ID: ${{ secrets.CI_SQLC_PROJECT_ID }}
         CI_SQLC_AUTH_TOKEN: ${{ secrets.CI_SQLC_AUTH_TOKEN }}
         SQLC_AUTH_TOKEN: ${{ secrets.CI_SQLC_AUTH_TOKEN }}

examples/authors/mysql/db_test.go

@@ -8,14 +8,20 @@ import (
 	"database/sql"
 	"testing"
 
-	"github.com/sqlc-dev/sqlc/internal/sqltest"
+	_ "github.com/go-sql-driver/mysql"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest/hosted"
 )
 
 func TestAuthors(t *testing.T) {
-	sdb, cleanup := sqltest.MySQL(t, []string{"schema.sql"})
-	defer cleanup()
-
 	ctx := context.Background()
+	uri := hosted.MySQL(t, []string{"schema.sql"})
+	sdb, err := sql.Open("mysql", uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer sdb.Close()
+
 	db := New(sdb)
 
 	// list all authors

examples/authors/sqlc.yaml

@@ -2,7 +2,8 @@ version: '2'
 cloud:
   project: "01HAQMMECEYQYKFJN8MP16QC41"
 sql:
-- schema: postgresql/schema.sql
+- name: postgresql
+  schema: postgresql/schema.sql
   queries: postgresql/query.sql
   engine: postgresql
   database:
@@ -17,19 +18,21 @@ sql:
       package: authors
       sql_package: pgx/v5
       out: postgresql
-- schema: mysql/schema.sql
+- name: mysql
+  schema: mysql/schema.sql
   queries: mysql/query.sql
   engine: mysql
   database:
-    uri: root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/authors?multiStatements=true&parseTime=true
+    managed: true
   rules:
   - sqlc/db-prepare
   # - mysql-query-too-costly
   gen:
     go:
       package: authors
       out: mysql
-- schema: sqlite/schema.sql
+- name: sqlite
+  schema: sqlite/schema.sql
   queries: sqlite/query.sql
   engine: sqlite
   database:

examples/booktest/mysql/db_test.go

@@ -5,17 +5,24 @@ package booktest
 
 import (
 	"context"
+	"database/sql"
 	"testing"
 	"time"
 
-	"github.com/sqlc-dev/sqlc/internal/sqltest"
+	_ "github.com/go-sql-driver/mysql"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest/hosted"
 )
 
 func TestBooks(t *testing.T) {
-	db, cleanup := sqltest.MySQL(t, []string{"schema.sql"})
-	defer cleanup()
-
 	ctx := context.Background()
+	uri := hosted.MySQL(t, []string{"schema.sql"})
+	db, err := sql.Open("mysql", uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer db.Close()
+
 	dq := New(db)
 
 	// create an author

examples/booktest/sqlc.json

@@ -28,7 +28,7 @@
       "queries": "mysql/query.sql",
       "engine": "mysql",
       "database": {
-        "uri": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/booktest?multiStatements=true&parseTime=true"
+        "managed": true
       },
       "rules": [
         "sqlc/db-prepare"

examples/ondeck/mysql/db_test.go

@@ -9,9 +9,10 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/sqlc-dev/sqlc/internal/sqltest"
-
+	_ "github.com/go-sql-driver/mysql"
 	"github.com/google/go-cmp/cmp"
+
+	"github.com/sqlc-dev/sqlc/internal/sqltest/hosted"
 )
 
 func join(vals ...string) sql.NullString {
@@ -143,10 +144,14 @@ func runOnDeckQueries(t *testing.T, q *Queries) {
 func TestPrepared(t *testing.T) {
 	t.Parallel()
 
-	sdb, cleanup := sqltest.MySQL(t, []string{"schema"})
-	defer cleanup()
+	uri := hosted.MySQL(t, []string{"schema"})
+	db, err := sql.Open("mysql", uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer db.Close()
 
-	q, err := Prepare(context.Background(), sdb)
+	q, err := Prepare(context.Background(), db)
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -157,8 +162,12 @@ func TestPrepared(t *testing.T) {
 func TestQueries(t *testing.T) {
 	t.Parallel()
 
-	sdb, cleanup := sqltest.MySQL(t, []string{"schema"})
-	defer cleanup()
+	uri := hosted.MySQL(t, []string{"schema"})
+	db, err := sql.Open("mysql", uri)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer db.Close()
 
-	runOnDeckQueries(t, New(sdb))
+	runOnDeckQueries(t, New(db))
 }

examples/ondeck/sqlc.json

@@ -31,7 +31,7 @@
       "queries": "mysql/query",
       "engine": "mysql",
       "database": {
-        "uri": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/ondeck?multiStatements=true&parseTime=true"
+        "managed": true
       },
       "rules": [
         "sqlc/db-prepare"

internal/cmd/vet.go

@@ -404,10 +404,6 @@ func (c *checker) fetchDatabaseUri(ctx context.Context, s config.SQL) (string, f
 		return uri, cleanup, err
 	}
 
-	if s.Engine != config.EnginePostgreSQL {
-		return "", cleanup, fmt.Errorf("managed: only PostgreSQL currently")
-	}
-
 	if c.Client == nil {
 		// FIXME: Eventual race condition
 		client, err := quickdb.NewClientFromConfig(c.Conf.Cloud)
@@ -431,7 +427,7 @@ func (c *checker) fetchDatabaseUri(ctx context.Context, s config.SQL) (string, f
 	}
 
 	resp, err := c.Client.CreateEphemeralDatabase(ctx, &pb.CreateEphemeralDatabaseRequest{
-		Engine:     "postgresql",
+		Engine:     string(s.Engine),
 		Region:     quickdb.GetClosestRegion(),
 		Migrations: ddl,
 	})
@@ -446,7 +442,19 @@ func (c *checker) fetchDatabaseUri(ctx context.Context, s config.SQL) (string, f
 		return err
 	}
 
-	return resp.Uri, cleanup, nil
+	var uri string
+	switch s.Engine {
+	case config.EngineMySQL:
+		dburi, err := quickdb.MySQLReformatURI(resp.Uri)
+		if err != nil {
+			return "", cleanup, fmt.Errorf("reformat uri: %w", err)
+		}
+		uri = dburi
+	default:
+		uri = resp.Uri
+	}
+
+	return uri, cleanup, nil
 }
 
 func (c *checker) DSN(dsn string) (string, error) {

internal/endtoend/vet_test.go

@@ -56,11 +56,6 @@ func TestExamplesVet(t *testing.T) {
 			path := filepath.Join(examples, tc)
 
 			if tc != "kotlin" && tc != "python" {
-				if s, found := findSchema(t, filepath.Join(path, "mysql")); found {
-					db, cleanup := sqltest.CreateMySQLDatabase(t, tc, []string{s})
-					defer db.Close()
-					defer cleanup()
-				}
 				if s, found := findSchema(t, filepath.Join(path, "sqlite")); found {
 					dsn := fmt.Sprintf("file:%s?mode=memory&cache=shared", tc)
 					db, cleanup := sqltest.CreateSQLiteDatabase(t, dsn, []string{s})

internal/quickdb/mysql.go

@@ -0,0 +1,16 @@
+package quickdb
+
+import (
+	"fmt"
+	"net/url"
+)
+
+// The database URI returned by the QuickDB service isn't understood by the
+// go-mysql-driver
+func MySQLReformatURI(original string) (string, error) {
+	u, err := url.Parse(original)
+	if err != nil {
+		return "", err
+	}
+	return fmt.Sprintf("%s@tcp(%s)%s?multiStatements=true&parseTime=true&tls=true", u.User, u.Host, u.Path), nil
+}