Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Camunda module #1186

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
<PackageVersion Include="Azure.Data.Tables" Version="12.8.0"/>
<PackageVersion Include="Azure.Storage.Blobs" Version="12.17.0"/>
<PackageVersion Include="Azure.Storage.Queues" Version="12.15.0"/>
<PackageVersion Include="Camunda.Api.Client" Version="2.6.0"/>
<PackageVersion Include="ClickHouse.Client" Version="6.7.1"/>
<PackageVersion Include="Confluent.Kafka" Version="2.0.2"/>
<PackageVersion Include="Consul" Version="1.6.10.9"/>
Expand Down
14 changes: 14 additions & 0 deletions Testcontainers.sln
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Tests", "tes
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.WebDriver.Tests", "tests\Testcontainers.WebDriver.Tests\Testcontainers.WebDriver.Tests.csproj", "{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Camunda", "src\Testcontainers.Camunda\Testcontainers.Camunda.csproj", "{D1291B24-EED1-431C-B7CE-606A1D1B5AE8}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testcontainers.Camunda.Tests", "tests\Testcontainers.Camunda.Tests\Testcontainers.Camunda.Tests.csproj", "{E49BEB22-7719-4006-ACB9-90046D1F8526}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -568,6 +572,14 @@ Global
{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2}.Release|Any CPU.Build.0 = Release|Any CPU
{D1291B24-EED1-431C-B7CE-606A1D1B5AE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D1291B24-EED1-431C-B7CE-606A1D1B5AE8}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D1291B24-EED1-431C-B7CE-606A1D1B5AE8}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D1291B24-EED1-431C-B7CE-606A1D1B5AE8}.Release|Any CPU.Build.0 = Release|Any CPU
{E49BEB22-7719-4006-ACB9-90046D1F8526}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{E49BEB22-7719-4006-ACB9-90046D1F8526}.Debug|Any CPU.Build.0 = Debug|Any CPU
{E49BEB22-7719-4006-ACB9-90046D1F8526}.Release|Any CPU.ActiveCfg = Release|Any CPU
{E49BEB22-7719-4006-ACB9-90046D1F8526}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{5365F780-0E6C-41F0-B1B9-7DC34368F80C} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
Expand Down Expand Up @@ -661,5 +673,7 @@ Global
{1A1983E6-5297-435F-B467-E8E1F11277D6} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
{27CDB869-A150-4593-958F-6F26E5391E7C} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
{EBA72C3B-57D5-43FF-A5B4-3D55B3B6D4C2} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
{D1291B24-EED1-431C-B7CE-606A1D1B5AE8} = {673F23AE-7694-4BB9-ABD4-136D6C13634E}
{E49BEB22-7719-4006-ACB9-90046D1F8526} = {7164F1FB-7F24-444A-ACD2-2C329C2B3CCF}
EndGlobalSection
EndGlobal
1 change: 1 addition & 0 deletions src/Testcontainers.Camunda/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
root = true
66 changes: 66 additions & 0 deletions src/Testcontainers.Camunda/CamundaBuilder.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
namespace Testcontainers.Camunda;

/// <inheritdoc cref="ContainerBuilder{TBuilderEntity, TContainerEntity, TConfigurationEntity}" />
[PublicAPI]
public sealed class CamundaBuilder : ContainerBuilder<CamundaBuilder, CamundaContainer, CamundaConfiguration>
{
public const string CamundaImage = "camunda/camunda-bpm-platform:7.22.0-SNAPSHOT";

public const ushort CamundaPort = 8080;

/// <summary>
/// Initializes a new instance of the <see cref="CamundaBuilder" /> class.
/// </summary>
public CamundaBuilder()
: this(new CamundaConfiguration())
{
DockerResourceConfiguration = Init().DockerResourceConfiguration;
}

/// <summary>
/// Initializes a new instance of the <see cref="CamundaBuilder" /> class.
/// </summary>
/// <param name="resourceConfiguration">The Docker resource configuration.</param>
private CamundaBuilder(CamundaConfiguration resourceConfiguration)
: base(resourceConfiguration)
{
DockerResourceConfiguration = resourceConfiguration;
}

/// <inheritdoc />
protected override CamundaConfiguration DockerResourceConfiguration { get; }

/// <inheritdoc />
public override CamundaContainer Build()
{
Validate();
return new CamundaContainer(DockerResourceConfiguration);
}

/// <inheritdoc />
protected override CamundaBuilder Init()
{
return base.Init()
.WithImage(CamundaImage)
.WithPortBinding(CamundaPort, true)
.WithWaitStrategy(Wait.ForUnixContainer().UntilMessageIsLogged("(?s).*Engine created.*$"));
}

/// <inheritdoc />
protected override CamundaBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
{
return Merge(DockerResourceConfiguration, new CamundaConfiguration(resourceConfiguration));
}

/// <inheritdoc />
protected override CamundaBuilder Clone(IContainerConfiguration resourceConfiguration)
{
return Merge(DockerResourceConfiguration, new CamundaConfiguration(resourceConfiguration));
}

/// <inheritdoc />
protected override CamundaBuilder Merge(CamundaConfiguration oldValue, CamundaConfiguration newValue)
{
return new CamundaBuilder(new CamundaConfiguration(oldValue, newValue));
}
}
54 changes: 54 additions & 0 deletions src/Testcontainers.Camunda/CamundaConfiguration.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
namespace Testcontainers.Camunda;

