test: add MCP tests for Postgres and MySQL (GoogleCloudPlatform#966)

Author: jackwotherspoon

.ci/cloudbuild.yaml

@@ -25,6 +25,8 @@ steps:
         "MYSQL_USER_IAM",
         "MYSQL_PASS",
         "MYSQL_DB",
+        "MYSQL_MCP_CONNECTION_NAME",
+        "MYSQL_MCP_PASS",
         "POSTGRES_CONNECTION_NAME",
         "POSTGRES_USER",
         "POSTGRES_USER_IAM",
@@ -36,6 +38,8 @@ steps:
         "POSTGRES_CUSTOMER_CAS_PASS",
         "POSTGRES_CUSTOMER_CAS_DOMAIN_NAME",
         "POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME",
+        "POSTGRES_MCP_CONNECTION_NAME",
+        "POSTGRES_MCP_PASS",
         "SQLSERVER_CONNECTION_NAME",
         "SQLSERVER_USER",
         "SQLSERVER_PASS",
@@ -59,6 +63,10 @@ availableSecrets:
     env: "MYSQL_PASS"
   - versionName: "projects/$PROJECT_ID/secrets/MYSQL_DB/versions/latest"
     env: "MYSQL_DB"
+  - versionName: "projects/$PROJECT_ID/secrets/MYSQL_MCP_CONNECTION_NAME/versions/latest"
+    env: "MYSQL_MCP_CONNECTION_NAME"
+  - versionName: "projects/$PROJECT_ID/secrets/MYSQL_MCP_PASS/versions/latest"
+    env: "MYSQL_MCP_PASS"
   - versionName: "projects/$PROJECT_ID/secrets/POSTGRES_CONNECTION_NAME/versions/latest"
     env: "POSTGRES_CONNECTION_NAME"
   - versionName: "projects/$PROJECT_ID/secrets/POSTGRES_USER/versions/latest"
@@ -81,6 +89,10 @@ availableSecrets:
     env: "POSTGRES_CUSTOMER_CAS_DOMAIN_NAME"
   - versionName: "projects/$PROJECT_ID/secrets/POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME/versions/latest"
     env: "POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME"
+  - versionName: "projects/$PROJECT_ID/secrets/POSTGRES_MCP_CONNECTION_NAME/versions/latest"
+    env: "POSTGRES_MCP_CONNECTION_NAME"
+  - versionName: "projects/$PROJECT_ID/secrets/POSTGRES_MCP_PASS/versions/latest"
+    env: "POSTGRES_MCP_PASS"
   - versionName: "projects/$PROJECT_ID/secrets/SQLSERVER_CONNECTION_NAME/versions/latest"
     env: "SQLSERVER_CONNECTION_NAME"
   - versionName: "projects/$PROJECT_ID/secrets/SQLSERVER_USER/versions/latest"

.github/workflows/tests.yaml

@@ -68,6 +68,8 @@ jobs:
             MYSQL_USER_IAM:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_USER_IAM_GO
             MYSQL_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_PASS
             MYSQL_DB:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_DB
+            MYSQL_MCP_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_MCP_CONNECTION_NAME
+            MYSQL_MCP_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/MYSQL_MCP_PASS
             POSTGRES_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CONNECTION_NAME
             POSTGRES_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_USER
             POSTGRES_USER_IAM:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_USER_IAM_GO
@@ -79,6 +81,8 @@ jobs:
             POSTGRES_CUSTOMER_CAS_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CUSTOMER_CAS_PASS
             POSTGRES_CUSTOMER_CAS_DOMAIN_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CUSTOMER_CAS_DOMAIN_NAME
             POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME
+            POSTGRES_MCP_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_MCP_CONNECTION_NAME
+            POSTGRES_MCP_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/POSTGRES_MCP_PASS
             SQLSERVER_CONNECTION_NAME:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_CONNECTION_NAME
             SQLSERVER_USER:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_USER
             SQLSERVER_PASS:${{ vars.GOOGLE_CLOUD_PROJECT }}/SQLSERVER_PASS
@@ -91,6 +95,8 @@ jobs:
           MYSQL_USER_IAM: "${{ steps.secrets.outputs.MYSQL_USER_IAM }}"
           MYSQL_PASS: "${{ steps.secrets.outputs.MYSQL_PASS }}"
           MYSQL_DB: "${{ steps.secrets.outputs.MYSQL_DB }}"
+          MYSQL_MCP_CONNECTION_NAME: "${{ steps.secrets.outputs.MYSQL_MCP_CONNECTION_NAME }}"
+          MYSQL_MCP_PASS: "${{ steps.secrets.outputs.MYSQL_MCP_PASS }}"
           POSTGRES_CONNECTION_NAME: "${{ steps.secrets.outputs.POSTGRES_CONNECTION_NAME }}"
           POSTGRES_USER: "${{ steps.secrets.outputs.POSTGRES_USER }}"
           POSTGRES_USER_IAM: "${{ steps.secrets.outputs.POSTGRES_USER_IAM }}"
@@ -102,6 +108,8 @@ jobs:
           POSTGRES_CUSTOMER_CAS_PASS: "${{ steps.secrets.outputs.POSTGRES_CUSTOMER_CAS_PASS }}"
           POSTGRES_CUSTOMER_CAS_DOMAIN_NAME: "${{ steps.secrets.outputs.POSTGRES_CUSTOMER_CAS_DOMAIN_NAME }}"
           POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME: "${{ steps.secrets.outputs.POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME }}"
+          POSTGRES_MCP_CONNECTION_NAME: "${{ steps.secrets.outputs.POSTGRES_MCP_CONNECTION_NAME }}"
+          POSTGRES_MCP_PASS: "${{ steps.secrets.outputs.POSTGRES_MCP_PASS }}"
           SQLSERVER_CONNECTION_NAME: "${{ steps.secrets.outputs.SQLSERVER_CONNECTION_NAME }}"
           SQLSERVER_USER: "${{ steps.secrets.outputs.SQLSERVER_USER }}"
           SQLSERVER_PASS: "${{ steps.secrets.outputs.SQLSERVER_PASS }}"

e2e_mysql_test.go

@@ -37,6 +37,11 @@ var (
 	mysqlPass = os.Getenv("MYSQL_PASS")
 	// Name of the database to connect to.
 	mysqlDB = os.Getenv("MYSQL_DB")
+	// "Cloud SQL MySQL MCP instance connection name, in the form of 'project:region:instance'.
+	mysqlMCPConnName = os.Getenv("MYSQL_MCP_CONNECTION_NAME")
+	// Password for the database user of MCP instance; be careful when entering
+	// a password on the command line (it may go into your terminal's history).
+	mysqlMCPPass = os.Getenv("MYSQL_MCP_PASS")
 	// IP Type of the MySQL instance to connect to.
 	ipType = os.Getenv("IP_TYPE")
 )
@@ -51,6 +56,10 @@ func requireMySQLVars(t *testing.T) {
 		t.Fatal("'MYSQL_PASS' env var not set")
 	case mysqlDB:
 		t.Fatal("'MYSQL_DB' env var not set")
+	case mysqlMCPConnName:
+		t.Fatal("'MYSQL_MCP_CONNECTION_NAME' env var not set")
+	case mysqlMCPPass:
+		t.Fatal("'MYSQL_MCP_PASS' env var not set")
 	}
 }
 
