e2e_postgres_test.go

// Copyright 2020 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.

//go:build !skip_postgres
// +build !skip_postgres

package cloudsqlconn_test

import (
	"context"
	"database/sql"
	"fmt"
	"net"
	"os"
	"strings"
	"sync"
	"testing"
	"time"

	"cloud.google.com/go/auth"
	"cloud.google.com/go/auth/credentials"
	"cloud.google.com/go/cloudsqlconn"
	"github.com/jackc/pgx/v5/pgxpool"
	"golang.org/x/oauth2"
	"golang.org/x/oauth2/google"

	"cloud.google.com/go/cloudsqlconn/postgres/pgxv4"
	"cloud.google.com/go/cloudsqlconn/postgres/pgxv5"
)

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'.
	postgresAIDEConnName         = os.Getenv("POSTGRES_AIDE_CONNECTION_NAME")             // "Cloud SQL Postgres AIDE 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).
	postgresAIDEUser             = os.Getenv("POSTGRES_AIDE_USER")                        // Name of database user for AIDE instance.
	postgresAIDEPass             = os.Getenv("POSTGRES_AIDE_PASS")                        // Password for the database user for AIDE instance.
	postgresAIDEDB               = os.Getenv("POSTGRES_AIDE_DB")                          // Name of the database to connect to for AIDE instance.
	postgresFallbackConnName     = os.Getenv("POSTGRES_FALLBACK_CONNECTION_NAME")         // Cloud SQL Postgres Fallback instance connection name, in the form of 'project:region:instance'.
	postgresFallbackUser         = os.Getenv("POSTGRES_FALLBACK_USER")                    // Name of database user for Fallback instance.
	postgresFallbackPass         = os.Getenv("POSTGRES_FALLBACK_PASS")                    // Password for the database user for Fallback instance.
	postgresFallbackDB           = os.Getenv("POSTGRES_FALLBACK_DB")                      // Name of the database to connect to for Fallback instance.
	postgresDB                   = os.Getenv("POSTGRES_DB")                               // Name of the database to connect to.
	postgresUserIAM              = os.Getenv("POSTGRES_USER_IAM")                         // Name of database IAM user.
	project                      = os.Getenv("QUOTA_PROJECT")                             // Name of the Google Cloud Platform project to use for quota and billing.
	postgresSANDomainName        = os.Getenv("POSTGRES_CUSTOMER_CAS_DOMAIN_NAME")         // Cloud SQL Postgres CAS domain name that is an instance Custom SAN of the postgresSANConnName instance.
	postgresSANInvalidDomainName = os.Getenv("POSTGRES_CUSTOMER_CAS_INVALID_DOMAIN_NAME") // Cloud SQL Postgres CAS domain name that IS NOT an instance Custom SAN of the postgresSANConnName instance.
)

func addIPTypeOptions(opts []cloudsqlconn.Option) []cloudsqlconn.Option {
	if ipType == "private" {
		return append(opts, cloudsqlconn.WithDefaultDialOptions(cloudsqlconn.WithPrivateIP()))
	}
	if ipType == "sqldata" {
		return append(opts, cloudsqlconn.WithDefaultDialOptions(cloudsqlconn.WithSQLData()))
	}
	return opts
}

func requirePostgresVars(t *testing.T) {
	switch "" {
	case postgresConnName:
		t.Fatal("'POSTGRES_CONNECTION_NAME' env var not set")
	case postgresCASConnName:
		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:
		t.Fatal("'POSTGRES_DB' env var not set")
	case postgresUserIAM:
		t.Fatal("'POSTGRES_USER_IAM' env var not set")
	case project:
		t.Fatal("'QUOTA_PROJECT' env var not set")
	case postgresSANDomainName:
		t.Fatal("'POSTGRES_SAN_DOMAIN_NAME' env var not set")
	case postgresSANInvalidDomainName:
		t.Fatal("'POSTGRES_SAN_INVALID_DOMAIN_NAME' env var not set")
	}
}

func requirePostgresAIDEVars(t *testing.T) {
	t.Helper()
	switch "" {
	case postgresAIDEConnName:
		t.Skip("'POSTGRES_AIDE_CONNECTION_NAME' env var not set, skipping AIDE test")
	case postgresAIDEUser:
		t.Skip("'POSTGRES_AIDE_USER' env var not set, skipping AIDE test")
	case postgresAIDEPass:
		t.Skip("'POSTGRES_AIDE_PASS' env var not set, skipping AIDE test")
	case postgresAIDEDB:
		t.Skip("'POSTGRES_AIDE_DB' env var not set, skipping AIDE test")
	}
}