/// <inheritdoc cref="ContainerConfiguration" />
[PublicAPI]
public sealed class CamundaConfiguration : ContainerConfiguration
{
/// <summary>
/// Initializes a new instance of the <see cref="CamundaConfiguration" /> class.
/// </summary>
public CamundaConfiguration()
{

}

/// <summary>
/// Initializes a new instance of the <see cref="CamundaConfiguration" /> class.
/// </summary>
/// <param name="resourceConfiguration">The Docker resource configuration.</param>
public CamundaConfiguration(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="CamundaConfiguration" /> class.
/// </summary>
/// <param name="resourceConfiguration">The Docker resource configuration.</param>
public CamundaConfiguration(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="CamundaConfiguration" /> class.
/// </summary>
/// <param name="resourceConfiguration">The Docker resource configuration.</param>
public CamundaConfiguration(CamundaConfiguration resourceConfiguration)
: this(new CamundaConfiguration(), resourceConfiguration)
{
// Passes the configuration upwards to the base implementations to create an updated immutable copy.
}

/// <summary>
/// Initializes a new instance of the <see cref="CamundaConfiguration" /> class.
/// </summary>
/// <param name="oldValue">The old Docker resource configuration.</param>
/// <param name="newValue">The new Docker resource configuration.</param>
public CamundaConfiguration(CamundaConfiguration oldValue, CamundaConfiguration newValue)
: base(oldValue, newValue)
{
}
}
25 changes: 25 additions & 0 deletions src/Testcontainers.Camunda/CamundaContainer.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
namespace Testcontainers.Camunda;

/// <inheritdoc cref="DockerContainer" />
[PublicAPI]
public sealed class CamundaContainer : DockerContainer
{
/// <summary>
/// Initializes a new instance of the <see cref="CamundaContainer" /> class.
/// </summary>
/// <param name="configuration">The container configuration.</param>
public CamundaContainer(IContainerConfiguration configuration) : base(configuration)
{
}

/// <summary>
/// Gets the Camunda connection string.
/// </summary>
/// <returns>The Camunda connection string.</returns>
public string GetConnectionString()
{
var endpoint = new UriBuilder(Uri.UriSchemeHttp, Hostname, GetMappedPublicPort(CamundaBuilder.CamundaPort));
endpoint.Path = "engine-rest";
return endpoint.ToString();
}
}
12 changes: 12 additions & 0 deletions src/Testcontainers.Camunda/Testcontainers.Camunda.csproj
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>net6.0;net8.0;netstandard2.0;netstandard2.1</TargetFrameworks>
<LangVersion>latest</LangVersion>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="JetBrains.Annotations" VersionOverride="2023.3.0" PrivateAssets="All"/>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="../Testcontainers/Testcontainers.csproj"/>
</ItemGroup>
</Project>
6 changes: 6 additions & 0 deletions src/Testcontainers.Camunda/Usings.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
global using System;
global using Docker.DotNet.Models;
global using DotNet.Testcontainers.Builders;
global using DotNet.Testcontainers.Configurations;
global using DotNet.Testcontainers.Containers;
global using JetBrains.Annotations;
1 change: 1 addition & 0 deletions tests/Testcontainers.Camunda.Tests/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
root = true
31 changes: 31 additions & 0 deletions tests/Testcontainers.Camunda.Tests/CamundaContainerTest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
namespace Testcontainers.Camunda;

public sealed class CamundaContainerTest : IAsyncLifetime
{
private readonly CamundaContainer _camundaContainer = new CamundaBuilder().Build();

public Task InitializeAsync()
{
return _camundaContainer.StartAsync();
}

public Task DisposeAsync()
{
return _camundaContainer.DisposeAsync().AsTask();
}

[Fact]
[Trait(nameof(DockerCli.DockerPlatform), nameof(DockerCli.DockerPlatform.Linux))]
public async Task EstablishesConnection()
{
// Given
var client = CamundaClient.Create(_camundaContainer.GetConnectionString());

// When
var response = (await client.ProcessDefinitions.Query(new ProcessDefinitionQuery()).List())
.Select(x => x.Resource);

// Then
Assert.Equal(new[] { "reviewInvoice.bpmn", "invoice.v1.bpmn", "invoice.v2.bpmn" }, response);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>net8.0</TargetFrameworks>
<IsPackable>false</IsPackable>
<IsPublishable>false</IsPublishable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Camunda.Api.Client" />
<PackageReference Include="Microsoft.NET.Test.Sdk"/>
<PackageReference Include="coverlet.collector"/>
<PackageReference Include="xunit.runner.visualstudio"/>
<PackageReference Include="xunit"/>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="../Testcontainers.Commons/Testcontainers.Commons.csproj"/>
<ProjectReference Include="..\..\src\Testcontainers.Camunda\Testcontainers.Camunda.csproj"/>
</ItemGroup>
</Project>
7 changes: 7 additions & 0 deletions tests/Testcontainers.Camunda.Tests/Usings.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
global using System;
global using System.Linq;
global using System.Threading.Tasks;
global using Camunda.Api.Client;
global using Camunda.Api.Client.ProcessDefinition;
global using DotNet.Testcontainers.Commons;
global using Xunit;
Loading