IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-01-26 16:27:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

SQLStore: Fix regression in PostgreSQL connection string (#71368)

Browse Source 
* SQLStore: Fix connection string for PostgreSQL

* better testing
This commit is contained in:
Sofia Papagiannaki 2023-07-11 16:47:35 +03:00 committed by GitHub
parent 2e5f733d2d
commit e21872bb15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 89 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/services/sqlstore/sqlstore.go
View File

@ -316,12 +316,14 @@ func (ss *SQLStore) buildConnectionString() (string, error) {
return "", fmt.Errorf("invalid host specifier '%s': %w", ss.dbCfg.Host, err)
}
if ss.dbCfg.User == "" {
ss.dbCfg.User = "''"
args := []any{ss.dbCfg.User, addr.Host, addr.Port, ss.dbCfg.Name, ss.dbCfg.SslMode, ss.dbCfg.ClientCertPath,
ss.dbCfg.ClientKeyPath, ss.dbCfg.CaCertPath}
for i, arg := range args {
if arg == "" {
args[i] = "''"
}
}
cnnstr = fmt.Sprintf("user=%s host=%s port=%s dbname=%s sslmode=%s sslcert=%s sslkey=%s sslrootcert=%s",
ss.dbCfg.User, addr.Host, addr.Port, ss.dbCfg.Name, ss.dbCfg.SslMode, ss.dbCfg.ClientCertPath,
ss.dbCfg.ClientKeyPath, ss.dbCfg.CaCertPath)
cnnstr = fmt.Sprintf("user=%s host=%s port=%s dbname=%s sslmode=%s sslcert=%s sslkey=%s sslrootcert=%s", args...)
if ss.dbCfg.Pwd != "" {
cnnstr += fmt.Sprintf(" password=%s", ss.dbCfg.Pwd)
}

155
pkg/services/sqlstore/sqlstore_test.go
View File

@ -10,87 +10,87 @@ import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/org"
"github.com/grafana/grafana/pkg/setting"
)
type sqlStoreTest struct {
name string
dbType string
dbHost string
dbURL string
dbUser string
dbPwd string
connStrValues []string
connStrExcludedValues []string
err error
name string
dbType string
dbHost string
dbURL string
dbUser string
dbPwd string
expConnStr string
features []string
err error
}
var sqlStoreTestCases = []sqlStoreTest{
{
name: "MySQL IPv4",
dbType: "mysql",
dbHost: "1.2.3.4:5678",
connStrValues: []string{"tcp(1.2.3.4:5678)"},
name: "MySQL IPv4",
dbType: "mysql",
dbHost: "1.2.3.4:5678",
expConnStr: ":@tcp(1.2.3.4:5678)/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true",
},
{
name: "Postgres IPv4",
dbType: "postgres",
dbHost: "1.2.3.4:5678",
connStrValues: []string{"host=1.2.3.4", "port=5678"},
name: "Postgres IPv4",
dbType: "postgres",
dbHost: "1.2.3.4:5678",
expConnStr: "user='' host=1.2.3.4 port=5678 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert=''",
},
{
name: "Postgres IPv4 (Default Port)",
dbType: "postgres",
dbHost: "1.2.3.4",
connStrValues: []string{"host=1.2.3.4", "port=5432"},
name: "Postgres IPv4 (Default Port)",
dbType: "postgres",
dbHost: "1.2.3.4",
expConnStr: "user='' host=1.2.3.4 port=5432 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert=''",
},
{
name: "Postgres username and password",
dbType: "postgres",
dbHost: "1.2.3.4",
dbUser: "grafana",
dbPwd: "password",
connStrValues: []string{"host=1.2.3.4", "port=5432", "user=grafana", "password=password"},
name: "Postgres username and password",
dbType: "postgres",
dbHost: "1.2.3.4",
dbUser: "grafana",
dbPwd: "password",
expConnStr: "user=grafana host=1.2.3.4 port=5432 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert='' password=password",
},
{
name: "Postgres username no password",
dbType: "postgres",
dbHost: "1.2.3.4",
dbUser: "grafana",
dbPwd: "",
connStrValues: []string{"host=1.2.3.4", "port=5432", "user=grafana"},
connStrExcludedValues: []string{"password"},
name: "Postgres username no password",
dbType: "postgres",
dbHost: "1.2.3.4",
dbUser: "grafana",
dbPwd: "",
expConnStr: "user=grafana host=1.2.3.4 port=5432 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert=''",
},
{
name: "MySQL IPv4 (Default Port)",
dbType: "mysql",
dbHost: "1.2.3.4",
connStrValues: []string{"tcp(1.2.3.4)"},
name: "MySQL IPv4 (Default Port)",
dbType: "mysql",
dbHost: "1.2.3.4",
expConnStr: ":@tcp(1.2.3.4)/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true",
},
{
name: "MySQL IPv6",
dbType: "mysql",
dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
connStrValues: []string{"tcp([fe80::24e8:31b2:91df:b177]:1234)"},
name: "MySQL IPv6",
dbType: "mysql",
dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
expConnStr: ":@tcp([fe80::24e8:31b2:91df:b177]:1234)/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true",
},
{
name: "Postgres IPv6",
dbType: "postgres",
dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
connStrValues: []string{"host=fe80::24e8:31b2:91df:b177", "port=1234"},
name: "Postgres IPv6",
dbType: "postgres",
dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
expConnStr: "user='' host=fe80::24e8:31b2:91df:b177 port=1234 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert=''",
},
{
name: "MySQL IPv6 (Default Port)",
dbType: "mysql",
dbHost: "[::1]",
connStrValues: []string{"tcp([::1])"},
name: "MySQL IPv6 (Default Port)",
dbType: "mysql",
dbHost: "[::1]",
expConnStr: ":@tcp([::1])/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true",
},
{
name: "Postgres IPv6 (Default Port)",
dbType: "postgres",
dbHost: "[::1]",
connStrValues: []string{"host=::1", "port=5432"},
name: "Postgres IPv6 (Default Port)",
dbType: "postgres",
dbHost: "[::1]",
expConnStr: "user='' host=::1 port=5432 dbname=test_db sslmode='' sslcert='' sslkey='' sslrootcert=''",
},
{
name: "Invalid database URL",
@ -98,10 +98,18 @@ var sqlStoreTestCases = []sqlStoreTest{
err: &url.Error{Op: "parse", URL: "://invalid.com/", Err: errors.New("missing protocol scheme")},
},
{
name: "Sql mode set to ANSI_QUOTES",
dbType: "mysql",
dbHost: "[::1]",
connStrValues: []string{"sql_mode='ANSI_QUOTES'"},
name: "MySQL with ANSI_QUOTES mode",
dbType: "mysql",
dbHost: "[::1]",
features: []string{featuremgmt.FlagMysqlAnsiQuotes},
expConnStr: ":@tcp([::1])/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true&sql_mode='ANSI_QUOTES'",
},
{
name: "New DB library",
dbType: "mysql",
dbHost: "[::1]",
features: []string{featuremgmt.FlagNewDBLibrary},
expConnStr: ":@tcp([::1])/test_db?collation=utf8mb4_unicode_ci&allowNativePasswords=true&clientFoundRows=true&sql_mode='ANSI_QUOTES'&parseTime=true",
},
}
@ -112,17 +120,11 @@ func TestIntegrationSQLConnectionString(t *testing.T) {
for _, testCase := range sqlStoreTestCases {
t.Run(testCase.name, func(t *testing.T) {
sqlstore := &SQLStore{}
sqlstore.Cfg = makeSQLStoreTestConfig(t, testCase.dbType, testCase.dbHost, testCase.dbUser, testCase.dbPwd, testCase.dbURL)
sqlstore.Cfg = makeSQLStoreTestConfig(t, testCase)
connStr, err := sqlstore.buildConnectionString()
require.Equal(t, testCase.err, err)
for _, connSubStr := range testCase.connStrValues {
require.Contains(t, connStr, connSubStr)
}
for _, connExcludedSubStr := range testCase.connStrExcludedValues {
require.NotContains(t, connStr, connExcludedSubStr)
}
assert.Equal(t, testCase.expConnStr, connStr)
})
}
}
@ -175,27 +177,34 @@ func TestIntegrationIsUniqueConstraintViolation(t *testing.T) {
}
}
func makeSQLStoreTestConfig(t *testing.T, dbType, host, user, password, dbURL string) *setting.Cfg {
func makeSQLStoreTestConfig(t *testing.T, tc sqlStoreTest) *setting.Cfg {
t.Helper()
cfg := setting.NewCfg()
sec, err := cfg.Raw.NewSection("database")
require.NoError(t, err)
_, err = sec.NewKey("type", dbType)
_, err = sec.NewKey("type", tc.dbType)
require.NoError(t, err)
_, err = sec.NewKey("host", host)
_, err = sec.NewKey("host", tc.dbHost)
require.NoError(t, err)
_, err = sec.NewKey("url", dbURL)
_, err = sec.NewKey("url", tc.dbURL)
require.NoError(t, err)
_, err = sec.NewKey("user", user)
_, err = sec.NewKey("user", tc.dbUser)
require.NoError(t, err)
_, err = sec.NewKey("name", "test_db")
require.NoError(t, err)
_, err = sec.NewKey("password", password)
_, err = sec.NewKey("password", tc.dbPwd)
require.NoError(t, err)
cfg.IsFeatureToggleEnabled = func(key string) bool { return true }
cfg.IsFeatureToggleEnabled = func(key string) bool {
for _, f := range tc.features {
if f == key {
return true
}
}
return false
}
return cfg
}