Add a helper for saving command output in a file #3286
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
happz
force-pushed
the
report-file-command-helper
branch
2 times, most recently
from
99f2692
to
4b6e215
Compare
happz
requested review from
psss,
lukaszachy,
thrix and
janhavlin
as code owners
happz
force-pushed
the
report-file-command-helper
branch
2 times, most recently
from
b3f7c66
to
8eff501
Compare
KwisatzHaderach
approved these changes
Oct 29, 2024
therazix
approved these changes
Oct 31, 2024
happz
added
the
status | ready for merge
happz
force-pushed
the
report-file-command-helper
branch
from
8eff501
to
4dcd596
Compare
|
Some problem on TF side? Let's reschedule? |
happz
force-pushed
the
report-file-command-helper
branch
from
4dcd596
to
1b50f67
Compare
psss
reviewed
Nov 1, 2024
tmt/utils/__init__.py
Outdated
| yield from output_lines | ||
| yield OUTPUT_WIDTH * '~' | ||
| yield f'{comment_sign} {name} ({line_summary} lines)' | ||
| yield comment_sign + (OUTPUT_WIDTH - 1) * '~' |
There was a problem hiding this comment.
Suggested change
| yield comment_sign + (OUTPUT_WIDTH - 1) * '~' | |
| yield f'{comment_sign} ' + (OUTPUT_WIDTH - 2) * '~' |
Would you be ok with this as well? I find it a little bit more pleasing to the eye...
There was a problem hiding this comment.
I don't mind, just need to fix tests after such a change.
This will be a very needed functionality: plugin runs a command, and its output needs to be saved in a dedicated file, usualy because the output represents some interesting, standalone piece of information. For example, an AVC denial report generated by `ausearch`. If it would be the only such actor, it would be fine to keep the implementation in the `avc` plugin. But, with the advent of saving results of `prepare` and `finish` phases, the question is, if I get `results.yaml` for a `prepare` step, would it even contain anything besides `pass` or `error`? Well, it can contain logs of commands like `ansible-playbook` or shell scripts. And suddenly we have several plugins that may need to save some walls of texts, usually produced by a command, in files, and then link those files to results and present them to user. And because of that, it makes sense to provide a helper function that would produce unified output for all of them? Why should `avc` separate stdout and stderr by two lines and `prepare/shell` with just one? Not on my watch.
happz
force-pushed
the
report-file-command-helper
branch
from
1b50f67
to
21f1896
Compare
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 will be a very needed functionality: the plugin runs a command, and its output needs to be saved in a dedicated file, usually because the output represents some interesting, standalone piece of information. For example, an AVC denial report generated by
ausearch.If it were the only such actor, it would be fine to keep the implementation in the
avcplugin. But, with the advent of saving results of theprepareandfinishphases, the question is, if I getresults.yamlfor apreparestep, would it even contain anything besidespassorerror? Well, it can contain logs of commands likeansible-playbookor shell scripts. And suddenly we have several plugins that may need to save some walls of text, usually produced by a command, in files, and then link those files to results and present them to a user.And because of that, it makes sense to provide a helper function that would produce unified output for all of them. Why should
avcseparate stdout and stderr by two lines andprepare/shellwith just one? Not on my watch.Pull Request Checklist