support flux uri --wait JOBID
#6443
Merged
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6443 +/- ##
==========================================
- Coverage 83.64% 83.64% -0.01%
==========================================
Files 524 524
Lines 87693 87708 +15
==========================================
+ Hits 73355 73365 +10
- Misses 14338 14343 +5
|
garlick
approved these changes
Dec 3, 2024
doc/man1/flux-uri.rst
Outdated
|
|
||
| :: | ||
|
|
||
| $ flux uri --wait $(flux batch -n1 --wrap flux run hostname) |
There was a problem hiding this comment.
In this example, maybe it would be slightly better to use sleep 3600 or something that runs for a while rather than hostname?
There was a problem hiding this comment.
Good point! If we're making a realistic example, maybe just a placeholder myjob or something?
Comment on lines
+77
to
78
| if the network host specified by an :program:`ssh` URI is not the current | ||
| host. |
There was a problem hiding this comment.
This contains reformatting that isn't mentioned in the commit message.
Might be good to at least call it out.
|
Ok I addressed those comments and will set MWP. Thanks! |
Problem: It is inconvenient that a user has to ensure a job's memo event containing the subinstance URI has been posted before they can call `flux uri` or other URI resolver. Support a `wait` parameter for the jobid resolver which, when used, causes the resolver to wait for the `memo` event containing the URI before returning. This is only done if the job is not in the INACTIVE or CLEANUP states.
Problem: The `?wait` query parameter to the `jobid` URI resolver scheme and the corresponding `--wait` flag to `flux uri` are not documented. Add documentation to flux-uri(1). Additionally replace use of double-backticks with :program:`prog` where appropriate for readability. Reformat paragraphs where necessary due to longer line length introduced by this change.
Problem: No tests in the testsuite ensure that `flux uri --wait` works. Add a test to t2802-uri-cmd.t.
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 PR adds support for a
?waitquery parameter to thejobidURI resolver, and a new--waitoption toflux-urito pass that parameter down to the resolver.This supports waiting until the URI is available for pending or starting jobs, as opposed to the resolver returning "job is not running".
If the
waitparameter is used with a job that isn't an instance of Flux, then it waits until thefinishevent before giving up and returning "URI not found".