feat(spicedb): add testcontainer module for SpiceDB

.github/workflows/cicd.yml

@@ -2,6 +2,11 @@ name: Continuous Integration & Delivery
 
 on:
   push:
+    branches: [develop, main, bugfix/*, feature/*]
+    paths-ignore: ["docs/**", "examples/**"]
+  pull_request:
+    branches: [develop, main]
+    paths-ignore: ["docs/**", "examples/**"]
     branches: [ develop, main, bugfix/*, feature/* ]
   pull_request:
     branches: [ develop, main ]

Directory.Packages.props

@@ -5,6 +5,9 @@
     </PropertyGroup>
     <ItemGroup>
         <PackageVersion Include="BouncyCastle.Cryptography" Version="2.6.1"/>
+        <PackageVersion Include="Docker.DotNet.Enhanced.X509" Version="3.128.3"/>
+        <PackageVersion Include="Docker.DotNet.Enhanced" Version="3.128.3"/>
+        <PackageVersion Include="Grpc.Core" Version="2.46.6" />
         <PackageVersion Include="Docker.DotNet.Enhanced.X509" Version="3.129.0"/>
         <PackageVersion Include="Docker.DotNet.Enhanced" Version="3.129.0"/>
         <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0"/>
@@ -61,6 +64,8 @@
         <PackageVersion Include="Google.Cloud.Firestore" Version="3.1.0"/>
         <PackageVersion Include="Google.Cloud.PubSub.V1" Version="3.5.0"/>
         <PackageVersion Include="Google.Cloud.Storage.V1" Version="4.6.0"/>
+        <PackageVersion Include="Grpc.HealthCheck" Version="2.60.0"/>
+        <PackageVersion Include="Grpc.Net.Client" Version="2.60.0"/>
         <PackageVersion Include="InfluxDB.Client" Version="4.18.0"/>
         <PackageVersion Include="JanusGraph.Net" Version="1.0.0"/>
         <PackageVersion Include="Keycloak.Net.Core" Version="1.0.20"/>

Testcontainers.sln

@@ -280,6 +280,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Xunit.Tests"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.XunitV3.Tests", "tests\Testcontainers.XunitV3.Tests\Testcontainers.XunitV3.Tests.csproj", "{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.SpiceDB", "src\Testcontainers.SpiceDB\Testcontainers.SpiceDB.csproj", "{64B27088-14DC-4CA2-B24E-5D0D5BA14355}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.SpiceDB.Tests", "tests\Testcontainers.SpiceDB.Tests\Testcontainers.SpiceDB.Tests.csproj", "{21D155EB-A843-4D4D-84E1-5C913217BE89}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -806,6 +810,18 @@ Global
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{64B27088-14DC-4CA2-B24E-5D0D5BA14355}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{64B27088-14DC-4CA2-B24E-5D0D5BA14355}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{64B27088-14DC-4CA2-B24E-5D0D5BA14355}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{64B27088-14DC-4CA2-B24E-5D0D5BA14355}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A9F554E5-9183-4F8A-B226-58DD46BB2060}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A9F554E5-9183-4F8A-B226-58DD46BB2060}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A9F554E5-9183-4F8A-B226-58DD46BB2060}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A9F554E5-9183-4F8A-B226-58DD46BB2060}.Release|Any CPU.Build.0 = Release|Any CPU
+		{21D155EB-A843-4D4D-84E1-5C913217BE89}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{21D155EB-A843-4D4D-84E1-5C913217BE89}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{21D155EB-A843-4D4D-84E1-5C913217BE89}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{21D155EB-A843-4D4D-84E1-5C913217BE89}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -942,5 +958,7 @@ Global
 		{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{E901DF14-6F05-4FC2-825A-3055FAD33561} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 		{B2E8B7FB-7D1E-4DD3-A25E-34DE4386B1EB} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
+		{64B27088-14DC-4CA2-B24E-5D0D5BA14355} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
+		{21D155EB-A843-4D4D-84E1-5C913217BE89} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
 	EndGlobalSection
 EndGlobal

docs/modules/index.md

@@ -20,7 +20,7 @@ await moduleNameContainer.StartAsync();
     We will add module-specific documentations soon.
 
 | Module            | Image                                                               | NuGet                                                                | Source                                                                                                          |
-|-------------------|---------------------------------------------------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
+| ----------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
 | ActiveMQ Artemis  | `apache/activemq-artemis:2.31.2`                                    | [NuGet](https://www.nuget.org/packages/Testcontainers.ActiveMq)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.ActiveMq)      |
 | ArangoDB          | `arangodb:3.11.5`                                                   | [NuGet](https://www.nuget.org/packages/Testcontainers.ArangoDb)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.ArangoDb)      |
 | Azure Cosmos DB   | `mcr.microsoft.com/cosmosdb/linux/azure-cosmos-emulator:latest`     | [NuGet](https://www.nuget.org/packages/Testcontainers.CosmosDb)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.CosmosDb)      |
@@ -77,6 +77,7 @@ await moduleNameContainer.StartAsync();
 | Typesense         | `typesense/typesense:28.0`                                          | [NuGet](https://www.nuget.org/packages/Testcontainers.Typesense)     | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Typesense)     |
 | Weaviate          | `semitechnologies/weaviate:1.26.14`                                 | [NuGet](https://www.nuget.org/packages/Testcontainers.Weaviate)      | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.Weaviate)      |
 | WebDriver         | `selenium/standalone-chrome:110.0`                                  | [NuGet](https://www.nuget.org/packages/Testcontainers.WebDriver)     | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.WebDriver)     |
+| SpiceDB           | `authzed/spicedb:v1.45.1`                                           | [NuGet](https://www.nuget.org/packages/Testcontainers.SpiceDB)       | [Source](https://github.com/testcontainers/testcontainers-dotnet/tree/develop/src/Testcontainers.SpiceDB)       |
 | WireMock          | -                                                                   | [NuGet](https://www.nuget.org/packages/WireMock.Net.Testcontainers)  | [Source](https://github.com/wiremock/WireMock.Net)                                                              |
 
 ## Implement a module

docs/modules/spicedb.md

@@ -0,0 +1,56 @@
+# SpiceDB
+
+[SpiceDB](https://authzed.com/spicedb/) is an open-source, Google Zanzibar-inspired permissions database that provides a centralized service to store, compute, and validate application permissions. It enables fine-grained authorization at scale with a flexible relationship-based permission model.
+
+Add the following dependency to your project file:
+
+```shell title="NuGet"
+dotnet add package Testcontainers.SpiceDB
+```
+
+You can start a SpiceDB 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.
+
+=== "Usage Example"
+
+````csharp
+public sealed class SpiceDBContainerTest : IAsyncLifetime
+{
+private readonly SpiceDBContainer \_spicedbContainer = new SpiceDBBuilder().Build();
+
+        public Task InitializeAsync()
+        {
+            return _spicedbContainer.StartAsync();
+        }
+
+        public Task DisposeAsync()
+        {
+            return _spicedbContainer.DisposeAsync().AsTask();
+        }
+
+        [Fact]
+        public async Task SpiceDBContainer_IsRunning_ReturnsTrue()
+        {
+            // Given
+            var containerState = await _spicedbContainer.GetStateAsync();
+
+            // ...
+        }
+    }
+    ```
+
+The test example uses the following NuGet dependencies:
+
+=== "Package References"
+`xml
+    <ItemGroup>
+      <PackageReference Include="Microsoft.NET.Test.Sdk" />
+      <PackageReference Include="xunit" />
+      <PackageReference Include="xunit.runner.visualstudio" />
+      <PackageReference Include="Testcontainers.SpiceDB" />
+    </ItemGroup>
+    `
+
+To execute the tests, use the command `dotnet test` from a terminal.
+
+--8<-- "docs/modules/\_call_out_test_projects.txt"
+````

src/Testcontainers.SpiceDB/.editorconfig

@@ -0,0 +1 @@
+root = true

src/Testcontainers.SpiceDB/SpiceDBBuilder.cs

@@ -0,0 +1,71 @@
+namespace Testcontainers.SpiceDB;
+
+/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
+[PublicAPI]
+public sealed class SpiceDBBuilder : ContainerBuilder<SpiceDBBuilder, SpiceDBContainer, SpiceDBConfiguration>
+{
+    public const string SpiceDBImage = "authzed/spicedb:v1.45.1";
+
+    public const ushort SpiceDBgRPCPort = 50051;
+
+    public const ushort SpiceDBgHTTPPort = 8443;
+
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBBuilder" /> class.
+    /// </summary>
+    public SpiceDBBuilder()
+        : this(new SpiceDBConfiguration())
+    {
+        DockerResourceConfiguration = Init().DockerResourceConfiguration;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBBuilder" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    private SpiceDBBuilder(SpiceDBConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        DockerResourceConfiguration = resourceConfiguration;
+    }
+
+    /// <inheritdoc />
+    protected override SpiceDBConfiguration DockerResourceConfiguration { get; }
+
+    /// <inheritdoc />
+    public override SpiceDBContainer Build()
+    {
+        Validate();
+        return new SpiceDBContainer(DockerResourceConfiguration);
+    }
+
+    /// <inheritdoc />
+    protected override SpiceDBBuilder Init()
+    {
+        return base.Init()
+            .WithImage(SpiceDBImage)
+            .WithPortBinding(SpiceDBgRPCPort, true)
+            .WithPortBinding(SpiceDBgHTTPPort, true)
+            .WithCommand("serve", $"--grpc-preshared-key={DockerResourceConfiguration.GrpcPresharedKey}", $"--datastore-engine={DockerResourceConfiguration.DatastoreEngine}", $"--log-level=info")
+            .WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged("grpc server started serving"));
+    }
+
+    /// <inheritdoc />
+    protected override SpiceDBBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new SpiceDBConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override SpiceDBBuilder Clone(IContainerConfiguration resourceConfiguration)
+    {
+        return Merge(DockerResourceConfiguration, new SpiceDBConfiguration(resourceConfiguration));
+    }
+
+    /// <inheritdoc />
+    protected override SpiceDBBuilder Merge(SpiceDBConfiguration oldValue, SpiceDBConfiguration newValue)
+    {
+        return new SpiceDBBuilder(new SpiceDBConfiguration(oldValue, newValue));
+    }
+}

src/Testcontainers.SpiceDB/SpiceDBConfiguration.cs

@@ -0,0 +1,63 @@
+namespace Testcontainers.SpiceDB;
+
+/// <inheritdoc cref="ContainerConfiguration" />
+[PublicAPI]
+public sealed class SpiceDBConfiguration : ContainerConfiguration
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBConfiguration" /> class.
+    /// </summary>
+    public SpiceDBConfiguration(string grpcPresharedKey = "mysecret", string datastoreEngine = "memory", bool? tslEnabled = false)
+    {
+        GrpcPresharedKey = grpcPresharedKey;
+        DatastoreEngine = datastoreEngine;
+        TslEnabled = tslEnabled.GetValueOrDefault(false);
+    }
+
+    public bool TslEnabled { get; set; }
+
+    public string GrpcPresharedKey { get; set; }
+
+    public string DatastoreEngine { get; set; }
+
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public SpiceDBConfiguration(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public SpiceDBConfiguration(IContainerConfiguration resourceConfiguration)
+        : base(resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBConfiguration" /> class.
+    /// </summary>
+    /// <param name="resourceConfiguration">The Docker resource configuration.</param>
+    public SpiceDBConfiguration(SpiceDBConfiguration resourceConfiguration)
+        : this(new SpiceDBConfiguration(), resourceConfiguration)
+    {
+        // Passes the configuration upwards to the base implementations to create an updated immutable copy.
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBConfiguration" /> class.
+    /// </summary>
+    /// <param name="oldValue">The old Docker resource configuration.</param>
+    /// <param name="newValue">The new Docker resource configuration.</param>
+    public SpiceDBConfiguration(SpiceDBConfiguration oldValue, SpiceDBConfiguration newValue)
+        : base(oldValue, newValue)
+    {
+    }
+}

src/Testcontainers.SpiceDB/SpiceDBContainer.cs

@@ -0,0 +1,28 @@
+using System.Threading;
+using Health = Grpc.Health.V1.Health;
+
+namespace Testcontainers.SpiceDB;
+
+/// <inheritdoc cref="DockerContainer" />
+[PublicAPI]
+public sealed class SpiceDBContainer : DockerContainer
+{
+    SpiceDBConfiguration _configuration;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SpiceDBContainer" /> class.
+    /// </summary>
+    /// <param name="configuration">The container configuration.</param>
+    public SpiceDBContainer(SpiceDBConfiguration configuration)
+        : base(configuration)
+    {
+        _configuration = configuration;
+    }
+
+    public string GetGrpcConnectionString()
+    {
+        var scheme = _configuration.TslEnabled ? Uri.UriSchemeHttps : Uri.UriSchemeHttp;
+        var endpoint = new UriBuilder(scheme, Hostname, GetMappedPublicPort(SpiceDBBuilder.SpiceDBgRPCPort));
+        return endpoint.ToString();
+    }
+}

src/Testcontainers.SpiceDB/Testcontainers.SpiceDB.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <TargetFrameworks>net8.0;net9.0;netstandard2.0;netstandard2.1</TargetFrameworks>
+        <LangVersion>latest</LangVersion>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Grpc.HealthCheck" />
+        <PackageReference Include="JetBrains.Annotations" VersionOverride="2023.3.0" PrivateAssets="All"/>
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Testcontainers\Testcontainers.csproj" />
+    </ItemGroup>
+
+</Project>

src/Testcontainers.SpiceDB/Usings.cs

@@ -0,0 +1,9 @@
+global using System;
+global using System.Threading.Tasks;
+global using Docker.DotNet.Models;
+global using DotNet.Testcontainers.Builders;
+global using DotNet.Testcontainers.Configurations;
+global using DotNet.Testcontainers.Containers;
+global using JetBrains.Annotations;
+global using Grpc.Health.V1;
+global using Grpc.Core; 

tests/Testcontainers.SpiceDB.Tests/.editorconfig

@@ -0,0 +1 @@
+root = true