chore: add comments for "api/healthz", clean up test env (#36481)

GITEA_UNIT_TESTS_LOG_SQL is renamed to GITEA_TEST_LOG_SQL

modules/gitrepo/main_test.go

@@ -8,12 +8,12 @@ import (
 	"testing"
 
 	"code.gitea.io/gitea/modules/git"
-	"code.gitea.io/gitea/modules/test"
+	"code.gitea.io/gitea/modules/setting"
 )
 
 func TestMain(m *testing.M) {
 	// resolve repository path relative to the test directory
-	testRootDir := test.SetupGiteaRoot()
+	testRootDir := setting.SetupGiteaTestEnv()
 	repoPath = func(repo Repository) string {
 		if filepath.IsAbs(repo.RelativePath()) {
 			return repo.RelativePath() // for testing purpose only

modules/setting/config_env.go

@@ -167,24 +167,13 @@ func EnvironmentToConfig(cfg ConfigProvider, envs []string) (changed bool) {
 	return changed
 }
 
-// InitGiteaEnvVars initializes the environment variables for gitea
-func InitGiteaEnvVars() {
+func UnsetUnnecessaryEnvVars() {
 	// Ideally Gitea should only accept the environment variables which it clearly knows instead of unsetting the ones it doesn't want,
-	// but the ideal behavior would be a breaking change, and it seems not bringing enough benefits to end users,
-	// so at the moment we could still keep "unsetting the unnecessary environments"
+	// but the ideal behavior would be a breaking change, and it seems not bringing enough benefits to end users.
+	// So at the moment we just keep "unsetting the unnecessary environment variables".
 
 	// HOME is managed by Gitea, Gitea's git should use "HOME/.gitconfig".
 	// But git would try "XDG_CONFIG_HOME/git/config" first if "HOME/.gitconfig" does not exist,
 	// then our git.InitFull would still write to "XDG_CONFIG_HOME/git/config" if XDG_CONFIG_HOME is set.
 	_ = os.Unsetenv("XDG_CONFIG_HOME")
 }
-
-func InitGiteaEnvVarsForTesting() {
-	InitGiteaEnvVars()
-	_ = os.Unsetenv("GIT_AUTHOR_NAME")
-	_ = os.Unsetenv("GIT_AUTHOR_EMAIL")
-	_ = os.Unsetenv("GIT_AUTHOR_DATE")
-	_ = os.Unsetenv("GIT_COMMITTER_NAME")
-	_ = os.Unsetenv("GIT_COMMITTER_EMAIL")
-	_ = os.Unsetenv("GIT_COMMITTER_DATE")
-}

modules/setting/testenv.go

@@ -0,0 +1,61 @@
+// Copyright 2026 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package setting
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"runtime"
+	"strings"
+
+	"code.gitea.io/gitea/modules/util"
+)
+
+func SetupGiteaTestEnv() string {
+	giteaRoot := os.Getenv("GITEA_TEST_ROOT")
+	if giteaRoot == "" {
+		_, filename, _, _ := runtime.Caller(0)
+		giteaRoot = filepath.Dir(filepath.Dir(filepath.Dir(filename)))
+		fixturesDir := filepath.Join(giteaRoot, "models", "fixtures")
+		if _, err := os.Stat(fixturesDir); err != nil {
+			panic("in gitea source code directory, fixtures directory not found: " + fixturesDir)
+		}
+	}
+
+	appWorkPathBuiltin = giteaRoot
+	AppWorkPath = giteaRoot
+	AppPath = filepath.Join(giteaRoot, "gitea") + util.Iif(IsWindows, ".exe", "")
+
+	// giteaConf (GITEA_CONF) must be relative because it is used in the git hooks as "$GITEA_ROOT/$GITEA_CONF"
+	giteaConf := os.Getenv("GITEA_TEST_CONF")
+	if giteaConf == "" {
+		// By default, use sqlite.ini for testing, then IDE like GoLand can start the test process with debugger.
+		// It's easier for developers to debug bugs step by step with a debugger.
+		// Notice: when doing "ssh push", Gitea executes sub processes, debugger won't work for the sub processes.
+		giteaConf = "tests/sqlite.ini"
+		_, _ = fmt.Fprintf(os.Stderr, "Environment variable GITEA_TEST_CONF not set - defaulting to %s\n", giteaConf)
+		if !EnableSQLite3 {
+			_, _ = fmt.Fprintf(os.Stderr, "sqlite3 requires: -tags sqlite,sqlite_unlock_notify\n")
+			os.Exit(1)
+		}
+	}
+	// CustomConf must be absolute path to make tests pass,
+	CustomConf = filepath.Join(AppWorkPath, giteaConf)
+
+	// also unset unnecessary env vars for testing (only keep "GITEA_TEST_*" ones)
+	UnsetUnnecessaryEnvVars()
+	for _, env := range os.Environ() {
+		if strings.HasPrefix(env, "GIT_") || (strings.HasPrefix(env, "GITEA_") && !strings.HasPrefix(env, "GITEA_TEST_")) {
+			k, _, _ := strings.Cut(env, "=")
+			_ = os.Unsetenv(k)
+		}
+	}
+
+	// TODO: some git repo hooks (test fixtures) still use these env variables, need to be refactored in the future
+	_ = os.Setenv("GITEA_ROOT", giteaRoot)
+	_ = os.Setenv("GITEA_CONF", giteaConf) // test fixture git hooks use "$GITEA_ROOT/$GITEA_CONF" in their scripts
+
+	return giteaRoot
+}

modules/test/utils.go

@@ -9,13 +9,9 @@ import (
 	"io"
 	"net/http"
 	"net/http/httptest"
-	"os"
-	"path/filepath"
-	"runtime"
 	"strings"
 
 	"code.gitea.io/gitea/modules/json"
-	"code.gitea.io/gitea/modules/util"
 )
 
 // RedirectURL returns the redirect URL of a http response.
@@ -59,22 +55,6 @@ func MockVariableValue[T any](p *T, v ...T) (reset func()) {
 	return func() { *p = old }
 }
 
-// SetupGiteaRoot Sets GITEA_ROOT if it is not already set and returns the value
-func SetupGiteaRoot() string {
-	giteaRoot := os.Getenv("GITEA_ROOT")
-	if giteaRoot != "" {
-		return giteaRoot
-	}
-	_, filename, _, _ := runtime.Caller(0)
-	giteaRoot = filepath.Dir(filepath.Dir(filepath.Dir(filename)))
-	fixturesDir := filepath.Join(giteaRoot, "models", "fixtures")
-	if exist, _ := util.IsDir(fixturesDir); !exist {
-		panic("fixtures directory not found: " + fixturesDir)
-	}
-	_ = os.Setenv("GITEA_ROOT", giteaRoot)
-	return giteaRoot
-}
-
 func ReadAllTarGzContent(r io.Reader) (map[string]string, error) {
 	gzr, err := gzip.NewReader(r)
 	if err != nil {

modules/test/utils_test.go

@@ -1,17 +0,0 @@
-// Copyright 2024 The Gitea Authors. All rights reserved.
-// SPDX-License-Identifier: MIT
-
-package test
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func TestSetupGiteaRoot(t *testing.T) {
-	t.Setenv("GITEA_ROOT", "test")
-	assert.Equal(t, "test", SetupGiteaRoot())
-	t.Setenv("GITEA_ROOT", "")
-	assert.NotEqual(t, "test", SetupGiteaRoot())
-}

modules/testlogger/testlogger.go

@@ -118,7 +118,7 @@ func PrintCurrentTest(t testing.TB, skip ...int) func() {
 	deferHasRun := false
 	t.Cleanup(func() {
 		if !deferHasRun {
-			Printf("!!! defer function hasn't been run but Cleanup is called\n%s", getRuntimeStackAll())
+			Printf("!!! %s defer function hasn't been run but Cleanup is called, usually caused by panic", t.Name())
 		}
 	})
 	Printf("=== %s (%s:%d)\n", log.NewColoredValue(t.Name()), strings.TrimPrefix(filename, prefix), line)
@@ -171,16 +171,6 @@ func Init() {
 	prefix = strings.TrimSuffix(filename, relFilePath)
 
 	log.RegisterEventWriter("test", newTestLoggerWriter)
-
-	duration, err := time.ParseDuration(os.Getenv("GITEA_TEST_SLOW_RUN"))
-	if err == nil && duration > 0 {
-		TestSlowRun = duration
-	}
-
-	duration, err = time.ParseDuration(os.Getenv("GITEA_TEST_SLOW_FLUSH"))
-	if err == nil && duration > 0 {
-		TestSlowFlush = duration
-	}
 }
 
 func Fatalf(format string, args ...any) {