feat: refactor Docker container management to use Testcontainers (#165)

Author: glucaci

.github/workflows/ci.yml

@@ -1,23 +1,30 @@
 name: CI
-run-name: CI ${{ github.event.pull_request.title }}
+run-name: CI 🔍 ${{ github.event.pull_request.title }}
 
 on:
   pull_request:
 
+concurrency:
+  group: ci-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
 jobs:
   tests:
     runs-on: ubuntu-latest
+    name: Tests dotnet ${{ matrix.dotnet-version }}
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        dotnet-version: [8, 9, 10]
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v5
         with:
-          dotnet-version: |
-            8
-            9
-            10
+          dotnet-version: ${{ matrix.dotnet-version }}
 
       - name: Docker Information
         run: |
@@ -28,9 +35,9 @@ jobs:
         shell: bash
 
       - name: Build projects
-        run: dotnet build ./all.csproj
         shell: bash
+        run: dotnet build ./all.csproj -f net${{ matrix.dotnet-version }}.0
 
       - name: Run tests
-        run: dotnet test ./all.csproj /p:BuildTestOnly=true
-        shell: bash
+        shell: bash
+        run: dotnet test ./all.csproj /p:BuildTestsOnly=true --no-build -f net${{ matrix.dotnet-version }}.0 -- RunConfiguration.MaxCpuCount=1

.github/workflows/release.yml

@@ -1,5 +1,5 @@
 name: Release
-run-name: Release ${{ github.ref_name }}
+run-name: Release 🚀 ${{ github.ref_name }}
 
 on:
   push:
@@ -9,17 +9,20 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        project: ['.']
     steps:
       - name: Checkout code
         uses: actions/checkout@v6
 
       - name: Setup .NET
         uses: actions/setup-dotnet@v5
-        with:
-          dotnet-version: |
-            8
-            9
-            10
+
+      - name: Build projects
+        shell: bash
+        working-directory: ${{ matrix.project }}
+        run: dotnet build ./all.csproj -c Release
 
       - name: Extract version
         id: extract_version
@@ -32,12 +35,9 @@ jobs:
           echo "Package Version: $PACKAGE_VERSION"
           echo "Assembly Version: $ASSEMBLY_VERSION"
 
-      - name: Build projects
-        shell: bash
-        run: dotnet build ./all.csproj -c Release
-
       - name: Pack
         shell: bash
+        working-directory: ${{ matrix.project }}
         run: |
           dotnet pack ./all.csproj \
             -c Release \
@@ -52,5 +52,6 @@ jobs:
 
       - name: Push
         shell: bash
+        working-directory: ${{ matrix.project }}
         run: |
           find . -name '*.nupkg' | grep -v '.sources.nupkg' | parallel --jobs 0 'dotnet nuget push {} --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json'

Directory.Packages.props

@@ -41,7 +41,7 @@
         <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
         <PackageVersion Include="xunit" Version="2.9.3" />
         <PackageVersion Include="xunit.core" Version="2.9.3" />
-        <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.0" />
+        <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
         <PackageVersion Include="FluentAssertions" Version="7.2.0" />
         <PackageVersion Include="Moq" Version="4.20.72" />
         <PackageVersion Include="coverlet.collector" Version="6.0.4" />
@@ -50,10 +50,16 @@
 
         <PackageVersion Include="Microsoft.Extensions.Configuration.UserSecrets" Version="5.0.0" />
 
-        <PackageVersion Include="Docker.DotNet.Enhanced" Version="3.131.0" />
+        <PackageVersion Include="Testcontainers" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.MongoDb" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.PostgreSql" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.Redis" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.RabbitMq" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.MySql" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.MsSql" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.Elasticsearch" Version="4.3.0" />
+        <PackageVersion Include="Testcontainers.MariaDb" Version="4.3.0" />
         <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
-        <PackageVersion Include="Polly" Version="8.5.2" />
-        <PackageVersion Include="SharpZipLib" Version="1.4.2" />
 
         <PackageVersion Include="MongoDB.Driver" Version="3.0.0" />
         <PackageVersion Include="MySqlConnector" Version="2.4.0" />
@@ -83,7 +89,7 @@
         <PackageVersion Include="Typesense" Version="7.33.0" />
 
         <PackageVersion Include="FluentFTP" Version="35.0.4" />
-        <PackageVersion Include="SSH.NET" Version="2023.0.0" />
+        <PackageVersion Include="SSH.NET" Version="2024.2.0" />
 
 
         <PackageVersion Include="ServiceStack.Text" Version="8.8.0" />

all.csproj

@@ -1,16 +1,16 @@
 <Project Sdk="Microsoft.Build.Traversal/4.1.82">
 
   <PropertyGroup>
-    <BuildTestOnly>false</BuildTestOnly>
+    <BuildTestsOnly>false</BuildTestsOnly>
     <IncludeInSolutionFile>false</IncludeInSolutionFile>
   </PropertyGroup>
 
-  <ItemGroup Condition="$(BuildTestOnly) != 'true'">
+  <ItemGroup Condition="'$(BuildTestsOnly)' != 'true'">
     <ProjectReference Include="**/*.csproj" />
   </ItemGroup>
 
-  <ItemGroup Condition="$(BuildTestOnly) != 'true'">
-    <ProjectReference Include="**/test/*.csproj" />
+  <ItemGroup Condition="'$(BuildTestsOnly)' == 'true'">
+    <ProjectReference Include="**/test/**/*.csproj" />
   </ItemGroup>
 
-</Project>
+</Project>

nuget.config

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+    <packageSources>
+        <clear />
+        <add key="nuget" value="https://api.nuget.org/v3/index.json" />
+    </packageSources>
+</configuration>

src/Core/ChmodCommand.cs

@@ -1,6 +1,5 @@
 
 using System;
-using Docker.DotNet.Models;
 
 namespace Squadron;
 
@@ -17,36 +16,27 @@ public static class ChmodCommand
     /// <param name="group"><see cref="Permission"/> for group</param>
     /// <param name="public"><see cref="Permission"/> for public</param>
     /// <param name="recursive">Apply recursive</param>
-    public static ContainerExecCreateParameters Set(
+    public static string[] Set(
         string pathInContainer,
         Permission owner = Permission.None,
         Permission group = Permission.None,
         Permission @public = Permission.None,
         bool recursive = false)
     {
         var cmd = $"chmod {(recursive ? "-R " : "")}{owner:d}{group:d}{@public:d} {pathInContainer}";
-
-        return new ContainerExecCreateParameters
-        {
-            AttachStderr = true,
-            AttachStdin = false,
-            AttachStdout = true,
-            Cmd = cmd.Split(' '),
-            Privileged = true,
-            User = "root"
-        };
+        return cmd.Split(' ');
     }
 
-    public static ContainerExecCreateParameters ReadOnly(string pathInContainer, bool recursive = false)
+    public static string[] ReadOnly(string pathInContainer, bool recursive = false)
         => Set(pathInContainer, Permission.Read, Permission.Read, Permission.Read, recursive);
 
-    public static ContainerExecCreateParameters FullAccess(string pathInContainer, bool recursive = false)
+    public static string[] FullAccess(string pathInContainer, bool recursive = false)
         => Set(pathInContainer, Permission.FullAccess, Permission.FullAccess, Permission.FullAccess, recursive);
 
-    public static ContainerExecCreateParameters Execute(string pathInContainer, bool recursive = false)
+    public static string[] Execute(string pathInContainer, bool recursive = false)
         => Set(pathInContainer, Permission.Execute, Permission.Execute, Permission.Execute, recursive);
 
-    public static ContainerExecCreateParameters ReadWrite(string pathInContainer, bool recursive = false)
+    public static string[] ReadWrite(string pathInContainer, bool recursive = false)
         => Set(pathInContainer, Permission.ReadWrite, Permission.ReadWrite, Permission.ReadWrite, recursive);
 
     [Flags]

src/Core/ContainerInstance.cs

@@ -1,11 +1,9 @@
 using System;
 using System.Collections.Generic;
-using System.IO;
-using Docker.DotNet;
 
 namespace Squadron;
 
-/// <summary>Respresents a created docker container</summary>
+/// <summary>Represents a created docker container</summary>
 public class ContainerInstance : IDisposable
 {
     /// <summary>
@@ -67,10 +65,7 @@ public class ContainerInstance : IDisposable
     /// </value>
     public IList<string> Logs { get; set; } = new List<string>();
 
-    internal MultiplexedStream? LogStream { get; set; }
-
     public void Dispose()
     {
-        LogStream?.Dispose();
     }
 }

src/Core/ContainerResource.cs

@@ -64,9 +64,7 @@ protected virtual void SetupContainerResource()
         OnSettingsBuilded(Settings);
         ValidateSettings(Settings);
 
-        DockerConfiguration dockerConfig = Settings.DockerConfigResolver();
-
-        Manager = new DockerContainerManager(Settings, dockerConfig);
+        Manager = new TestcontainersDockerManager(Settings);
         Initializer = new ContainerInitializer(Manager, Settings);
     }
 

src/Core/ContainerResourceBuilder.cs

@@ -60,24 +60,6 @@ public ContainerResourceBuilder Image(string image)
         return this;
     }
 
