refactor: move service factory

Author: davidramiro

.mockery.yaml

@@ -1,6 +1,12 @@
 with-expecter: True
+outpkg: "mock_{{.PackageName}}"
 packages:
   github.com/davidramiro/frigabun/services:
+    interfaces:
+      DnsUpdateService:
+      HTTPClient:
+  github.com/davidramiro/frigabun/services/factory:
     interfaces:
       ServiceFactory:
-      DnsUpdateService:
+    config:
+      all: True

.testcoverage.yml

@@ -3,8 +3,9 @@ profile: cover.out
 threshold:
   file: 70
   package: 80
-  total: 95
+  total: 90
 
 exclude:
   paths:
+    - main.go
     - mocks

internal/api/api.go

@@ -3,6 +3,7 @@ package api
 import (
 	"fmt"
 	"github.com/davidramiro/frigabun/services"
+	"github.com/davidramiro/frigabun/services/factory"
 	"github.com/rs/zerolog/log"
 	"net/http"
 	"strings"
@@ -12,7 +13,7 @@ import (
 )
 
 type UpdateApi struct {
-	dnsServiceFactory services.ServiceFactory
+	dnsServiceFactory factory.ServiceFactory
 }
 
 type StatusResponse struct {
@@ -27,7 +28,7 @@ type UpdateRequest struct {
 	Registrar  string `query:"registrar"`
 }
 
-func NewUpdateApi(dnsServiceFactory services.ServiceFactory) *UpdateApi {
+func NewUpdateApi(dnsServiceFactory factory.ServiceFactory) *UpdateApi {
 	return &UpdateApi{dnsServiceFactory: dnsServiceFactory}
 }
 

main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"fmt"
 	"github.com/davidramiro/frigabun/internal/api"
-	"github.com/davidramiro/frigabun/services"
+	"github.com/davidramiro/frigabun/services/factory"
 	"github.com/labstack/echo/v4"
 	"github.com/labstack/echo/v4/middleware"
 	"github.com/rs/zerolog/log"
@@ -15,6 +15,7 @@ func main() {
 
 	log.Info().Msg("starting frigabun")
 	log.Info().Msg("reading config")
+
 	viper.SetConfigName("config")
 	viper.SetConfigType("toml")
 	viper.AddConfigPath(".")
@@ -48,7 +49,7 @@ func main() {
 	}))
 	e.Use(middleware.Recover())
 
-	factory, err := services.NewDnsUpdateServiceFactory()
+	factory, err := factory.NewDnsUpdateServiceFactory()
 	if err != nil {
 		log.Fatal().Err(err).Msg("cannot init service factory")
 	}

services/dns_update_service_factory.go

@@ -0,0 +1,83 @@
+package factory
+
+import (
+	"github.com/davidramiro/frigabun/services"
+	"github.com/spf13/viper"
+)
+
+type ServiceFactory interface {
+	Register(services.DnsUpdateService)
+	Find(services.Registrar) (services.DnsUpdateService, error)
+	ListServices() []services.Registrar
+}
+
+type DnsUpdateServiceFactory struct {
+	services map[services.Registrar]services.DnsUpdateService
+}
+
+func NewDnsUpdateServiceFactory() (*DnsUpdateServiceFactory, error) {
+	factory := &DnsUpdateServiceFactory{
+		services: make(map[services.Registrar]services.DnsUpdateService),
+	}
+
+	if viper.GetBool("cloudflare.enabled") {
+		cloudflareService, err := services.NewCloudflareDnsUpdateService(nil)
+		if err != nil {
+			return nil, err
+		}
+
+		factory.Register(cloudflareService)
+	}
+
+	if viper.GetBool("gandi.enabled") {
+		gandiService, err := services.NewGandiDnsUpdateService(nil)
+		if err != nil {
+			return nil, err
+		}
+
+		factory.Register(gandiService)
+	}
+
+	if viper.GetBool("porkbun.enabled") {
+		porkbunService, err := services.NewPorkbunDnsUpdateService(nil)
+		if err != nil {
+			return nil, err
+		}
+
+		factory.Register(porkbunService)
+	}
+
+	return factory, nil
+}
+
+func (df *DnsUpdateServiceFactory) Register(service services.DnsUpdateService) {
+	if service == nil {
+		return
+	}
+
+	key := service.Registrar()
+
+	df.services[key] = service
+}
+
+func (df *DnsUpdateServiceFactory) Find(registrar services.Registrar) (service services.DnsUpdateService, err error) {
+
+	service, ok := df.services[registrar]
+	if !ok {
+		return nil, services.ErrRegistrarNotFound
+	}
+
+	return service, nil
+}
+
+func (df *DnsUpdateServiceFactory) ListServices() []services.Registrar {
+	keys := make([]services.Registrar, len(df.services))
+
+	i := 0
+	for k := range df.services {
+		keys[i] = k
+		i++
+	}
+
+	return keys
+}

services/factory/dns_update_service_factory.go

@@ -1,11 +1,14 @@
-package services
+package factory
 
 import (
+	"github.com/davidramiro/frigabun/services"
 	"github.com/spf13/viper"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )
 
+var factory *DnsUpdateServiceFactory
+
 func init() {
 	viper.Set("cloudflare.enabled", true)
 	viper.Set("cloudflare.baseurl", "https://api.foo.com/client/v4")
@@ -21,11 +24,12 @@ func init() {
 	viper.Set("porkbun.apiKey", "foo")
 	viper.Set("porkbun.apiSecretKey", "bar")
 	viper.Set("porkbun.ttl", 42)
+
+	factory, _ = NewDnsUpdateServiceFactory()
 }
 
 func TestNewDnsUpdateServiceFactory(t *testing.T) {
-	factory, err := NewDnsUpdateServiceFactory()
-	assert.Nil(t, err, "no error on creating factory")
+
 	assert.Equal(t, 3, len(factory.ListServices()), "factory should contain 3 services")
 
 	service, err := factory.Find("cloudflare")
@@ -36,13 +40,10 @@ func TestNewDnsUpdateServiceFactory(t *testing.T) {
 }
 
 func TestDnsUpdateServiceFactory_ListServices(t *testing.T) {
-	factory, err := NewDnsUpdateServiceFactory()
-	assert.Nil(t, err, "no error on creating factory")
 	assert.Equal(t, 3, len(factory.ListServices()), "factory should contain 3 services")
 }
 
 func TestDnsUpdateServiceFactory_FindSuccess(t *testing.T) {
-	factory, _ := NewDnsUpdateServiceFactory()
 	service, err := factory.Find("cloudflare")
 
 	assert.Nil(t, err)
@@ -52,8 +53,27 @@ func TestDnsUpdateServiceFactory_FindSuccess(t *testing.T) {
 }
 
 func TestDnsUpdateServiceFactory_FindInvalidName(t *testing.T) {
-	factory, _ := NewDnsUpdateServiceFactory()
 	_, err := factory.Find("cloudbun")
+	assert.ErrorIs(t, err, services.ErrRegistrarNotFound)
+}
+
+func TestNewDnsUpdateServiceFactory_MissingParamForPorkbun(t *testing.T) {
+	viper.Set("porkbun.baseUrl", "")
+	f, err := NewDnsUpdateServiceFactory()
+	assert.ErrorIs(t, err, services.ErrMissingInfoForServiceInit)
+	assert.Nil(t, f)
+}
+
+func TestNewDnsUpdateServiceFactory_MissingParamForCloudflare(t *testing.T) {
+	viper.Set("cloudflare.apiKey", "")
+	f, err := NewDnsUpdateServiceFactory()
+	assert.ErrorIs(t, err, services.ErrMissingInfoForServiceInit)
+	assert.Nil(t, f)
+}
 
-	assert.Error(t, err)
+func TestNewDnsUpdateServiceFactory_MissingParamForGandi(t *testing.T) {
+	viper.Set("gandi.ttl", 0)
+	f, err := NewDnsUpdateServiceFactory()
+	assert.ErrorIs(t, err, services.ErrMissingInfoForServiceInit)
+	assert.Nil(t, f)
 }