@@ -88,6 +97,22 @@ func TestMySQLDriver(t *testing.T) {
 			user:         mysqlIAMUser,
 			password:     "password",
 		},
+		{
+			desc:         "default options with MCP",
+			driverName:   "cloudsql-mysql-mcp",
+			opts:         opts,
+			instanceName: mysqlMCPConnName,
+			user:         mysqlUser,
+			password:     mysqlMCPPass,
+		},
+		{
+			desc:         "auto IAM authn with MCP",
+			driverName:   "cloudsql-mysql-iam-mcp",
+			opts:         append(opts, cloudsqlconn.WithIAMAuthN()),
+			instanceName: mysqlMCPConnName,
+			user:         mysqlIAMUser,
+			password:     "password",
+		},
 	}
 
 	for _, tc := range tcs {

e2e_postgres_test.go

@@ -40,9 +40,11 @@ var (
 	postgresConnName             = os.Getenv("POSTGRES_CONNECTION_NAME")                  // "Cloud SQL Postgres instance connection name, in the form of 'project:region:instance'.
 	postgresCASConnName          = os.Getenv("POSTGRES_CAS_CONNECTION_NAME")              // "Cloud SQL Postgres CAS instance connection name, in the form of 'project:region:instance'.
 	postgresCustomerCASConnName  = os.Getenv("POSTGRES_CUSTOMER_CAS_CONNECTION_NAME")     // "Cloud SQL Postgres Customer CAS instance connection name, in the form of 'project:region:instance'.
+	postgresMCPConnName          = os.Getenv("POSTGRES_MCP_CONNECTION_NAME")              // "Cloud SQL Postgres MCP instance connection name, in the form of 'project:region:instance'.
 	postgresUser                 = os.Getenv("POSTGRES_USER")                             // Name of database user.
 	postgresPass                 = os.Getenv("POSTGRES_PASS")                             // Password for the database user; be careful when entering a password on the command line (it may go into your terminal's history).
 	postgresCASPass              = os.Getenv("POSTGRES_CAS_PASS")                         // Password for the database user for CAS instances; be careful when entering a password on the command line (it may go into your terminal's history).
+	postgresMCPPass              = os.Getenv("POSTGRES_MCP_PASS")                         // Password for the database user for MCP instances; be careful when entering a password on the command line (it may go into your terminal's history).
 	postgresCustomerCASPass      = os.Getenv("POSTGRES_CUSTOMER_CAS_PASS")                // Password for the database user for customer CAS instances; be careful when entering a password on the command line (it may go into your terminal's history).
 	postgresDB                   = os.Getenv("POSTGRES_DB")                               // Name of the database to connect to.
 	postgresUserIAM              = os.Getenv("POSTGRES_USER_IAM")                         // Name of database IAM user.
@@ -66,12 +68,16 @@ func requirePostgresVars(t *testing.T) {
 		t.Fatal("'POSTGRES_CAS_CONNECTION_NAME' env var not set")
 	case postgresCustomerCASConnName:
 		t.Fatal("'POSTGRES_CUSTOMER_CAS_CONNECTION_NAME' env var not set")
+	case postgresMCPConnName:
+		t.Fatal("'POSTGRES_MCP_CONNECTION_NAME' env var not set")
 	case postgresUser:
 		t.Fatal("'POSTGRES_USER' env var not set")
 	case postgresPass:
 		t.Fatal("'POSTGRES_PASS' env var not set")
 	case postgresCASPass:
 		t.Fatal("'POSTGRES_CAS_PASS' env var not set")
+	case postgresMCPPass:
+		t.Fatal("'POSTGRES_MCP_PASS' env var not set")
 	case postgresCustomerCASPass:
 		t.Fatal("'POSTGRES_CUSTOMER_CAS_PASS' env var not set")
 	case postgresDB:
@@ -295,6 +301,58 @@ func TestPostgresCustomerCASConnect(t *testing.T) {
 	t.Log(now)
 }
 
+func TestPostgresMCPConnect(t *testing.T) {
+	if testing.Short() {
+		t.Skip("skipping Postgres integration tests")
+	}
+	requirePostgresVars(t)
+
+	ctx := context.Background()
+
+	// Configure the driver to connect to the database
+	dsn := fmt.Sprintf("user=%s password=%s dbname=%s sslmode=disable", postgresUser, postgresMCPPass, postgresDB)
+	config, err := pgxpool.ParseConfig(dsn)
+	if err != nil {
+		t.Fatalf("failed to parse pgx config: %v", err)
+	}
+
+	// Use WithPrivateIP option if the ipType is set to private
+	var opts []cloudsqlconn.Option
+	opts = AddIPTypeOptions(opts)
+
+	// Create a new dialer with any options
+	d, err := cloudsqlconn.NewDialer(ctx, opts...)
+	if err != nil {
+		t.Fatalf("failed to init Dialer: %v", err)
+	}
+
+	// call cleanup when you're done with the database connection to close dialer
+	cleanup := func() error { return d.Close() }
+
+	// Tell the driver to use the Cloud SQL Go Connector to create connections
+	// postgresMCPConnName takes the form of 'project:region:instance'.
+	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
+		return d.Dial(ctx, postgresMCPConnName)
+	}
+
+	// Interact with the driver directly as you normally would
+	pool, err := pgxpool.NewWithConfig(ctx, config)
+	if err != nil {
+		t.Fatalf("failed to create pool: %s", err)
+	}
+	// ... etc
+
+	defer cleanup()
+	defer pool.Close()
+
+	var now time.Time
+	err = pool.QueryRow(context.Background(), "SELECT NOW()").Scan(&now)
+	if err != nil {
+		t.Fatalf("QueryRow failed: %s", err)
+	}
+	t.Log(now)
+}
+
 func TestPostgresSANDomainConnect(t *testing.T) {
 	if testing.Short() {
 		t.Skip("skipping Postgres integration tests")