fix: fix resource assertion logic and its logging #618
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
Fix two things in the resource asserters: 1. We were doing a busy `state.Get` loop in the resource assertions. This was unnecessary to wait for a resource to be created, as we also create a watch, and the moment the resource gets created, we get notified. Changed this logic to follow the same logic with the rest of the assertions on the resource (block on `watch` events). 2. This busy wait also produced a test log every single time the resource was not found, producing an excessive number of logs. Remove this log and unify the logic with the rest of the assertions (see fix 1), so that the NotFound logs will also be aggregated/de-duplicated. Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
There was a problem hiding this comment.
Pull Request Overview
The PR refactors the resource asserters to block on watch events instead of busy-waiting on StateGet, removes excessive NotFound logs, and corrects a typo in the reporting counter.
- Replace busy
StateGetloops with watch-based blocking - Remove per-iteration NotFound logging and deduplicate reports
- Fix typo
lastReporedOk→lastReportedOk
Comments suppressed due to low confidence (1)
pkg/resource/rtestutils/assertions.go:60
- For NotFound errors you still fall through and call
asserter.NoError(err), causing the test to fail immediately instead of retrying. You likely need tocontinuethe loop whenstate.IsNotFoundError(err)to wait on watch events as intended.
if !state.IsNotFoundError(err) {
Comment on lines
+143
to
+147
| if !state.IsNotFoundError(err) { | ||
| require.NoError(err) | ||
| } | ||
|
|
||
| require.NoError(err) | ||
| asserter.NoError(err) |
There was a problem hiding this comment.
This call will also catch NotFound errors (since you no longer continue), leading to immediate failures rather than waiting for the resource creation event. Consider guarding this call so it only runs when the resource is actually found.
Suggested change
| if !state.IsNotFoundError(err) { | |
| require.NoError(err) | |
| } | |
| require.NoError(err) | |
| asserter.NoError(err) | |
| if state.IsNotFoundError(err) { | |
| // Skip NotFound errors as they are expected during resource creation | |
| continue | |
| } else { | |
| require.NoError(err) | |
| asserter.NoError(err) | |
| } |
smira
reviewed
Jul 9, 2025
|
|
||
| asserter := assert.New(&aggregator) | ||
|
|
||
| res, err := safe.StateGet[R](ctx, st, resource.NewMetadata(namespace, rds.Type, id, resource.VersionUndefined)) |
Member
There was a problem hiding this comment.
we could even avoid Get completely and rely just on watch events, but I think it's fine as it is
Member
There was a problem hiding this comment.
and btw is not a busy loop, as it runs only on watch events anyways
smira
approved these changes
Jul 9, 2025
Member
Author
|
/m |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Fix two things in the resource asserters:
We were doing a busy
state.Getloop in the resource assertions. This was unnecessary to wait for a resource to be created, as we also create a watch, and the moment the resource gets created, we get notified. Changed this logic to follow the same logic with the rest of the assertions on the resource (block onwatchevents).This busy wait also produced a test log every single time the resource was not found, producing an excessive number of logs. Remove this log and unify the logic with the rest of the assertions (see fix 1), so that the NotFound logs will also be aggregated/de-duplicated.