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: Include the container name in the reuse hash #1162

Merged
Merged
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
4 changes: 4 additions & 0 deletions docs/api/resource_reuse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ _ = new ContainerBuilder()

The current implementation considers the following resource configurations and their corresponding builder APIs when calculating the hash value.

> [!NOTE]
> Version 3.8.0 did not include the container configuration's name in the hash value.

- [ContainerConfiguration](https://github.com/testcontainers/testcontainers-dotnet/blob/develop/src/Testcontainers/Configurations/Containers/ContainerConfiguration.cs)
- Image
- Entrypoint
Expand All @@ -26,6 +29,7 @@ The current implementation considers the following resource configurations and t
- PortBindings
- NetworkAliases
- ExtraHosts
- Name
- Labels
- [NetworkConfiguration](https://github.com/testcontainers/testcontainers-dotnet/blob/develop/src/Testcontainers/Configurations/Networks/NetworkConfiguration.cs)
- Name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@ public ContainerConfiguration(IContainerConfiguration oldValue, IContainerConfig
public Func<ImageInspectResponse, bool> ImagePullPolicy { get; }

/// <inheritdoc />
[JsonIgnore]
public string Name { get; }

/// <inheritdoc />
Expand Down
35 changes: 35 additions & 0 deletions tests/Testcontainers.Platform.Linux.Tests/ReusableResourceTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ public async Task ShouldReuseExistingResource()
Assert.Single(response.Volumes);
}

[Fact]
public void ContainersWithDifferentNamesShouldHaveDifferentHashes()
{
var hash1 = new ReuseHashContainerBuilder().WithName("Name1").GetReuseHash();
var hash2 = new ReuseHashContainerBuilder().WithName("Name2").GetReuseHash();

Assert.NotEqual(hash1, hash2);
}

public static class UnsupportedBuilderConfigurationTest
{
private const string EnabledCleanUpExceptionMessage = "Reuse cannot be used in conjunction with WithCleanUp(true). (Parameter 'Reuse')";
Expand Down Expand Up @@ -143,4 +152,30 @@ public void EnabledCleanUpThrowsException()
}
}
}

private sealed class ReuseHashContainerBuilder : ContainerBuilder<ReuseHashContainerBuilder, DockerContainer, ContainerConfiguration>
{
public ReuseHashContainerBuilder() : this(new ContainerConfiguration())
=> DockerResourceConfiguration = Init().DockerResourceConfiguration;

private ReuseHashContainerBuilder(ContainerConfiguration configuration) : base(configuration)
=> DockerResourceConfiguration = configuration;

protected override ContainerConfiguration DockerResourceConfiguration { get; }

public string GetReuseHash()
=> DockerResourceConfiguration.GetReuseHash();

public override DockerContainer Build()
=> new(DockerResourceConfiguration);

protected override ReuseHashContainerBuilder Clone(IResourceConfiguration<CreateContainerParameters> resourceConfiguration)
=> Merge(DockerResourceConfiguration, new ContainerConfiguration(resourceConfiguration));

protected override ReuseHashContainerBuilder Clone(IContainerConfiguration resourceConfiguration)
=> Merge(DockerResourceConfiguration, new ContainerConfiguration(resourceConfiguration));

protected override ReuseHashContainerBuilder Merge(ContainerConfiguration oldValue, ContainerConfiguration newValue)
=> new(new ContainerConfiguration(oldValue, newValue));
}
}
Loading