func requirePostgresFallbackVars(t *testing.T) {
	t.Helper()
	switch "" {
	case postgresFallbackConnName:
		t.Skip("'POSTGRES_FALLBACK_CONNECTION_NAME' env var not set, skipping Fallback test")
	case postgresFallbackUser:
		t.Skip("'POSTGRES_FALLBACK_USER' env var not set, skipping Fallback test")
	case postgresFallbackPass:
		t.Skip("'POSTGRES_FALLBACK_PASS' env var not set, skipping Fallback test")
	case postgresFallbackDB:
		t.Skip("'POSTGRES_FALLBACK_DB' env var not set, skipping Fallback test")
	}
}

func TestPostgresPgxPoolConnect(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, postgresPass, 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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresConnName)
	}

	// 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 TestPostgresCASConnect(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, postgresCASPass, 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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresCASConnName)
	}

	// 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)
}

type e2eTestLogger struct {
	t *testing.T
}

func (l *e2eTestLogger) Debugf(f string, args ...interface{}) {
	l.t.Logf(f, args...)
}

func TestPostgresSQLDataConnect(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresAIDEVars(t)

	ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
	defer cancel()

	// Configure the driver to connect to the database
	dsn := fmt.Sprintf("user=%s password=%s dbname=%s sslmode=disable", postgresAIDEUser, postgresAIDEPass, postgresAIDEDB)
	config, err := pgxpool.ParseConfig(dsn)
	if err != nil {
		t.Fatalf("failed to parse pgx config: %v", err)
	}

	// Create a new dialer with SQLData option
	d, err := cloudsqlconn.NewDialer(ctx,
		cloudsqlconn.WithDefaultDialOptions(cloudsqlconn.WithSQLData()),
		cloudsqlconn.WithDebugLogger(&e2eTestLogger{t: t}),
	)
	if err != nil {
		t.Fatalf("failed to init Dialer: %v", err)
	}
	defer d.Close()

	var connsMu sync.Mutex
	var conns []net.Conn
	cleanupConns := func() {
		connsMu.Lock()
		defer connsMu.Unlock()
		for _, c := range conns {
			_ = c.Close()
		}
		conns = nil
	}
	defer cleanupConns()

	done := make(chan struct{})
	defer close(done)
	go func() {
		select {
		case <-ctx.Done():
			cleanupConns()
		case <-done:
		}
	}()

	// Tell the driver to use the Cloud SQL Go Connector to create connections
	// postgresAIDEConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(dialCtx context.Context, _ string, _ string) (net.Conn, error) {
		t.Logf("DialFunc called for %s", postgresAIDEConnName)
		conn, err := d.Dial(dialCtx, postgresAIDEConnName)
		if err != nil {
			t.Logf("d.Dial returned error: %v", err)
			return nil, err
		}
		t.Logf("d.Dial returned net.Conn successfully")
		connsMu.Lock()
		conns = append(conns, conn)
		connsMu.Unlock()
		return conn, nil
	}

	// 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)
	}
	defer pool.Close()

	var now time.Time
	err = pool.QueryRow(ctx, "SELECT NOW()").Scan(&now)
	if err != nil {
		t.Fatalf("QueryRow failed: %s", err)
	}

	t.Logf("Successfully executed query via SQLData: %v", now)
}

