Template: Reduce log level for Getwd() failures (#251)

Author: jkellerer

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/adrg/xdg v0.4.0
 	github.com/capnspacehook/taskmaster v0.0.0-20210519235353-1629df7c85e9
 	github.com/coreos/go-systemd/v22 v22.5.0
-	github.com/creativeprojects/clog v0.13.0
+	github.com/creativeprojects/clog v0.14.0
 	github.com/creativeprojects/go-selfupdate v1.1.1
 	github.com/distatus/battery v0.11.0
 	github.com/fatih/color v1.15.0
@@ -24,7 +24,7 @@ require (
 	github.com/stretchr/testify v1.8.4
 	golang.org/x/crypto v0.11.0
 	golang.org/x/exp v0.0.0-20230425010034-47ecfdc1ba53
-	golang.org/x/sys v0.10.0
+	golang.org/x/sys v0.13.0
 	golang.org/x/text v0.11.0
 	gopkg.in/yaml.v3 v3.0.1
 	howett.net/plist v1.0.0
@@ -47,7 +47,7 @@ require (
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/lufia/plan9stats v0.0.0-20230110061619-bbe2e5e100de // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
-	github.com/mattn/go-isatty v0.0.17 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect

go.sum

@@ -63,6 +63,8 @@ github.com/coreos/go-systemd/v22 v22.5.0 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8
 github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/creativeprojects/clog v0.13.0 h1:QVWO65Za2/XfCQeNnDvO4td9i7fwV2xuv8V5jzFIONk=
 github.com/creativeprojects/clog v0.13.0/go.mod h1:4CBBbXkwjxTSIE/OyrC77aTrEEHj6daYGFEDrNjfOkU=
+github.com/creativeprojects/clog v0.14.0 h1:kthfMG6efS9kI4ACgYRIOPZ2efQkXvW7VhqZigCtpzU=
+github.com/creativeprojects/clog v0.14.0/go.mod h1:iHLlN4sZU+o5rRiFab6ZGHs2vApq09DyykMVJ2Sflro=
 github.com/creativeprojects/go-selfupdate v1.1.1 h1:eQT5xvjniA6UsNd5ScVu+vzP+fmpMafycNVbLCNsqLY=
 github.com/creativeprojects/go-selfupdate v1.1.1/go.mod h1:nm7AWUJfrfYt/SB97NAcMhR0KEpPqlrVHXkWFti+ezw=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -195,6 +197,8 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng=
 github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
+github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
+github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/matttproud/golang_protobuf_extensions v1.0.4 h1:mmDVorXM7PCGKw94cs5zkfA9PSy5pEvNWRP0ET0TIVo=
 github.com/matttproud/golang_protobuf_extensions v1.0.4/go.mod h1:BSXmuO+STAnVfrANrmjBb36TMTDstsz7MSK+HVaYKv4=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
@@ -427,9 +431,12 @@ golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.9.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA=
 golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
+golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.10.0 h1:3R7pNqamzBraeqj/Tj8qt1aQ2HpmlC+Cx/qL/7hn4/c=
 golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o=

util/templates/data.go

@@ -5,6 +5,7 @@ import (
 	"path/filepath"
 	"runtime"
 	"strings"
+	"sync"
 	"time"
 
 	"github.com/creativeprojects/clog"
@@ -43,10 +44,14 @@ func NewDefaultData(env map[string]string) (data DefaultData) {
 		CurrentDir: startupDir,
 	}
 
-	if cwd, err := os.Getwd(); err == nil {
-		data.CurrentDir = filepath.ToSlash(cwd)
+	if logStartupDirError != nil {
+		logStartupDirError()
+	}
+
+	if dir, errorFunc := internalGetCurrentDir(".CurrentDir"); errorFunc == nil {
+		data.CurrentDir = dir
 	} else {
-		clog.Warning("failed retrieving pwd: %s", err.Error())
+		errorFunc()
 	}
 
 	if binary, err := os.Executable(); err == nil {
@@ -75,11 +80,16 @@ func NewDefaultData(env map[string]string) (data DefaultData) {
 	return data
 }
 
-var startupDir = (func() string {
+func internalGetCurrentDir(name string) (startupDir string, logError func()) {
 	if dir, err := os.Getwd(); err == nil {
-		return filepath.ToSlash(dir)
+		startupDir = filepath.ToSlash(dir)
 	} else {
-		clog.Warning("failed retrieving pwd: %s", err.Error())
-		return "."
+		startupDir = "."
+		logError = sync.OnceFunc(func() {
+			clog.Debugf("using %q as fallback for %s ; %s", startupDir, name, err.Error())
+		})
 	}
-})()
+	return
+}
+
+var startupDir, logStartupDirError = internalGetCurrentDir(".StartupDir")

util/templates/data_test.go

@@ -8,6 +8,7 @@ import (
 	"testing"
 	"time"
 
+	"github.com/creativeprojects/clog"
 	"github.com/creativeprojects/resticprofile/util"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -23,13 +24,38 @@ func TestBinaryDir(t *testing.T) {
 func TestCurrentDir(t *testing.T) {
 	dir, err := os.Getwd()
 	require.NoError(t, err)
-	defer func(d string) { _ = os.Chdir(d) }(dir)
+	resetDir := func() { _ = os.Chdir(dir) }
+	defer resetDir()
 
-	require.NoError(t, os.Chdir(t.TempDir()))
-	currentDir, _ := os.Getwd()
+	t.Run("CurrentDir", func(t *testing.T) {
+		defer resetDir()
+		require.NoError(t, os.Chdir(t.TempDir()))
+		currentDir, _ := os.Getwd()
 
-	assert.Equal(t, filepath.ToSlash(dir), NewDefaultData(nil).StartupDir)
-	assert.Equal(t, filepath.ToSlash(currentDir), NewDefaultData(nil).CurrentDir)
+		assert.Equal(t, filepath.ToSlash(dir), NewDefaultData(nil).StartupDir)
+		assert.Equal(t, filepath.ToSlash(currentDir), NewDefaultData(nil).CurrentDir)
+	})
+
+	t.Run("getStartupDir", func(t *testing.T) {
+		defer resetDir()
+
+		defaultLogger := clog.GetDefaultLogger()
+		defer clog.SetDefaultLogger(defaultLogger)
+
+		dir := filepath.Join(t.TempDir(), "start-dir")
+		require.NoError(t, os.Mkdir(dir, 0700))
+		require.NoError(t, os.Chdir(dir))
+		dir, _ = os.Getwd()
+
+		mem := clog.NewMemoryHandler()
+		clog.SetDefaultLogger(clog.NewLogger(mem))
+
+		currentDir, logError := internalGetCurrentDir(".TestDir")
+		assert.Equal(t, filepath.ToSlash(dir), currentDir)
+		assert.Nil(t, logError)
+
+		// TODO: Test error in getwd()
+	})
 }
 
 func TestTempDir(t *testing.T) {