com.tencent.devops.common.pipeline.pojo.element.Element.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-pipeline 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.common.pipeline.pojo.element

import com.fasterxml.jackson.annotation.JsonSubTypes
import com.fasterxml.jackson.annotation.JsonTypeInfo
import com.tencent.devops.common.api.util.JsonUtil
import com.tencent.devops.common.pipeline.IModelTemplate
import com.tencent.devops.common.pipeline.NameAndValue
import com.tencent.devops.common.pipeline.enums.BuildStatus
import com.tencent.devops.common.pipeline.enums.StartType
import com.tencent.devops.common.pipeline.pojo.element.agent.CodeGitElement
import com.tencent.devops.common.pipeline.pojo.element.agent.CodeGitlabElement
import com.tencent.devops.common.pipeline.pojo.element.agent.CodeSvnElement
import com.tencent.devops.common.pipeline.pojo.element.agent.GithubElement
import com.tencent.devops.common.pipeline.pojo.element.agent.LinuxScriptElement
import com.tencent.devops.common.pipeline.pojo.element.agent.ManualReviewUserTaskElement
import com.tencent.devops.common.pipeline.pojo.element.agent.WindowsScriptElement
import com.tencent.devops.common.pipeline.pojo.element.market.MarketBuildAtomElement
import com.tencent.devops.common.pipeline.pojo.element.market.MarketBuildLessAtomElement
import com.tencent.devops.common.pipeline.pojo.element.market.MarketCheckImageElement
import com.tencent.devops.common.pipeline.pojo.element.matrix.MatrixStatusElement
import com.tencent.devops.common.pipeline.pojo.element.quality.QualityGateInElement
import com.tencent.devops.common.pipeline.pojo.element.quality.QualityGateOutElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeGitWebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeGithubWebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeGitlabWebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeP4WebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeSVNWebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.CodeTGitWebHookTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.ManualTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.RemoteTriggerElement
import com.tencent.devops.common.pipeline.pojo.element.trigger.TimerTriggerElement
import com.tencent.devops.common.pipeline.pojo.time.BuildRecordTimeCost
import com.tencent.devops.common.pipeline.pojo.transfer.PreStep
import com.tencent.devops.common.pipeline.utils.ElementUtils
import io.swagger.v3.oas.annotations.media.Schema
import org.json.JSONObject

