Azure DevOps YAML Pipeline：遍历测试套件列表生成独立任务

问题 #

我在Azure DevOps YAML流水线中运行WebdriverIO测试套件，需求是：当用户选择all-suites时，自动为每个测试套件创建独立的流水线任务。目前我得手动为每个套件编写重复的任务代码块，希望改成通过遍历套件列表的方式实现，避免新增套件时重复劳动。

当前流水线代码：

parameters:
    - name: testSuite
      type: string
      default: 'all-suites'
      values:
          - 'all-suites'
          - 'suite1'
          - 'suite2'
          - 'suite3'

trigger: none

jobs:
    - job: run_pipeline
      timeoutInMinutes: 120
      displayName: 'Run'
      pool:
          vmImage: 'ubuntu-latest'

      steps:
          # 运行单个选中的套件
          - ${{ if ne(parameters.testSuite, 'all-suites') }}:
                - script: |
                      npm run example-command -- --suite ${{ parameters.testSuite }}
                  displayName: 'Run test suite: ${{ parameters.testSuite }}'
                  continueOnError: true
          # 手动编写每个套件的任务
          - ${{ if eq(parameters.testSuite, 'all-suites') }}:
                - script: |
                      npm run example-command -- --suite suite1
                  displayName: 'suite1'
                  continueOnError: true

                - script: |
                      npm run example-command -- --suite suite2
                  displayName: 'suite2'
                  continueOnError: true

                - script: |
                      npm run example-command -- --suite suite3
                  displayName: 'suite3'
                  continueOnError: true

我想改成这种迭代写法：

steps:
    - ${{ if ne(parameters.testSuite, 'all-suites') }}:
          - script: |
                npm run example-command -- --suite ${{ parameters.testSuite }}
            displayName: 'Run test suite: ${{ parameters.testSuite }}'
            continueOnError: true

    - ${{ if eq(parameters.testSuite, 'all-suites') }}:
          - ${{ each suite in <SUITE LIST HERE> }}:
                # 跳过all-suites这个选项
                - ${{ if ne(suite, 'all-suites') }}:
                      - script: |
                            npm run example-command -- --suite ${{ suite }}
                        displayName: '${{ suite }}'
                        continueOnError: true

但听说只有编译时可访问的列表才能实现这种遍历，想请教有没有可行方案？

解决方案 #

可以通过定义编译时可访问的变量列表来实现，把套件列表抽离成独立变量，既作为参数的可选值，又用于遍历生成任务，不用重复维护。

优化后的完整流水线代码 #

# 定义编译时可用的测试套件列表（JSON字符串格式）
variables:
  - name: testSuitesList
    value: '["all-suites", "suite1", "suite2", "suite3"]'

parameters:
    - name: testSuite
      type: string
      default: 'all-suites'
      # 从编译时变量中读取可选值，确保和遍历列表一致
      values: ${{ fromJson(variables.testSuitesList) }}

trigger: none

jobs:
    - job: run_pipeline
      timeoutInMinutes: 120
      displayName: 'Run'
      pool:
          vmImage: 'ubuntu-latest'

      steps:
          # 运行单个选中的测试套件
          - ${{ if ne(parameters.testSuite, 'all-suites') }}:
                - script: |
                      npm run example-command -- --suite ${{ parameters.testSuite }}
                  displayName: 'Run test suite: ${{ parameters.testSuite }}'
                  continueOnError: true
          # 遍历所有测试套件生成任务（跳过all-suites选项）
          - ${{ if eq(parameters.testSuite, 'all-suites') }}:
                - ${{ each suite in fromJson(variables.testSuitesList) }}:
                    - ${{ if ne(suite, 'all-suites') }}:
                          - script: |
                                npm run example-command -- --suite ${{ suite }}
                            displayName: '${{ suite }}'
                            continueOnError: true

核心要点 #

1. 编译时变量复用：将套件列表以JSON字符串形式存在testSuitesList变量中，Azure DevOps的模板表达式${{ ... }}会在流水线编译阶段解析这个变量，满足遍历的要求。
2. 参数与列表同步：参数testSuite的values直接引用fromJson(variables.testSuitesList)，确保下拉选项和遍历的套件列表完全一致，避免两处维护。
3. 遍历逻辑简洁：在all-suites分支里，用each suite in fromJson(variables.testSuitesList)遍历所有套件，再通过if ne(suite, 'all-suites')过滤掉非实际测试套件的选项。

后续新增测试套件时，只需要修改testSuitesList变量里的JSON字符串，参数选项和流水线任务会自动更新，不用再手动添加重复的任务代码块。

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