Auto-start Cosmos emulator via Testcontainers #37999
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,7 @@ | |
| using Azure.Core; | ||
| using Azure.Identity; | ||
| using Microsoft.Extensions.Configuration; | ||
| using Testcontainers.CosmosDb; | ||
|
|
||
| namespace Microsoft.EntityFrameworkCore.TestUtilities; | ||
|
|
||
|
|
@@ -22,15 +23,96 @@ public static class TestEnvironment | |
| .Build() | ||
| .GetSection("Test:Cosmos"); | ||
|
|
||
| private static readonly Lazy<(string Connection, CosmosDbContainer Container)> _connectionInfo = new(InitializeConnection); | ||
|
|
||
| public static string DefaultConnection => _connectionInfo.Value.Connection; | ||
|
|
||
| private static CosmosDbContainer Container => _connectionInfo.Value.Container; | ||
|
|
||
| public static bool IsTestContainer => Container != null; | ||
|
AndriySvyryd marked this conversation as resolved.
Outdated
|
||
|
|
||
| internal static Func<HttpMessageHandler> HttpMessageHandlerFactory | ||
| => Container != null ? () => Container.HttpMessageHandler : null; | ||
|
AndriySvyryd marked this conversation as resolved.
Outdated
|
||
|
|
||
| private static (string Connection, CosmosDbContainer Container) InitializeConnection() | ||
|
AndriySvyryd marked this conversation as resolved.
Outdated
|
||
| { | ||
| // If a connection string is specified (env var, config.json...), always use that. | ||
| var configured = Config["DefaultConnection"]; | ||
| if (!string.IsNullOrEmpty(configured)) | ||
| { | ||
| return (configured, null); | ||
| } | ||
|
|
||
| // Try to connect to the default emulator endpoint. | ||
| if (TryProbeEmulator("https://localhost:8081")) | ||
| { | ||
| return ("https://localhost:8081", null); | ||
| } | ||
|
|
||
| // Try to start a testcontainer with the Linux emulator. | ||
| // Synchronous blocking is required here because this runs in a Lazy<T> initializer | ||
| // which cannot be async. This matches the pattern used in SQL Server's TestEnvironment. | ||
| try | ||
| { | ||
| var container = new CosmosDbBuilder("mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:vnext-preview") | ||
| .Build(); | ||
| container.StartAsync().GetAwaiter().GetResult(); | ||
|
|
||
| AppDomain.CurrentDomain.ProcessExit += (_, _) => | ||
|
Member
There was a problem hiding this comment. We'd ideally use an xunit assembly fixture to start and stop the container.
Member
There was a problem hiding this comment. @copilot use an xunit assembly fixture to start and stop the container.
Contributor
Author
There was a problem hiding this comment. Done in 8ea3913. Implemented a custom xunit test framework ( The |
||
| { | ||
| try | ||
| { | ||
| container.DisposeAsync().AsTask().GetAwaiter().GetResult(); | ||
| } | ||
| catch | ||
| { | ||
| // Best-effort cleanup: container may already be stopped or Docker daemon | ||
| // may have exited before the process exit handler runs. | ||
| } | ||
| }; | ||
|
|
||
| var endpoint = new UriBuilder( | ||
| Uri.UriSchemeHttp, | ||
| container.Hostname, | ||
| container.GetMappedPublicPort(CosmosDbBuilder.CosmosDbPort)).ToString(); | ||
|
|
||
| return (endpoint, container); | ||
| } | ||
| catch | ||
| { | ||
| // Any failure (Docker not installed, daemon not running, image pull failure, etc.) | ||
|
AndriySvyryd marked this conversation as resolved.
Outdated
|
||
| // falls back to the default endpoint. The connection check in CosmosTestStore will | ||
| // determine whether the emulator is actually reachable and skip tests if not. | ||
| return ("https://localhost:8081", null); | ||
| } | ||
| } | ||
|
|
||
| private static bool TryProbeEmulator(string endpoint) | ||
| { | ||
| try | ||
| { | ||
| using var handler = new HttpClientHandler | ||
| { | ||
| ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousAcceptAnyServerCertificateValidator | ||
| }; | ||
| using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(3) }; | ||
| // Any successful response (even 401) means the emulator is up and accepting connections. | ||
| using var response = client.GetAsync(endpoint).GetAwaiter().GetResult(); | ||
| return true; | ||
| } | ||
| catch | ||
| { | ||
| // Expected: HttpRequestException (connection refused), TaskCanceledException (timeout), | ||
| // or SocketException when the emulator is not running. | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| public static string AuthToken { get; } = string.IsNullOrEmpty(Config["AuthToken"]) | ||
| ? _emulatorAuthToken | ||
| : Config["AuthToken"]; | ||
|
|
||
| public static string ConnectionString => $"AccountEndpoint={DefaultConnection};AccountKey={AuthToken}"; | ||
|
|
||
| public static bool UseTokenCredential { get; } = string.Equals(Config["UseTokenCredential"], "true", StringComparison.OrdinalIgnoreCase); | ||
|
|
||
|
|
@@ -45,12 +127,14 @@ public static class TestEnvironment | |
| ? AzureLocation.WestUS | ||
| : Enum.Parse<AzureLocation>(Config["AzureLocation"]); | ||
|
|
||
| public static bool IsEmulator => !UseTokenCredential && (AuthToken == _emulatorAuthToken); | ||
|
|
||
| public static bool SkipConnectionCheck { get; } = string.Equals(Config["SkipConnectionCheck"], "true", StringComparison.OrdinalIgnoreCase); | ||
|
|
||
| public static string EmulatorType => IsTestContainer | ||
| ? "linux" | ||
| : Config["EmulatorType"] ?? (!OperatingSystem.IsWindows() ? "linux" : ""); | ||
|
|
||
| public static bool IsLinuxEmulator => IsEmulator | ||
| && EmulatorType.Equals("linux", StringComparison.OrdinalIgnoreCase); | ||
| } | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.