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.

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

Add unit tests to jobset success policy functions #501

Merged
merged 4 commits into from
Apr 11, 2024
Merged

Add unit tests to jobset success policy functions #501

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5dc8f18
test: Add unit tests to jobset success policy functions
zhifei92 Apr 9, 2024
7a36cf7
refactor: use table-driven format to test
zhifei92 Apr 9, 2024
2c52448
refactor: change test case name to tests and test names start with l…
zhifei92 Apr 10, 2024
28eeae1
refactor: Optimal names and delete todo in success_policy.go
zhifei92 Apr 11, 2024
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
283 changes: 283 additions & 0 deletions pkg/controllers/success_policy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
/*
Copyright 2023 The Kubernetes 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 controllers

import (
"testing"

"github.com/google/go-cmp/cmp"
batchv1 "k8s.io/api/batch/v1"

jobset "sigs.k8s.io/jobset/api/jobset/v1alpha2"
testutils "sigs.k8s.io/jobset/pkg/util/testing"
)

func TestJobMatchesSuccessPolicy(t *testing.T) {
var (
jobSetName = "test-jobset"
jobName = "test-job"
ns = "default"
)

jobMatchesSuccessPolicyTestCases := []struct {
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
name string
js *jobset.JobSet
job *batchv1.Job
expected bool
}{
{
name: "TargetReplicatedJobs is empty",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{},
}).Obj(),
job: testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-1"}).
Obj(),
expected: true,
},
{
name: "Job matches one of the TargetReplicatedJobs",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
job: testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-1"}).
Obj(),
expected: true,
},
{
name: "Job does not match any of the TargetReplicatedJobs",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
job: testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-3"}).
Obj(),
expected: false,
},
}

for _, tc := range jobMatchesSuccessPolicyTestCases {
t.Run(tc.name, func(t *testing.T) {
actual := jobMatchesSuccessPolicy(tc.js, tc.job)
if diff := cmp.Diff(tc.expected, actual); diff != "" {
t.Errorf("unexpected finished value (+got/-want): %s", diff)
}
})
}
}

func TestReplicatedJobMatchesSuccessPolicy(t *testing.T) {
var (
jobSetName = "test-jobset"
ns = "default"
)

replicatedJobMatchTestCases := []struct {
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
name string
js *jobset.JobSet
replicatedJob jobset.ReplicatedJob
expected bool
}{
{
name: "Empty target replicated jobs",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{},
}).Obj(),
replicatedJob: testutils.MakeReplicatedJob("test-replicated-job-1").Obj(),
expected: true,
},
{
name: "Matching case",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
replicatedJob: testutils.MakeReplicatedJob("test-replicated-job-1").Obj(),
expected: true,
},
{
name: "Non-matching case",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
replicatedJob: testutils.MakeReplicatedJob("test-replicated-job-3").Obj(),
expected: false,
},
}

for _, tc := range replicatedJobMatchTestCases {
t.Run(tc.name, func(t *testing.T) {
actual := replicatedJobMatchesSuccessPolicy(tc.js, &tc.replicatedJob)
if diff := cmp.Diff(tc.expected, actual); diff != "" {
t.Errorf("unexpected finished value (+got/-want): %s", diff)
}
})
}
}

func TestNumJobsMatchingSuccessPolicy(t *testing.T) {
var (
jobSetName = "test-jobset"
jobName = "test-job"
ns = "default"
)

numJobsMatchTestCases := []struct {
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
name string
js *jobset.JobSet
jobs []*batchv1.Job
expected int
}{
{
name: "One job matches the success policy",
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
jobs: []*batchv1.Job{
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-1"}).
Obj(),
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-3"}).
Obj(),
},
expected: 1,
},
{
name: "all jobs matches the success policy",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
jobs: []*batchv1.Job{
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-1"}).
Obj(),
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-2"}).
Obj(),
},
expected: 2,
},
{
name: "non job matches the success policy",
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).Obj(),
jobs: []*batchv1.Job{
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-3"}).
Obj(),
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-4"}).
Obj(),
},
expected: 0,
},
{
name: "empty target replicated jobs, all job matches the success policy",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
TargetReplicatedJobs: []string{},
}).Obj(),
jobs: []*batchv1.Job{
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-1"}).
Obj(),
testutils.MakeJob(jobName, ns).
JobLabels(map[string]string{jobset.ReplicatedJobNameKey: "test-replicated-job-2"}).
Obj(),
},
expected: 2,
},
}

for _, tc := range numJobsMatchTestCases {
t.Run(tc.name, func(t *testing.T) {
actual := numJobsMatchingSuccessPolicy(tc.js, tc.jobs)
if diff := cmp.Diff(tc.expected, actual); diff != "" {
t.Errorf("unexpected finished value (+got/-want): %s", diff)
}
})
}
}

func TestNumJobsExpectedToSucceed(t *testing.T) {
var (
jobSetName = "test-jobset"
ns = "default"
)

numJobsMatchTests := []struct {
zhifei92 marked this conversation as resolved.
Show resolved Hide resolved
name string
js *jobset.JobSet
expected int
}{
{
name: "OperatorAny",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
Operator: jobset.OperatorAny,
}).Obj(),
expected: 1,
},
{
name: "OperatorAll - all replicated jobs match success policy",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
Operator: jobset.OperatorAll,
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-2"},
}).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-1").
Replicas(1).Obj()).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-2").
Replicas(2).Obj()).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-3").
Replicas(3).Obj()).Obj(),
expected: 3,
},
{
name: "OperatorAll - some replicated jobs don't match success policy",
js: testutils.MakeJobSet(jobSetName, ns).
SuccessPolicy(&jobset.SuccessPolicy{
Operator: jobset.OperatorAll,
TargetReplicatedJobs: []string{"test-replicated-job-1", "test-replicated-job-3"},
}).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-1").
Replicas(1).Obj()).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-2").
Replicas(2).Obj()).
ReplicatedJob(testutils.MakeReplicatedJob("test-replicated-job-3").
Replicas(3).Obj()).Obj(),
expected: 4,
},
}

for _, tc := range numJobsMatchTests {
t.Run(tc.name, func(t *testing.T) {
actual := numJobsExpectedToSucceed(tc.js)
if diff := cmp.Diff(tc.expected, actual); diff != "" {
t.Errorf("unexpected finished value (+got/-want): %s", diff)
}
})
}
}