Add tests and threads helpers

Author: Artem Labazin

CHANGELOG.md

@@ -12,6 +12,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Add more tests.
 - Add `JavaDoc`.
 
+## [1.5.0](https://github.com/appulse-projects/utils-java/releases/tag/1.5.0) - 2018-03-22
+
+Added tests and threads helpers.
+
+### Added
+
+- Threads helpers: executor wrappers, customizable thread factory and executor builders.
+- Test helpers.
+
 ## [1.3.3](https://github.com/appulse-projects/utils-java/releases/tag/1.3.3) - 2018-03-15
 
 Small refactoring.

pom.xml

@@ -24,7 +24,7 @@ limitations under the License.
 
   <groupId>io.appulse</groupId>
   <artifactId>utils-java</artifactId>
-  <version>1.3.3</version>
+  <version>1.5.0</version>
   <packaging>jar</packaging>
 
   <properties>
@@ -62,7 +62,7 @@ limitations under the License.
     <url>https://github.com/appulse-projects/utils-java</url>
     <connection>scm:git:https://github.com/appulse-projects/utils-java.git</connection>
     <developerConnection>scm:git:https://github.com/appulse-projects/utils-java.git</developerConnection>
-    <tag>1.3.3</tag>
+    <tag>1.5.0</tag>
   </scm>
 
   <distributionManagement>
@@ -102,6 +102,25 @@ limitations under the License.
       <scope>provided</scope>
     </dependency>
 
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.7.25</version>
+    </dependency>
+    <dependency>
+      <groupId>io.appulse</groupId>
+      <artifactId>logging-java</artifactId>
+      <version>1.0.2</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.12</version>
+      <scope>provided</scope>
+    </dependency>
+
     <dependency>
       <groupId>com.google.code.findbugs</groupId>
       <artifactId>annotations</artifactId>
@@ -115,12 +134,6 @@ limitations under the License.
       <scope>provided</scope>
     </dependency>
 
-    <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.12</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>

src/main/java/io/appulse/utils/test/TestAppender.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils.test;
+
+import java.util.LinkedList;
+import java.util.List;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.AppenderBase;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.5.0
+ */
+@SuppressFBWarnings("MS_MUTABLE_COLLECTION_PKGPROTECT")
+public class TestAppender extends AppenderBase<ILoggingEvent> {
+
+  public static final List<ILoggingEvent> EVENTS = new LinkedList<>();
+
+  @Override
+  protected void append (ILoggingEvent eventObject) {
+    EVENTS.add(eventObject);
+  }
+}

src/main/java/io/appulse/utils/test/TestMethodNamePrinter.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils.test;
+
+import lombok.val;
+
+import org.junit.rules.TestWatcher;
+import org.junit.runner.Description;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.5.0
+ */
+@SuppressWarnings("PMD.SystemPrintln")
+public class TestMethodNamePrinter extends TestWatcher {
+
+  @Override
+  protected void starting (Description description) {
+    val message = String.format("%nRUNNING TEST: %s.%s%n",
+                                description.getClassName(),
+                                description.getMethodName());
+    System.out.println(message);
+  }
+}

src/main/java/io/appulse/utils/threads/AppulseExecutors.java

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils.threads;
+
+import static java.lang.Integer.MAX_VALUE;
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+import static java.util.concurrent.TimeUnit.MINUTES;
+
+import java.util.concurrent.ForkJoinPool;
+import java.util.concurrent.SynchronousQueue;
+
+import io.appulse.utils.threads.executor.builder.ExecutorServiceBuilder;
+import io.appulse.utils.threads.executor.builder.ForkJoinPoolBuilder;
+import io.appulse.utils.threads.executor.builder.ScheduledExecutorServiceBuilder;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.5.0
+ */
+public final class AppulseExecutors {
+
+  public static ExecutorServiceBuilder newFixedThreadPool (int threads) {
+    return new ExecutorServiceBuilder()
+        .corePoolSize(threads)
+        .maxPoolSize(threads)
+        .keepAliveTime(0L)
+        .unit(MILLISECONDS);
+  }
+
+  public static ForkJoinPoolBuilder newWorkStealingPool () {
+    return new ForkJoinPoolBuilder()
+        .parallelism(Runtime.getRuntime().availableProcessors())
+        .threadFactory(ForkJoinPool.defaultForkJoinWorkerThreadFactory)
+        .asyncMode(true);
+  }
+
+  public static ExecutorServiceBuilder newSingleThreadExecutor () {
+    return new ExecutorServiceBuilder()
+        .corePoolSize(1)
+        .maxPoolSize(1)
+        .keepAliveTime(0L)
+        .unit(MILLISECONDS);
+  }
+
+  public static ExecutorServiceBuilder newCachedThreadPool () {
+    return new ExecutorServiceBuilder()
+        .corePoolSize(0)
+        .maxPoolSize(MAX_VALUE)
+        .keepAliveTime(1L)
+        .unit(MINUTES)
+        .queue(new SynchronousQueue<>());
+  }
+
+  public static ScheduledExecutorServiceBuilder newScheduledThreadPool () {
+    return new ScheduledExecutorServiceBuilder();
+  }
+
+  private AppulseExecutors () {
+  }
+}