func TestPostgresSQLDataFallback(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresFallbackVars(t)

	ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
	defer cancel()

	// Configure the driver to connect to the database
	dsn := fmt.Sprintf("user=%s password=%s dbname=%s sslmode=disable", postgresFallbackUser, postgresFallbackPass, postgresFallbackDB)
	config, err := pgxpool.ParseConfig(dsn)
	if err != nil {
		t.Fatalf("failed to parse pgx config: %v", err)
	}

	// Create a new dialer with SQLData option
	d, err := cloudsqlconn.NewDialer(ctx,
		cloudsqlconn.WithDefaultDialOptions(cloudsqlconn.WithSQLData()),
		cloudsqlconn.WithDebugLogger(&e2eTestLogger{t: t}),
	)
	if err != nil {
		t.Fatalf("failed to init Dialer: %v", err)
	}
	defer d.Close()

	var connsMu sync.Mutex
	var conns []net.Conn
	cleanupConns := func() {
		connsMu.Lock()
		defer connsMu.Unlock()
		for _, c := range conns {
			_ = c.Close()
		}
		conns = nil
	}
	defer cleanupConns()

	doneFallback := make(chan struct{})
	defer close(doneFallback)
	go func() {
		select {
		case <-ctx.Done():
			cleanupConns()
		case <-doneFallback:
		}
	}()

	// Tell the driver to use the Cloud SQL Go Connector to create connections
	// postgresFallbackConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(dialCtx context.Context, _ string, _ string) (net.Conn, error) {
		t.Logf("DialFunc called for %s", postgresFallbackConnName)
		conn, err := d.Dial(dialCtx, postgresFallbackConnName)
		if err != nil {
			t.Logf("d.Dial returned error: %v", err)
			return nil, err
		}
		t.Logf("d.Dial returned net.Conn successfully")
		connsMu.Lock()
		conns = append(conns, conn)
		connsMu.Unlock()
		return conn, nil
	}

	// 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)
	}
	defer pool.Close()

	var now time.Time
	err = pool.QueryRow(ctx, "SELECT NOW()").Scan(&now)
	if err != nil {
		t.Fatalf("QueryRow failed: %s", err)
	}
	t.Logf("Successfully executed query via SQLData fallback to public IP: %v", now)
}

func TestPostgresConnectWithQuotaProject(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, postgresPass, 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, append(opts, cloudsqlconn.WithQuotaProject(project))...)
	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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresConnName)
	}

	// 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 TestPostgresCustomerCASConnect(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, postgresCustomerCASPass, 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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresCustomerCASConnName)
	}

	// 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 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")
	}
	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, postgresCustomerCASPass, "postgres")
	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, append(opts, cloudsqlconn.WithDNSResolver())...)

	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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresSANDomainName)
	}

	// 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 TestPostgresSANBadDomainCausesConnectError(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, postgresCustomerCASPass, "postgres")
	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, append(opts, cloudsqlconn.WithDNSResolver())...)

	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
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresSANInvalidDomainName)
	}

	// 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.Fatal("Want error, got invalid error")
	}
	if !strings.Contains(fmt.Sprint(err), "dial error: handshake failed") {
		t.Fatal("Want error 'Dial error: handshake failed'.  got: ", err)
	}
	t.Log(now)
}

func TestPostgresPgxPoolConnectDomainName(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresVars(t)
	pgxv5.RegisterDriver("pgxpool-connect", cloudsqlconn.WithDNSResolver())

	ctx := context.Background()

	// Configure the driver to connect to the database
	dsn := fmt.Sprintf("user=%s password=%s dbname=%s sslmode=disable", postgresUser, postgresCustomerCASPass, 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, append(opts, cloudsqlconn.WithDNSResolver())...)
	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() { d.Close() }
	t.Cleanup(cleanup)

	// Tell the driver to use the Cloud SQL Go Connector to create connections
	// postgresConnName takes the form of 'project:region:instance'.
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresSANDomainName)
	}

	pool, err := pgxpool.NewWithConfig(ctx, config)
	if err != nil {
		t.Fatalf("failed to create pool: %s", err)
	}
	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 TestPostgresConnectWithIAMUser(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresVars(t)

	ctx := context.Background()

	// password is intentionally blank
	dsn := fmt.Sprintf("user=%s password=\"\" dbname=%s sslmode=disable", postgresUserIAM, 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)

	d, err := cloudsqlconn.NewDialer(ctx, append(opts, cloudsqlconn.WithIAMAuthN())...)
	if err != nil {
		t.Fatalf("failed to initiate Dialer: %v", err)
	}
	defer d.Close()

	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresConnName)
	}

	pool, err := pgxpool.NewWithConfig(ctx, config)
	if err != nil {
		t.Fatalf("failed to create pool: %s", err)
	}
	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 TestPostgresConnectWithLazyRefresh(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresVars(t)

	ctx := context.Background()

	// password is intentionally blank
	dsn := fmt.Sprintf("user=%s password=\"\" dbname=%s sslmode=disable", postgresUserIAM, 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)

	d, err := cloudsqlconn.NewDialer(
		ctx,
		append(opts, cloudsqlconn.WithLazyRefresh(), cloudsqlconn.WithIAMAuthN())...,
	)
	if err != nil {
		t.Fatalf("failed to initiate Dialer: %v", err)
	}
	defer d.Close()
	config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
		return d.Dial(ctx, postgresConnName)
	}

	pool, err := pgxpool.NewWithConfig(ctx, config)
	if err != nil {
		t.Fatalf("failed to create pool: %s", err)
	}
	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 TestPostgresEngineVersion(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// Use WithPrivateIP option if the ipType is set to private
	var opts []cloudsqlconn.Option
	opts = addIPTypeOptions(opts)

	d, err := cloudsqlconn.NewDialer(context.Background(), opts...)
	if err != nil {
		t.Fatalf("failed to init Dialer: %v", err)
	}
	gotEV, err := d.EngineVersion(ctx, postgresConnName)
	if err != nil {
		t.Fatalf("failed to retrieve engine version: %v", err)
	}
	if !strings.Contains(gotEV, "POSTGRES") {
		t.Errorf("InstanceEngineVersion(%s) failed: want 'POSTGRES', got %v", gotEV, err)
	}
}

