Introduce 'globus gcs' as a collection of aliases for existing commands #902
Conversation
This file contains 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
Testing covers two elements of this: - ensure that the aliasing produces good usage/help text - ensure that the aliases can be used interchangably with the originals
To test these aliases, parametrize the tests to use 'gcs collection' and 'collection' variants. In order to ensure these work correctly, the "should use" mapping of commands needed several updates to list 'globus gcs' variants. It also was opportunistically updated at this time to list 'globus gcp'.
The "should use map" in `WrongEntityTypeError` is used to map one command to another, e.g. redirecting `globus endpoint update` to `globus gcp update guest`. This enhancement rewrites it such that the source side is expected to be multiple (rather than the destination side), which leads to a more natural expression of the same data. For improved comprehensibility, the mapping is now ordered at the top-level (as a tuple) rather than containing ordered lists, and uses a dataclass to represent the mappings. This makes it slightly more verbose in spite of the fact that it features slightly less repetition of data. A very slight data change was made to list `globus gcs collection show` rather than `globus collection show`.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
kurtmckee
requested changes
Dec 5, 2023
- ShouldUse.command is renamed to ShouldUse.dst_command - Always write ShouldUse params in the same order - Improvements to test parametrization Co-authored-by: Kurt McKee <[email protected]>
kurtmckee
approved these changes
Dec 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 changeset introduces
globus gcswith tests particularly focused on theglobus gcs collectioncommands for now.The changelog describes these as new commands meant to eventually replace the existing commands. No deprecation is included in the current messaging.
There are some impacts of these changes on the
WrongEntityTypeErrormapping of commands to "commands which should be used instead".Not only are commands mapped to
globus gcs collectioninstead ofglobus collection, but the underlying datastructure was refactored in an attempt to improve clarity.