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

fix: Instability of cleanup process of old configmaps and secrets #928

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Instability of cleanup process of old configmaps and secrets #928

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
30 changes: 30 additions & 0 deletions internal/controller/common/action/result.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package action

func IsSuccess(result *Result) bool {
return IsContinue(result) || IsReturn(result)
}

func IsContinue(result *Result) bool {
return result == nil
}

func IsReturn(result *Result) bool {
if result == nil {
return false
}
return !IsError(result) && !IsRequeue(result)
}

func IsError(result *Result) bool {
if result == nil {
return false
}
return result.Err != nil
}

func IsRequeue(result *Result) bool {
if result == nil {
return false
}
return result.Result.Requeue || result.Result.RequeueAfter > 0
}
264 changes: 264 additions & 0 deletions internal/controller/common/action/result_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,264 @@
package action

import (
"errors"
"testing"
"time"

"sigs.k8s.io/controller-runtime/pkg/reconcile"
)

func TestIsContinue(t *testing.T) {
tests := []struct {
name string
arg *Result
want bool
}{
{
name: "continue",
want: true,
arg: nil,
},
{
name: "return",
want: false,
arg: &Result{},
},
{
name: "error",
want: false,
arg: &Result{Err: errors.New("error")},
},
{
name: "terminal error",
want: false,
arg: &Result{Err: reconcile.TerminalError(errors.New("error"))},
},
{
name: "requeue",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}},
},
{
name: "requeue after",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: false, RequeueAfter: 5 * time.Second}},
},
{
name: "requeue error",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}, Err: errors.New("error")},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsContinue(tt.arg); got != tt.want {
t.Errorf("IsContinue() = %v, want %v", got, tt.want)
}
})
}
}

func TestIsError(t *testing.T) {
tests := []struct {
name string
arg *Result
want bool
}{
{
name: "continue",
want: false,
arg: nil,
},
{
name: "return",
want: false,
arg: &Result{},
},
{
name: "error",
want: true,
arg: &Result{Err: errors.New("error")},
},
{
name: "terminal error",
want: true,
arg: &Result{Err: reconcile.TerminalError(errors.New("error"))},
},
{
name: "requeue",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}},
},
{
name: "requeue after",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: false, RequeueAfter: 5 * time.Second}},
},
{
name: "requeue error",
want: true,
arg: &Result{Result: reconcile.Result{Requeue: true}, Err: errors.New("error")},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsError(tt.arg); got != tt.want {
t.Errorf("IsError() = %v, want %v", got, tt.want)
}
})
}
}

func TestIsRequeue(t *testing.T) {
tests := []struct {
name string
arg *Result
want bool
}{
{
name: "continue",
want: false,
arg: nil,
},
{
name: "return",
want: false,
arg: &Result{},
},
{
name: "error",
want: false,
arg: &Result{Err: errors.New("error")},
},
{
name: "terminal error",
want: false,
arg: &Result{Err: reconcile.TerminalError(errors.New("error"))},
},
{
name: "requeue",
want: true,
arg: &Result{Result: reconcile.Result{Requeue: true}},
},
{
name: "requeue after",
want: true,
arg: &Result{Result: reconcile.Result{Requeue: false, RequeueAfter: 5 * time.Second}},
},
{
name: "requeue error",
want: true,
arg: &Result{Result: reconcile.Result{Requeue: true}, Err: errors.New("error")},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsRequeue(tt.arg); got != tt.want {
t.Errorf("IsRequeue() = %v, want %v", got, tt.want)
}
})
}
}

func TestIsReturn(t *testing.T) {
tests := []struct {
name string
arg *Result
want bool
}{
{
name: "continue",
want: false,
arg: nil,
},
{
name: "return",
want: true,
arg: &Result{},
},
{
name: "error",
want: false,
arg: &Result{Err: errors.New("error")},
},
{
name: "terminal error",
want: false,
arg: &Result{Err: reconcile.TerminalError(errors.New("error"))},
},
{
name: "requeue",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}},
},
{
name: "requeue after",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: false, RequeueAfter: 5 * time.Second}},
},
{
name: "requeue error",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}, Err: errors.New("error")},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsReturn(tt.arg); got != tt.want {
t.Errorf("IsReturn() = %v, want %v", got, tt.want)
}
})
}
}

