org.tbk.spring.testcontainer.bitcoind.config.BitcoindContainerAutoConfiguration Maven / Gradle / Ivy
Show all versions of spring-testcontainer-bitcoind-starter Show documentation
package org.tbk.spring.testcontainer.bitcoind.config;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import lombok.Builder;
import lombok.NonNull;
import lombok.Value;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.tbk.spring.testcontainer.bitcoind.BitcoindContainer;
import org.tbk.spring.testcontainer.bitcoind.config.BitcoindContainerProperties.Chain;
import org.tbk.spring.testcontainer.core.CustomHostPortWaitStrategy;
import org.tbk.spring.testcontainer.core.MoreTestcontainers;
import org.testcontainers.utility.DockerImageName;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import static com.google.common.base.Preconditions.checkState;
import static java.util.Objects.requireNonNull;
@Slf4j
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(BitcoindContainerProperties.class)
@ConditionalOnProperty(value = "org.tbk.spring.testcontainer.bitcoind.enabled", havingValue = "true")
public class BitcoindContainerAutoConfiguration {
// currently only the image from "polarlightning" is supported
private static final String DEFAULT_DOCKER_IMAGE_NAME = "polarlightning/bitcoind:25.0";
private static final DockerImageName defaultDockerImageName = DockerImageName.parse(DEFAULT_DOCKER_IMAGE_NAME);
private final BitcoindContainerProperties properties;
public BitcoindContainerAutoConfiguration(BitcoindContainerProperties properties) {
this.properties = requireNonNull(properties);
}
/**
* Creates a bitcoin container from the properties given.
*
* NOTE: Currently only really supports creating "regtest" container.
* Defaults do not play nicely with mainnet/testnet -> "networkactive" is disabled.
*
*
Mainnet
* JSON-RPC/REST: 8332
* P2P: 8333
*
*
Testnet
* Testnet JSON-RPC: 18332
* P2P: 18333
*
*
Regtest
* JSON-RPC/REST: 18443 (since 0.16+, otherwise 18332)
* P2P: 18444
*
*
Signet
* JSON-RPC/REST: 38332
* P2P: 38333
*/
@Bean(name = "bitcoindContainer", destroyMethod = "stop")
BitcoindContainer bitcoindContainer() {
List commands = buildCommandList();
// TODO: expose ports specified via auto configuration properties
List hardcodedStandardPorts = ImmutableList.builder()
.addAll(this.properties.getChain() == Chain.mainnet ? Lists.newArrayList(8332, 8333) : Collections.emptyList())
.addAll(this.properties.getChain() == Chain.testnet ? Lists.newArrayList(18332, 18333) : Collections.emptyList())
.addAll(this.properties.getChain() == Chain.regtest ? Lists.newArrayList(18443, 18444) : Collections.emptyList())
.build();
List exposedPorts = ImmutableList.builder()
.addAll(hardcodedStandardPorts)
.addAll(this.properties.getExposedPorts())
.build();
// only wait for rpc ports - p2p ports might be disabled (networkactive=0); zeromq ports won't work (we can live with that for now)
CustomHostPortWaitStrategy waitStrategy = CustomHostPortWaitStrategy.builder()
.ports(ImmutableList.builder()
.addAll(this.properties.getChain() == Chain.mainnet ? Lists.newArrayList(8332) : Collections.emptyList())
.addAll(this.properties.getChain() == Chain.testnet ? Lists.newArrayList(18332) : Collections.emptyList())
.addAll(this.properties.getChain() == Chain.regtest ? Lists.newArrayList(18443) : Collections.emptyList())
.build())
.build();
DockerImageName dockerImageName = this.properties.getImage()
.map(DockerImageName::parse)
.orElse(defaultDockerImageName);
String dockerContainerName = String.format("%s-%s", dockerImageName.getUnversionedPart(),
Integer.toHexString(System.identityHashCode(this)))
.replace("/", "-");
BitcoindContainer bitcoindContainer = new BitcoindContainer<>(dockerImageName)
.withCreateContainerCmdModifier(MoreTestcontainers.cmdModifiers().withName(dockerContainerName))
.withExposedPorts(exposedPorts.toArray(new Integer[]{}))
.withCommand(commands.toArray(new String[]{}))
.waitingFor(waitStrategy);
bitcoindContainer.start();
checkState(bitcoindContainer.isRunning(), "'bitcoindContainer' must be running");
// expose all mapped ports of the host so other containers can communication with bitcoind.
// e.g. lnd needs access to rpc and zeromq ports.
MoreTestcontainers.exposeAllPortsToOtherContainers(bitcoindContainer);
return bitcoindContainer;
}
private List buildCommandList() {
ImmutableList.Builder requiredCommandsBuilder = ImmutableList.builder();
Optional.of(this.properties.getChain())
.filter(it -> it != Chain.mainnet)
.map(Enum::name)
.map(String::toLowerCase)
.map(it -> "-chain=" + it)
.ifPresent(requiredCommandsBuilder::add);
List overridingDefaults = ImmutableList.builder()
// dns: Allow DNS lookups for -addnode, -seednode and -connect values.
.add("-dns=" + this.properties.getCommandValueByKey("dns").orElse("0"))
// dnsseed: Query for peer addresses via DNS lookup, if low on addresses.
.add("-dnsseed=" + this.properties.getCommandValueByKey("dnsseed").orElse("0"))
// upnp: Use UPnP to map the listening port.
.add("-upnp=" + this.properties.getCommandValueByKey("upnp").orElse("0"))
// networkactive: enable all P2P network activity.
.add("-networkactive=" + this.properties.getCommandValueByKey("networkactive").orElse("0"))
.add("-txindex=" + this.properties.getCommandValueByKey("txindex").orElse("1"))
.add("-server=" + this.properties.getCommandValueByKey("server").orElse("1"))
.add("-rpcbind=" + this.properties.getCommandValueByKey("rpcbind").orElse("0.0.0.0"))
.add("-rpcallowip=" + this.properties.getCommandValueByKey("rpcallowip").orElse("0.0.0.0/0"))
.build();
ImmutableList.Builder optionalCommandsBuilder = ImmutableList.builder();
this.properties.getRpcuser()
.map(val -> String.format("-rpcuser=%s", val))
.ifPresent(optionalCommandsBuilder::add);
this.properties.getRpcpassword()
.map(val -> String.format("-rpcpassword=%s", val))
.ifPresent(optionalCommandsBuilder::add);
ImmutableList.Builder commandsBuilder = ImmutableList.builder()
.addAll(requiredCommandsBuilder.build())
.addAll(overridingDefaults)
.addAll(optionalCommandsBuilder.build());
List predefinedKeys = commandsBuilder.build().stream()
.map(BitcoindConfigEntry::valueOf)
.flatMap(Optional::stream)
.map(BitcoindConfigEntry::getName)
.toList();
List userGivenCommands = this.properties.getCommands();
List allowedUserGivenCommands = userGivenCommands.stream()
.map(BitcoindConfigEntry::valueOf)
.flatMap(Optional::stream)
.filter(it -> !predefinedKeys.contains(it.getName()))
.map(BitcoindConfigEntry::toCommandString)
.toList();
return commandsBuilder
.addAll(allowedUserGivenCommands)
.build();
}
@Value
@Builder
public static class BitcoindConfigEntry {
public static Optional valueOf(String command) {
String commandPrefix = "-";
return Optional.ofNullable(command)
.filter(it -> it.startsWith(commandPrefix))
.map(it -> it.split(commandPrefix, 2)[1])
.map(it -> {
boolean withoutValue = !it.contains("=");
if (withoutValue) {
return BitcoindConfigEntry.builder()
.name(it)
.build();
}
String[] parts = it.split("=", 2);
return BitcoindConfigEntry.builder()
.name(parts[0])
.value(parts[1])
.build();
});
}
@NonNull
String name;
String value;
public Optional getValue() {
return Optional.ofNullable(value);
}
public String toCommandString() {
return "-" + this.name + getValue()
.map(it -> "=" + it)
.orElse("");
}
}
}