feat: add BetterStack uptime provider - split provider package in subpackages

Author: rkettelerij

cmd/main.go

@@ -22,7 +22,8 @@ import (
 	"os"
 
 	"github.com/PDOK/uptime-operator/internal/service"
-	"github.com/PDOK/uptime-operator/internal/service/providers"
+	"github.com/PDOK/uptime-operator/internal/service/providers/betterstack"
+	"github.com/PDOK/uptime-operator/internal/service/providers/pingdom"
 	"github.com/PDOK/uptime-operator/internal/util"
 	"github.com/peterbourgon/ff"
 	"sigs.k8s.io/controller-runtime/pkg/cache"
@@ -144,13 +145,13 @@ func main() {
 			setupLog.Error(err, "Unable to parse 'pingdom-alert-integration-ids' flag")
 			os.Exit(1)
 		}
-		uptimeProviderSettings = providers.PingdomSettings{
+		uptimeProviderSettings = pingdom.Settings{
 			APIToken:       pingdomAPIToken,
 			UserIDs:        alertUserIDs,
 			IntegrationIDs: alertIntegrationIDs,
 		}
 	} else if uptimeProviderID == service.ProviderBetterStack {
-		uptimeProviderSettings = providers.BetterStackSettings{
+		uptimeProviderSettings = betterstack.Settings{
 			APIToken: betterstackAPIToken,
 		}
 	}

internal/service/providers/betterstack.go …ice/providers/betterstack/betterstack.gointernal/service/providers/betterstack.go renamed to internal/service/providers/betterstack/betterstack.go internal/service/providers/betterstack.go renamed to internal/service/providers/betterstack/betterstack.go

@@ -1,4 +1,4 @@
-package providers
+package betterstack
 
 import (
 	"context"
@@ -9,53 +9,54 @@ import (
 	"time"
 
 	"github.com/PDOK/uptime-operator/internal/model"
+	"github.com/PDOK/uptime-operator/internal/service/providers"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
 const betterStackBaseURL = "https://uptime.betterstack.com"
 
-type BetterStackSettings struct {
+type Settings struct {
 	APIToken string
 }
 
-type BetterStackUptimeProvider struct {
-	settings   BetterStackSettings
+type BetterStack struct {
+	settings   Settings
 	httpClient *http.Client
 }
 
-// NewBetterStackProvider creates a BetterStackUptimeProvider
-func NewBetterStackProvider(settings BetterStackSettings) *BetterStackUptimeProvider {
+// New creates a BetterStack
+func New(settings Settings) *BetterStack {
 	if settings.APIToken == "" {
 		classiclog.Fatal("Better Stack API token is not provided")
 	}
-	return &BetterStackUptimeProvider{
+	return &BetterStack{
 		settings:   settings,
 		httpClient: &http.Client{Timeout: time.Duration(5) * time.Minute},
 	}
 }
 
 // CreateOrUpdateCheck create the given check with Better Stack, or update an existing check. Needs to be idempotent!
-func (m *BetterStackUptimeProvider) CreateOrUpdateCheck(ctx context.Context, check model.UptimeCheck) (err error) {
+func (b *BetterStack) CreateOrUpdateCheck(_ context.Context, _ model.UptimeCheck) (err error) {
 	// TODO
 	return err
 }
 
 // DeleteCheck deletes the given check from Better Stack
-func (m *BetterStackUptimeProvider) DeleteCheck(ctx context.Context, check model.UptimeCheck) error {
+func (b *BetterStack) DeleteCheck(ctx context.Context, check model.UptimeCheck) error {
 	log.FromContext(ctx).Info("deleting check", "check", check)
 	// TODO
 	return nil
 }
 
-func (m *BetterStackUptimeProvider) findCheck(ctx context.Context, check model.UptimeCheck) (int64, error) {
-	result := checkNotFound
+func (b *BetterStack) findCheck(ctx context.Context, _ model.UptimeCheck) (int64, error) {
+	result := providers.CheckNotFound
 
-	req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("%s/api/v3/metadata", betterStackBaseURL), nil)
+	req, err := http.NewRequest(http.MethodGet, betterStackBaseURL+"/api/v3/metadata", nil)
 	if err != nil {
 		return result, err
 	}
-	req.Header.Add(headerAccept, "application/json")
-	resp, err := m.execRequest(req)
+	req.Header.Add(providers.HeaderAccept, "application/json")
+	resp, err := b.execRequest(req)
 	if err != nil {
 		return result, err
 	}
@@ -73,12 +74,12 @@ func (m *BetterStackUptimeProvider) findCheck(ctx context.Context, check model.U
 	metadata := metadataResponse["data"].([]any)
 	for _, metadataEntry := range metadata {
 		// TODO find pointer to monitor
-		println(metadataEntry)
+		log.FromContext(ctx).Info("test", "metadataEntry", metadataEntry)
 	}
 	return result, nil
 }
 
-func (m *BetterStackUptimeProvider) execRequest(req *http.Request) (*http.Response, error) {
-	req.Header.Add(headerAuthorization, "Bearer "+m.settings.APIToken)
-	return m.httpClient.Do(req)
+func (b *BetterStack) execRequest(req *http.Request) (*http.Response, error) {
+	req.Header.Add(providers.HeaderAuthorization, "Bearer "+b.settings.APIToken)
+	return b.httpClient.Do(req)
 }

…al/service/providers/betterstack_test.go …roviders/betterstack/betterstack_test.gointernal/service/providers/betterstack_test.go renamed to internal/service/providers/betterstack/betterstack_test.go internal/service/providers/betterstack_test.go renamed to internal/service/providers/betterstack/betterstack_test.go

@@ -1,4 +1,4 @@
-package providers
+package betterstack
 
 import (
 	"context"
@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/PDOK/uptime-operator/internal/model"
+	"github.com/PDOK/uptime-operator/internal/service/providers"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -75,10 +76,10 @@ func TestAgainstREALBetterStackAPI(t *testing.T) {
 				"integration test against the REAL Better Stack API.")
 		}
 		t.Run(tt.name, func(t *testing.T) {
-			settings := BetterStackSettings{APIToken: os.Getenv("BETTERSTACK_API_TOKEN")}
+			settings := Settings{APIToken: os.Getenv("BETTERSTACK_API_TOKEN")}
 
 			// create/update/delete actual check with REAL Better Stack API.
-			m := NewBetterStackProvider(settings)
+			m := New(settings)
 			check, err := model.NewUptimeCheck("foo", tt.annotations)
 			assert.NoError(t, err)
 			if tt.wantDelete {
@@ -90,7 +91,7 @@ func TestAgainstREALBetterStackAPI(t *testing.T) {
 
 				existingCheckID, err := m.findCheck(context.TODO(), *check)
 				assert.NoError(t, err)
-				assert.Equal(t, checkNotFound, existingCheckID)
+				assert.Equal(t, providers.CheckNotFound, existingCheckID)
 			} else {
 				if err := m.CreateOrUpdateCheck(context.TODO(), *check); (err != nil) != tt.wantErr {
 					t.Errorf("CreateOrUpdateCheck() error = %v, wantErr %v", err, tt.wantErr)

internal/service/providers/betterstack/types.go

@@ -0,0 +1,13 @@
+package betterstack
+
+type MetadataListRequest struct {
+}
+
+type MetadataListResponse struct {
+}
+
+type MetadataUpdateRequest struct {
+}
+
+type MetadataUpdateResponse struct {
+}

internal/service/providers/const.go

@@ -0,0 +1,9 @@
+package providers
+
+const (
+	CheckNotFound = int64(-1)
+
+	HeaderAuthorization = "Authorization"
+	HeaderAccept        = "Accept"
+	HeaderContentType   = "Content-Type"
+)

internal/service/providers/mock.go internal/service/providers/mock/mock.gointernal/service/providers/mock.go renamed to internal/service/providers/mock/mock.go

@@ -1,4 +1,4 @@
-package providers
+package mock
 
 import (
 	"context"
@@ -9,17 +9,17 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 )
 
-type MockUptimeProvider struct {
+type Mock struct {
 	checks map[string]model.UptimeCheck
 }
 
-func NewMockUptimeProvider() *MockUptimeProvider {
-	return &MockUptimeProvider{
+func New() *Mock {
+	return &Mock{
 		checks: make(map[string]model.UptimeCheck),
 	}
 }
 
-func (m *MockUptimeProvider) CreateOrUpdateCheck(ctx context.Context, check model.UptimeCheck) error {
+func (m *Mock) CreateOrUpdateCheck(ctx context.Context, check model.UptimeCheck) error {
 	m.checks[check.ID] = check
 
 	checkJSON, _ := json.Marshal(check)
@@ -28,7 +28,7 @@ func (m *MockUptimeProvider) CreateOrUpdateCheck(ctx context.Context, check mode
 	return nil
 }
 
-func (m *MockUptimeProvider) DeleteCheck(ctx context.Context, check model.UptimeCheck) error {
+func (m *Mock) DeleteCheck(ctx context.Context, check model.UptimeCheck) error {
 	delete(m.checks, check.ID)
 
 	checkJSON, _ := json.Marshal(check)