Runnable identifier #5992
Merged
Runnable identifier #5992
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
richtja
added
enhancement
customer:Passt
clebergnu
requested changes
Aug 2, 2024
There was a problem hiding this comment.
Hi @richtja,
This LGTM, but I will ask you to consider:
- Adding one example of the identifier to the recipes documentation section
- Adding identifier example to
examples/nrunner/recipes/runnableorexamples/nrunner/recipes/runnables
One other issue that this opens is what to present on an avocado list command. What I mean is that, until now, it was presenting the "only" information available, that is, the URI. Example:
avocado list examples/nrunner/recipes/runnable/exec_test_sleep_3.json
exec-test /bin/sleep
Now, with a change such as:
diff --git a/examples/nrunner/recipes/runnable/exec_test_sleep_3.json b/examples/nrunner/recipes/runnable/exec_test_sleep_3.json
index 23113758b..8e4284eb0 100644
--- a/examples/nrunner/recipes/runnable/exec_test_sleep_3.json
+++ b/examples/nrunner/recipes/runnable/exec_test_sleep_3.json
@@ -1 +1 @@
-{"kind": "exec-test", "uri": "/bin/sleep", "args": ["3"]}
+{"kind": "exec-test", "uri": "/bin/sleep", "args": ["3"], "identifier": "sleep-3-seconds"}It may make sense to show, instead:
avocado list examples/nrunner/recipes/runnable/exec_test_sleep_3.json
exec-test sleep-3-seconds
|
Hi @clebergnu, thanks for your review. I agree with you, and I will update the examples. Also, it reminded to me that I should update our documentation as well. |
richtja
force-pushed
the
runnable_identifier
branch
from
225c0db
to
8d414e3
Compare
|
Hi @clebergnu, I have added the examples and update the |
richtja
force-pushed
the
runnable_identifier
branch
from
8d414e3
to
1b9fca0
Compare
|
Hi @clebergnu, thanks for your review. I have addressed your comments via force-push. Please have a look. |
This commit introduces a way how to explicitly specify runnable identifier through Job API or runnable recipe. This change shouldn't affect current behaviour and if the identifier is not specified it will be generated based on the `runner.identifier_format` config variable. Reference: avocado-framework#5964 Signed-off-by: Jan Richter <[email protected]>
After this commit the `avocado list` command will print runnable identifier instead of url and `avocado -V list` will add the identifier as another column in the list matrix. It will be helpful when users will define their own identifiers after change in e7228af. Signed-off-by: Jan Richter <[email protected]>
richtja
force-pushed
the
runnable_identifier
branch
from
1b9fca0
to
331cd09
Compare
|
Hi @clebergnu, I have just updated the |
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 commit introduces a way how to explicitly specify runnable identifier through Job API or runnable recipe. This change shouldn't affect current behaviour and if the identifier is not specified it will be generated based on the
runner.identifier_formatconfig variable.Reference: #5964