WIP: Embed files into the binary

config/config_test.go

@@ -17,7 +17,6 @@ import (
 	"github.com/TwiN/gatus/v3/alerting/provider/telegram"
 	"github.com/TwiN/gatus/v3/alerting/provider/twilio"
 	"github.com/TwiN/gatus/v3/client"
-	"github.com/TwiN/gatus/v3/config/ui"
 	"github.com/TwiN/gatus/v3/config/web"
 	"github.com/TwiN/gatus/v3/core"
 )
@@ -38,10 +37,6 @@ func TestLoadDefaultConfigurationFile(t *testing.T) {
 
 func TestParseAndValidateConfigBytes(t *testing.T) {
 	file := t.TempDir() + "/test.db"
-	ui.StaticFolder = "../web/static"
-	defer func() {
-		ui.StaticFolder = "./web/static"
-	}()
 	config, err := parseAndValidateConfigBytes([]byte(fmt.Sprintf(`
 storage:
   file: %s

config/ui/ui.go

@@ -3,19 +3,15 @@ package ui
 import (
 	"bytes"
 	"html/template"
+
+	"github.com/TwiN/gatus/v3/web"
 )
 
 const (
 	defaultTitle = "Health Dashboard | Gatus"
 	defaultLogo  = ""
 )
 
-var (
-	// 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 configuration for the UI of Gatus
 type Config struct {
 	Title string `yaml:"title"` // Title of the page
@@ -35,7 +31,7 @@ func (cfg *Config) ValidateAndSetDefaults() error {
 	if len(cfg.Title) == 0 {
 		cfg.Title = defaultTitle
 	}
-	t, err := template.ParseFiles(StaticFolder + "/index.html")
+	t, err := template.ParseFS(web.StaticFolder, "index.html")
 	if err != nil {
 		return err
 	}

config/ui/ui_test.go

@@ -5,10 +5,6 @@ import (
 )
 
 func TestConfig_ValidateAndSetDefaults(t *testing.T) {
-	StaticFolder = "../../web/static"
-	defer func() {
-		StaticFolder = "./web/static"
-	}()
 	cfg := &Config{Title: ""}
 	if err := cfg.ValidateAndSetDefaults(); err != nil {
 		t.Error("expected no error, got", err.Error())

controller/controller.go

@@ -22,7 +22,7 @@ var (
 
 // Handle creates the router and starts the server
 func Handle(securityConfig *security.Config, webConfig *web.Config, uiConfig *ui.Config, enableMetrics bool) {
-	var router http.Handler = handler.CreateRouter(ui.StaticFolder, securityConfig, uiConfig, enableMetrics)
+	var router http.Handler = handler.CreateRouter(securityConfig, uiConfig, enableMetrics)
 	if os.Getenv("ENVIRONMENT") == "dev" {
 		router = handler.DevelopmentCORS(router)
 	}

controller/handler/badge_test.go

@@ -31,7 +31,7 @@ func TestUptimeBadge(t *testing.T) {
 	}
 	watchdog.UpdateServiceStatuses(cfg.Services[0], &core.Result{Success: true, Duration: time.Millisecond, Timestamp: time.Now()})
 	watchdog.UpdateServiceStatuses(cfg.Services[1], &core.Result{Success: false, Duration: time.Second, Timestamp: time.Now()})
-	router := CreateRouter("../../web/static", cfg.Security, nil, cfg.Metrics)
+	router := CreateRouter(cfg.Security, nil, cfg.Metrics)
 	type Scenario struct {
 		Name         string
 		Path         string

controller/handler/chart_test.go

@@ -30,7 +30,7 @@ func TestResponseTimeChart(t *testing.T) {
 	}
 	watchdog.UpdateServiceStatuses(cfg.Services[0], &core.Result{Success: true, Duration: time.Millisecond, Timestamp: time.Now()})
 	watchdog.UpdateServiceStatuses(cfg.Services[1], &core.Result{Success: false, Duration: time.Second, Timestamp: time.Now()})
-	router := CreateRouter("../../web/static", cfg.Security, nil, cfg.Metrics)
+	router := CreateRouter(cfg.Security, nil, cfg.Metrics)
 	type Scenario struct {
 		Name         string
 		Path         string

controller/handler/handler.go

@@ -5,18 +5,18 @@ import (
 
 	"github.com/TwiN/gatus/v3/config/ui"
 	"github.com/TwiN/gatus/v3/security"
+	"github.com/TwiN/gatus/v3/web"
 	"github.com/TwiN/health"
 	"github.com/gorilla/mux"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
-func CreateRouter(staticFolder string, securityConfig *security.Config, uiConfig *ui.Config, enabledMetrics bool) *mux.Router {
+func CreateRouter(securityConfig *security.Config, uiConfig *ui.Config, enabledMetrics bool) *mux.Router {
 	router := mux.NewRouter()
 	if enabledMetrics {
 		router.Handle("/metrics", promhttp.Handler()).Methods("GET")
 	}
 	router.Handle("/health", health.Handler().WithJSON(true)).Methods("GET")
-	router.HandleFunc("/favicon.ico", FavIcon(staticFolder)).Methods("GET")
 	// Endpoints
 	router.HandleFunc("/api/v1/services/statuses", secureIfNecessary(securityConfig, ServiceStatuses)).Methods("GET") // No GzipHandler for this one, because we cache the content as Gzipped already
 	router.HandleFunc("/api/v1/services/{key}/statuses", secureIfNecessary(securityConfig, GzipHandlerFunc(ServiceStatus))).Methods("GET")
@@ -26,10 +26,10 @@ func CreateRouter(staticFolder string, securityConfig *security.Config, uiConfig
 	router.HandleFunc("/api/v1/services/{key}/response-times/{duration}/badge.svg", ResponseTimeBadge).Methods("GET")
 	router.HandleFunc("/api/v1/services/{key}/response-times/{duration}/chart.svg", ResponseTimeChart).Methods("GET")
 	// SPA
-	router.HandleFunc("/services/{service}", SinglePageApplication(staticFolder, uiConfig)).Methods("GET")
-	router.HandleFunc("/", SinglePageApplication(staticFolder, uiConfig)).Methods("GET")
+	router.HandleFunc("/services/{service}", SinglePageApplication(uiConfig)).Methods("GET")
+	router.HandleFunc("/", SinglePageApplication(uiConfig)).Methods("GET")
 	// Everything else falls back on static content
-	router.PathPrefix("/").Handler(GzipHandler(http.FileServer(http.Dir(staticFolder))))
+	router.PathPrefix("/").Handler(http.StripPrefix("/", http.FileServer(http.FS(web.StaticFolder))))
 	return router
 }
 

controller/handler/handler_test.go

@@ -7,7 +7,7 @@ import (
 )
 
 func TestCreateRouter(t *testing.T) {
-	router := CreateRouter("../../web/static", nil, nil, true)
+	router := CreateRouter(nil, nil, true)
 	type Scenario struct {
 		Name         string
 		Path         string

controller/handler/service_status_test.go

@@ -101,7 +101,7 @@ func TestServiceStatus(t *testing.T) {
 	}
 	watchdog.UpdateServiceStatuses(cfg.Services[0], &core.Result{Success: true, Duration: time.Millisecond, Timestamp: time.Now()})
 	watchdog.UpdateServiceStatuses(cfg.Services[1], &core.Result{Success: false, Duration: time.Second, Timestamp: time.Now()})
-	router := CreateRouter("../../web/static", cfg.Security, nil, cfg.Metrics)
+	router := CreateRouter(cfg.Security, nil, cfg.Metrics)
 
 	type Scenario struct {
 		Name         string
@@ -157,7 +157,7 @@ func TestServiceStatuses(t *testing.T) {
 	// Can't be bothered dealing with timezone issues on the worker that runs the automated tests
 	firstResult.Timestamp = time.Time{}
 	secondResult.Timestamp = time.Time{}
-	router := CreateRouter("../../web/static", nil, nil, false)
+	router := CreateRouter(nil, nil, false)
 
 	type Scenario struct {
 		Name         string

controller/handler/spa.go

@@ -6,21 +6,20 @@ import (
 	"net/http"
 
 	"github.com/TwiN/gatus/v3/config/ui"
+	"github.com/TwiN/gatus/v3/web"
 )
 
-func SinglePageApplication(staticFolder string, ui *ui.Config) http.HandlerFunc {
+func SinglePageApplication(ui *ui.Config) http.HandlerFunc {
 	return func(writer http.ResponseWriter, request *http.Request) {
-		t, err := template.ParseFiles(staticFolder + "/index.html")
+		t, err := template.ParseFS(web.StaticFolder, "index.html")
 		if err != nil {
 			log.Println("[handler][SinglePageApplication] Failed to parse template:", err.Error())
-			http.ServeFile(writer, request, staticFolder+"/index.html")
 			return
 		}
 		writer.Header().Set("Content-Type", "text/html")
 		err = t.Execute(writer, ui)
 		if err != nil {
 			log.Println("[handler][SinglePageApplication] Failed to parse template:", err.Error())
-			http.ServeFile(writer, request, staticFolder+"/index.html")
 			return
 		}
 	}

controller/handler/spa_test.go

@@ -30,7 +30,7 @@ func TestSinglePageApplication(t *testing.T) {
 	}
 	watchdog.UpdateServiceStatuses(cfg.Services[0], &core.Result{Success: true, Duration: time.Millisecond, Timestamp: time.Now()})
 	watchdog.UpdateServiceStatuses(cfg.Services[1], &core.Result{Success: false, Duration: time.Second, Timestamp: time.Now()})
-	router := CreateRouter("../../web/static", cfg.Security, nil, cfg.Metrics)
+	router := CreateRouter(cfg.Security, nil, cfg.Metrics)
 	type Scenario struct {
 		Name         string
 		Path         string

web/web.go

@@ -0,0 +1,10 @@
+package web
+
+import (
+	"embed"
+	"io/fs"
+)
+
+//go:embed static
+var folder embed.FS
+var StaticFolder, _ = fs.Sub(folder, "static")