show preparing message in stdout status update #575
Merged
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
Signed-off-by: Harper, Jason M <jason.m.harper@intel.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances progress reporting during script execution by refactoring the script.RunScripts function to accept status update callbacks and messages as parameters. This allows callers to provide custom status messages and enables the display of a "preparing to collect data" message before target preparation, improving visibility into script execution progress.
Key changes:
- Modified
script.RunScriptssignature to acceptstatusUpdateandcollectingStatusparameters - Added status update calls in
script.RunScriptsbefore preparing targets and before running scripts - Updated all callers across the codebase to pass the new parameters
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| internal/script/script.go | Added status update parameters to RunScripts function and inserted status update calls before target preparation and script execution |
| internal/common/common.go | Refactored to pass status update function and message to RunScripts instead of calling status update before the function |
| cmd/metrics/metadata.go | Updated RunScripts calls to include nil and empty string for new parameters where status updates are not needed |
| cmd/config/set.go | Updated multiple RunScripts calls to include nil and empty string for new parameters |
| cmd/config/config.go | Refactored to pass status update function and message to RunScripts instead of calling status update before the function |
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 pull request updates the way scripts are run on targets throughout the codebase, primarily by refactoring the
script.RunScriptsfunction to accept additional parameters for status updates and status messages. This change improves progress reporting and status tracking during script execution, and standardizes how status updates are handled across multiple modules.Refactoring for improved status reporting:
script.RunScriptsfunction signature ininternal/script/script.goto acceptstatusUpdateandcollectingStatusparameters, allowing callers to provide status update callbacks and custom status messages.script.RunScripts, enhancing progress visibility for users. [1] [2]Codebase-wide adoption of new interface:
script.RunScriptsincmd/config/set.go,cmd/config/config.go,cmd/metrics/metadata.go, andinternal/common/common.goto use the new parameters, passing appropriate status update functions and messages ornil/empty string where not needed. [1] [2] [3] [4] [5] [6] [7] [8] [9]Dependency update:
perfspect/internal/progressininternal/script/script.goto support the new status update functionality.