Merge pull request #38 from kamil-holubicki/DISTMYSQL-421

DISTMYSQL-421: Remove master-slave terminologies in Orchestrator

Author: kamil-holubicki

docker/Dockerfile.system

@@ -19,15 +19,21 @@ RUN git clone -b $ci_env_branch $ci_env_repo # cache
 
 # Setup dbdeployer
 RUN mkdir /dbdeployer
-RUN (cd /dbdeployer && wget https://github.com/datacharmer/dbdeployer/releases/download/v1.64.0/dbdeployer-1.64.0.linux.tar.gz)
-RUN (cd /dbdeployer && tar -xf dbdeployer-1.64.0.linux.tar.gz)
-RUN (cd /dbdeployer && ln -s dbdeployer-1.64.0.linux dbdeployer)
+RUN (cd /dbdeployer && wget https://github.com/datacharmer/dbdeployer/releases/download/v1.73.0/dbdeployer-1.73.0.linux.tar.gz)
+RUN (cd /dbdeployer && tar -xf dbdeployer-1.73.0.linux.tar.gz)
+RUN (cd /dbdeployer && ln -s dbdeployer-1.73.0.linux dbdeployer)
 RUN (cd /dbdeployer && ./dbdeployer defaults update reserved-ports '0')
 RUN (cd /orchestrator/orchestrator-ci-env/bin/linux && ln -s /dbdeployer/dbdeployer)
 
+# Temporary solution:
+# dbdeployer patched to work with PS 8.4
+COPY docker/resources/dbdeployer /dbdeployer/dbdeployer84
+RUN (cd /dbdeployer && ./dbdeployer84 defaults update reserved-ports '0')
+RUN (cd /orchestrator/orchestrator-ci-env/bin/linux && ln -s /dbdeployer/dbdeployer84)
+
 # For dev purposes only, just to avoid downloading over and over via download-mysql script
 # RUN (mkdir /orchestrator/orchestrator-ci-env/mysql-tarballs-downloaded)
-# COPY docker/Percona-Server-8.0.30-22-Linux.x86_64.glibc2.17-minimal.tar.gz /orchestrator/orchestrator-ci-env/mysql-tarballs-downloaded/ 
+# COPY docker/mysql-8.4.0-linux-glibc2.17-x86_64-minimal.tar.xz /orchestrator/orchestrator-ci-env/mysql-tarballs-downloaded/ 
 
 RUN (cd /orchestrator/orchestrator-ci-env && cp bin/linux/systemctl.py /usr/bin/systemctl)
 RUN (cd /orchestrator/orchestrator-ci-env && script/deploy-haproxy)

docker/Dockerfile.test

@@ -2,7 +2,7 @@ FROM golang:1.20.3-bullseye
 LABEL maintainer="[email protected]"
 
 RUN apt-get update
-RUN apt-get install -y lsb-release rsync libaio1 numactl sqlite3
+RUN apt-get install -y lsb-release rsync libaio1 numactl sqlite3 libncurses5 libtinfo5
 RUN rm -rf /var/lib/apt/lists/*
 
 ENV WORKPATH /go/src/github.com/openark/orchestrator

docker/resources/dbdeployer

@@ -23,6 +23,7 @@ github.com/go-martini/martini v0.0.0-20170121215854-22fa46961aab h1:xveKWz2iauee
 github.com/go-martini/martini v0.0.0-20170121215854-22fa46961aab/go.mod h1:/P9AEU963A2AYjv4d1V5eVL1CQbEJq6aCNHDDjibzu8=
 github.com/go-sql-driver/mysql v1.6.0 h1:BCTh4TKNUYmOmMUcQ3IipzF5prigylS7XXjEkfCHuOE=
 github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
+github.com/go-sql-driver/mysql v1.7.1/go.mod h1:OXbVy3sEdcQ2Doequ6Z5BW6fXNQTmx+9S1MCJN5yJMI=
 github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=
 github.com/google/btree v1.0.0 h1:0udJVsspx3VBr5FwtLhQQtuAsVc79tTq0ocGIPAU6qo=
 github.com/google/btree v1.0.0/go.mod h1:lNA+9X1NB3Zf8V7Ke586lFgjr2dZNuvo3lPJSGZ5JPQ=

go.sum

@@ -136,7 +136,7 @@ func main() {
 
 	if len(flag.Args()) == 0 && *command == "" {
 		// No command, no argument: just prompt
-		fmt.Println(app.AppPrompt)
+		fmt.Print(app.AppPrompt)
 		return
 	}
 

go/cmd/orchestrator/main.go

@@ -107,7 +107,7 @@ func openTopology(host string, port int, readTimeout int) (db *sql.DB, err error
 			return nil, err
 		}
 	}
-	sqlUtilsLogger := SqlUtilsLogger{client_context: host + ":" + strconv.Itoa(port)}
+	sqlUtilsLogger := SqlUtilsLogger{client_context: host + ":" + strconv.Itoa(port), backend_connection: false}
 	if db, _, err = sqlutils.GetDB(mysql_uri, sqlUtilsLogger); err != nil {
 		return nil, err
 	}
@@ -131,7 +131,7 @@ func openOrchestratorMySQLGeneric() (db *sql.DB, fromCache bool, err error) {
 	if config.Config.MySQLOrchestratorUseMutualTLS {
 		uri, _ = SetupMySQLOrchestratorTLS(uri)
 	}
-	sqlUtilsLogger := SqlUtilsLogger{client_context: config.Config.MySQLOrchestratorHost + ":" + strconv.FormatUint(uint64(config.Config.MySQLOrchestratorPort), 10)}
+	sqlUtilsLogger := SqlUtilsLogger{client_context: config.Config.MySQLOrchestratorHost + ":" + strconv.FormatUint(uint64(config.Config.MySQLOrchestratorPort), 10), backend_connection: true}
 	return sqlutils.GetDB(uri, sqlUtilsLogger)
 }
 
@@ -200,7 +200,7 @@ func OpenOrchestrator() (db *sql.DB, err error) {
 			}
 		}
 		dsn := getMySQLURI()
-		sqlUtilsLogger := SqlUtilsLogger{client_context: config.Config.MySQLOrchestratorHost + ":" + strconv.FormatUint(uint64(config.Config.MySQLOrchestratorPort), 10)}
+		sqlUtilsLogger := SqlUtilsLogger{client_context: config.Config.MySQLOrchestratorHost + ":" + strconv.FormatUint(uint64(config.Config.MySQLOrchestratorPort), 10), backend_connection: true}
 		db, fromCache, err = sqlutils.GetDB(dsn, sqlUtilsLogger)
 		if err == nil && !fromCache {
 			log.Debugf("Connected to orchestrator backend: %v", safeMySQLURI(dsn))

go/db/db.go

@@ -57,22 +57,48 @@ func init() {
 }
 
 type SqlUtilsLogger struct {
-	client_context string
+	client_context     string
+	backend_connection bool
 }
 
 func (logger SqlUtilsLogger) OnError(caller_context string, query string, err error) error {
-	query = strings.Join(strings.Fields(query), " ")  // trim whitespaces
-	query = strings.Replace(query, "%", "%%", -1)  // escape %
+	query = strings.Join(strings.Fields(query), " ") // trim whitespaces
+	query = strings.Replace(query, "%", "%%", -1)    // escape %
 
 	msg := fmt.Sprintf("%+v(%+v) %+v: %+v",
-						caller_context,
-						logger.client_context,
-						query,
-						err)
+		caller_context,
+		logger.client_context,
+		query,
+		err)
 
 	return log.Errorf(msg)
 }
 
+// This validator is for dev purposes only. Call of this validator is
+// disabled in sqlutils.go
+var query_whitelist = []string{
+	"substring_index(host, ':', 1) as slave_hostname",
+}
+
+func (logger SqlUtilsLogger) ValidateQuery(query string) {
+	if logger.backend_connection {
+		return
+	}
+
+	// check if whitelisted
+	for i := 0; i < len(query_whitelist); i++ {
+		if strings.Contains(query, query_whitelist[i]) {
+			return
+		}
+	}
+
+	lquery := strings.ToLower(query)
+	if strings.Contains(lquery, "master") || strings.Contains(lquery, "slave") {
+		log.Error("QUERY CONTAINS MASTER / SLAVE: ")
+		// panic("Query contains master/slave: " + query)
+	}
+}
+
 func requiresTLS(host string, port int, mysql_uri string) bool {
 	cacheKey := fmt.Sprintf("%s:%d", host, port)
 
@@ -82,7 +108,7 @@ func requiresTLS(host string, port int, mysql_uri string) bool {
 	}
 
 	required := false
-	sqlUtilsLogger := SqlUtilsLogger{client_context: host + ":" + strconv.Itoa(port)}
+	sqlUtilsLogger := SqlUtilsLogger{client_context: host + ":" + strconv.Itoa(port), backend_connection: false}
 	db, _, _ := sqlutils.GetDB(mysql_uri, sqlUtilsLogger)
 	if err := db.Ping(); err != nil && (strings.Contains(err.Error(), Error3159) || strings.Contains(err.Error(), Error1045)) {
 		required = true

go/db/tls.go

@@ -170,20 +170,34 @@ func (this *RowMap) GetTime(key string) time.Time {
 	return time.Time{}
 }
 
+func validateQuery(query string, db *sql.DB) {
+	// dev purposes only. Remove this return to call query validator function.
+	return
+
+	knownDBsMutex.RLock()
+	defer knownDBsMutex.RUnlock()
+
+	if logger, exists := DB2logger[db]; exists && logger != nil {
+		logger.ValidateQuery((query))
+	}
+}
+
 // knownDBs is a DB cache by uri
 var knownDBs map[string]*sql.DB = make(map[string]*sql.DB)
 var knownDBsMutex = &sync.RWMutex{}
 
 type Logger interface {
 	OnError(context string, query string, err error) error
+	ValidateQuery(query string)
 }
+
 // it is also protected by knownDBsMutex
 var DB2logger map[*sql.DB]Logger = make(map[*sql.DB]Logger)
 
 // GetDB returns a DB instance based on uri.
 // logger parameter is optional. If nil, internal logging will be used.
 // bool result indicates whether the DB was returned from cache; err
-func GetGenericDB(driverName, dataSourceName string ,logger Logger) (*sql.DB, bool, error) {
+func GetGenericDB(driverName, dataSourceName string, logger Logger) (*sql.DB, bool, error) {
 	knownDBsMutex.Lock()
 	defer func() {
 		knownDBsMutex.Unlock()
@@ -221,7 +235,7 @@ func GetSQLiteDB(dbFile string, logger Logger) (*sql.DB, bool, error) {
 func RowToArray(rows *sql.Rows, columns []string) []CellData {
 	buff := make([]interface{}, len(columns))
 	data := make([]CellData, len(columns))
-	for i, _ := range buff {
+	for i := range buff {
 		buff[i] = data[i].NullString()
 	}
 	rows.Scan(buff...)
@@ -265,12 +279,10 @@ func ScanRowsToMaps(rows *sql.Rows, on_row func(RowMap) error) error {
 	return err
 }
 
-func logErrorInternal(context string, db *sql.DB, query string, err error) error{
+func logErrorInternal(context string, db *sql.DB, query string, err error) error {
 	// find logger registered by the client
 	knownDBsMutex.RLock()
-	defer func() {
-		knownDBsMutex.RUnlock()
-	}()
+	defer knownDBsMutex.RUnlock()
 
 	if logger, exists := DB2logger[db]; exists && logger != nil {
 		return logger.OnError(context, query, err)
@@ -282,6 +294,7 @@ func logErrorInternal(context string, db *sql.DB, query string, err error) error
 // QueryRowsMap is a convenience function allowing querying a result set while poviding a callback
 // function activated per read row.
 func QueryRowsMap(db *sql.DB, query string, on_row func(RowMap) error, args ...interface{}) (err error) {
+	validateQuery(query, db)
 	defer func() {
 		if derr := recover(); derr != nil {
 			err = fmt.Errorf("QueryRowsMap unexpected error: %+v", derr)
@@ -302,6 +315,7 @@ func QueryRowsMap(db *sql.DB, query string, on_row func(RowMap) error, args ...i
 
 // queryResultData returns a raw array of rows for a given query, optionally reading and returning column names
 func queryResultData(db *sql.DB, query string, retrieveColumns bool, args ...interface{}) (resultData ResultData, columns []string, err error) {
+	validateQuery(query, db)
 	defer func() {
 		if derr := recover(); derr != nil {
 			err = errors.New(fmt.Sprintf("QueryRowsMap unexpected error: %+v", derr))
@@ -358,6 +372,7 @@ func QueryRowsMapBuffered(db *sql.DB, query string, on_row func(RowMap) error, a
 
 // ExecNoPrepare executes given query using given args on given DB, without using prepared statements.
 func ExecNoPrepare(db *sql.DB, query string, args ...interface{}) (res sql.Result, err error) {
+	validateQuery(query, db)
 	defer func() {
 		if derr := recover(); derr != nil {
 			err = errors.New(fmt.Sprintf("ExecNoPrepare unexpected error: %+v", derr))
@@ -374,6 +389,7 @@ func ExecNoPrepare(db *sql.DB, query string, args ...interface{}) (res sql.Resul
 // ExecQuery executes given query using given args on given DB. It will safele prepare, execute and close
 // the statement.
 func execInternal(silent bool, db *sql.DB, query string, args ...interface{}) (res sql.Result, err error) {
+	validateQuery(query, db)
 	defer func() {
 		if derr := recover(); derr != nil {
 			err = errors.New(fmt.Sprintf("execInternal unexpected error: %+v", derr))

go/golib/sqlutils/sqlutils.go

@@ -206,7 +206,7 @@ func UpdateClusterAliases() error {
 			// MySQL backend (Orchestrator supports only SQLite and MySQL backends)
 			// INSERT ON DUPLICATE KEY UPDATE is more performant than REPLACE in MySQL
 			err = updateClusterAliasesUsingInsert()
-			if (err != nil) {
+			if err != nil {
 				// Fallback to the original, safe implementation
 				err = updateClusterAliasesUsingReplace()
 			}

go/inst/cluster_alias_dao.go

@@ -148,6 +148,9 @@ type Instance struct {
 
 	// Primary of the replication group
 	ReplicationGroupPrimaryInstanceKey InstanceKey
+
+	// Query string provider
+	QSP QueryStringProvider
 }
 
 // NewInstance creates a new, empty instance