cmd/snap: improved robustness of unit tests TestWaitWhileInhibitedGraphicalSession* #12535
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
ernestl
force-pushed
the
ernestl_SNAPDENG-4506_unit_test_fixes_additional
branch
from
70b2b4d to
f9ddf5f
Compare
mvo5
approved these changes
Jan 31, 2023
| @@ -1899,6 +1899,11 @@ func (s *RunSuite) TestWaitWhileInhibitedGraphicalSessionFlow(c *check.C) { | |||
| restoreIsGraphicalSession := snaprun.MockIsGraphicalSession(true) | |||
| defer restoreIsGraphicalSession() | |||
|
|
|||
| restoreTryNotifyRefresh := snaprun.MockTryNotifyRefreshViaSnapDesktopIntegrationFlow(func(snapName string) (bool, error) { | |||
There was a problem hiding this comment.
Given that we add mocking here, it seems like a good opportunity to also add checks here, e.g. c.Check(snapName, Equals, "some-snap") here and in similar places (assuming it's some-snap)
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.
Problem:
When running
run-checks --unitwith snapsnapd-desktop-integration installedindevmode, the unit testsTestWaitWhileInhibitedGraphicalSessionFlow,TestWaitWhileInhibitedGraphicalSessionFlowError,TestWaitWhileInhibitedGraphicalSessionFlowErrorOnFinishfails and or timeout.The underlying issue in all three test is that the target function
graphicalSessionFlowdoes not get called due to the presence of DBus andsnapd-desktop-integrationaffecting the return values from functiontryNotifyRefreshViaSnapDesktopIntegrationFlowin an unexpected way. Also, when inhibit state is not unlocked with a mock,tryNotifyRefreshViaSnapDesktopIntegrationFlowis stuck inwaitInhibitUnlockloop until timeout (the case with testTestWaitWhileInhibitedGraphicalSessionFlowError).Solution:
Enabled mocking of
tryNotifyRefreshViaSnapDesktopIntegrationFlowto predictably exercisegraphicalSessionFlowas intended.