services - migrate to junit 5 (#5613)

* services to junit5

* removed some junit4 engine imports

* updated some plugins test since these extend from testutil KV storage

* one more form of EPL v2

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

---------

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>

enclave/build.gradle

@@ -17,8 +17,6 @@ dependencies {
   testImplementation 'org.assertj:assertj-core'
   testImplementation 'org.junit.jupiter:junit-jupiter'
 
-  testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
-
   // integration test dependencies.
   integrationTestImplementation project(':testutil')
   integrationTestImplementation 'org.assertj:assertj-core'
@@ -27,6 +25,4 @@ dependencies {
   integrationTestImplementation 'org.junit.jupiter:junit-jupiter-api'
   integrationTestImplementation 'org.mockito:mockito-core'
   integrationTestImplementation 'org.testcontainers:testcontainers'
-
-  integrationTestRuntimeOnly 'org.junit.jupiter:junit-jupiter'
 }

gradle/check-licenses.gradle

@@ -126,7 +126,8 @@ downloadLicenses {
     ],
     (epl2) : [
       'Eclipse Public License - v 2.0',
-      'Eclipse Public License version 2.0'
+      'Eclipse Public License version 2.0',
+      'Eclipse Public License v2.0'
     ],
     (mit) : [
       'MIT',

metrics/core/build.gradle

@@ -70,8 +70,6 @@ dependencies {
   testImplementation 'org.mockito:mockito-core'
   testImplementation 'org.mockito:mockito-junit-jupiter'
 
-  testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
-
   testSupportImplementation 'org.mockito:mockito-core'
 
   annotationProcessor 'com.google.dagger:dagger-compiler'

plugins/rocksdb/build.gradle

@@ -55,6 +55,7 @@ dependencies {
   testImplementation 'org.assertj:assertj-core'
   testImplementation 'org.junit.jupiter:junit-jupiter'
   testImplementation 'org.mockito:mockito-core'
+  testImplementation 'org.mockito:mockito-junit-jupiter'
 
   testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
 }

plugins/rocksdb/src/test/java/org/hyperledger/besu/plugin/services/storage/rocksdb/segmented/OptimisticTransactionDBRocksDBColumnarKeyValueStorageTest.java

@@ -25,14 +25,18 @@
 import java.util.Arrays;
 import java.util.List;
 
+import org.apache.tuweni.bytes.Bytes;
+
 public class OptimisticTransactionDBRocksDBColumnarKeyValueStorageTest
     extends RocksDBColumnarKeyValueStorageTest {
 
   @Override
   protected SegmentedKeyValueStorage<RocksDbSegmentIdentifier> createSegmentedStore()
       throws Exception {
     return new OptimisticRocksDBColumnarKeyValueStorage(
-        new RocksDBConfigurationBuilder().databaseDir(folder.newFolder().toPath()).build(),
+        new RocksDBConfigurationBuilder()
+            .databaseDir(folder.resolve(Bytes.random(9).toString()))
+            .build(),
         Arrays.asList(TestSegment.FOO, TestSegment.BAR),
         List.of(),
         new NoOpMetricsSystem(),

plugins/rocksdb/src/test/java/org/hyperledger/besu/plugin/services/storage/rocksdb/segmented/RocksDBColumnarKeyValueStorageTest.java

@@ -35,13 +35,12 @@
 import java.util.function.Consumer;
 
 import org.apache.commons.lang3.tuple.Pair;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.TemporaryFolder;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
 
 public abstract class RocksDBColumnarKeyValueStorageTest extends AbstractKeyValueStorageTest {
 
-  @Rule public final TemporaryFolder folder = new TemporaryFolder();
+  @TempDir public Path folder;
 
   @Test
   public void assertClear() throws Exception {
@@ -178,8 +177,8 @@ public void canGetThroughSegmentIteration() throws Exception {
   }
 
   @Test
-  public void dbShouldIgnoreExperimentalSegmentsIfNotExisted() throws Exception {
-    final Path testPath = folder.newFolder().toPath();
+  public void dbShouldIgnoreExperimentalSegmentsIfNotExisted(@TempDir final Path testPath)
+      throws Exception {
     // Create new db should ignore experimental column family
     SegmentedKeyValueStorage<RocksDbSegmentIdentifier> store =
         createSegmentedStore(
@@ -195,8 +194,8 @@ public void dbShouldIgnoreExperimentalSegmentsIfNotExisted() throws Exception {
   }
 
   @Test
-  public void dbShouldNotIgnoreExperimentalSegmentsIfExisted() throws Exception {
-    final Path testPath = folder.newFolder().toPath();
+  public void dbShouldNotIgnoreExperimentalSegmentsIfExisted(@TempDir final Path testPath)
+      throws Exception {
     // Create new db with experimental column family
     SegmentedKeyValueStorage<RocksDbSegmentIdentifier> store =
         createSegmentedStore(
@@ -225,8 +224,8 @@ public void dbShouldNotIgnoreExperimentalSegmentsIfExisted() throws Exception {
   }
 
   @Test
-  public void dbWillBeBackwardIncompatibleAfterExperimentalSegmentsAreAdded() throws Exception {
-    final Path testPath = folder.newFolder().toPath();
+  public void dbWillBeBackwardIncompatibleAfterExperimentalSegmentsAreAdded(
+      @TempDir final Path testPath) throws Exception {
     // Create new db should ignore experimental column family
     SegmentedKeyValueStorage<RocksDbSegmentIdentifier> store =
         createSegmentedStore(

plugins/rocksdb/src/test/java/org/hyperledger/besu/plugin/services/storage/rocksdb/segmented/RocksDBKeyValueStorageTest.java

@@ -35,24 +35,24 @@
 import org.hyperledger.besu.plugin.services.storage.rocksdb.configuration.RocksDBConfigurationBuilder;
 import org.hyperledger.besu.plugin.services.storage.rocksdb.unsegmented.RocksDBKeyValueStorage;
 
+import java.nio.file.Path;
 import java.util.function.LongSupplier;
 
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.rules.TemporaryFolder;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.junit.jupiter.api.io.TempDir;
 import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
-import org.mockito.junit.MockitoJUnitRunner;
+import org.mockito.junit.jupiter.MockitoExtension;
 
-@RunWith(MockitoJUnitRunner.class)
+@ExtendWith(MockitoExtension.class)
 public class RocksDBKeyValueStorageTest extends AbstractKeyValueStorageTest {
 
   @Mock private ObservableMetricsSystem metricsSystemMock;
   @Mock private LabelledMetric<OperationTimer> labelledMetricOperationTimerMock;
   @Mock private LabelledMetric<Counter> labelledMetricCounterMock;
   @Mock private OperationTimer operationTimerMock;
-  @Rule public final TemporaryFolder folder = new TemporaryFolder();
+  @TempDir static Path folder;
 
   @Override
   protected KeyValueStorage createStore() throws Exception {
@@ -131,6 +131,6 @@ public void createStoreMustCreateMetrics() throws Exception {
   }
 
   private RocksDBConfiguration config() throws Exception {
-    return new RocksDBConfigurationBuilder().databaseDir(folder.newFolder().toPath()).build();
+    return new RocksDBConfigurationBuilder().databaseDir(getTempSubFolder(folder)).build();
   }
 }

plugins/rocksdb/src/test/java/org/hyperledger/besu/plugin/services/storage/rocksdb/segmented/TransactionDBRocksDBColumnarKeyValueStorageTest.java

@@ -32,7 +32,7 @@ public class TransactionDBRocksDBColumnarKeyValueStorageTest
   protected SegmentedKeyValueStorage<RocksDbSegmentIdentifier> createSegmentedStore()
       throws Exception {
     return new TransactionDBRocksDBColumnarKeyValueStorage(
-        new RocksDBConfigurationBuilder().databaseDir(folder.newFolder().toPath()).build(),
+        new RocksDBConfigurationBuilder().databaseDir(getTempSubFolder(folder)).build(),
         Arrays.asList(TestSegment.FOO, TestSegment.BAR),
         List.of(),
         new NoOpMetricsSystem(),

services/kvstore/build.gradle

@@ -33,8 +33,6 @@ dependencies {
   implementation 'com.google.guava:guava'
 
   testImplementation project(':testutil')
-  testImplementation 'junit:junit'
+  testImplementation 'org.junit.jupiter:junit-jupiter'
   testImplementation 'org.assertj:assertj-core'
-
-  testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
 }

services/kvstore/src/test/java/org/hyperledger/besu/services/kvstore/LimitedInMemoryKeyValueStorageTest.java

@@ -20,7 +20,7 @@
 import org.hyperledger.besu.plugin.services.storage.KeyValueStorage;
 import org.hyperledger.besu.plugin.services.storage.KeyValueStorageTransaction;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class LimitedInMemoryKeyValueStorageTest extends AbstractKeyValueStorageTest {
 

services/pipeline/build.gradle

@@ -37,11 +37,9 @@ dependencies {
   implementation 'io.opentelemetry:opentelemetry-api'
   implementation 'com.google.guava:guava'
 
-  testImplementation 'junit:junit'
   testImplementation 'org.assertj:assertj-core'
   testImplementation 'org.awaitility:awaitility'
   testImplementation 'org.junit.jupiter:junit-jupiter'
   testImplementation 'org.mockito:mockito-core'
-
-  testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
+  testImplementation 'org.mockito:mockito-junit-jupiter'
 }

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/AsyncOperationProcessorTest.java

@@ -26,7 +26,7 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.function.Function;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class AsyncOperationProcessorTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/BatchingReadPipeTest.java

@@ -27,7 +27,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class BatchingReadPipeTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/CompleterStageTest.java

@@ -20,7 +20,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class CompleterStageTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/FlatMapProcessorTest.java

@@ -24,7 +24,7 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class FlatMapProcessorTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/IteratorSourceStageTest.java

@@ -18,7 +18,7 @@
 import static org.hyperledger.besu.metrics.noop.NoOpMetricsSystem.NO_OP_COUNTER;
 
 import com.google.common.collect.Iterators;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class IteratorSourceStageTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/MapProcessorTest.java

@@ -23,7 +23,7 @@
 
 import java.util.function.Function;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class MapProcessorTest {
 

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/PipeTest.java

@@ -24,7 +24,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class PipeTest {
   private final Counter inputCounter = mock(Counter.class);

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/PipelineBuilderTest.java

@@ -51,8 +51,8 @@
 import java.util.stream.Stream;
 
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
-import org.junit.After;
-import org.junit.Test;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.Test;
 
 public class PipelineBuilderTest {
 
@@ -66,7 +66,7 @@ public class PipelineBuilderTest {
 
   private final ExecutorService executorService = Executors.newCachedThreadPool(THREAD_FACTORY);
 
-  @After
+  @AfterEach
   public void afterClass() throws Exception {
     executorService.shutdownNow();
     if (!executorService.awaitTermination(10, SECONDS)) {

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/ProcessingStageTest.java

@@ -16,21 +16,21 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.hyperledger.besu.metrics.noop.NoOpMetricsSystem.NO_OP_COUNTER;
-import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.lenient;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
 
 import java.util.Locale;
 
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.Mock;
-import org.mockito.junit.MockitoJUnitRunner;
+import org.mockito.junit.jupiter.MockitoExtension;
 
-@RunWith(MockitoJUnitRunner.class)
+@ExtendWith(MockitoExtension.class)
 public class ProcessingStageTest {
 
   private final Pipe<String> inputPipe =
@@ -40,10 +40,11 @@ public class ProcessingStageTest {
   @Mock private Processor<String, String> singleStep;
   private ProcessingStage<String, String> stage;
 
-  @Before
+  @BeforeEach
   public void setUp() {
     stage = new ProcessingStage<>("name", inputPipe, outputPipe, singleStep);
-    doAnswer(
+    lenient()
+        .doAnswer(
             invocation -> {
               outputPipe.put(inputPipe.get().toLowerCase(Locale.UK));
               return 1;

services/pipeline/src/test/java/org/hyperledger/besu/services/pipeline/SharedWritePipeTest.java

@@ -18,7 +18,7 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.verifyNoInteractions;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class SharedWritePipeTest {
 

services/tasks/build.gradle

@@ -40,9 +40,6 @@ dependencies {
   implementation 'io.vertx:vertx-core'
   implementation 'org.apache.tuweni:tuweni-bytes'
 
-  testImplementation 'junit:junit'
   testImplementation 'org.assertj:assertj-core'
   testImplementation 'org.junit.jupiter:junit-jupiter'
-
-  testRuntimeOnly 'org.junit.vintage:junit-vintage-engine'
 }

services/tasks/src/test/java/org/hyperledger/besu/services/tasks/AbstractTaskQueueTest.java

@@ -23,7 +23,7 @@
 import java.util.function.Function;
 
 import org.apache.tuweni.bytes.Bytes;
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 abstract class AbstractTaskQueueTest<T extends TaskCollection<Bytes>> {
 

services/tasks/src/test/java/org/hyperledger/besu/services/tasks/CachingTaskCollectionTest.java

@@ -23,13 +23,13 @@
 import java.util.stream.Collectors;
 
 import org.apache.tuweni.bytes.Bytes;
-import org.junit.Before;
-import org.junit.Test;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
 
 public class CachingTaskCollectionTest {
   private TaskCollection<Bytes> wrappedTaskCollection;
 
-  @Before
+  @BeforeEach
   public void setup() {
     wrappedTaskCollection = new InMemoryTaskQueue<>();
   }

services/tasks/src/test/java/org/hyperledger/besu/services/tasks/InMemoryTasksPriorityQueuesTest.java

@@ -21,7 +21,7 @@
 import java.util.List;
 import java.util.Objects;
 
-import org.junit.Test;
+import org.junit.jupiter.api.Test;
 
 public class InMemoryTasksPriorityQueuesTest {
 

testutil/build.gradle

@@ -36,7 +36,7 @@ dependencies {
   implementation 'com.google.guava:guava'
   implementation 'com.squareup.okhttp3:okhttp'
   implementation 'io.vertx:vertx-core'
-  implementation 'junit:junit'
+  implementation 'org.junit.jupiter:junit-jupiter'
   implementation 'org.apache.tuweni:tuweni-bytes'
   implementation 'org.apache.tuweni:tuweni-io'
   implementation 'org.apache.tuweni:tuweni-toml'