Migrate controller to eris (#4463)

* Update controller code

* Update tests

Author: theunrepentantgeek

v2/cmd/controller/app/setup.go

@@ -20,7 +20,7 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/benbjohnson/clock"
 	"github.com/go-logr/logr"
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 	"golang.org/x/time/rate"
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -151,7 +151,7 @@ func SetupControllerManager(ctx context.Context, setupLog logr.Logger, flgs *Fla
 
 			included := crdmanagement.IncludedCRDs(installationInstructions)
 			if len(included) == 0 {
-				err = errors.New("No existing CRDs in cluster and no --crd-pattern specified")
+				err = eris.New("No existing CRDs in cluster and no --crd-pattern specified")
 				setupLog.Error(err, "failed to apply CRDs")
 				os.Exit(1)
 			}
@@ -297,7 +297,7 @@ func getDefaultAzureTokenCredential(cfg config.Values, setupLog logr.Logger) (az
 			TokenFilePath: identity.FederatedTokenFilePath,
 		})
 		if err != nil {
-			return nil, errors.Wrapf(err, "unable to get workload identity credential")
+			return nil, eris.Wrapf(err, "unable to get workload identity credential")
 		}
 
 		return credential, nil
@@ -307,15 +307,15 @@ func getDefaultAzureTokenCredential(cfg config.Values, setupLog logr.Logger) (az
 		certPassword := os.Getenv(common.AzureClientCertificatePassword)
 		credential, err := identity.NewClientCertificateCredential(cfg.TenantID, cfg.ClientID, []byte(cert), []byte(certPassword))
 		if err != nil {
-			return nil, errors.Wrapf(err, "unable to get client certificate credential")
+			return nil, eris.Wrapf(err, "unable to get client certificate credential")
 		}
 
 		return credential, nil
 	}
 
 	credential, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
-		return nil, errors.Wrapf(err, "unable to get default azure credential")
+		return nil, eris.Wrapf(err, "unable to get default azure credential")
 	}
 
 	return credential, err
