grafana/pkg/setting/setting_feature_toggles_test.go

package setting

import (
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/open-feature/go-sdk/openfeature/memprovider"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"gopkg.in/ini.v1"
)

func TestFeatureToggles(t *testing.T) {
	testCases := []struct {
		name            string
		conf            map[string]string
		expectedToggles map[string]memprovider.InMemoryFlag
	}{
		{
			name: "can parse feature toggles passed in the `enable` array",
			conf: map[string]string{
				"enable": "feature1,feature2",
			},
			expectedToggles: map[string]memprovider.InMemoryFlag{
				"feature1": NewInMemoryFlag("feature1", true),
				"feature2": NewInMemoryFlag("feature2", true),
			},
		},
		{
			name: "can parse feature toggles listed under [feature_toggles]",
			conf: map[string]string{
				"enable":   "feature1,feature2",
				"feature3": "true",
			},
			expectedToggles: map[string]memprovider.InMemoryFlag{
				"feature1": NewInMemoryFlag("feature1", true),
				"feature2": NewInMemoryFlag("feature2", true),
				"feature3": NewInMemoryFlag("feature3", true),
			},
		},
		{
			name: "toggles under [feature_toggles] overrides those in the array",
			conf: map[string]string{
				"enable":   "feature1,feature2",
				"feature2": "false",
			},
			expectedToggles: map[string]memprovider.InMemoryFlag{
				"feature1": NewInMemoryFlag("feature1", true),
				"feature2": NewInMemoryFlag("feature2", false),
			},
		},
		{
			name: "feature flags of different types are handled correctly",
			conf: map[string]string{
				"feature1": "1", "feature2": "1.0",
				"feature3": `{"foo":"bar"}`, "feature4": "bar",
				"feature5": "t", "feature6": "T",
			},
			expectedToggles: map[string]memprovider.InMemoryFlag{
				"feature1": NewInMemoryFlag("feature1", 1),
				"feature2": NewInMemoryFlag("feature2", 1.0),
				"feature3": NewInMemoryFlag("feature3", map[string]any{"foo": "bar"}),
				"feature4": NewInMemoryFlag("feature4", "bar"),
				"feature5": NewInMemoryFlag("feature5", true),
				"feature6": NewInMemoryFlag("feature6", true),
			},
		},
	}

	for _, tc := range testCases {
		f := ini.Empty()

		toggles, _ := f.NewSection("feature_toggles")
		for k, v := range tc.conf {
			_, err := toggles.NewKey(k, v)
			require.ErrorIs(t, err, nil)
		}

		featureToggles, err := ReadFeatureTogglesFromInitFile(toggles)
		require.NoError(t, err)

		for k, v := range featureToggles {
			toggle := tc.expectedToggles[k]
			require.Equal(t, toggle, v, tc.name)
		}
	}
}

func TestFlagValueSerialization(t *testing.T) {
	testCases := []memprovider.InMemoryFlag{
		NewInMemoryFlag("int", 1),
		NewInMemoryFlag("1.0f", 1.0),
		NewInMemoryFlag("1.01f", 1.01),
		NewInMemoryFlag("1.10f", 1.10),
		NewInMemoryFlag("struct", map[string]any{"foo": "bar"}),
		NewInMemoryFlag("string", "bar"),
		NewInMemoryFlag("true", true),
		NewInMemoryFlag("false", false),
	}

	for _, tt := range testCases {
		asStringMap := AsStringMap(map[string]memprovider.InMemoryFlag{tt.Key: tt})

		deserialized, err := ParseFlag(tt.Key, asStringMap[tt.Key])
		assert.NoError(t, err)

		if diff := cmp.Diff(tt, deserialized); diff != "" {
			t.Errorf("(-want, +got) = %v", diff)
		}
	}
}