refactor: move keycloak logic to separate package (#19)

* refactor: attempt to factor out keycloak client creation

* build(Dockerfile): include all of internal in builder

* fix: read-unlock the read-lock

Author: nicolst

Dockerfile

@@ -14,7 +14,7 @@ RUN go mod download
 # Copy the go source
 COPY cmd/main.go cmd/main.go
 COPY api/ api/
-COPY internal/controller/ internal/controller/
+COPY internal/ internal/
 
 # Build
 # the GOARCH has not a default value to allow the binary be built according to the host where the command

cmd/main.go

@@ -45,6 +45,7 @@ import (
 	"github.com/caarlos0/env/v11"
 	daplav1alpha1 "github.com/statisticsnorway/keycloakerator/api/v1alpha1"
 	"github.com/statisticsnorway/keycloakerator/internal/controller"
+	"github.com/statisticsnorway/keycloakerator/internal/keycloak"
 	//+kubebuilder:scaffold:imports
 )
 
@@ -165,8 +166,7 @@ func main() {
 		setupLog.Error(err, "unable to parse general config from env")
 	}
 
-	var ctrlOpts []controller.SimpleProxyClientOption
-
+	var oidcService controller.OIDCService = &controller.OidcDummy{}
 	if !cfg.KeycloakDummy {
 		kcConfig := &keycloakConfig{}
 
@@ -203,16 +203,15 @@ func main() {
 			).String(),
 		}
 
-		kc := controller.NewGocloakWrapper(
+		oidcService = keycloak.NewGocloakWrapper(
 			kcConfig.KeycloakUrl.String(),
 			kcConfig.ClientRealm,
 			authConfig.TokenSource(ctx),
 		)
-		ctrlOpts = append(ctrlOpts, controller.WithKeycloak(kc))
 	}
 
 	// Set up our reconciler
-	if err = controller.NewSimpleProxyClientReconciler(mgr, ctrlOpts...).SetupWithManager(mgr); err != nil {
+	if err = controller.NewSimpleProxyClientReconciler(mgr, oidcService).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "SimpleProxyClient")
 		os.Exit(1)
 	}

go.mod

@@ -3,14 +3,17 @@ module github.com/statisticsnorway/keycloakerator
 go 1.21
 
 require (
+	cloud.google.com/go/secretmanager v1.13.1
 	github.com/Nerzal/gocloak/v13 v13.9.0
 	github.com/caarlos0/env/v11 v11.0.1
 	github.com/onsi/ginkgo/v2 v2.14.0
 	github.com/onsi/gomega v1.30.0
 	golang.org/x/oauth2 v0.20.0
+	gopkg.in/yaml.v3 v3.0.1
 	k8s.io/api v0.29.0
 	k8s.io/apimachinery v0.29.0
 	k8s.io/client-go v0.29.0
+	k8s.io/utils v0.0.0-20230726121419-3b25d923346b
 	sigs.k8s.io/controller-runtime v0.17.2
 )
 
