Upgrade to controller-runtime 0.8.3

config/rbac/leader_election_role.yaml

@@ -30,3 +30,12 @@ rules:
   - events
   verbs:
   - create
+- apiGroups:
+    - coordination.k8s.io
+  resources:
+    - leases
+  verbs:
+    - create
+    - get
+    - list
+    - update

go.mod

@@ -3,14 +3,11 @@ module github.com/cert-manager/sample-external-issuer
 go 1.15
 
 require (
-	github.com/go-logr/logr v0.2.1-0.20200730175230-ee2de8da5be6
-	github.com/go-logr/zapr v0.2.0 // indirect
+	github.com/go-logr/logr v0.3.0
 	github.com/jetstack/cert-manager v1.0.4
-	github.com/onsi/ginkgo v1.12.1
-	github.com/onsi/gomega v1.10.1
 	github.com/stretchr/testify v1.6.1
-	k8s.io/api v0.19.0
-	k8s.io/apimachinery v0.19.0
-	k8s.io/client-go v0.19.0
-	sigs.k8s.io/controller-runtime v0.6.2
+	k8s.io/api v0.20.2
+	k8s.io/apimachinery v0.20.2
+	k8s.io/client-go v0.20.2
+	sigs.k8s.io/controller-runtime v0.8.3
 )

internal/controllers/certificaterequest_controller.go

