bumped to operator utils v1.1.2 (#91)

improved context propagation
fixed #90

Signed-off-by: raffaelespazzoli <[email protected]>

Author: raffaelespazzoli

README.md

@@ -141,6 +141,8 @@ spec:
 
 Although not enforced by the operator the general expectation is that the NamespaceConfig CR will be used to create objects inside the selected namespace.
 
+The `default` namespace and all namespaces starting with either `kube-` or `openshift-` are never considered by this operator. This is a safety feature to ensure that this operator does not interfere with the core of the system.
+
 Examples of NamespaceConfig usages can be found [here](./examples/namespace-config/readme.md)
 
 ## GroupConfig

controllers/groupconfig_controller.go

@@ -106,7 +106,7 @@ func (r *GroupConfigReconciler) Reconcile(context context.Context, req ctrl.Requ
 	}
 
 	//get selected users
-	selectedGroups, err := r.getSelectedGroups(instance)
+	selectedGroups, err := r.getSelectedGroups(context, instance)
 	if err != nil {
 		log.Error(err, "unable to get groups selected by", "GroupConfig", instance)
 		return r.ManageError(context, instance, err)
@@ -140,7 +140,7 @@ func (r *GroupConfigReconciler) getResourceList(instance *redhatcopv1alpha1.Grou
 	return lockedresources, nil
 }
 
-func (r *GroupConfigReconciler) getSelectedGroups(instance *redhatcopv1alpha1.GroupConfig) ([]userv1.Group, error) {
+func (r *GroupConfigReconciler) getSelectedGroups(context context.Context, instance *redhatcopv1alpha1.GroupConfig) ([]userv1.Group, error) {
 	groupList := &userv1.GroupList{}
 
 	labelSelector, err := metav1.LabelSelectorAsSelector(&instance.Spec.LabelSelector)
@@ -155,7 +155,7 @@ func (r *GroupConfigReconciler) getSelectedGroups(instance *redhatcopv1alpha1.Gr
 		return []userv1.Group{}, err
 	}
 
-	err = r.GetClient().List(context.TODO(), groupList, &client.ListOptions{
+	err = r.GetClient().List(context, groupList, &client.ListOptions{
 		LabelSelector: labelSelector,
 	})
 	if err != nil {

controllers/namespaceconfig_controller.go

@@ -64,7 +64,7 @@ type NamespaceConfigReconciler struct {
 // - https://pkg.go.dev/sigs.k8s.io/[email protected]/pkg/reconcile
 func (r *NamespaceConfigReconciler) Reconcile(context context.Context, req ctrl.Request) (ctrl.Result, error) {
 	log := r.Log.WithValues("namespaceconfig", req.NamespacedName)
-
+	log.Info("reconciling started")
 	// Fetch the NamespaceConfig instance
 	instance := &redhatcopv1alpha1.NamespaceConfig{}
 	err := r.GetClient().Get(context, req.NamespacedName, instance)
@@ -78,7 +78,6 @@ func (r *NamespaceConfigReconciler) Reconcile(context context.Context, req ctrl.
 		// Error reading the object - requeue the request.
 		return reconcile.Result{}, err
 	}
-
 	if !r.IsInitialized(instance) {
 		err := r.GetClient().Update(context, instance)
 		if err != nil {
@@ -105,9 +104,8 @@ func (r *NamespaceConfigReconciler) Reconcile(context context.Context, req ctrl.
 		}
 		return reconcile.Result{}, nil
 	}
-
-	//get selected users
-	selectedNamespaces, err := r.getSelectedNamespaces(instance)
+	//get selected namespaces
+	selectedNamespaces, err := r.getSelectedNamespaces(context, instance)
 	if err != nil {
 		log.Error(err, "unable to get namespaces selected by", "NamespaceConfig", instance)
 		return r.ManageError(context, instance, err)
@@ -172,7 +170,7 @@ func (r *NamespaceConfigReconciler) getResourceList(instance *redhatcopv1alpha1.
 	return lockedresources, nil
 }
 
-func (r *NamespaceConfigReconciler) getSelectedNamespaces(namespaceconfig *redhatcopv1alpha1.NamespaceConfig) ([]corev1.Namespace, error) {
+func (r *NamespaceConfigReconciler) getSelectedNamespaces(context context.Context, namespaceconfig *redhatcopv1alpha1.NamespaceConfig) ([]corev1.Namespace, error) {
 	nl := corev1.NamespaceList{}
 	selector, err := metav1.LabelSelectorAsSelector(&namespaceconfig.Spec.LabelSelector)
 	if err != nil {
@@ -186,7 +184,7 @@ func (r *NamespaceConfigReconciler) getSelectedNamespaces(namespaceconfig *redha
 		return []corev1.Namespace{}, err
 	}
 
-	err = r.GetClient().List(context.TODO(), &nl, &client.ListOptions{LabelSelector: selector})
+	err = r.GetClient().List(context, &nl, &client.ListOptions{LabelSelector: selector})
 	if err != nil {
 		r.Log.Error(err, "unable to list namespaces with selector", "selector", selector)
 		return []corev1.Namespace{}, err
@@ -239,7 +237,7 @@ func (r *NamespaceConfigReconciler) findApplicableNameSpaceConfigs(namespace cor
 }
 
 func isProhibitedNamespaceName(name string) bool {
-	return name == "default" || strings.HasPrefix(name, "openshift") || strings.HasPrefix(name, "kube")
+	return name == "default" || strings.HasPrefix(name, "openshift-") || strings.HasPrefix(name, "kube-")
 }
 
 // SetupWithManager sets up the controller with the Manager.

controllers/userconfig_controller.go

@@ -107,7 +107,7 @@ func (r *UserConfigReconciler) Reconcile(context context.Context, req ctrl.Reque
 	}
 
 	//get selected users
-	selectedUsers, err := r.getSelectedUsers(instance)
+	selectedUsers, err := r.getSelectedUsers(context, instance)
 	if err != nil {
 		log.Error(err, "unable to get users selected by", "UserConfig", instance)
 		return r.ManageError(context, instance, err)
@@ -141,17 +141,17 @@ func (r *UserConfigReconciler) getResourceList(instance *redhatcopv1alpha1.UserC
 	return lockedresources, nil
 }
 
-func (r *UserConfigReconciler) getSelectedUsers(instance *redhatcopv1alpha1.UserConfig) ([]userv1.User, error) {
+func (r *UserConfigReconciler) getSelectedUsers(context context.Context, instance *redhatcopv1alpha1.UserConfig) ([]userv1.User, error) {
 	userList := &userv1.UserList{}
 	identitiesList := &userv1.IdentityList{}
 
-	err := r.GetClient().List(context.TODO(), userList, &client.ListOptions{})
+	err := r.GetClient().List(context, userList, &client.ListOptions{})
 	if err != nil {
 		r.Log.Error(err, "unable to get all users")
 		return []userv1.User{}, err
 	}
 
-	err = r.GetClient().List(context.TODO(), identitiesList, &client.ListOptions{})
+	err = r.GetClient().List(context, identitiesList, &client.ListOptions{})
 	if err != nil {
 		r.Log.Error(err, "unable to get all identities")
 		return []userv1.User{}, err

go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/onsi/ginkgo v1.14.1
 	github.com/onsi/gomega v1.10.2
 	github.com/openshift/api v3.9.0+incompatible
-	github.com/redhat-cop/operator-utils v1.0.0
+	github.com/redhat-cop/operator-utils v1.1.2
 	github.com/scylladb/go-set v1.0.2
 	k8s.io/api v0.20.0
 	k8s.io/apimachinery v0.20.0

go.sum

@@ -451,8 +451,8 @@ github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4O
 github.com/prometheus/procfs v0.2.0 h1:wH4vA7pcjKuZzjF7lM8awk4fnuJO6idemZXoKnULUx4=
 github.com/prometheus/procfs v0.2.0/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
 github.com/prometheus/tsdb v0.7.1/go.mod h1:qhTCs0VvXwvX/y3TZrWD7rabWM+ijKTux40TwIPHuXU=
-github.com/redhat-cop/operator-utils v1.0.0 h1:h6/0vvWny3Ac6RtR8p6ds4x7ZIz6L7JF6czxV9T/tpE=
-github.com/redhat-cop/operator-utils v1.0.0/go.mod h1:8YX6iLy5xOOY9VF6PT5xjv7Tul249ALwnQFXS206Sss=
+github.com/redhat-cop/operator-utils v1.1.2 h1:jQjQs3U5ayzHPNFfiadEFmH/z/oE3OFJLJ9Kv++KH8U=
+github.com/redhat-cop/operator-utils v1.1.2/go.mod h1:d/7g1ZoiKNDjRjgUsqn7jzrWHKNCX2RNDbPmgXUgJN0=
 github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
 github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=

main.go

@@ -83,15 +83,15 @@ func main() {
 	}
 
 	if err = (&controllers.NamespaceConfigReconciler{
-		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetEventRecorderFor("NamespaceConfig_controller"), true),
+		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetAPIReader(), mgr.GetEventRecorderFor("NamespaceConfig_controller"), true),
 		Log:                 ctrl.Log.WithName("controllers").WithName("NamespaceConfig"),
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "NamespaceConfig")
 		os.Exit(1)
 	}
 
 	userConfigController := &controllers.UserConfigReconciler{
-		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetEventRecorderFor("UserConfig_controller"), true),
+		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetAPIReader(), mgr.GetEventRecorderFor("UserConfig_controller"), true),
 		Log:                 ctrl.Log.WithName("controllers").WithName("UserConfig"),
 	}
 
@@ -112,7 +112,7 @@ func main() {
 	}
 
 	groupConfigController := &controllers.GroupConfigReconciler{
-		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetEventRecorderFor("GroupConfig_controller"), true),
+		EnforcingReconciler: lockedresourcecontroller.NewEnforcingReconciler(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetAPIReader(), mgr.GetEventRecorderFor("GroupConfig_controller"), true),
 		Log:                 ctrl.Log.WithName("controllers").WithName("GroupConfig"),
 	}