Extend the TestClassWatcher interface to add notifications with runners

Author: sbabcoc

src/main/java/com/nordstrom/automation/junit/CreateTestClass.java

@@ -24,12 +24,14 @@
 @SuppressWarnings("squid:S1118")
 public class CreateTestClass {
     private static final ServiceLoader<TestClassWatcher> classWatcherLoader;
+    private static final ServiceLoader<TestClassWatcher2> classWatcher2Loader;
     private static final Logger LOGGER = LoggerFactory.getLogger(CreateTestClass.class);
     private static final Map<TestClass, Object> TESTCLASS_TO_RUNNER = new ConcurrentHashMap<>();
     private static final Map<Object, TestClass> METHOD_TO_TESTCLASS = new ConcurrentHashMap<>();
 
     static {
         classWatcherLoader = ServiceLoader.load(TestClassWatcher.class);
+        classWatcher2Loader = ServiceLoader.load(TestClassWatcher2.class);
     }
 
     /**
@@ -53,6 +55,9 @@ public static TestClass intercept(@This final Object runner, @SuperCall final Ca
         for (TestClassWatcher watcher : classWatcherLoader) {
             watcher.testClassCreated(testClass, runner);
         }
+        for (TestClassWatcher2 watcher : classWatcher2Loader) {
+            watcher.testClassCreated(testClass, runner);
+        }
 
         attachRunnerScheduler(testClass, runner);
         return testClass;
@@ -67,7 +72,7 @@ public static TestClass intercept(@This final Object runner, @SuperCall final Ca
     private static void attachRunnerScheduler(final TestClass testClass, final Object runner) {
         try {
             RunnerScheduler scheduler = getFieldValue(runner, "scheduler");
-            setFieldValue(runner, "scheduler", createRunnerScheduler(testClass, scheduler));
+            setFieldValue(runner, "scheduler", createRunnerScheduler(testClass, runner, scheduler));
         } catch (IllegalAccessException | NoSuchFieldException | SecurityException | IllegalArgumentException e) {
             LOGGER.warn("Unable to attach notifying runner scheduler", e);
         }
@@ -77,10 +82,12 @@ private static void attachRunnerScheduler(final TestClass testClass, final Objec
      * Create notifying runner scheduler, which forwards to the previous scheduler if specified.
      * 
      * @param testClass {@link TestClass} object that was just created
+     * @param runner {@link ParentRunner} for the specified test class
      * @param scheduler runner scheduler that's currently attached to the specified runner (may be {@code null})
      * @return new notifying runner scheduler
      */
-    private static RunnerScheduler createRunnerScheduler(final TestClass testClass, final RunnerScheduler scheduler) {
+    private static RunnerScheduler createRunnerScheduler(final TestClass testClass,
+                    final Object runner, final RunnerScheduler scheduler) {
         return new RunnerScheduler() {
             private AtomicBoolean scheduled = new AtomicBoolean(false);
 
@@ -89,6 +96,9 @@ public void schedule(Runnable childStatement) {
                     for (TestClassWatcher watcher : classWatcherLoader) {
                         watcher.testClassStarted(testClass);
                     }
+                    for (TestClassWatcher2 watcher : classWatcher2Loader) {
+                        watcher.testClassStarted(testClass, runner);
+                    }
                 }
 
                 RunReflectiveCall.fireTestStarted(testClass, childStatement);
@@ -106,6 +116,9 @@ public void finished() {
                 for (TestClassWatcher watcher : classWatcherLoader) {
                     watcher.testClassFinished(testClass);
                 }
+                for (TestClassWatcher2 watcher : classWatcher2Loader) {
+                    watcher.testClassFinished(testClass, runner);
+                }
             }
         };
     }

src/main/java/com/nordstrom/automation/junit/TestClassWatcher.java

@@ -20,13 +20,15 @@ public interface TestClassWatcher {
      * Called when a runner (test class or suite) is about to be started.
      * 
      * @param testClass {@link TestClass} object for the parent runner
+     * @deprecated Use {@link TestClassWatcher2#testClassStarted(TestClass, Object)} instead
      */
     void testClassStarted(TestClass testClass);
 
     /**
      * Called when a runner (test class or suite) has finished.
      * 
      * @param testClass {@link TestClass} object for the parent runner
+     * @deprecated Use {@link TestClassWatcher2#testClassFinished(TestClass, Object)} instead
      */
     void testClassFinished(TestClass testClass);
 }

src/main/java/com/nordstrom/automation/junit/TestClassWatcher2.java

@@ -0,0 +1,26 @@
+package com.nordstrom.automation.junit;
+
+import org.junit.runners.model.TestClass;
+
+/**
+ * This interface defines the methods implemented by JUnit TestClass watchers. These watchers are registered via a
+ * ServiceLoader provider configuration file.
+ */
+public interface TestClassWatcher2 extends TestClassWatcher {
+    
+    /**
+     * Called when a runner (test class or suite) is about to be started.
+     * 
+     * @param testClass {@link TestClass} object for the parent runner
+     * @param runner JUnit test runner
+     */
+    void testClassStarted(TestClass testClass, Object runner);
+    
+    /**
+     * Called when a runner (test class or suite) has finished.
+     * 
+     * @param testClass {@link TestClass} object for the parent runner
+     * @param runner JUnit test runner
+     */
+    void testClassFinished(TestClass testClass, Object runner);
+}