Rename outputMethod values

common-workflow-language · Sep 18, 2024 · d22e4b4 · d22e4b4
1 parent 72d2835
commit d22e4b4
Show file tree

Hide file tree

Showing 17 changed files with 33 additions and 32 deletions.
diff --git a/Workflow.yml b/Workflow.yml
@@ -497,8 +497,8 @@ $graph:
   docParent: "#LoopWorkflowStep"
   doc: The loop output method, as described in [workflow step loop](#LoopWorkflowStep).
   symbols:
-    - last
-    - all
+    - last_iteration
+    - all_iterations
 
 
 - name: AbstractWorkflowStep
@@ -705,14 +705,14 @@ $graph:
     The `outputMethod` field describes how to deal with loop outputs after
     termination:
 
-      * **last** specifies that only the last computed element for each output
-        parameter should be propagated to the subsequent steps. This is the
-        default value.
+      * **last_iteration** specifies that only the last computed element for
+        each output parameter should be propagated to the subsequent steps.
+        This is the default value.
 
-      * **all** specifies that an array with all output values computed at the
-        end of each loop iteration should be propagated to the subsequent steps.
-        Elements in the array must be ordered according to the loop iterations
-        that produced them.
+      * **all_iterations** specifies that an array with all output values
+        computed at the end of each loop iteration should be propagated to
+        the subsequent steps. Elements in the array must be ordered according
+        to the loop iterations that produced them.
 
     Iterative execution in CWL is an optional feature and is not required
     to be implemented by all consumers of CWL documents. An implementation that
@@ -734,9 +734,9 @@ $graph:
         mapPredicate: outputSource
     - name: outputMethod
       doc: |
-        If not specified, the default method is "last".
+        If not specified, the default method is "last_iteration".
       type: LoopOutputMethod?
-      default: last
+      default: last_iteration
       jsonldPredicate:
         "_id": "cwl:outputMethod"
         "_type": "@vocab"
@@ -748,7 +748,8 @@ $graph:
         Only run the next iteration when the expression evaluates to `true`.
         If the first iteration evaluates to `false` the step is skipped.
         A skipped step produces a `null` on each output if the `outputMethod`
-        is set to `last`, and an empty array if the `outputMethod` is set to `all`.
+        is set to `last_iteration`, and an empty array if the `outputMethod`
+        is set to `all_iterations`.
 
 
 - name: Workflow

diff --git a/tests/loop/all-output-loop-no-iteration.cwl b/tests/loop/all-output-loop-no-iteration.cwl
@@ -14,7 +14,7 @@ steps:
     when: $(inputs.i1 < 1)
     loop:
       i1: o1
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/all-output-loop.cwl b/tests/loop/all-output-loop.cwl
@@ -14,7 +14,7 @@ steps:
     when: $(inputs.i1 < 10)
     loop:
       i1: o1
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/default-value-loop.cwl b/tests/loop/default-value-loop.cwl
@@ -19,7 +19,7 @@ steps:
       i1:
         outputSource: o1
         default: 5
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:

diff --git a/tests/loop/invalid-multi-source-loop-no-requirement.cwl b/tests/loop/invalid-multi-source-loop-no-requirement.cwl
@@ -20,7 +20,7 @@ steps:
       i1:
         outputSource: [ osmall, obig ]
         pickValue: the_only_non_null
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:

diff --git a/tests/loop/invalid-value-from-loop-no-requirement.cwl b/tests/loop/invalid-value-from-loop-no-requirement.cwl
@@ -16,7 +16,7 @@ steps:
     loop:
       i1:
         valueFrom: $(inputs.i1 + 1)
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/loop-inside-loop-all.cwl b/tests/loop/loop-inside-loop-all.cwl
@@ -23,7 +23,7 @@ steps:
     loop:
       i2:
         valueFrom: $(inputs.i2 + 1)
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:
@@ -38,7 +38,7 @@ steps:
           when: $(inputs.i1 <= inputs.i2)
           loop:
             i1: o1
-          outputMethod: all
+          outputMethod: all_iterations
           run:
             class: ExpressionTool
             inputs:

diff --git a/tests/loop/loop-inside-loop.cwl b/tests/loop/loop-inside-loop.cwl
@@ -19,7 +19,7 @@ steps:
     loop:
       i2:
         valueFrom: $(inputs.i2 + 1)
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:
@@ -34,7 +34,7 @@ steps:
           when: $(inputs.i1 <= inputs.i2)
           loop:
             i1: o1
-          outputMethod: last
+          outputMethod: last_iteration
           run:
             class: ExpressionTool
             inputs:

diff --git a/tests/loop/loop-inside-scatter.cwl b/tests/loop/loop-inside-scatter.cwl
@@ -28,7 +28,7 @@ steps:
           when: $(inputs.i1 < 10)
           loop:
             i1: o1
-          outputMethod: last
+          outputMethod: last_iteration
           run:
             class: ExpressionTool
             inputs:

diff --git a/tests/loop/multi-source-loop-no-pick-value.cwl b/tests/loop/multi-source-loop-no-pick-value.cwl
@@ -20,7 +20,7 @@ steps:
       i1:
         outputSource: [ osmall, obig ]
         valueFrom: $(self[0])
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:

diff --git a/tests/loop/multi-source-loop.cwl b/tests/loop/multi-source-loop.cwl
@@ -21,7 +21,7 @@ steps:
       i1:
         outputSource: [ osmall, obig ]
         pickValue: the_only_non_null
-    outputMethod: all
+    outputMethod: all_iterations
     run:
       class: Workflow
       inputs:

diff --git a/tests/loop/single-var-loop-no-iteration.cwl b/tests/loop/single-var-loop-no-iteration.cwl
@@ -14,7 +14,7 @@ steps:
     when: $(inputs.i1 < 1)
     loop:
       i1: o1
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/single-var-loop.cwl b/tests/loop/single-var-loop.cwl
@@ -14,7 +14,7 @@ steps:
     when: $(inputs.i1 < 10)
     loop:
       i1: o1
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/test-index.yaml b/tests/loop/test-index.yaml
@@ -33,15 +33,15 @@
 - job: single-var-loop-job.yml
   tool: all-output-loop.cwl
   id: loop_with_all_output_method
-  doc: "Test a loop case with outputMethod set to all"
+  doc: "Test a loop case with outputMethod set to all_iterations"
   output:
     o1: [2, 3, 4, 5, 6, 7, 8, 9, 10]
   tags: [ conditional, loop, inline_javascript, workflow ]
 
 - job: single-var-loop-job.yml
   tool: all-output-loop-no-iteration.cwl
   id: loop_with_all_output_method_no_iteration
-  doc: "Test a loop case with outputMethod set to all and a false condition"
+  doc: "Test a loop case with outputMethod set to all_iterations and a false condition"
   output:
     o1: []
   tags: [ conditional, loop, inline_javascript, workflow ]
@@ -80,7 +80,7 @@
 - job: two-vars-loop-job.yml
   tool: loop-inside-loop-all.cwl
   id: loop_nested_all
-  doc: "Test a workflow with two nested loops, both with outputMethod set to all"
+  doc: "Test a workflow with two nested loops, both with outputMethod set to all_iterations"
   output:
     o1: [[2], [2, 3], [2, 3, 4]]
   tags: [ conditional, loop, inline_javascript, scatter, workflow ]

diff --git a/tests/loop/two-vars-loop-2.cwl b/tests/loop/two-vars-loop-2.cwl
@@ -15,7 +15,7 @@ steps:
     when: $(inputs.i1 < 10)
     loop:
       i1: o1
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/two-vars-loop.cwl b/tests/loop/two-vars-loop.cwl
@@ -16,7 +16,7 @@ steps:
     loop:
       i1: o1
       i2: o2
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs:

diff --git a/tests/loop/value-from-loop.cwl b/tests/loop/value-from-loop.cwl
@@ -17,7 +17,7 @@ steps:
     loop:
       i1:
         valueFrom: $(inputs.i1 + 1)
-    outputMethod: last
+    outputMethod: last_iteration
     run:
       class: ExpressionTool
       inputs: