apps: fix a race in watch-appstream.py#23126
Open
allisonkarlitskaya wants to merge 1 commit intocockpit-project:mainfrom
Open
apps: fix a race in watch-appstream.py#23126allisonkarlitskaya wants to merge 1 commit intocockpit-project:mainfrom
allisonkarlitskaya wants to merge 1 commit intocockpit-project:mainfrom
Conversation
We have a recursive directory-watching rig which uses inotify to watch for files in a directory and also supports situations where the directories don't exist to start with. We attempt to that that in `TestApps.testBasic` by deleting the directories and waiting for them to be created by appstream. Unfortunately this code contains a race: if we find a directory missing, we register a watch for it and wait for it to appear. We don't check if the directory got created before our watch was established though, which means we could end up waiting forever. The test is also arranged in such a way that these two things happen at approximately the same time. Let's double-check after establishing the watch: if the path exists, reset() the watch to start the process from the start. It's not the most elegant way to do this, but it should hopefully be rare. This should hopefully solve one of our most common current flakes. Even if it doesn't, it's a bug that deserves to be fixed. Assisted-by: Claude Opus 4.6
allisonkarlitskaya
force-pushed
the
deflake
branch
from
341a2d0 to
983e11a
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.
We have a recursive directory-watching rig which uses inotify to watch for files in a directory and also supports situations where the directories don't exist to start with. We attempt to that that in
TestApps.testBasicby deleting the directories and waiting for them to be created by appstream.Unfortunately this code contains a race: if we find a directory missing, we register a watch for it and wait for it to appear. We don't check if the directory got created before our watch was established though, which means we could end up waiting forever. The test is also arranged in such a way that these two things happen at approximately the same time.
Let's double-check after establishing the watch: if the path exists, reset() the watch to start the process from the start. It's not the most elegant way to do this, but it should hopefully be rare.
This should hopefully solve one of our most common current flakes. Even if it doesn't, it's a bug that deserves to be fixed.
Assisted-by: Claude Opus 4.6