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.

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

Added unit tests for status and cronfederatedhpa helper utilities #5768

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
168 changes: 168 additions & 0 deletions pkg/util/helper/cronfederatedhpa_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
/*
Copyright 2024 The Karmada Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package helper

import (
"testing"

"github.com/stretchr/testify/assert"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/ptr"

autoscalingv1alpha1 "github.com/karmada-io/karmada/pkg/apis/autoscaling/v1alpha1"
)

func TestIsCronFederatedHPARuleSuspend(t *testing.T) {
tests := []struct {
name string
rule autoscalingv1alpha1.CronFederatedHPARule
expected bool
}{
{
name: "suspend is nil",
rule: autoscalingv1alpha1.CronFederatedHPARule{},
expected: false,
},
{
name: "suspend is true",
rule: autoscalingv1alpha1.CronFederatedHPARule{
Suspend: ptr.To(true),
},
expected: true,
},
{
name: "suspend is false",
rule: autoscalingv1alpha1.CronFederatedHPARule{
Suspend: ptr.To(false),
},
expected: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := IsCronFederatedHPARuleSuspend(tt.rule)
assert.Equal(t, tt.expected, result)
})
}
}

func TestGetCronFederatedHPASuccessHistoryLimits(t *testing.T) {
tests := []struct {
name string
rule autoscalingv1alpha1.CronFederatedHPARule
expected int
}{
{
name: "successful history limit is nil",
rule: autoscalingv1alpha1.CronFederatedHPARule{},
expected: 3,
},
{
name: "successful history limit is set to 5",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a code bad taste involved here. The number 3 is a devil's number in the test case, and if we can describe it in one word, we'll be more comfortable naming the test case. For example, we can change the name of the test case to successful history limit is set to bigger than xxx.

If you wish, you can resubmit a pr to modify it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that makes sense, 3 could be defined as a constant at the package level, which would make it easier to change the default value in the future if needed.

rule: autoscalingv1alpha1.CronFederatedHPARule{
SuccessfulHistoryLimit: ptr.To[int32](5),
},
expected: 5,
},
{
name: "successful history limit is set to 0",
rule: autoscalingv1alpha1.CronFederatedHPARule{
SuccessfulHistoryLimit: ptr.To[int32](0),
},
expected: 0,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := GetCronFederatedHPASuccessHistoryLimits(tt.rule)
assert.Equal(t, tt.expected, result)
})
}
}

func TestGetCronFederatedHPAFailedHistoryLimits(t *testing.T) {
tests := []struct {
name string
rule autoscalingv1alpha1.CronFederatedHPARule
expected int
}{
{
name: "failed history limit is nil",
rule: autoscalingv1alpha1.CronFederatedHPARule{},
expected: 3,
},
{
name: "failed history limit is set to 5",
rule: autoscalingv1alpha1.CronFederatedHPARule{
FailedHistoryLimit: ptr.To[int32](5),
},
expected: 5,
},
{
name: "failed history limit is set to 0",
rule: autoscalingv1alpha1.CronFederatedHPARule{
FailedHistoryLimit: ptr.To[int32](0),
},
expected: 0,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := GetCronFederatedHPAFailedHistoryLimits(tt.rule)
assert.Equal(t, tt.expected, result)
})
}
}

func TestGetCronFederatedHPAKey(t *testing.T) {
tests := []struct {
name string
cronFHPA *autoscalingv1alpha1.CronFederatedHPA
expected string
}{
{
name: "default namespace",
cronFHPA: &autoscalingv1alpha1.CronFederatedHPA{
ObjectMeta: metav1.ObjectMeta{
Name: "test-hpa",
Namespace: "default",
},
},
expected: "default/test-hpa",
},
{
name: "custom namespace",
cronFHPA: &autoscalingv1alpha1.CronFederatedHPA{
ObjectMeta: metav1.ObjectMeta{
Name: "custom-hpa",
Namespace: "karmada-system",
},
},
expected: "karmada-system/custom-hpa",
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := GetCronFederatedHPAKey(tt.cronFHPA)
assert.Equal(t, tt.expected, result)
})
}
}
Loading