Replace "jsr305" with "jakarta.annotation-api", auto-closeable CommonUtils.ExecutorService for easier resource management

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- Auto-closeable `CommonUtils.ExecutorService` for easier resource management, by @HardNorth
+### Changed
+- Replace "jsr305" with "jakarta.annotation-api", by @HardNorth
+### Removed
+- Java 8-10 support, by @HardNorth
 
 ## [0.0.13]
 ### Changed

build.gradle

@@ -23,16 +23,16 @@ repositories {
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+    sourceCompatibility = JavaVersion.VERSION_11
+    targetCompatibility = JavaVersion.VERSION_11
 }
 
 compileTestJava.options.encoding = "UTF-8"
 
 dependencies {
     compileOnly 'io.reactivex.rxjava2:rxjava:2.2.21'
-    compileOnly 'com.google.code.findbugs:jsr305:3.0.2'
-    compileOnly 'org.apache.commons:commons-lang3:3.17.0'
+    compileOnly 'jakarta.annotation:jakarta.annotation-api:3.0.0'
+    compileOnly 'org.apache.commons:commons-lang3:3.18.0'
     compileOnly 'commons-io:commons-io:2.18.0'
     compileOnly('org.slf4j:slf4j-api:2.0.16')
 

gradle.properties

@@ -1,4 +1,4 @@
-version=0.0.14-SNAPSHOT
+version=0.1.0-SNAPSHOT
 group=com.epam.reportportal
 description=Common agent test utilites
 junit_version=5.6.3

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.9.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.5-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/com/epam/reportportal/util/test/CommonUtils.java

@@ -16,30 +16,128 @@
 package com.epam.reportportal.util.test;
 
 import io.reactivex.Maybe;
+import jakarta.annotation.Nonnull;
 
+import java.util.Collection;
+import java.util.List;
 import java.util.UUID;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
-import java.util.concurrent.ThreadLocalRandom;
-import java.util.concurrent.TimeUnit;
+import java.util.concurrent.*;
 
+@SuppressWarnings("unused")
 public class CommonUtils {
 
 	// 20 milliseconds is enough to separate one test from another
 	public static final long MINIMAL_TEST_PAUSE = 20L;
 
+	public static class ExecutorService implements java.util.concurrent.ExecutorService, AutoCloseable {
+		private final java.util.concurrent.ExecutorService delegate;
+
+		public ExecutorService(java.util.concurrent.ExecutorService delegate) {
+			this.delegate = delegate;
+		}
+
+		@Override
+		public void shutdown() {
+			delegate.shutdown();
+		}
+
+		@Override
+		@Nonnull
+		public List<Runnable> shutdownNow() {
+			return delegate.shutdownNow();
+		}
+
+		@Override
+		public boolean isShutdown() {
+			return delegate.isShutdown();
+		}
+
+		@Override
+		public boolean isTerminated() {
+			return delegate.isTerminated();
+		}
+
+		@Override
+		public boolean awaitTermination(long timeout, @Nonnull TimeUnit unit) throws InterruptedException {
+			return delegate.awaitTermination(timeout, unit);
+		}
+
+		@Override
+		@Nonnull
+		public <T> Future<T> submit(@Nonnull Callable<T> task) {
+			return delegate.submit(task);
+		}
+
+		@Override
+		@Nonnull
+		public <T> Future<T> submit(@Nonnull Runnable task, T result) {
+			return delegate.submit(task, result);
+		}
+
+		@Override
+		@Nonnull
+		public Future<?> submit(@Nonnull Runnable task) {
+			return delegate.submit(task);
+		}
+
+		@Override
+		@Nonnull
+		public <T> List<Future<T>> invokeAll(@Nonnull Collection<? extends Callable<T>> tasks) throws InterruptedException {
+			return delegate.invokeAll(tasks);
+		}
+
+		@Override
+		@Nonnull
+		public <T> List<Future<T>> invokeAll(@Nonnull Collection<? extends Callable<T>> tasks, long timeout, @Nonnull TimeUnit unit)
+				throws InterruptedException {
+			return delegate.invokeAll(tasks, timeout, unit);
+		}
+
+		@Override
+		@Nonnull
+		public <T> T invokeAny(@Nonnull Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {
+			return delegate.invokeAny(tasks);
+		}
+
+		@Override
+		public <T> T invokeAny(@Nonnull Collection<? extends Callable<T>> tasks, long timeout, @Nonnull TimeUnit unit)
+				throws InterruptedException, ExecutionException, TimeoutException {
+			return delegate.invokeAny(tasks, timeout, unit);
+		}
+
+		@Override
+		public void execute(@Nonnull Runnable command) {
+			delegate.execute(command);
+		}
+
+		@Override
+		public void close() {
+			CommonUtils.shutdownExecutorService(delegate);
+		}
+	}
+
 	private CommonUtils() {
 	}
 
 	public static ExecutorService testExecutor() {
-		return Executors.newSingleThreadExecutor(r -> {
-			Thread t = new Thread(r);
+		return new ExecutorService(Executors.newSingleThreadExecutor(r -> {
+			Thread t = Executors.defaultThreadFactory().newThread(r);
 			t.setDaemon(true);
 			return t;
-		});
+		}));
+	}
+
+	public static ExecutorService testExecutor(final int threadNum) {
+		return new ExecutorService(Executors.newFixedThreadPool(
+				threadNum, r -> {
+					Thread t = Executors.defaultThreadFactory().newThread(r);
+					t.setDaemon(true);
+					return t;
+				}
+		));
 	}
 
-	public static void shutdownExecutorService(ExecutorService executor) {
+	public static <T extends java.util.concurrent.ExecutorService> void shutdownExecutorService(T executor) {
 		if (executor == null || executor.isShutdown()) {
 			return;
 		}

src/main/java/com/epam/reportportal/util/test/ProcessUtils.java

@@ -16,14 +16,14 @@
 
 package com.epam.reportportal.util.test;
 
+import jakarta.annotation.Nonnull;
+import jakarta.annotation.Nullable;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.tuple.ImmutableTriple;
 import org.apache.commons.lang3.tuple.Triple;
 import org.awaitility.Awaitility;
 import org.awaitility.core.ConditionTimeoutException;
 
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
 import java.io.*;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.FileSystems;
@@ -36,6 +36,7 @@
 import static org.apache.commons.lang3.StringUtils.joinWith;
 import static org.hamcrest.Matchers.notNullValue;
 
+@SuppressWarnings("unused")
 public class ProcessUtils {
 	private ProcessUtils() {
 	}
@@ -51,8 +52,8 @@ private static String getPathToClass(@Nonnull Class<?> mainClass) {
 	}
 
 	public static Process buildProcess(boolean inheritOutput, @Nonnull Class<?> mainClass,
-			@Nullable Map<String, String> additionalEnvironmentVariables,
-			@Nullable Map<String, String> additionSystemVariables, String... params) throws IOException {
+			@Nullable Map<String, String> additionalEnvironmentVariables, @Nullable Map<String, String> additionSystemVariables,
+			String... params) throws IOException {
 		String fileSeparator = FileSystems.getDefault().getSeparator();
 		String javaHome = System.getProperty("java.home");
 		String executablePath = joinWith(fileSeparator, javaHome, "bin", "java");
@@ -117,10 +118,8 @@ public static void closeIos(Triple<OutputStreamWriter, BufferedReader, BufferedR
 	public static String waitForLine(final BufferedReader reader, final BufferedReader errorReader, final Predicate<String> linePredicate)
 			throws IOException {
 		try {
-			return Awaitility.await("Waiting for a line")
-					.timeout(8, TimeUnit.SECONDS)
-					.pollInterval(100, TimeUnit.MILLISECONDS)
-					.until(() -> {
+			return Awaitility.await("Waiting for a line").timeout(8, TimeUnit.SECONDS).pollInterval(100, TimeUnit.MILLISECONDS).until(
+					() -> {
 						if (!reader.ready()) {
 							return null;
 						}
@@ -131,7 +130,8 @@ public static String waitForLine(final BufferedReader reader, final BufferedRead
 							}
 						}
 						return null;
-					}, notNullValue());
+					}, notNullValue()
+			);
 		} catch (ConditionTimeoutException e) {
 			List<String> errorLines = Collections.EMPTY_LIST;
 			if (errorReader.ready()) {

src/main/java/com/epam/reportportal/util/test/SocketUtils.java

@@ -16,12 +16,12 @@
 
 package com.epam.reportportal.util.test;
 
+import jakarta.annotation.Nonnull;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.tuple.Pair;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import javax.annotation.Nonnull;
 import java.io.*;
 import java.net.ServerSocket;
 import java.net.Socket;
@@ -34,6 +34,7 @@
 
 import static java.util.Optional.*;
 
+@SuppressWarnings("unused")
 public class SocketUtils {
 	public static final String CONTENT_LENGTH_HEADER = "Content-Length: ";
 	public static final String WEB_DATE_FORMAT = "EEE, dd MMM yyyy HH:mm:ss z";