Parse database host correctly when using IPv6

2025-02-25 18:55:37 -06:00 · 2019-01-25 21:56:19 +00:00
parent c7b556c0e4
commit c208186f26
5 changed files with 182 additions and 15 deletions
--- a/pkg/services/sqlstore/sqlstore_test.go
+++ b/pkg/services/sqlstore/sqlstore_test.go
@@ -0,0 +1,101 @@
+package sqlstore
+
+import (
+	"testing"
+
+	. "github.com/smartystreets/goconvey/convey"
+
+	"github.com/grafana/grafana/pkg/setting"
+)
+
+type sqlStoreTest struct {
+	name string
+	dbType string
+	dbHost string
+	connStrValues []string
+}
+
+var sqlStoreTestCases = []sqlStoreTest {
+	sqlStoreTest {
+		name: "MySQL IPv4",
+		dbType: "mysql",
+		dbHost: "1.2.3.4:5678",
+		connStrValues: []string {"tcp(1.2.3.4:5678)"},
+	},
+	sqlStoreTest {
+		name: "Postgres IPv4",
+		dbType: "postgres",
+		dbHost: "1.2.3.4:5678",
+		connStrValues: []string {"host=1.2.3.4", "port=5678"},
+	},
+	sqlStoreTest {
+		name: "Postgres IPv4 (Default Port)",
+		dbType: "postgres",
+		dbHost: "1.2.3.4",
+		connStrValues: []string {"host=1.2.3.4", "port=5432"},
+	},
+	sqlStoreTest {
+		name: "MySQL IPv4 (Default Port)",
+		dbType: "mysql",
+		dbHost: "1.2.3.4",
+		connStrValues: []string {"tcp(1.2.3.4)"},
+	},
+	sqlStoreTest {
+		name: "MySQL IPv6",
+		dbType: "mysql",
+		dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
+		connStrValues: []string {"tcp([fe80::24e8:31b2:91df:b177]:1234)"},
+	},
+	sqlStoreTest {
+		name: "Postgres IPv6",
+		dbType: "postgres",
+		dbHost: "[fe80::24e8:31b2:91df:b177]:1234",
+		connStrValues: []string {"host=fe80::24e8:31b2:91df:b177", "port=1234"},
+	},
+	sqlStoreTest {
+		name: "MySQL IPv6 (Default Port)",
+		dbType: "mysql",
+		dbHost: "::1",
+		connStrValues: []string {"tcp(::1)"},
+	},
+	sqlStoreTest {
+		name: "Postgres IPv6 (Default Port)",
+		dbType: "postgres",
+		dbHost: "::1",
+		connStrValues: []string {"host=::1", "port=5432"},
+	},
+}
+
+func TestSqlConnectionString(t *testing.T) {
+	Convey("Testing SQL Connection Strings", t, func() {
+		t.Helper()
+
+		for _, testCase := range sqlStoreTestCases {
+			Convey(testCase.name, func() {
+				sqlstore := &SqlStore{}
+				sqlstore.Cfg = makeSqlStoreTestConfig(testCase.dbType, testCase.dbHost)
+				sqlstore.readConfig()
+
+				connStr, err := sqlstore.buildConnectionString()
+
+				So(err, ShouldBeNil)
+				for _, connSubStr := range testCase.connStrValues {
+					So(connStr, ShouldContainSubstring, connSubStr)
+				}
+			})
+		}
+	})
+}
+
+func makeSqlStoreTestConfig(dbType string, host string) *setting.Cfg {
+	cfg := setting.NewCfg()
+
+	sec, _ := cfg.Raw.NewSection("database")
+	sec.NewKey("type", dbType)
+	sec.NewKey("host", host)
+	sec.NewKey("user", "user")
+	sec.NewKey("name", "test_db")
+	sec.NewKey("password", "pass")
+
+	return cfg;
+}