align tests

Author: TheFox0x7

modules/setting/git_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 func TestGitConfig(t *testing.T) {
@@ -50,16 +51,15 @@ func TestGitReflog(t *testing.T) {
 
 	assert.EqualValues(t, "true", GitConfig.GetOption("core.logAllRefUpdates"))
 	assert.EqualValues(t, "90", GitConfig.GetOption("gc.reflogExpire"))
+}
 
-	// custom reflog config by legacy options
-	cfg, err = NewConfigProviderFromData(`
+func TestLegacyRefLog(t *testing.T) {
+	cfg, err := NewConfigProviderFromData(`
 [git.reflog]
 ENABLED = false
 EXPIRATION = 123
 `)
-	assert.NoError(t, err)
-	loadGitFrom(cfg)
+	require.NoError(t, err)
 
-	assert.EqualValues(t, "false", GitConfig.GetOption("core.logAllRefUpdates"))
-	assert.EqualValues(t, "123", GitConfig.GetOption("gc.reflogExpire"))
+	require.Error(t, checkForRemovedSettings(cfg))
 }

modules/setting/lfs_test.go

@@ -40,10 +40,7 @@ LFS_CONTENT_PATH = deprecatedpath
 `
 	cfg, err = NewConfigProviderFromData(iniStr)
 	assert.NoError(t, err)
-	assert.NoError(t, loadLFSFrom(cfg))
-
-	assert.EqualValues(t, "local", LFS.Storage.Type)
-	assert.Contains(t, LFS.Storage.Path, "deprecatedpath")
+	assert.Error(t, checkForRemovedSettings(cfg))
 
 	iniStr = `
 [storage.lfs]

modules/setting/log_test.go

@@ -150,90 +150,29 @@ MODE = console
 func TestLogConfigLegacyMode(t *testing.T) {
 	tempDir := t.TempDir()
 
-	tempPath := func(file string) string {
-		return filepath.Join(tempDir, file)
-	}
-
-	manager, managerClose := initLoggersByConfig(t, `
+	cfg, err := NewConfigProviderFromData(`
 [log]
-ROOT_PATH = `+tempDir+`
+ROOT_PATH = ` + tempDir + `
 MODE = file
 ROUTER = file
 ACCESS = file
 `)
-	defer managerClose()
+	require.NoError(t, err)
 
-	writerDump := `
-{
-	"file": {
-		"BufferLen": 10000,
-		"Colorize": false,
-		"Expression": "",
-		"Flags": "stdflags",
-		"Level": "info",
-		"Prefix": "",
-		"StacktraceLevel": "none",
-		"WriterOption": {
-			"Compress": true,
-			"CompressionLevel": -1,
-			"DailyRotate": true,
-			"FileName": "$FILENAME",
-			"LogRotate": true,
-			"MaxDays": 7,
-			"MaxSize": 268435456
-		},
-		"WriterType": "file"
-	}
-}
-`
-	writerDumpAccess := `
-{
-	"file.access": {
-		"BufferLen": 10000,
-		"Colorize": false,
-		"Expression": "",
-		"Flags": "none",
-		"Level": "info",
-		"Prefix": "",
-		"StacktraceLevel": "none",
-		"WriterOption": {
-			"Compress": true,
-			"CompressionLevel": -1,
-			"DailyRotate": true,
-			"FileName": "$FILENAME",
-			"LogRotate": true,
-			"MaxDays": 7,
-			"MaxSize": 268435456
-		},
-		"WriterType": "file"
-	}
-}
-`
-	dump := manager.GetLogger(log.DEFAULT).DumpWriters()
-	require.JSONEq(t, strings.ReplaceAll(writerDump, "$FILENAME", tempPath("gitea.log")), toJSON(dump))
-
-	dump = manager.GetLogger("access").DumpWriters()
-	require.JSONEq(t, strings.ReplaceAll(writerDumpAccess, "$FILENAME", tempPath("access.log")), toJSON(dump))
-
-	dump = manager.GetLogger("router").DumpWriters()
-	require.JSONEq(t, strings.ReplaceAll(writerDump, "$FILENAME", tempPath("gitea.log")), toJSON(dump))
+	require.Error(t, checkForRemovedSettings(cfg))
 }
 
 func TestLogConfigLegacyModeDisable(t *testing.T) {
-	manager, managerClose := initLoggersByConfig(t, `
+	cfg, err := NewConfigProviderFromData(`
 [log]
 ROUTER = file
 ACCESS = file
 DISABLE_ROUTER_LOG = true
 ENABLE_ACCESS_LOG = false
 `)
-	defer managerClose()
+	require.NoError(t, err)
 
-	dump := manager.GetLogger("access").DumpWriters()
-	require.JSONEq(t, "{}", toJSON(dump))
-
-	dump = manager.GetLogger("router").DumpWriters()
-	require.JSONEq(t, "{}", toJSON(dump))
+	require.Error(t, checkForRemovedSettings(cfg))
 }
 
 func TestLogConfigNewConfig(t *testing.T) {

modules/setting/mailer_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func Test_loadMailerFrom(t *testing.T) {
-	kases := map[string]*Mailer{
+	cases := map[string]*Mailer{
 		"smtp.mydomain.com": {
 			SMTPAddr: "smtp.mydomain.com",
 			SMTPPort: "465",
@@ -24,18 +24,15 @@ func Test_loadMailerFrom(t *testing.T) {
 			SMTPPort: "123",
 		},
 	}
-	for host, kase := range kases {
+	for host := range cases {
 		t.Run(host, func(t *testing.T) {
 			cfg, _ := NewConfigProviderFromData("")
 			sec := cfg.Section("mailer")
 			sec.NewKey("ENABLED", "true")
 			sec.NewKey("HOST", host)
 
-			// Check mailer setting
-			loadMailerFrom(cfg)
-
-			assert.EqualValues(t, kase.SMTPAddr, MailService.SMTPAddr)
-			assert.EqualValues(t, kase.SMTPPort, MailService.SMTPPort)
+			// Ensure removed settings catches the removed config setting
+			assert.Error(t, checkForRemovedSettings(cfg))
 		})
 	}
 }

modules/setting/removed.go

@@ -3,13 +3,11 @@ package setting
 import (
 	"errors"
 	"fmt"
-
-	"code.gitea.io/gitea/modules/log"
 )
 
 // checkForRemovedSettings checks the entire configuration for removed keys and gathers them fataling if any is present
 // Arbitrary permament removal is 3 releases
-func checkForRemovedSettings(rootCfg ConfigProvider) {
+func checkForRemovedSettings(rootCfg ConfigProvider) error {
 	var errs []error
 
 	removedSettings := []struct {
@@ -51,10 +49,7 @@ func checkForRemovedSettings(rootCfg ConfigProvider) {
 		errs = append(errs, fmt.Errorf("removed fallback `[mailer]` `PROTOCOL = smtp+startls` present. Use `[mailer]` `PROTOCOL = smtp+starttls`` instead"))
 	}
 
-	err := errors.Join(errs...)
-	if err != nil {
-		log.Fatal("Encountered errors while loading configuration: %v", err)
-	}
+	return errors.Join(errs...)
 }
 
 func removedSetting(rootCfg ConfigProvider, oldSection, oldKey, newSection, newKey, version string) error {

modules/setting/setting.go

@@ -200,7 +200,9 @@ func mustCurrentRunUserMatch(rootCfg ConfigProvider) {
 // LoadSettings initializes the settings for normal start up
 func LoadSettings() {
 	initAllLoggers()
-	checkForRemovedSettings(CfgProvider)
+	if err := checkForRemovedSettings(CfgProvider); err != nil {
+		log.Fatal("Encountered removed settings while loading configuration: %v", err)
+	}
 
 	loadDBSetting(CfgProvider)
 	loadServiceFrom(CfgProvider)