com.tencent.devops.process.utils.DependOnUtils.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-process Show documentation
Show all versions of api-process Show documentation
Tencent blueking ci project
The newest version!
/*
* Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* BK-CI 蓝鲸持续集成平台 is licensed under the MIT license.
*
* A copy of the MIT License is included in this file.
*
*
* Terms of the MIT License:
* ---------------------------------------------------
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of
* the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
* LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
* NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package com.tencent.devops.process.utils
import com.tencent.devops.common.api.exception.ErrorCodeException
import com.tencent.devops.common.api.util.EnvUtils
import com.tencent.devops.common.pipeline.container.Container
import com.tencent.devops.common.pipeline.container.NormalContainer
import com.tencent.devops.common.pipeline.container.Stage
import com.tencent.devops.common.pipeline.container.VMBuildContainer
import com.tencent.devops.common.pipeline.enums.DependOnType
import com.tencent.devops.common.pipeline.pojo.DependOnConfig
import com.tencent.devops.process.constant.ProcessMessageCode
import java.util.regex.Pattern
import javax.ws.rs.core.Response
@Suppress("ALL")
object DependOnUtils {
private val regex = Pattern.compile("[,;]")
fun checkRepeatedJobId(
stage: Stage
) {
val jobIdSet = mutableSetOf()
stage.containers.forEach container@{ c ->
val jobId = c.jobId
if (jobId.isNullOrBlank()) {
return@container
}
if (jobIdSet.contains(jobId)) {
val jobName = getContainerName(stage = stage, container = c, jobId = jobId)
throw ErrorCodeException(
statusCode = Response.Status.CONFLICT.statusCode,
errorCode = ProcessMessageCode.ERROR_PIPELINE_JOBID_EXIST,
params = arrayOf(jobName, c.jobId!!),
defaultMessage = "$jobName 的jobId(${c.jobId})已存在"
)
}
jobIdSet.add(jobId)
}
removeNonexistentJob(
stage = stage,
jobIdSet = jobIdSet
)
}
/**
* 移除不存在的jobId
* 如果已选择的jobId名字被修改，前端并不会把job删除,而是不展示，需要后端将不存在的jobId删除
*/
private fun removeNonexistentJob(
stage: Stage,
jobIdSet: Set
) {
stage.containers.forEach container@{ c ->
val jobControlOption = when (c) {
is VMBuildContainer -> c.jobControlOption
is NormalContainer -> c.jobControlOption
else -> null
} ?: return@container
val isEmpty = jobControlOption.dependOnId?.isEmpty() ?: true
if (jobControlOption.dependOnType != DependOnType.ID || isEmpty) {
return@container
}
val existJobIds = jobControlOption.dependOnId!!.filter { jobIdSet.contains(it) }
jobControlOption.dependOnId = existJobIds
}
}
/**
* dependOn jobId与containerId映射
* 前端通过jobId声明依赖关系,流水线真正运行是通过containerId
*/
fun initDependOn(stage: Stage, params: Map) {
val allJobId2JobMap = mutableMapOf()
stage.containers.forEach container@{ c ->
if (c.jobId.isNullOrBlank()) {
return@container
}
allJobId2JobMap[c.jobId!!] = c
}
if (allJobId2JobMap.isEmpty()) {
return
}
val cycleCheckJobMap = mutableMapOf>()
stage.containers.forEach container@{ c ->
val jobControlOption = when (c) {
is VMBuildContainer -> c.jobControlOption
is NormalContainer -> c.jobControlOption
else -> null
} ?: return@container
val dependOnJobIds = getDependOnJobIds(
dependOnConfig = DependOnConfig(
dependOnType = jobControlOption.dependOnType,
dependOnId = jobControlOption.dependOnId,
dependOnName = jobControlOption.dependOnName
),
params = params
)
if (dependOnJobIds.isEmpty()) {
return@container
}
if (!c.jobId.isNullOrBlank()) {
cycleCheckJobMap[c.jobId!!] = dependOnJobIds
}
val containerId2JobIds = mutableMapOf()
// containerId与jobId做映射
dependOnJobIds.forEach { dependOnJobId ->
val dependOnJob = allJobId2JobMap[dependOnJobId] ?: return@forEach
containerId2JobIds[dependOnJob.id!!] = dependOnJobId
}
if (containerId2JobIds.isNotEmpty()) {
jobControlOption.dependOnContainerId2JobIds = containerId2JobIds
}
}
// 校验是否循环依赖
val visited = mutableMapOf()
cycleCheckJobMap.keys.forEach { jobId ->
dsf(
jobId = jobId,
dependOnMap = cycleCheckJobMap,
visited = visited,
stage = stage,
allJobId2JobMap = allJobId2JobMap
)
}
}
fun enableDependOn(container: Container): Boolean {
val jobControlOption = when (container) {
is VMBuildContainer -> container.jobControlOption
is NormalContainer -> container.jobControlOption
else -> null
} ?: return false
return when (jobControlOption.dependOnType) {
DependOnType.ID ->
jobControlOption.dependOnId != null && jobControlOption.dependOnId!!.isNotEmpty()
DependOnType.NAME ->
jobControlOption.dependOnName?.isNotEmpty() ?: false
else ->
false
}
}
private fun getDependOnJobIds(dependOnConfig: DependOnConfig, params: Map): List {
return when (dependOnConfig.dependOnType) {
DependOnType.ID -> {
if (dependOnConfig.dependOnId == null || dependOnConfig.dependOnId!!.isEmpty()) {
listOf()
} else {
dependOnConfig.dependOnId!!
}
}
DependOnType.NAME -> {
if (dependOnConfig.dependOnName.isNullOrBlank()) {
listOf()
} else {
val dependONames = dependOnConfig.dependOnName!!.split(regex)
dependONames.map { EnvUtils.parseEnv(it, params) }
}
}
else -> listOf()
}
}
/**
* visited: key为jobId,value: 0-未访问,1-正在访问,2-已经访问
*/
private fun dsf(
jobId: String,
dependOnMap: Map>,
visited: MutableMap,
stage: Stage,
allJobId2JobMap: Map
): Boolean {
if (visited[jobId] == 1) {
return true
}
if (visited[jobId] == 2) {
return false
}
visited[jobId] = 1
dependOnMap[jobId]?.forEach { dependOnJobId ->
if (dsf(
jobId = dependOnJobId,
dependOnMap = dependOnMap,
visited = visited,
stage = stage,
allJobId2JobMap = allJobId2JobMap
)
) {
val jobName = getContainerName(stage = stage, container = allJobId2JobMap[jobId], jobId = jobId)
val dependJobName = getContainerName(stage, allJobId2JobMap[dependOnJobId], jobId = dependOnJobId)
throw ErrorCodeException(
errorCode = ProcessMessageCode.ERROR_PIPELINE_DEPENDON_CYCLE,
params = arrayOf(jobName, dependJobName)
)
}
}
visited[jobId] = 2
return false
}
private fun getContainerName(stage: Stage, container: Container?, jobId: String): String {
if (container == null) {
return jobId
}
val namePrefix = stage.name?.removePrefix("stage-")
return "$namePrefix-${container.id}"
}
}