#77: Make page title customizable

config/config.go

@@ -41,6 +41,10 @@ var (
 
 	// ErrInvalidSecurityConfig is an error returned when the security configuration is invalid
 	ErrInvalidSecurityConfig = errors.New("invalid security configuration")
+
+	// StaticFolder is the path to the location of the static folder from the root path of the project
+	// The only reason this is exposed is to allow running tests from a different path than the root path of the project
+	StaticFolder = "./web/static"
 )
 
 // Config is the main configuration structure
@@ -75,6 +79,9 @@ type Config struct {
 	// Web is the configuration for the web listener
 	Web *WebConfig `yaml:"web"`
 
+	// UI is the configuration for the UI
+	UI *UIConfig `yaml:"ui"`
+
 	filePath        string    // path to the file from which config was loaded from
 	lastFileModTime time.Time // last modification time
 }
@@ -162,6 +169,9 @@ func parseAndValidateConfigBytes(yamlBytes []byte) (config *Config, err error) {
 		if err := validateWebConfig(config); err != nil {
 			return nil, err
 		}
+		if err := validateUIConfig(config); err != nil {
+			return nil, err
+		}
 		if err := validateStorageConfig(config); err != nil {
 			return nil, err
 		}
@@ -191,9 +201,20 @@ func validateStorageConfig(config *Config) error {
 	return nil
 }
 
+func validateUIConfig(config *Config) error {
+	if config.UI == nil {
+		config.UI = GetDefaultUIConfig()
+	} else {
+		if err := config.UI.validateAndSetDefaults(); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 func validateWebConfig(config *Config) error {
 	if config.Web == nil {
-		config.Web = &WebConfig{Address: DefaultAddress, Port: DefaultPort}
+		config.Web = GetDefaultWebConfig()
 	} else {
 		return config.Web.validateAndSetDefaults()
 	}

config/config_test.go

@@ -36,10 +36,15 @@ func TestLoadDefaultConfigurationFile(t *testing.T) {
 
 func TestParseAndValidateConfigBytes(t *testing.T) {
 	file := t.TempDir() + "/test.db"
+	StaticFolder = "../web/static"
+	defer func() {
+		StaticFolder = "./web/static"
+	}()
 	config, err := parseAndValidateConfigBytes([]byte(fmt.Sprintf(`
 storage:
   file: %s
-
+ui:
+  title: Test
 services:
   - name: twinnation
     url: https://twinnation.org/health
@@ -71,6 +76,9 @@ services:
 	if config == nil {
 		t.Fatal("Config shouldn't have been nil")
 	}
+	if config.UI == nil || config.UI.Title != "Test" {
+		t.Error("Expected Config.UI.Title to be Test")
+	}
 	if len(config.Services) != 3 {
 		t.Error("Should have returned two services")
 	}

config/ui.go

@@ -0,0 +1,36 @@
+package config
+
+import (
+	"bytes"
+	"html/template"
+)
+
+const defaultTitle = "Health Dashboard | Gatus"
+
+// UIConfig is the configuration for the UI of Gatus
+type UIConfig struct {
+	Title string `yaml:"title"` // Title of the page
+}
+
+// GetDefaultUIConfig returns a UIConfig struct with the default values
+func GetDefaultUIConfig() *UIConfig {
+	return &UIConfig{
+		Title: defaultTitle,
+	}
+}
+
+func (cfg *UIConfig) validateAndSetDefaults() error {
+	if len(cfg.Title) == 0 {
+		cfg.Title = defaultTitle
+	}
+	t, err := template.ParseFiles(StaticFolder + "/index.html")
+	if err != nil {
+		return err
+	}
+	var buffer bytes.Buffer
+	err = t.Execute(&buffer, cfg)
+	if err != nil {
+		return err
+	}
+	return nil
+}

config/ui_test.go

@@ -0,0 +1,21 @@
+package config
+
+import "testing"
+
+func TestUIConfig_validateAndSetDefaults(t *testing.T) {
+	StaticFolder = "../web/static"
+	defer func() {
+		StaticFolder = "./web/static"
+	}()
+	uiConfig := &UIConfig{Title: ""}
+	if err := uiConfig.validateAndSetDefaults(); err != nil {
+		t.Error("expected no error, got", err.Error())
+	}
+}
+
+func TestGetDefaultUIConfig(t *testing.T) {
+	defaultUIConfig := GetDefaultUIConfig()
+	if defaultUIConfig.Title != defaultTitle {
+		t.Error("expected GetDefaultUIConfig() to return defaultTitle, got", defaultUIConfig.Title)
+	}
+}

config/web.go

@@ -15,6 +15,11 @@ type WebConfig struct {
 	Port int `yaml:"port"`
 }
 
+// GetDefaultWebConfig returns a WebConfig struct with the default values
+func GetDefaultWebConfig() *WebConfig {
+	return &WebConfig{Address: DefaultAddress, Port: DefaultPort}
+}
+
 // validateAndSetDefaults checks and sets the default values for fields that are not set
 func (web *WebConfig) validateAndSetDefaults() error {
 	// Validate the Address