feat: codeql

Reviewed-on: #23
Co-authored-by: Timo Behrendt <t.behrendt@t00n.de>
Co-committed-by: Timo Behrendt <t.behrendt@t00n.de>

.gitea/workflows/ci.yaml

@@ -40,3 +40,5 @@ jobs:
         run: make build
       - name: test
         run: make test
+      - name: check:format
+        run: make check-format

.gitea/workflows/codeql.yaml

@@ -0,0 +1,23 @@
+name: CodeQL Analysis
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  codeql-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: "go"
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

Dockerfile

@@ -1,21 +1,13 @@
-FROM golang:1.21-alpine
+FROM golang:1.23-alpine
 
-# Set the Current Working Directory inside the container
 WORKDIR /app
 
-# Copy go mod and sum files
 COPY go.mod go.sum ./
 
-# Download all dependencies. Dependencies will be cached if the go.mod and go.sum files are not changed
 RUN go mod download
 
-# Copy the source from the current directory to the Working Directory inside the container
 COPY . .
 
-# Build the Go app
 RUN go build -o main .
 
-
-# Command to run the executable
-
 CMD ["./main"]

Makefile

@@ -6,3 +6,18 @@ build:
 
 lint:
 	golint ./...
+
+run:
+	make build
+	./realdyndns
+
+format:
+	gofmt -w .
+
+check-format:
+	@OUTPUT=$$(gofmt -l .); \
+	if [ -n "$$OUTPUT" ]; then \
+		echo "Formatter failed for:"; \
+		echo "$$OUTPUT"; \
+		exit 1; \
+	fi

README.md

@@ -1,10 +1,12 @@
 # realDynDNS
+
 RealDynDNS aims to be a replacement to "classical" dynDNS solutions that offer a subdomain. Instead realDynDns actually changes your DNS entries.
 
 This service requires your DNS provider to expose an API that allows your DNS entries to be changed.
 A service that provides your current external IP is also required.
 
 ## Configuration
+
 The configuration is done via a YAML file called `config.yaml`. The following example shows the configuration for a domain with two subdomains.
 
 Configuration of the IP provider and the DNS provider is mandatory.
@@ -35,40 +37,52 @@ domains:
       - "@"
       - www
 check_interval: 0 0 0/6 * * * *
+mode: Scheduled
+log_level: info
 ```
 
 The config file is expected to be in the same directory as the binary and called `config.yaml`. For the OCR image, the root directory is `/app`.
 
 ## DNS Providers
+
 The DNS provider abstracts the API of your DNS provider. Currently the following providers are supported:
 
 ### IONOS
+
 IONOS requires two configuration parameters. You can get your API key [here](https://developer.hosting.ionos.com/docs/getstarted).
+
 ```yaml
 api_key: <your-api-key>
 base_url: https://api.hosting.ionos.com/dns
 ```
 
 ## External IP Providers
+
 The external IP provider is used to get your current external IP. Currently the following providers are supported:
 
 ### Plain
+
 Any provider that returns your IP as plain text can be used. The following configuration is required:
+
 ```yaml
 url: <your-providers-URL>
 ```
 
 Examples for providers are:
+
 - https://ifconfig.me
 - https://api.ipify.org
 
 ## Notification Providers
+
 The notification provider is used to send notifications whena IP address changes and a DNS record is updated.
 
 ### Console
+
 The console notification provider is used to print the notification to the console. This is the default notification provider.
 
 ### Gotify
+
 The Gotify notification provider is used to send notifications to a Gotify server.
 
 ```yaml
