chore: use interfaces for all other services

internal/app/configfile/manager.go

@@ -10,7 +10,6 @@ import (
 	"os"
 	"strings"
 
-	evbus "github.com/vardius/message-bus"
 	"github.com/yeqown/go-qrcode/v2"
 	"github.com/yeqown/go-qrcode/writer/compressed"
 
@@ -19,19 +18,56 @@ import (
 	"github.com/h44z/wg-portal/internal/domain"
 )
 
-type Manager struct {
-	cfg        *config.Config
-	bus        evbus.MessageBus
-	tplHandler *TemplateHandler
+// region dependencies
 
-	fsRepo FileSystemRepo
-	users  UserDatabaseRepo
-	wg     WireguardDatabaseRepo
+type UserDatabaseRepo interface {
+	// GetUser returns the user with the given identifier from the SQL database.
+	GetUser(ctx context.Context, id domain.UserIdentifier) (*domain.User, error)
 }
 
+type WireguardDatabaseRepo interface {
+	// GetInterfaceAndPeers returns the interface and all peers associated with it.
+	GetInterfaceAndPeers(ctx context.Context, id domain.InterfaceIdentifier) (*domain.Interface, []domain.Peer, error)
+	// GetPeer returns the peer with the given identifier.
+	GetPeer(ctx context.Context, id domain.PeerIdentifier) (*domain.Peer, error)
+	// GetInterface returns the interface with the given identifier.
+	GetInterface(ctx context.Context, id domain.InterfaceIdentifier) (*domain.Interface, error)
+}
+
+type FileSystemRepo interface {
+	// WriteFile writes the contents to the file at the given path.
+	WriteFile(path string, contents io.Reader) error
+}
+
+type TemplateRenderer interface {
+	// GetInterfaceConfig returns the configuration file for the given interface.
+	GetInterfaceConfig(iface *domain.Interface, peers []domain.Peer) (io.Reader, error)
+	// GetPeerConfig returns the configuration file for the given peer.
+	GetPeerConfig(peer *domain.Peer) (io.Reader, error)
+}
+
+type EventBus interface {
+	// Subscribe subscribes to the given topic.
+	Subscribe(topic string, fn any) error
+}
+
+// endregion dependencies
+
+// Manager is responsible for managing the configuration files of the WireGuard interfaces and peers.
+type Manager struct {
+	cfg *config.Config
+	bus EventBus
+
+	tplHandler TemplateRenderer
+	fsRepo     FileSystemRepo
+	users      UserDatabaseRepo
+	wg         WireguardDatabaseRepo
+}
+
+// NewConfigFileManager creates a new Manager instance.
 func NewConfigFileManager(
 	cfg *config.Config,
-	bus evbus.MessageBus,
+	bus EventBus,
 	users UserDatabaseRepo,
 	wg WireguardDatabaseRepo,
 	fsRepo FileSystemRepo,
@@ -115,6 +151,8 @@ func (m Manager) handlePeerInterfaceUpdatedEvent(id domain.InterfaceIdentifier)
 	}
 }
 
+// GetInterfaceConfig returns the configuration file for the given interface.
+// The file is structured in wg-quick format.
 func (m Manager) GetInterfaceConfig(ctx context.Context, id domain.InterfaceIdentifier) (io.Reader, error) {
 	if err := domain.ValidateAdminAccessRights(ctx); err != nil {
 		return nil, err
@@ -128,6 +166,8 @@ func (m Manager) GetInterfaceConfig(ctx context.Context, id domain.InterfaceIden
 	return m.tplHandler.GetInterfaceConfig(iface, peers)
 }
 
+// GetPeerConfig returns the configuration file for the given peer.
+// The file is structured in wg-quick format.
 func (m Manager) GetPeerConfig(ctx context.Context, id domain.PeerIdentifier) (io.Reader, error) {
 	peer, err := m.wg.GetPeer(ctx, id)
 	if err != nil {
@@ -141,6 +181,7 @@ func (m Manager) GetPeerConfig(ctx context.Context, id domain.PeerIdentifier) (i
 	return m.tplHandler.GetPeerConfig(peer)
 }
 
+// GetPeerConfigQrCode returns a QR code image containing the configuration for the given peer.
 func (m Manager) GetPeerConfigQrCode(ctx context.Context, id domain.PeerIdentifier) (io.Reader, error) {
 	peer, err := m.wg.GetPeer(ctx, id)
 	if err != nil {
@@ -191,6 +232,7 @@ func (m Manager) GetPeerConfigQrCode(ctx context.Context, id domain.PeerIdentifi
 	return buf, nil
 }
 
+// PersistInterfaceConfig writes the configuration file for the given interface to the file system.
 func (m Manager) PersistInterfaceConfig(ctx context.Context, id domain.InterfaceIdentifier) error {
 	iface, peers, err := m.wg.GetInterfaceAndPeers(ctx, id)
 	if err != nil {
@@ -213,4 +255,5 @@ type nopCloser struct {
 	io.Writer
 }
 
+// Close is a no-op for the nopCloser.
 func (nopCloser) Close() error { return nil }

internal/app/configfile/repos.go

@@ -1,22 +0,0 @@
-package configfile
-
-import (
-	"context"
-	"io"
-
-	"github.com/h44z/wg-portal/internal/domain"
-)
-
-type UserDatabaseRepo interface {
-	GetUser(ctx context.Context, id domain.UserIdentifier) (*domain.User, error)
-}
-
-type WireguardDatabaseRepo interface {
-	GetInterfaceAndPeers(ctx context.Context, id domain.InterfaceIdentifier) (*domain.Interface, []domain.Peer, error)
-	GetPeer(ctx context.Context, id domain.PeerIdentifier) (*domain.Peer, error)
-	GetInterface(ctx context.Context, id domain.InterfaceIdentifier) (*domain.Interface, error)
-}
-
-type FileSystemRepo interface {
-	WriteFile(path string, contents io.Reader) error
-}

internal/app/configfile/template.go

@@ -13,6 +13,8 @@ import (
 //go:embed tpl_files/*
 var TemplateFiles embed.FS
 
+// TemplateHandler is responsible for rendering the WireGuard configuration files
+// based on the provided templates.
 type TemplateHandler struct {
 	templates *template.Template
 }
@@ -34,6 +36,7 @@ func newTemplateHandler() (*TemplateHandler, error) {
 	return handler, nil
 }
 
+// GetInterfaceConfig returns the rendered configuration file for a WireGuard interface.
 func (c TemplateHandler) GetInterfaceConfig(cfg *domain.Interface, peers []domain.Peer) (io.Reader, error) {
 	var tplBuff bytes.Buffer
 
@@ -51,6 +54,7 @@ func (c TemplateHandler) GetInterfaceConfig(cfg *domain.Interface, peers []domai
 	return &tplBuff, nil
 }
 
+// GetPeerConfig returns the rendered configuration file for a WireGuard peer.
 func (c TemplateHandler) GetPeerConfig(peer *domain.Peer) (io.Reader, error) {
 	var tplBuff bytes.Buffer