feat: summarize health checks and add verbose output - #445
Draft
federicobozzini wants to merge 2 commits into
Draft
feat: summarize health checks and add verbose output#445federicobozzini wants to merge 2 commits into
federicobozzini wants to merge 2 commits into
Conversation
federicobozzini
marked this pull request as draft
September 7, 2026 09:45
federicobozzini
force-pushed
the
health-reshaping
branch
2 times, most recently
from
September 7, 2026 09:46
8357d9d to
4c85465
Compare
muchzill4
reviewed
Sep 7, 2026
| }) | ||
|
|
||
| t.Run("it renders an info icon for info checks", func(t *testing.T) { | ||
| t.Run("it renders remoteproc info without suppressing the success summary", func(t *testing.T) { |
Contributor
There was a problem hiding this comment.
This test now conflates two things: info icon and suppression of the success message. We should probably have a test evaluating all icons.
| func TestHealthReport(t *testing.T) { | ||
| t.Run("PlainFormat", func(t *testing.T) { | ||
| t.Run("it renders the healthy host dependencies", func(t *testing.T) { | ||
| t.Run("it renders a generic result for healthy host and target sections", func(t *testing.T) { |
Contributor
There was a problem hiding this comment.
What's "a generic result"? It's not obvious to me what this is actually testing now.
We should make three cases obvious:
- renders summaries if all checks pass in verbose=true mode
- renders details of failing checks details in verbose=false mode
- renders "all good" summary and no details in verbose=false mode
| Host health.HostReport `json:"host"` | ||
| Target *health.TargetReport `json:"target,omitempty"` | ||
| TargetHint string `json:"-"` | ||
| Verbose bool `json:"-"` |
Contributor
There was a problem hiding this comment.
Doesn't feel like Verbose belongs here. These are contents of a health report, verbose adds "how to print it", which doesn't belong here.
Comment on lines
20
to
34
| type healthCheckSection struct { | ||
| ShowPassedSummary bool | ||
| Checks []health.HealthCheck | ||
| } | ||
|
|
||
| type healthTargetSection struct { | ||
| Destination string | ||
| Section healthCheckSection | ||
| } | ||
|
|
||
| type plainHealthReport struct { | ||
| Host healthCheckSection | ||
| Target *healthTargetSection | ||
| TargetHint string | ||
| } |
Contributor
There was a problem hiding this comment.
Why do we need all these new types? What purpose do they serve? I find it a bit confusing. It could be the naming (what is plain?) or the purpose (why new types if all we do is display "All good" if all checks pass).
Signed-off-by: Federico Bozzini <federico.bozzini@arm.com>
federicobozzini
force-pushed
the
health-reshaping
branch
from
September 8, 2026 09:38
4c85465 to
f3fced6
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes
topo healthonly shows errors and warningstopo healthdoesn't report any issueverboseflag is introduced to report the result of all checksScreenshot
Checklist