Skip to content

Commit 09279aa

Browse files
ardalisardalis
committed
Make tests run in parallel (all 3 projects) by default.
Configure testcontainers for functional tests
1 parent 5ef6c24 commit 09279aa

10 files changed

Lines changed: 245 additions & 36 deletions

File tree

‎.runsettings‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<RunSettings>
3+
<RunConfiguration>
4+
<!-- Enable parallel test execution at the assembly level -->
5+
<MaxCpuCount>0</MaxCpuCount>
6+
<!-- 0 means use all available processors -->
7+
<DisableParallelization>false</DisableParallelization>
8+
</RunConfiguration>
9+
10+
<xUnit>
11+
<!-- Configure xUnit-specific settings -->
12+
<ParallelizeAssembly>true</ParallelizeAssembly>
13+
<ParallelizeTestCollections>true</ParallelizeTestCollections>
14+
<MaxParallelThreads>0</MaxParallelThreads>
15+
<!-- 0 means use default algorithm (processors * 2) -->
16+
</xUnit>
17+
</RunSettings>

‎Directory.Packages.props‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
<PackageVersion Include="SQLite" Version="3.13.0" />
3838
<PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
3939
<PackageVersion Include="Swashbuckle.AspNetCore.Annotations" Version="6.5.0" />
40+
<PackageVersion Include="Testcontainers" Version="4.3.0" />
41+
<PackageVersion Include="Testcontainers.MsSql" Version="4.3.0" />
4042
<PackageVersion Include="xunit" Version="2.9.3" />
4143
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
4244
<PackageVersion Include="Aspire.Hosting.AppHost" Version="13.0.0" />