@@ -340,7 +340,7 @@ func initializeClients(cfg config.Values, mgr ctrl.Manager) (*clients, error) {
 
 	credential, err := getDefaultAzureCredential(cfg, log)
 	if err != nil {
-		return nil, errors.Wrap(err, "error while fetching default global credential")
+		return nil, eris.Wrap(err, "error while fetching default global credential")
 	}
 
 	kubeClient := kubeclient.NewClient(mgr.GetClient())
@@ -366,7 +366,7 @@ func initializeClients(cfg config.Values, mgr ctrl.Manager) (*clients, error) {
 		asocel.Log(log),
 	)
 	if err != nil {
-		return nil, errors.Wrap(err, "error creating expression evaluator")
+		return nil, eris.Wrap(err, "error creating expression evaluator")
 	}
 	// Register the evaluator for use by webhooks
 	asocel.RegisterEvaluator(expressionEvaluator)
@@ -396,13 +396,13 @@ func initializeWatchers(readyResources map[string]apiextensions.CustomResourceDe
 		clients.expressionEvaluator,
 		clients.options)
 	if err != nil {
-		return errors.Wrap(err, "failed getting storage types and reconcilers")
+		return eris.Wrap(err, "failed getting storage types and reconcilers")
 	}
 
 	// Filter the types to register
 	objs, err = crdmanagement.FilterStorageTypesByReadyCRDs(clients.log, mgr.GetScheme(), readyResources, objs)
 	if err != nil {
-		return errors.Wrap(err, "failed to filter storage types by ready CRDs")
+		return eris.Wrap(err, "failed to filter storage types by ready CRDs")
 	}
 
 	err = generic.RegisterAll(
@@ -413,7 +413,7 @@ func initializeWatchers(readyResources map[string]apiextensions.CustomResourceDe
 		objs,
 		clients.options)
 	if err != nil {
-		return errors.Wrap(err, "failed to register gvks")
+		return eris.Wrap(err, "failed to register gvks")
 	}
 
 	return nil
@@ -463,7 +463,7 @@ func newCRDManager(logger logr.Logger, k8sConfig *rest.Config) (*crdmanagement.M
 	_ = apiextensions.AddToScheme(crdScheme)
 	crdClient, err := client.New(k8sConfig, client.Options{Scheme: crdScheme})
 	if err != nil {
-		return nil, errors.Wrap(err, "unable to create CRD client")
+		return nil, eris.Wrap(err, "unable to create CRD client")
 	}
 
 	crdManager := crdmanagement.NewManager(logger, kubeclient.NewClient(crdClient))

v2/internal/annotations/parse.go

@@ -8,7 +8,7 @@ package annotations
 import (
 	"strings"
 
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 )
 
 type Annotation struct {
@@ -20,20 +20,20 @@ type Annotation struct {
 func Parse(s string) (Annotation, error) {
 	split := strings.Split(s, "=")
 	if len(split) != 2 {
-		return Annotation{}, errors.Errorf("%s must have two parts separated by '='", s)
+		return Annotation{}, eris.Errorf("%s must have two parts separated by '='", s)
 	}
 
 	// see https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 	key := split[0]
 	value := split[1]
 
 	if len(key) == 0 {
-		return Annotation{}, errors.New("key can't be length 0")
+		return Annotation{}, eris.New("key can't be length 0")
 	}
 
 	keySplit := strings.Split(key, "/")
 	if len(keySplit) > 2 {
-		return Annotation{}, errors.Errorf("key %s must contain only a single '/'", key)
+		return Annotation{}, eris.Errorf("key %s must contain only a single '/'", key)
 	}
 
 	var name string
@@ -48,11 +48,11 @@ func Parse(s string) (Annotation, error) {
 	}
 
 	if len(key) > 63 {
-		return Annotation{}, errors.Errorf("name %s must be 63 characters or less", name)
+		return Annotation{}, eris.Errorf("name %s must be 63 characters or less", name)
 	}
 
 	if len(prefix) > 253 {
-		return Annotation{}, errors.Errorf("prefix %s must be 253 characters or less", prefix)
+		return Annotation{}, eris.Errorf("prefix %s must be 253 characters or less", prefix)
 	}
 
 	// TODO: Could enforce character restrictions too but not bothering for now
@@ -70,7 +70,7 @@ func ParseAll(annotations []string) ([]Annotation, error) {
 	for _, annotation := range annotations {
 		parsed, err := Parse(annotation)
 		if err != nil {
-			return nil, errors.Wrapf(err, "failed parsing %s", annotation)
+			return nil, eris.Wrapf(err, "failed parsing %s", annotation)
 		}
 		result = append(result, parsed)
 	}

v2/internal/config/operatormode.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 )
 
 // OperatorMode determines whether we'll run watchers and/or webhooks.
@@ -57,6 +57,6 @@ func ParseOperatorMode(value string) (OperatorMode, error) {
 	case "watchers-and-webhooks":
 		return OperatorModeBoth, nil
 	default:
-		return OperatorMode(0), errors.Errorf(`operator mode value must be one of "watchers-and-webhooks", "webhooks" or "watchers" but was %q`, value)
+		return OperatorMode(0), eris.Errorf(`operator mode value must be one of "watchers-and-webhooks", "webhooks" or "watchers" but was %q`, value)
 	}
 }

v2/internal/config/vars.go

@@ -11,7 +11,7 @@ import (
 	"time"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/cloud"
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 
 	"github.com/Azure/azure-service-operator/v2/pkg/common/config"
 )
@@ -119,7 +119,7 @@ func ParseRateLimitMode(s string) (RateLimitMode, error) {
 	case string(RateLimitModeBucket):
 		return RateLimitModeBucket, nil
 	default:
-		return "", errors.Errorf("invalid rate limit mode %q", s)
+		return "", eris.Errorf("invalid rate limit mode %q", s)
 	}
 }
 
@@ -245,7 +245,7 @@ func ReadFromEnvironment() (Values, error) {
 	result.TargetNamespaces = parseTargetNamespaces(os.Getenv(config.TargetNamespaces))
 	result.SyncPeriod, err = parseSyncPeriod()
 	if err != nil {
-		return result, errors.Wrapf(err, "parsing %q", config.SyncPeriod)
+		return result, eris.Wrapf(err, "parsing %q", config.SyncPeriod)
 	}
 
 	result.ResourceManagerEndpoint = envOrDefault(config.ResourceManagerEndpoint, DefaultEndpoint)
@@ -296,13 +296,13 @@ func ReadAndValidate() (Values, error) {
 // Validate checks whether the configuration settings are consistent.
 func (v Values) Validate() error {
 	if v.PodNamespace == "" {
-		return errors.Errorf("missing value for %s", config.PodNamespace)
+		return eris.Errorf("missing value for %s", config.PodNamespace)
 	}
 	if !v.OperatorMode.IncludesWatchers() && len(v.TargetNamespaces) > 0 {
-		return errors.Errorf("%s must include watchers to specify target namespaces", config.TargetNamespaces)
+		return eris.Errorf("%s must include watchers to specify target namespaces", config.TargetNamespaces)
 	}
 	if v.MaxConcurrentReconciles <= 0 {
-		return errors.Errorf("%s must be at least 1", config.MaxConcurrentReconciles)
+		return eris.Errorf("%s must be at least 1", config.MaxConcurrentReconciles)
 	}
 	return nil
 }
@@ -349,19 +349,19 @@ func envParseOrDefault[T int | string | float64](env string, def T) (T, error) {
 	case int:
 		parsedVal, err := strconv.Atoi(str)
 		if err != nil {
-			return def, errors.Wrapf(err, "failed to parse value %q for %q", str, env)
+			return def, eris.Wrapf(err, "failed to parse value %q for %q", str, env)
 		}
 		result = any(parsedVal).(T)
 	case string:
 		result = any(str).(T)
 	case float64:
 		parsedVal, err := strconv.ParseFloat(str, 64)
 		if err != nil {
-			return def, errors.Wrapf(err, "failed to parse value %q for %q", str, env)
+			return def, eris.Wrapf(err, "failed to parse value %q for %q", str, env)
 		}
 		result = any(parsedVal).(T)
 	default:
-		return def, errors.Errorf("can't read unsupported type %T from env", def)
+		return def, eris.Errorf("can't read unsupported type %T from env", def)
 	}
 
 	return result, nil

v2/internal/controllers/controller_resources.go

@@ -16,7 +16,7 @@ import (
 	. "github.com/Azure/azure-service-operator/v2/internal/logging"
 
 	"github.com/go-logr/logr"
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/conversion"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -174,21 +174,21 @@ func getGeneratedStorageTypes(
 
 	err := resourceResolver.IndexStorageTypes(schemer.GetScheme(), knownStorageTypes)
 	if err != nil {
-		return nil, errors.Wrap(err, "failed add storage types to resource resolver")
+		return nil, eris.Wrap(err, "failed add storage types to resource resolver")
 	}
 
 	var extensions map[schema.GroupVersionKind]genruntime.ResourceExtension
 	extensions, err = GetResourceExtensions(schemer.GetScheme())
 	if err != nil {
-		return nil, errors.Wrap(err, "failed getting extensions")
+		return nil, eris.Wrap(err, "failed getting extensions")
 	}
 
 	for _, t := range knownStorageTypes {
 		// Use the provided GVK to construct a new runtime object of the desired concrete type.
 		var gvk schema.GroupVersionKind
 		gvk, err = apiutil.GVKForObject(t.Obj, schemer.GetScheme())
 		if err != nil {
-			return nil, errors.Wrapf(err, "creating GVK for obj %T", t.Obj)
+			return nil, eris.Wrapf(err, "creating GVK for obj %T", t.Obj)
 		}
 		extension := extensions[gvk]
 
@@ -242,7 +242,7 @@ func makeStandardPredicate() predicate.Predicate {
 func augmentWithControllerName(t *registration.StorageType) error {
 	controllerName, err := getControllerName(t.Obj)
 	if err != nil {
-		return errors.Wrapf(err, "failed to get controller name for obj %T", t.Obj)
+		return eris.Wrapf(err, "failed to get controller name for obj %T", t.Obj)
 	}
 
 	t.Name = controllerName
@@ -255,14 +255,14 @@ var groupRegex = regexp.MustCompile(`.*/v2/api/([a-zA-Z0-9.]+)/`)
 func getControllerName(obj client.Object) (string, error) {
 	v, err := conversion.EnforcePtr(obj)
 	if err != nil {
-		return "", errors.Wrap(err, "t.Obj was expected to be ptr but was not")
+		return "", eris.Wrap(err, "t.Obj was expected to be ptr but was not")
 	}
 
 	typ := v.Type()
 	pkgPath := typ.PkgPath()
 	matches := groupRegex.FindStringSubmatch(pkgPath)
 	if len(matches) == 0 {
-		return "", errors.Errorf("couldn't parse package path %s", pkgPath)
+		return "", eris.Errorf("couldn't parse package path %s", pkgPath)
 	}
 	group := strings.Replace(matches[1], ".", "", -1) // elide . for groups like network.frontdoor
 	name := fmt.Sprintf("%s_%s", group, strings.ToLower(typ.Name()))
@@ -302,7 +302,7 @@ func GetResourceExtensions(scheme *runtime.Scheme) (map[schema.GroupVersionKind]
 			// Make sure the type casting goes well, and we can extract the GVK successfully.
 			resourceObj, ok := resource.(runtime.Object)
 			if !ok {
-				err := errors.Errorf("unexpected resource type for resource '%s', found '%T'", resource.AzureName(), resource)
+				err := eris.Errorf("unexpected resource type for resource '%s', found '%T'", resource.AzureName(), resource)
 				return nil, err
 			}
 

v2/internal/crdmanagement/helpers.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 
 	"github.com/go-logr/logr"
-	"github.com/pkg/errors"
+	"github.com/rotisserie/eris"
 	apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -47,7 +47,7 @@ func FilterStorageTypesByReadyCRDs(
 		// Use the provided GVK to construct a new runtime object of the desired concrete type.
 		gvk, err := apiutil.GVKForObject(storageType.Obj, scheme)
 		if err != nil {
-			return nil, errors.Wrapf(err, "creating GVK for obj %T", storageType.Obj)
+			return nil, eris.Wrapf(err, "creating GVK for obj %T", storageType.Obj)
 		}
 
 		if !includeKinds.Contains(gvk.GroupKind()) {
@@ -80,7 +80,7 @@ func FilterKnownTypesByReadyCRDs(
 		// Use the provided GVK to construct a new runtime object of the desired concrete type.
 		gvk, err := apiutil.GVKForObject(knownType, scheme)
 		if err != nil {
-			return nil, errors.Wrapf(err, "creating GVK for obj %T", knownType)
+			return nil, eris.Wrapf(err, "creating GVK for obj %T", knownType)
 		}
 		if !includeKinds.Contains(gvk.GroupKind()) {
 			logger.V(0).Info(