func TestIsSuccess(t *testing.T) {
tests := []struct {
name string
arg *Result
want bool
}{
{
name: "continue",
want: true,
arg: nil,
},
{
name: "return",
want: true,
arg: &Result{},
},
{
name: "error",
want: false,
arg: &Result{Err: errors.New("error")},
},
{
name: "terminal error",
want: false,
arg: &Result{Err: reconcile.TerminalError(errors.New("error"))},
},
{
name: "requeue",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}},
},
{
name: "requeue after",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: false, RequeueAfter: 5 * time.Second}},
},
{
name: "requeue error",
want: false,
arg: &Result{Result: reconcile.Result{Requeue: true}, Err: errors.New("error")},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := IsSuccess(tt.arg); got != tt.want {
t.Errorf("IsSuccess() = %v, want %v", got, tt.want)
}
})
}
}
41 changes: 27 additions & 14 deletions internal/controller/ctlog/actions/server_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package actions

import (
"context"
"errors"
"fmt"

rhtasv1alpha1 "github.com/securesign/operator/api/v1alpha1"
Expand Down Expand Up @@ -147,13 +148,37 @@ func (i serverConfig) Handle(ctx context.Context, instance *rhtasv1alpha1.CTlog)
})
}

// try to discover existing config and clear them out
instance.Status.ServerConfigRef = &rhtasv1alpha1.LocalObjectReference{Name: newConfig.Name}

i.Recorder.Eventf(instance, corev1.EventTypeNormal, "CTLogConfigCreated", "Secret with ctlog configuration created: %s", newConfig.Name)
meta.SetStatusCondition(&instance.Status.Conditions, metav1.Condition{
Type: ConfigCondition,
Status: metav1.ConditionTrue,
Reason: constants.Ready,
Message: "Server config created",
ObservedGeneration: instance.Generation,
})
result := i.StatusUpdate(ctx, instance)
if action.IsSuccess(result) {
i.cleanup(ctx, instance, configLabels)
}
return result
}

func (i serverConfig) cleanup(ctx context.Context, instance *rhtasv1alpha1.CTlog, configLabels map[string]string) {
if instance.Status.ServerConfigRef == nil || instance.Status.ServerConfigRef.Name == "" {
i.Logger.Error(errors.New("new Secret name is empty"), "unable to clean old objects", "namespace", instance.Namespace)
return
}

// try to discover existing secrets and clear them out
partialConfigs, err := utils.ListSecrets(ctx, i.Client, instance.Namespace, labels2.SelectorFromSet(configLabels).String())
if err != nil {
i.Logger.Error(err, "problem with listing configmaps", "namespace", instance.Namespace)
return
}
for _, partialConfig := range partialConfigs.Items {
if partialConfig.Name == newConfig.Name {
if partialConfig.Name == instance.Status.ServerConfigRef.Name {
continue
}

Expand All @@ -166,18 +191,6 @@ func (i serverConfig) Handle(ctx context.Context, instance *rhtasv1alpha1.CTlog)
i.Logger.Info("Remove invalid Secret with ctlog configuration", "Name", partialConfig.Name)
i.Recorder.Eventf(instance, corev1.EventTypeNormal, "CTLogConfigDeleted", "Secret with ctlog configuration deleted: %s", partialConfig.Name)
}

instance.Status.ServerConfigRef = &rhtasv1alpha1.LocalObjectReference{Name: newConfig.Name}

i.Recorder.Eventf(instance, corev1.EventTypeNormal, "CTLogConfigCreated", "Secret with ctlog configuration created: %s", newConfig.Name)
meta.SetStatusCondition(&instance.Status.Conditions, metav1.Condition{
Type: ConfigCondition,
Status: metav1.ConditionTrue,
Reason: constants.Ready,
Message: "Server config created",
ObservedGeneration: instance.Generation,
})
return i.StatusUpdate(ctx, instance)
}

func (i serverConfig) handlePrivateKey(instance *rhtasv1alpha1.CTlog) (*ctlogUtils.KeyConfig, error) {
Expand Down
Loading
Loading