mirror of
https://github.com/go-gitea/gitea
synced 2024-11-14 14:14:25 +00:00
c53ad052d8
Some bugs caused by less unit tests in fundamental packages. This PR refactor `setting` package so that create a unit test will be easier than before. - All `LoadFromXXX` files has been splited as two functions, one is `InitProviderFromXXX` and `LoadCommonSettings`. The first functions will only include the code to create or new a ini file. The second function will load common settings. - It also renames all functions in setting from `newXXXService` to `loadXXXSetting` or `loadXXXFrom` to make the function name less confusing. - Move `XORMLog` to `SQLLog` because it's a better name for that. Maybe we should finally move these `loadXXXSetting` into the `XXXInit` function? Any idea? --------- Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: delvh <dev.lh@web.de>
111 lines
2.9 KiB
Go
111 lines
2.9 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package doctor
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/models/db"
|
|
"code.gitea.io/gitea/modules/git"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
)
|
|
|
|
// Check represents a Doctor check
|
|
type Check struct {
|
|
Title string
|
|
Name string
|
|
IsDefault bool
|
|
Run func(ctx context.Context, logger log.Logger, autofix bool) error
|
|
AbortIfFailed bool
|
|
SkipDatabaseInitialization bool
|
|
Priority int
|
|
}
|
|
|
|
type wrappedLevelLogger struct {
|
|
log.LevelLogger
|
|
}
|
|
|
|
func (w *wrappedLevelLogger) Log(skip int, level log.Level, format string, v ...interface{}) error {
|
|
return w.LevelLogger.Log(
|
|
skip+1,
|
|
level,
|
|
" - %s "+format,
|
|
append(
|
|
[]interface{}{
|
|
log.NewColoredValueBytes(
|
|
fmt.Sprintf("[%s]", strings.ToUpper(level.String()[0:1])),
|
|
level.Color()),
|
|
}, v...)...)
|
|
}
|
|
|
|
func initDBDisableConsole(ctx context.Context, disableConsole bool) error {
|
|
setting.InitProviderFromExistingFile()
|
|
setting.LoadCommonSettings()
|
|
setting.LoadDBSetting()
|
|
setting.InitSQLLog(disableConsole)
|
|
if err := db.InitEngine(ctx); err != nil {
|
|
return fmt.Errorf("db.InitEngine: %w", err)
|
|
}
|
|
// some doctor sub-commands need to use git command
|
|
if err := git.InitFull(ctx); err != nil {
|
|
return fmt.Errorf("git.InitFull: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Checks is the list of available commands
|
|
var Checks []*Check
|
|
|
|
// RunChecks runs the doctor checks for the provided list
|
|
func RunChecks(ctx context.Context, logger log.Logger, autofix bool, checks []*Check) error {
|
|
wrappedLogger := log.LevelLoggerLogger{
|
|
LevelLogger: &wrappedLevelLogger{logger},
|
|
}
|
|
|
|
dbIsInit := false
|
|
for i, check := range checks {
|
|
if !dbIsInit && !check.SkipDatabaseInitialization {
|
|
// Only open database after the most basic configuration check
|
|
setting.Log.EnableXORMLog = false
|
|
if err := initDBDisableConsole(ctx, true); err != nil {
|
|
logger.Error("Error whilst initializing the database: %v", err)
|
|
logger.Error("Check if you are using the right config file. You can use a --config directive to specify one.")
|
|
return nil
|
|
}
|
|
dbIsInit = true
|
|
}
|
|
logger.Info("[%d] %s", log.NewColoredIDValue(i+1), check.Title)
|
|
logger.Flush()
|
|
if err := check.Run(ctx, &wrappedLogger, autofix); err != nil {
|
|
if check.AbortIfFailed {
|
|
logger.Critical("FAIL")
|
|
return err
|
|
}
|
|
logger.Error("ERROR")
|
|
} else {
|
|
logger.Info("OK")
|
|
logger.Flush()
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Register registers a command with the list
|
|
func Register(command *Check) {
|
|
Checks = append(Checks, command)
|
|
sort.SliceStable(Checks, func(i, j int) bool {
|
|
if Checks[i].Priority == Checks[j].Priority {
|
|
return Checks[i].Name < Checks[j].Name
|
|
}
|
|
if Checks[i].Priority == 0 {
|
|
return false
|
|
}
|
|
return Checks[i].Priority < Checks[j].Priority
|
|
})
|
|
}
|