-    /// <summary>
-    /// Container registry name as defined in configurations
-    /// Default is DockerHub
-    /// </summary>
-    /// <param name="registryName">Name of the registry.</param>
-    /// <returns></returns>
-    public ContainerResourceBuilder Registry(string registryName)
-    {
-        _options.RegistryName = registryName;
-        return this;
-    }
-
-    public ContainerResourceBuilder AddressMode(ContainerAddressMode mode)
-    {
-        _options.AddressMode = mode;
-        return this;
-    }
-
     /// <summary>
     /// Adds an environment variable.
     /// </summary>
@@ -342,18 +324,6 @@ public ContainerResourceBuilder WaitTimeout(int seconds)
         return this;
     }
 
-    /// <summary>
-    /// Sets the docker configuration resolver.
-    /// </summary>
-    /// <param name="resolver">The resolver.</param>
-    /// <returns></returns>
-    public ContainerResourceBuilder SetDockerConfigResolver(
-        Func<DockerConfiguration> resolver)
-    {
-        _options.DockerConfigResolver = resolver;
-        return this;
-    }
-
     /// <summary>
     /// Adds a network of which the container should be part of.
     /// </summary>
@@ -420,7 +390,6 @@ public virtual ContainerResourceSettings Build()
             _logLevel = overriddenLogLevel;
         }
 
-        _options.DockerConfigResolver ??= ContainerResourceOptions.DefaultDockerConfigResolver;
         _options.Logger = new Logger(_logLevel, _options);
         _options.Cmd = _cmd;
         return _options;