-
-
Notifications
You must be signed in to change notification settings - Fork 274
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Share common interface (IDatabaseContainer) for ADO.NET compati…
…ble containers (#920) Co-authored-by: Andre Hofmeister <[email protected]>
- Loading branch information
1 parent
6e31cf3
commit 44a1d3a
Showing
13 changed files
with
113 additions
and
7 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
namespace DotNet.Testcontainers.Containers | ||
{ | ||
using JetBrains.Annotations; | ||
|
||
/// <summary> | ||
/// Represents a database container instance that can be accessed with an ADO.NET provider. | ||
/// </summary> | ||
[PublicAPI] | ||
public interface IDatabaseContainer | ||
{ | ||
/// <summary> | ||
/// Gets the database connection string. | ||
/// </summary> | ||
/// <returns>The database connection string.</returns> | ||
[NotNull] | ||
string GetConnectionString(); | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
root = true |
54 changes: 54 additions & 0 deletions
54
tests/Testcontainers.Databases.Tests/DatabasesContainerTest.cs
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
namespace Testcontainers.Databases; | ||
|
||
public sealed class DatabaseContainersTest | ||
{ | ||
[Theory] | ||
[MemberData(nameof(GetContainerImplementations), parameters: true)] | ||
public void ShouldImplementIDatabaseContainer(Type type) | ||
{ | ||
Assert.True(type.IsAssignableTo(typeof(IDatabaseContainer)), $"The type '{type.Name}' does not implement the database interface."); | ||
} | ||
|
||
[Theory] | ||
[MemberData(nameof(GetContainerImplementations), parameters: false)] | ||
public void ShouldNotImplementIDatabaseContainer(Type type) | ||
{ | ||
Assert.False(type.IsAssignableTo(typeof(IDatabaseContainer)), $"The type '{type.Name}' does implement the database interface."); | ||
} | ||
|
||
public static IEnumerable<object[]> GetContainerImplementations(bool expectDataProvider) | ||
{ | ||
var testAssemblies = Directory.GetFiles(".", "Testcontainers.*.Tests.dll", SearchOption.TopDirectoryOnly) | ||
.Select(Path.GetFullPath) | ||
.Select(Assembly.LoadFrom) | ||
.ToDictionary(assembly => assembly, assembly => assembly.GetReferencedAssemblies() | ||
.Where(referencedAssembly => referencedAssembly.Name != null) | ||
.Where(referencedAssembly => !referencedAssembly.Name.StartsWith("System")) | ||
.Where(referencedAssembly => !referencedAssembly.Name.StartsWith("xunit")) | ||
.Where(referencedAssembly => !referencedAssembly.Name.Equals("Microsoft.VisualStudio.TestPlatform.ObjectModel")) | ||
.Where(referencedAssembly => !referencedAssembly.Name.Equals("Docker.DotNet")) | ||
.Where(referencedAssembly => !referencedAssembly.Name.Equals("Testcontainers")) | ||
.Select(Assembly.Load) | ||
.SelectMany(referencedAssembly => referencedAssembly.ExportedTypes) | ||
.ToImmutableList()); | ||
|
||
foreach (var testAssembly in testAssemblies) | ||
{ | ||
// TODO: If a module contains multiple container implementations, it would require all container implementations to implement the interface. | ||
foreach (var containerType in testAssembly.Value.Where(type => type.IsAssignableTo(typeof(IContainer)))) | ||
{ | ||
var hasDataProvider = testAssembly.Value.Exists(type => type.IsSubclassOf(typeof(DbProviderFactory))); | ||
|
||
if (expectDataProvider && hasDataProvider) | ||
{ | ||
yield return new object[] { containerType }; | ||
} | ||
|
||
if (!expectDataProvider && !hasDataProvider) | ||
{ | ||
yield return new object[] { containerType }; | ||
} | ||
} | ||
} | ||
} | ||
} |
17 changes: 17 additions & 0 deletions
17
tests/Testcontainers.Databases.Tests/Testcontainers.Databases.Tests.csproj
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<Project Sdk="Microsoft.NET.Sdk"> | ||
<PropertyGroup> | ||
<TargetFrameworks>net6.0</TargetFrameworks> | ||
<IsPackable>false</IsPackable> | ||
<IsPublishable>false</IsPublishable> | ||
</PropertyGroup> | ||
<ItemGroup> | ||
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.2"/> | ||
<PackageReference Include="coverlet.collector" Version="6.0.0"/> | ||
<PackageReference Include="xunit.runner.visualstudio" Version="2.5.0"/> | ||
<PackageReference Include="xunit" Version="2.5.0"/> | ||
</ItemGroup> | ||
<ItemGroup> | ||
<ProjectReference Include="$(SolutionDir)tests/Testcontainers.*.Tests/Testcontainers.*.Tests.csproj"/> | ||
<ProjectReference Remove="$(SolutionDir)tests/Testcontainers.Databases.Tests/Testcontainers.Databases.Tests.csproj"/> | ||
</ItemGroup> | ||
</Project> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
global using System; | ||
global using System.Collections.Generic; | ||
global using System.Collections.Immutable; | ||
global using System.Data.Common; | ||
global using System.IO; | ||
global using System.Linq; | ||
global using System.Reflection; | ||
global using DotNet.Testcontainers.Containers; | ||
global using Xunit; |