lib: add lib for applying objects

Author: abhinavdahiya

lib/resourceapply/apiext.go

@@ -0,0 +1,52 @@
+package resourceapply
+
+import (
+	"github.com/openshift/cluster-version-operator/lib/resourcemerge"
+	apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
+	apiextclientv1beta1 "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/typed/apiextensions/v1beta1"
+	apiextlistersv1beta1 "k8s.io/apiextensions-apiserver/pkg/client/listers/apiextensions/v1beta1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/pointer"
+)
+
+func ApplyCustomResourceDefinition(client apiextclientv1beta1.CustomResourceDefinitionsGetter, required *apiextv1beta1.CustomResourceDefinition) (*apiextv1beta1.CustomResourceDefinition, bool, error) {
+	existing, err := client.CustomResourceDefinitions().Get(required.Name, metav1.GetOptions{})
+	if apierrors.IsNotFound(err) {
+		actual, err := client.CustomResourceDefinitions().Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureCustomResourceDefinition(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.CustomResourceDefinitions().Update(existing)
+	return actual, true, err
+}
+
+func ApplyCustomResourceDefinitionFromCache(lister apiextlistersv1beta1.CustomResourceDefinitionLister, client apiextclientv1beta1.CustomResourceDefinitionsGetter, required *apiextv1beta1.CustomResourceDefinition) (*apiextv1beta1.CustomResourceDefinition, bool, error) {
+	existing, err := lister.Get(required.Name)
+	if apierrors.IsNotFound(err) {
+		actual, err := client.CustomResourceDefinitions().Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	existing = existing.DeepCopy()
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureCustomResourceDefinition(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.CustomResourceDefinitions().Update(existing)
+	return actual, true, err
+}

lib/resourceapply/apps.go

@@ -0,0 +1,54 @@
+package resourceapply
+
+import (
+	"github.com/openshift/cluster-version-operator/lib/resourcemerge"
+	appsv1 "k8s.io/api/apps/v1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	appsclientv1 "k8s.io/client-go/kubernetes/typed/apps/v1"
+	appslisterv1 "k8s.io/client-go/listers/apps/v1"
+	"k8s.io/utils/pointer"
+)
+
+// ApplyDeployment applies the required deployment to the cluster.
+func ApplyDeployment(client appsclientv1.DeploymentsGetter, required *appsv1.Deployment) (*appsv1.Deployment, bool, error) {
+	existing, err := client.Deployments(required.Namespace).Get(required.Name, metav1.GetOptions{})
+	if apierrors.IsNotFound(err) {
+		actual, err := client.Deployments(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureDeployment(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.Deployments(required.Namespace).Update(existing)
+	return actual, true, err
+}
+
+// ApplyDeploymentFromCache applies the required deployment to the cluster.
+func ApplyDeploymentFromCache(lister appslisterv1.DeploymentLister, client appsclientv1.DeploymentsGetter, required *appsv1.Deployment) (*appsv1.Deployment, bool, error) {
+	existing, err := lister.Deployments(required.Namespace).Get(required.Name)
+	if apierrors.IsNotFound(err) {
+		actual, err := client.Deployments(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	existing = existing.DeepCopy()
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureDeployment(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.Deployments(required.Namespace).Update(existing)
+	return actual, true, err
+}

lib/resourceapply/cv.go

@@ -0,0 +1,104 @@
+package resourceapply
+
+import (
+	"fmt"
+
+	"github.com/openshift/cluster-version-operator/lib/resourcemerge"
+	"github.com/openshift/cluster-version-operator/pkg/apis/clusterversion.openshift.io/v1"
+	clientv1 "github.com/openshift/cluster-version-operator/pkg/generated/clientset/versioned/typed/clusterversion.openshift.io/v1"
+	listersv1 "github.com/openshift/cluster-version-operator/pkg/generated/listers/clusterversion.openshift.io/v1"
+	"k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/utils/pointer"
+)
+
+func ApplyOperatorStatus(client clientv1.OperatorStatusesGetter, required *v1.OperatorStatus) (*v1.OperatorStatus, bool, error) {
+	if required.Extension.Raw != nil && required.Extension.Object != nil {
+		return nil, false, fmt.Errorf("both extension.Raw and extension.Object should not be set")
+	}
+	existing, err := client.OperatorStatuses(required.Namespace).Get(required.Name, metav1.GetOptions{})
+	if errors.IsNotFound(err) {
+		actual, err := client.OperatorStatuses(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureOperatorStatus(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.OperatorStatuses(required.Namespace).Update(existing)
+	return actual, true, err
+}
+
+func ApplyOperatorStatusFromCache(lister listersv1.OperatorStatusLister, client clientv1.OperatorStatusesGetter, required *v1.OperatorStatus) (*v1.OperatorStatus, bool, error) {
+	if required.Extension.Raw != nil && required.Extension.Object != nil {
+		return nil, false, fmt.Errorf("both extension.Raw and extension.Object should not be set")
+	}
+	existing, err := lister.OperatorStatuses(required.Namespace).Get(required.Name)
+	if errors.IsNotFound(err) {
+		actual, err := client.OperatorStatuses(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	// Don't want to mutate cache.
+	existing = existing.DeepCopy()
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureOperatorStatus(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.OperatorStatuses(required.Namespace).Update(existing)
+	return actual, true, err
+}
+
+func ApplyCVOConfig(client clientv1.CVOConfigsGetter, required *v1.CVOConfig) (*v1.CVOConfig, bool, error) {
+	existing, err := client.CVOConfigs(required.Namespace).Get(required.Name, metav1.GetOptions{})
+	if errors.IsNotFound(err) {
+		actual, err := client.CVOConfigs(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureCVOConfig(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.CVOConfigs(required.Namespace).Update(existing)
+	return actual, true, err
+}
+
+func ApplyCVOConfigFromCache(lister listersv1.CVOConfigLister, client clientv1.CVOConfigsGetter, required *v1.CVOConfig) (*v1.CVOConfig, bool, error) {
+	obj, err := lister.CVOConfigs(required.Namespace).Get(required.Name)
+	if errors.IsNotFound(err) {
+		actual, err := client.CVOConfigs(required.Namespace).Create(required)
+		return actual, true, err
+	}
+	if err != nil {
+		return nil, false, err
+	}
+
+	// Don't want to mutate cache.
+	existing := new(v1.CVOConfig)
+	obj.DeepCopyInto(existing)
+	modified := pointer.BoolPtr(false)
+	resourcemerge.EnsureCVOConfig(modified, existing, *required)
+	if !*modified {
+		return existing, false, nil
+	}
+
+	actual, err := client.CVOConfigs(required.Namespace).Update(existing)
+	return actual, true, err
+}

lib/resourcemerge/apiext.go

@@ -0,0 +1,18 @@
+package resourcemerge
+
+import (
+	apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
+	"k8s.io/apimachinery/pkg/api/equality"
+)
+
+// EnsureCustomResourceDefinition ensures that the existing matches the required.
+// modified is set to true when existing had to be updated with required.
+func EnsureCustomResourceDefinition(modified *bool, existing *apiextv1beta1.CustomResourceDefinition, required apiextv1beta1.CustomResourceDefinition) {
+	EnsureObjectMeta(modified, &existing.ObjectMeta, required.ObjectMeta)
+
+	// we stomp everything
+	if !equality.Semantic.DeepEqual(existing.Spec, required.Spec) {
+		*modified = true
+		existing.Spec = required.Spec
+	}
+}

lib/resourcemerge/apps.go

@@ -0,0 +1,23 @@
+package resourcemerge
+
+import (
+	appsv1 "k8s.io/api/apps/v1"
+	"k8s.io/apimachinery/pkg/api/equality"
+)
+
+// EnsureDeployment ensures that the existing matches the required.
+// modified is set to true when existing had to be updated with required.
+func EnsureDeployment(modified *bool, existing *appsv1.Deployment, required appsv1.Deployment) {
+	EnsureObjectMeta(modified, &existing.ObjectMeta, required.ObjectMeta)
+
+	if existing.Spec.Selector == nil {
+		*modified = true
+		existing.Spec.Selector = required.Spec.Selector
+	}
+	if !equality.Semantic.DeepEqual(existing.Spec.Selector, required.Spec.Selector) {
+		*modified = true
+		existing.Spec.Selector = required.Spec.Selector
+	}
+
+	ensurePodTemplateSpec(modified, &existing.Spec.Template, required.Spec.Template)
+}