Skip to content

Commit

Permalink
fix bug with config file being a relative symlink
Browse files Browse the repository at this point in the history
Signed-off-by: Will Wang <[email protected]>
  • Loading branch information
willww64 committed Jul 23, 2024
1 parent a69c036 commit c90705a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions cli/config/configfile/file.go
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,10 @@ func (configFile *ConfigFile) Save() (retErr error) {
cfgFile := configFile.Filename
if f, err := os.Readlink(cfgFile); err == nil {
cfgFile = f
// The target of a symlink can be a relative path, ensure the final path is absolute
if !filepath.IsAbs(f) {
cfgFile = filepath.Join(dir, f)
}
}

// Try copying the current config file (if any) ownership and permissions
Expand Down
28 changes: 28 additions & 0 deletions cli/config/configfile/file_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,34 @@ func TestSaveWithSymlink(t *testing.T) {
assert.Check(t, is.Equal(string(cfg), "{\n \"auths\": {}\n}"))
}

func TestSaveWithRelativeSymlink(t *testing.T) {
dir := fs.NewDir(t, t.Name(), fs.WithFile("real-config.json", `{}`))
defer dir.Remove()

symLink := dir.Join("config.json")
relativeRealFile := "real-config.json"
realFile := dir.Join(relativeRealFile)
err := os.Symlink(relativeRealFile, symLink)
assert.NilError(t, err)

configFile := New(symLink)

err = configFile.Save()
assert.NilError(t, err)

fi, err := os.Lstat(symLink)
assert.NilError(t, err)
assert.Assert(t, fi.Mode()&os.ModeSymlink != 0, "expected %s to be a symlink", symLink)

cfg, err := os.ReadFile(symLink)
assert.NilError(t, err)
assert.Check(t, is.Equal(string(cfg), "{\n \"auths\": {}\n}"))

cfg, err = os.ReadFile(realFile)
assert.NilError(t, err)
assert.Check(t, is.Equal(string(cfg), "{\n \"auths\": {}\n}"))
}

func TestPluginConfig(t *testing.T) {
configFile := New("test-plugin")
defer os.Remove("test-plugin")
Expand Down

0 comments on commit c90705a

Please sign in to comment.