Merge setting.InitXXX into one function with options (#24389)

This PR will merge 3 Init functions on setting packages as 1 and introduce an options struct.
go-gitea · May 4, 2023 · 377a0a2 · 377a0a2
1 parent a2fe68e
commit 377a0a2
Show file tree

Hide file tree

Showing 28 changed files with 103 additions and 136 deletions.
diff --git a/cmd/actions.go b/cmd/actions.go
@@ -42,8 +42,7 @@ func runGenerateActionsRunnerToken(c *cli.Context) error {
 	ctx, cancel := installSignals()
 	defer cancel()
 
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 
 	scope := c.String("scope")
 

diff --git a/cmd/cmd.go b/cmd/cmd.go
@@ -57,8 +57,7 @@ func confirm() (bool, error) {
 }
 
 func initDB(ctx context.Context) error {
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	setting.LoadDBSetting()
 	setting.InitSQLLog(false)
 

diff --git a/cmd/doctor.go b/cmd/doctor.go
@@ -87,8 +87,7 @@ func runRecreateTable(ctx *cli.Context) error {
 	golog.SetPrefix("")
 	golog.SetOutput(log.NewLoggerAsWriter("INFO", log.GetLogger(log.DEFAULT)))
 
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	setting.LoadDBSetting()
 
 	setting.Log.EnableXORMLog = ctx.Bool("debug")

diff --git a/cmd/dump.go b/cmd/dump.go
@@ -185,8 +185,7 @@ func runDump(ctx *cli.Context) error {
 		}
 		fileName += "." + outType
 	}
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 
 	// make sure we are logging to the console no matter what the configuration tells us do to
 	// FIXME: don't use CfgProvider directly

diff --git a/cmd/embedded.go b/cmd/embedded.go
@@ -106,8 +106,9 @@ func initEmbeddedExtractor(c *cli.Context) error {
 	log.DelNamedLogger(log.DEFAULT)
 
 	// Read configuration file
-	setting.InitProviderAllowEmpty()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{
+		AllowEmpty: true,
+	})
 
 	patterns, err := compileCollectPatterns(c.Args())
 	if err != nil {

diff --git a/cmd/mailer.go b/cmd/mailer.go
@@ -16,8 +16,7 @@ func runSendMail(c *cli.Context) error {
 	ctx, cancel := installSignals()
 	defer cancel()
 
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 
 	if err := argsSet(c, "title"); err != nil {
 		return err

diff --git a/cmd/main_test.go b/cmd/main_test.go
@@ -7,14 +7,8 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/models/unittest"
-	"code.gitea.io/gitea/modules/setting"
 )
 
-func init() {
-	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
-}
-
 func TestMain(m *testing.M) {
 	unittest.MainTest(m, &unittest.TestOptions{
 		GiteaRootPath: "..",

diff --git a/cmd/restore_repo.go b/cmd/restore_repo.go
@@ -51,8 +51,7 @@ func runRestoreRepository(c *cli.Context) error {
 	ctx, cancel := installSignals()
 	defer cancel()
 
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	var units []string
 	if s := c.String("units"); s != "" {
 		units = strings.Split(s, ",")

diff --git a/cmd/serv.go b/cmd/serv.go
@@ -62,8 +62,7 @@ func setup(ctx context.Context, debug bool) {
 	} else {
 		_ = log.NewLogger(1000, "console", "console", `{"level":"fatal","stacktracelevel":"NONE","stderr":true}`)
 	}
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	if debug {
 		setting.RunMode = "dev"
 	}

diff --git a/cmd/web.go b/cmd/web.go
@@ -177,8 +177,7 @@ func runWeb(ctx *cli.Context) error {
 
 	log.Info("Global init")
 	// Perform global initialization
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	routers.GlobalInitInstalled(graceful.GetManager().HammerContext())
 
 	// We check that AppDataPath exists here (it should have been created during installation)

diff --git a/models/asymkey/main_test.go b/models/asymkey/main_test.go
@@ -8,14 +8,8 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/models/unittest"
-	"code.gitea.io/gitea/modules/setting"
 )
 
-func init() {
-	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
-}
-
 func TestMain(m *testing.M) {
 	unittest.MainTest(m, &unittest.TestOptions{
 		GiteaRootPath: filepath.Join("..", ".."),

diff --git a/models/dbfs/main_test.go b/models/dbfs/main_test.go
@@ -8,14 +8,8 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/models/unittest"
-	"code.gitea.io/gitea/modules/setting"
 )
 
-func init() {
-	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
-}
-
 func TestMain(m *testing.M) {
 	unittest.MainTest(m, &unittest.TestOptions{
 		GiteaRootPath: filepath.Join("..", ".."),

diff --git a/models/issues/main_test.go b/models/issues/main_test.go
@@ -9,7 +9,6 @@ import (
 
 	issues_model "code.gitea.io/gitea/models/issues"
 	"code.gitea.io/gitea/models/unittest"
-	"code.gitea.io/gitea/modules/setting"
 
 	_ "code.gitea.io/gitea/models"
 	_ "code.gitea.io/gitea/models/repo"
@@ -18,11 +17,6 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func init() {
-	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
-}
-
 func TestFixturesAreConsistent(t *testing.T) {
 	assert.NoError(t, unittest.PrepareTestDatabase())
 	unittest.CheckConsistencyFor(t,

diff --git a/models/main_test.go b/models/main_test.go
@@ -11,18 +11,12 @@ import (
 	repo_model "code.gitea.io/gitea/models/repo"
 	"code.gitea.io/gitea/models/unittest"
 	user_model "code.gitea.io/gitea/models/user"
-	"code.gitea.io/gitea/modules/setting"
 
 	_ "code.gitea.io/gitea/models/system"
 
 	"github.com/stretchr/testify/assert"
 )
 
-func init() {
-	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
-}
-
 // TestFixturesAreConsistent assert that test fixtures are consistent
 func TestFixturesAreConsistent(t *testing.T) {
 	assert.NoError(t, unittest.PrepareTestDatabase())

diff --git a/models/migrations/base/tests.go b/models/migrations/base/tests.go
@@ -150,7 +150,7 @@ func MainTest(m *testing.M) {
 	setting.AppDataPath = tmpDataPath
 
 	setting.SetCustomPathAndConf("", "", "")
-	setting.InitProviderAndLoadCommonSettingsForTest()
+	unittest.InitSettings()
 	if err = git.InitFull(context.Background()); err != nil {
 		fmt.Printf("Unable to InitFull: %v\n", err)
 		os.Exit(1)

diff --git a/models/unittest/testdb.go b/models/unittest/testdb.go
@@ -6,12 +6,15 @@ package unittest
 import (
 	"context"
 	"fmt"
+	"log"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"code.gitea.io/gitea/models/db"
 	system_model "code.gitea.io/gitea/models/system"
+	"code.gitea.io/gitea/modules/auth/password/hash"
 	"code.gitea.io/gitea/modules/base"
 	"code.gitea.io/gitea/modules/git"
 	"code.gitea.io/gitea/modules/setting"
@@ -39,6 +42,22 @@ func fatalTestError(fmtStr string, args ...interface{}) {
 	os.Exit(1)
 }
 
+// InitSettings initializes config provider and load common setttings for tests
+func InitSettings(extraConfigs ...string) {
+	setting.Init(&setting.Options{
+		AllowEmpty:  true,
+		ExtraConfig: strings.Join(extraConfigs, "\n"),
+	})
+
+	if err := setting.PrepareAppDataPath(); err != nil {
+		log.Fatalf("Can not prepare APP_DATA_PATH: %v", err)
+	}
+	// register the dummy hash algorithm function used in the test fixtures
+	_ = hash.Register("dummy", hash.NewDummyHasher)
+
+	setting.PasswordHashAlgo, _ = hash.SetDefaultPasswordHashAlgorithm("dummy")
+}
+
 // TestOptions represents test options
 type TestOptions struct {
 	GiteaRootPath string
@@ -50,6 +69,9 @@ type TestOptions struct {
 // MainTest a reusable TestMain(..) function for unit tests that need to use a
 // test database. Creates the test database, and sets necessary settings.
 func MainTest(m *testing.M, testOpts *TestOptions) {
+	setting.SetCustomPathAndConf("", "", "")
+	InitSettings()
+
 	var err error
 
 	giteaRoot = testOpts.GiteaRootPath

diff --git a/modules/doctor/doctor.go b/modules/doctor/doctor.go
@@ -44,8 +44,7 @@ func (w *wrappedLevelLogger) Log(skip int, level log.Level, format string, v ...
 }
 
 func initDBDisableConsole(ctx context.Context, disableConsole bool) error {
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 	setting.LoadDBSetting()
 	setting.InitSQLLog(disableConsole)
 	if err := db.InitEngine(ctx); err != nil {

diff --git a/modules/doctor/paths.go b/modules/doctor/paths.go
@@ -66,8 +66,7 @@ func checkConfigurationFiles(ctx context.Context, logger log.Logger, autofix boo
 		return err
 	}
 
-	setting.InitProviderFromExistingFile()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{})
 
 	configurationFiles := []configurationFile{
 		{"Configuration File Path", setting.CustomConf, false, true, false},

diff --git a/modules/markup/html_test.go b/modules/markup/html_test.go
@@ -28,8 +28,9 @@ var localMetas = map[string]string{
 }
 
 func TestMain(m *testing.M) {
-	setting.InitProviderAllowEmpty()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{
+		AllowEmpty: true,
+	})
 	if err := git.InitSimple(context.Background()); err != nil {
 		log.Fatal("git init failed, err: %v", err)
 	}

diff --git a/modules/markup/markdown/markdown_test.go b/modules/markup/markdown/markdown_test.go
@@ -33,8 +33,9 @@ var localMetas = map[string]string{
 }
 
 func TestMain(m *testing.M) {
-	setting.InitProviderAllowEmpty()
-	setting.LoadCommonSettings()
+	setting.Init(&setting.Options{
+		AllowEmpty: true,
+	})
 	if err := git.InitSimple(context.Background()); err != nil {
 		log.Fatal("git init failed, err: %v", err)
 	}

diff --git a/modules/setting/config_provider.go b/modules/setting/config_provider.go
@@ -35,10 +35,9 @@ type ConfigProvider interface {
 }
 
 type iniFileConfigProvider struct {
+	opts *Options
 	*ini.File
-	filepath   string // the ini file path
-	newFile    bool   // whether the file has not existed previously
-	allowEmpty bool   // whether not finding configuration files is allowed (only true for the tests)
+	newFile bool // whether the file has not existed previously
 }
 
 // NewEmptyConfigProvider create a new empty config provider
@@ -66,41 +65,47 @@ func newConfigProviderFromData(configContent string) (ConfigProvider, error) {
 	}, nil
 }
 
+type Options struct {
+	CustomConf                string // the ini file path
+	AllowEmpty                bool   // whether not finding configuration files is allowed (only true for the tests)
+	ExtraConfig               string
+	DisableLoadCommonSettings bool
+}
+
 // newConfigProviderFromFile load configuration from file.
 // NOTE: do not print any log except error.
-func newConfigProviderFromFile(customConf string, allowEmpty bool, extraConfig string) (*iniFileConfigProvider, error) {
+func newConfigProviderFromFile(opts *Options) (*iniFileConfigProvider, error) {
 	cfg := ini.Empty()
 	newFile := true
 
-	if customConf != "" {
-		isFile, err := util.IsFile(customConf)
+	if opts.CustomConf != "" {
+		isFile, err := util.IsFile(opts.CustomConf)
 		if err != nil {
-			return nil, fmt.Errorf("unable to check if %s is a file. Error: %v", customConf, err)
+			return nil, fmt.Errorf("unable to check if %s is a file. Error: %v", opts.CustomConf, err)
 		}
 		if isFile {
-			if err := cfg.Append(customConf); err != nil {
-				return nil, fmt.Errorf("failed to load custom conf '%s': %v", customConf, err)
+			if err := cfg.Append(opts.CustomConf); err != nil {
+				return nil, fmt.Errorf("failed to load custom conf '%s': %v", opts.CustomConf, err)
 			}
 			newFile = false
 		}
 	}
 
-	if newFile && !allowEmpty {
+	if newFile && !opts.AllowEmpty {
 		return nil, fmt.Errorf("unable to find configuration file: %q, please ensure you are running in the correct environment or set the correct configuration file with -c", CustomConf)
 	}
 
-	if extraConfig != "" {
-		if err := cfg.Append([]byte(extraConfig)); err != nil {
+	if opts.ExtraConfig != "" {
+		if err := cfg.Append([]byte(opts.ExtraConfig)); err != nil {
 			return nil, fmt.Errorf("unable to append more config: %v", err)
 		}
 	}
 
 	cfg.NameMapper = ini.SnackCase
 	return &iniFileConfigProvider{
-		File:       cfg,
-		filepath:   customConf,
-		newFile:    newFile,
-		allowEmpty: allowEmpty,
+		opts:    opts,
+		File:    cfg,
+		newFile: newFile,
 	}, nil
 }
 
@@ -123,8 +128,8 @@ func (p *iniFileConfigProvider) DeleteSection(name string) error {
 
 // Save save the content into file
 func (p *iniFileConfigProvider) Save() error {
-	if p.filepath == "" {
-		if !p.allowEmpty {
+	if p.opts.CustomConf == "" {
+		if !p.opts.AllowEmpty {
 			return fmt.Errorf("custom config path must not be empty")
 		}
 		return nil
@@ -135,8 +140,8 @@ func (p *iniFileConfigProvider) Save() error {
 			return fmt.Errorf("failed to create '%s': %v", CustomConf, err)
 		}
 	}
-	if err := p.SaveTo(p.filepath); err != nil {
-		return fmt.Errorf("failed to save '%s': %v", p.filepath, err)
+	if err := p.SaveTo(p.opts.CustomConf); err != nil {
+		return fmt.Errorf("failed to save '%s': %v", p.opts.CustomConf, err)
 	}
 
 	// Change permissions to be more restrictive