Skip to content

Commit

Permalink
Update unit tests to use apply configurations
Browse files Browse the repository at this point in the history 
Signed-off-by: Antonin Stefanutti <[email protected]>
  • Loading branch information
@astefanutti
astefanutti committed Feb 14, 2025
1 parent 999e800 commit 3f1e774
Show file tree
Hide file tree
Showing 5 changed files with 380 additions and 362 deletions.
12 changes: 7 additions & 5 deletions pkg/runtime/core/clustertrainingruntime_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ import (
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"
schedulerpluginsv1alpha1 "sigs.k8s.io/scheduler-plugins/apis/scheduling/v1alpha1"

trainer "github.com/kubeflow/trainer/pkg/apis/trainer/v1alpha1"
trainerac "github.com/kubeflow/trainer/pkg/client/applyconfiguration/trainer/v1alpha1"
testingutil "github.com/kubeflow/trainer/pkg/util/testing"
)

Expand All @@ -40,8 +42,8 @@ func TestClusterTrainingRuntimeNewObjects(t *testing.T) {

cases := map[string]struct {
trainJob *trainer.TrainJob
clusterTrainingRuntime *trainer.ClusterTrainingRuntime
wantObjs []client.Object
clusterTrainingRuntime *trainerac.ClusterTrainingRuntimeApplyConfiguration
wantObjs []*unstructured.Unstructured
wantError error
}{
"succeeded to build PodGroup and JobSet with NumNodes from the Runtime and container from the Trainer.": {
Expand All @@ -63,7 +65,7 @@ func TestClusterTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
InitContainerDatasetModelInitializer("test:runtime", []string{"runtime"}, []string{"runtime"}, resRequests).
NumNodes(100).
Expand All @@ -80,7 +82,7 @@ func TestClusterTrainingRuntimeNewObjects(t *testing.T) {
}).
SchedulingTimeout(120).
Obj(),
},
),
},
"missing trainingRuntime resource": {
trainJob: testingutil.MakeTrainJobWrapper(metav1.NamespaceDefault, "test-job").
Expand All @@ -107,7 +109,7 @@ func TestClusterTrainingRuntimeNewObjects(t *testing.T) {
t.Cleanup(cancel)
clientBuilder := testingutil.NewClientBuilder()
if tc.clusterTrainingRuntime != nil {
clientBuilder.WithObjects(tc.clusterTrainingRuntime)
clientBuilder.WithObjects(testingutil.ToUnstructured(t, tc.clusterTrainingRuntime)[0])
}

trainingRuntime, err := NewTrainingRuntime(ctx, clientBuilder.Build(), testingutil.AsIndex(clientBuilder))
Expand Down
28 changes: 15 additions & 13 deletions pkg/runtime/core/trainingruntime_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ import (
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"
schedulerpluginsv1alpha1 "sigs.k8s.io/scheduler-plugins/apis/scheduling/v1alpha1"

trainer "github.com/kubeflow/trainer/pkg/apis/trainer/v1alpha1"
trainerac "github.com/kubeflow/trainer/pkg/client/applyconfiguration/trainer/v1alpha1"
"github.com/kubeflow/trainer/pkg/constants"
jobsetplugin "github.com/kubeflow/trainer/pkg/runtime/framework/plugins/jobset"
testingutil "github.com/kubeflow/trainer/pkg/util/testing"
Expand All @@ -42,9 +44,9 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {

// TODO (andreyvelich): Add more test cases.
cases := map[string]struct {
trainingRuntime *trainer.TrainingRuntime
trainingRuntime *trainerac.TrainingRuntimeApplyConfiguration
trainJob *trainer.TrainJob
wantObjs []client.Object
wantObjs []*unstructured.Unstructured
wantError error
}{
// Test cases for the PlainML MLPolicy.
Expand Down Expand Up @@ -72,7 +74,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
InitContainerDatasetModelInitializer("test:runtime", []string{"runtime"}, []string{"runtime"}, resRequests).
NumNodes(30).
Expand All @@ -94,7 +96,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
}).
SchedulingTimeout(120).
Obj(),
},
),
},
"succeeded to build JobSet with NumNodes from the Runtime and container from the TrainJob.": {
trainingRuntime: testingutil.MakeTrainingRuntimeWrapper(metav1.NamespaceDefault, "test-runtime").RuntimeSpec(
Expand Down Expand Up @@ -136,7 +138,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
NumNodes(100).
ContainerTrainer("test:trainjob", []string{"trainjob"}, []string{"trainjob"}, resRequests).
Expand All @@ -158,7 +160,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
).
ControllerReference(trainer.SchemeGroupVersion.WithKind(trainer.TrainJobKind), "test-job", "uid").
Obj(),
},
),
},
"succeeded to build JobSet with dataset and model initializer from the TrainJob.": {
trainingRuntime: testingutil.MakeTrainingRuntimeWrapper(metav1.NamespaceDefault, "test-runtime").RuntimeSpec(
Expand Down Expand Up @@ -204,7 +206,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
NumNodes(100).
ContainerTrainer("test:runtime", []string{"runtime"}, []string{"runtime"}, resRequests).
Expand Down Expand Up @@ -257,7 +259,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
).
ControllerReference(trainer.SchemeGroupVersion.WithKind(trainer.TrainJobKind), "test-job", "uid").
Obj(),
},
),
},
// Test cases for the Torch MLPolicy.
"succeeded to build JobSet with Torch values from the TrainJob": {
Expand All @@ -277,7 +279,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
NumNodes(30).
ContainerTrainer("test:runtime", []string{"runtime"}, []string{"runtime"}, resRequests).
Expand Down Expand Up @@ -312,7 +314,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
).
ControllerReference(trainer.SchemeGroupVersion.WithKind(trainer.TrainJobKind), "test-job", "uid").
Obj(),
},
),
},
"succeeded to build JobSet with Torch values from the Runtime and envs.": {
trainingRuntime: testingutil.MakeTrainingRuntimeWrapper(metav1.NamespaceDefault, "test-runtime").RuntimeSpec(
Expand Down Expand Up @@ -354,7 +356,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
Obj(),
).
Obj(),
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").
NumNodes(100).
ContainerTrainer("test:trainjob", []string{"trainjob"}, []string{"trainjob"}, resRequests).
Expand Down Expand Up @@ -401,7 +403,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
).
ControllerReference(trainer.SchemeGroupVersion.WithKind(trainer.TrainJobKind), "test-job", "uid").
Obj(),
},
),
},
// Failed test cases.
"missing trainingRuntime resource": {
Expand Down Expand Up @@ -429,7 +431,7 @@ func TestTrainingRuntimeNewObjects(t *testing.T) {
t.Cleanup(cancel)
clientBuilder := testingutil.NewClientBuilder()
if tc.trainingRuntime != nil {
clientBuilder.WithObjects(tc.trainingRuntime)
clientBuilder.WithObjects(testingutil.ToUnstructured(t, tc.trainingRuntime)[0])
}

trainingRuntime, err := NewTrainingRuntime(ctx, clientBuilder.Build(), testingutil.AsIndex(clientBuilder))
Expand Down
26 changes: 13 additions & 13 deletions pkg/runtime/framework/core/framework_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ import (
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
apiruntime "k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/validation/field"
"k8s.io/utils/ptr"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/webhook/admission"
jobsetv1alpha2 "sigs.k8s.io/jobset/api/jobset/v1alpha2"
jobsetv1alpha2ac "sigs.k8s.io/jobset/client-go/applyconfiguration/jobset/v1alpha2"
jobsetconsts "sigs.k8s.io/jobset/pkg/constants"
schedulerpluginsv1alpha1 "sigs.k8s.io/scheduler-plugins/apis/scheduling/v1alpha1"

Expand Down Expand Up @@ -387,17 +389,15 @@ func TestRunComponentBuilderPlugins(t *testing.T) {
}

cases := map[string]struct {
registry fwkplugins.Registry
runtimeInfo *runtime.Info
trainJob *trainer.TrainJob
runtimeJobTemplate client.Object
wantRuntimeInfo *runtime.Info
wantObjs []client.Object
wantError error
registry fwkplugins.Registry
runtimeInfo *runtime.Info
trainJob *trainer.TrainJob
wantRuntimeInfo *runtime.Info
wantObjs []*unstructured.Unstructured
wantError error
}{
"succeeded to build PodGroup and JobSet with NumNodes from TrainJob": {
registry: fwkplugins.NewRegistry(),
runtimeJobTemplate: testingutil.MakeJobSetWrapper(metav1.NamespaceDefault, "test-job").DeepCopy(),
registry: fwkplugins.NewRegistry(),
runtimeInfo: &runtime.Info{
RuntimePolicy: runtime.RuntimePolicy{
MLPolicy: &trainer.MLPolicy{
Expand Down Expand Up @@ -466,7 +466,7 @@ func TestRunComponentBuilderPlugins(t *testing.T) {
},
},
},
wantObjs: []client.Object{
wantObjs: testingutil.ToUnstructured(t,
testingutil.MakeSchedulerPluginsPodGroup(metav1.NamespaceDefault, "test-job").
SchedulingTimeout(300).
MinMember(101). // 101 replicas = 100 Trainer nodes + 1 Initializer.
Expand All @@ -482,7 +482,7 @@ func TestRunComponentBuilderPlugins(t *testing.T) {
PodLabel(schedulerpluginsv1alpha1.PodGroupLabel, "test-job").
ContainerTrainer("test:trainjob", []string{"trainjob"}, []string{"trainjob"}, resRequests).
Obj(),
},
),
},
"an empty registry": {},
}
Expand Down Expand Up @@ -580,7 +580,7 @@ func TestTerminalConditionPlugins(t *testing.T) {
cases := map[string]struct {
registry fwkplugins.Registry
trainJob *trainer.TrainJob
jobSet *jobsetv1alpha2.JobSet
jobSet *jobsetv1alpha2ac.JobSetApplyConfiguration
wantCondition *metav1.Condition
wantError error
}{
Expand Down Expand Up @@ -649,7 +649,7 @@ func TestTerminalConditionPlugins(t *testing.T) {
t.Cleanup(cancel)
clientBuilder := testingutil.NewClientBuilder()
if tc.jobSet != nil {
clientBuilder = clientBuilder.WithObjects(tc.jobSet)
clientBuilder = clientBuilder.WithObjects(testingutil.ToUnstructured(t, tc.jobSet)[0])
}
fwk, err := New(ctx, clientBuilder.Build(), tc.registry, testingutil.AsIndex(clientBuilder))
if err != nil {
Expand Down
42 changes: 42 additions & 0 deletions pkg/util/testing/unstructured.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
Copyright 2024 The Kubeflow 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 testing

import (
"testing"

"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
k8sruntime "k8s.io/apimachinery/pkg/runtime"
)

func toUnstructured(t *testing.T, obj any) *unstructured.Unstructured {
t.Helper()

u, err := k8sruntime.DefaultUnstructuredConverter.ToUnstructured(obj)
if err != nil {
t.Fatal(err)
}
return &unstructured.Unstructured{Object: u}
}

func ToUnstructured(t *testing.T, obj ...any) []*unstructured.Unstructured {
var uns []*unstructured.Unstructured
for _, obj := range obj {
uns = append(uns, toUnstructured(t, obj))
}
return uns
}
Loading

0 comments on commit 3f1e774

Please sign in to comment.