support redacted config in dashboard (#635)

gorse-io · Feb 25, 2023 · bcc601b · bcc601b
1 parent 61c72ff
commit bcc601b
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/config/config.go b/config/config.go
@@ -83,6 +83,7 @@ type MasterConfig struct {
 	DashboardUserName   string        `mapstructure:"dashboard_user_name"`          // dashboard user name
 	DashboardPassword   string        `mapstructure:"dashboard_password"`           // dashboard password
 	DashboardAuthServer string        `mapstructure:"dashboard_auth_server"`        // dashboard auth server
+	DashboardRedacted   bool          `mapstructure:"dashboard_redacted"`
 	AdminAPIKey         string        `mapstructure:"admin_api_key"`
 }
 
@@ -540,6 +541,7 @@ func LoadConfig(path string, oneModel bool) (*Config, error) {
 		{"master.dashboard_user_name", "GORSE_DASHBOARD_USER_NAME"},
 		{"master.dashboard_password", "GORSE_DASHBOARD_PASSWORD"},
 		{"master.dashboard_auth_server", "GORSE_DASHBOARD_AUTH_SERVER"},
+		{"master.dashboard_redacted", "GORSE_DASHBOARD_REDACTED"},
 		{"master.admin_api_key", "GORSE_ADMIN_API_KEY"},
 		{"server.api_key", "GORSE_SERVER_API_KEY"},
 	}

diff --git a/config/config_test.go b/config/config_test.go
@@ -175,6 +175,7 @@ func TestBindEnv(t *testing.T) {
 		{"GORSE_DASHBOARD_USER_NAME", "user_name"},
 		{"GORSE_DASHBOARD_PASSWORD", "password"},
 		{"GORSE_DASHBOARD_AUTH_SERVER", "http://127.0.0.1:8888"},
+		{"GORSE_DASHBOARD_REDACTED", "true"},
 		{"GORSE_ADMIN_API_KEY", "<admin_api_key>"},
 		{"GORSE_SERVER_API_KEY", "<server_api_key>"},
 	}
@@ -197,6 +198,7 @@ func TestBindEnv(t *testing.T) {
 	assert.Equal(t, "user_name", config.Master.DashboardUserName)
 	assert.Equal(t, "password", config.Master.DashboardPassword)
 	assert.Equal(t, "http://127.0.0.1:8888", config.Master.DashboardAuthServer)
+	assert.Equal(t, true, config.Master.DashboardRedacted)
 	assert.Equal(t, "<admin_api_key>", config.Master.AdminAPIKey)
 	assert.Equal(t, "<server_api_key>", config.Server.APIKey)
 

diff --git a/master/rest.go b/master/rest.go
@@ -517,7 +517,7 @@ func (m *Master) getConfig(_ *restful.Request, response *restful.Response) {
 		server.InternalServerError(response, err)
 		return
 	}
-	if m.managedMode {
+	if m.Config.Master.DashboardRedacted {
 		delete(configMap, "database")
 	}
 	server.Ok(response, formatConfig(configMap))

diff --git a/master/rest_test.go b/master/rest_test.go
@@ -829,16 +829,16 @@ func TestMaster_GetConfig(t *testing.T) {
 		Body(marshal(t, formatConfig(convertToMapStructure(t, s.Config)))).
 		End()
 
-	s.managedMode = true
-	managedConfig := formatConfig(convertToMapStructure(t, s.Config))
-	delete(managedConfig, "database")
+	s.Config.Master.DashboardRedacted = true
+	redactedConfig := formatConfig(convertToMapStructure(t, s.Config))
+	delete(redactedConfig, "database")
 	apitest.New().
 		Handler(s.handler).
 		Get("/api/dashboard/config").
 		Header("Cookie", cookie).
 		Expect(t).
 		Status(http.StatusOK).
-		Body(marshal(t, managedConfig)).
+		Body(marshal(t, redactedConfig)).
 		End()
 }