improve: add meaningful context to error returns

Author: moko-poi

pkg/cloudprovider/cloudprovider.go

@@ -251,7 +251,7 @@ func (c *CloudProvider) GetInstanceTypes(ctx context.Context, nodePool *karpv1.N
 
 	nodeClass, err := c.resolveNodeClassFromNodePool(ctx, nodePool)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to resolve NodeClass from NodePool %s: %w", nodePool.Name, err)
 	}
 
 	capiInstanceTypes, err := c.findInstanceTypesForNodeClass(ctx, nodeClass)
@@ -299,7 +299,7 @@ func (c *CloudProvider) List(ctx context.Context) ([]*karpv1.NodeClaim, error) {
 	for _, machine := range machines {
 		nodeClaim, err := c.machineToNodeClaim(ctx, machine)
 		if err != nil {
-			return []*karpv1.NodeClaim{}, err
+			return []*karpv1.NodeClaim{}, fmt.Errorf("unable to convert Machine %s to NodeClaim: %w", machine.Name, err)
 		}
 		nodeClaims = append(nodeClaims, nodeClaim)
 	}
@@ -326,7 +326,7 @@ func (c *CloudProvider) machineDeploymentFromMachine(ctx context.Context, machin
 
 	machineDeployment, err := c.machineDeploymentProvider.Get(ctx, mdName, machine.GetNamespace())
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to get MachineDeployment %s for Machine %s: %w", mdName, machine.GetName(), err)
 	}
 
 	return machineDeployment, nil
@@ -341,7 +341,7 @@ func (c *CloudProvider) findInstanceTypesForNodeClass(ctx context.Context, nodeC
 
 	machineDeployments, err := c.machineDeploymentProvider.List(ctx, nodeClass.Spec.ScalableResourceSelector)
 	if err != nil {
-		return instanceTypes, err
+		return instanceTypes, fmt.Errorf("unable to list MachineDeployments for NodeClass %s: %w", nodeClass.Name, err)
 	}
 
 	for _, md := range machineDeployments {
@@ -458,7 +458,7 @@ func (c *CloudProvider) resolveNodeClassFromNodeClaim(ctx context.Context, nodeC
 	// if the kind and version differ from the included api then we will need to load differently.
 	// NodeClass and NodeClaim are not namespace scoped, this call can probably be changed.
 	if err := c.kubeClient.Get(ctx, client.ObjectKey{Name: name, Namespace: nodeClaim.Namespace}, nodeClass); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to get NodeClass %s for NodeClaim %s: %w", name, nodeClaim.Name, err)
 	}
 
 	return nodeClass, nil
@@ -483,7 +483,7 @@ func (c *CloudProvider) resolveNodeClassFromNodePool(ctx context.Context, nodePo
 	// TODO (elmiko) add extra logic to get different resources from the class ref
 	// if the kind and version differ from the included api then we will need to load differently.
 	if err := c.kubeClient.Get(ctx, client.ObjectKey{Name: name, Namespace: nodePool.Namespace}, nodeClass); err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to get NodeClass %s for NodePool %s: %w", name, nodePool.Name, err)
 	}
 
 	return nodeClass, nil

pkg/controllers/nodeclass/status/controller.go

@@ -18,6 +18,7 @@ package status
 
 import (
 	"context"
+	"fmt"
 
 	"github.com/awslabs/operatorpkg/status"
 	"k8s.io/apimachinery/pkg/api/equality"
@@ -63,7 +64,7 @@ func (c *Controller) Reconcile(ctx context.Context, nodeClass *v1alpha1.ClusterA
 			if errors.IsConflict(err) {
 				return reconcile.Result{Requeue: true}, nil
 			}
-			return reconcile.Result{}, err
+			return reconcile.Result{}, fmt.Errorf("unable to patch NodeClass status for %s: %w", nodeClass.Name, err)
 		}
 	}
 

pkg/operator/operator.go

@@ -18,6 +18,7 @@ package operator
 
 import (
 	"context"
+	"fmt"
 	"log"
 
 	"github.com/samber/lo"
@@ -73,18 +74,18 @@ func NewOperator(ctx context.Context, operator *operator.Operator) (context.Cont
 func buildManagementClusterKubeClient(ctx context.Context, operator *operator.Operator) (client.Client, error) {
 	clusterAPIKubeConfig, err := buildClusterCAPIKubeConfig(ctx)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to build cluster API kube config: %w", err)
 	}
 
 	if clusterAPIKubeConfig != nil {
 		mgmtCluster, err := cluster.New(clusterAPIKubeConfig, func(o *cluster.Options) {
 			o.Scheme = operator.GetScheme()
 		})
 		if err != nil {
-			return nil, err
+			return nil, fmt.Errorf("unable to create new cluster for management cluster: %w", err)
 		}
 		if err = operator.Add(mgmtCluster); err != nil {
-			return nil, err
+			return nil, fmt.Errorf("unable to add management cluster to operator: %w", err)
 		}
 		return mgmtCluster.GetClient(), nil
 	}

pkg/providers/machine/machine.go

@@ -79,7 +79,7 @@ func (p *DefaultProvider) List(ctx context.Context, selector *metav1.LabelSelect
 	machineList := &capiv1beta1.MachineList{}
 	err := p.kubeClient.List(ctx, machineList, listOptions...)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to list machines with selector: %w", err)
 	}
 
 	for _, m := range machineList.Items {

pkg/providers/machinedeployment/machinedeployment.go

@@ -47,8 +47,9 @@ func (p *DefaultProvider) Get(ctx context.Context, name string, namespace string
 	err := p.kubeClient.Get(ctx, client.ObjectKey{Name: name, Namespace: namespace}, machineDeployment)
 	if err != nil {
 		machineDeployment = nil
+		return machineDeployment, fmt.Errorf("unable to get MachineDeployment %s in namespace %s: %w", name, namespace, err)
 	}
-	return machineDeployment, err
+	return machineDeployment, nil
 }
 
 func (p *DefaultProvider) List(ctx context.Context, selector *metav1.LabelSelector) ([]*capiv1beta1.MachineDeployment, error) {
@@ -70,7 +71,7 @@ func (p *DefaultProvider) List(ctx context.Context, selector *metav1.LabelSelect
 	machineDeploymentList := &capiv1beta1.MachineDeploymentList{}
 	err := p.kubeClient.List(ctx, machineDeploymentList, listOptions...)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("unable to list MachineDeployments with selector: %w", err)
 	}
 
 	for _, m := range machineDeploymentList.Items {