src/main/java/io/appulse/utils/threads/AppulseThreadFactory.java

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils.threads;
+
+import static java.lang.Thread.NORM_PRIORITY;
+import static java.util.Locale.ROOT;
+import static java.util.Optional.ofNullable;
+import static lombok.AccessLevel.PRIVATE;
+
+import java.lang.Thread.UncaughtExceptionHandler;
+import java.util.Optional;
+import java.util.concurrent.Executors;
+import java.util.concurrent.ThreadFactory;
+import java.util.concurrent.atomic.AtomicLong;
+
+import lombok.Builder;
+import lombok.NonNull;
+import lombok.experimental.FieldDefaults;
+import lombok.val;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.5.0
+ */
+@SuppressWarnings("PMD.DoNotUseThreads")
+@FieldDefaults(level = PRIVATE, makeFinal = true)
+public final class AppulseThreadFactory implements ThreadFactory {
+
+  ThreadFactory parent;
+
+  int priority;
+
+  Optional<String> name;
+
+  AtomicLong threadCount;
+
+  Optional<Boolean> daemon;
+
+  Optional<UncaughtExceptionHandler> uncaughtExceptionHandler;
+
+  @Builder
+  public AppulseThreadFactory (String name, Boolean daemon, Integer priority, ThreadFactory parent,
+                               UncaughtExceptionHandler uncaughtExceptionHandler
+  ) {
+    this.name = ofNullable(name);
+    threadCount = this.name
+        .filter(it -> it.contains("%d"))
+        .map(it -> new AtomicLong(1))
+        .orElse(null);
+
+    this.daemon = ofNullable(daemon);
+    this.uncaughtExceptionHandler = ofNullable(uncaughtExceptionHandler);
+
+    this.priority = ofNullable(priority)
+        .orElse(NORM_PRIORITY);
+
+    this.parent = ofNullable(parent)
+        .orElse(Executors.defaultThreadFactory());
+  }
+
+  @Override
+  public Thread newThread (@NonNull Runnable runnable) {
+    val thread = parent.newThread(runnable);
+    thread.setPriority(priority);
+
+    name.map(it -> ofNullable(threadCount)
+        .map(counter -> String.format(ROOT, it, counter.getAndIncrement()))
+        .orElse(it)
+    )
+        .ifPresent(thread::setName);
+
+    daemon.ifPresent(thread::setDaemon);
+    uncaughtExceptionHandler.ifPresent(thread::setUncaughtExceptionHandler);
+    return thread;
+  }
+}

src/main/java/io/appulse/utils/threads/executor/ExecutorServiceWithClientTrace.java

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.appulse.utils.threads.executor;
+
+import java.util.concurrent.ExecutorService;
+
+import lombok.NonNull;
+import lombok.extern.slf4j.Slf4j;
+import lombok.val;
+
+/**
+ *
+ * @author Artem Labazin
+ * @since 1.5.0
+ */
+@Slf4j
+@SuppressWarnings("PMD.DoNotUseThreads")
+public final class ExecutorServiceWithClientTrace extends ExecutorServiceWrapper {
+
+  public ExecutorServiceWithClientTrace (ExecutorService delegate) {
+    super(delegate);
+  }
+
+  @Override
+  public void execute (@NonNull Runnable command) {
+    val clientStack = new Exception("Client stack trace");
+    val threadName = Thread.currentThread().getName();
+
+    super.execute(() -> {
+      try {
+        command.run();
+      } catch (Exception ex) {
+        log.error("Exception '{}' in task submitted from thread '{}' here:",
+                  ex.getClass().getSimpleName(), threadName, clientStack);
+        throw ex;
+      }
+    });
+  }
+}