add unit test for mxjob controller

pkg/common/util/v1/testutil/const.go

@@ -30,6 +30,13 @@ const (
 	ThreadCount   = 1
 )
 
+const (
+	TestMXJobName = "test-mxjob"
+
+	LabelScheduler = "scheduler"
+	LabelServer    = "server"
+)
+
 var (
 	AlwaysReady = func() bool { return true }
 )

pkg/common/util/v1/testutil/mxjob.go

@@ -0,0 +1,153 @@
+// Copyright 2022 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 testutil
+
+import (
+	"time"
+
+	commonv1 "github.com/kubeflow/common/pkg/apis/common/v1"
+	mxv1 "github.com/kubeflow/training-operator/pkg/apis/mxnet/v1"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func NewMXJobWithCleanPolicy(scheduler, worker, server int, policy commonv1.CleanPodPolicy) *mxv1.MXJob {
+
+	var mxJob *mxv1.MXJob
+
+	if scheduler > 0 {
+		mxJob = NewMXJobWithScheduler(worker, server)
+	} else {
+		mxJob = NewMXJob(worker, server)
+	}
+
+	mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+	return mxJob
+}
+
+func NewMXJobWithCleanupJobDelay(scheduler, worker, server int, ttl *int32) *mxv1.MXJob {
+
+	var mxJob *mxv1.MXJob
+
+	if scheduler > 0 {
+		mxJob = NewMXJobWithScheduler(worker, server)
+	} else {
+		mxJob = NewMXJob(worker, server)
+	}
+
+	mxJob.Spec.RunPolicy.TTLSecondsAfterFinished = ttl
+	policy := commonv1.CleanPodPolicyNone
+	mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+	return mxJob
+}
+
+func NewMXJobWithActiveDeadlineSeconds(scheduler, worker, ps int, ads *int64) *mxv1.MXJob {
+	if scheduler == 1 {
+		mxJob := NewMXJobWithScheduler(worker, ps)
+		mxJob.Spec.RunPolicy.ActiveDeadlineSeconds = ads
+		policy := commonv1.CleanPodPolicyAll
+		mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+		return mxJob
+	}
+	mxJob := NewMXJob(worker, ps)
+	mxJob.Spec.RunPolicy.ActiveDeadlineSeconds = ads
+	policy := commonv1.CleanPodPolicyAll
+	mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+	return mxJob
+}
+
+func NewMXJobWithBackoffLimit(scheduler, worker, ps int, backoffLimit *int32) *mxv1.MXJob {
+	if scheduler == 1 {
+		mxJob := NewMXJobWithScheduler(worker, ps)
+		mxJob.Spec.RunPolicy.BackoffLimit = backoffLimit
+		mxJob.Spec.MXReplicaSpecs["Worker"].RestartPolicy = "OnFailure"
+		policy := commonv1.CleanPodPolicyAll
+		mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+		return mxJob
+	}
+	mxJob := NewMXJob(worker, ps)
+	mxJob.Spec.RunPolicy.BackoffLimit = backoffLimit
+	mxJob.Spec.MXReplicaSpecs["Worker"].RestartPolicy = "OnFailure"
+	policy := commonv1.CleanPodPolicyAll
+	mxJob.Spec.RunPolicy.CleanPodPolicy = &policy
+	return mxJob
+}
+
+func NewMXJobWithScheduler(worker, server int) *mxv1.MXJob {
+	mxJob := NewMXJob(worker, server)
+	mxJob.Spec.MXReplicaSpecs[mxv1.MXReplicaTypeScheduler] = &commonv1.ReplicaSpec{
+		Template: NewMXReplicaSpecTemplate(),
+	}
+	return mxJob
+}
+
+func NewMXJob(worker, server int) *mxv1.MXJob {
+	mxJob := &mxv1.MXJob{
+		TypeMeta: metav1.TypeMeta{
+			Kind: mxv1.Kind,
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      TestMXJobName,
+			Namespace: metav1.NamespaceDefault,
+		},
+		Spec: mxv1.MXJobSpec{
+			MXReplicaSpecs: make(map[commonv1.ReplicaType]*commonv1.ReplicaSpec),
+		},
+	}
+
+	if worker > 0 {
+		worker := int32(worker)
+		workerReplicaSpec := &commonv1.ReplicaSpec{
+			Replicas: &worker,
+			Template: NewMXReplicaSpecTemplate(),
+		}
+		mxJob.Spec.MXReplicaSpecs[mxv1.MXReplicaTypeWorker] = workerReplicaSpec
+	}
+
+	if server > 0 {
+		server := int32(server)
+		serverReplicaSpec := &commonv1.ReplicaSpec{
+			Replicas: &server,
+			Template: NewMXReplicaSpecTemplate(),
+		}
+		mxJob.Spec.MXReplicaSpecs[mxv1.MXReplicaTypeServer] = serverReplicaSpec
+	}
+	return mxJob
+}
+
+func NewMXReplicaSpecTemplate() v1.PodTemplateSpec {
+	return v1.PodTemplateSpec{
+		Spec: v1.PodSpec{
+			Containers: []v1.Container{
+				{
+					Name:  mxv1.DefaultContainerName,
+					Image: TestImageName,
+					Args:  []string{"Fake", "Fake"},
+					Ports: []v1.ContainerPort{
+						{
+							Name:          mxv1.DefaultPortName,
+							ContainerPort: mxv1.DefaultPort,
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func SetMXJobCompletionTime(mxJob *mxv1.MXJob) {
+	now := metav1.Time{Time: time.Now()}
+	mxJob.Status.CompletionTime = &now
+}

pkg/controller.v1/mxnet/job_test.go

@@ -0,0 +1,48 @@
+// Copyright 2022 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 mxnet
+
+import (
+	"context"
+
+	mxjobv1 "github.com/kubeflow/training-operator/pkg/apis/mxnet/v1"
+	"k8s.io/apimachinery/pkg/types"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/kubeflow/training-operator/pkg/common/util/v1/testutil"
+)
+
+var _ = Describe("MXJob controller", func() {
+	Context("Test Add MXJob", func() {
+		It("should get desired MXJob", func() {
+			mxJob := testutil.NewMXJob(1, 0)
+
+			ctx := context.Background()
+			Expect(testK8sClient.Create(ctx, mxJob)).Should(Succeed())
+
+			obj := &mxjobv1.MXJob{}
+			key := types.NamespacedName{
+				Namespace: mxJob.GetNamespace(),
+				Name:      mxJob.GetName(),
+			}
+			Eventually(func() error {
+				return testK8sClient.Get(ctx, key, obj)
+			}).Should(BeNil())
+		})
+	})
+
+})