Merge pull request #40 from ZhengYang/master

Generate migration template fix and New migrate command

g_migration.go

@@ -64,12 +64,9 @@ func formatSourceCode(fpath string) {
 	cmd.Run()
 }
 
-const MIGRATION_TPL = `
+const MIGRATION_TPL = `package main
-package main
 
 import (
-	"time"
-
 	"github.com/astaxie/beego/migration"
 )
 

migrate.go

@@ -14,7 +14,13 @@
 
 package main
 
-import "os"
+import (
+	"database/sql"
+	"os"
+	"os/exec"
+	"path"
+	"strings"
+)
 
 var cmdMigrate = &Command{
 	UsageLine: "migrate [Command]",
@@ -22,25 +28,36 @@ var cmdMigrate = &Command{
 	Long: `
 bee migrate
     run all outstanding migrations
+    -driver: [mysql | postgresql | sqlite], the default is mysql
+    -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
 
 bee migrate rollback
     rollback the last migration operation
+    -driver: [mysql | postgresql | sqlite], the default is mysql
+    -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
 
 bee migrate reset
     rollback all migrations
+    -driver: [mysql | postgresql | sqlite], the default is mysql
+    -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
 
 bee migrate refresh
     rollback all migrations and run them all again
+    -driver: [mysql | postgresql | sqlite], the default is mysql
+    -conn:   the connection string used by the driver, the default is root:@tcp(127.0.0.1:3306)/test
 `,
 }
 
+var mDriver docValue
+var mConn docValue
+
 func init() {
 	cmdMigrate.Run = runMigration
+	cmdMigrate.Flag.Var(&mDriver, "driver", "database driver: mysql, postgresql, etc.")
+	cmdMigrate.Flag.Var(&mConn, "conn", "connection string used by the driver to connect to a database instance")
 }
 
 func runMigration(cmd *Command, args []string) {
-	//curpath, _ := os.Getwd()
-
 	gopath := os.Getenv("GOPATH")
 	Debugf("gopath:%s", gopath)
 	if gopath == "" {
@@ -48,43 +65,252 @@ func runMigration(cmd *Command, args []string) {
 		ColorLog("[HINT] Set $GOPATH in your environment vairables\n")
 		os.Exit(2)
 	}
-
+	// getting command line arguments
+	if len(args) != 0 {
+		cmd.Flag.Parse(args[1:])
+	}
+	if mDriver == "" {
+		mDriver = "mysql"
+	}
+	if mConn == "" {
+		mConn = "root:@tcp(127.0.0.1:3306)/test"
+	}
+	ColorLog("[INFO] Using '%s' as 'driver'\n", mDriver)
+	ColorLog("[INFO] Using '%s' as 'conn'\n", mConn)
+	driverStr, connStr := string(mDriver), string(mConn)
 	if len(args) == 0 {
 		// run all outstanding migrations
-		ColorLog("[INFO] running all outstanding migrations\n")
+		ColorLog("[INFO] Running all outstanding migrations\n")
-		migrateUpdate()
+		migrateUpdate(driverStr, connStr)
 	} else {
 		mcmd := args[0]
 		switch mcmd {
 		case "rollback":
-			ColorLog("[INFO] rolling back the last migration operation\n")
+			ColorLog("[INFO] Rolling back the last migration operation\n")
-			migrateRollback()
+			migrateRollback(driverStr, connStr)
 		case "reset":
-			ColorLog("[INFO] reseting all migrations\n")
+			ColorLog("[INFO] Reseting all migrations\n")
-			migrateReset()
+			migrateReset(driverStr, connStr)
 		case "refresh":
-			ColorLog("[INFO] refreshing all migrations\n")
+			ColorLog("[INFO] Refreshing all migrations\n")
-			migrateReset()
+			migrateReset(driverStr, connStr)
 		default:
-			ColorLog("[ERRO] command is missing\n")
+			ColorLog("[ERRO] Command is missing\n")
 			os.Exit(2)
 		}
-		ColorLog("[SUCC] migration successful!\n")
+	}
+	ColorLog("[SUCC] Migration successful!\n")
+}
+
+func checkForSchemaUpdateTable(db *sql.DB) {
+	if rows, err := db.Query("SHOW TABLES LIKE 'migrations'"); err != nil {
+		ColorLog("[ERRO] Could not show migrations table: %s\n", err)
+		os.Exit(2)
+	} else if !rows.Next() {
+		// no migrations table, create anew
+		ColorLog("[INFO] Creating 'migrations' table...\n")
+		if _, err := db.Query(MYSQL_MIGRATION_DDL); err != nil {
+			ColorLog("[ERRO] Could not create migrations table: %s\n", err)
+			os.Exit(2)
+		}
+	}
+	// checking that migrations table schema are expected
+	if rows, err := db.Query("DESC migrations"); err != nil {
+		ColorLog("[ERRO] Could not show columns of migrations table: %s\n", err)
+		os.Exit(2)
+	} else {
+		for rows.Next() {
+			var fieldBytes, typeBytes, nullBytes, keyBytes, defaultBytes, extraBytes []byte
+			if err := rows.Scan(&fieldBytes, &typeBytes, &nullBytes, &keyBytes, &defaultBytes, &extraBytes); err != nil {
+				ColorLog("[ERRO] Could not read column information: %s\n", err)
+				os.Exit(2)
+			}
+			fieldStr, typeStr, nullStr, keyStr, defaultStr, extraStr :=
+				string(fieldBytes), string(typeBytes), string(nullBytes), string(keyBytes), string(defaultBytes), string(extraBytes)
+			if fieldStr == "id_migration" {
+				if keyStr != "PRI" || extraStr != "auto_increment" {
+					ColorLog("[ERRO] Column migration.id_migration type mismatch: KEY: %s, EXTRA: %s\n", keyStr, extraStr)
+					ColorLog("[HINT] Expecting KEY: PRI, EXTRA: auto_increment\n")
+					os.Exit(2)
+				}
+			} else if fieldStr == "name" {
+				if !strings.HasPrefix(typeStr, "varchar") || nullStr != "YES" {
+					ColorLog("[ERRO] Column migration.name type mismatch: TYPE: %s, NULL: %s\n", typeStr, nullStr)
+					ColorLog("[HINT] Expecting TYPE: varchar, NULL: YES\n")
+					os.Exit(2)
+				}
+
+			} else if fieldStr == "created_at" {
+				if typeStr != "timestamp" || defaultStr != "CURRENT_TIMESTAMP" {
+					ColorLog("[ERRO] Column migration.timestamp type mismatch: TYPE: %s, DEFAULT: %s\n", typeStr, defaultStr)
+					ColorLog("[HINT] Expecting TYPE: timestamp, DEFAULT: CURRENT_TIMESTAMP\n")
+					os.Exit(2)
+				}
+			}
+		}
 	}
 }
 
-func migrateUpdate() {
+func getLatestMigration(db *sql.DB) (file string, createdAt string) {
-	println("=>update")
+	sql := "SELECT name, created_at FROM migrations where status = 'update' ORDER BY id_migration DESC LIMIT 1"
+	if rows, err := db.Query(sql); err != nil {
+		ColorLog("[ERRO] Could not retrieve migrations: %s\n", err)
+		os.Exit(2)
+	} else {
+		var fileBytes, createdAtBytes []byte
+		if rows.Next() {
+			if err := rows.Scan(&fileBytes, &createdAtBytes); err != nil {
+				ColorLog("[ERRO] Could not read migrations in database: %s\n", err)
+				os.Exit(2)
+			}
+			file, createdAt = string(fileBytes), string(createdAtBytes)
+		} else {
+			file, createdAt = "", "0"
+		}
+	}
+	return
 }
 
-func migrateRollback() {
+func createTempMigrationDir(path string) {
-	println("=>rollback")
+	if err := os.MkdirAll(path, 0777); err != nil {
+		ColorLog("[ERRO] Could not create path: %s\n", err)
+		os.Exit(2)
+	}
 }
 
-func migrateReset() {
+func writeMigrationSourceFile(filename string, driver string, connStr string, latestTime string, latestName string, task string) {
-	println("=>reset")
+	if f, err := os.OpenFile(filename+".go", os.O_CREATE|os.O_EXCL|os.O_RDWR, 0666); err != nil {
+		ColorLog("[ERRO] Could not create file: %s\n", err)
+		os.Exit(2)
+	} else {
+		content := strings.Replace(MIGRATION_MAIN_TPL, "{{DBDriver}}", driver, -1)
+		content = strings.Replace(content, "{{ConnStr}}", connStr, -1)
+		content = strings.Replace(content, "{{LatestTime}}", latestTime, -1)
+		content = strings.Replace(content, "{{LatestName}}", latestName, -1)
+		content = strings.Replace(content, "{{Task}}", task, -1)
+		if _, err := f.WriteString(content); err != nil {
+			ColorLog("[ERRO] Could not write to file: %s\n", err)
+			os.Exit(2)
+		}
+		f.Close()
+	}
 }
 
-func migrateRefresh() {
+func buildMigrationBinary(filename string) {
-	println("=>refresh")
+	os.Chdir(path.Join("database", "migrations"))
+	cmd := exec.Command("go", "build", "-o", filename)
+	if out, err := cmd.CombinedOutput(); err != nil {
+		ColorLog("[ERRO] Could not build migration binary: %s\n", err)
+		formatShellErrOutput(string(out))
+		os.Exit(2)
 	}
+}
+
+func runMigrationBinary(filename string) {
+	cmd := exec.Command("./" + filename)
+	if out, err := cmd.CombinedOutput(); err != nil {
+		ColorLog("[ERRO] Could not run migration binary\n")
+		os.Exit(2)
+	} else {
+		formatShellOutput(string(out))
+	}
+}
+
+func removeMigrationBinary(path string) {
+	if err := os.Remove(path); err != nil {
+		ColorLog("[ERRO] Could not remove migration binary: %s\n", err)
+		os.Exit(2)
+	}
+}
+
+func migrateUpdate(driver, connStr string) {
+	migrate("upgrade", driver, connStr)
+}
+
+func migrateRollback(driver, connStr string) {
+	migrate("rollback", driver, connStr)
+}
+
+func migrateReset(driver, connStr string) {
+	migrate("reset", driver, connStr)
+}
+
+func migrateRefresh(driver, connStr string) {
+	migrate("refresh", driver, connStr)
+}
+
+func migrate(goal, driver, connStr string) {
+	filepath := path.Join("database", "migrations", "migrate")
+	// connect to database
+	db, err := sql.Open(driver, connStr)
+	if err != nil {
+		ColorLog("[ERRO] Could not connect to %s: %s\n", driver, connStr)
+		os.Exit(2)
+	}
+	defer db.Close()
+	checkForSchemaUpdateTable(db)
+	latestName, latestTime := getLatestMigration(db)
+	writeMigrationSourceFile(filepath, driver, connStr, latestTime, latestName, goal)
+	buildMigrationBinary(filepath)
+	runMigrationBinary(filepath)
+	removeMigrationBinary(filepath)
+}
+
+func formatShellErrOutput(o string) {
+	for _, line := range strings.Split(o, "\n") {
+		if line != "" {
+			ColorLog("[ERRO] -| %s\n", line)
+		}
+	}
+}
+
+func formatShellOutput(o string) {
+	for _, line := range strings.Split(o, "\n") {
+		if line != "" {
+			ColorLog("[INFO] -| %s\n", line)
+		}
+	}
+}
+
+const (
+	MIGRATION_MAIN_TPL = `package main
+
+import(
+	"github.com/astaxie/beego/orm"
+	"github.com/astaxie/beego/migration"
+
+	_ "github.com/go-sql-driver/mysql"
+)
+
+func init(){
+	orm.RegisterDataBase("default", "{{DBDriver}}","{{ConnStr}}")
+}
+
+func main(){
+	task := "{{Task}}"
+	switch task {
+	case "upgrade":
+		migration.Upgrade({{LatestTime}})
+	case "rollback":
+		migration.Rollback("{{LatestName}}")
+	case "reset":
+		migration.Reset()
+	case "refresh":
+		migration.Refresh()
+	}
+}
+
+`
+	MYSQL_MIGRATION_DDL = `
+CREATE TABLE migrations (
+	id_migration int(10) unsigned NOT NULL AUTO_INCREMENT COMMENT 'surrogate key',
+	name varchar(255) DEFAULT NULL COMMENT 'migration name, unique',
+	created_at timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'date migrated or rolled back',
+	statements longtext COMMENT 'SQL statements for this migration',
+	rollback_statements longtext COMMENT 'SQL statment for rolling back migration',
+	status ENUM('update', 'rollback') COMMENT 'update indicates it is a normal migration while rollback means this migration is rolled back',
+	PRIMARY KEY (id_migration),
+	UNIQUE KEY (name)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8 
+`
+)