Stabilize integration tests by using a single shared mock server instead of multiple per-test servers #870
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
Copilot
AI
changed the title
[WIP] Stabilize integration tests using a single mock server
Stabilize integration tests by using a single shared mock server instead of multiple per-test servers
Nov 30, 2025
ThaminduDilshan
added
skip-changelog
Co-authored-by: KaveeshaPiumini <[email protected]>
…prove comments Co-authored-by: KaveeshaPiumini <[email protected]>
…erver state The shared mock server implementation was causing race conditions where users, auth codes, and tokens from one test suite would persist when another test suite ran. This led to non-deterministic behavior since Go maps iterate in random order, causing the mock server to randomly select different users. Changes: - Added Reset() method to all mock servers (Google, GitHub, OAuth, OIDC) to clear users, auth codes, tokens, and custom authorize functions - Updated all test suites to call Reset() in SetupSuite() before adding test users, ensuring clean state for each test suite - This eliminates race conditions and makes tests deterministic Affected test suites: - GoogleAuthFlowTestSuite - ConditionalExecAuthFlowTestSuite - GoogleRegistrationFlowTestSuite - GithubAuthFlowTestSuite - GithubRegistrationFlowTestSuite - OAuthAuthTestSuite - OIDCAuthTestSuite Fixes intermittent failures in TestGoogleAuthFlowCompleteSuccess and TestGoogleAuthFlowMultipleUsersSuccess among others.
KaveeshaPiumini
force-pushed
the
copilot/stabilize-integration-tests
branch
from
8839e50 to
89528a8
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #870 +/- ##
===========================================
+ Coverage 62.07% 88.25% +26.18%
===========================================
Files 322 324 +2
Lines 26441 26446 +5
Branches 606 606
===========================================
+ Hits 16412 23340 +6928
+ Misses 7593 1933 -5660
+ Partials 2436 1173 -1263
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Add WaitForMessage method to MockNotificationServer that polls for messages with a configurable timeout instead of using fixed sleep - Replace time.Sleep + GetLastMessage calls with WaitForMessage in SMS registration tests for more reliable test execution - This addresses intermittent test failures caused by timing issues when waiting for SMS OTP messages
senthalan
reviewed
Dec 11, 2025
| ts.testAppID = appID | ||
|
|
||
| // Start mock notification server | ||
| ts.mockServer = testutils.NewMockNotificationServer(mockNotificationServerPort) |
Contributor
There was a problem hiding this comment.
Shall we change this constructor to private newMockNotificationServer. So we can make sure mock server will be always retrieved from testutils.GetSharedMockServers() in future.
Let's do this for all the mock server constructor in the test_utils package
|
|
||
| // Stop mock server | ||
| if ts.mockServer != nil { | ||
| err := ts.mockServer.Stop() |
Contributor
There was a problem hiding this comment.
Sameway, we can make the stop package private. So other package can't invoke it.
Let's do this for all the mock server constructor in the test_utils package
| time.Sleep(500 * time.Millisecond) | ||
|
|
||
| // Verify SMS was sent | ||
| lastMessage := ts.mockServer.GetLastMessage() |
Contributor
There was a problem hiding this comment.
Sameway, we can make the getLastMessage package private. So other package can't invoke it.
Let's do this for all the mock server constructor in the test_utils package
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.
Purpose
Integration tests were failing intermittently due to race conditions when multiple test suites started/stopped their own mock servers on the same ports (8092, 8093, 8098, 9091). When teardown didn't complete before the next suite's setup, ports were left in inconsistent states.
Approach
Introduced a singleton
SharedMockServersmanager that starts each mock server once and shares it across all test suites.Key changes:
testutils/shared_mock_servers.gowith thread-safe singleton patternGetSharedMockServers().Get*Server()instead of creating/starting their ownStart()/Stop()calls fromSetupSuite()/TearDownSuite()Usage:
Updated test files:
flowauthn/: sms_auth, decision_auth, http_request_executor_auth, github_auth, google_auth, conditional_exec_authflowregistration/: sms_registration, ou_registration, http_request_executor_registration, github_registration, google_registrationauthn/: oauth_auth, oidc_authRelated Issues
Related PRs
Checklist
Security checks
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.