func TestPostgresV5Hook(t *testing.T) {

	// Use WithPrivateIP option if the ipType is set to private
	var opts []cloudsqlconn.Option
	opts = addIPTypeOptions(opts)

	tests := []struct {
		driver   string
		source   string
		IAMAuthN bool
		resolver bool
		opts     []cloudsqlconn.Option
	}{
		{
			driver: "cloudsql-postgres-v5",
			source: fmt.Sprintf("host=%s user=%s password=%s dbname=%s sslmode=disable",
				postgresConnName, postgresUser, postgresPass, postgresDB),
			IAMAuthN: false,
			opts:     opts,
		},
		{
			driver: "cloudsql-postgres-iam-v5",
			source: fmt.Sprintf("host=%s user=%s dbname=%s sslmode=disable",
				postgresConnName, postgresUserIAM, postgresDB),
			IAMAuthN: true,
			opts:     opts,
		},
		{
			driver: "cloudsql-postgres-v5-dns",
			source: fmt.Sprintf("host=%s user=%s password=%s dbname=%s sslmode=disable",
				postgresSANDomainName, postgresUser, postgresCustomerCASPass, postgresDB),
			IAMAuthN: false,
			resolver: true,
			opts:     opts,
		},
	}

	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	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)
	}

	for _, tc := range tests {
		var registerOpts []cloudsqlconn.Option
		registerOpts = append(registerOpts, tc.opts...)
		if tc.IAMAuthN {
			registerOpts = append(registerOpts, cloudsqlconn.WithIAMAuthN())
		}
		if tc.resolver {
			registerOpts = append(registerOpts, cloudsqlconn.WithDNSResolver())
		}
		pgxv5.RegisterDriver(tc.driver, registerOpts...)
		db, err := sql.Open(tc.driver, tc.source)

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

func TestPostgresV4Hook(t *testing.T) {

	// Use WithPrivateIP option if the ipType is set to private
	var opts []cloudsqlconn.Option
	opts = addIPTypeOptions(opts)

	tests := []struct {
		driver   string
		source   string
		IAMAuthN bool
		opts     []cloudsqlconn.Option
	}{
		{
			driver: "cloudsql-postgres-v4",
			source: fmt.Sprintf("host=%s user=%s password=%s dbname=%s sslmode=disable",
				postgresConnName, postgresUser, postgresPass, postgresDB),
			IAMAuthN: false,
			opts:     opts,
		},
		{
			driver: "cloudsql-postgres-iam-v4",
			source: fmt.Sprintf("host=%s user=%s dbname=%s sslmode=disable",
				postgresConnName, postgresUserIAM, postgresDB),
			IAMAuthN: true,
			opts:     opts,
		},
	}
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	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)
	}

	for _, tc := range tests {
		var registerOpts []cloudsqlconn.Option
		registerOpts = append(registerOpts, tc.opts...)
		if tc.IAMAuthN {
			registerOpts = append(registerOpts, cloudsqlconn.WithIAMAuthN())
		}
		pgxv4.RegisterDriver(tc.driver, registerOpts...)
		db, err := sql.Open(tc.driver, tc.source)
		if err != nil {
			t.Fatalf("sql.Open want err = nil, got = %v", err)
		}
		defer db.Close()
		testConn(db)
	}
}

