config: Add config Path type and use it for proxy-ca-file

cfergeau · praveenkumar · commit f780531357f8 · 2023-11-07T12:25:34.000+05:30
This allows to convert relative paths to absolute paths at the time the config value is set. fixes #3641
diff --git a/pkg/crc/api/api_client_test.go b/pkg/crc/api/api_client_test.go
@@ -196,6 +196,9 @@ func TestConfigGetAll(t *testing.T) {
 		switch v := v.Value.(type) {
 		case int:
 			configs[k] = float64(v)
+		// when config of type Path is converted to JSON it is converted to string
+		case crcConfig.Path:
+			configs[k] = string(v)
 		default:
 			configs[k] = v
 		}
diff --git a/pkg/crc/config/config.go b/pkg/crc/config/config.go
@@ -2,6 +2,7 @@ package config
 
 import (
 	"fmt"
+	"path/filepath"
 	"reflect"
 
 	"github.com/crc-org/crc/v2/pkg/crc/preset"
@@ -101,6 +102,14 @@ func (c *Config) Set(key string, value interface{}) (string, error) {
 		if err != nil {
 			return "", fmt.Errorf(invalidProp, value, key, err)
 		}
+	case Path:
+		path := cast.ToString(value)
+		path, err := filepath.Abs(path)
+		if err != nil {
+			return "", fmt.Errorf(invalidProp, value, key, err)
+		}
+		castValue = path
+
 	case preset.Preset:
 		castValue = cast.ToString(value)
 	default:
@@ -200,6 +209,8 @@ func (c *Config) Get(key string) SettingValue {
 		}
 	case string:
 		value = cast.ToString(value)
+	case Path:
+		value = Path(cast.ToString(value))
 	case bool:
 		value, err = cast.ToBoolE(value)
 		if err != nil {
diff --git a/pkg/crc/config/settings.go b/pkg/crc/config/settings.go
@@ -122,7 +122,7 @@ func RegisterSettings(cfg *Config) {
 		"HTTPS proxy URL (string, like 'https://my-proxy.com:8443')")
 	cfg.AddSetting(NoProxy, "", validateNoProxy, SuccessfullyApplied,
 		"Hosts, ipv4 addresses or CIDR which do not use a proxy (string, comma-separated list such as '127.0.0.1,192.168.100.1/24')")
-	cfg.AddSetting(ProxyCAFile, "", validatePath, SuccessfullyApplied,
+	cfg.AddSetting(ProxyCAFile, Path(""), validatePath, SuccessfullyApplied,
 		"Path to an HTTPS proxy certificate authority (CA)")
 
 	cfg.AddSetting(EnableClusterMonitoring, false, ValidateBool, SuccessfullyApplied,
diff --git a/pkg/crc/config/settings_test.go b/pkg/crc/config/settings_test.go
@@ -2,6 +2,7 @@ package config
 
 import (
 	"fmt"
+	"path/filepath"
 	"testing"
 
 	"github.com/crc-org/crc/v2/pkg/crc/constants"
@@ -158,3 +159,26 @@ func TestUnsetPreset(t *testing.T) {
 		IsSecret:  false,
 	}, cfg.Get(CPUs))
 }
+
+func TestPath(t *testing.T) {
+	cfg, err := newInMemoryConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, SettingValue{
+		Value:     Path(""),
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(ProxyCAFile))
+
+	_, err = cfg.Set(ProxyCAFile, "testdata/foo.crt")
+	require.NoError(t, err)
+	expectedPath, err := filepath.Abs("testdata/foo.crt")
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     Path(expectedPath),
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(ProxyCAFile))
+}
diff --git a/pkg/crc/config/testdata/foo.crt b/pkg/crc/config/testdata/foo.crt
diff --git a/pkg/crc/config/types.go b/pkg/crc/config/types.go
@@ -55,3 +55,10 @@ type RawStorage interface {
 	Set(key string, value interface{}) error
 	Unset(key string) error
 }
+
+// type Path is used for a setting which is a file path
+type Path string
+
+func (p Path) String() string {
+	return string(p)
+}
