AWSTOE でループ構文を使用する

このセクションでは、AWSTOE でループ構文を作成する際に役立つ情報を提供します。ループは、繰り返される命令シーケンスを定義する。AWSTOE では以下のタイプのループ構文を使用できます。

イテレーション変数の参照

現在のイテレーション変数のインデックスと値を参照するには、ループ構文を含むステップの入力ボディ内で参照式 {{ loop.* }} を使用する必要があります。この式は、別のステップのループ構文のイテレーション変数を参照する場合には使用できません。

参照式は、次のメンバーで構成されます。

ループ名

ループ構文にはすべて、識別用のオプションの名前フィールドがあります。ループ名を指定すると、そのループ名を使用してステップの入力ボディ内のイテレーション変数を参照できます。名前付きループのイテレーションインデックスと値を参照するには、ステップの入力ボディで {{ <loop_name>.* }} と {{ loop.* }} を使用してください。この式は、他のステップの名前付きループ構成を参照するために使用することはできない。

参照式は、次のメンバーで構成されます。

参照式を解決する

AWSTOE は以下のように参照式を解決します。

ループを含まないステップ内で参照式が使用された場合、AWSTOE 式は解決されず、置換されることなくステップに表示されます。

ループ構文のタイプ

このセクションでは、AWSTOE で使用できるループ構文タイプに関する情報と例を紹介します。

for ループ

for ループは、変数の先頭と末尾で囲まれた境界内で指定された整数の範囲で反復処理を行います。イテレーション値は [start, end] のセットに含まれており、境界値も含まれます。

AWSTOE は start、end および updateBy の値を確認して、組み合わせによって無限ループが発生しないことを確認します。

for ループスキーマ

  - name: "StepName"
    action: "ActionModule"
    loop:
      name: "string"
      for:
        start: int
        end: int
        updateBy: int
inputs:
  ...

for ループ入力の例

  - name: "CalculateFileUploadLatencies"
    action: "ExecutePowerShell"
    loop:
      for:
        start: 100000
        end: 1000000
        updateBy: 100000
    inputs:
      commands:
        - |
          $f = new-object System.IO.FileStream c:\temp\test{{ loop.index }}.txt, Create, ReadWrite
          $f.SetLength({{ loop.value }}MB)
          $f.Close()
        - c:\users\administrator\downloads\latencyTest.exe --file c:\temp\test{{ loop.index }}.txt
        - AWS s3 cp c:\users\administrator\downloads\latencyMetrics.json s3://bucket/latencyMetrics.json
        - |
          Remove-Item -Path c:\temp\test{{ loop.index }}.txt
          Remove-Item -Path c:\users\administrator\downloads\latencyMetrics.json

forEach ループ (入力リスト付き)

forEach ループは明示的な値リスト (文字列でも連鎖式でもかまいません) を繰り返し処理します。

入力リストのスキーマを含む forEach ループ

  - name: "StepName"
    action: "ActionModule"
    loop:
      name: "string"
      forEach:
        - "string"
    inputs:
  ...

入力リストによる forEach ループ (例 1)

  - name: "ExecuteCustomScripts"
    action: "ExecuteBash"
    loop:
      name: BatchExecLoop
      forEach:
        - /tmp/script1.sh
        - /tmp/script2.sh
        - /tmp/script3.sh
    inputs:
      commands:
        - echo "Count {{ BatchExecLoop.index }}"
        - sh "{{ loop.value }}"
        - |
          retVal=$?
          if [ $retVal -ne 0 ]; then
            echo "Failed"
          else
            echo "Passed"
         fi

入力リストによる forEach ループ (例 2)

  - name: "RunMSIWithDifferentArgs"
    action: "ExecuteBinary"
    loop:
      name: MultiArgLoop
      forEach:
        - "ARG1=C:\Users ARG2=1"
        - "ARG1=C:\Users"
        - "ARG1=C:\Users ARG3=C:\Users\Administrator\Documents\f1.txt"
    inputs:
      commands:
        path: "c:\users\administrator\downloads\runner.exe"
        args:
          - "{{ MultiArgLoop.value }}"

入力リストによる forEach ループ (例 3)

  - name: "DownloadAllBinaries"
    action: "S3Download"
    loop:
      name: MultiArgLoop
      forEach:
        - "bin1.exe"
        - "bin10.exe"
        - "bin5.exe"
    inputs:
      - source: "s3://bucket/{{ loop.value }}"
        destination: "c:\temp\{{ loop.value }}"

区切りリストによる forEach ループ

ループは、区切り文字で区切られた値を含む文字列を繰り返し処理します。文字列の構成要素を反復処理するには、AWSTOE は区切り文字を使用して文字列を反復処理に適した配列に分割します。

区切りリストスキーマによる forEach ループ

  - name: "StepName"
    action: "ActionModule"
    loop:
      name: "string"
      forEach:
        list: "string"
        delimiter: ".,;:\n\t -_"
    inputs:
  ...

forEach 区切りリストによるループ 例1

次の例では、<phase_name>.<step_name>.[inputs | outputs].<var_name> という連鎖式パターンを使用して別のステップの出力を参照します。

  - name: "RunMSIs"
    action: "ExecuteBinary"
    loop:
      forEach:
        list: "{{ build.GetAllMSIPathsForInstallation.outputs.stdout }}"
        delimiter: "\n"
    inputs:
      commands:
        path: "{{ loop.value }}"

forEach 区切りリストによるループ 例2

  - name: "UploadMetricFiles"
    action: "S3Upload"
    loop:
      forEach:
        list: "/tmp/m1.txt,/tmp/m2.txt,/tmp/m3.txt,..."
    inputs:
      commands:
        - source: "{{ loop.value }}"
          destination: "s3://bucket/key/{{ loop.value }}"

ステップフィールド

ループはステップの一部です。ステップの実行に関連するフィールドは、個々の反復には適用されません。ステップフィールドは、以下のようにステップレベルでのみ適用されます。

ステップとイテレーションの出力

すべてのイテレーションには出力が含まれます。ループ実行の最後に、AWSTOE は成功したすべてのイテレーション出力を detailedOutput.json に統合します。統合出力は、アクションモジュールの出力スキーマで定義されている対応する出力キーに属する値を照合したものです。次の例では、出力の統合方法を示しています。

イテレーション 1 の ExecuteBash の出力

{
	"stdout":"Hello"
}

イテレーション 2 の ExecuteBash の出力

{
	"stdout":"World"
}

ステップ ExecuteBash の出力

{
	"stdout":"Hello\nWorld"
}

例えば、ExecuteBash、ExecutePowerShell、および ExecuteBinary はアクションモジュール出力として STDOUT を返すアクションモジュールです。 STDOUT メッセージは改行文字で結合され、detailedOutput.json のステップの全体的な出力が生成されます。

AWSTOE は失敗したイテレーションの出力を統合しません。