484 lines
15 KiB
Go
484 lines
15 KiB
Go
/*
|
|
Copyright 2016 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 cronjob
|
|
|
|
import (
|
|
"reflect"
|
|
"sort"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
cron "github.com/robfig/cron/v3"
|
|
batchv1 "k8s.io/api/batch/v1"
|
|
"k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/types"
|
|
"k8s.io/client-go/tools/record"
|
|
"k8s.io/klog/v2/ktesting"
|
|
)
|
|
|
|
func TestGetJobFromTemplate2(t *testing.T) {
|
|
// getJobFromTemplate2() needs to take the job template and copy the labels and annotations
|
|
// and other fields, and add a created-by reference.
|
|
|
|
var one int64 = 1
|
|
var no bool
|
|
|
|
cj := batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "mycronjob",
|
|
Namespace: "snazzycats",
|
|
UID: types.UID("1a2b3c"),
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "* * * * ?",
|
|
ConcurrencyPolicy: batchv1.AllowConcurrent,
|
|
JobTemplate: batchv1.JobTemplateSpec{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Labels: map[string]string{"a": "b"},
|
|
Annotations: map[string]string{"x": "y"},
|
|
},
|
|
Spec: batchv1.JobSpec{
|
|
ActiveDeadlineSeconds: &one,
|
|
ManualSelector: &no,
|
|
Template: v1.PodTemplateSpec{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Labels: map[string]string{
|
|
"foo": "bar",
|
|
},
|
|
},
|
|
Spec: v1.PodSpec{
|
|
Containers: []v1.Container{
|
|
{Image: "foo/bar"},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
var job *batchv1.Job
|
|
job, err := getJobFromTemplate2(&cj, time.Time{})
|
|
if err != nil {
|
|
t.Errorf("Did not expect error: %s", err)
|
|
}
|
|
if !strings.HasPrefix(job.ObjectMeta.Name, "mycronjob-") {
|
|
t.Errorf("Wrong Name")
|
|
}
|
|
if len(job.ObjectMeta.Labels) != 1 {
|
|
t.Errorf("Wrong number of labels")
|
|
}
|
|
if len(job.ObjectMeta.Annotations) != 1 {
|
|
t.Errorf("Wrong number of annotations")
|
|
}
|
|
}
|
|
|
|
func TestNextScheduleTime(t *testing.T) {
|
|
logger, _ := ktesting.NewTestContext(t)
|
|
// schedule is hourly on the hour
|
|
schedule := "0 * * * ?"
|
|
|
|
PraseSchedule := func(schedule string) cron.Schedule {
|
|
sched, err := cron.ParseStandard(schedule)
|
|
if err != nil {
|
|
t.Errorf("Error parsing schedule: %#v", err)
|
|
return nil
|
|
}
|
|
return sched
|
|
}
|
|
recorder := record.NewFakeRecorder(50)
|
|
// T1 is a scheduled start time of that schedule
|
|
T1 := *topOfTheHour()
|
|
// T2 is a scheduled start time of that schedule after T1
|
|
T2 := *deltaTimeAfterTopOfTheHour(1 * time.Hour)
|
|
|
|
cj := batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "mycronjob",
|
|
Namespace: metav1.NamespaceDefault,
|
|
UID: types.UID("1a2b3c"),
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: schedule,
|
|
ConcurrencyPolicy: batchv1.AllowConcurrent,
|
|
JobTemplate: batchv1.JobTemplateSpec{},
|
|
},
|
|
}
|
|
{
|
|
// Case 1: no known start times, and none needed yet.
|
|
// Creation time is before T1.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-10 * time.Minute)}
|
|
// Current time is more than creation time, but less than T1.
|
|
now := T1.Add(-7 * time.Minute)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule != nil {
|
|
t.Errorf("expected no start time, got: %v", schedule)
|
|
}
|
|
}
|
|
{
|
|
// Case 2: no known start times, and one needed.
|
|
// Creation time is before T1.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-10 * time.Minute)}
|
|
// Current time is after T1
|
|
now := T1.Add(2 * time.Second)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule == nil {
|
|
t.Errorf("expected 1 start time, got nil")
|
|
} else if !schedule.Equal(T1) {
|
|
t.Errorf("expected: %v, got: %v", T1, schedule)
|
|
}
|
|
}
|
|
{
|
|
// Case 3: known LastScheduleTime, no start needed.
|
|
// Creation time is before T1.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-10 * time.Minute)}
|
|
// Status shows a start at the expected time.
|
|
cj.Status.LastScheduleTime = &metav1.Time{Time: T1}
|
|
// Current time is after T1
|
|
now := T1.Add(2 * time.Minute)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule != nil {
|
|
t.Errorf("expected 0 start times, got: %v", schedule)
|
|
}
|
|
}
|
|
{
|
|
// Case 4: known LastScheduleTime, a start needed
|
|
// Creation time is before T1.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-10 * time.Minute)}
|
|
// Status shows a start at the expected time.
|
|
cj.Status.LastScheduleTime = &metav1.Time{Time: T1}
|
|
// Current time is after T1 and after T2
|
|
now := T2.Add(5 * time.Minute)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule == nil {
|
|
t.Errorf("expected 1 start times, got nil")
|
|
} else if !schedule.Equal(T2) {
|
|
t.Errorf("expected: %v, got: %v", T2, schedule)
|
|
}
|
|
}
|
|
{
|
|
// Case 5: known LastScheduleTime, two starts needed
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-2 * time.Hour)}
|
|
cj.Status.LastScheduleTime = &metav1.Time{Time: T1.Add(-1 * time.Hour)}
|
|
// Current time is after T1 and after T2
|
|
now := T2.Add(5 * time.Minute)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule == nil {
|
|
t.Errorf("expected 1 start times, got nil")
|
|
} else if !schedule.Equal(T2) {
|
|
t.Errorf("expected: %v, got: %v", T2, schedule)
|
|
}
|
|
}
|
|
{
|
|
// Case 6: now is way way ahead of last start time, and there is no deadline.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-2 * time.Hour)}
|
|
cj.Status.LastScheduleTime = &metav1.Time{Time: T1.Add(-1 * time.Hour)}
|
|
now := T2.Add(10 * 24 * time.Hour)
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule == nil {
|
|
t.Errorf("expected more than 0 missed times")
|
|
}
|
|
}
|
|
{
|
|
// Case 7: now is way way ahead of last start time, but there is a short deadline.
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(-2 * time.Hour)}
|
|
cj.Status.LastScheduleTime = &metav1.Time{Time: T1.Add(-1 * time.Hour)}
|
|
now := T2.Add(10 * 24 * time.Hour)
|
|
// Deadline is short
|
|
deadline := int64(2 * 60 * 60)
|
|
cj.Spec.StartingDeadlineSeconds = &deadline
|
|
schedule, _ := nextScheduleTime(logger, &cj, now, PraseSchedule(cj.Spec.Schedule), recorder)
|
|
if schedule == nil {
|
|
t.Errorf("expected more than 0 missed times")
|
|
}
|
|
}
|
|
{
|
|
// Case 8: ensure the error from mostRecentScheduleTime gets populated up
|
|
cj.ObjectMeta.CreationTimestamp = metav1.Time{Time: T1.Add(10 * time.Second)}
|
|
cj.Status.LastScheduleTime = nil
|
|
now := *deltaTimeAfterTopOfTheHour(1 * time.Hour)
|
|
// rouge schedule
|
|
schedule, err := nextScheduleTime(logger, &cj, now, PraseSchedule("59 23 31 2 *"), recorder)
|
|
if schedule != nil {
|
|
t.Errorf("expected no start time, got: %v", schedule)
|
|
}
|
|
if err == nil {
|
|
t.Errorf("expected error")
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestByJobStartTime(t *testing.T) {
|
|
now := metav1.NewTime(time.Date(2018, time.January, 1, 2, 3, 4, 5, time.UTC))
|
|
later := metav1.NewTime(time.Date(2019, time.January, 1, 2, 3, 4, 5, time.UTC))
|
|
aNil := &batchv1.Job{
|
|
ObjectMeta: metav1.ObjectMeta{Name: "a"},
|
|
Status: batchv1.JobStatus{},
|
|
}
|
|
bNil := &batchv1.Job{
|
|
ObjectMeta: metav1.ObjectMeta{Name: "b"},
|
|
Status: batchv1.JobStatus{},
|
|
}
|
|
aSet := &batchv1.Job{
|
|
ObjectMeta: metav1.ObjectMeta{Name: "a"},
|
|
Status: batchv1.JobStatus{StartTime: &now},
|
|
}
|
|
bSet := &batchv1.Job{
|
|
ObjectMeta: metav1.ObjectMeta{Name: "b"},
|
|
Status: batchv1.JobStatus{StartTime: &now},
|
|
}
|
|
aSetLater := &batchv1.Job{
|
|
ObjectMeta: metav1.ObjectMeta{Name: "a"},
|
|
Status: batchv1.JobStatus{StartTime: &later},
|
|
}
|
|
|
|
testCases := []struct {
|
|
name string
|
|
input, expected []*batchv1.Job
|
|
}{
|
|
{
|
|
name: "both have nil start times",
|
|
input: []*batchv1.Job{bNil, aNil},
|
|
expected: []*batchv1.Job{aNil, bNil},
|
|
},
|
|
{
|
|
name: "only the first has a nil start time",
|
|
input: []*batchv1.Job{aNil, bSet},
|
|
expected: []*batchv1.Job{bSet, aNil},
|
|
},
|
|
{
|
|
name: "only the second has a nil start time",
|
|
input: []*batchv1.Job{aSet, bNil},
|
|
expected: []*batchv1.Job{aSet, bNil},
|
|
},
|
|
{
|
|
name: "both have non-nil, equal start time",
|
|
input: []*batchv1.Job{bSet, aSet},
|
|
expected: []*batchv1.Job{aSet, bSet},
|
|
},
|
|
{
|
|
name: "both have non-nil, different start time",
|
|
input: []*batchv1.Job{aSetLater, bSet},
|
|
expected: []*batchv1.Job{bSet, aSetLater},
|
|
},
|
|
}
|
|
|
|
for _, testCase := range testCases {
|
|
sort.Sort(byJobStartTime(testCase.input))
|
|
if !reflect.DeepEqual(testCase.input, testCase.expected) {
|
|
t.Errorf("case: '%s', jobs not sorted as expected", testCase.name)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMostRecentScheduleTime(t *testing.T) {
|
|
metav1TopOfTheHour := metav1.NewTime(*topOfTheHour())
|
|
metav1HalfPastTheHour := metav1.NewTime(*deltaTimeAfterTopOfTheHour(30 * time.Minute))
|
|
oneMinute := int64(60)
|
|
|
|
tests := []struct {
|
|
name string
|
|
cj *batchv1.CronJob
|
|
includeSDS bool
|
|
now time.Time
|
|
expectedEarliestTime time.Time
|
|
expectedRecentTime *time.Time
|
|
expectedNumberOfMisses int64
|
|
wantErr bool
|
|
}{
|
|
{
|
|
name: "now before next schedule",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "0 * * * *",
|
|
},
|
|
},
|
|
now: topOfTheHour().Add(30 * time.Second),
|
|
expectedRecentTime: nil,
|
|
expectedEarliestTime: *topOfTheHour(),
|
|
},
|
|
{
|
|
name: "now just after next schedule",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "0 * * * *",
|
|
},
|
|
},
|
|
now: topOfTheHour().Add(61 * time.Minute),
|
|
expectedRecentTime: deltaTimeAfterTopOfTheHour(60 * time.Minute),
|
|
expectedEarliestTime: *topOfTheHour(),
|
|
expectedNumberOfMisses: 1,
|
|
},
|
|
{
|
|
name: "missed 5 schedules",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1.NewTime(*deltaTimeAfterTopOfTheHour(10 * time.Second)),
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "0 * * * *",
|
|
},
|
|
},
|
|
now: *deltaTimeAfterTopOfTheHour(301 * time.Minute),
|
|
expectedRecentTime: deltaTimeAfterTopOfTheHour(300 * time.Minute),
|
|
expectedEarliestTime: *deltaTimeAfterTopOfTheHour(10 * time.Second),
|
|
expectedNumberOfMisses: 5,
|
|
},
|
|
{
|
|
name: "rogue cronjob",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1.NewTime(*deltaTimeAfterTopOfTheHour(10 * time.Second)),
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "59 23 31 2 *",
|
|
},
|
|
},
|
|
now: *deltaTimeAfterTopOfTheHour(1 * time.Hour),
|
|
expectedRecentTime: nil,
|
|
expectedNumberOfMisses: 0,
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "earliestTime being CreationTimestamp and LastScheduleTime",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "0 * * * *",
|
|
},
|
|
Status: batchv1.CronJobStatus{
|
|
LastScheduleTime: &metav1TopOfTheHour,
|
|
},
|
|
},
|
|
now: *deltaTimeAfterTopOfTheHour(30 * time.Second),
|
|
expectedEarliestTime: *topOfTheHour(),
|
|
expectedRecentTime: nil,
|
|
},
|
|
{
|
|
name: "earliestTime being LastScheduleTime",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "*/5 * * * *",
|
|
},
|
|
Status: batchv1.CronJobStatus{
|
|
LastScheduleTime: &metav1HalfPastTheHour,
|
|
},
|
|
},
|
|
now: *deltaTimeAfterTopOfTheHour(31 * time.Minute),
|
|
expectedEarliestTime: *deltaTimeAfterTopOfTheHour(30 * time.Minute),
|
|
expectedRecentTime: nil,
|
|
},
|
|
{
|
|
name: "earliestTime being LastScheduleTime (within StartingDeadlineSeconds)",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "*/5 * * * *",
|
|
StartingDeadlineSeconds: &oneMinute,
|
|
},
|
|
Status: batchv1.CronJobStatus{
|
|
LastScheduleTime: &metav1HalfPastTheHour,
|
|
},
|
|
},
|
|
now: *deltaTimeAfterTopOfTheHour(31 * time.Minute),
|
|
expectedEarliestTime: *deltaTimeAfterTopOfTheHour(30 * time.Minute),
|
|
expectedRecentTime: nil,
|
|
},
|
|
{
|
|
name: "earliestTime being LastScheduleTime (outside StartingDeadlineSeconds)",
|
|
cj: &batchv1.CronJob{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
CreationTimestamp: metav1TopOfTheHour,
|
|
},
|
|
Spec: batchv1.CronJobSpec{
|
|
Schedule: "*/5 * * * *",
|
|
StartingDeadlineSeconds: &oneMinute,
|
|
},
|
|
Status: batchv1.CronJobStatus{
|
|
LastScheduleTime: &metav1HalfPastTheHour,
|
|
},
|
|
},
|
|
includeSDS: true,
|
|
now: *deltaTimeAfterTopOfTheHour(32 * time.Minute),
|
|
expectedEarliestTime: *deltaTimeAfterTopOfTheHour(31 * time.Minute),
|
|
expectedRecentTime: nil,
|
|
},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
sched, err := cron.ParseStandard(tt.cj.Spec.Schedule)
|
|
if err != nil {
|
|
t.Errorf("error setting up the test, %s", err)
|
|
}
|
|
gotEarliestTime, gotRecentTime, gotNumberOfMisses, err := mostRecentScheduleTime(tt.cj, tt.now, sched, tt.includeSDS)
|
|
if tt.wantErr {
|
|
if err == nil {
|
|
t.Error("mostRecentScheduleTime() got no error when expected one")
|
|
}
|
|
return
|
|
}
|
|
if !tt.wantErr && err != nil {
|
|
t.Error("mostRecentScheduleTime() got error when none expected")
|
|
}
|
|
if gotEarliestTime.IsZero() {
|
|
t.Errorf("earliestTime should never be 0, want %v", tt.expectedEarliestTime)
|
|
}
|
|
if !gotEarliestTime.Equal(tt.expectedEarliestTime) {
|
|
t.Errorf("expectedEarliestTime - got %v, want %v", gotEarliestTime, tt.expectedEarliestTime)
|
|
}
|
|
if !reflect.DeepEqual(gotRecentTime, tt.expectedRecentTime) {
|
|
t.Errorf("expectedRecentTime - got %v, want %v", gotRecentTime, tt.expectedRecentTime)
|
|
}
|
|
if gotNumberOfMisses != tt.expectedNumberOfMisses {
|
|
t.Errorf("expectedNumberOfMisses - got %v, want %v", gotNumberOfMisses, tt.expectedNumberOfMisses)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func topOfTheHour() *time.Time {
|
|
T1, err := time.Parse(time.RFC3339, "2016-05-19T10:00:00Z")
|
|
if err != nil {
|
|
panic("test setup error")
|
|
}
|
|
return &T1
|
|
}
|
|
|
|
func deltaTimeAfterTopOfTheHour(duration time.Duration) *time.Time {
|
|
T1, err := time.Parse(time.RFC3339, "2016-05-19T10:00:00Z")
|
|
if err != nil {
|
|
panic("test setup error")
|
|
}
|
|
t := T1.Add(duration)
|
|
return &t
|
|
}
|