Merge pull request #300 from common-workflow-language/stdin-shortcut

stdin shortcut

Author: mr-c

doc/add-new-draft.md

@@ -11,8 +11,8 @@ How to make a new draft version of the CWL spec
 
 4. In the reference implementation (cwltool): make a new branch, and update the
    subtree checkout of the spec:
-   
-     git subtree merge -P cwltool/schemas/ cwl_repo/v1.1.0-dev1
+  
+     git subtree merge --squash -P cwltool/schemas/ cwl_repo/v1.1.0-dev1
 
    Where `cwl_repo` is the remote repository for the CWL specifications.
 4. In the reference implementation, teach it about the new draft version:

run_test.sh

@@ -17,6 +17,7 @@ JUNIT_XML=""
 RUNNER=cwl-runner
 PLATFORM=$(uname -s)
 COVERAGE="python"
+EXTRA=""
 
 while [[ -n "$1" ]]
 do
@@ -70,7 +71,7 @@ runtest() {
     (cd $DRAFT
      cwltest --tool "$1" \
 	     --test=conformance_test_${DRAFT}.yaml ${TEST_N} \
-	     ${TEST_L} ${ONLY_TOOLS} ${JUNIT_XML} --basedir ${DRAFT}
+	     ${TEST_L} ${ONLY_TOOLS} ${JUNIT_XML} --basedir ${DRAFT} -- ${EXTRA}
     )
     checkexit
 }

v1.1.0-dev1/CommandLineTool.yml

@@ -42,7 +42,7 @@ $graph:
       maintenance release of the CWL CommandLineTool specification.
       Version 1.1 introduces the followings additions:
 
-      *
+        * Addition of `stdin` type shortcut for `CommandInputParamater`s.
 
       ## Introduction to v1.0
 
@@ -388,6 +388,7 @@ $graph:
       type:
         - "null"
         - CWLType
+        - stdin
         - stdout
         - stderr
         - CommandOutputRecordSchema
@@ -409,6 +410,31 @@ $graph:
       doc: |
         Specify valid types of data that may be assigned to this parameter.
 
+- name: stdin
+  type: enum
+  symbols: [ "cwl:stdin" ]
+  docParent: "#CommandOutputParameter"
+  doc: |
+    Only valid as a `type` for a `CommandLineTool` input with no
+    `inputBinding` set. `stdin` must not be specified at the `CommandLineTool`
+    level.
+
+    The following
+    ```
+    inputs:
+       an_input_name:
+       type: stdin
+    ```
+    is equivalent to
+    ```
+    inputs:
+      an_input_name:
+        type: File
+        streamable: true
+
+    stdin: ${inputs.an_input_name.path}
+    ```
+
 - name: stdout
   type: enum
   symbols: [ "cwl:stdout" ]
@@ -558,6 +584,7 @@ $graph:
         "_container": "@list"
     - name: stdin
       type: ["null", string, Expression]
+      jsonldPredicate: "https://w3id.org/cwl/cwl#stdin"
       doc: |
         A path to a file whose contents must be piped into the command's
         standard input stream.

v1.1.0-dev1/conformance_test_v1.1.0-dev1.yaml

@@ -117,6 +117,17 @@
   tool: v1.1.0-dev1/cat4-tool.cwl
   doc: Test command execution in Docker with stdin and stdout redirection
 
+- job: v1.1.0-dev1/cat-job.json
+  output:
+    output_txt:
+      class: File
+      checksum: sha1$47a013e660d408619d894b20806b1d5086aab03b
+      location: output.txt
+      size: 13
+  tool: v1.1.0-dev1/cat4b-tool.cwl
+  doc: Test command execution in Docker with stdin and stdout redirection
+          with stdin shortcut
+
 - job: v1.1.0-dev1/empty.json
   tool: v1.1.0-dev1/null-expression1-tool.cwl
   output: