pkg/*: use operator-lib handlers (#58)

Author: joelanford

go.mod

@@ -4,22 +4,22 @@ go 1.13
 
 require (
 	github.com/go-logr/logr v0.1.0
-	github.com/onsi/ginkgo v1.12.0
-	github.com/onsi/gomega v1.9.0
-	github.com/prometheus/client_golang v1.0.0
+	github.com/onsi/ginkgo v1.12.1
+	github.com/onsi/gomega v1.10.1
+	github.com/operator-framework/operator-lib v0.1.0
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.5.1
 	go.uber.org/zap v1.13.0
 	gomodules.xyz/jsonpatch/v2 v2.0.1
 	helm.sh/helm/v3 v3.2.0
-	k8s.io/api v0.18.2
-	k8s.io/apiextensions-apiserver v0.18.2
-	k8s.io/apimachinery v0.18.2
+	k8s.io/api v0.18.4
+	k8s.io/apiextensions-apiserver v0.18.4
+	k8s.io/apimachinery v0.18.4
 	k8s.io/cli-runtime v0.18.2
-	k8s.io/client-go v0.18.2
+	k8s.io/client-go v0.18.4
 	k8s.io/klog v1.0.0
 	k8s.io/kubectl v0.18.2
 	rsc.io/letsencrypt v0.0.3 // indirect
-	sigs.k8s.io/controller-runtime v0.6.0
+	sigs.k8s.io/controller-runtime v0.6.1
 	sigs.k8s.io/yaml v1.2.0
 )

go.sum

@@ -22,6 +22,7 @@ import (
 	"errors"
 	"fmt"
 
+	sdkhandler "github.com/operator-framework/operator-lib/handler"
 	"gomodules.xyz/jsonpatch/v2"
 	"helm.sh/helm/v3/pkg/action"
 	"helm.sh/helm/v3/pkg/chart"
@@ -43,7 +44,6 @@ import (
 	"sigs.k8s.io/yaml"
 
 	"github.com/joelanford/helm-operator/pkg/internal/sdk/controllerutil"
-	"github.com/joelanford/helm-operator/pkg/internal/sdk/handler"
 )
 
 type ActionClientGetter interface {
@@ -329,13 +329,9 @@ func (pr *ownerPostRenderer) Run(in *bytes.Buffer) (*bytes.Buffer, error) {
 			ownerRefs := append(u.GetOwnerReferences(), *ownerRef)
 			u.SetOwnerReferences(ownerRefs)
 		} else {
-			a := u.GetAnnotations()
-			if a == nil {
-				a = map[string]string{}
+			if err := sdkhandler.SetOwnerAnnotations(pr.owner, u); err != nil {
+				return err
 			}
-			a[handler.NamespacedNameAnnotation] = fmt.Sprintf("%s/%s", pr.owner.GetNamespace(), pr.owner.GetName())
-			a[handler.TypeAnnotation] = pr.owner.GetObjectKind().GroupVersionKind().GroupKind().String()
-			u.SetAnnotations(a)
 		}
 		outData, err := yaml.Marshal(u.Object)
 		if err != nil {

pkg/client/actionclient.go

@@ -20,6 +20,7 @@ import (
 	"sync"
 
 	"github.com/go-logr/logr"
+	sdkhandler "github.com/operator-framework/operator-lib/handler"
 	"helm.sh/helm/v3/pkg/release"
 	"helm.sh/helm/v3/pkg/releaseutil"
 	"k8s.io/apimachinery/pkg/api/meta"
@@ -32,7 +33,6 @@ import (
 
 	"github.com/joelanford/helm-operator/pkg/hook"
 	"github.com/joelanford/helm-operator/pkg/internal/sdk/controllerutil"
-	sdkhandler "github.com/joelanford/helm-operator/pkg/internal/sdk/handler"
 	"github.com/joelanford/helm-operator/pkg/internal/sdk/predicate"
 )
 
@@ -86,7 +86,7 @@ func (d *dependentResourceWatcher) Exec(owner *unstructured.Unstructured, rel re
 			}
 		} else {
 			if err := d.controller.Watch(&source.Kind{Type: &obj}, &sdkhandler.EnqueueRequestForAnnotation{
-				Type: owner.GetObjectKind().GroupVersionKind().GroupKind().String(),
+				Type: owner.GetObjectKind().GroupVersionKind().GroupKind(),
 			}, dependentPredicate); err != nil {
 				return err
 			}

pkg/internal/sdk/handler/enqueue_annotation.go

@@ -22,6 +22,7 @@ import (
 	"github.com/go-logr/logr/testing"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	sdkhandler "github.com/operator-framework/operator-lib/handler"
 	"helm.sh/helm/v3/pkg/release"
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -30,7 +31,6 @@ import (
 
 	"github.com/joelanford/helm-operator/pkg/hook"
 	"github.com/joelanford/helm-operator/pkg/internal/sdk/fake"
-	sdkhandler "github.com/joelanford/helm-operator/pkg/internal/sdk/handler"
 	internalhook "github.com/joelanford/helm-operator/pkg/reconciler/internal/hook"
 )
 

pkg/reconciler/internal/hook/hook.go

@@ -25,7 +25,7 @@ import (
 	"time"
 
 	"github.com/go-logr/logr"
-	"github.com/prometheus/client_golang/prometheus"
+	sdkhandler "github.com/operator-framework/operator-lib/handler"
 	"helm.sh/helm/v3/pkg/action"
 	"helm.sh/helm/v3/pkg/chart"
 	"helm.sh/helm/v3/pkg/chartutil"
@@ -42,7 +42,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
-	"sigs.k8s.io/controller-runtime/pkg/metrics"
 	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	"github.com/joelanford/helm-operator/pkg/annotation"
@@ -80,8 +79,6 @@ type Reconciler struct {
 	installAnnotations   map[string]annotation.Install
 	upgradeAnnotations   map[string]annotation.Upgrade
 	uninstallAnnotations map[string]annotation.Uninstall
-
-	infoMetric *prometheus.GaugeVec
 }
 
 // New creates a new Reconciler that reconciles custom resources that define a
@@ -108,10 +105,6 @@ func New(opts ...Option) (*Reconciler, error) {
 		return nil, err
 	}
 
-	if err := r.setupMetrics(); err != nil {
-		return nil, err
-	}
-
 	return r, nil
 }
 
@@ -122,15 +115,6 @@ func (r *Reconciler) setupAnnotationMaps() {
 	r.uninstallAnnotations = make(map[string]annotation.Uninstall)
 }
 
-func (r *Reconciler) setupMetrics() error {
-	r.infoMetric = prometheus.NewGaugeVec(prometheus.GaugeOpts{
-		Name: fmt.Sprintf("%s_info", strings.ToLower(r.gvk.Kind)),
-		Help: fmt.Sprintf("Information about the %s custom resource.", r.gvk.Kind),
-	}, []string{"namespace", "name"})
-
-	return metrics.Registry.Register(r.infoMetric)
-}
-
 // SetupWithManager configures a controller for the Reconciler and registers
 // watches. It also uses the passed Manager to initialize default values for the
 // Reconciler and sets up the manager's scheme with the Reconciler's configured
@@ -524,16 +508,6 @@ func (r *Reconciler) Reconcile(req ctrl.Request) (res ctrl.Result, err error) {
 		return ctrl.Result{}, fmt.Errorf("unexpected release state: %s", state)
 	}
 
-	labels := map[string]string{
-		"namespace": obj.GetNamespace(),
-		"name":      obj.GetName(),
-	}
-	if m, err := r.infoMetric.GetMetricWith(labels); err != nil {
-		panic(err)
-	} else {
-		m.Set(1.0)
-	}
-
 	for _, h := range r.postHooks {
 		if err := h.Exec(obj, *rel, log); err != nil {
 			log.Error(err, "post-release hook failed", "name", rel.Name, "version", rel.Version)
@@ -599,12 +573,6 @@ func (r *Reconciler) handleDeletion(ctx context.Context, actionClient helmclient
 		return err
 	}
 
-	labels := map[string]string{
-		"namespace": obj.GetNamespace(),
-		"name":      obj.GetName(),
-	}
-	_ = r.infoMetric.Delete(labels)
-
 	// Since the client is hitting a cache, waiting for the
 	// deletion here will guarantee that the next reconciliation
 	// will see that the CR has been deleted and that there's
@@ -783,7 +751,7 @@ func (r *Reconciler) setupWatches(mgr ctrl.Manager, c controller.Controller) err
 	obj.SetGroupVersionKind(*r.gvk)
 	if err := c.Watch(
 		&source.Kind{Type: obj},
-		&handler.EnqueueRequestForObject{},
+		&sdkhandler.InstrumentedEnqueueRequestForObject{},
 	); err != nil {
 		return err
 	}

pkg/reconciler/internal/hook/hook_test.go

@@ -46,7 +46,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/log/zap"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
-	"sigs.k8s.io/controller-runtime/pkg/metrics"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/yaml"
 
@@ -428,7 +427,6 @@ var _ = Describe("Reconciler", func() {
 				}
 				Expect(err).To(BeNil())
 			})
-			metrics.Registry.Unregister(r.infoMetric)
 			close(done)
 		})