Feat 12010

src/backend/ci/core/common/common-auth/common-auth-api/src/main/kotlin/com/tencent/devops/common/auth/api/ActionId.kt

@@ -101,4 +101,12 @@ object ActionId {
     // 自定义操作
     const val PROJECT_USER_VERIFY = "project_user_verify"
     const val WATER_MARK_GET = "water_mark_get"
+
+    // 公共变量组
+    const val PUBLIC_VARIABLE_CREATE = "public_variable_create"
+    const val PUBLIC_VARIABLE_EDIT = "public_variable_edit"
+    const val PUBLIC_VARIABLE_LIST = "public_variable_list"
+    const val PUBLIC_VARIABLE_VIEW = "public_variable_view"
+    const val PUBLIC_VARIABLE_DELETE = "public_variable_delete"
+    const val PUBLIC_VARIABLE_USE = "public_variable_use"
 }

src/backend/ci/core/common/common-auth/common-auth-api/src/main/kotlin/com/tencent/devops/common/auth/api/AuthResourceType.kt

@@ -37,6 +37,8 @@ enum class AuthResourceType(val value: String) {
     PIPELINE_GROUP("pipeline_group"), // 流水线组类型
     PIPELINE_TEMPLATE("pipeline_template"), // 流水线模板类型
 
+    PUBLIC_VAR_GROUP("public_variable"), // 公共变量组
+
     ARTIFACTORY_CUSTOM_DIR("custom_dir"), // 版本仓库自定义目录
 
     TICKET_CREDENTIAL("credential"), // 凭证服务凭据

src/backend/ci/core/common/common-auth/common-auth-api/src/main/kotlin/com/tencent/devops/common/auth/code/PublicVarGroupAuthServiceCode.kt

@@ -0,0 +1,34 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2019 Tencent.  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.auth.code
+
+/**
+ * 公共变量组ServiceCode
+ */
+interface PublicVarGroupAuthServiceCode : AuthServiceCode

src/backend/ci/core/common/common-auth/common-auth-provider/src/main/kotlin/com/tencent/devops/common/auth/rbac/RbacAuthAutoConfiguration.kt

@@ -45,6 +45,7 @@ import com.tencent.devops.common.auth.rbac.code.RbacExperienceAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacPipelineAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacPipelineGroupAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacProjectAuthServiceCode
+import com.tencent.devops.common.auth.rbac.code.RbacPublicVarGroupAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacQualityAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacRepoAuthServiceCode
 import com.tencent.devops.common.auth.rbac.code.RbacTicketAuthServiceCode
@@ -159,4 +160,8 @@ class RbacAuthAutoConfiguration {
     @Bean
     @Primary
     fun experienceAuthServiceCode() = RbacExperienceAuthServiceCode()
+
+    @Bean
+    @Primary
+    fun publicVarGroupAuthServiceCode() = RbacPublicVarGroupAuthServiceCode()
 }

src/backend/ci/core/common/common-auth/common-auth-provider/src/main/kotlin/com/tencent/devops/common/auth/rbac/code/RbacPublicVarGroupAuthServiceCode.kt

@@ -0,0 +1,7 @@
+package com.tencent.devops.common.auth.rbac.code
+
+import com.tencent.devops.common.auth.code.PublicVarGroupAuthServiceCode
+
+class RbacPublicVarGroupAuthServiceCode : PublicVarGroupAuthServiceCode {
+    override fun id() = RbacAuthServiceCode.PIPELINE.value
+}

src/backend/ci/core/common/common-event/src/main/kotlin/com/tencent/devops/common/stream/constants/StreamBinding.kt

@@ -242,4 +242,7 @@ object StreamBinding {
     const val PIPELINE_YAML_FILE_SCHEDULER = "pipeline.yaml.file.scheduler"
     // yaml文件执行事件
     const val PIPELINE_YAML_FILE_EXECUTOR = "pipeline.yaml.file.executor"
+
+    // 变量引用事件监听器
+    const val MODEL_VAR_REFERENCE_FANOUT = "model.var.reference.fanout"
 }

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/creator/ModelCreate.kt

@@ -95,7 +95,7 @@ class ModelCreate @Autowired constructor(
             startEpoch = null,
             systemElapsed = null,
             elementElapsed = null,
-            params = pipelineParams
+            params = pipelineParams.toMutableList()
         )
 
         // 蓝盾引擎会将stageId从1开始顺序强制重写，因此在生成model时保持一致

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/transfer/ModelTransfer.kt

@@ -36,6 +36,7 @@ import com.tencent.devops.common.pipeline.container.Stage
 import com.tencent.devops.common.pipeline.container.TriggerContainer
 import com.tencent.devops.common.pipeline.dialect.PipelineDialectType
 import com.tencent.devops.common.pipeline.enums.TemplateRefType
+import com.tencent.devops.common.pipeline.pojo.PublicVarGroupRef
 import com.tencent.devops.common.pipeline.pojo.TemplateInstanceField
 import com.tencent.devops.common.pipeline.pojo.TemplateInstanceRecommendedVersion
 import com.tencent.devops.common.pipeline.pojo.TemplateInstanceTriggerConfig
@@ -64,14 +65,16 @@ import com.tencent.devops.process.yaml.v3.models.Notices
 import com.tencent.devops.process.yaml.v3.models.PacNotices
 import com.tencent.devops.process.yaml.v3.models.PreExtends
 import com.tencent.devops.process.yaml.v3.models.PreTemplateScriptBuildYamlV3Parser
+import com.tencent.devops.process.yaml.v3.models.VariableTemplate
 import com.tencent.devops.process.yaml.v3.models.on.IPreTriggerOn
 import com.tencent.devops.process.yaml.v3.models.on.PreTriggerOn
 import com.tencent.devops.process.yaml.v3.models.on.PreTriggerOnV3
 import com.tencent.devops.process.yaml.v3.models.stage.PreStage
+import com.tencent.devops.process.yaml.v3.parsers.template.Constants.TEMPLATE_KEY
+import java.util.concurrent.atomic.AtomicInteger
 import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.stereotype.Component
-import java.util.concurrent.atomic.AtomicInteger
 
 @Component
 @Suppress("ComplexMethod")
@@ -180,6 +183,9 @@ class ModelTransfer @Autowired constructor(
             pipelineCreator = yamlInput.pipelineInfo?.creator ?: yamlInput.userId
         )
         model.latestVersion = yamlInput.pipelineInfo?.version ?: 0
+        model.publicVarGroups = yamlInput.yaml.formatVariableTemplates().map {
+            PublicVarGroupRef(groupName = it.name, versionName = it.version)
+        }
 
         // 蓝盾引擎会将stageId从1开始顺序强制重写，因此在生成model时保持一致
         val stageIndex = AtomicInteger(0)
@@ -323,7 +329,16 @@ class ModelTransfer @Autowired constructor(
         }
         yaml.notices = makeNoticesV3(modelInput)
         yaml.stages = makeStages(modelInput).ifEmpty { null }?.let { TransferMapper.anyTo(it) }
-        yaml.variables = variableTransfer.makeVariableFromModel(getTriggerContainer(modelInput))
+        val variables = mutableMapOf<String, Any>()
+        modelInput.model.handlePublicVarInfo()
+        val publicVarGroups = modelInput.model.publicVarGroups
+        if (!publicVarGroups.isNullOrEmpty()) {
+            variables[TEMPLATE_KEY] = publicVarGroups.map {
+                VariableTemplate(it.groupName, it.versionName)
+            }
+        }
+        variableTransfer.makeVariableFromModel(modelInput.model.getTriggerContainer())?.let { variables.putAll(it) }
+        yaml.variables = if (variables.isEmpty()) null else variables
         yaml.extends = makeExtend(modelInput.model)
         yaml.finally = makeFinally(modelInput)?.ifEmpty { null }
         yaml.concurrency = makeConcurrency(modelInput)

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/transfer/StageTransfer.kt

@@ -108,7 +108,6 @@ class StageTransfer @Autowired(required = false) constructor(
         // 第一个stage，触发类
         val triggerElementList = mutableListOf<Element>()
         elementTransfer.yaml2Triggers(yamlInput, triggerElementList)
-
         val triggerContainer = TriggerContainer(
             id = "0",
             name = I18nUtil.getCodeLanMessage(CommonMessageCode.BK_BUILD_TRIGGER),
@@ -117,7 +116,7 @@ class StageTransfer @Autowired(required = false) constructor(
             startEpoch = null,
             systemElapsed = null,
             elementElapsed = null,
-            params = variableTransfer.makeVariableFromYaml(makeVariables(yamlInput.yaml))
+            params = variableTransfer.makeVariableFromYaml(makeVariables(yamlInput.yaml)).toMutableList()
         )
         with(yamlInput.yaml.recommendedVersion) {
             if (this != null && this.enabled) {

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/transfer/TemplateModelTransfer.kt

@@ -34,6 +34,7 @@ import com.tencent.devops.common.pipeline.container.Stage
 import com.tencent.devops.common.pipeline.container.TriggerContainer
 import com.tencent.devops.common.pipeline.dialect.PipelineDialectType
 import com.tencent.devops.common.pipeline.pojo.setting.BuildCancelPolicy
+import com.tencent.devops.common.pipeline.pojo.PublicVarGroupRef
 import com.tencent.devops.common.pipeline.pojo.setting.PipelineRunLockType
 import com.tencent.devops.common.pipeline.pojo.setting.PipelineSetting
 import com.tencent.devops.common.pipeline.template.ITemplateModel
@@ -48,10 +49,12 @@ import com.tencent.devops.process.yaml.transfer.pojo.YamlTransferInput
 import com.tencent.devops.process.yaml.v3.enums.SyntaxDialectType
 import com.tencent.devops.process.yaml.v3.models.IPreTemplateScriptBuildYamlParser
 import com.tencent.devops.process.yaml.v3.models.PreTemplateScriptBuildYamlV3Parser
+import com.tencent.devops.process.yaml.v3.models.VariableTemplate
 import com.tencent.devops.process.yaml.v3.models.on.IPreTriggerOn
 import com.tencent.devops.process.yaml.v3.models.on.PreTriggerOn
 import com.tencent.devops.process.yaml.v3.models.on.PreTriggerOnV3
 import com.tencent.devops.process.yaml.v3.models.stage.PreStage
+import com.tencent.devops.process.yaml.v3.parsers.template.Constants.TEMPLATE_KEY
 import org.slf4j.LoggerFactory
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.stereotype.Component
@@ -180,7 +183,21 @@ class TemplateModelTransfer @Autowired constructor(
             stages.add(ymlStage)
         }
         baseYaml.stages = stages.ifEmpty { null }?.let { TransferMapper.anyTo(stages) }
-        baseYaml.variables = model.triggerContainer()?.let { variableTransfer.makeVariableFromModel(it) }
+        baseYaml.variables = model.triggerContainer()?.let { triggerContainer ->
+            // 刷新公共变量配置信息
+            modelInput.model.handlePublicVarInfo()
+            val variables = mutableMapOf<String, Any>()
+            val publicVarGroupNames = modelInput.model.getPublicVarGroups()
+            if (!publicVarGroupNames.isNullOrEmpty()) {
+                variables[TEMPLATE_KEY] = publicVarGroupNames.map {
+                    VariableTemplate(it.groupName, it.versionName)
+                }
+            }
+            variableTransfer.makeVariableFromModel(triggerContainer)?.let { modelVariables ->
+                variables.putAll(modelVariables)
+            }
+            variables.ifEmpty { null }
+        }
         val lastStage = model.stages()?.last()
         val finally = if (lastStage?.finally == true) {
             modelInput.aspectWrapper.setModelStage4Model(lastStage, PipelineTransferAspectWrapper.AspectType.BEFORE)
@@ -221,6 +238,21 @@ class TemplateModelTransfer @Autowired constructor(
         else -> null
     }
 
+    private fun ITemplateModel.handlePublicVarInfo() = when (this) {
+        is Model -> handlePublicVarInfo()
+        is StageTemplateModel -> null
+        is JobTemplateModel -> null
+        is StepTemplateModel -> null
+        else -> null
+    }
+
+    private fun ITemplateModel.getPublicVarGroups(): List<PublicVarGroupRef>? {
+        if (this !is Model) {
+            return null
+        }
+        return publicVarGroups
+    }
+
     private fun ITemplateModel.stages() = when (this) {
         is Model -> stages
         is StageTemplateModel -> stages

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/transfer/VariableTransfer.kt

@@ -58,10 +58,17 @@ class VariableTransfer {
             listOf(MAJORVERSION, "MajorVersion", MINORVERSION, "MinorVersion", FIXVERSION, "FixVersion")
     }
 
-    fun makeVariableFromModel(triggerContainer: TriggerContainer?): Map<String, Variable>? {
+    fun makeVariableFromModel(triggerContainer: TriggerContainer?): Map<String, Any>? {
+        if (triggerContainer != null) {
+            return makeVariableFromBuildParams(triggerContainer.params, true)
+        }
+        return null
+    }
+
+    fun makeVariableFromBuildParams(params: List<BuildFormProperty>, skipPublicVar: Boolean): Map<String, Variable>? {
         val result = mutableMapOf<String, Variable>()
-        triggerContainer?.params?.forEach {
-            if (it.id in ignoredVariable) return@forEach
+        params.forEach {
+            if (it.id in ignoredVariable || (skipPublicVar && it.varGroupName != null)) return@forEach
             var props = when {
                 // 字符串
                 it.type == BuildFormPropertyType.STRING -> VariableProps(

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/transfer/pojo/PublicVarGroupYamlParser.kt

@@ -0,0 +1,43 @@
+/*
+ * Tencent is pleased to support the open source community by making BK-CI 蓝鲸持续集成平台 available.
+ *
+ * Copyright (C) 2019 Tencent.  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.yaml.transfer.pojo
+
+import com.tencent.devops.process.yaml.v3.models.Variable
+import io.swagger.v3.oas.annotations.media.Schema
+
+@Schema(title = "公共变量组yaml解析")
+data class PublicVarGroupYamlParser(
+    @get:Schema(title = "yaml版本")
+    val version: String,
+    @get:Schema(title = "变量组名称")
+    val name: String,
+    @get:Schema(title = "变量组描述")
+    val desc: String? = null,
+    @get:Schema(title = "变量列表")
+    val variables: Map<String, Variable>
+)

src/backend/ci/core/common/common-pipeline-yaml/src/main/kotlin/com/tencent/devops/process/yaml/v2/utils/YamlCommonUtils.kt

@@ -35,6 +35,10 @@ import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator
 import com.fasterxml.jackson.module.kotlin.registerKotlinModule
 import com.tencent.devops.process.yaml.v2.models.YAME_META_DATA_JSON_FILTER
+import jakarta.ws.rs.core.MediaType
+import jakarta.ws.rs.core.Response
+import jakarta.ws.rs.core.StreamingOutput
+import java.net.URLEncoder
 
 object YamlCommonUtils {
     private val objectMapper = ObjectMapper(
@@ -55,4 +59,18 @@ object YamlCommonUtils {
         objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL)
         return objectMapper.writeValueAsString(bean)!!
     }
+
+    fun exportToFile(yaml: String, fileName: String): Response {
+        // 流式下载
+        val fileStream = StreamingOutput { output ->
+            output.write(yaml.toByteArray(Charsets.UTF_8))
+            output.flush()
+        }
+        val encodedFileName = URLEncoder.encode("$fileName.yml", "UTF-8")
+        return Response
+            .ok(fileStream, MediaType.APPLICATION_OCTET_STREAM_TYPE)
+            .header("content-disposition", "attachment; filename = $encodedFileName")
+            .header("Cache-Control", "no-cache")
+            .build()
+    }
 }