ocm: increased placement binding coverage (rh-ecosystem-edge#550)

This PR adds unit tests for list and validate for the placement binding resource in the OCM package. It also removes the PlacementBinding from the clients package.

Author: klaskosk

pkg/clients/clients.go

@@ -75,7 +75,6 @@ import (
 	"k8s.io/client-go/kubernetes/scheme"
 	coreV1Client "k8s.io/client-go/kubernetes/typed/core/v1"
 	storageV1Client "k8s.io/client-go/kubernetes/typed/storage/v1"
-	policiesv1 "open-cluster-management.io/governance-policy-propagator/api/v1"
 
 	plumbingv1 "github.com/k8snetworkplumbingwg/multi-networkpolicy/pkg/apis/k8s.cni.cncf.io/v1beta1"
 	fakeMultiNetPolicyClient "github.com/k8snetworkplumbingwg/multi-networkpolicy/pkg/client/clientset/versioned/fake"
@@ -352,10 +351,6 @@ func SetScheme(crScheme *runtime.Scheme) error {
 		return err
 	}
 
-	if err := policiesv1.AddToScheme(crScheme); err != nil {
-		return err
-	}
-
 	if err := cguapiv1alpha1.AddToScheme(crScheme); err != nil {
 		return err
 	}
@@ -528,8 +523,6 @@ func GetTestClients(tcp TestClientParams) *Settings {
 			genericClientObjects = append(genericClientObjects, v)
 		case *routev1.Route:
 			genericClientObjects = append(genericClientObjects, v)
-		case *policiesv1.PlacementBinding:
-			genericClientObjects = append(genericClientObjects, v)
 		case *policiesv1beta1.PolicySet:
 			genericClientObjects = append(genericClientObjects, v)
 		case *configV1.Node:

pkg/ocm/placementbinding.go

@@ -20,7 +20,7 @@ type PlacementBindingBuilder struct {
 	// created placementBinding object.
 	Object *policiesv1.PlacementBinding
 	// api client to interact with the cluster.
-	apiClient *clients.Settings
+	apiClient runtimeclient.Client
 	// used to store latest error message upon defining or mutating placementBinding definition.
 	errorMsg string
 }
@@ -36,8 +36,21 @@ func NewPlacementBindingBuilder(
 		"Initializing new placement binding structure with the following params: name: %s, nsname: %s",
 		name, nsname)
 
+	if apiClient == nil {
+		glog.V(100).Info("The apiClient of the PlacementBinding is nil")
+
+		return nil
+	}
+
+	err := apiClient.AttachScheme(policiesv1.AddToScheme)
+	if err != nil {
+		glog.V(100).Info("Failed to add PlacementBinding scheme to client schemes")
+
+		return nil
+	}
+
 	builder := PlacementBindingBuilder{
-		apiClient: apiClient,
+		apiClient: apiClient.Client,
 		Definition: &policiesv1.PlacementBinding{
 			ObjectMeta: metav1.ObjectMeta{
 				Name:      name,
@@ -77,8 +90,15 @@ func PullPlacementBinding(apiClient *clients.Settings, name, nsname string) (*Pl
 		return nil, fmt.Errorf("placementBinding's 'apiClient' cannot be empty")
 	}
 
+	err := apiClient.AttachScheme(policiesv1.AddToScheme)
+	if err != nil {
+		glog.V(100).Info("Failed to add PlacementBinding scheme to client schemes")
+
+		return nil, err
+	}
+
 	builder := PlacementBindingBuilder{
-		apiClient: apiClient,
+		apiClient: apiClient.Client,
 		Definition: &policiesv1.PlacementBinding{
 			ObjectMeta: metav1.ObjectMeta{
 				Name:      name,
@@ -196,23 +216,29 @@ func (builder *PlacementBindingBuilder) Update(force bool) (*PlacementBindingBui
 		return builder, err
 	}
 
+	if !builder.Exists() {
+		glog.V(100).Infof(
+			"PlacementBinding %s does not exist in namespace %s", builder.Definition.Name, builder.Definition.Namespace)
+
+		return nil, fmt.Errorf("cannot update non-existent placementBinding")
+	}
+
 	glog.V(100).Infof("Updating the placementBinding object: %s in namespace: %s",
 		builder.Definition.Name, builder.Definition.Namespace)
 
+	builder.Definition.ResourceVersion = builder.Object.ResourceVersion
 	err := builder.apiClient.Update(context.TODO(), builder.Definition)
 
 	if err != nil {
 		if force {
 			glog.V(100).Infof(
-				"Failed to update the placementBinding object %s. "+
-					"Note: Force flag set, executed delete/create methods instead", builder.Definition.Name)
+				msg.FailToUpdateNotification("placementBinding", builder.Definition.Name, builder.Definition.Namespace))
 
 			builder, err := builder.Delete()
+			builder.Definition.ResourceVersion = ""
 
 			if err != nil {
-				glog.V(100).Infof(
-					"Failed to update the placementBinding object %s, "+
-						"due to error in delete function", builder.Definition.Name)
+				glog.V(100).Infof(msg.FailToUpdateError("placementBinding", builder.Definition.Name, builder.Definition.Namespace))
 
 				return nil, err
 			}
@@ -221,9 +247,7 @@ func (builder *PlacementBindingBuilder) Update(force bool) (*PlacementBindingBui
 		}
 	}
 
-	if err == nil {
-		builder.Object = builder.Definition
-	}
+	builder.Object = builder.Definition
 
 	return builder, err
 }

pkg/ocm/placementbindingList.go

@@ -14,6 +14,19 @@ import (
 func ListPlacementBindingsInAllNamespaces(apiClient *clients.Settings,
 	options ...runtimeclient.ListOptions) (
 	[]*PlacementBindingBuilder, error) {
+	if apiClient == nil {
+		glog.V(100).Info("PlacementBindings 'apiClient' parameter cannot be nil")
+
+		return nil, fmt.Errorf("failed to list placementBindings, 'apiClient' parameter is nil")
+	}
+
+	err := apiClient.AttachScheme(policiesv1.AddToScheme)
+	if err != nil {
+		glog.V(100).Info("Failed to add PlacementBinding scheme to client schemes")
+
+		return nil, err
+	}
+
 	logMessage := string("Listing all placementBindings in all namespaces")
 	passedOptions := runtimeclient.ListOptions{}
 
@@ -30,9 +43,8 @@ func ListPlacementBindingsInAllNamespaces(apiClient *clients.Settings,
 
 	glog.V(100).Infof(logMessage)
 
-	placementBindingList := &policiesv1.PlacementBindingList{}
-
-	err := apiClient.Client.List(context.TODO(), placementBindingList, &passedOptions)
+	placementBindingList := new(policiesv1.PlacementBindingList)
+	err = apiClient.Client.List(context.TODO(), placementBindingList, &passedOptions)
 
 	if err != nil {
 		glog.V(100).Infof("Failed to list all placementBindings in all namespaces due to %s", err.Error())
@@ -45,7 +57,7 @@ func ListPlacementBindingsInAllNamespaces(apiClient *clients.Settings,
 	for _, placementBinding := range placementBindingList.Items {
 		copiedplacementBinding := placementBinding
 		placementBinding := &PlacementBindingBuilder{
-			apiClient:  apiClient,
+			apiClient:  apiClient.Client,
 			Object:     &copiedplacementBinding,
 			Definition: &copiedplacementBinding,
 		}