@@ -19,7 +22,6 @@ require (
 	cloud.google.com/go/auth/oauth2adapt v0.2.2 // indirect
 	cloud.google.com/go/compute/metadata v0.3.0 // indirect
 	cloud.google.com/go/iam v1.1.8 // indirect
-	cloud.google.com/go/secretmanager v1.13.1 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
@@ -63,7 +65,6 @@ require (
 	github.com/prometheus/procfs v0.12.0 // indirect
 	github.com/segmentio/ksuid v1.0.4 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/stretchr/testify v1.9.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 // indirect
 	go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
@@ -90,12 +91,10 @@ require (
 	google.golang.org/protobuf v1.34.1 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 	k8s.io/apiextensions-apiserver v0.29.0 // indirect
 	k8s.io/component-base v0.29.0 // indirect
 	k8s.io/klog/v2 v2.110.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20231010175941-2dd684a91f00 // indirect
-	k8s.io/utils v0.0.0-20230726121419-3b25d923346b // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect

go.sum

@@ -1,4 +1,6 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
+cloud.google.com/go v0.112.2 h1:ZaGT6LiG7dBzi6zNOvVZwacaXlmf3lRqnC4DQzqyRQw=
+cloud.google.com/go v0.112.2/go.mod h1:iEqjp//KquGIJV/m+Pk3xecgKNhV+ry+vVTsy4TbDms=
 cloud.google.com/go/auth v0.4.1 h1:Z7YNIhlWRtrnKlZke7z3GMqzvuYzdc2z98F9D1NV5Hg=
 cloud.google.com/go/auth v0.4.1/go.mod h1:QVBuVEKpCn4Zp58hzRGvL0tjRGU0YqdRTdCHM1IHnro=
 cloud.google.com/go/auth/oauth2adapt v0.2.2 h1:+TTV8aXpjeChS9M+aTtN/TjdQnzJvmzKFt//oWu7HX4=
@@ -179,6 +181,8 @@ go.opentelemetry.io/otel v1.24.0 h1:0LAOdjNmQeSTzGBzduGe/rU4tZhMwL5rWgtp9Ku5Jfo=
 go.opentelemetry.io/otel v1.24.0/go.mod h1:W7b9Ozg4nkF5tWI5zsXkaKKDjdVjpD4oAt9Qi/MArHo=
 go.opentelemetry.io/otel/metric v1.24.0 h1:6EhoGWWK28x1fbpA4tYTOWBkPefTDQnb8WSGXlc88kI=
 go.opentelemetry.io/otel/metric v1.24.0/go.mod h1:VYhLe1rFfxuTXLgj4CBiyz+9WYBA8pNGJgDcSFRKBco=
+go.opentelemetry.io/otel/sdk v1.24.0 h1:YMPPDNymmQN3ZgczicBY3B6sf9n62Dlj9pWD3ucgoDw=
+go.opentelemetry.io/otel/sdk v1.24.0/go.mod h1:KVrIYw6tEubO9E96HQpcmpTKDVn9gdv35HoYiQWGDFg=
 go.opentelemetry.io/otel/trace v1.24.0 h1:CsKnnL4dUAr/0llH9FKuc698G04IrpWV0MQA/Y1YELI=
 go.opentelemetry.io/otel/trace v1.24.0/go.mod h1:HPc3Xr/cOApsBI154IU0OI0HJexz+aw5uPdbs3UCjNU=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=

internal/controller/keycloak.go

@@ -2,63 +2,43 @@ package controller
 
 import (
 	"context"
-	"crypto/md5"
-	"encoding/hex"
-	"errors"
-	"fmt"
+	"math/rand"
 	"strconv"
-
-	"github.com/Nerzal/gocloak/v13"
+	"sync"
 )
 
-var _ Keycloak = (*KeycloakDummy)(nil)
-
-type KeycloakDummy struct {
-	clients []gocloak.Client
-}
-
-func (d *KeycloakDummy) CreateClient(ctx context.Context, newClient gocloak.Client) (string, error) {
-	id := strconv.Itoa(len(d.clients))
-	newClient.ID = &id
-	hash := md5.Sum([]byte(fmt.Sprintf("%s-%s", id, *(newClient.Name))))
-	secret := hex.EncodeToString(hash[:])
-	newClient.Secret = &secret
-	d.clients = append(d.clients, newClient)
-	return id, nil
+type OidcDummy struct {
+	mu      sync.RWMutex
+	clients map[string]Client
 }
 
-func (d *KeycloakDummy) CreateClientProtocolMapper(ctx context.Context, idOfClient string, mapper gocloak.ProtocolMapperRepresentation) (string, error) {
-	return "", nil
-}
-
-func (d *KeycloakDummy) GetClientByClientId(ctx context.Context, clientId string) (*gocloak.Client, error) {
-	for _, client := range d.clients {
-		if *client.ClientID == clientId {
-			return &client, nil
-		}
+func (d *OidcDummy) CreateClient(ctx context.Context, req CreateClientRequest) (*Client, error) {
+	secret := strconv.Itoa(rand.Int())
+	client := Client{
+		ClientID:     req.Name,
+		ClientSecret: secret,
 	}
-	return nil, &ClientNotFoundError{ClientId: clientId}
+	d.mu.Lock()
+	defer d.mu.Unlock()
+	d.clients[req.Name] = client
+	return &client, nil
 }
 
-func (d *KeycloakDummy) GetClient(ctx context.Context, idOfClient string) (*gocloak.Client, error) {
-	id, err := strconv.Atoi(idOfClient)
-	if err != nil {
-		return nil, err
+func (d *OidcDummy) GetClient(ctx context.Context, req GetClientRequest) (*Client, error) {
+	d.mu.RLock()
+	defer d.mu.RUnlock()
+	if client, ok := d.clients[req.Name]; ok {
+		return &client, nil
 	}
-	if id < 0 || id >= len(d.clients) {
-		return nil, fmt.Errorf("invalid dummy client ID %d", id)
-	}
-	return &d.clients[id], nil
+	return nil, ErrNotFound
 }
 
-func (d *KeycloakDummy) DeleteClient(ctx context.Context, idOfClient string) error {
-	id, err := strconv.Atoi(idOfClient)
-	if err != nil {
-		return err
-	}
-	if id < 0 || id >= len(d.clients) {
-		return errors.New("invalid dummy client ID")
+func (d *OidcDummy) DeleteClient(ctx context.Context, req DeleteClientRequest) error {
+	d.mu.Lock()
+	defer d.mu.Unlock()
+	if _, ok := d.clients[req.Name]; ok {
+		delete(d.clients, req.Name)
+		return nil
 	}
-	d.clients = append(d.clients[:id], d.clients[id+1:]...)
-	return nil
+	return ErrNotFound
 }

internal/controller/keycloak_dummy.go

@@ -0,0 +1,32 @@
+package controller
+
+import (
+	"context"
+	"errors"
+)
+
+type OIDCService interface {
+	CreateClient(context.Context, CreateClientRequest) (*Client, error)
+	GetClient(context.Context, GetClientRequest) (*Client, error)
+	DeleteClient(context.Context, DeleteClientRequest) error
+}
+
+var ErrNotFound error = errors.New("client not found")
+
+type Client struct {
+	ClientID     string
+	ClientSecret string
+}
+
+type CreateClientRequest struct {
+	Name         string
+	RedirectURIs []string
+}
+
+type GetClientRequest struct {
+	Name string
+}
+
+type DeleteClientRequest struct {
+	Name string
+}