config: Add unit test for set/unset preset

This checks that CPU/memory are updated as needed when moving from one
preset to another. If CPU/memory are invalid for the new preset, the
config code should reset them to their default value.

Author: cfergeau

pkg/crc/config/settings_test.go

@@ -0,0 +1,160 @@
+package config
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/crc-org/crc/pkg/crc/constants"
+	crcpreset "github.com/crc-org/crc/pkg/crc/preset"
+	"github.com/crc-org/crc/pkg/crc/version"
+
+	"github.com/spf13/cast"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// override for ValidateMemory in validations.go to disable the physical memory check
+func validateMemoryNoPhysicalCheck(value interface{}, preset crcpreset.Preset) (bool, string) {
+	v, err := cast.ToIntE(value)
+	if err != nil {
+		return false, fmt.Sprintf("requires integer value in MiB >= %d", constants.GetDefaultMemory(preset))
+	}
+	if v < constants.GetDefaultMemory(preset) {
+		return false, fmt.Sprintf("requires memory in MiB >= %d", constants.GetDefaultMemory(preset))
+	}
+	return true, ""
+}
+
+func newInMemoryConfig() (*Config, error) {
+	ValidateMemory = validateMemoryNoPhysicalCheck
+	cfg := New(NewEmptyInMemoryStorage(), NewEmptyInMemorySecretStorage())
+
+	RegisterSettings(cfg)
+
+	return cfg, nil
+}
+
+// Check that with the default preset, we cannot set less CPUs than the defaultCPUs
+// but that it is allowed with a different preset with less requirements (podman)
+func TestCPUsValidate(t *testing.T) {
+	cfg, err := newInMemoryConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, SettingValue{
+		Value:     version.GetDefaultPreset().String(),
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(Preset))
+
+	defaultCPUs := constants.GetDefaultCPUs(version.GetDefaultPreset())
+	_, err = cfg.Set(CPUs, defaultCPUs-1)
+	require.Error(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     defaultCPUs,
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+
+	_, err = cfg.Set(Preset, crcpreset.Podman)
+	require.NoError(t, err)
+	_, err = cfg.Set(CPUs, defaultCPUs-1)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     defaultCPUs - 1,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+}
+
+// Check that when changing preset, invalid memory values are reset to their
+// default value
+func TestSetPreset(t *testing.T) {
+	cfg, err := newInMemoryConfig()
+	require.NoError(t, err)
+
+	_, err = cfg.Set(Preset, crcpreset.Podman)
+	require.NoError(t, err)
+	_, err = cfg.Set(Memory, 10000)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     10000,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(Memory))
+	_, err = cfg.Set(CPUs, 3)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     3,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+
+	// Changing the preset to 'openshift' should reset the CPUs config value
+	_, err = cfg.Set(Preset, crcpreset.OpenShift)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     10000,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(Memory))
+	assert.Equal(t, SettingValue{
+		Value:     4,
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+}
+
+// Check that when unsetting preset, invalid memory values are reset to their
+// default value
+func TestUnsetPreset(t *testing.T) {
+	cfg, err := newInMemoryConfig()
+	require.NoError(t, err)
+
+	_, err = cfg.Set(Preset, crcpreset.Podman)
+	require.NoError(t, err)
+	_, err = cfg.Set(Memory, 10000)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     10000,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(Memory))
+	_, err = cfg.Set(CPUs, 3)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     3,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+
+	// Unsetting the preset should reset the CPUs config value
+	_, err = cfg.Unset(Preset)
+	require.NoError(t, err)
+	assert.Equal(t, SettingValue{
+		Value:     crcpreset.OpenShift.String(),
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(Preset))
+	assert.Equal(t, SettingValue{
+		Value:     10000,
+		Invalid:   false,
+		IsDefault: false,
+		IsSecret:  false,
+	}, cfg.Get(Memory))
+	assert.Equal(t, SettingValue{
+		Value:     4,
+		Invalid:   false,
+		IsDefault: true,
+		IsSecret:  false,
+	}, cfg.Get(CPUs))
+}

pkg/crc/config/validations.go

@@ -54,7 +54,8 @@ func ValidateCPUs(value interface{}, preset crcpreset.Preset) (bool, string) {
 }
 
 // ValidateMemory checks if provided memory is valid in the config
-func ValidateMemory(value interface{}, preset crcpreset.Preset) (bool, string) {
+// It's defined as a variable so that it can be overridden in tests to disable the physical memory check
+var ValidateMemory = func(value interface{}, preset crcpreset.Preset) (bool, string) {
 	v, err := cast.ToIntE(value)
 	if err != nil {
 		return false, fmt.Sprintf("requires integer value in MiB >= %d", constants.GetDefaultMemory(preset))