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

Refactor core/pod tests #1890

Merged
merged 1 commit into from
Aug 21, 2023
Merged
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
150 changes: 85 additions & 65 deletions pkg/controller.v1/common/pod_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,90 +19,110 @@ import (

apiv1 "github.com/kubeflow/training-operator/pkg/apis/kubeflow.org/v1"
"github.com/kubeflow/training-operator/pkg/core"
testjobv1 "github.com/kubeflow/training-operator/test_job/apis/test_job/v1"
v12 "github.com/kubeflow/training-operator/test_job/test_util/v1"

"github.com/stretchr/testify/assert"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestSetRestartPolicy(t *testing.T) {
type tc struct {
testJob *testjobv1.TestJob
testCases := map[string]struct {
replicaSpec *apiv1.ReplicaSpec
expectedRestartPolicy v1.RestartPolicy
expectedType testjobv1.TestReplicaType
}{
"restartPolicy is ExitCode": {
replicaSpec: &apiv1.ReplicaSpec{
RestartPolicy: apiv1.RestartPolicyExitCode,
},
expectedRestartPolicy: v1.RestartPolicyNever,
},
"restartPolicy is Never": {
replicaSpec: &apiv1.ReplicaSpec{
RestartPolicy: apiv1.RestartPolicyNever,
},
expectedRestartPolicy: v1.RestartPolicyNever,
},
"restartPolicy is Always": {
replicaSpec: &apiv1.ReplicaSpec{
RestartPolicy: apiv1.RestartPolicyAlways,
},
expectedRestartPolicy: v1.RestartPolicyAlways,
},
"restartPolicy is OnFailure": {
replicaSpec: &apiv1.ReplicaSpec{
RestartPolicy: apiv1.RestartPolicyOnFailure,
},
expectedRestartPolicy: v1.RestartPolicyOnFailure,
},
}
testCase := []tc{
func() tc {
tj := v12.NewTestJob(2)
tj.Spec.TestReplicaSpecs[testjobv1.TestReplicaTypeWorker].RestartPolicy = apiv1.RestartPolicyExitCode
return tc{
testJob: tj,
expectedRestartPolicy: v1.RestartPolicyNever,
expectedType: testjobv1.TestReplicaTypeWorker,
}
}(),
func() tc {
tj := v12.NewTestJob(2)
tj.Spec.TestReplicaSpecs[testjobv1.TestReplicaTypeWorker].RestartPolicy = apiv1.RestartPolicyNever
return tc{
testJob: tj,
expectedRestartPolicy: v1.RestartPolicyNever,
expectedType: testjobv1.TestReplicaTypeWorker,
}
}(),
func() tc {
tj := v12.NewTestJob(2)
tj.Spec.TestReplicaSpecs[testjobv1.TestReplicaTypeWorker].RestartPolicy = apiv1.RestartPolicyAlways
return tc{
testJob: tj,
expectedRestartPolicy: v1.RestartPolicyAlways,
expectedType: testjobv1.TestReplicaTypeWorker,
}
}(),
func() tc {
tj := v12.NewTestJob(2)
tj.Spec.TestReplicaSpecs[testjobv1.TestReplicaTypeWorker].RestartPolicy = apiv1.RestartPolicyOnFailure
return tc{
testJob: tj,
expectedRestartPolicy: v1.RestartPolicyOnFailure,
expectedType: testjobv1.TestReplicaTypeWorker,
for name, tc := range testCases {
t.Run(name, func(t *testing.T) {
podTemplate := &tc.replicaSpec.Template
core.SetRestartPolicy(podTemplate, tc.replicaSpec)
if podTemplate.Spec.RestartPolicy != tc.expectedRestartPolicy {
t.Errorf("Unexpected restartPolicy from SetRetartPolicy:\nwant:%v\ngot:%v\n", tc.expectedRestartPolicy, podTemplate.Spec.RestartPolicy)
}
}(),
}
for _, c := range testCase {
spec := c.testJob.Spec.TestReplicaSpecs[c.expectedType]
podTemplate := spec.Template
core.SetRestartPolicy(&podTemplate, spec)
if podTemplate.Spec.RestartPolicy != c.expectedRestartPolicy {
t.Errorf("Expected %s, got %s", c.expectedRestartPolicy, podTemplate.Spec.RestartPolicy)
}
})
}
}

func TestIsCustomSchedulerSet(t *testing.T) {
gangSchedulerName := "test-gang-scheduler"
replicaSpecs := map[apiv1.ReplicaType]*apiv1.ReplicaSpec{}
assert.False(t, isCustomSchedulerSet(replicaSpecs, gangSchedulerName))

replicaSpecs[apiv1.ReplicaType(testjobv1.TestReplicaTypeWorker)] = &apiv1.ReplicaSpec{
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
SchedulerName: gangSchedulerName,
testCases := map[string]struct {
replicaSpecs map[apiv1.ReplicaType]*apiv1.ReplicaSpec
gangSchedulerName string
want bool
}{
"replicaSpecs aren't set custom schedulerName": {
replicaSpecs: map[apiv1.ReplicaType]*apiv1.ReplicaSpec{
apiv1.ReplicaType("A"): {},
apiv1.ReplicaType("B"): {},
},
gangSchedulerName: "alpha",
want: false,
},
}
assert.False(t, isCustomSchedulerSet(replicaSpecs, gangSchedulerName))

replicaSpecs[apiv1.ReplicaType(testjobv1.TestReplicaTypeWorker)] = &apiv1.ReplicaSpec{
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
SchedulerName: "other-scheduler",
"all replicaSpecs are set custom schedulerName": {
replicaSpecs: map[apiv1.ReplicaType]*apiv1.ReplicaSpec{
apiv1.ReplicaType("A"): {
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
SchedulerName: "custom-a",
},
},
},
apiv1.ReplicaType("B"): {
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
SchedulerName: "custom-b",
},
},
},
},
gangSchedulerName: "beta",
want: true,
},
"one of replicaSpecs is set custom schedulerName": {
replicaSpecs: map[apiv1.ReplicaType]*apiv1.ReplicaSpec{
apiv1.ReplicaType("A"): {},
apiv1.ReplicaType("B"): {
Template: v1.PodTemplateSpec{
Spec: v1.PodSpec{
SchedulerName: "custom-b",
},
},
},
},
gangSchedulerName: "gamma",
want: true,
},
}
for name, tc := range testCases {
t.Run(name, func(t *testing.T) {
got := isCustomSchedulerSet(tc.replicaSpecs, tc.gangSchedulerName)
if tc.want != got {
t.Errorf("Unexpected value from isCustomSchedulerSet:\nwant:%v\ngot:%v\n", tc.want, got)
}
})
}
assert.True(t, isCustomSchedulerSet(replicaSpecs, gangSchedulerName))
}

func TestCalculatePodSliceSize(t *testing.T) {
Expand Down