clustertoken_controller.go

/*
Copyright 2024 Robin Breathe.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package controller

import (
	"context"
	"time"

	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/controller"
	"sigs.k8s.io/controller-runtime/pkg/event"
	"sigs.k8s.io/controller-runtime/pkg/log"
	"sigs.k8s.io/controller-runtime/pkg/predicate"

	githubv1 "github.com/isometry/github-token-manager/api/v1"
	"github.com/isometry/github-token-manager/internal/ghapp"
	tm "github.com/isometry/github-token-manager/internal/tokenmanager"
)

// ClusterTokenReconciler reconciles a ClusterToken object
type ClusterTokenReconciler struct {
	client.Client
	// Scheme *runtime.Scheme
	// Recorder record.EventRecorder
}

// +kubebuilder:rbac:groups=github.as-code.io,resources=clustertokens,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=github.as-code.io,resources=clustertokens/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=github.as-code.io,resources=clustertokens/finalizers,verbs=update
// +kubebuilder:rbac:groups=core,resources=events,verbs=create;patch
// +kubebuilder:rbac:groups=core,resources=secrets,verbs=get;list;watch;create;update;patch;delete

// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
// TODO(user): Modify the Reconcile function to compare the state specified by
// the ClusterToken object against the actual cluster state, and then
// perform operations to make the cluster state reflect the state specified by
// the user.
//
// For more details, check Reconcile and its Result here:
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.16.3/pkg/reconcile
func (r *ClusterTokenReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
	logger := log.FromContext(ctx)

	if app == nil {
		app, err = ghapp.NewGHApp(ctx)
		if err != nil {
			logger.Error(err, "failed to load GitHub App credentials")
			return ctrl.Result{RequeueAfter: time.Minute}, err
		}
	}

	// Fetch Token instance
	token := &githubv1.ClusterToken{}
	options := []tm.Option{
		tm.WithReconciler(r),
		tm.WithGHApp(app),
		tm.WithLogger(logger),
	}

	tokenSecret, err := tm.NewTokenSecret(ctx, req.NamespacedName, token, options...)
	if err != nil {
		logger.Error(err, "failed to create ClusterToken reconciler")
		return ctrl.Result{}, err
	}

	if tokenSecret == nil {
		logger.Info("ClusterToken not found, skipping reconciliation")
		return ctrl.Result{}, nil
	}

	result, err = tokenSecret.Reconcile()
	if err != nil {
		logger.Error(err, "failed to reconcile ClusterToken")
		return result, err
	}
	logger.Info("reconciled", "requeueAfter", result.RequeueAfter)
	return result, nil
}

func ignoreClusterTokenStatusUpdatePredicate() predicate.Predicate {
	return predicate.Funcs{
		UpdateFunc: func(e event.UpdateEvent) bool {
			oldToken, ok1 := e.ObjectOld.(*githubv1.ClusterToken)
			newToken, ok2 := e.ObjectNew.(*githubv1.ClusterToken)
			if ok1 && ok2 && oldToken.GetGeneration() == newToken.GetGeneration() {
				// The generation has not changed, so ignore this update
				return false
			}
			// The generation has changed, so handle this update
			return true
		},
	}
}

// SetupWithManager sets up the controller with the Manager.
func (r *ClusterTokenReconciler) SetupWithManager(mgr ctrl.Manager) error {
	return ctrl.NewControllerManagedBy(mgr).
		For(&githubv1.ClusterToken{}).
		Named("github-clustertoken").
		WithEventFilter(ignoreClusterTokenStatusUpdatePredicate()).
		WithOptions(controller.Options{MaxConcurrentReconciles: 1}). // default
		Complete(r)
}