revise: clarifies canonicalization, validation, and equality semantics around File and Directory
#748
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
Note that the example here will not compile until we merge in the work of 1.2 bug fixes. After that, I'll need to hook up the inputs correctly to this example. |
claymcleod
added
Z-specification-change
…s around `File` and `Directory`
claymcleod
changed the title
File and DirectoryFile and Directory
* Makes it clear that `File`s can only point to file paths and `Directory`s can only point to directory paths. Errors otherwise. * Fixes the `join_paths()` function to accept a `Directory` as the first argument and return a `String`. See openwdl#721 for more information on what needed changing and why. Closes openwdl#721.
acfoltzer
reviewed
Nov 14, 2025
|
|
||
| When a `File` or `Directory` value is created, the following operations are performed: | ||
|
|
||
| - **Path Canonicalization.** Intermediate path components are normalized (resolving `.` for current directory and `..` for parent directory segments), symbolic links are resolved to their final targets, and relative paths are converted to their absolute path form. For `Directory` values, trailing directory separators are removed. |
There was a problem hiding this comment.
It would be helpful to have a very specific description of how relative paths are converted to absolute form. I believe the sensible choice is that they're normalized relative to the .wdl file in which the declaration appears, but unless I'm missing something this is left ambiguous in the current text.
Collaborator
Author
There was a problem hiding this comment.
Apologies, you're right—I have this language in #735 (a PR to WDL 1.3), and my intention was to go back and cherry-pick that PR onto WDL 1.2.1 as well. So this will be addressed in the final changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses several open issues regarding the semantics of
FileandDirectory. It builds off the work done in #735 and #745 to fully qualify whenFile/Directorys are evaluated, how they are evaluated, and equality semantics.Closes #720.
Before submitting this PR, please make sure:
README.mdor other documentation needs updating to account for these changes.CHANGELOG.mddescribing the change and linking back to your pull request.CONTRIBUTING.mddocument.For OpenWDL team members: