Add comments and optimize configuration

- Add comments to configuration - Add multi/single value to cmd argument options

Author: mblaschke

sync/config.go

@@ -8,91 +8,143 @@ import (
 var waitGroup sync.WaitGroup
 
 type Filter struct {
+// Exclude as strings (regexp)
 Exclude []string `yaml:"exclude"`
+// compiled regexp excludes
 excludeRegexp []*regexp.Regexp
+
+// Includes as strings (regexp)
 Include []string `yaml:"include"`
+// compiled regexp includes
 includeRegexp []*regexp.Regexp
 }
 
 type Filesystem struct {
+// Remove path
 Path string `yaml:"path"`
+// Local path (optional)
 Local string `yaml:"local"`
+// Filter
 Filter Filter `yaml:"filter"`
+// Connection for filesystem sync (optional, default is Server connection)
 Connection *YamlCommandBuilderConnection `yaml:"connection"`
 Options struct {
+// Generate stubs (small example files) instead of fetching files from remote
 GenerateStubs bool `yaml:"generate-stubs"`
 } `yaml:"options"`
 }
 
 type DatabaseOptions struct {
+// Clear database with DROP/CREATE before sync
 ClearDatabase bool `yaml:"clear-database"`
-Mysqldump string `yaml:"mysqldump"`
-Mysql string `yaml:"mysql"`
-Pgdump string `yaml:"pgdump"`
-Psql string `yaml:"psql"`
+// Arguments for mysqldump command
+Mysqldump *YamlStringArray `yaml:"mysqldump"`
+// Arguments for mysql command
+Mysql *YamlStringArray `yaml:"mysql"`
+// Arguments for pgdump command
+Pgdump *YamlStringArray `yaml:"pgdump"`
+// Arguments for psql command
+Psql *YamlStringArray `yaml:"psql"`
 }
 
 type EnvironmentVar struct {
+// Name of variable
 Name string `yaml:"name"`
+// Value of variable
 Value string `yaml:"value"`
 }
 
 type Database struct {
+// Type of database (either mysql or postgres)
 Type string `yaml:"type"`
+// Database name on remote database server
 Db string `yaml:"database"`
+// Hostname of remote database server
 Hostname string `yaml:"hostname"`
+// Port of remote database server
 Port string `yaml:"port"`
+// Username of remote database server
 User string `yaml:"user"`
+// Password of remote database server
 Password string `yaml:"password"`
 
+// Table filter
 Filter Filter `yaml:"filter"`
+// Connection for database sync (optional, default is Server connection)
 Connection *YamlCommandBuilderConnection `yaml:"connection"`
+// Database options
 Options DatabaseOptions `yaml:"options"`
 
 Local struct {
-Type string `yaml:"type"`
+// Database name on local database server
 Db string `yaml:"database"`
+// Hostname of local database server
 Hostname string `yaml:"hostname"`
+// Port of local database server
 Port string `yaml:"port"`
+// Username of local database server
 User string `yaml:"user"`
+// Password of local database server
 Password string `yaml:"password"`
 
+// Connection for database sync (optional, default is empty)
 Connection *YamlCommandBuilderConnection `yaml:"connection"`
+
+// Database options
 Options DatabaseOptions `yaml:"options"`
 } `yaml:"local"`
 
-// local cache
+// local cache for remote table list
 cacheRemoteTableList []string
+// local cache for local table list
 cacheLocalTableList []string
 }
 
 type Execution struct {
+// Type of execution (remote or local)
 Type string `yaml:"type"`
+// Command as string or as elements
 Command YamlStringArray `yaml:"command"`
+// Workdir for execution
 Workdir string `yaml:"workdir"`
+
+// Environment variables
 Environment []EnvironmentVar `yaml:"environment"`
+
+// Execution options
 Options struct {
 } `yaml:"options"`
 }
 
 type Server struct {
+// General working path (for filesystem syncs)
 Path string `yaml:"path"`
+// General connection (default for all remote connections)
 Connection *YamlCommandBuilderConnection `yaml:"connection"`
+// Filesystem sync list
 Filesystem []Filesystem `yaml:"filesystem"`
+// Database sync list
 Database []Database `yaml:"database"`
+// Startup execution list (executed before sync)
 ExecStartup []Execution `yaml:"exec-startup"`
+// Finish execution list (executed after sync)
 ExecFinish []Execution `yaml:"exec-finish"`
 
 runConfiguration *RunConfiguration
 }
 
 type SyncConfig struct {
+// Sync (remote -> local) configurations
 Sync map[string]Server `yaml:"sync"`
+// Deploy (local -> remote) configurations
 Deploy map[string]Server `yaml:"deploy"`
 }
 
 type RunConfiguration struct {
+// Enable database sync
 Database bool
+// Enable filesystem sync
 Filesystem bool
+// Enable exec runner
 Exec bool
 }

sync/database_mysql_local.go

@@ -10,8 +10,8 @@ func (database *DatabaseMysql) localMysqldumpCmdBuilder(additionalArgs []string,
 connection := database.Local.Connection.GetInstance().Clone()
 
 // add custom options (raw)
-if database.Local.Options.Mysqldump != "" {
-args = append(args, database.Local.Options.Mysqldump)
+if database.Local.Options.Mysqldump != nil {
+args = append(args, database.Local.Options.Mysqldump.Array()...)
 }
 
 if database.Local.User != "" {
@@ -57,8 +57,8 @@ func (database *DatabaseMysql) localMysqlCmdBuilder(additonalArgs ...string) []i
 connection := database.Local.Connection.GetInstance().Clone()
 
 // add custom options (raw)
-if database.Local.Options.Mysql != "" {
-args = append(args, database.Local.Options.Mysql)
+if database.Local.Options.Mysql != nil {
+args = append(args, database.Local.Options.Mysql.Array()...)
 }
 
 args = append(args, "-BN")

sync/database_mysql_remote.go

@@ -47,8 +47,8 @@ func (database *DatabaseMysql) remoteMysqldumpCmdBuilder(additionalArgs []string
 cmd := []string{"mysqldump"}
 
 // add custom options (raw)
-if database.Options.Mysqldump != "" {
-cmd = append(cmd, database.Options.Mysqldump)
+if database.Options.Mysqldump != nil {
+cmd = append(cmd, database.Options.Mysqldump.Array()...)
 }
 
 cmd = append(cmd, args...)
@@ -63,8 +63,8 @@ func (database *DatabaseMysql) remoteMysqlCmdBuilder(additonalArgs ...string) []
 connection := database.Connection.GetInstance().Clone()
 
 // append options in raw
-if database.Options.Mysql != "" {
-args = append(args, database.Options.Mysql)
+if database.Options.Mysql != nil {
+args = append(args, database.Options.Mysql.Array()...)
 }
 
 args = append(args, "-BN")
@@ -103,8 +103,8 @@ func (database *DatabaseMysql) remoteMysqlCmdBuilderUncompress(additonalArgs ...
 connection := database.Connection.GetInstance().Clone()
 
 // add custom options (raw)
-if database.Options.Mysql != "" {
-args = append(args, database.Options.Mysql)
+if database.Options.Mysql != nil {
+args = append(args, database.Options.Mysql.Array()...)
 }
 
 args = append(args, "-BN")

sync/database_postgres_local.go

@@ -8,8 +8,8 @@ func (database *DatabasePostgres) localPgdumpCmdBuilder(additionalArgs []string,
 connection := database.Local.Connection.GetInstance().Clone()
 
 // add custom options (raw)
-if database.Local.Options.Pgdump != "" {
-args = append(args, database.Local.Options.Pgdump)
+if database.Local.Options.Pgdump != nil {
+args = append(args, database.Local.Options.Pgdump.Array()...)
 }
 
 if database.Local.User != "" {
@@ -55,8 +55,8 @@ func (database *DatabasePostgres) localPsqlCmdBuilder(additonalArgs ...string) [
 connection := database.Local.Connection.GetInstance().Clone()
 
 // add custom options (raw)
-if database.Local.Options.Psql != "" {
-args = append(args, database.Local.Options.Psql)
+if database.Local.Options.Psql != nil {
+args = append(args, database.Local.Options.Psql.Array()...)
 }
 
 args = append(args, "-t")

sync/database_postgres_remote.go

@@ -46,8 +46,8 @@ func (database *DatabasePostgres) remotePgdumpCmdBuilder(additionalArgs []string
 cmd := []string{"pg_dump"}
 
 // add custom options (raw)
-if database.Options.Pgdump != "" {
-cmd = append(cmd, database.Options.Pgdump)
+if database.Options.Pgdump != nil {
+cmd = append(cmd, database.Options.Pgdump.Array()...)
 }
 
 cmd = append(cmd, args...)
@@ -62,8 +62,8 @@ func (database *DatabasePostgres) remotePsqlCmdBuilder(additonalArgs ...string)
 connection := database.Connection.GetInstance().Clone()
 
 // append options in raw
-if database.Options.Psql != "" {
-args = append(args, database.Options.Psql)
+if database.Options.Psql != nil {
+args = append(args, database.Options.Psql.Array()...)
 }
 
 args = append(args, "-t")
@@ -117,8 +117,8 @@ func (database *DatabasePostgres) remotePsqlCmdBuilderUncompress(args ...string)
 }
 
 // add custom options (raw)
-if database.Options.Psql != "" {
-args = append(args, database.Options.Psql)
+if database.Options.Psql != nil {
+args = append(args, database.Options.Psql.Array()...)
 }
 
 if database.Db != "" {