Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
package dbauth
import (
"context"
"net"
"testing"
"github.com/jackc/pgx/v5"
"github.com/stretchr/testify/require"
)
type fakeGCPDialer struct {
calls []fakeGCPDialerCall
closeCalls int
err error
}
type fakeGCPDialerCall struct {
ctx context.Context
instanceConnectionName string
}
func (d *fakeGCPDialer) Dial(ctx context.Context, instanceConnectionName string) (net.Conn, error) {
d.calls = append(d.calls, fakeGCPDialerCall{
ctx: ctx,
instanceConnectionName: instanceConnectionName,
})
return nil, d.err
}
func (d *fakeGCPDialer) Close() error {
d.closeCalls++
return nil
}
func TestGCPConfigFromPGXConfigDisabled(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://bb:[email protected]:5432/bytebase?sslmode=disable")
authConfig, err := gcpConfigFromPGXConfig(pgxConfig)
require.NoError(t, err)
require.Nil(t, authConfig)
}
func TestGCPConfigFromPGXConfigEnabledURL(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://[email protected]:5432/bytebase?bytebase_gcp_cloud_sql_iam=true&bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance")
authConfig, err := gcpConfigFromPGXConfig(pgxConfig)
require.NoError(t, err)
require.NotNil(t, authConfig)
require.True(t, authConfig.enabled)
require.Equal(t, "project:region:instance", authConfig.instanceConnectionName)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLIAMParam)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLInstanceConnectionNameParam)
}
func TestGCPConfigFromPGXConfigEnabledKeywordValue(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "user=bb dbname=bytebase bytebase_gcp_cloud_sql_iam=true bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance")
authConfig, err := gcpConfigFromPGXConfig(pgxConfig)
require.NoError(t, err)
require.NotNil(t, authConfig)
require.True(t, authConfig.enabled)
require.Equal(t, "project:region:instance", authConfig.instanceConnectionName)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLIAMParam)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLInstanceConnectionNameParam)
}
func TestGCPConfigFromPGXConfigStripsDisabledParams(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://bb:[email protected]:5432/bytebase?bytebase_gcp_cloud_sql_iam=false&bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance")
authConfig, err := gcpConfigFromPGXConfig(pgxConfig)
require.NoError(t, err)
require.Nil(t, authConfig)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLIAMParam)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLInstanceConnectionNameParam)
}
func TestGCPConfigFromPGXConfigRequiresInstanceConnectionName(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://[email protected]:5432/bytebase?bytebase_gcp_cloud_sql_iam=true")
_, err := gcpConfigFromPGXConfig(pgxConfig)
require.ErrorContains(t, err, "bytebase_gcp_cloud_sql_instance_connection_name is required")
}
func TestApplyGCPConfigSetsDialFunc(t *testing.T) {
pgxConfig := &pgx.ConnConfig{}
dialer := &fakeGCPDialer{}
ctx := context.WithValue(context.Background(), contextKey{}, "marker")
applyGCPConfig(pgxConfig, &gcpConfig{
enabled: true,
instanceConnectionName: "project:region:instance",
}, dialer)
require.NotNil(t, pgxConfig.DialFunc)
conn, err := pgxConfig.DialFunc(ctx, "tcp", "ignored:5432")
require.NoError(t, err)
require.Nil(t, conn)
require.Equal(t, []fakeGCPDialerCall{
{
ctx: ctx,
instanceConnectionName: "project:region:instance",
},
}, dialer.calls)
}
func TestConfigureGCPWithDialerReturnsCleanup(t *testing.T) {
pgxConfig := &pgx.ConnConfig{}
dialer := &fakeGCPDialer{}
openOptions, cleanup, err := configureGCPWithDialer(pgxConfig, &gcpConfig{
enabled: true,
instanceConnectionName: "project:region:instance",
}, dialer)
require.NoError(t, err)
require.Empty(t, openOptions)
require.NotNil(t, cleanup)
require.NotNil(t, pgxConfig.DialFunc)
require.NoError(t, cleanup())
require.Equal(t, 1, dialer.closeCalls)
}
func TestConfigureRejectsMultipleMetadataDBAuthProviders(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://[email protected]:5432/bytebase?sslmode=verify-full&bytebase_aws_rds_iam=true&bytebase_aws_region=us-east-1&bytebase_gcp_cloud_sql_iam=true&bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance")
_, _, err := Configure(context.Background(), pgxConfig)
require.ErrorContains(t, err, "multiple metadata database IAM auth providers are enabled")
}
func TestGCPConfigFromPGXConfigParsesIPType(t *testing.T) {
tests := []struct {
name string
param string
expect string
}{
{"default", "", ""},
{"public", "&bytebase_gcp_cloud_sql_ip_type=public", "public"},
{"private", "&bytebase_gcp_cloud_sql_ip_type=private", "private"},
{"psc", "&bytebase_gcp_cloud_sql_ip_type=psc", "psc"},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://[email protected]:5432/bytebase?bytebase_gcp_cloud_sql_iam=true&bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance"+tc.param)
authConfig, err := gcpConfigFromPGXConfig(pgxConfig)
require.NoError(t, err)
require.NotNil(t, authConfig)
require.Equal(t, tc.expect, authConfig.ipType)
require.NotContains(t, pgxConfig.RuntimeParams, gcpCloudSQLIPTypeParam)
})
}
}
func TestGCPConfigFromPGXConfigRejectsInvalidIPType(t *testing.T) {
pgxConfig := mustParsePGXConfig(t, "postgres://[email protected]:5432/bytebase?bytebase_gcp_cloud_sql_iam=true&bytebase_gcp_cloud_sql_instance_connection_name=project:region:instance&bytebase_gcp_cloud_sql_ip_type=bogus")
_, err := gcpConfigFromPGXConfig(pgxConfig)
require.ErrorContains(t, err, gcpCloudSQLIPTypeParam)
}
func TestGCPDialIPOptions(t *testing.T) {
tests := []struct {
name string
ipType string
wantLen int
}{
{"empty defaults to public", "", 0},
{"public", "public", 0},
{"private", "private", 1},
{"psc", "psc", 1},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
require.Len(t, gcpDialIPOptions(tc.ipType), tc.wantLen)
})
}
}
func TestIsKeywordValueRuntimeParamIncludesIPType(t *testing.T) {
require.True(t, IsKeywordValueRuntimeParam(gcpCloudSQLIPTypeParam))
}