Fix #187: homedir/env-vars in repo and other flags (#188)

Author: jkellerer

config/confidential.go

@@ -26,6 +26,14 @@ func (c *ConfidentialValue) IsConfidential() bool {
 	return c.public != c.confidential
 }
 
+// setValue updates the Value. The public part is updated if the value is not confidential.
+func (c *ConfidentialValue) setValue(value string) {
+	if !c.IsConfidential() {
+		c.public = value
+	}
+	c.confidential = value
+}
+
 // hideValue hides the entire value in the public representation
 func (c *ConfidentialValue) hideValue() {
 	if c.IsConfidential() {

config/confidential_test.go

@@ -44,6 +44,21 @@ func TestConfidentialHideSubmatch(t *testing.T) {
 	assert.Equal(t, expected, value.String())
 }
 
+func TestUpdateConfidentialValue(t *testing.T) {
+	v := NewConfidentialValue("abc")
+
+	v.setValue("xyz")
+	assert.Equal(t, "xyz", v.Value())
+	assert.Equal(t, "xyz", v.String())
+
+	v.hideSubmatches(regexp.MustCompile("(z)"))
+	assert.Equal(t, "xy"+ConfidentialReplacement, v.String())
+
+	v.setValue("abc")
+	assert.Equal(t, "abc", v.Value())
+	assert.Equal(t, "xy"+ConfidentialReplacement, v.String())
+}
+
 func TestFmtStringDoesntLeakConfidentialValues(t *testing.T) {
 	value := NewConfidentialValue("secret")
 	value.hideValue()

config/profile.go

@@ -123,8 +123,9 @@ type InitSection struct {
 func (i *InitSection) IsEmpty() bool { return i == nil }
 
 func (i *InitSection) setRootPath(_ *Profile, rootPath string) {
-	i.FromRepositoryFile = fixPath(i.FromRepositoryFile, expandEnv, absolutePrefix(rootPath))
-	i.FromPasswordFile = fixPath(i.FromPasswordFile, expandEnv, absolutePrefix(rootPath))
+	i.FromRepositoryFile = fixPath(i.FromRepositoryFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	i.FromPasswordFile = fixPath(i.FromPasswordFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	i.FromRepository.setValue(fixPath(i.FromRepository.Value(), expandEnv, expandUserHome))
 }
 
 func (i *InitSection) getCommandFlags(profile *Profile) (flags *shell.Args) {
@@ -184,10 +185,10 @@ func (b *BackupSection) resolve(p *Profile) {
 func (s *BackupSection) setRootPath(p *Profile, rootPath string) {
 	s.SendMonitoringSections.setRootPath(p, rootPath)
 
-	s.ExcludeFile = fixPaths(s.ExcludeFile, expandEnv, absolutePrefix(rootPath))
-	s.FilesFrom = fixPaths(s.FilesFrom, expandEnv, absolutePrefix(rootPath))
-	s.Exclude = fixPaths(s.Exclude, expandEnv)
-	s.Iexclude = fixPaths(s.Iexclude, expandEnv)
+	s.ExcludeFile = fixPaths(s.ExcludeFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	s.FilesFrom = fixPaths(s.FilesFrom, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	s.Exclude = fixPaths(s.Exclude, expandEnv, expandUserHome)
+	s.Iexclude = fixPaths(s.Iexclude, expandEnv, expandUserHome)
 }
 
 // RetentionSection contains the specific configuration to
@@ -259,8 +260,9 @@ func (s *CopySection) IsEmpty() bool { return s == nil }
 func (c *CopySection) setRootPath(p *Profile, rootPath string) {
 	c.SendMonitoringSections.setRootPath(p, rootPath)
 
-	c.PasswordFile = fixPath(c.PasswordFile, expandEnv, absolutePrefix(rootPath))
-	c.RepositoryFile = fixPath(c.RepositoryFile, expandEnv, absolutePrefix(rootPath))
+	c.PasswordFile = fixPath(c.PasswordFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	c.RepositoryFile = fixPath(c.RepositoryFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	c.Repository.setValue(fixPath(c.Repository.Value(), expandEnv, expandUserHome))
 }
 
 func (s *CopySection) getInitFlags(profile *Profile) *shell.Args {
@@ -357,7 +359,7 @@ type SendMonitoringSections struct {
 func (s *SendMonitoringSections) setRootPath(_ *Profile, rootPath string) {
 	for _, monitoringSections := range s.getAllSendMonitoringSections() {
 		for index, value := range monitoringSections {
-			monitoringSections[index].BodyTemplate = fixPath(value.BodyTemplate, expandEnv, absolutePrefix(rootPath))
+			monitoringSections[index].BodyTemplate = fixPath(value.BodyTemplate, expandEnv, expandUserHome, absolutePrefix(rootPath))
 		}
 	}
 }
@@ -489,11 +491,12 @@ func (p *Profile) SetResticVersion(resticVersion string) (err error) {
 // SetRootPath changes the path of all the relative paths and files in the configuration
 func (p *Profile) SetRootPath(rootPath string) {
 	p.Lock = fixPath(p.Lock, expandEnv, absolutePrefix(rootPath))
-	p.PasswordFile = fixPath(p.PasswordFile, expandEnv, absolutePrefix(rootPath))
-	p.RepositoryFile = fixPath(p.RepositoryFile, expandEnv, absolutePrefix(rootPath))
-	p.CacheDir = fixPath(p.CacheDir, expandEnv, absolutePrefix(rootPath))
-	p.CACert = fixPath(p.CACert, expandEnv, absolutePrefix(rootPath))
-	p.TLSClientCert = fixPath(p.TLSClientCert, expandEnv, absolutePrefix(rootPath))
+	p.PasswordFile = fixPath(p.PasswordFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	p.RepositoryFile = fixPath(p.RepositoryFile, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	p.Repository.setValue(fixPath(p.Repository.Value(), expandEnv, expandUserHome))
+	p.CacheDir = fixPath(p.CacheDir, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	p.CACert = fixPath(p.CACert, expandEnv, expandUserHome, absolutePrefix(rootPath))
+	p.TLSClientCert = fixPath(p.TLSClientCert, expandEnv, expandUserHome, absolutePrefix(rootPath))
 
 	// Forward to sections accepting paths
 	for _, s := range GetSectionsWith[relativePath](p) {
@@ -513,7 +516,7 @@ func (p *Profile) SetRootPath(rootPath string) {
 			if paths, ok := stringifyValueOf(section[flag]); ok && len(paths) > 0 {
 				for i, path := range paths {
 					if len(path) > 0 {
-						paths[i] = fixPath(path, expandEnv, absolutePrefix(rootPath))
+						paths[i] = fixPath(path, expandEnv, expandUserHome, absolutePrefix(rootPath))
 					}
 				}
 				section[flag] = paths

config/profile_test.go

@@ -3,6 +3,8 @@ package config
 import (
 	"bytes"
 	"fmt"
+	"math/rand"
+	"os"
 	"path"
 	"path/filepath"
 	"runtime"
@@ -271,6 +273,35 @@ array2 = ["one", "two"]
 	})
 }
 
+func TestEnvironmentInProfileRepo(t *testing.T) {
+	runForVersions(t, func(t *testing.T, version, prefix string) {
+		testConfig := version + `
+		[` + prefix + `profile]
+		repository = "~/$TEST_VAR"
+		password-file = "~/${TEST_VAR}.key"
+		[` + prefix + `profile.copy]
+		repository = "~/$TEST_VAR"
+		[` + prefix + `profile.init]
+		from-repository = "~/$TEST_VAR"
+		`
+		profile, err := getProfile("toml", testConfig, "profile", "")
+		require.NoError(t, err)
+		require.NotNil(t, profile)
+
+		testVar := fmt.Sprintf("v%d", rand.Int())
+		require.NoError(t, os.Setenv("TEST_VAR", testVar))
+		homeDir, err := os.UserHomeDir()
+		require.NoError(t, err)
+		repoPath := filepath.ToSlash(filepath.Join(homeDir, testVar))
+
+		profile.SetRootPath("/any")
+		assert.Equal(t, repoPath, filepath.ToSlash(profile.Repository.Value()))
+		assert.Equal(t, repoPath+".key", filepath.ToSlash(profile.PasswordFile))
+		assert.Equal(t, repoPath, filepath.ToSlash(profile.Init.FromRepository.Value()))
+		assert.Equal(t, repoPath, filepath.ToSlash(profile.Copy.Repository.Value()))
+	})
+}
+
 func TestSetRootInProfileUnix(t *testing.T) {
 	if runtime.GOOS == "windows" {
 		t.SkipNow()