Groovy Jenkinsfile循环数组调用API获取Workspace ID并生成Payload的问题

问题1：getWorkspaceId仅返回第一个工作区ID #

错误原因 #

原代码中return data.data.id写在for循环内部，第一次循环执行到这里就直接返回了，后续的工作区遍历逻辑完全没机会执行。

修复后的代码 #

def getWorkspaceIds(config) {
    def purl = pipelineUtil.getConfiguration('purl')
    def token = pipelineUtil.getConfiguration('token')
    def workspaceIds = [] // 创建列表存储所有工作区ID

    for (workspaceName in config.workspace_name) {
        def response = httpRequest(
            customHeaders: [
                [name: "Authorization", value: "Bearer ${token}"], 
                [name: "Content-Type", value: "application/vnd.api+json"]
            ],
            url: "${purl}/api/v2/organizations/${config.tfeorganization}/workspaces/${workspaceName}"
        )

        def data = new JsonSlurper().parseText(response.content)
        def workspaceId = data.data.id
        println("Workspace Id: ${workspaceId}")
        workspaceIds.add(workspaceId) // 将每个ID加入列表
    }

    return workspaceIds // 循环结束后返回完整的ID列表
}

注：方法名从getWorkspaceId改为getWorkspaceIds，更符合返回多个ID的语义

问题2：Payload无法动态传入多个工作区ID #

错误原因 #

原代码只接收单个ID，无法处理数组结构的工作区ID列表，且用字符串拼接单个对象的方式无法扩展到多个。

修复方案（推荐用JsonBuilder生成，避免字符串拼接错误） #

def setPayload(config) {
    def workspaceIds = getWorkspaceIds(config)
    def policysetName = pipelineUtil.getConfiguration('policysetName') // 根据实际场景获取策略集名称

    // 用Groovy的JsonBuilder构建JSON，自动处理数组结构
    def payloadBuilder = new groovy.json.JsonBuilder()
    payloadBuilder {
        data {
            type "policy-sets"
            attributes {
                name policysetName
                global false
                kind "sentinel"
            }
            relationships {
                workspaces {
                    data workspaceIds.collect { id ->
                        [id: id, type: "workspaces"]
                    }
                }
            }
        }
    }

    return payloadBuilder.toPrettyString() // 返回格式化的JSON字符串
}

备选方案（字符串拼接方式） #

如果偏好直接拼接字符串，可以这样写：

def setPayload(config) {
    def workspaceIds = getWorkspaceIds(config)
    def policysetName = pipelineUtil.getConfiguration('policysetName')

    // 将每个ID转换为JSON对象字符串，再用逗号连接
    def workspacesData = workspaceIds.collect { id ->
        "{ \"id\": \"${id}\", \"type\": \"workspaces\" }"
    }.join(", ")

    def payload = """
{
    "data": {
      "type": "policy-sets",
      "attributes": {
        "name": "${policysetName}",
        "global": false,
        "kind": "sentinel"
      },
      "relationships": {
        "workspaces": {
          "data": [
            ${workspacesData}
          ]
        }
      }
    }
  }
""".trim()
    return payload
}

内容的提问来源于stack exchange，提问作者green_car