k8s.io/kubernetes@v1.31.0-alpha.0.0.20240520171757-56147500dadc/pkg/controller/job/util/utils.go (about)

     1  /*
     2  Copyright 2016 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package util
    18  
    19  import (
    20  	batch "k8s.io/api/batch/v1"
    21  	v1 "k8s.io/api/core/v1"
    22  )
    23  
    24  // FinishedCondition returns true if a job is finished as well as the condition type indicating that.
    25  // Returns false and no condition type otherwise
    26  func FinishedCondition(j *batch.Job) (bool, batch.JobConditionType) {
    27  	for _, c := range j.Status.Conditions {
    28  		if (c.Type == batch.JobComplete || c.Type == batch.JobFailed) && c.Status == v1.ConditionTrue {
    29  			return true, c.Type
    30  		}
    31  	}
    32  	return false, ""
    33  }
    34  
    35  // IsJobFinished checks whether the given Job has finished execution.
    36  // It does not discriminate between successful and failed terminations.
    37  func IsJobFinished(j *batch.Job) bool {
    38  	isFinished, _ := FinishedCondition(j)
    39  	return isFinished
    40  }
    41  
    42  // IsJobSucceeded returns whether a job has completed successfully.
    43  func IsJobSucceeded(j *batch.Job) bool {
    44  	for _, c := range j.Status.Conditions {
    45  		if c.Type == batch.JobComplete && c.Status == v1.ConditionTrue {
    46  			return true
    47  		}
    48  	}
    49  	return false
    50  }