2cdf260f42
# The problem
There were many "path tricks":
* By default, Gitea uses its program directory as its work path
* Gitea tries to use the "work path" to guess its "custom path" and
"custom conf (app.ini)"
* Users might want to use other directories as work path
* The non-default work path should be passed to Gitea by GITEA_WORK_DIR
or "--work-path"
* But some Gitea processes are started without these values
* The "serv" process started by OpenSSH server
* The CLI sub-commands started by site admin
* The paths are guessed by SetCustomPathAndConf again and again
* The default values of "work path / custom path / custom conf" can be
changed when compiling
# The solution
* Use `InitWorkPathAndCommonConfig` to handle these path tricks, and use
test code to cover its behaviors.
* When Gitea's web server runs, write the WORK_PATH to "app.ini", this
value must be the most correct one, because if this value is not right,
users would find that the web UI doesn't work and then they should be
able to fix it.
* Then all other sub-commands can use the WORK_PATH in app.ini to
initialize their paths.
* By the way, when Gitea starts for git protocol, it shouldn't output
any log, otherwise the git protocol gets broken and client blocks
forever.
The "work path" priority is: WORK_PATH in app.ini > cmd arg --work-path
> env var GITEA_WORK_DIR > builtin default
The "app.ini" searching order is: cmd arg --config > cmd arg "work path
/ custom path" > env var "work path / custom path" > builtin default
## ⚠️ BREAKING
If your instance's "work path / custom path / custom conf" doesn't meet
the requirements (eg: work path must be absolute), Gitea will report a
fatal error and exit. You need to set these values according to the
error log.
----
Close #24818
Close #24222
Close #21606
Close #21498
Close #25107
Close #24981
Maybe close #24503
Replace #23301
Replace #22754
And maybe more
152 lines
5.5 KiB
Go
152 lines
5.5 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package setting
|
|
|
|
import (
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type envVars map[string]string
|
|
|
|
func (e envVars) Getenv(key string) string {
|
|
return e[key]
|
|
}
|
|
|
|
func TestInitWorkPathAndCommonConfig(t *testing.T) {
|
|
testInit := func(defaultWorkPath, defaultCustomPath, defaultCustomConf string) {
|
|
AppWorkPathMismatch = false
|
|
AppWorkPath = defaultWorkPath
|
|
appWorkPathBuiltin = defaultWorkPath
|
|
CustomPath = defaultCustomPath
|
|
customPathBuiltin = defaultCustomPath
|
|
CustomConf = defaultCustomConf
|
|
customConfBuiltin = defaultCustomConf
|
|
}
|
|
|
|
fp := filepath.Join
|
|
|
|
tmpDir := t.TempDir()
|
|
dirFoo := fp(tmpDir, "foo")
|
|
dirBar := fp(tmpDir, "bar")
|
|
dirXxx := fp(tmpDir, "xxx")
|
|
dirYyy := fp(tmpDir, "yyy")
|
|
|
|
t.Run("Default", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, fp(dirFoo, "custom"), CustomPath)
|
|
assert.Equal(t, fp(dirFoo, "custom/conf/app.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("WorkDir(env)", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirBar, AppWorkPath)
|
|
assert.Equal(t, fp(dirBar, "custom"), CustomPath)
|
|
assert.Equal(t, fp(dirBar, "custom/conf/app.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("WorkDir(env,arg)", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{WorkPath: dirXxx})
|
|
assert.Equal(t, dirXxx, AppWorkPath)
|
|
assert.Equal(t, fp(dirXxx, "custom"), CustomPath)
|
|
assert.Equal(t, fp(dirXxx, "custom/conf/app.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("CustomPath(env)", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": fp(dirBar, "custom1")}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, fp(dirBar, "custom1"), CustomPath)
|
|
assert.Equal(t, fp(dirBar, "custom1/conf/app.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("CustomPath(env,arg)", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": fp(dirBar, "custom1")}.Getenv, ArgWorkPathAndCustomConf{CustomPath: "custom2"})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, fp(dirFoo, "custom2"), CustomPath)
|
|
assert.Equal(t, fp(dirFoo, "custom2/conf/app.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("CustomConf", func(t *testing.T) {
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: "app1.ini"})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
cwd, _ := os.Getwd()
|
|
assert.Equal(t, fp(cwd, "app1.ini"), CustomConf)
|
|
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: fp(dirBar, "app1.ini")})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, fp(dirBar, "app1.ini"), CustomConf)
|
|
})
|
|
|
|
t.Run("CustomConfOverrideWorkPath", func(t *testing.T) {
|
|
iniWorkPath := fp(tmpDir, "app-workpath.ini")
|
|
_ = os.WriteFile(iniWorkPath, []byte("WORK_PATH="+dirXxx), 0o644)
|
|
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath})
|
|
assert.Equal(t, dirXxx, AppWorkPath)
|
|
assert.Equal(t, fp(dirXxx, "custom"), CustomPath)
|
|
assert.Equal(t, iniWorkPath, CustomConf)
|
|
assert.False(t, AppWorkPathMismatch)
|
|
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirBar}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath})
|
|
assert.Equal(t, dirXxx, AppWorkPath)
|
|
assert.Equal(t, fp(dirXxx, "custom"), CustomPath)
|
|
assert.Equal(t, iniWorkPath, CustomConf)
|
|
assert.True(t, AppWorkPathMismatch)
|
|
|
|
testInit(dirFoo, "", "")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{WorkPath: dirBar, CustomConf: iniWorkPath})
|
|
assert.Equal(t, dirXxx, AppWorkPath)
|
|
assert.Equal(t, fp(dirXxx, "custom"), CustomPath)
|
|
assert.Equal(t, iniWorkPath, CustomConf)
|
|
assert.True(t, AppWorkPathMismatch)
|
|
})
|
|
|
|
t.Run("Builtin", func(t *testing.T) {
|
|
testInit(dirFoo, dirBar, dirXxx)
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, dirBar, CustomPath)
|
|
assert.Equal(t, dirXxx, CustomConf)
|
|
|
|
testInit(dirFoo, "custom1", "cfg.ini")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, fp(dirFoo, "custom1"), CustomPath)
|
|
assert.Equal(t, fp(dirFoo, "custom1/cfg.ini"), CustomConf)
|
|
|
|
testInit(dirFoo, "custom1", "cfg.ini")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_WORK_DIR": dirYyy}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirYyy, AppWorkPath)
|
|
assert.Equal(t, fp(dirYyy, "custom1"), CustomPath)
|
|
assert.Equal(t, fp(dirYyy, "custom1/cfg.ini"), CustomConf)
|
|
|
|
testInit(dirFoo, "custom1", "cfg.ini")
|
|
InitWorkPathAndCommonConfig(envVars{"GITEA_CUSTOM": dirYyy}.Getenv, ArgWorkPathAndCustomConf{})
|
|
assert.Equal(t, dirFoo, AppWorkPath)
|
|
assert.Equal(t, dirYyy, CustomPath)
|
|
assert.Equal(t, fp(dirYyy, "cfg.ini"), CustomConf)
|
|
|
|
iniWorkPath := fp(tmpDir, "app-workpath.ini")
|
|
_ = os.WriteFile(iniWorkPath, []byte("WORK_PATH="+dirXxx), 0o644)
|
|
testInit(dirFoo, "custom1", "cfg.ini")
|
|
InitWorkPathAndCommonConfig(envVars{}.Getenv, ArgWorkPathAndCustomConf{CustomConf: iniWorkPath})
|
|
assert.Equal(t, dirXxx, AppWorkPath)
|
|
assert.Equal(t, fp(dirXxx, "custom1"), CustomPath)
|
|
assert.Equal(t, iniWorkPath, CustomConf)
|
|
})
|
|
}
|