Skip to content

controller/workload: Clean up status reporting helpers and test infrastructure #2197

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

Merged
openshift-merge-bot merged 1 commit into from
May 6, 2026
Merged

controller/workload: Clean up status reporting helpers and test infrastructure #2197

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
16 changes: 7 additions & 9 deletions pkg/operator/apiserver/controller/workload/workload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
corev1listers "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"k8s.io/utils/ptr"

operatorv1 "github.com/openshift/api/operator/v1"
applyoperatorv1 "github.com/openshift/client-go/operator/applyconfigurations/operator/v1"
Expand Down Expand Up @@ -218,8 +219,8 @@ func (c *Controller) updateOperatorStatus(ctx context.Context, previousStatus *o

if !preconditionsReady {
var message string
for _, err := range errs {
message = message + err.Error() + "\n"
if err := errors.Join(errs...); err != nil {
message = err.Error()
}
if len(message) == 0 {
message = "the operator didn't specify what preconditions are missing"
Expand Down Expand Up @@ -249,9 +250,9 @@ func (c *Controller) updateOperatorStatus(ctx context.Context, previousStatus *o
}

if len(errs) > 0 {
message := ""
for _, err := range errs {
message = message + err.Error() + "\n"
var message string
if err := errors.Join(errs...); err != nil {
message = err.Error()
}
workloadDegradedCondition = workloadDegradedCondition.
WithStatus(operatorv1.ConditionTrue).
Expand Down Expand Up @@ -298,10 +299,7 @@ func (c *Controller) updateOperatorStatus(ctx context.Context, previousStatus *o
WithReason("AsExpected")
}

desiredReplicas := int32(1)
if workload.Spec.Replicas != nil {
desiredReplicas = *(workload.Spec.Replicas)
}
desiredReplicas := ptr.Deref(workload.Spec.Replicas, 1)

// If the workload is up to date, then we are no longer progressing
workloadAtHighestGeneration := workload.ObjectMeta.Generation == workload.Status.ObservedGeneration
Expand Down
37 changes: 16 additions & 21 deletions pkg/operator/apiserver/controller/workload/workload_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/: could not be retrieved",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand All @@ -112,7 +112,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
{
Type: fmt.Sprintf("%sWorkloadDegraded", defaultControllerName),
Status: operatorv1.ConditionTrue,
Message: "nasty error\n",
Message: "nasty error",
Reason: "SyncError",
},
{
Expand All @@ -129,7 +129,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/: could not be retrieved",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand All @@ -140,7 +140,6 @@ func TestUpdateOperatorStatus(t *testing.T) {
Namespace: "openshift-apiserver",
},
Spec: appsv1.DeploymentSpec{
Template: corev1.PodTemplateSpec{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"foo": "bar"}}},
Replicas: ptr.To[int32](3),
},
Status: appsv1.DeploymentStatus{
Expand All @@ -152,7 +151,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
},
pods: []*corev1.Pod{
{
ObjectMeta: metav1.ObjectMeta{Name: "apiserver", Namespace: "openshift-apiserver", Labels: map[string]string{"foo": "bar"}},
ObjectMeta: metav1.ObjectMeta{Name: "apiserver", Namespace: "openshift-apiserver"},
Status: corev1.PodStatus{
Phase: corev1.PodPending,
ContainerStatuses: []corev1.ContainerStatus{
Expand Down Expand Up @@ -203,7 +202,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: 0/3 pods have been updated to the latest generation and 0/3 pods are available",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand All @@ -214,7 +213,6 @@ func TestUpdateOperatorStatus(t *testing.T) {
Namespace: "openshift-apiserver",
},
Spec: appsv1.DeploymentSpec{
Template: corev1.PodTemplateSpec{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"foo": "bar"}}},
Replicas: ptr.To[int32](3),
},
Status: appsv1.DeploymentStatus{
Expand All @@ -226,7 +224,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
},
pods: []*corev1.Pod{
{
ObjectMeta: metav1.ObjectMeta{Name: "apiserver", Namespace: "openshift-apiserver", Labels: map[string]string{"foo": "bar"}},
ObjectMeta: metav1.ObjectMeta{Name: "apiserver", Namespace: "openshift-apiserver"},
Status: corev1.PodStatus{
Phase: corev1.PodPending,
ContainerStatuses: []corev1.ContainerStatus{
Expand Down Expand Up @@ -276,7 +274,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: 0/3 pods have been updated to the latest generation and 0/3 pods are available",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand All @@ -287,7 +285,6 @@ func TestUpdateOperatorStatus(t *testing.T) {
Namespace: "openshift-apiserver",
},
Spec: appsv1.DeploymentSpec{
Template: corev1.PodTemplateSpec{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"foo": "bar"}}},
Replicas: ptr.To[int32](3),
},
Status: appsv1.DeploymentStatus{
Expand Down Expand Up @@ -343,7 +340,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand Down Expand Up @@ -389,7 +386,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand Down Expand Up @@ -439,7 +436,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: observed generation is 99, desired generation is 100.",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},

Expand Down Expand Up @@ -490,7 +487,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: observed generation is 99, desired generation is 100.",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand Down Expand Up @@ -523,7 +520,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "the operator didn't specify what preconditions are missing",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand Down Expand Up @@ -573,7 +570,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: 1/3 pods have been updated to the latest generation and 2/3 pods are available",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand Down Expand Up @@ -624,7 +621,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Reason: "AsExpected",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
{
Expand All @@ -635,8 +632,6 @@ func TestUpdateOperatorStatus(t *testing.T) {
Namespace: "openshift-apiserver",
},
Spec: appsv1.DeploymentSpec{
Selector: &metav1.LabelSelector{MatchLabels: map[string]string{"foo": "bar"}},
Template: corev1.PodTemplateSpec{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"foo": "bar"}}},
Replicas: ptr.To[int32](3),
},
Status: appsv1.DeploymentStatus{
Expand Down Expand Up @@ -673,7 +668,7 @@ func TestUpdateOperatorStatus(t *testing.T) {
Message: "deployment/apiserver.openshift-apiserver: 3/3 pods have been updated to the latest generation and 2/3 pods are available",
},
}
return areCondidtionsEqual(expectedConditions, actualStatus.Conditions)
return areConditionsEqual(expectedConditions, actualStatus.Conditions)
},
},
}
Expand Down Expand Up @@ -756,7 +751,7 @@ func (f *fakePodLister) Pods(namespace string) corev1listers.PodNamespaceLister
}
}

func areCondidtionsEqual(expectedConditions []operatorv1.OperatorCondition, actualConditions []operatorv1.OperatorCondition) error {
func areConditionsEqual(expectedConditions []operatorv1.OperatorCondition, actualConditions []operatorv1.OperatorCondition) error {
if len(expectedConditions) != len(actualConditions) {
return fmt.Errorf("expected %d conditions but got %d", len(expectedConditions), len(actualConditions))
}
Expand Down