e2e_mysql_test.go

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package cloudsqlconn_test

import (
	"database/sql"
	"os"
	"testing"
	"time"

	"cloud.google.com/go/cloudsqlconn"
	"cloud.google.com/go/cloudsqlconn/mysql/mysql"
	gomysql "github.com/go-sql-driver/mysql"
)

var (
	// "Cloud SQL MySQL instance connection name, in the form of 'project:region:instance'.
	mysqlConnName = os.Getenv("MYSQL_CONNECTION_NAME")
	// Name of database user.
	mysqlUser = os.Getenv("MYSQL_USER")
	// Name of database IAM user.
	mysqlIAMUser = os.Getenv("MYSQL_USER_IAM")
	// Password for the database user; be careful when entering a password on
	// the command line (it may go into your terminal's history).
	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")
)

func requireMySQLVars(t *testing.T) {
	switch "" {
	case mysqlConnName:
		t.Fatal("'MYSQL_CONNECTION_NAME' env var not set")
	case mysqlUser:
		t.Fatal("'MYSQL_USER' env var not set")
	case mysqlPass:
		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")
	}
}

func TestMySQLDriver(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping MySQL integration tests")
	}

	var opts []cloudsqlconn.Option
	if ipType == "private" {
		opts = append(opts, cloudsqlconn.WithDefaultDialOptions(cloudsqlconn.WithPrivateIP()))
	}

	tcs := []struct {
		desc         string
		driverName   string
		instanceName string
		user         string
		password     string
		opts         []cloudsqlconn.Option
	}{
		{
			desc:         "default options",
			driverName:   "cloudsql-mysql",
			opts:         opts,
			instanceName: mysqlConnName,
			user:         mysqlUser,
			password:     mysqlPass,
		},
		{
			desc:         "auto IAM authn",
			driverName:   "cloudsql-mysql-iam",
			opts:         append(opts, cloudsqlconn.WithIAMAuthN()),
			instanceName: mysqlConnName,
			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 {
		t.Run(tc.desc, func(t *testing.T) {
			testConn := func(db *sql.DB) {
				var now time.Time
				if err := db.QueryRow("SELECT NOW()").Scan(&now); err != nil {
					t.Fatalf("QueryRow failed: %v", err)
				}
				t.Log(now)
			}
			cleanup, err := mysql.RegisterDriver(tc.driverName, tc.opts...)
			if err != nil {
				t.Fatalf("failed to register driver: %v", err)
			}
			defer cleanup()
			cfg := gomysql.NewConfig()
			cfg.CheckConnLiveness = true
			cfg.User = tc.user
			cfg.Passwd = tc.password
			cfg.DBName = mysqlDB
			cfg.Net = tc.driverName
			cfg.Addr = tc.instanceName
			cfg.Params = map[string]string{"parseTime": "true"}

			db, err := sql.Open("mysql", cfg.FormatDSN())
			if err != nil {
				t.Fatalf("sql.Open want err = nil, got = %v", err)
			}
			defer db.Close()
			testConn(db)
		})
	}
}