@@ -58,8 +58,7 @@ type CertificateRequestReconciler struct {
 // +kubebuilder:rbac:groups=cert-manager.io,resources=certificaterequests/status,verbs=get;update;patch
 // +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch
 
-func (r *CertificateRequestReconciler) Reconcile(req ctrl.Request) (result ctrl.Result, err error) {
-	ctx := context.Background()
+func (r *CertificateRequestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
 	log := r.Log.WithValues("certificaterequest", req.NamespacedName)
 
 	// Get the CertificateRequest
@@ -119,14 +118,14 @@ func (r *CertificateRequestReconciler) Reconcile(req ctrl.Request) (result ctrl.
 
 	// Ignore but log an error if the issuerRef.Kind is unrecognised
 	issuerGVK := sampleissuerapi.GroupVersion.WithKind(certificateRequest.Spec.IssuerRef.Kind)
-	issuer, err := r.Scheme.New(issuerGVK)
+	issuerRO, err := r.Scheme.New(issuerGVK)
 	if err != nil {
 		err = fmt.Errorf("%w: %v", errIssuerRef, err)
 		log.Error(err, "Unrecognised kind. Ignoring.")
 		setReadyCondition(cmmeta.ConditionFalse, cmapi.CertificateRequestReasonFailed, err.Error())
 		return ctrl.Result{}, nil
 	}
-
+	issuer := issuerRO.(client.Object)
 	// Create a Namespaced name for Issuer and a non-Namespaced name for ClusterIssuer
 	issuerName := types.NamespacedName{
 		Name: certificateRequest.Spec.IssuerRef.Name,

internal/controllers/certificaterequest_controller_test.go

@@ -37,7 +37,7 @@ func (o *fakeSigner) Sign([]byte) ([]byte, error) {
 func TestCertificateRequestReconcile(t *testing.T) {
 	type testCase struct {
 		name                         types.NamespacedName
-		objects                      []runtime.Object
+		objects                      []client.Object
 		signerBuilder                signer.SignerBuilder
 		clusterResourceNamespace     string
 		expectedResult               ctrl.Result
@@ -49,7 +49,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 	tests := map[string]testCase{
 		"success-issuer": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -96,7 +96,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"success-cluster-issuer": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -146,7 +146,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"issuer-ref-foreign-group": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -159,7 +159,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"certificaterequest-already-ready": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -177,7 +177,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"certificaterequest-missing-ready-condition": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -193,7 +193,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"issuer-ref-unknown-kind": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -213,7 +213,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"issuer-not-found": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -234,7 +234,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"clusterissuer-not-found": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -255,7 +255,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"issuer-not-ready": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -290,7 +290,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"issuer-secret-not-found": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -328,7 +328,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"signer-builder-error": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -375,7 +375,7 @@ func TestCertificateRequestReconcile(t *testing.T) {
 		},
 		"signer-error": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "cr1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				cmgen.CertificateRequest(
 					"cr1",
 					cmgen.SetCertificateRequestNamespace("ns1"),
@@ -429,15 +429,18 @@ func TestCertificateRequestReconcile(t *testing.T) {
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
-			fakeClient := fake.NewFakeClientWithScheme(scheme, tc.objects...)
+			fakeClient := fake.NewClientBuilder().
+				WithScheme(scheme).
+				WithObjects(tc.objects...).
+				Build()
 			controller := CertificateRequestReconciler{
 				Client:                   fakeClient,
 				Log:                      logrtesting.TestLogger{T: t},
 				Scheme:                   scheme,
 				ClusterResourceNamespace: tc.clusterResourceNamespace,
 				SignerBuilder:            tc.signerBuilder,
 			}
-			result, err := controller.Reconcile(reconcile.Request{NamespacedName: tc.name})
+			result, err := controller.Reconcile(context.TODO(), reconcile.Request{NamespacedName: tc.name})
 			if tc.expectedError != nil {
 				assertErrorIs(t, tc.expectedError, err)
 			} else {

internal/controllers/issuer_controller.go

@@ -60,21 +60,23 @@ type IssuerReconciler struct {
 // +kubebuilder:rbac:groups=sample-issuer.example.com,resources=issuers/status;clusterissuers/status,verbs=get;update;patch
 // +kubebuilder:rbac:groups="",resources=secrets,verbs=get;list;watch
 
-func (r *IssuerReconciler) newIssuer() (runtime.Object, error) {
+func (r *IssuerReconciler) newIssuer() (client.Object, error) {
 	issuerGVK := sampleissuerapi.GroupVersion.WithKind(r.Kind)
-	return r.Scheme.New(issuerGVK)
+	ro, err := r.Scheme.New(issuerGVK)
+	if err != nil {
+		return nil, err
+	}
+	return ro.(client.Object), nil
 }
 
-func (r *IssuerReconciler) Reconcile(req ctrl.Request) (result ctrl.Result, err error) {
-	ctx := context.Background()
+func (r *IssuerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, err error) {
 	log := r.Log.WithValues("issuer", req.NamespacedName)
 
 	issuer, err := r.newIssuer()
 	if err != nil {
 		log.Error(err, "Unrecognised issuer type")
 		return ctrl.Result{}, nil
 	}
-
 	if err := r.Get(ctx, req.NamespacedName, issuer); err != nil {
 		if err := client.IgnoreNotFound(err); err != nil {
 			return ctrl.Result{}, fmt.Errorf("unexpected get error: %v", err)

internal/controllers/issuer_controller_test.go

@@ -13,6 +13,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/types"
 	ctrl "sigs.k8s.io/controller-runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
@@ -33,7 +34,7 @@ func TestIssuerReconcile(t *testing.T) {
 	type testCase struct {
 		kind                         string
 		name                         types.NamespacedName
-		objects                      []runtime.Object
+		objects                      []client.Object
 		healthCheckerBuilder         signer.HealthCheckerBuilder
 		clusterResourceNamespace     string
 		expectedResult               ctrl.Result
@@ -45,7 +46,7 @@ func TestIssuerReconcile(t *testing.T) {
 		"success-issuer": {
 			kind: "Issuer",
 			name: types.NamespacedName{Namespace: "ns1", Name: "issuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.Issuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "issuer1",
@@ -79,7 +80,7 @@ func TestIssuerReconcile(t *testing.T) {
 		"success-clusterissuer": {
 			kind: "ClusterIssuer",
 			name: types.NamespacedName{Name: "clusterissuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.ClusterIssuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name: "clusterissuer1",
@@ -119,7 +120,7 @@ func TestIssuerReconcile(t *testing.T) {
 		},
 		"issuer-missing-ready-condition": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "issuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.Issuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "issuer1",
@@ -131,7 +132,7 @@ func TestIssuerReconcile(t *testing.T) {
 		},
 		"issuer-missing-secret": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "issuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.Issuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "issuer1",
@@ -155,7 +156,7 @@ func TestIssuerReconcile(t *testing.T) {
 		},
 		"issuer-failing-healthchecker-builder": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "issuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.Issuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "issuer1",
@@ -188,7 +189,7 @@ func TestIssuerReconcile(t *testing.T) {
 		},
 		"issuer-failing-healthchecker-check": {
 			name: types.NamespacedName{Namespace: "ns1", Name: "issuer1"},
-			objects: []runtime.Object{
+			objects: []client.Object{
 				&sampleissuerapi.Issuer{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      "issuer1",
@@ -227,7 +228,10 @@ func TestIssuerReconcile(t *testing.T) {
 
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
-			fakeClient := fake.NewFakeClientWithScheme(scheme, tc.objects...)
+			fakeClient := fake.NewClientBuilder().
+				WithScheme(scheme).
+				WithObjects(tc.objects...).
+				Build()
 			if tc.kind == "" {
 				tc.kind = "Issuer"
 			}
@@ -239,7 +243,7 @@ func TestIssuerReconcile(t *testing.T) {
 				HealthCheckerBuilder:     tc.healthCheckerBuilder,
 				ClusterResourceNamespace: tc.clusterResourceNamespace,
 			}
-			result, err := controller.Reconcile(reconcile.Request{NamespacedName: tc.name})
+			result, err := controller.Reconcile(context.TODO(), reconcile.Request{NamespacedName: tc.name})
 			if tc.expectedError != nil {
 				assertErrorIs(t, tc.expectedError, err)
 			} else {

internal/issuer/util/util.go

@@ -20,12 +20,12 @@ import (
 	"fmt"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
-	"k8s.io/apimachinery/pkg/runtime"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	sampleissuerapi "github.com/cert-manager/sample-external-issuer/api/v1alpha1"
 )
 
-func GetSpecAndStatus(issuer runtime.Object) (*sampleissuerapi.IssuerSpec, *sampleissuerapi.IssuerStatus, error) {
+func GetSpecAndStatus(issuer client.Object) (*sampleissuerapi.IssuerSpec, *sampleissuerapi.IssuerStatus, error) {
 	switch t := issuer.(type) {
 	case *sampleissuerapi.Issuer:
 		return &t.Spec, &t.Status, nil