// removeAuthEnvVar retrieves an OAuth2 token and a path to a service account key
// and then unsets GOOGLE_APPLICATION_CREDENTIALS. It returns a cleanup function
// that restores the original setup.
func removeAuthEnvVar(t *testing.T) (*oauth2.Token, *auth.Credentials, string, func()) {
	ts, err := google.DefaultTokenSource(context.Background(),
		"https://www.googleapis.com/auth/cloud-platform",
	)
	if err != nil {
		t.Errorf("failed to resolve token source: %v", err)
	}

	creds, err := credentials.DetectDefault(&credentials.DetectOptions{Scopes: []string{"https://www.googleapis.com/auth/cloud-platform"}})
	if err != nil {
		t.Errorf("failed to resolve auth credentials: %v", err)
	}

	tok, err := ts.Token()
	if err != nil {
		t.Errorf("failed to get token: %v", err)
	}
	if ipType == "private" {
		return tok, creds, "", func() {}
	}
	path, ok := os.LookupEnv("GOOGLE_APPLICATION_CREDENTIALS")
	if !ok {
		t.Fatalf("GOOGLE_APPLICATION_CREDENTIALS was not set in the environment")
	}
	if err := os.Unsetenv("GOOGLE_APPLICATION_CREDENTIALS"); err != nil {
		t.Fatalf("failed to unset GOOGLE_APPLICATION_CREDENTIALS")
	}
	return tok, creds, path, func() {
		os.Setenv("GOOGLE_APPLICATION_CREDENTIALS", path)
	}
}

func keyfile(t *testing.T) string {
	path := os.Getenv("GOOGLE_APPLICATION_CREDENTIALS")
	if path == "" {
		t.Skip("GOOGLE_APPLICATION_CREDENTIALS not set")
	}
	creds, err := os.ReadFile(path)
	if err != nil {
		t.Fatalf("io.ReadAll(): %v", err)
	}
	return string(creds)
}

func TestPostgresAuthentication(t *testing.T) {
	if testing.Short() {
		t.Skip("skipping Postgres integration tests")
	}
	requirePostgresVars(t)
	var creds string
	var opts []cloudsqlconn.Option
	if ipType != "private" {
		creds = keyfile(t)
	}
	opts = addIPTypeOptions(opts)
	tok, authCreds, path, cleanup := removeAuthEnvVar(t)
	defer cleanup()

	tcs := []struct {
		desc string
		opts []cloudsqlconn.Option
	}{
		{
			desc: "with token",
			opts: append(opts, cloudsqlconn.WithTokenSource(
				oauth2.StaticTokenSource(tok),
			)),
		},
		{
			desc: "with auth credentials",
			opts: append(opts, cloudsqlconn.WithCredentials(authCreds)),
		},
	}

	if ipType != "private" {
		tcs = append(tcs,
			struct {
				desc string
				opts []cloudsqlconn.Option
			}{
				desc: "with credentials file",
				opts: append(opts, cloudsqlconn.WithCredentialsFile(path)),
			},
			struct {
				desc string
				opts []cloudsqlconn.Option
			}{
				desc: "with credentials JSON",
				opts: append(opts, cloudsqlconn.WithCredentialsJSON([]byte(creds))),
			},
		)
	}
	for _, tc := range tcs {
		t.Run(tc.desc, func(t *testing.T) {
			ctx := context.Background()

			d, err := cloudsqlconn.NewDialer(ctx, tc.opts...)
			if err != nil {
				t.Fatalf("failed to init Dialer: %v", err)
			}
			defer d.Close()

			dsn := fmt.Sprintf("user=%s password=%s dbname=%s sslmode=disable", postgresUser, postgresPass, postgresDB)
			config, err := pgxpool.ParseConfig(dsn)
			if err != nil {
				t.Fatalf("failed to parse pgx config: %v", err)
			}

			config.ConnConfig.DialFunc = func(ctx context.Context, _ string, _ string) (net.Conn, error) {
				return d.Dial(ctx, postgresConnName)
			}

			pool, err := pgxpool.NewWithConfig(ctx, config)
			if err != nil {
				t.Fatalf("failed to create pool: %s", err)
			}
			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)
		})
	}
}