feat：流水线变量语法支持两种风格 #10576

TencentBlueKing · Sep 22, 2024 · f31c3fb · f31c3fb
1 parent e1d95ee
commit f31c3fb
Show file tree

Hide file tree

Showing 3 changed files with 375 additions and 34 deletions.
diff --git a/...ommon-pipeline/src/main/kotlin/com/tencent/devops/common/pipeline/EnvReplacementParser.kt b/...ommon-pipeline/src/main/kotlin/com/tencent/devops/common/pipeline/EnvReplacementParser.kt
@@ -66,20 +66,25 @@ object EnvReplacementParser {
 
     /**
      * 根据环境变量map进行object处理并保持原类型
-     * 根据方言的配置判断是否能够使用${}或者变量值是否存在
+     * @param value 等待进行环境变量替换的对象，可以是任意类型
+     * @param contextMap 环境变量map值
+     * @param contextPair 自定义表达式计算上下文（如果指定则不使用表达式替换或默认替换逻辑）
+     * @param onlyExpression 只进行表达式替换（若指定了自定义替换逻辑此字段无效，为false）
+     * @param functions 用户自定义的拓展用函数
+     * @param output 表达式计算时输出
      */
     fun parse(
         value: String?,
         contextMap: Map<String, String>,
-        dialect: IPipelineDialect,
+        onlyExpression: Boolean? = false,
         contextPair: Pair<ExecutionContext, List<NamedValueInfo>>? = null,
         functions: Iterable<IFunctionInfo>? = null,
         output: ExpressionOutput? = null
     ): String {
         val context = EnvReplacementContext(
             value = value,
             contextMap = contextMap,
-            dialect = dialect,
+            useSingleCurlyBraces = !(onlyExpression ?: false),
             contextPair = contextPair,
             functions = functions,
             output = output
@@ -89,18 +94,20 @@ object EnvReplacementParser {
 
     /**
      * 根据环境变量map进行object处理并保持原类型
-     * 能够使用${}占位符替换,变量值不存在不抛异常
+     * 根据方言的配置判断是否能够使用${}或者变量值是否存在
      */
     fun parse(
         value: String?,
         contextMap: Map<String, String>,
+        dialect: IPipelineDialect,
         contextPair: Pair<ExecutionContext, List<NamedValueInfo>>? = null,
         functions: Iterable<IFunctionInfo>? = null,
         output: ExpressionOutput? = null
     ): String {
         val context = EnvReplacementContext(
             value = value,
             contextMap = contextMap,
+            dialect = dialect,
             contextPair = contextPair,
             functions = functions,
             output = output
@@ -109,33 +116,14 @@ object EnvReplacementParser {
     }
 
     fun parse(context: EnvReplacementContext): String {
-        with (context) {
+        with(context) {
             if (value.isNullOrBlank()) return ""
-            var newValue = value
-            if (useSingleCurlyBraces) {
-                newValue = ObjectReplaceEnvVarUtil.replaceEnvVar(newValue, contextMap).let {
+            val newValue = parseExpression()
+
+            return if (useSingleCurlyBraces) {
+                ObjectReplaceEnvVarUtil.replaceEnvVar(newValue, contextMap).let {
                     JsonUtil.toJson(it, false)
                 }
-            }
-            return if (containsExpressions(newValue)) {
-                try {
-                    val (executeContext, nameValues) = contextPair
-                        ?: getCustomExecutionContextByMap(contextMap)
-                        ?: return value
-                    parseExpression(
-                        value = newValue,
-                        context = executeContext,
-                        nameValues = nameValues,
-                        functions = functions,
-                        output = output,
-                        contextNotNull = contextNotNull
-                    )
-                } catch (ex: VariableNotFoundException) {
-                    throw ex
-                } catch (ignore: Throwable) {
-                    logger.warn("[$value]|EnvReplacementParser expression invalid: ", ignore)
-                    value
-                }
             } else {
                 newValue
             }
@@ -159,11 +147,34 @@ object EnvReplacementParser {
             ExpressionParser.fillContextByMap(variables, context, nameValue)
             return Pair(context, nameValue)
         } catch (ignore: Throwable) {
+            println("EnvReplacementParser context invalid: $variables")
             logger.warn("EnvReplacementParser context invalid: $variables", ignore)
             return null
         }
     }
 
+    private fun EnvReplacementContext.parseExpression(): String {
+        if (value.isNullOrBlank()) return ""
+        return try {
+            val (executeContext, nameValues) = contextPair
+                ?: getCustomExecutionContextByMap(contextMap)
+                ?: return value
+            parseExpression(
+                value = value,
+                context = executeContext,
+                nameValues = nameValues,
+                functions = functions,
+                output = output,
+                contextNotNull = contextNotNull
+            )
+        } catch (ex: VariableNotFoundException) {
+            throw ex
+        } catch (ignore: Throwable) {
+            logger.warn("[$value]|EnvReplacementParser expression invalid: ", ignore)
+            value
+        }
+    }
+
     private fun parseExpression(
         value: String,
         nameValues: List<NamedValueInfo>,