Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Critical Bug]unexpectedly deleted when pruneObjectBehavior is None #142

Merged
merged 1 commit into from
Jun 15, 2023
Merged

[Critical Bug]unexpectedly deleted when pruneObjectBehavior is None #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 45 additions & 45 deletions controllers/configurationpolicy_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,10 +506,37 @@ func (r *ConfigurationPolicyReconciler) getObjectTemplateDetails(
return templateObjs, selectedNamespaces, false, nil
}

func (r *ConfigurationPolicyReconciler) cleanUpChildObjects(plc policyv1.ConfigurationPolicy) []string {
func (r *ConfigurationPolicyReconciler) cleanUpChildObjects(plc policyv1.ConfigurationPolicy,
newRelated []policyv1.RelatedObject,
) []string {
deletionFailures := []string{}

for _, object := range plc.Status.RelatedObjects {
if !strings.EqualFold(string(plc.Spec.RemediationAction), "enforce") {
return deletionFailures
}

// PruneObjectBehavior = none case fall in here
if !(string(plc.Spec.PruneObjectBehavior) == "DeleteAll" ||
string(plc.Spec.PruneObjectBehavior) == "DeleteIfCreated") {
return deletionFailures
}

objsToDelete := plc.Status.RelatedObjects

// When spec is updated and new related objects are created
if len(newRelated) != 0 {
var objShouldRemoved []policyv1.RelatedObject

for _, oldR := range objsToDelete {
if !containRelated(newRelated, oldR) {
objShouldRemoved = append(objShouldRemoved, oldR)
}
}

objsToDelete = objShouldRemoved
}

for _, object := range objsToDelete {
// set up client for object deletion
gvk := schema.FromAPIVersionAndKind(object.Object.APIVersion, object.Object.Kind)

Expand Down Expand Up @@ -555,22 +582,20 @@ func (r *ConfigurationPolicyReconciler) cleanUpChildObjects(plc policyv1.Configu
continue
}

if strings.EqualFold(string(plc.Spec.RemediationAction), "enforce") {
if string(plc.Spec.PruneObjectBehavior) == "DeleteAll" {
if string(plc.Spec.PruneObjectBehavior) == "DeleteAll" {
needsDelete = true
} else if string(plc.Spec.PruneObjectBehavior) == "DeleteIfCreated" {
// if prune behavior is DeleteIfCreated, we need to check whether createdByPolicy
// is true and the UID is not stale
uid, uidFound, err := unstructured.NestedString(existing.Object, "metadata", "uid")

if !uidFound || err != nil {
log.Error(err, "Tried to pull UID from obj but the field did not exist or was not a string")
} else if object.Properties != nil &&
object.Properties.CreatedByPolicy != nil &&
*object.Properties.CreatedByPolicy &&
object.Properties.UID == uid {
needsDelete = true
} else {
// if prune behavior is DeleteIfCreated, we need to check whether createdByPolicy
// is true and the UID is not stale
uid, uidFound, err := unstructured.NestedString(existing.Object, "metadata", "uid")

if !uidFound || err != nil {
log.Error(err, "Tried to pull UID from obj but the field did not exist or was not a string")
} else if object.Properties != nil &&
object.Properties.CreatedByPolicy != nil &&
*object.Properties.CreatedByPolicy &&
object.Properties.UID == uid {
needsDelete = true
}
}
}

Expand Down Expand Up @@ -618,7 +643,7 @@ func (r *ConfigurationPolicyReconciler) cleanUpChildObjects(plc policyv1.Configu
continue
}

log.Info("Object successfully deleted as part of child object pruning")
log.Info("Object successfully deleted as part of child object pruning or detached objects")
}
}
}
Expand Down Expand Up @@ -767,7 +792,7 @@ func (r *ConfigurationPolicyReconciler) handleObjectTemplates(plc policyv1.Confi
if plc.ObjectMeta.DeletionTimestamp != nil {
log.V(1).Info("Config policy has been deleted, handling child objects")

failures := r.cleanUpChildObjects(plc)
failures := r.cleanUpChildObjects(plc, nil)

if len(failures) == 0 {
log.V(1).Info("Objects have been successfully cleaned up, removing finalizer")
Expand Down Expand Up @@ -1302,39 +1327,14 @@ func (r *ConfigurationPolicyReconciler) sortRelatedObjectsAndUpdate(
}

if !gocmp.Equal(related, oldRelated) {
// When it is hub or managed template parse error, it should not remove previous objects
if deleteDetachedObjs {
r.deleteDetachedObj(*plc, related, oldRelated)
r.cleanUpChildObjects(*plc, related)
}

plc.Status.RelatedObjects = related
}
}

// helper function to delete unconnected objs
func (r *ConfigurationPolicyReconciler) deleteDetachedObj(plc policyv1.ConfigurationPolicy,
related, oldRelated []policyv1.RelatedObject,
) []policyv1.RelatedObject {
objShouldRemoved := []policyv1.RelatedObject{}
// Pick out only obj should be removed in oldRelated
for _, oldR := range oldRelated {
isContain := containRelated(related, oldR)

if !isContain {
objShouldRemoved = append(objShouldRemoved, oldR)
}
}

plc.Status.RelatedObjects = objShouldRemoved

// removed objs which are not related(detached) anymore
if r != nil {
r.cleanUpChildObjects(plc)
}
// For now this is for unit test
return objShouldRemoved
}

// helper function that appends a condition (violation or compliant) to the status of a configurationpolicy
// Set the index to -1 to signal that the status should be cleared.
func addConditionToStatus(
Expand Down
Loading