Skip to content

Commit

Permalink
fix: Remove cref from inheritdoc (#922)
Browse files Browse the repository at this point in the history
  • Loading branch information
@HofmeisterAn
HofmeisterAn authored Jun 13, 2023
1 parent 2c5c2cb commit 32d76af
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 54 deletions.
16 changes: 8 additions & 8 deletions src/Testcontainers/Builders/AbstractBuilder`4.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,50 +33,50 @@ protected AbstractBuilder(TConfigurationEntity dockerResourceConfiguration)
/// </summary>
protected abstract TConfigurationEntity DockerResourceConfiguration { get; }

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithDockerEndpoint(string endpoint)
{
return WithDockerEndpoint(new Uri(endpoint));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithDockerEndpoint(Uri endpoint)
{
return WithDockerEndpoint(new DockerEndpointAuthenticationConfiguration(endpoint));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithDockerEndpoint(IDockerEndpointAuthenticationConfiguration dockerEndpointAuthConfig)
{
return Clone(new ResourceConfiguration<TCreateResourceEntity>(dockerEndpointAuthenticationConfiguration: dockerEndpointAuthConfig));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithCleanUp(bool cleanUp)
{
return WithResourceReaperSessionId(TestcontainersSettings.ResourceReaperEnabled && cleanUp ? ResourceReaper.DefaultSessionId : Guid.Empty);
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithLabel(string name, string value)
{
return WithLabel(new Dictionary<string, string> { { name, value } });
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithLabel(IReadOnlyDictionary<string, string> labels)
{
return Clone(new ResourceConfiguration<TCreateResourceEntity>(labels: labels));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public TBuilderEntity WithCreateParameterModifier(Action<TCreateResourceEntity> parameterModifier)
{
var parameterModifiers = new[] { parameterModifier };
return Clone(new ResourceConfiguration<TCreateResourceEntity>(parameterModifiers: parameterModifiers));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TContainerEntity, TCreateResourceEntity}" />
/// <inheritdoc />
public abstract TResourceEntity Build();

/// <summary>
Expand Down
92 changes: 46 additions & 46 deletions src/Testcontainers/Builders/ContainerBuilder`3.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,38 +35,38 @@ protected ContainerBuilder(TConfigurationEntity dockerResourceConfiguration)
{
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity DependsOn(IContainer container)
{
var containers = new[] { container };
return Clone(new ContainerConfiguration(containers: containers));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity DependsOn(INetwork network)
{
return WithNetwork(network);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity DependsOn(IVolume volume, string destination)
{
return WithVolumeMount(volume, destination);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity DependsOn(IVolume volume, string destination, AccessMode accessMode)
{
return WithVolumeMount(volume, destination, accessMode);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithImage(string image)
{
return WithImage(new DockerImage(image));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithImage(IImage image)
{
if (string.IsNullOrEmpty(TestcontainersSettings.HubImageNamePrefix))
Expand All @@ -82,95 +82,95 @@ public TBuilderEntity WithImage(IImage image)
return Clone(new ContainerConfiguration(image: new DockerImage(image.Repository, image.Name, image.Tag, TestcontainersSettings.HubImageNamePrefix)));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithImagePullPolicy(Func<ImagesListResponse, bool> imagePullPolicy)
{
return Clone(new ContainerConfiguration(imagePullPolicy: imagePullPolicy));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithName(string name)
{
return Clone(new ContainerConfiguration(name: name));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithHostname(string hostname)
{
return Clone(new ContainerConfiguration(hostname: hostname));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithMacAddress(string macAddress)
{
return Clone(new ContainerConfiguration(macAddress: macAddress));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithWorkingDirectory(string workingDirectory)
{
return Clone(new ContainerConfiguration(workingDirectory: workingDirectory));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithEntrypoint(params string[] entrypoint)
{
return Clone(new ContainerConfiguration(entrypoint: entrypoint));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithCommand(params string[] command)
{
return Clone(new ContainerConfiguration(command: command));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithEnvironment(string name, string value)
{
var environments = new Dictionary<string, string> { { name, value } };
return Clone(new ContainerConfiguration(environments: environments));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithEnvironment(IReadOnlyDictionary<string, string> environments)
{
return Clone(new ContainerConfiguration(environments: environments));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithExposedPort(int port)
{
return WithExposedPort(port.ToString(CultureInfo.InvariantCulture));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithExposedPort(string port)
{
var exposedPorts = new Dictionary<string, string> { { port, port } };
return Clone(new ContainerConfiguration(exposedPorts: exposedPorts));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithPortBinding(int port, bool assignRandomHostPort = false)
{
return WithPortBinding(port.ToString(CultureInfo.InvariantCulture), assignRandomHostPort);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithPortBinding(int hostPort, int containerPort)
{
return WithPortBinding(hostPort.ToString(CultureInfo.InvariantCulture), containerPort.ToString(CultureInfo.InvariantCulture));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithPortBinding(string port, bool assignRandomHostPort = false)
{
// Use an empty string instead of "0": https://github.com/docker/for-mac/issues/5588#issuecomment-934600089.
var hostPort = assignRandomHostPort ? string.Empty : port;
return WithPortBinding(hostPort, port);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithPortBinding(string hostPort, string containerPort)
{
// Remove this together with TestcontainersSettings.ResourceReaperPublicHostPort.
Expand All @@ -180,157 +180,157 @@ public TBuilderEntity WithPortBinding(string hostPort, string containerPort)
return Clone(new ContainerConfiguration(portBindings: portBindings)).WithExposedPort(containerPort);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithResourceMapping(string source, string destination)
{
return WithResourceMapping(new FileResourceMapping(source, destination));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithResourceMapping(byte[] resourceContent, string destination)
{
return WithResourceMapping(new BinaryResourceMapping(resourceContent, destination));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithResourceMapping(IResourceMapping resourceMapping)
{
var resourceMappings = new Dictionary<string, IResourceMapping> { { resourceMapping.Target, resourceMapping } };
return Clone(new ContainerConfiguration(resourceMappings: resourceMappings));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithMount(IMount mount)
{
var mounts = new[] { mount };
return Clone(new ContainerConfiguration(mounts: mounts));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithBindMount(string source, string destination)
{
return WithBindMount(source, destination, AccessMode.ReadWrite);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithBindMount(string source, string destination, AccessMode accessMode)
{
return WithMount(new BindMount(source, destination, accessMode));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithVolumeMount(string source, string destination)
{
return WithVolumeMount(source, destination, AccessMode.ReadWrite);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithVolumeMount(string source, string destination, AccessMode accessMode)
{
var volume = new FromExistingVolume().WithName(source).Build();
return WithVolumeMount(volume, destination, accessMode);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithVolumeMount(IVolume volume, string destination)
{
return WithVolumeMount(volume, destination, AccessMode.ReadWrite);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithVolumeMount(IVolume volume, string destination, AccessMode accessMode)
{
return WithMount(new VolumeMount(volume, destination, accessMode));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithTmpfsMount(string destination)
{
return WithTmpfsMount(destination, AccessMode.ReadWrite);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithTmpfsMount(string destination, AccessMode accessMode)
{
return WithMount(new TmpfsMount(destination, accessMode));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithNetwork(string id, string name)
{
return WithNetwork(name);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithNetwork(string name)
{
var network = new FromExistingNetwork().WithName(name).Build();
return WithNetwork(network);
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithNetwork(INetwork network)
{
var networks = new[] { network };
return Clone(new ContainerConfiguration(networks: networks));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithNetworkAliases(params string[] networkAliases)
{
return WithNetworkAliases(networkAliases.AsEnumerable());
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithNetworkAliases(IEnumerable<string> networkAliases)
{
return Clone(new ContainerConfiguration(networkAliases: networkAliases));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithExtraHost(string hostname, string ipAddress)
{
var extraHosts = new[] { string.Join(":", hostname, ipAddress) };
return Clone(new ContainerConfiguration(extraHosts: extraHosts));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithAutoRemove(bool autoRemove)
{
return Clone(new ContainerConfiguration(autoRemove: autoRemove));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithPrivileged(bool privileged)
{
return Clone(new ContainerConfiguration(privileged: privileged));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithOutputConsumer(IOutputConsumer outputConsumer)
{
return Clone(new ContainerConfiguration(outputConsumer: outputConsumer));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithWaitStrategy(IWaitForContainerOS waitStrategy)
{
return Clone(new ContainerConfiguration(waitStrategies: waitStrategy.Build()));
}

/// <inheritdoc cref="IContainerBuilder{TBuilderEntity, TContainerEntity}" />
/// <inheritdoc />
public TBuilderEntity WithStartupCallback(Func<IContainer, CancellationToken, Task> startupCallback)
{
return Clone(new ContainerConfiguration(startupCallback: startupCallback));
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TResourceEntity, TCreateResourceEntity}" />
/// <inheritdoc />
protected override TBuilderEntity Init()
{
return base.Init().WithImagePullPolicy(PullPolicy.Missing).WithPortForwarding().WithOutputConsumer(Consume.DoNotConsumeStdoutAndStderr()).WithWaitStrategy(Wait.ForUnixContainer()).WithStartupCallback((_, ct) => Task.CompletedTask);
}

/// <inheritdoc cref="IAbstractBuilder{TBuilderEntity, TResourceEntity, TCreateResourceEntity}" />
/// <inheritdoc />
protected override void Validate()
{
base.Validate();
Expand Down

0 comments on commit 32d76af

Please sign in to comment.