refactor: move regtest miner test classes from module 'testcontainer' to 'bitcoin-regtest'

Author: theborakompanioni

examples/incubator/bitcoin-electrum-gateway-example-application/build.gradle

@@ -3,14 +3,12 @@ apply plugin: 'org.springframework.boot'
 description = 'electrum gateway example application package'
 
 dependencies {
-    implementation project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
+    implementation project(':incubator:bitcoin-regtest:bitcoin-regtest-starter')
+
     implementation project(':spring-testcontainer:spring-testcontainer-electrumx-starter')
     implementation project(':spring-testcontainer:spring-testcontainer-electrum-daemon-starter')
     implementation project(':incubator:tbk-electrum-daemon-client:tbk-electrum-daemon-client-starter')
 
-    implementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
-    implementation project(':bitcoin-zeromq-client:bitcoin-zeromq-client-starter')
-
     implementation "io.projectreactor:reactor-core"
 
     implementation 'org.springframework.boot:spring-boot-starter-web'

examples/incubator/bitcoin-electrum-gateway-example-application/src/main/resources/application.yml

@@ -77,15 +77,17 @@ org.tbk.spring.testcontainer.bitcoind:
     # Send trace/debug info to console instead of debug.log.
     - '-printtoconsole=1'
 
-# mine blocks every 1 - 10 seconds
-org.tbk.spring.testcontainer.bitcoind-regtest-miner:
+org.tbk.bitcoin.regtest:
   enabled: true
-  # secret to address: truth fever mom transfer steak immense lake jacket glide bring fancy electric
-  coinbase-reward-address: bcrt1q0xtrupsjmqr7u7xz4meufd3a8pt6v553m8nmvz
-  mine-initial-amount-of-blocks: 100
-  next-block-duration:
-    min-duration-in-millis: 1000
-    max-duration-in-millis: 10000
+  # mine blocks every 1 - 10 seconds
+  miner:
+    enabled: true
+    # secret to address: truth fever mom transfer steak immense lake jacket glide bring fancy electric
+    coinbase-reward-address: bcrt1q0xtrupsjmqr7u7xz4meufd3a8pt6v553m8nmvz
+    mine-initial-amount-of-blocks: 100
+    next-block-duration:
+      min-duration-in-millis: 1000
+      max-duration-in-millis: 10000
 
 org.tbk.bitcoin.jsonrpc:
   network: regtest

examples/lnd-playground-example-application/build.gradle

@@ -3,14 +3,11 @@ apply plugin: 'org.springframework.boot'
 description = 'lnd testcontainer example application package'
 
 dependencies {
-    implementation project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
-    implementation project(':spring-testcontainer:spring-testcontainer-lnd-starter')
+    implementation project(':incubator:bitcoin-regtest:bitcoin-regtest-starter')
 
+    implementation project(':spring-testcontainer:spring-testcontainer-lnd-starter')
     implementation project(':lnd-grpc-client:lnd-grpc-client-starter')
 
-    implementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
-    implementation project(':bitcoin-zeromq-client:bitcoin-zeromq-client-starter')
-
     implementation "io.projectreactor:reactor-core"
 
     implementation 'org.springframework.boot:spring-boot-starter-web'

examples/lnd-playground-example-application/src/main/resources/application.yml

@@ -73,12 +73,14 @@ org.tbk.spring.testcontainer.bitcoind:
     # Send trace/debug info to console instead of debug.log.
     - '-printtoconsole=1'
 
-# mine blocks every 1 - 10 seconds
-org.tbk.spring.testcontainer.bitcoind-regtest-miner:
+org.tbk.bitcoin.regtest:
   enabled: true
-  next-block-duration:
-    min-duration-in-millis: 1000
-    max-duration-in-millis: 10000
+  # mine blocks every 1 - 10 seconds
+  miner:
+    enabled: true
+    next-block-duration:
+      min-duration-in-millis: 1000
+      max-duration-in-millis: 10000
 
 org.tbk.bitcoin.jsonrpc:
   network: regtest

incubator/bitcoin-mqtt/bitcoin-mqtt-server-example-application/build.gradle

@@ -5,8 +5,7 @@ description = 'bitcoin mqtt server example application package'
 dependencies {
     implementation project(':incubator:bitcoin-mqtt:bitcoin-mqtt-server-starter')
 
-    implementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
-    implementation project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
+    implementation project(':incubator:bitcoin-regtest:bitcoin-regtest-starter')
 
     implementation 'org.flywaydb:flyway-core'
     implementation "org.xerial:sqlite-jdbc:${sqliteVersion}"

incubator/bitcoin-mqtt/bitcoin-mqtt-server-example-application/src/main/resources/application.yml

@@ -39,14 +39,16 @@ org.tbk.spring.testcontainer.bitcoind:
     # Enable publishing of transaction hashes to <address>.
     - '-zmqpubhashtx=tcp://0.0.0.0:28335'
 
-# mine blocks every 1 - 10 seconds
-org.tbk.spring.testcontainer.bitcoind-regtest-miner:
+org.tbk.bitcoin.regtest:
   enabled: true
-  # secret to address: across distance search gym explain fruit sense tiny decrease ribbon day course
-  coinbase-reward-address: bcrt1q0lhr8js5rrhjl7hf6e80ns3pgk5tjswgg9um9t
-  next-block-duration:
-    min-duration-in-millis: 1000
-    max-duration-in-millis: 10000
+  # mine blocks every 1 - 10 seconds
+  miner:
+    enabled: true
+    # secret to address: across distance search gym explain fruit sense tiny decrease ribbon day course
+    coinbase-reward-address: bcrt1q0lhr8js5rrhjl7hf6e80ns3pgk5tjswgg9um9t
+    next-block-duration:
+      min-duration-in-millis: 1000
+      max-duration-in-millis: 10000
 
 org.tbk.bitcoin.jsonrpc:
   network: regtest
@@ -74,4 +76,4 @@ org.tbk.mqtt.moquette.broker:
     'authenticator.db.digest': SHA-256
 
 org.tbk.bitcoin.tool.mqtt.server:
-  enabled: true
+  enabled: true

incubator/bitcoin-mqtt/bitcoin-mqtt-server-starter/build.gradle

@@ -13,8 +13,7 @@ dependencies {
 
     implementation 'org.springframework.boot:spring-boot-starter'
 
-    integTestImplementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
-    integTestImplementation project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
+    integTestImplementation project(':incubator:bitcoin-regtest:bitcoin-regtest-starter')
 
     integTestImplementation 'org.springframework.integration:spring-integration-mqtt'
 }

incubator/bitcoin-mqtt/bitcoin-mqtt-server-starter/src/integTest/java/org/tbk/bitcoin/tool/mqtt/BitcoinMqttServerStarterTest.java

@@ -19,8 +19,8 @@
 import org.springframework.messaging.MessageHandler;
 import org.springframework.messaging.MessagingException;
 import org.springframework.test.context.ActiveProfiles;
+import org.tbk.bitcoin.regtest.BitcoindRegtestMiner;
 import org.tbk.bitcoin.tool.mqtt.config.BitcoinMqttServerAutoConfigProperties;
-import org.tbk.spring.testcontainer.bitcoind.regtest.BitcoindRegtestMiner;
 import reactor.core.publisher.Flux;
 
 import java.time.Duration;

incubator/bitcoin-mqtt/bitcoin-mqtt-server-starter/src/integTest/resources/application-test.yml

@@ -18,12 +18,13 @@ org.tbk.spring.testcontainer.bitcoind:
     # Enable publishing of transaction hashes to <address>.
     - '-zmqpubhashtx=tcp://0.0.0.0:28335'
 
-# mine blocks every 1 - 10 seconds
-org.tbk.spring.testcontainer.bitcoind-regtest-miner:
+org.tbk.bitcoin.regtest:
   enabled: true
-  # secret to address: across distance search gym explain fruit sense tiny decrease ribbon day course
-  coinbase-reward-address: bcrt1q0lhr8js5rrhjl7hf6e80ns3pgk5tjswgg9um9t
-  scheduled-mining-enabled: false
+  miner:
+    enabled: true
+    # secret to address: across distance search gym explain fruit sense tiny decrease ribbon day course
+    coinbase-reward-address: bcrt1q0lhr8js5rrhjl7hf6e80ns3pgk5tjswgg9um9t
+    scheduled-mining-enabled: false
 
 org.tbk.bitcoin.jsonrpc:
   network: regtest

incubator/bitcoin-regtest/bitcoin-regtest-autoconfigure/build.gradle

@@ -5,7 +5,7 @@ plugins {
 description = 'bitcoin regtest autoconfigure package'
 
 dependencies {
-    compileOnly project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-core')
+    compileOnly project(':incubator:bitcoin-regtest:bitcoin-regtest-core')
 
     implementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-autoconfigure')
 

incubator/bitcoin-regtest/bitcoin-regtest-autoconfigure/src/main/java/org/tbk/bitcoin/regtest/config/BitcoinRegtestAutoConfigProperties.java

@@ -17,6 +17,8 @@ public class BitcoinRegtestAutoConfigProperties implements Validator {
      */
     private boolean enabled;
 
+    private BitcoindRegtestMinerProperties miner;
+
     @Override
     public boolean supports(Class<?> clazz) {
         return clazz == BitcoinRegtestAutoConfigProperties.class;

spring-testcontainer/spring-testcontainer-bitcoind-starter/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/BitcoindRegtestMinerAutoConfiguration.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-autoconfigure/src/main/java/org/tbk/bitcoin/regtest/config/BitcoindRegtestMinerAutoConfiguration.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest.config;
 
 import com.google.common.base.Stopwatch;
 import com.google.common.util.concurrent.AbstractScheduledService;
@@ -11,12 +11,14 @@
 import org.bitcoinj.core.Sha256Hash;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 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.bitcoin.regtest.*;
 
 import java.time.Duration;
 import java.util.List;
@@ -27,20 +29,21 @@
 
 @Slf4j
 @Configuration(proxyBeanMethods = false)
-@EnableConfigurationProperties(BitcoindRegtestMinerProperties.class)
-@ConditionalOnProperty(value = "org.tbk.spring.testcontainer.bitcoind-regtest-miner.enabled", havingValue = "true")
+@ConditionalOnClass(BitcoindRegtestMiner.class)
+@ConditionalOnProperty(value = "org.tbk.bitcoin.regtest.miner.enabled", havingValue = "true")
+@AutoConfigureAfter(BitcoinRegtestAutoConfiguration.class)
 public class BitcoindRegtestMinerAutoConfiguration {
 
     private final BitcoindRegtestMinerProperties properties;
 
-    public BitcoindRegtestMinerAutoConfiguration(BitcoindRegtestMinerProperties properties) {
-        this.properties = requireNonNull(properties);
+    public BitcoindRegtestMinerAutoConfiguration(BitcoinRegtestAutoConfigProperties properties) {
+        this.properties = requireNonNull(properties.getMiner());
     }
 
     @Bean
     @ConditionalOnBean({BitcoinClient.class})
-    @ConditionalOnMissingBean(CoinbaseRewardAddressSupplier.class)
-    @ConditionalOnProperty(value = "org.tbk.spring.testcontainer.bitcoind-regtest-miner.coinbase-reward-address")
+    @ConditionalOnMissingBean
+    @ConditionalOnProperty(value = "org.tbk.bitcoin.regtest.miner.coinbase-reward-address")
     public CoinbaseRewardAddressSupplier staticCoinbaseRewardAddressSupplier(BitcoinClient bitcoinJsonRpcClient) {
         return this.properties.getCoinbaseRewardAddress()
                 .map(it -> Address.fromString(bitcoinJsonRpcClient.getNetParams(), it))
@@ -50,14 +53,14 @@ public CoinbaseRewardAddressSupplier staticCoinbaseRewardAddressSupplier(Bitcoin
 
     @Bean
     @ConditionalOnBean({BitcoinClient.class})
-    @ConditionalOnMissingBean(CoinbaseRewardAddressSupplier.class)
+    @ConditionalOnMissingBean
     public CoinbaseRewardAddressSupplier bitcoinClientCoinbaseRewardAddressSupplier(BitcoinClient bitcoinJsonRpcClient) {
         return new BitcoinClientCoinbaseRewardAddressSupplier(bitcoinJsonRpcClient);
     }
 
     @Bean
     @ConditionalOnBean({BitcoinClient.class})
-    @ConditionalOnMissingBean(BitcoindRegtestMiner.class)
+    @ConditionalOnMissingBean
     public BitcoindRegtestMiner bitcoindRegtestMiner(BitcoinClient bitcoinJsonRpcClient,
                                                      CoinbaseRewardAddressSupplier coinbaseRewardAddressSupplier) {
         return new BitcoindRegtestMinerImpl(bitcoinJsonRpcClient, coinbaseRewardAddressSupplier);
@@ -83,7 +86,7 @@ public MinMaxDurationScheduler bitcoindRegtestMinerScheduler() {
             MinMaxDurationScheduler.class
     })
     @ConditionalOnMissingBean(ScheduledBitcoindRegtestMiner.class)
-    @ConditionalOnProperty(value = "org.tbk.spring.testcontainer.bitcoind-regtest-miner.scheduled-mining-enabled", havingValue = "true", matchIfMissing = true)
+    @ConditionalOnProperty(value = "org.tbk.bitcoin.regtest.miner.scheduled-mining-enabled", havingValue = "true", matchIfMissing = true)
     public ScheduledBitcoindRegtestMiner scheduledBitcoindRegtestMiner(BitcoindRegtestMiner bitcoindRegtestMiner,
                                                                        @Qualifier("bitcoindRegtestMinerScheduler") Scheduler scheduler) {
         ScheduledBitcoindRegtestMiner scheduledBitcoindRegtestMiner = new ScheduledBitcoindRegtestMiner(bitcoindRegtestMiner, scheduler);
@@ -131,7 +134,7 @@ public MinMaxDurationScheduler(@NonNull Duration minDuration, @NonNull Duration
         }
 
         @Override
-        protected Schedule getNextSchedule() throws Exception {
+        protected Schedule getNextSchedule() {
             long minMillis = minDuration.toMillis();
             long maxMillis = maxDuration.toMillis();
 

spring-testcontainer/spring-testcontainer-bitcoind-starter/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/BitcoindRegtestMinerProperties.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-autoconfigure/src/main/java/org/tbk/bitcoin/regtest/config/BitcoindRegtestMinerProperties.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest.config;
 
 import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;
@@ -9,18 +9,14 @@
 import java.util.Optional;
 
 @Data
-@ConfigurationProperties(
-        prefix = "org.tbk.spring.testcontainer.bitcoind-regtest-miner",
-        ignoreUnknownFields = false
-)
 public class BitcoindRegtestMinerProperties implements Validator {
     private static final NextBlockDurationProperties DEFAULT_NEXT_BLOCK_DURATION = new NextBlockDurationProperties() {{
         setMinDurationInMillis(1_000L);
         setMaxDurationInMillis(10_000L);
     }};
 
     /**
-     * Whether the client should be enabled
+     * Whether the miner should be enabled
      */
     private boolean enabled;
 

incubator/bitcoin-regtest/bitcoin-regtest-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,2 +1,3 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-org.tbk.bitcoin.regtest.config.BitcoinRegtestAutoConfiguration
+org.tbk.bitcoin.regtest.config.BitcoinRegtestAutoConfiguration,\
+org.tbk.bitcoin.regtest.config.BitcoindRegtestMinerAutoConfiguration

incubator/bitcoin-regtest/bitcoin-regtest-core/build.gradle

@@ -0,0 +1,14 @@
+plugins {
+    id 'java'
+}
+
+description = 'bitcoin regtest core package'
+
+dependencies {
+    api project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-core')
+
+    testImplementation project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
+    integTestImplementation project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
+
+    testImplementation "io.projectreactor:reactor-core"
+}

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/integTest/java/org/tbk/spring/testcontainer/bitcoind/regtest/ScheduledBitcoindRegtestMinerTest.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/integTest/java/org/tbk/bitcoin/regtest/ScheduledBitcoindRegtestMinerTest.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import com.google.common.util.concurrent.AbstractScheduledService;
 import com.msgilligan.bitcoinj.json.pojo.BlockChainInfo;

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/integTest/resources/application-test.yml renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/integTest/resources/application-test.yml

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import com.msgilligan.bitcoinj.rpc.BitcoinClient;
 import org.bitcoinj.core.Address;

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/BitcoinClientCoinbaseRewardAddressSupplier.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/BitcoinClientCoinbaseRewardAddressSupplier.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import org.bitcoinj.core.Sha256Hash;
 

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/BitcoindRegtestMiner.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/BitcoindRegtestMiner.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import com.google.common.collect.Lists;
 import com.msgilligan.bitcoinj.rpc.BitcoinClient;

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/BitcoindRegtestMinerImpl.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/BitcoindRegtestMinerImpl.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import org.bitcoinj.core.Address;
 

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/CoinbaseRewardAddressSupplier.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/CoinbaseRewardAddressSupplier.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import com.google.common.util.concurrent.AbstractScheduledService;
 import lombok.extern.slf4j.Slf4j;

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/ScheduledBitcoindRegtestMiner.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/ScheduledBitcoindRegtestMiner.java

@@ -1,4 +1,4 @@
-package org.tbk.spring.testcontainer.bitcoind.regtest;
+package org.tbk.bitcoin.regtest;
 
 import org.bitcoinj.core.Address;
 

spring-testcontainer/spring-testcontainer-bitcoind-helper/src/main/java/org/tbk/spring/testcontainer/bitcoind/regtest/StaticCoinbaseRewardAddressSupplier.java renamed to incubator/bitcoin-regtest/bitcoin-regtest-core/src/main/java/org/tbk/bitcoin/regtest/StaticCoinbaseRewardAddressSupplier.java

@@ -5,15 +5,19 @@ plugins {
 description = 'bitcoin regtest starter package'
 
 dependencies {
+    api project(':incubator:bitcoin-regtest:bitcoin-regtest-core')
     api project(':incubator:bitcoin-regtest:bitcoin-regtest-autoconfigure')
 
+    api project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
     api project(':bitcoin-jsonrpc-client:bitcoin-jsonrpc-client-starter')
     api project(':bitcoin-zeromq-client:bitcoin-zeromq-client-starter')
 
-    api project(':lnd-grpc-client:lnd-grpc-client-starter')
+    // api project(':spring-testcontainer:spring-testcontainer-lnd-starter')
+    // api project(':lnd-grpc-client:lnd-grpc-client-starter')
 
-    api project(':spring-testcontainer:spring-testcontainer-bitcoind-starter')
-    api project(':spring-testcontainer:spring-testcontainer-lnd-starter')
+    // api project(':spring-testcontainer:spring-testcontainer-electrumx-starter')
+    // api project(':spring-testcontainer:spring-testcontainer-electrum-daemon-starter')
+    // api project(':incubator:tbk-electrum-daemon-client:tbk-electrum-daemon-client-starter')
 
     implementation 'org.springframework.boot:spring-boot-starter'
 }

incubator/bitcoin-regtest/bitcoin-regtest-starter/build.gradle

@@ -10,6 +10,7 @@ dependencies {
     implementation "org.apache.httpcomponents:httpcore:${httpComponentsVersion}"
     implementation "org.apache.httpcomponents:httpclient:${httpComponentsClientVersion}"
 
+    integTestImplementation project(':incubator:bitcoin-regtest:bitcoin-regtest-starter')
     integTestImplementation project(':spring-testcontainer:spring-testcontainer-test')
     integTestImplementation project(':spring-testcontainer:spring-testcontainer-electrumx-starter')
     integTestImplementation project(':spring-testcontainer:spring-testcontainer-electrum-daemon-starter')