Terraform External Data Source调用Python获取Azure DevOps分支ID报错求助

问题根因 #

1. 请求URL拼接错误：你在Terraform的query参数里传入的organisation值已经包含https://dev.azure.com/前缀，Python脚本拼接请求URL时又重复添加了该前缀，导致最终请求的地址非法，接口返回非200状态码，branch_id变量仅在状态码为200的分支中定义，所以触发NameError。你单独运行Python脚本时大概率是硬编码了正确的organisation值，所以没有触发该问题。
2. 返回字段与Terraform取值不匹配：Python脚本输出的字典key为objectID，但Terraform的output中取的是result.branch_id，字段不对应，就算接口请求成功也拿不到返回值。
3. 缺少异常兜底逻辑：未处理接口请求失败、返回结果为空、分支匹配不到的场景，容易出现未定义变量、下标越界等错误。

修复方案 #

1. 调整Terraform配置

修改organisation参数值，仅传入组织名，去掉前缀：

data "external" "example" {
  program = ["python", "ex-data-source.py"]

  query = {
    organisation = "my-org" # 去掉https://dev.azure.com/前缀
    project = "my-proj"
    repositoryId = "my-repo"
    branch = "heads/my-branch"
    new_branch = "heads/newbranch"
    pat = "my-pat"
  }
}

# 取值key和Python输出的objectID对应
output "branch_id" {
  value = data.external.example.result.objectID
}

2. 调整Python脚本

增加变量初始化、异常处理、分支匹配逻辑：

import base64
import json
import sys
import requests

# 初始化变量，避免未定义错误
branch_id = ""
try:
    # 解析Terraform传入的参数
    input = sys.stdin.read()
    input_json = json.loads(input)

    pat = input_json.get("pat")
    organisation = input_json.get("organisation")
    project = input_json.get("project")
    repositoryId = input_json.get("repositoryId")
    branch = input_json.get("branch")

    # 构造请求头
    b64userpass = str(base64.b64encode(bytes(':' + pat, 'ascii')), 'ascii')
    headers = {
        'Accept': 'application/json',
        'Authorization': 'Basic %s' % b64userpass
    }

    # 拼接正确的请求URL
    list_url = f"https://dev.azure.com/{organisation}/{project}/_apis/git/repositories/{repositoryId}/refs?filter={branch}&api-version=6.1-preview.1"

    r = requests.get(list_url, headers=headers)
    r.raise_for_status() # 直接抛出请求错误，方便排查
    r_json = r.json()
    
    # 匹配到分支再取值
    if r_json.get("count", 0) > 0:
        for item in r_json["value"]:
            if branch in item["name"]:
                branch_id = item["objectId"]
                break
except Exception as e:
    # 错误输出到stderr，不影响Terraform对stdout的解析
    print(f"脚本执行出错: {str(e)}", file=sys.stderr)
    sys.exit(1)

# 返回结果给Terraform
output = {
    "objectID": branch_id
}
print(json.dumps(output))

验证方法 #

你可以先在本地模拟Terraform传参测试脚本执行：
执行命令：echo '{"organisation":"my-org","project":"my-proj","repositoryId":"my-repo","branch":"heads/my-branch","pat":"my-pat"}' | python ex-data-source.py，确认stdout输出正确的objectID即可。

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