feat: refactor with tests

.github/workflows/validate.yaml

@@ -0,0 +1,27 @@
+name: Validate
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  job:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 1.21
+
+      - name: 🧹 Lint
+        uses: golangci/golangci-lint-action@v6
+
+      - name: 🧪 Test
+        run: go test -v ./...

ReadME.MD

@@ -25,9 +25,11 @@ A docker container is provided at `ameliaah/ical-merger:latest`, mount the confi
 Example:
 
 ```yaml
-webhook: <discord url>
 adress: "127.0.0.1"
 port: "4040"
+notifcation:
+  service: discord
+  url: <URL>
 sources:
 - end_point: filtered_calender
   heartbeat: 60
@@ -71,3 +73,15 @@ sources:
 These will now be accessible on `http://127.0.0.1:4040/filtered_calender.ics` and `http://127.0.0.1:4040/full_calender.ics`
 
 Quickly made to make my school calender work because my school sucks 😝
+
+## Production
+
+### Health Check
+
+The health check endpoint is available at `/health` and will return a 200 status code if the server is running.
+
+Additionally, a command exists to check the health of the server:
+
+```bash
+./ical-merger -health
+```

config.example.yaml

@@ -1,9 +1,10 @@
-# Discord URL
-webhook:
 # Hostname to bind the server to (default none) 
 hostname: 
 # Port to bind the server to (default 4040)
 port: "4040"
+notification:
+  service: discord
+  url: <URL>
 sources:
 - end_point: filtered_calender
   heartbeat: 60

config/config.go

@@ -1,10 +1,13 @@
 package config
 
 import (
+	"fmt"
+	"net/url"
 	"os"
+	"slices"
 	"strings"
 
-	"gopkg.in/yaml.v2"
+	"gopkg.in/yaml.v3"
 )
 
 type Rule struct {
@@ -23,13 +26,6 @@ func (r *Rule) Transform(s string) string {
 	return strings.ToLower(s)
 }
 
-type SourceInfo struct {
-	Name      string     `yaml:"name"`
-	Url       string     `yaml:"url"`
-	Rules     []Rule     `yaml:"rules,omitempty"`
-	Modifiers []Modifier `yaml:"modifiers,omitempty"`
-}
-
 type Action string
 
 const (
@@ -39,6 +35,12 @@ const (
 	ALARM   Action = "ALARM"
 )
 
+type NotificationService string
+
+const (
+	NotifyDiscord NotificationService = "DISCORD"
+)
+
 type Modifier struct {
 	Name      string `yaml:"name"`
 	Component string `yaml:"component,omitempty"`
@@ -47,40 +49,140 @@ type Modifier struct {
 	Filters   []Rule `yaml:"rules,omitempty"`
 }
 
-type Source struct {
-	EndPoint  string       `yaml:"end_point"`
-	Heartbeat int          `yaml:"heartbeat"`
-	XWRName   string       `yaml:"xwr_name"`
-	Info      []SourceInfo `yaml:"info"`
-}
-
 type Config struct {
-	WebHook  string   `yaml:"webhook"`
-	Hostname string   `yaml:"hostname"`
-	Port     string   `yaml:"port"`
-	Sources  []Source `yaml:"sources"`
+	Hostname string `yaml:"hostname"`
+	Port     string `yaml:"port"`
+
+	Notification Notification `yaml:"notification"`
+	Sources      []Source     `yaml:"sources"`
 }
 
 var defaultConfig = Config{
 	Port: "4040",
 }
 
-func LoadConfig(file_path string) (*Config, error) {
-	content, e := os.ReadFile(file_path)
-	if e != nil {
-		return nil, e
-	}
+func LoadConfig(filePath string) (*Config, error) {
+	config := &Config{}
 
-	var config Config
+	if filePath == "" {
+		filePath = "./config.yaml"
+	}
 
-	e = yaml.Unmarshal(content, &config)
+	content, e := os.ReadFile(filePath)
 	if e != nil {
 		return nil, e
 	}
 
+	if err := yaml.Unmarshal(content, &config); err != nil {
+		return nil, err
+	}
+
 	if config.Port == "" {
 		config.Port = defaultConfig.Port
 	}
 
-	return &config, nil
+	if err := config.Validate(); err != nil {
+		return nil, err
+	}
+
+	return config, nil
+}
+
+func (c *Config) Validate() error {
+	var endpoints []string
+
+	// Validate notification if set - not required
+	if c.Notification != (Notification{}) {
+		if err := c.Notification.Validate(); err != nil {
+			return fmt.Errorf(".Notification: %s", err)
+		}
+	}
+
+	for i, source := range c.Sources {
+		// Ensure that the endpoint is unique
+		if slices.Contains(endpoints, source.EndPoint) {
+			return fmt.Errorf(".Source.%d: EndPoint is not unique", i)
+		}
+		endpoints = append(endpoints, source.EndPoint)
+
+		if err := source.Validate(); err != nil {
+			return fmt.Errorf(".Source.%d: %s", i, err)
+		}
+	}
+
+	return nil
+}
+
+type Notification struct {
+	Url     string `yaml:"url"`
+	Service string `yaml:"service"`
+}
+
+func (n *Notification) Validate() error {
+	if n.Url == "" {
+		return fmt.Errorf("url is missing")
+	}
+
+	if n.Service == "" {
+		return fmt.Errorf("service is missing")
+	}
+
+	n.Service = strings.ToUpper(n.Service)
+	switch NotificationService(n.Service) {
+	case NotifyDiscord:
+		break
+	default:
+		return fmt.Errorf("service is invalid")
+	}
+
+	return nil
+}
+
+type Source struct {
+	EndPoint  string       `yaml:"end_point"`
+	Heartbeat int          `yaml:"heartbeat"`
+	Name      string       `yaml:"xwr_name"`
+	Info      []SourceInfo `yaml:"info"`
+}
+
+func (c *Source) Validate() error {
+	if c.Heartbeat <= 0 {
+		return fmt.Errorf("heartbeat must be greater than 0")
+	}
+
+	for i, info := range c.Info {
+		if err := info.Validate(); err != nil {
+			return fmt.Errorf(".Info.%d: %s", i, err)
+		}
+	}
+
+	return nil
+}
+
+type SourceInfo struct {
+	Name      string     `yaml:"name"`
+	Url       string     `yaml:"url"`
+	Rules     []Rule     `yaml:"rules,omitempty"`
+	Modifiers []Modifier `yaml:"modifiers,omitempty"`
+}
+
+func (c *SourceInfo) Validate() error {
+	if c.Name == "" {
+		return fmt.Errorf("name is missing")
+	}
+
+	if c.Url == "" {
+		return fmt.Errorf("URL is missing")
+	}
+
+	u, err := url.Parse(c.Url)
+	if err != nil {
+		return fmt.Errorf("URL is invalid")
+	}
+
+	if u.Hostname() == "" {
+		return fmt.Errorf("URL is invalid (hostname)")
+	}
+
+	return nil
 }