From 42e91392655b9d60ef701aacaa9e01458794f57d Mon Sep 17 00:00:00 2001 From: Usman Saleem Date: Wed, 8 May 2024 14:39:10 +1000 Subject: [PATCH] build: Add default constructor and javadoc for metrics, nat, pki, plugins, services, testutil, util (#7071) Signed-off-by: Usman Saleem --- .../besu/metrics/MetricCategoryRegistryImpl.java | 3 +++ .../besu/metrics/MetricsConfigurationModule.java | 3 +++ .../org/hyperledger/besu/metrics/MetricsSystemModule.java | 2 ++ .../hyperledger/besu/metrics/noop/NoOpMetricsSystem.java | 3 +++ .../hyperledger/besu/metrics/noop/NoOpValueCollector.java | 3 +++ .../hyperledger/besu/metrics/rocksdb/RocksDBStats.java | 3 +++ .../org/hyperledger/besu/nat/docker/DockerDetector.java | 2 ++ .../hyperledger/besu/nat/docker/HostBasedIpDetector.java | 3 +++ .../besu/nat/kubernetes/KubernetesDetector.java | 3 +++ .../main/java/org/hyperledger/besu/pki/crl/CRLUtil.java | 2 ++ .../configuration/RocksDBConfigurationBuilder.java | 3 +++ .../besu/services/kvstore/InMemoryStoragePlugin.java | 3 +++ .../kvstore/SegmentedInMemoryKeyValueStorage.java | 3 +++ .../besu/kvstore/AbstractKeyValueStorageTest.java | 2 ++ .../hyperledger/besu/testutil/MockExecutorService.java | 8 ++++++++ .../hyperledger/besu/testutil/MockScheduledExecutor.java | 2 ++ .../org/hyperledger/enclave/testutil/EnclaveKeyUtils.java | 3 +++ .../enclave/testutil/TesseraTestHarnessFactory.java | 3 +++ 18 files changed, 54 insertions(+) diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricCategoryRegistryImpl.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricCategoryRegistryImpl.java index 14699e7ff..b0a31793b 100644 --- a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricCategoryRegistryImpl.java +++ b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricCategoryRegistryImpl.java @@ -25,6 +25,9 @@ public class MetricCategoryRegistryImpl implements MetricCategoryRegistry { private final List metricCategories = new ArrayList<>(); + /** Default constructor */ + public MetricCategoryRegistryImpl() {} + /** * Gets metric categories. * diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsConfigurationModule.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsConfigurationModule.java index 8a1974031..3559958ab 100644 --- a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsConfigurationModule.java +++ b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsConfigurationModule.java @@ -24,6 +24,9 @@ import dagger.Provides; /** Dagger module for providing the {@link MetricsConfiguration} instance. */ @Module public class MetricsConfigurationModule { + /** Default constructor */ + public MetricsConfigurationModule() {} + @Provides @Singleton MetricsConfiguration provideMetricsConfiguration() { diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemModule.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemModule.java index 95b861fea..044085ef4 100644 --- a/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemModule.java +++ b/metrics/core/src/main/java/org/hyperledger/besu/metrics/MetricsSystemModule.java @@ -28,6 +28,8 @@ import dagger.Provides; */ @Module public class MetricsSystemModule { + /** Default constructor */ + public MetricsSystemModule() {} @Provides @Singleton diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpMetricsSystem.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpMetricsSystem.java index adb91ed88..2b3db497b 100644 --- a/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpMetricsSystem.java +++ b/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpMetricsSystem.java @@ -73,6 +73,9 @@ public class NoOpMetricsSystem implements ObservableMetricsSystem { public static final LabelledGauge NO_OP_LABELLED_3_GAUGE = new LabelledGaugeNoOpMetric(3, NO_OP_GAUGE); + /** Default constructor */ + public NoOpMetricsSystem() {} + @Override public LabelledMetric createLabelledCounter( final MetricCategory category, diff --git a/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpValueCollector.java b/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpValueCollector.java index 42884a92f..144e7f318 100644 --- a/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpValueCollector.java +++ b/metrics/core/src/main/java/org/hyperledger/besu/metrics/noop/NoOpValueCollector.java @@ -24,6 +24,9 @@ import java.util.function.DoubleSupplier; public class NoOpValueCollector implements LabelledGauge { private final List labelValuesCreated = new ArrayList<>(); + /** Default constructor */ + public NoOpValueCollector() {} + @Override public synchronized void labels(final DoubleSupplier valueSupplier, final String... labelValues) { final String labelValuesString = String.join(",", labelValues); diff --git a/metrics/rocksdb/src/main/java/org/hyperledger/besu/metrics/rocksdb/RocksDBStats.java b/metrics/rocksdb/src/main/java/org/hyperledger/besu/metrics/rocksdb/RocksDBStats.java index e919364d4..edb837985 100644 --- a/metrics/rocksdb/src/main/java/org/hyperledger/besu/metrics/rocksdb/RocksDBStats.java +++ b/metrics/rocksdb/src/main/java/org/hyperledger/besu/metrics/rocksdb/RocksDBStats.java @@ -164,6 +164,9 @@ public class RocksDBStats { HistogramType.READ_NUM_MERGE_OPERANDS, }; + /** Default constructor */ + private RocksDBStats() {} + /** * Register rocks db metrics. * diff --git a/nat/src/main/java/org/hyperledger/besu/nat/docker/DockerDetector.java b/nat/src/main/java/org/hyperledger/besu/nat/docker/DockerDetector.java index 4ac665657..1188759f6 100644 --- a/nat/src/main/java/org/hyperledger/besu/nat/docker/DockerDetector.java +++ b/nat/src/main/java/org/hyperledger/besu/nat/docker/DockerDetector.java @@ -25,6 +25,8 @@ import java.util.stream.Stream; /** The Docker detector. */ public class DockerDetector implements NatMethodDetector { + /** Default constructor */ + public DockerDetector() {} @Override public Optional detect() { diff --git a/nat/src/main/java/org/hyperledger/besu/nat/docker/HostBasedIpDetector.java b/nat/src/main/java/org/hyperledger/besu/nat/docker/HostBasedIpDetector.java index 42b2019e2..c5a5b6c44 100644 --- a/nat/src/main/java/org/hyperledger/besu/nat/docker/HostBasedIpDetector.java +++ b/nat/src/main/java/org/hyperledger/besu/nat/docker/HostBasedIpDetector.java @@ -25,6 +25,9 @@ public class HostBasedIpDetector implements IpDetector { private static final String HOSTNAME = "HOST_IP"; + /** Default constructor */ + public HostBasedIpDetector() {} + @Override @SuppressWarnings("AddressSelection") public Optional detectAdvertisedIp() { diff --git a/nat/src/main/java/org/hyperledger/besu/nat/kubernetes/KubernetesDetector.java b/nat/src/main/java/org/hyperledger/besu/nat/kubernetes/KubernetesDetector.java index 755f52b9e..8165a0c3c 100644 --- a/nat/src/main/java/org/hyperledger/besu/nat/kubernetes/KubernetesDetector.java +++ b/nat/src/main/java/org/hyperledger/besu/nat/kubernetes/KubernetesDetector.java @@ -32,6 +32,9 @@ public class KubernetesDetector implements NatMethodDetector { Optional.ofNullable(System.getenv("KUBERNETES_SERVICE_HOST")); private static final Path KUBERNETES_WATERMARK_FILE = Paths.get("var/run/secrets/kubernetes.io"); + /** Default constructor */ + public KubernetesDetector() {} + @Override public Optional detect() { return KUBERNETES_SERVICE_HOST diff --git a/pki/src/main/java/org/hyperledger/besu/pki/crl/CRLUtil.java b/pki/src/main/java/org/hyperledger/besu/pki/crl/CRLUtil.java index a298736b4..17d3ecea7 100644 --- a/pki/src/main/java/org/hyperledger/besu/pki/crl/CRLUtil.java +++ b/pki/src/main/java/org/hyperledger/besu/pki/crl/CRLUtil.java @@ -27,6 +27,8 @@ import java.util.stream.Collectors; /** The CRL util. */ public class CRLUtil { + /** Default constructor */ + private CRLUtil() {} /** * Load CRLs cert store. diff --git a/plugins/rocksdb/src/main/java/org/hyperledger/besu/plugin/services/storage/rocksdb/configuration/RocksDBConfigurationBuilder.java b/plugins/rocksdb/src/main/java/org/hyperledger/besu/plugin/services/storage/rocksdb/configuration/RocksDBConfigurationBuilder.java index 4ca88a5e1..8e98b6cda 100644 --- a/plugins/rocksdb/src/main/java/org/hyperledger/besu/plugin/services/storage/rocksdb/configuration/RocksDBConfigurationBuilder.java +++ b/plugins/rocksdb/src/main/java/org/hyperledger/besu/plugin/services/storage/rocksdb/configuration/RocksDBConfigurationBuilder.java @@ -31,6 +31,9 @@ public class RocksDBConfigurationBuilder { private int backgroundThreadCount = DEFAULT_BACKGROUND_THREAD_COUNT; private boolean isHighSpec = DEFAULT_IS_HIGH_SPEC; + /** Instantiates a new Rocks db configuration builder. */ + public RocksDBConfigurationBuilder() {} + /** * Database dir. * diff --git a/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/InMemoryStoragePlugin.java b/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/InMemoryStoragePlugin.java index 648de893f..6783a82c1 100644 --- a/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/InMemoryStoragePlugin.java +++ b/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/InMemoryStoragePlugin.java @@ -40,6 +40,9 @@ public class InMemoryStoragePlugin implements BesuPlugin { private InMemoryKeyValueStorageFactory factory; private InMemoryKeyValueStorageFactory privacyFactory; + /** Default constructor */ + public InMemoryStoragePlugin() {} + @Override public void register(final BesuContext context) { LOG.debug("Registering plugin"); diff --git a/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/SegmentedInMemoryKeyValueStorage.java b/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/SegmentedInMemoryKeyValueStorage.java index e719dab56..beabb04d8 100644 --- a/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/SegmentedInMemoryKeyValueStorage.java +++ b/services/kvstore/src/main/java/org/hyperledger/besu/services/kvstore/SegmentedInMemoryKeyValueStorage.java @@ -290,6 +290,9 @@ public class SegmentedInMemoryKeyValueStorage /** protected access to deletedValues set for the transaction. */ protected Map> removedKeys = new HashMap<>(); + /** Default constructor */ + public SegmentedInMemoryTransaction() {} + @Override public void put( final SegmentIdentifier segmentIdentifier, final byte[] key, final byte[] value) { diff --git a/testutil/src/main/java/org/hyperledger/besu/kvstore/AbstractKeyValueStorageTest.java b/testutil/src/main/java/org/hyperledger/besu/kvstore/AbstractKeyValueStorageTest.java index 2e0d9195e..a2f68e177 100644 --- a/testutil/src/main/java/org/hyperledger/besu/kvstore/AbstractKeyValueStorageTest.java +++ b/testutil/src/main/java/org/hyperledger/besu/kvstore/AbstractKeyValueStorageTest.java @@ -40,6 +40,8 @@ import org.junit.jupiter.api.Test; /** The Abstract key value storage test. */ @Disabled public abstract class AbstractKeyValueStorageTest { + /** Default Constructor */ + protected AbstractKeyValueStorageTest() {} /** * Create store key value storage. diff --git a/testutil/src/main/java/org/hyperledger/besu/testutil/MockExecutorService.java b/testutil/src/main/java/org/hyperledger/besu/testutil/MockExecutorService.java index a84d9b578..0dc93a69f 100644 --- a/testutil/src/main/java/org/hyperledger/besu/testutil/MockExecutorService.java +++ b/testutil/src/main/java/org/hyperledger/besu/testutil/MockExecutorService.java @@ -36,6 +36,14 @@ public class MockExecutorService implements ExecutorService { private final List> tasks = new ArrayList<>(); + /** Default constructor */ + public MockExecutorService() {} + + /** + * Gets tasks. + * + * @return the tasks + */ /** * Gets futures. * diff --git a/testutil/src/main/java/org/hyperledger/besu/testutil/MockScheduledExecutor.java b/testutil/src/main/java/org/hyperledger/besu/testutil/MockScheduledExecutor.java index fbcb5f1a0..14f62b740 100644 --- a/testutil/src/main/java/org/hyperledger/besu/testutil/MockScheduledExecutor.java +++ b/testutil/src/main/java/org/hyperledger/besu/testutil/MockScheduledExecutor.java @@ -25,6 +25,8 @@ import java.util.concurrent.TimeoutException; /** The mock scheduled executor */ public class MockScheduledExecutor extends MockExecutorService implements ScheduledExecutorService { + /** Default constructor */ + public MockScheduledExecutor() {} @Override public ScheduledFuture schedule( diff --git a/testutil/src/main/java/org/hyperledger/enclave/testutil/EnclaveKeyUtils.java b/testutil/src/main/java/org/hyperledger/enclave/testutil/EnclaveKeyUtils.java index 39b75abba..acefd47d6 100644 --- a/testutil/src/main/java/org/hyperledger/enclave/testutil/EnclaveKeyUtils.java +++ b/testutil/src/main/java/org/hyperledger/enclave/testutil/EnclaveKeyUtils.java @@ -34,6 +34,9 @@ import org.slf4j.LoggerFactory; public class EnclaveKeyUtils { private static final Logger LOG = LoggerFactory.getLogger(EnclaveKeyUtils.class); + /** Default constructor */ + private EnclaveKeyUtils() {} + /** * Utility method to load the enclave public key. Possible input values are the names of the *.pub * files in the resources folder. diff --git a/testutil/src/main/java/org/hyperledger/enclave/testutil/TesseraTestHarnessFactory.java b/testutil/src/main/java/org/hyperledger/enclave/testutil/TesseraTestHarnessFactory.java index cf02a1602..0cfe8b76c 100644 --- a/testutil/src/main/java/org/hyperledger/enclave/testutil/TesseraTestHarnessFactory.java +++ b/testutil/src/main/java/org/hyperledger/enclave/testutil/TesseraTestHarnessFactory.java @@ -30,6 +30,9 @@ import org.testcontainers.containers.Network; public class TesseraTestHarnessFactory { private static final String storage = "memory"; + /** Default constructor */ + private TesseraTestHarnessFactory() {} + /** * Create tessera test harness. *