ttlafterfinished.go

/*
Copyright 2018 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 common

import (
	"fmt"
	"time"

	batch "k8s.io/api/batch/v1"
	"k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/util/wait"
	"k8s.io/kubernetes/pkg/util/slice"
	"k8s.io/kubernetes/test/e2e/framework"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

const dummyFinalizer = "k8s.io/dummy-finalizer"

var _ = framework.KubeDescribe("TTLAfterFinished", func() {
	f := framework.NewDefaultFramework("ttlafterfinished")

	alphaFeatureStr := "[Feature:TTLAfterFinished]"
	It(fmt.Sprintf("Job should be deleted once it finishes after TTL seconds %s", alphaFeatureStr), func() {
		testFinishedJob(f)
	})
})

func cleanupJob(f *framework.Framework, job *batch.Job) {
	ns := f.Namespace.Name
	c := f.ClientSet

	framework.Logf("Remove the Job's dummy finalizer; the Job should be deleted cascadingly")
	removeFinalizerFunc := func(j *batch.Job) {
		j.ObjectMeta.Finalizers = slice.RemoveString(j.ObjectMeta.Finalizers, dummyFinalizer, nil)
	}
	_, err := framework.UpdateJobWithRetries(c, ns, job.Name, removeFinalizerFunc)
	Expect(err).NotTo(HaveOccurred())
	framework.WaitForJobGone(c, ns, job.Name, wait.ForeverTestTimeout)

	err = framework.WaitForAllJobPodsGone(c, ns, job.Name)
	Expect(err).NotTo(HaveOccurred())
}

func testFinishedJob(f *framework.Framework) {
	ns := f.Namespace.Name
	c := f.ClientSet

	parallelism := int32(1)
	completions := int32(1)
	backoffLimit := int32(2)
	ttl := int32(10)

	job := framework.NewTestJob("randomlySucceedOrFail", "rand-non-local", v1.RestartPolicyNever, parallelism, completions, nil, backoffLimit)
	job.Spec.TTLSecondsAfterFinished = &ttl
	job.ObjectMeta.Finalizers = []string{dummyFinalizer}
	defer cleanupJob(f, job)

	framework.Logf("Create a Job %s/%s with TTL", job.Namespace, job.Name)
	job, err := framework.CreateJob(c, ns, job)
	Expect(err).NotTo(HaveOccurred())

	framework.Logf("Wait for the Job to finish")
	err = framework.WaitForJobFinish(c, ns, job.Name)
	Expect(err).NotTo(HaveOccurred())

	framework.Logf("Wait for TTL after finished controller to delete the Job")
	err = framework.WaitForJobDeleting(c, ns, job.Name)
	Expect(err).NotTo(HaveOccurred())

	framework.Logf("Check Job's deletionTimestamp and compare with the time when the Job finished")
	job, err = framework.GetJob(c, ns, job.Name)
	Expect(err).NotTo(HaveOccurred())
	finishTime := framework.JobFinishTime(job)
	finishTimeUTC := finishTime.UTC()
	Expect(finishTime.IsZero()).NotTo(BeTrue())

	deleteAtUTC := job.ObjectMeta.DeletionTimestamp.UTC()
	Expect(deleteAtUTC).NotTo(BeNil())

	expireAtUTC := finishTimeUTC.Add(time.Duration(ttl) * time.Second)
	Expect(deleteAtUTC.Before(expireAtUTC)).To(BeFalse())
}