@@ -78,3 +92,19 @@ priority: 0
 ```
 
 The priority must be between 0 and 4.
+
+## Mode Selection
+
+Two modes are available:
+
+### RunOnce
+
+The RunOnce mode is used to run the application once and exit. This is useful when providing your own external scheduler, like cron.
+
+Set the `mode` to `RunOnce`.
+
+### Scheduled
+
+The Scheduled mode is used to run the application in a scheduled interval.
+
+Set the `mode` to `Scheduled` and provide a cron expression for the `check_interval`.

config.example.yaml

@@ -21,3 +21,4 @@ domains:
       - www
 check_interval: 0 0 0/6 * * * *
 mode: Scheduled
+log_level: info

go.mod

@@ -1,6 +1,6 @@
 module realdnydns
 
-go 1.20
+go 1.23
 
 require (
 	github.com/go-co-op/gocron v1.37.0

main.go

@@ -2,6 +2,9 @@ package main
 
 import (
 	"fmt"
+	"log/slog"
+	"os"
+	"strings"
 
 	"realdnydns/pkg/config"
 	"realdnydns/pkg/dnsProvider"
@@ -15,48 +18,84 @@ import (
 )
 
 func main() {
+	logger := slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
+		Level: slog.LevelInfo,
+	}))
+
 	configClient := config.Config{}
 	err := configClient.Load("config.yaml")
 	if err != nil {
+		logger.Error("Failed to load config file", slog.String("error", err.Error()))
 		panic(err)
 	}
 
+	if configClient.LogLevel != "" {
+		logger = slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
+			Level: slog.Level(config.LogLevelMap[strings.ToLower(configClient.LogLevel)]),
+		}))
+	}
+
 	var externalIpProvider externalIpProvider.ExternalIpProvider
 	switch configClient.ExternalIPProvider.Type {
 	case "plain":
+		logger.Info("Using plain external IP provider", slog.String("external_ip_provider", "plain"))
+
 		var plainConfig plainExternalIpProvider.PlainExternalIpProviderConfig
 		err := configClient.ExternalIPProvider.ProviderConfig.Decode(&plainConfig)
 		if err != nil {
+			logger.Error("Failed to create config",
+				slog.String("external_ip_provider", "plain"),
+				slog.String("error", err.Error()),
+			)
 			panic(err)
 		}
 
 		externalIpProvider, err = plainExternalIpProvider.New(plainConfig)
 		if err != nil {
+			logger.Error("Failed to create plain external IP provider",
+				slog.String("external_ip_provider", "plain"),
+				slog.String("error", err.Error()),
+			)
 			panic(err)
 		}
 	default:
+		logger.Error("Unknown external IP provider", slog.String("external_ip_provider", configClient.ExternalIPProvider.Type))
 		panic(fmt.Errorf("unknown external IP provider: %s", configClient.ExternalIPProvider.Type))
 	}
 
 	var dnsProvider dnsProvider.DNSProvider
 	switch configClient.DNSProvider.Type {
 	case "ionos":
+		logger.Info("Using IONOS DNS provider", slog.String("dns_provider", "ionos"))
+
 		var ionosConfig ionos.IONOSConfig
 		err := configClient.DNSProvider.ProviderConfig.Decode(&ionosConfig)
 		if err != nil {
+			logger.Error("Failed to create IONOS DNS provider",
+				slog.String("dns_provider", "ionos"),
+				slog.String("error", err.Error()),
+			)
 			panic(err)
 		}
+
 		dnsProvider, err = ionos.NewIonos(&ionosConfig)
 		if err != nil {
+			logger.Error("Failed to create IONOS DNS provider",
+				slog.String("dns_provider", "ionos"),
+				slog.String("error", err.Error()),
+			)
 			panic(err)
 		}
 	default:
+		logger.Error("Unknown DNS provider", slog.String("dns_provider", configClient.DNSProvider.Type))
 		panic(fmt.Errorf("unknown DNS provider: %s", configClient.DNSProvider.Type))
 	}
 
 	var notificationProvider notificationProvider.NotificationProvider
 	switch configClient.NotificationProvider.Type {
 	case "gotify":
+		logger.Info("Using Gotify notification provider", slog.String("notification_provider", "gotify"))
+
 		var gotifyConfig gotify.NotificationProviderImplGotifyConfig
 		err := configClient.NotificationProvider.ProviderConfig.Decode(&gotifyConfig)
 		if err != nil {
@@ -65,29 +104,39 @@ func main() {
 
 		notificationProvider, err = gotify.New(gotifyConfig)
 		if err != nil {
+			logger.Error("Failed to create Gotify notification provider",
+				slog.String("notification_provider", "gotify"),
+				slog.String("error", err.Error()),
+			)
 			panic(err)
 		}
 	default:
+		logger.Info("Using console notification provider", slog.String("notification_provider", "console"))
+
 		notificationProvider = notificationProviderConsole.New()
 	}
 
-	rdd := realDynDns.New(externalIpProvider, dnsProvider, notificationProvider, configClient.Domains)
+	rdd := realDynDns.New(externalIpProvider, dnsProvider, notificationProvider, configClient.Domains, logger.With(slog.String("service", "realDynDns")))
 
 	switch configClient.Mode {
 	case config.ScheduledMode:
+		logger.Info("Running in scheduled mode", slog.String("interval", configClient.CheckInterval))
+
 		schedule, job, err := rdd.RunWithSchedule(configClient.CheckInterval)
 		if err != nil {
+			logger.Error("Failed to create scheduler", slog.String("error", err.Error()))
 			panic(err)
 		}
 
-			fmt.Println("Starting scheduler")
+		logger.Info("Next run:", slog.String("time", job.NextRun().String()))
-			fmt.Println("Next run:", job.NextRun())
 		schedule.StartBlocking()
 	case config.RunOnceMode:
-			numberOfChanges, err := rdd.RunOnce()
+		logger.Info("Running in run once mode")
+
+		_, err := rdd.RunOnce()
 		if err != nil {
+			logger.Error("Failed to run once", slog.String("error", err.Error()))
 			panic(err)
 		}
-			fmt.Println("Number of changes:", numberOfChanges)
 	}
 }

pkg/config/config.go

@@ -3,7 +3,9 @@ package config
 import (
 	"errors"
 	"fmt"
+	"log/slog"
 	"os"
+	"strings"
 
 	"gopkg.in/yaml.v3"
 )
@@ -15,6 +17,7 @@ type Config struct {
 	NotificationProvider NotificationProviderConfig `yaml:"notification_provider,omitempty"`
 	Domains              []DomainConfig             `yaml:"domains"`
 	CheckInterval        string                     `yaml:"check_interval"`
+	LogLevel             string                     `yaml:"log_level"`
 }
 
 const (
@@ -22,6 +25,18 @@ const (
 	ScheduledMode = "Scheduled"
 )
 
+var LogLevelMap = map[string]slog.Level{
+	"debug": slog.LevelDebug,
+	"info":  slog.LevelInfo,
+	"warn":  slog.LevelWarn,
+	"error": slog.LevelError,
+}
+
+func isValidLogLevel(level string) bool {
+	_, ok := LogLevelMap[strings.ToLower(level)]
+	return ok
+}
+
 type DomainConfig struct {
 	TLD        string   `yaml:"tld"`
 	Subdomains []string `yaml:"subdomains"`
@@ -56,7 +71,7 @@ func (c *Config) Load(filePath string) error {
 		return fmt.Errorf("failed to validate config: %w", err)
 	}
 
-	return nil;
+	return nil
 }
 
 func (c *Config) validate() error {
@@ -68,5 +83,9 @@ func (c *Config) validate() error {
 		return errors.New("check interval must be set when mode is 'Scheduled'")
 	}
 
-	return nil;
+	if c.LogLevel != "" && !isValidLogLevel(c.LogLevel) {
+		return fmt.Errorf("log level must be one of 'debug', 'info', 'warn', 'error', but got %s", c.LogLevel)
+	}
+
+	return nil
 }

pkg/dnsProvider/ionos/api/ionosAPI.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"net"
 	"net/http"
+	"net/url"
 	"realdnydns/model/common"
 )
 
@@ -18,7 +19,7 @@ type IonosAPI interface {
 	SetARecord(tld string, subdomain string, ip net.IP, ttl int, prio int, disabled bool) (*common.ARecord, error)
 	GetZoneId(tld string) (string, error)
 	GetRecordId(zoneId string, tld string, subdomain string, recordType string) (string, error)
-	HttpCall(method string, url string, body io.Reader) (*http.Response, error)
+	HttpCall(method string, url string, body io.Reader, queryParams map[string]string) (*http.Response, error)
 }
 
 type IonosAPIImpl struct {
@@ -76,8 +77,16 @@ func New(APIKey string, BaseURL string) IonosAPI {
 	}
 }
 
-func (i *IonosAPIImpl) HttpCall(method string, url string, body io.Reader) (*http.Response, error) {
+func (i *IonosAPIImpl) HttpCall(method string, path string, body io.Reader, queryParams map[string]string) (*http.Response, error) {
-	req, err := http.NewRequest(method, i.BaseURL+url, body)
+	requestUrl, _ := url.Parse(i.BaseURL + path)
+
+	query := requestUrl.Query()
+	for key, value := range queryParams {
+		query.Add(key, value)
+	}
+	requestUrl.RawQuery = query.Encode()
+
+	req, err := http.NewRequest(method, requestUrl.String(), body)
 	if err != nil {
 		return nil, err
 	}
@@ -90,7 +99,7 @@ func (i *IonosAPIImpl) HttpCall(method string, url string, body io.Reader) (*htt
 }
 
 func (i *IonosAPIImpl) GetZoneId(tld string) (string, error) {
-	res, err := i.HttpCall("GET", "/v1/zones", nil)
+	res, err := i.HttpCall("GET", "/v1/zones", nil, nil)
 	if err != nil {
 		return "", err
 	}
@@ -111,7 +120,14 @@ func (i *IonosAPIImpl) GetZoneId(tld string) (string, error) {
 }
 
 func (i *IonosAPIImpl) GetRecordId(zoneId string, tld string, subdomain string, recordType string) (string, error) {
-	res, err := i.HttpCall("GET", "/v1/zones/"+zoneId, nil)
+	var domain string
+	if subdomain == "@" || subdomain == "" {
+		domain = tld
+	} else {
+		domain = subdomain + "." + tld
+	}
+
+	res, err := i.HttpCall("GET", "/v1/zones/"+zoneId, nil, map[string]string{"recordName": domain, "recordType": recordType})
 	if err != nil {
 		return "", err
 	}
@@ -122,13 +138,6 @@ func (i *IonosAPIImpl) GetRecordId(zoneId string, tld string, subdomain string,
 	zone := ZoneResponse{}
 	json.Unmarshal(responseBody, &zone)
 
-	var domain string
-	if subdomain == "@" || subdomain == "" { 
-		domain = tld
-	} else {
-		domain = subdomain + "." + tld
-	}
-
 	for _, record := range zone.Records {
 		if record.Type == recordType && record.Name == domain {
 			return record.Id, nil
@@ -159,7 +168,7 @@ func (i *IonosAPIImpl) SetARecord(tld string, subdomain string, ip net.IP, ttl i
 		return nil, err
 	}
 
-	res, err := i.HttpCall("PUT", "/v1/zones/"+zoneId+"/records/"+recordId, bytes.NewReader(changeRecordRequest))
+	res, err := i.HttpCall("PUT", "/v1/zones/"+zoneId+"/records/"+recordId, bytes.NewReader(changeRecordRequest), nil)
 	if err != nil {
 		return nil, err
 	}
@@ -171,8 +180,6 @@ func (i *IonosAPIImpl) SetARecord(tld string, subdomain string, ip net.IP, ttl i
 		return nil, errors.New("error updating record")
 	}
 
-	
-
 	changeRecord := ChangeRecord{}
 	json.Unmarshal(responseBody, &changeRecord)
 
@@ -196,7 +203,7 @@ func (ionos *IonosAPIImpl) GetARecord(tld string, subdomain string) (*common.ARe
 		return nil, err
 	}
 
-	res, err := ionos.HttpCall("GET", "/v1/zones/"+zoneId+"/records/"+recordId, nil)
+	res, err := ionos.HttpCall("GET", "/v1/zones/"+zoneId+"/records/"+recordId, nil, nil)
 	if err != nil {
 		return nil, err
 	}

pkg/dnsProvider/ionos/api/ionosAPI_test.go

@@ -76,7 +76,8 @@ func utilMockServerImpl() func(w http.ResponseWriter, r *http.Request) {
 		if r.Method == "GET" {
 			if r.RequestURI == "/v1/zones" {
 				response = zonesResponseJson
-			} else if r.RequestURI == "/v1/zones/1234567890" {
+			} else if r.RequestURI == "/v1/zones/1234567890?recordName=example.com&recordType=A" ||
+				r.RequestURI == "/v1/zones/1234567890?recordName=sub.example.com&recordType=A" {
 				response = zoneResponseJson
 			} else if r.RequestURI == "/v1/zones/1234567890/records/abcdefghij" {
 				response = recordResponseSubJson
@@ -106,7 +107,7 @@ func TestHttpCall(t *testing.T) {
 
 func testHttpCallGet(api IonosAPI) func(t *testing.T) {
 	return func(t *testing.T) {
-		res, err := api.HttpCall("GET", "/v1/zones", nil)
+		res, err := api.HttpCall("GET", "/v1/zones", nil, nil)
 
 		if err != nil {
 			t.Fatalf("HttpCall() returned unexpected error: %v", err)
@@ -120,7 +121,7 @@ func testHttpCallGet(api IonosAPI) func(t *testing.T) {
 
 func testHttpCallPut(api IonosAPI) func(t *testing.T) {
 	return func(t *testing.T) {
-		res, err := api.HttpCall("PUT", "/v1/zones/1234567890/records/abcdefghij", nil)
+		res, err := api.HttpCall("PUT", "/v1/zones/1234567890/records/abcdefghij", nil, nil)
 
 		if err != nil {
 			t.Fatalf("HttpCall() returned unexpected error: %v", err)
@@ -141,7 +142,7 @@ func testHttpCallNonExistingEndpoint() func(t *testing.T) {
 
 		api := New("dummyKey", mockServer.URL)
 
-		res, err := api.HttpCall("GET", "/v1/nonExistingEndpoint", nil)
+		res, err := api.HttpCall("GET", "/v1/nonExistingEndpoint", nil, nil)
 
 		if err != nil {
 			t.Fatalf("HttpCall() returned unexpected error: %v", err)

pkg/dnsProvider/ionos/ionos_test.go

@@ -82,7 +82,7 @@ func (m *MockIonosAPI) GetZoneId(tld string) (string, error) {
 	return m.GetZoneIdFunc(tld)
 }
 
-func (m *MockIonosAPI) HttpCall(method string, url string, body io.Reader) (*http.Response, error) {
+func (m *MockIonosAPI) HttpCall(method string, url string, body io.Reader, queryParams map[string]string) (*http.Response, error) {
 	return m.HttpCallFunc(method, url, body)
 }
 

pkg/realDynDns/realDynDns.go

@@ -2,6 +2,8 @@ package realDynDns
 
 import (
 	"fmt"
+	"log/slog"
+	"sync"
 	"time"
 
 	"realdnydns/pkg/config"
@@ -17,6 +19,7 @@ type ChangeDetector struct {
 	dnsProvider          dnsProvider.DNSProvider
 	notificationProvider notificationProvider.NotificationProvider
 	domains              []config.DomainConfig
+	logger               *slog.Logger
 }
 
 func New(
@@ -24,12 +27,14 @@ func New(
 	dnsProvider dnsProvider.DNSProvider,
 	notificationProvider notificationProvider.NotificationProvider,
 	domains []config.DomainConfig,
+	logger *slog.Logger,
 ) ChangeDetector {
 	return ChangeDetector{
 		externalIpProvider:   externalIpProvider,
 		dnsProvider:          dnsProvider,
 		notificationProvider: notificationProvider,
 		domains:              domains,
+		logger:               logger,
 	}
 }
 
@@ -58,37 +63,90 @@ func (c *ChangeDetector) RunOnce() (int, error) {
 }
 
 func (c *ChangeDetector) detectAndApplyChanges() (int, error) {
+	c.logger.Info("Detecting and applying changes")
+
 	externalIp, err := c.externalIpProvider.GetExternalIp()
 	if err != nil {
+		c.logger.Error("Failed to retrieve external IP", slog.String("error", err.Error()))
 		return 0, err
 	}
 
-	var numberUpdated int
+	var wg sync.WaitGroup
+
+	numberUpdatedChannel := make(chan int)
 
 	for _, domain := range c.domains {
 		for _, subdomain := range domain.Subdomains {
+			wg.Add(1)
+
+			go func(domain config.DomainConfig, subdomain string) {
+				defer wg.Done()
+
+				c.logger.Info("Checking record",
+					slog.String("tld", domain.TLD),
+					slog.String("subdomain", subdomain),
+				)
 				currentRecord, err := c.dnsProvider.GetRecord(domain.TLD, subdomain)
 				if err != nil {
-				return numberUpdated, err
+					c.logger.Error("Failed to retrieve record",
+						slog.String("error", err.Error()),
+						slog.String("tld", domain.TLD),
+						slog.String("subdomain", subdomain),
+					)
+					return
 				}
 
 				if currentRecord.IP != externalIp.String() {
+					c.logger.Info("Record has changed",
+						slog.String("tld", domain.TLD),
+						slog.String("subdomain", subdomain),
+						slog.String("current_ip", currentRecord.IP),
+						slog.String("external_ip", externalIp.String()),
+					)
+
 					err = c.notificationProvider.SendNotification(
 						fmt.Sprintf("Update %s.%s", subdomain, domain.TLD),
 						fmt.Sprintf("The IP of %s has changed from %s to %s", domain.TLD, currentRecord.IP, externalIp.String()),
 					)
 					if err != nil {
-					return numberUpdated, err
+						c.logger.Warn("Failed to send notification",
+							slog.String("error", err.Error()),
+						)
+						return
 					}
 
+					c.logger.Info("Updating record",
+						slog.String("tld", domain.TLD),
+						slog.String("subdomain", subdomain),
+						slog.String("current_ip", currentRecord.IP),
+						slog.String("external_ip", externalIp.String()),
+					)
 					_, err = c.dnsProvider.UpdateRecord(domain.TLD, subdomain, externalIp, currentRecord.TTL, currentRecord.Prio, currentRecord.Disabled)
-				numberUpdated++
 					if err != nil {
-					return numberUpdated, err
+						c.logger.Error("Failed to update record",
+							slog.String("error", err.Error()),
+							slog.String("tld", domain.TLD),
+							slog.String("subdomain", subdomain),
+						)
+						return
 					}
+
+					numberUpdatedChannel <- 1
 				}
+			}(domain, subdomain)
 		}
 	}
 
+	go func() {
+		wg.Wait()
+		close(numberUpdatedChannel)
+	}()
+
+	numberUpdated := 0
+	for v := range numberUpdatedChannel {
+		numberUpdated += v
+	}
+
+	c.logger.Info("Run completed", slog.Int("number_of_changes", numberUpdated))
 	return numberUpdated, nil
 }

pkg/realDynDns/realDynDns_test.go

@@ -1,6 +1,7 @@
 package realDynDns
 
 import (
+	"log/slog"
 	"net"
 	"realdnydns/model/common"
 	"realdnydns/pkg/config"
@@ -72,7 +73,9 @@ func testDetectAndApplyChangesWithChanges() func(t *testing.T) {
 						"@",
 					},
 				},
-			})
+			},
+			slog.Default(),
+		)
 
 		numberUpdated, err := changeDetector.RunOnce()
 		if err != nil {
@@ -101,7 +104,9 @@ func testDetectAndApplyChangesWithoutChanges() func(t *testing.T) {
 						"@",
 					},
 				},
-			})
+			},
+			slog.Default(),
+		)
 
 		numberUpdated, err := changeDetector.RunOnce()
 		if err != nil {