Plugins: Make sure feature toggles config value is deterministic (#75249)

* make sure feature toggle config vals are deterministic * fix nil pointer * undo changes * fix condition * add tests
2023-09-22 13:56:48 +02:00
parent 4cfc834c08
commit d6db9eaeb2
2 changed files with 133 additions and 9 deletions
@@ -379,3 +379,125 @@ func TestInitializer_featureToggleEnvVar(t *testing.T) {
 		}
 	})
 }
+
+func TestService_GetConfigMap(t *testing.T) {
+	tcs := []struct {
+		name     string
+		cfg      *config.Cfg
+		expected map[string]string
+	}{
+		{
+			name: "Both features and proxy settings enabled",
+			cfg: &config.Cfg{
+				Features: featuremgmt.WithFeatures("feat-2", "feat-500", "feat-1"),
+				ProxySettings: setting.SecureSocksDSProxySettings{
+					Enabled:      true,
+					ShowUI:       true,
+					ClientCert:   "c3rt",
+					ClientKey:    "k3y",
+					RootCA:       "ca",
+					ProxyAddress: "https://proxy.grafana.com",
+					ServerName:   "secureProxy",
+				},
+			},
+			expected: map[string]string{
+				"GF_INSTANCE_FEATURE_TOGGLES_ENABLE":              "feat-1,feat-2,feat-500",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_SERVER_ENABLED": "true",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_CLIENT_CERT":    "c3rt",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_CLIENT_KEY":     "k3y",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_ROOT_CA_CERT":   "ca",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_PROXY_ADDRESS":  "https://proxy.grafana.com",
+				"GF_SECURE_SOCKS_DATASOURCE_PROXY_SERVER_NAME":    "secureProxy",
+			},
+		},
+		{
+			name: "Features enabled but proxy settings disabled",
+			cfg: &config.Cfg{
+				Features: featuremgmt.WithFeatures("feat-2", "feat-500", "feat-1"),
+				ProxySettings: setting.SecureSocksDSProxySettings{
+					Enabled:      false,
+					ShowUI:       true,
+					ClientCert:   "c3rt",
+					ClientKey:    "k3y",
+					RootCA:       "ca",
+					ProxyAddress: "https://proxy.grafana.com",
+					ServerName:   "secureProxy",
+				},
+			},
+			expected: map[string]string{
+				"GF_INSTANCE_FEATURE_TOGGLES_ENABLE": "feat-1,feat-2,feat-500",
+			},
+		},
+		{
+			name: "Both features and proxy settings disabled",
+			cfg: &config.Cfg{
+				Features: featuremgmt.WithFeatures("feat-2", false),
+				ProxySettings: setting.SecureSocksDSProxySettings{
+					Enabled:      false,
+					ShowUI:       true,
+					ClientCert:   "c3rt",
+					ClientKey:    "k3y",
+					RootCA:       "ca",
+					ProxyAddress: "https://proxy.grafana.com",
+					ServerName:   "secureProxy",
+				},
+			},
+			expected: map[string]string{},
+		},
+		{
+			name: "Both features and proxy settings empty",
+			cfg: &config.Cfg{
+				Features:      nil,
+				ProxySettings: setting.SecureSocksDSProxySettings{},
+			},
+			expected: map[string]string{},
+		},
+	}
+	for _, tc := range tcs {
+		t.Run(tc.name, func(t *testing.T) {
+			s := &Service{
+				cfg: tc.cfg,
+			}
+			require.Equal(t, tc.expected, s.GetConfigMap(context.Background(), "", nil))
+		})
+	}
+}
+
+func TestService_GetConfigMap_featureToggles(t *testing.T) {
+	t.Run("Feature toggles list is deterministic", func(t *testing.T) {
+		tcs := []struct {
+			enabledFeatures []string
+			expectedConfig  map[string]string
+		}{
+			{
+				enabledFeatures: nil,
+				expectedConfig:  map[string]string{},
+			},
+			{
+				enabledFeatures: []string{},
+				expectedConfig:  map[string]string{},
+			},
+			{
+				enabledFeatures: []string{"A", "B", "C"},
+				expectedConfig:  map[string]string{"GF_INSTANCE_FEATURE_TOGGLES_ENABLE": "A,B,C"},
+			},
+			{
+				enabledFeatures: []string{"C", "B", "A"},
+				expectedConfig:  map[string]string{"GF_INSTANCE_FEATURE_TOGGLES_ENABLE": "A,B,C"},
+			},
+			{
+				enabledFeatures: []string{"b", "a", "c", "d"},
+				expectedConfig:  map[string]string{"GF_INSTANCE_FEATURE_TOGGLES_ENABLE": "a,b,c,d"},
+			},
+		}
+
+		for _, tc := range tcs {
+			s := &Service{
+				cfg: &config.Cfg{
+					Features: fakes.NewFakeFeatureToggles(tc.enabledFeatures...),
+				},
+			}
+			require.Equal(t, tc.expectedConfig, s.GetConfigMap(context.Background(), "", nil))
+		}
+	})
+}