docs(ClickHouse): Add example

Author: digital88

docs/modules/clickhouse.md

@@ -0,0 +1,39 @@
+# ClickHouse
+
+[ClickHouse](https://clickhouse.com/) is a high-performance, column-oriented SQL database management system (DBMS) for online analytical processing (OLAP).
+
+Add the following dependency to your project file:
+
+```shell title="NuGet"
+dotnet add package Testcontainers.ClickHouse
+```
+
+You can start a ClickHouse container instance from any .NET application. This example uses xUnit.net's `IAsyncLifetime` interface to manage the lifecycle of the container. The container is started in the `InitializeAsync` method before the test method runs, ensuring that the environment is ready for testing. After the test completes, the container is removed in the `DisposeAsync` method.
+
+=== "Test class"
+    ```csharp
+    --8<-- "tests/Testcontainers.ClickHouse.Tests/ClickHouseContainerTest.cs:Class"
+    }
+    ```
+
+=== "Connecting to ClickHouse"
+    ```csharp
+    --8<-- "tests/Testcontainers.ClickHouse.Tests/ClickHouseContainerTest.cs:Connecting"
+    ```
+
+Execute SQL script example:
+=== "SQL Script"
+    ```csharp
+    --8<-- "tests/Testcontainers.ClickHouse.Tests/ClickHouseContainerTest.cs:SQLScript"
+    ```
+
+The test example uses the following NuGet dependencies:
+
+=== "Package References"
+    ```xml
+    --8<-- "tests/Testcontainers.ClickHouse.Tests/Testcontainers.ClickHouse.Tests.csproj:PackageReferences"
+    ```
+
+To execute the tests, use the command `dotnet test` from a terminal.
+
+--8<-- "docs/modules/_call_out_test_projects.txt"

mkdocs.yml

@@ -53,6 +53,7 @@ nav:
     - modules/pulsar.md # Apache
     - modules/eventhubs.md # Azure
     - modules/servicebus.md # Azure
+    - modules/clickhouse.md
     - modules/db2.md
     - modules/elasticsearch.md
     - modules/mongodb.md

tests/Testcontainers.ClickHouse.Tests/ClickHouseContainerTest.cs

@@ -1,5 +1,6 @@
 namespace Testcontainers.ClickHouse;
 
+// <!-- -8<- [start:Class] -->
 public sealed class ClickHouseContainerTest : IAsyncLifetime
 {
     private readonly ClickHouseContainer _clickHouseContainer = new ClickHouseBuilder().Build();
@@ -13,7 +14,9 @@ public Task DisposeAsync()
     {
         return _clickHouseContainer.DisposeAsync().AsTask();
     }
+    // <!-- -8<- [end:Class] -->
 
+    // <!-- -8<- [start:Connecting] -->
     [Fact]
     [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
     public void ConnectionStateReturnsOpen()
@@ -27,7 +30,9 @@ public void ConnectionStateReturnsOpen()
         // Then
         Assert.Equal(ConnectionState.Open, connection.State);
     }
+    // <!-- -8<- [end:Connecting] -->
 
+    // <!-- -8<- [start:SQLScript] -->
     [Fact]
     [Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
     public async Task ExecScriptReturnsSuccessful()
@@ -43,4 +48,5 @@ public async Task ExecScriptReturnsSuccessful()
         Assert.True(0L.Equals(execResult.ExitCode), execResult.Stderr);
         Assert.Empty(execResult.Stderr);
     }
+    // <!-- -8<- [end:SQLScript] -->
 }

tests/Testcontainers.ClickHouse.Tests/Testcontainers.ClickHouse.Tests.csproj

@@ -5,11 +5,13 @@
         <IsPublishable>false</IsPublishable>
     </PropertyGroup>
     <ItemGroup>
+        <!-- -8<- [start:PackageReferences] -->
         <PackageReference Include="Microsoft.NET.Test.Sdk"/>
         <PackageReference Include="coverlet.collector"/>
         <PackageReference Include="xunit.runner.visualstudio"/>
         <PackageReference Include="xunit"/>
         <PackageReference Include="ClickHouse.Client"/>
+        <!-- -8<- [end:PackageReferences] -->
     </ItemGroup>
     <ItemGroup>
         <ProjectReference Include="../../src/Testcontainers.ClickHouse/Testcontainers.ClickHouse.csproj"/>