@JsonTypeInfo(
    use = JsonTypeInfo.Id.NAME,
    include = JsonTypeInfo.As.PROPERTY,
    property = "@type",
    defaultImpl = EmptyElement::class
)
@JsonSubTypes(
    JsonSubTypes.Type(value = MatrixStatusElement::class, name = MatrixStatusElement.classType),
    JsonSubTypes.Type(value = CodeGitWebHookTriggerElement::class, name = CodeGitWebHookTriggerElement.classType),
    JsonSubTypes.Type(value = CodeGitlabWebHookTriggerElement::class, name = CodeGitlabWebHookTriggerElement.classType),
    JsonSubTypes.Type(value = CodeSVNWebHookTriggerElement::class, name = CodeSVNWebHookTriggerElement.classType),
    JsonSubTypes.Type(value = CodeGithubWebHookTriggerElement::class, name = CodeGithubWebHookTriggerElement.classType),
    JsonSubTypes.Type(value = CodeGitElement::class, name = CodeGitElement.classType),
    JsonSubTypes.Type(value = CodeGitlabElement::class, name = CodeGitlabElement.classType),
    JsonSubTypes.Type(value = GithubElement::class, name = GithubElement.classType),
    JsonSubTypes.Type(value = CodeSvnElement::class, name = CodeSvnElement.classType),
    JsonSubTypes.Type(value = LinuxScriptElement::class, name = LinuxScriptElement.classType),
    JsonSubTypes.Type(value = WindowsScriptElement::class, name = WindowsScriptElement.classType),
    JsonSubTypes.Type(value = ManualTriggerElement::class, name = ManualTriggerElement.classType),
    JsonSubTypes.Type(value = RemoteTriggerElement::class, name = RemoteTriggerElement.classType),
    JsonSubTypes.Type(value = TimerTriggerElement::class, name = TimerTriggerElement.classType),
    JsonSubTypes.Type(value = ManualReviewUserTaskElement::class, name = ManualReviewUserTaskElement.classType),
    JsonSubTypes.Type(value = SubPipelineCallElement::class, name = SubPipelineCallElement.classType),
    JsonSubTypes.Type(value = MarketBuildAtomElement::class, name = MarketBuildAtomElement.classType),
    JsonSubTypes.Type(value = MarketBuildLessAtomElement::class, name = MarketBuildLessAtomElement.classType),
    JsonSubTypes.Type(value = MarketCheckImageElement::class, name = MarketCheckImageElement.classType),
    JsonSubTypes.Type(value = QualityGateInElement::class, name = QualityGateInElement.classType),
    JsonSubTypes.Type(value = QualityGateOutElement::class, name = QualityGateOutElement.classType),
    JsonSubTypes.Type(value = CodeTGitWebHookTriggerElement::class, name = CodeTGitWebHookTriggerElement.classType),
    JsonSubTypes.Type(value = CodeP4WebHookTriggerElement::class, name = CodeP4WebHookTriggerElement.classType)
)
@Suppress("ALL")
@Schema(title = "Element 基类")
abstract class Element(
    @get:Schema(title = "任务名称", required = false)
    open val name: String,
    @get:Schema(title = "id", required = false)
    open var id: String? = null,
    @get:Schema(title = "状态(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var status: String? = null,
    @get:Schema(title = "执行次数(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var executeCount: Int = 1,
    @get:Schema(title = "是否重试(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var canRetry: Boolean? = null,
    @get:Schema(title = "是否跳过(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var canSkip: Boolean? = null,
    @get:Schema(title = "执行时间(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    @Deprecated("即将被timeCost代替")
    open var elapsed: Long? = null,
    @get:Schema(title = "启动时间(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    @Deprecated("即将被timeCost代替")
    open var startEpoch: Long? = null,
    @get:Schema(title = "插件原始版本(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var originVersion: String? = null,
    @get:Schema(title = "插件版本", required = true)
    open var version: String = "1.*",
    @get:Schema(title = "模板对比的时候是不是有变更(temporary field)", required = false)
    open var templateModify: Boolean? = null, // 模板对比的时候是不是又变更
    @get:Schema(title = "附加参数", required = false)
    open var additionalOptions: ElementAdditionalOptions? = null,
    @get:Schema(title = "用户自定义ID，用于上下文键值设置", required = false)
    open var stepId: String? = null, // 用于上下文键值设置
    @get:Schema(title = "各项耗时", required = true)
    open var timeCost: BuildRecordTimeCost? = null,
    @get:Schema(title = "用户自定义环境变量（插件运行时写入环境）", required = false)
    open var customEnv: List? = null,
    @get:Schema(title = "错误类型(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var errorType: String? = null,
    @get:Schema(title = "错误代码(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var errorCode: Int? = null,
    @get:Schema(title = "错误信息(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var errorMsg: String? = null,
    @get:Schema(
        title = "插件名称,构建结束后的快照名称(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）",
        required = false
    )
    open var atomName: String? = null,
    @get:Schema(title = "所属插件分类代码(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false)
    open var classifyCode: String? = null,
    @get:Schema(
        title = "所属插件分类名称(仅在运行构建时有用的中间参数，不要在编排保存阶段设置值）", required = false
    )
    open var classifyName: String? = null,
    @get:Schema(title = "任务运行进度", required = false)
    open var progressRate: Double? = null,
    override var template: String? = null,
    override var ref: String? = null,
    override var variables: Map? = null,
    var asyncStatus: String? = null
) : IModelTemplate {

    open fun getAtomCode() = getClassType()

    abstract fun getClassType(): String

    open fun getTaskAtom(): String = ""

    open fun genTaskParams(): MutableMap {
        return JsonUtil.toMutableMap(this)
    }

    open fun cleanUp() {}

    open fun transferYaml(defaultValue: JSONObject?): PreStep? = null

    open fun elementEnabled(): Boolean {
        return additionalOptions?.enable ?: true
    }

    /**
     * 兼容性初始化等处理
     */
    fun transformCompatibility() {
        if (additionalOptions != null && additionalOptions!!.timeoutVar.isNullOrBlank()) {
            additionalOptions!!.timeoutVar = additionalOptions!!.timeout.toString()
        }
    }

    /**
     * 根据[startType]类型返回element的id值，如果不符合，则返回空字符串""
     */
    open fun findFirstTaskIdByStartType(startType: StartType): String = ""

    /**
     * 除非是本身的[elementEnabled]设置为未启用插件会返回SKIP，或者是设置了失败手动跳过
     * [rerun]允许对状态进行重置为QUEUE
     */
    fun initStatus(rerun: Boolean = false): BuildStatus {
        return if (!elementEnabled()) { // 插件未启用
            BuildStatus.SKIP // 跳过
        } else if (rerun) { // 除以上指定跳过或不启用的以外，在final Stage 下的插件都需要重置状态
            BuildStatus.QUEUE
        } else if (status == BuildStatus.SKIP.name) { // 原本状态为SKIP，一般为 Rebuild/Fail Retry 的上一次执行标志下来
            BuildStatus.SKIP // 跳过
        } else {
            BuildStatus.QUEUE // 默认为排队状态
        }
    }

    fun disableBySkipVar(variables: Map) {
        val elementPostInfo = additionalOptions?.elementPostInfo
        val postFlag = elementPostInfo != null
        // post插件的父插件如果跳过执行，则其自身也需要跳过执行
        val elementId = if (postFlag) elementPostInfo?.parentElementId else id
        if (variables[ElementUtils.getSkipElementVariableName(elementId)] == "true") { // 参数中指明要求跳过
            if (additionalOptions == null) {
                additionalOptions = ElementAdditionalOptions(runCondition = RunCondition.PRE_TASK_SUCCESS)
            }
            additionalOptions!!.enable = false
        }
    }

    open fun initTaskVar(): MutableMap = mutableMapOf()
}