common-workflow-language / common-workflow-language/common-workflow-language

need to clarify: should implementation ignore conflicting information in the input object?

Open
#808 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Common Workflow Language
Stars
1.5k
Forks
193
PR merge metrics
No merged PRs in 30d

Description

Conformance test 1 include an input object where one of the inputs, a `File`, has an incorrect `size` and `checksum`.

There appears to be no guidance in CWL v1.0 about this situation.

I feel that ignoring this is bad; what if the `File` was a remote resource and the user had specified the `size` and `checksum` as an indication of what they expected.

- [ ] Clarify the intent
- [ ] Document in v1.1
- [ ] Adjust the conformance tests to implement this in a specific test or tests

Again, many thanks to @tom-tan for bringing this to my attention

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing Conformance test 1 and the CWL v1.0 guidance for File objects. Determine the intended behavior when declared size or checksum conflicts with the resource, then document the decision for v1.1 and adjust the conformance tests to enforce it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.