Rename db Engines related functions (#17481)

lunny · wxiaoguang · web-flow · commit 63c0dc89ef96 · 2021-10-30T22:32:11.000+08:00
* Rename db Engines related functions

Co-authored-by: wxiaoguang &lt;wxiaoguang@gmail.com&gt;
diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -65,7 +65,7 @@ func initDBDisableConsole(disableConsole bool) error {
 	setting.InitDBConfig()
 
 	setting.NewXORMLogService(disableConsole)
-	if err := db.SetEngine(); err != nil {
+	if err := db.InitEngine(); err != nil {
 		return fmt.Errorf("models.SetEngine: %v", err)
 	}
 	return nil
diff --git a/cmd/doctor.go b/cmd/doctor.go
@@ -96,7 +96,7 @@ func runRecreateTable(ctx *cli.Context) error {
 	setting.Cfg.Section("log").Key("XORM").SetValue(",")
 
 	setting.NewXORMLogService(!ctx.Bool("debug"))
-	if err := db.SetEngine(); err != nil {
+	if err := db.InitEngine(); err != nil {
 		fmt.Println(err)
 		fmt.Println("Check if you are using the right config file. You can use a --config directive to specify one.")
 		return nil
@@ -114,7 +114,7 @@ func runRecreateTable(ctx *cli.Context) error {
 	}
 	recreateTables := migrations.RecreateTables(beans...)
 
-	return db.NewEngine(context.Background(), func(x *xorm.Engine) error {
+	return db.InitEngineWithMigration(context.Background(), func(x *xorm.Engine) error {
 		if err := migrations.EnsureUpToDate(x); err != nil {
 			return err
 		}
diff --git a/cmd/dump.go b/cmd/dump.go
@@ -173,7 +173,7 @@ func runDump(ctx *cli.Context) error {
 	}
 	setting.NewServices() // cannot access session settings otherwise
 
-	err := db.SetEngine()
+	err := db.InitEngine()
 	if err != nil {
 		return err
 	}
diff --git a/cmd/migrate.go b/cmd/migrate.go
@@ -35,7 +35,7 @@ func runMigrate(ctx *cli.Context) error {
 	log.Info("Configuration file: %s", setting.CustomConf)
 	setting.InitDBConfig()
 
-	if err := db.NewEngine(context.Background(), migrations.Migrate); err != nil {
+	if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {
 		log.Fatal("Failed to initialize ORM engine: %v", err)
 		return err
 	}
diff --git a/cmd/migrate_storage.go b/cmd/migrate_storage.go
@@ -118,7 +118,7 @@ func runMigrateStorage(ctx *cli.Context) error {
 	log.Info("Configuration file: %s", setting.CustomConf)
 	setting.InitDBConfig()
 
-	if err := db.NewEngine(context.Background(), migrations.Migrate); err != nil {
+	if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {
 		log.Fatal("Failed to initialize ORM engine: %v", err)
 		return err
 	}
diff --git a/contrib/pr/checkout.go b/contrib/pr/checkout.go
@@ -95,7 +95,7 @@ func runPR() {
 	setting.Database.LogSQL = true
 	//x, err = xorm.NewEngine("sqlite3", "file::memory:?cache=shared")
 
-	db.NewEngine(context.Background(), func(_ *xorm.Engine) error {
+	db.InitEngineWithMigration(context.Background(), func(_ *xorm.Engine) error {
 		return nil
 	})
 	db.HasEngine = true
diff --git a/integrations/migration-test/migration_test.go b/integrations/migration-test/migration_test.go
@@ -256,21 +256,21 @@ func doMigrationTest(t *testing.T, version string) {
 
 	setting.NewXORMLogService(false)
 
-	err := db.NewEngine(context.Background(), wrappedMigrate)
+	err := db.InitEngineWithMigration(context.Background(), wrappedMigrate)
 	assert.NoError(t, err)
 	currentEngine.Close()
 
 	beans, _ := db.NamesToBean()
 
-	err = db.NewEngine(context.Background(), func(x *xorm.Engine) error {
+	err = db.InitEngineWithMigration(context.Background(), func(x *xorm.Engine) error {
 		currentEngine = x
 		return migrations.RecreateTables(beans...)(x)
 	})
 	assert.NoError(t, err)
 	currentEngine.Close()
 
 	// We do this a second time to ensure that there is not a problem with retained indices
-	err = db.NewEngine(context.Background(), func(x *xorm.Engine) error {
+	err = db.InitEngineWithMigration(context.Background(), func(x *xorm.Engine) error {
 		currentEngine = x
 		return migrations.RecreateTables(beans...)(x)
 	})
diff --git a/models/db/engine.go b/models/db/engine.go
@@ -95,8 +95,8 @@ func init() {
 	}
 }
 
-// GetNewEngine returns a new xorm engine from the configuration
-func GetNewEngine() (*xorm.Engine, error) {
+// NewEngine returns a new xorm engine from the configuration
+func NewEngine() (*xorm.Engine, error) {
 	connStr, err := setting.DBConnStr()
 	if err != nil {
 		return nil, err
@@ -128,11 +128,11 @@ func syncTables() error {
 	return x.StoreEngine("InnoDB").Sync2(tables...)
 }
 
-// NewInstallTestEngine creates a new xorm.Engine for testing during install
+// InitInstallEngineWithMigration creates a new xorm.Engine for testing during install
 //
 // This function will cause the basic database schema to be created
-func NewInstallTestEngine(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
-	x, err = GetNewEngine()
+func InitInstallEngineWithMigration(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
+	x, err = NewEngine()
 	if err != nil {
 		return fmt.Errorf("failed to connect to database: %w", err)
 	}
@@ -160,9 +160,9 @@ func NewInstallTestEngine(ctx context.Context, migrateFunc func(*xorm.Engine) er
 	return syncTables()
 }
 
-// SetEngine sets the xorm.Engine
-func SetEngine() (err error) {
-	x, err = GetNewEngine()
+// InitEngine sets the xorm.Engine
+func InitEngine() (err error) {
+	x, err = NewEngine()
 	if err != nil {
 		return fmt.Errorf("Failed to connect to database: %v", err)
 	}
@@ -178,13 +178,13 @@ func SetEngine() (err error) {
 	return nil
 }
 
-// NewEngine initializes a new xorm.Engine
+// InitEngineWithMigration initializes a new xorm.Engine
 // This function must never call .Sync2() if the provided migration function fails.
 // When called from the "doctor" command, the migration function is a version check
 // that prevents the doctor from fixing anything in the database if the migration level
 // is different from the expected value.
-func NewEngine(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
-	if err = SetEngine(); err != nil {
+func InitEngineWithMigration(ctx context.Context, migrateFunc func(*xorm.Engine) error) (err error) {
+	if err = InitEngine(); err != nil {
 		return err
 	}
 
diff --git a/models/migrations/migrations_test.go b/models/migrations/migrations_test.go
@@ -84,9 +84,9 @@ func removeAllWithRetry(dir string) error {
 	return err
 }
 
-// SetEngine sets the xorm.Engine
-func SetEngine() (*xorm.Engine, error) {
-	x, err := db.GetNewEngine()
+// newEngine sets the xorm.Engine
+func newEngine() (*xorm.Engine, error) {
+	x, err := db.NewEngine()
 	if err != nil {
 		return x, fmt.Errorf("Failed to connect to database: %v", err)
 	}
@@ -212,7 +212,7 @@ func prepareTestEnv(t *testing.T, skip int, syncModels ...interface{}) (*xorm.En
 		return nil, deferFn
 	}
 
-	x, err := SetEngine()
+	x, err := newEngine()
 	assert.NoError(t, err)
 	if x != nil {
 		oldDefer := deferFn
diff --git a/modules/doctor/dbconsistency.go b/modules/doctor/dbconsistency.go
@@ -74,7 +74,7 @@ func genericOrphanCheck(name, subject, refobject, joincond string) consistencyCh
 
 func checkDBConsistency(logger log.Logger, autofix bool) error {
 	// make sure DB version is uptodate
-	if err := db.NewEngine(context.Background(), migrations.EnsureUpToDate); err != nil {
+	if err := db.InitEngineWithMigration(context.Background(), migrations.EnsureUpToDate); err != nil {
 		logger.Critical("Model version on the database does not match the current Gitea version. Model consistency will not be checked until the database is upgraded")
 		return err
 	}
diff --git a/modules/doctor/dbversion.go b/modules/doctor/dbversion.go
@@ -13,15 +13,15 @@ import (
 )
 
 func checkDBVersion(logger log.Logger, autofix bool) error {
-	if err := db.NewEngine(context.Background(), migrations.EnsureUpToDate); err != nil {
+	if err := db.InitEngineWithMigration(context.Background(), migrations.EnsureUpToDate); err != nil {
 		if !autofix {
 			logger.Critical("Error: %v during ensure up to date", err)
 			return err
 		}
 		logger.Warn("Got Error: %v during ensure up to date", err)
 		logger.Warn("Attempting to migrate to the latest DB version to fix this.")
 
-		err = db.NewEngine(context.Background(), migrations.Migrate)
+		err = db.InitEngineWithMigration(context.Background(), migrations.Migrate)
 		if err != nil {
 			logger.Critical("Error: %v during migration", err)
 		}
diff --git a/modules/doctor/doctor.go b/modules/doctor/doctor.go
@@ -47,7 +47,7 @@ func initDBDisableConsole(disableConsole bool) error {
 	setting.InitDBConfig()
 
 	setting.NewXORMLogService(disableConsole)
-	if err := db.SetEngine(); err != nil {
+	if err := db.InitEngine(); err != nil {
 		return fmt.Errorf("models.SetEngine: %v", err)
 	}
 	return nil
diff --git a/routers/common/db.go b/routers/common/db.go
@@ -25,7 +25,7 @@ func InitDBEngine(ctx context.Context) (err error) {
 		default:
 		}
 		log.Info("ORM engine initialization attempt #%d/%d...", i+1, setting.Database.DBConnectRetries)
-		if err = db.NewEngine(ctx, migrations.Migrate); err == nil {
+		if err = db.InitEngineWithMigration(ctx, migrations.Migrate); err == nil {
 			break
 		} else if i == setting.Database.DBConnectRetries-1 {
 			return err
diff --git a/routers/install/install.go b/routers/install/install.go
@@ -209,7 +209,7 @@ func SubmitInstall(ctx *context.Context) {
 	}
 
 	// Set test engine.
-	if err = db.NewInstallTestEngine(ctx, migrations.Migrate); err != nil {
+	if err = db.InitInstallEngineWithMigration(ctx, migrations.Migrate); err != nil {
 		if strings.Contains(err.Error(), `Unknown database type: sqlite3`) {
 			ctx.Data["Err_DbType"] = true
 			ctx.RenderWithErr(ctx.Tr("install.sqlite3_not_available", "https://docs.gitea.io/en-us/install-from-binary/"), tplInstall, &form)

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ func initDBDisableConsole(disableConsole bool) error {`
`65`	`65`	`setting.InitDBConfig()`
`66`	`66`
`67`	`67`	`setting.NewXORMLogService(disableConsole)`
`68`		`- if err := db.SetEngine(); err != nil {`
	`68`	`+ if err := db.InitEngine(); err != nil {`
`69`	`69`	`return fmt.Errorf("models.SetEngine: %v", err)`
`70`	`70`	`}`
`71`	`71`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ func runDump(ctx *cli.Context) error {`
`173`	`173`	`}`
`174`	`174`	`setting.NewServices() // cannot access session settings otherwise`
`175`	`175`
`176`		`- err := db.SetEngine()`
	`176`	`+ err := db.InitEngine()`
`177`	`177`	`if err != nil {`
`178`	`178`	`return err`
`179`	`179`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func runMigrate(ctx *cli.Context) error {`
`35`	`35`	`log.Info("Configuration file: %s", setting.CustomConf)`
`36`	`36`	`setting.InitDBConfig()`
`37`	`37`
`38`		`- if err := db.NewEngine(context.Background(), migrations.Migrate); err != nil {`
	`38`	`+ if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {`
`39`	`39`	`log.Fatal("Failed to initialize ORM engine: %v", err)`
`40`	`40`	`return err`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,7 @@ func runMigrateStorage(ctx *cli.Context) error {`
`118`	`118`	`log.Info("Configuration file: %s", setting.CustomConf)`
`119`	`119`	`setting.InitDBConfig()`
`120`	`120`
`121`		`- if err := db.NewEngine(context.Background(), migrations.Migrate); err != nil {`
	`121`	`+ if err := db.InitEngineWithMigration(context.Background(), migrations.Migrate); err != nil {`
`122`	`122`	`log.Fatal("Failed to initialize ORM engine: %v", err)`
`123`	`123`	`return err`
`124`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,9 +84,9 @@ func removeAllWithRetry(dir string) error {`
`84`	`84`	`return err`
`85`	`85`	`}`
`86`	`86`
`87`		`-// SetEngine sets the xorm.Engine`
`88`		`-func SetEngine() (*xorm.Engine, error) {`
`89`		`- x, err := db.GetNewEngine()`
	`87`	`+// newEngine sets the xorm.Engine`
	`88`	`+func newEngine() (*xorm.Engine, error) {`
	`89`	`+ x, err := db.NewEngine()`
`90`	`90`	`if err != nil {`
`91`	`91`	`return x, fmt.Errorf("Failed to connect to database: %v", err)`
`92`	`92`	`}`
`@@ -212,7 +212,7 @@ func prepareTestEnv(t testing.T, skip int, syncModels ...interface{}) (xorm.En`
`212`	`212`	`return nil, deferFn`
`213`	`213`	`}`
`214`	`214`
`215`		`- x, err := SetEngine()`
	`215`	`+ x, err := newEngine()`
`216`	`216`	`assert.NoError(t, err)`
`217`	`217`	`if x != nil {`
`218`	`218`	`oldDefer := deferFn`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ func genericOrphanCheck(name, subject, refobject, joincond string) consistencyCh`
`74`	`74`
`75`	`75`	`func checkDBConsistency(logger log.Logger, autofix bool) error {`
`76`	`76`	`// make sure DB version is uptodate`
`77`		`- if err := db.NewEngine(context.Background(), migrations.EnsureUpToDate); err != nil {`
	`77`	`+ if err := db.InitEngineWithMigration(context.Background(), migrations.EnsureUpToDate); err != nil {`
`78`	`78`	`logger.Critical("Model version on the database does not match the current Gitea version. Model consistency will not be checked until the database is upgraded")`
`79`	`79`	`return err`
`80`	`80`	`}`