‎PARALLEL_TEST_EXECUTION.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Parallel Test Execution Configuration
2+
3+
This workspace is configured to run all three test projects in parallel in Visual Studio Test Explorer.
4+
5+
## Configuration Files
6+
7+
### `.runsettings` (Solution Root)
8+
- Enables parallel test execution at the assembly level
9+
- `MaxCpuCount=0` uses all available processors to run test assemblies in parallel
10+
- `DisableParallelization=false` ensures parallelization is enabled
11+
12+
### `xunit.runner.json` (In Each Test Project)
13+
Each test project contains an `xunit.runner.json` file with:
14+
- `parallelizeAssembly: true` - Allows tests from this assembly to run in parallel with other assemblies
15+
- `parallelizeTestCollections: true` - Runs test collections within the assembly in parallel
16+
- `maxParallelThreads: 0` - Uses xUnit's default algorithm (processors × 2)
17+
18+
## How to Use in Visual Studio
19+
20+
### Option 1: Configure via Test Explorer Settings
21+
1. Open **Test Explorer** (Test ? Test Explorer)
22+
2. Click the settings icon (??) in the toolbar
23+
3. Select **Configure Run Settings** ? **Select Solution Wide runsettings File**
24+
4. Browse to and select the `.runsettings` file at the solution root
25+
26+
### Option 2: Configure via Visual Studio Settings
27+
1. Go to **Tools** ? **Options**
28+
2. Navigate to **Test** ? **General**
29+
3. Under **Run Settings File**, browse and select the `.runsettings` file
30+
31+
### Option 3: Automatic Detection
32+
Visual Studio will automatically detect and use `.runsettings` in the solution root in most cases.
33+
34+
## Verification
35+
36+
After configuration, when you run all tests:
37+
- The three test projects (UnitTests, IntegrationTests, FunctionalTests) will run in parallel
38+
- Within each project, test collections will also run in parallel
39+
- You should see multiple tests running simultaneously in Test Explorer
40+
41+
## Performance Considerations
42+
43+
**Recommended for:**
44+
- Fast unit tests (UnitTests project)
45+
- Independent integration tests that don't share state
46+
47+
**Use with caution for:**
48+
- Tests using shared resources (databases, files, ports)
49+
- Tests with Testcontainers - these may need collection fixtures to control parallelization
50+
51+
If you encounter issues with FunctionalTests (which use Testcontainers), you may need to:
52+
1. Disable parallelization for that specific project by setting `parallelizeAssembly: false` in its `xunit.runner.json`
53+
2. Use xUnit Collection Fixtures to control which tests can run in parallel
54+
3. Configure Testcontainers to use unique ports/databases per test class
55+
56+
## Disabling Parallel Execution
57+
58+
To disable parallel execution for a specific test project, update its `xunit.runner.json`:
59+
```json
60+
{
61+
"shadowCopy": false,
62+
"parallelizeAssembly": false,
63+
"parallelizeTestCollections": false
64+
}
65+
```
66+
67+
## Command Line Usage
68+
69+
To use the .runsettings file when running tests from the command line:
70+
```bash
71+
dotnet test --settings .runsettings
72+
```
73+
74+
## Related Documentation
75+
- [xUnit Parallel Test Execution](https://xunit.net/docs/running-tests-in-parallel)
76+
- [Visual Studio Run Settings](https://learn.microsoft.com/en-us/visualstudio/test/configure-unit-tests-by-using-a-dot-runsettings-file)

‎TESTCONTAINERS_IMPLEMENTATION.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Testcontainers Implementation for Functional Tests
2+
3+
## Summary
4+
5+
Successfully migrated functional tests from in-memory database to **Testcontainers** with SQL Server 2022. This provides a more realistic testing environment that matches production database behavior.
6+
7+
## Changes Made
8+
9+
### 1. Package References
10+
11+
**Added to `Directory.Packages.props`:**
12+
```xml
13+
<PackageVersion Include="Testcontainers" Version="4.3.0" />
14+
<PackageVersion Include="Testcontainers.MsSql" Version="4.3.0" />
15+
```
16+
17+
**Updated `tests\Clean.Architecture.FunctionalTests\Clean.Architecture.FunctionalTests.csproj`:**
18+
- Removed: `Microsoft.EntityFrameworkCore.InMemory`
19+
- Added: `Testcontainers` and `Testcontainers.MsSql`
20+
21+
### 2. CustomWebApplicationFactory
22+
23+
**File:** `tests\Clean.Architecture.FunctionalTests\CustomWebApplicationFactory.cs`
24+
25+
Key changes:
26+
- Implements `IAsyncLifetime` for proper async initialization/cleanup
27+
- Creates a SQL Server container using `MsSqlBuilder`
28+
- Uses SQL Server 2022 image: `mcr.microsoft.com/mssql/server:2022-latest`
29+
- Applies EF Core migrations instead of `EnsureCreated()`
30+
- Each test run gets a fresh containerized SQL Server instance
31+
32+
```csharp
33+
private readonly MsSqlContainer _dbContainer = new MsSqlBuilder()
34+
.WithImage("mcr.microsoft.com/mssql/server:2022-latest")
35+
.WithPassword("Your_password123!")
36+
.Build();
37+
```
38+
39+
### 3. Test Configuration
40+
41+
Tests now:
42+
- Use real SQL Server running in Docker containers
43+
- Apply actual EF Core migrations (matches production)
44+
- Run against isolated database instances (parallel test safety)
45+
- Clean up containers automatically after tests complete
46+
47+
## Benefits
48+
49+
? **Realistic Testing**: Tests run against actual SQL Server, not in-memory provider
50+
? **Migration Testing**: Validates that migrations work correctly
51+
? **Production Parity**: Database behavior matches production environment
52+
? **Isolation**: Each test class gets its own containerized database
53+
? **Automatic Cleanup**: Containers are disposed after tests complete
54+
55+
## Requirements
56+
57+
- **Docker Desktop** must be running on the development machine
58+
- Tests take slightly longer (~10-13 seconds vs instant with in-memory)
59+
- First run downloads SQL Server 2022 Docker image (~1.5 GB)
60+
61+
## Test Results
62+
63+
All 18 tests passing:
64+
- ? Unit Tests: 15 tests
65+
- ? Functional Tests: 3 tests
66+
- ? Total Duration: ~12 seconds
67+
68+
## Usage
69+
70+
Run tests normally:
71+
```bash
72+
dotnet test
73+
```
74+
75+
Or specifically for functional tests:
76+
```bash
77+
dotnet test tests\Clean.Architecture.FunctionalTests\Clean.Architecture.FunctionalTests.csproj
78+
```
79+
80+
## Notes
81+
82+
- Tests use the "Testing" environment configuration
83+
- SQL Server password: `Your_password123!` (only for test containers)
84+
- Container lifecycle managed by xUnit's `IAsyncLifetime`
85+
- Containers are automatically cleaned up even if tests fail

‎src/Clean.Architecture.Web/appsettings.Testing.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"Logging": {
3+
"LogLevel": {
4+
"Default": "Information",
5+
"Microsoft.AspNetCore": "Warning",
6+
"Microsoft.EntityFrameworkCore.Database.Command": "Information"
7+
}
8+
},
9+
"ConnectionStrings": {
10+
"SqliteConnection": ":memory:"
11+
},
12+
"Database": {
13+
"ApplyMigrationsOnStartup": false
14+
}
15+
}

‎tests/Clean.Architecture.FunctionalTests/Clean.Architecture.FunctionalTests.csproj‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
1515
</PackageReference>
1616
<PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" />
17-
<PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" />
17+
<PackageReference Include="Testcontainers" />
18+
<PackageReference Include="Testcontainers.MsSql" />
1819
<PackageReference Include="Ardalis.HttpClientTestExtensions" />
1920
</ItemGroup>
2021

‎tests/Clean.Architecture.FunctionalTests/CustomWebApplicationFactory.cs‎

Lines changed: 36 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
using Clean.Architecture.Infrastructure.Data;
2+
using Microsoft.EntityFrameworkCore;
3+
using Testcontainers.MsSql;
24

35
namespace Clean.Architecture.FunctionalTests;
46

5-
public class CustomWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram> where TProgram : class
7+
public class CustomWebApplicationFactory<TProgram> : WebApplicationFactory<TProgram>, IAsyncLifetime where TProgram : class
68
{
9+
private readonly MsSqlContainer _dbContainer = new MsSqlBuilder()
10+
.WithImage("mcr.microsoft.com/mssql/server:2022-latest")
11+
.WithPassword("Your_password123!")
12+
.Build();
13+
14+
public async Task InitializeAsync()
15+
{
16+
await _dbContainer.StartAsync();
17+
}
18+
19+
public new async Task DisposeAsync()
20+
{
21+
await _dbContainer.DisposeAsync();
22+
}
23+
724
/// <summary>
825
/// Overriding CreateHost to avoid creating a separate ServiceProvider per this thread:
926
/// https://github.com/dotnet-architecture/eShopOnWeb/issues/465
@@ -12,7 +29,7 @@ public class CustomWebApplicationFactory<TProgram> : WebApplicationFactory<TProg
1229
/// <returns></returns>
1330
protected override IHost CreateHost(IHostBuilder builder)
1431
{
15-
builder.UseEnvironment("Development"); // will not send real emails
32+
builder.UseEnvironment("Testing"); // will not send real emails
1633
var host = builder.Build();
1734
host.Start();
1835

@@ -29,21 +46,13 @@ protected override IHost CreateHost(IHostBuilder builder)
2946
var logger = scopedServices
3047
.GetRequiredService<ILogger<CustomWebApplicationFactory<TProgram>>>();
3148

32-
// Reset Sqlite database for each test run
33-
// If using a real database, you'll likely want to remove this step.
34-
db.Database.EnsureDeleted();
35-
36-
// Ensure the database is created.
37-
db.Database.EnsureCreated();
38-
3949
try
4050
{
41-
// Can also skip creating the items
42-
//if (!db.ToDoItems.Any())
43-
//{
51+
// Apply migrations to create the database schema
52+
db.Database.Migrate();
53+
4454
// Seed the database with test data.
4555
SeedData.PopulateTestDataAsync(db).Wait();
46-
//}
4756
}
4857
catch (Exception ex)
4958
{
@@ -60,26 +69,22 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
6069
builder
6170
.ConfigureServices(services =>
6271
{
63-
// Configure test dependencies here
64-
65-
//// Remove the app's ApplicationDbContext registration.
66-
//var descriptor = services.SingleOrDefault(
67-
//d => d.ServiceType ==
68-
// typeof(DbContextOptions<AppDbContext>));
69-
70-
//if (descriptor != null)
71-
//{
72-
// services.Remove(descriptor);
73-
//}
72+
// Remove the app's ApplicationDbContext registration
73+
var descriptors = services.Where(
74+
d => d.ServiceType == typeof(AppDbContext) ||
75+
d.ServiceType == typeof(DbContextOptions<AppDbContext>))
76+
.ToList();
7477

75-
//// This should be set for each individual test run
76-
//string inMemoryCollectionName = Guid.NewGuid().ToString();
78+
foreach (var descriptor in descriptors)
79+
{
80+
services.Remove(descriptor);
81+
}
7782

78-
//// Add ApplicationDbContext using an in-memory database for testing.
79-
//services.AddDbContext<AppDbContext>(options =>
80-
//{
81-
// options.UseInMemoryDatabase(inMemoryCollectionName);
82-
//});
83+
// Add ApplicationDbContext using the Testcontainers SQL Server instance
84+
services.AddDbContext<AppDbContext>((provider, options) =>
85+
{
86+
options.UseSqlServer(_dbContainer.GetConnectionString());
87+
});
8388
});
8489
}
8590
}

‎tests/Clean.Architecture.FunctionalTests/xunit.runner.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"shadowCopy": false,
3-
"parallelizeAssembly": false,
4-
"parallelizeTestCollections": false
3+
"parallelizeAssembly": true,
4+
"parallelizeTestCollections": true,
5+
"maxParallelThreads": 0
56
}

‎tests/Clean.Architecture.IntegrationTests/xunit.runner.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"shadowCopy": false,
3+
"parallelizeAssembly": true,
4+
"parallelizeTestCollections": true,
5+
"maxParallelThreads": 0
6+
}

‎tests/Clean.Architecture.UnitTests/xunit.runner.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"shadowCopy": false,
3-
"parallelizeAssembly": false,
4-
"parallelizeTestCollections": false
3+
"parallelizeAssembly": true,
4+
"parallelizeTestCollections": true,
5+
"maxParallelThreads": 0
56
}

0 commit comments

Comments
 (0)