Junit5 support

openmaqs-base/pom.xml

@@ -15,6 +15,10 @@
     <version>${revision}</version>
     <packaging>jar</packaging>
 
+    <properties>
+        <junit.version>5.9.2</junit.version>
+    </properties>
+
     <dependencies>
         <dependency>
             <groupId>io.github.openmaqs.utilities</groupId>
@@ -24,5 +28,15 @@
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>${junit.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>${junit.version}</version>
+        </dependency>
     </dependencies>
 </project>

openmaqs-base/src/main/java/io/github/openmaqs/base/BaseGenericTest.java

@@ -19,6 +19,6 @@ protected void beforeLoggingTeardown(ITestResult resultType) {
   @Override
   protected void createNewTestObject() {
     this.setTestObject(
-        new BaseTestObject(this.createLogger(), this.getFullyQualifiedTestClassName()));
+            new BaseTestObject(this.createLogger(), this.getFullyQualifiedTestClassName()));
   }
 }

openmaqs-base/src/main/java/io/github/openmaqs/base/BaseTest.java

@@ -7,6 +7,8 @@
 import static java.lang.System.out;
 
 import io.github.openmaqs.base.exceptions.MAQSRuntimeException;
+import io.github.openmaqs.base.interfaces.TestResult;
+import io.github.openmaqs.base.watcher.JunitTestWatcher;
 import io.github.openmaqs.utilities.helper.StringProcessor;
 import io.github.openmaqs.utilities.logging.ConsoleLogger;
 import io.github.openmaqs.utilities.logging.FileLogger;
@@ -16,6 +18,7 @@
 import io.github.openmaqs.utilities.logging.LoggingConfig;
 import io.github.openmaqs.utilities.logging.LoggingEnabled;
 import io.github.openmaqs.utilities.logging.MessageType;
+import io.github.openmaqs.utilities.logging.TestResultType;
 import io.github.openmaqs.utilities.performance.IPerfTimerCollection;
 import io.github.openmaqs.utilities.performance.PerfTimerCollection;
 import java.lang.reflect.Method;
@@ -27,15 +30,19 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
+import java.util.Optional;
 import java.util.concurrent.ConcurrentHashMap;
 import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.TestInfo;
+import org.junit.jupiter.api.extension.RegisterExtension;
 import org.testng.ITestContext;
 import org.testng.ITestResult;
 import org.testng.annotations.AfterMethod;
 import org.testng.annotations.BeforeMethod;
 
 /**
- * The Base test class.
+ * The Base Test class.
  */
 public abstract class BaseTest {
 
@@ -54,6 +61,11 @@ public abstract class BaseTest {
    */
   private ITestResult testResult;
 
+  /**
+   * The JUnit test result object.
+   */
+  private TestResult junitTestResult;
+
   /**
    * The Collection of Base Test Objects to use.
    */
@@ -74,12 +86,17 @@ public abstract class BaseTest {
    */
   ThreadLocal<String> fullyQualifiedTestClassName = new ThreadLocal<>();
 
+
+  @RegisterExtension
+  public JunitTestWatcher testWatcher;
+
   /**
    * Initializes a new instance of the BaseTest class.
    */
   protected BaseTest() {
     this.loggedExceptions = new ConcurrentHashMap<>();
     this.baseTestObjects = new ConcurrentManagerHashMap();
+    this.testWatcher = new JunitTestWatcher(this);
   }
 
   /**
@@ -215,7 +232,36 @@ public void setTestObject(BaseTestObject baseTestObject) {
   }
 
   /**
-   * Setup before a test.
+   * Setup before a JUnit test.
+   *
+   * @param info the test info of the unit test being run
+   */
+  @BeforeEach
+  public void setup(TestInfo info) {
+    String testClassName = null;
+    String testMethodName = null;
+
+    // Get the Fully Qualified Test Class Name and set it in the object
+    if (info.getTestClass().isPresent()) {
+      Optional<Class<?>> optional = info.getTestClass();
+      if (optional.isPresent()) {
+        testClassName = optional.get().getName();
+      }
+    }
+
+    if (info.getTestMethod().isPresent()) {
+      Optional<Method> optional = info.getTestMethod();
+      if (optional.isPresent()) {
+        testMethodName = optional.get().getName();
+      }
+    }
+
+    String testName = testClassName + "." + testMethodName;
+    customSetup(testName);
+  }
+
+  /**
+   * Setup before a testng unit test.
    *
    * @param method      The initial executing Method object
    * @param testContext The initial executing Test Context object
@@ -237,22 +283,25 @@ public void setup(Method method, ITestContext testContext) {
    */
   public void customSetup(String testName, ITestContext testContext) {
     this.testContextInstance = testContext;
+    customSetup(testName);
+  }
 
+  private void customSetup(String testName) {
     testName = testName.replaceFirst("class ", "");
     this.fullyQualifiedTestClassName.set(testName);
-
     this.createNewTestObject();
   }
 
   /**
-   * Cleanup after a test.
+   * Cleanup after a TestNG test.
    */
   @AfterMethod(alwaysRun = true)
   public void teardown() {
     try {
       this.beforeLoggingTeardown(testResult);
     } catch (Exception e) {
-      this.tryToLog(MessageType.WARNING, "Failed before logging teardown because: %s", e.getMessage());
+      this.tryToLog(MessageType.WARNING, "Failed before logging teardown because: %s",
+          e.getMessage());
     }
 
     // Log the test result
@@ -280,6 +329,42 @@ public void teardown() {
       this.tryToLog(MessageType.WARNING, "Failed to cleanup log files because: %s", e.getMessage());
     }
 
+    cleanUpTest();
+  }
+
+  /**
+   * Cleanup after a JUnit test.
+   */
+  public void teardownJunit() {
+    // Log the test result
+    if (junitTestResult.isSuccess()) {
+      this.tryToLog(MessageType.SUCCESS, "Test Passed");
+    } else if (junitTestResult.getStatus() == TestResultType.FAIL) {
+      this.tryToLog(MessageType.ERROR, "Test Failed");
+    } else if (junitTestResult.getStatus() == TestResultType.SKIP) {
+      this.tryToLog(MessageType.INFORMATION, "Test was skipped");
+    } else {
+      this.tryToLog(MessageType.WARNING, "Test had an unexpected result.");
+    }
+
+    // Cleanup log files we don't want
+    try {
+      if ((this.getLogger() instanceof FileLogger)
+          && junitTestResult.getStatus() == TestResultType.PASS
+          && this.loggingEnabledSetting == LoggingEnabled.ONFAIL) {
+        Files.delete(Paths.get(((FileLogger) this.getLogger()).getFilePath()));
+      }
+    } catch (Exception e) {
+      this.tryToLog(MessageType.WARNING, "Failed to cleanup log files because: %s", e.getMessage());
+    }
+
+    cleanUpTest();
+  }
+
+  /**
+   * Cleans up logs and files after the test.
+   */
+  private void cleanUpTest() {
     // Get the Fully Qualified Test Name
     String fullyQualifiedTestName = this.fullyQualifiedTestClassName.get();
 
@@ -310,6 +395,10 @@ public void setTestResult(ITestResult testResult) {
     this.testResult = testResult;
   }
 
+  public void setTestResult(TestResult testResult) {
+    this.junitTestResult = testResult;
+  }
+
   /**
    * Steps to take before logging teardown results.
    *
@@ -330,7 +419,8 @@ protected ILogger createLogger() {
       if (this.loggingEnabledSetting != LoggingEnabled.NO) {
         return LoggerFactory.getLogger(
             StringProcessor.safeFormatter("%s - %s", this.fullyQualifiedTestClassName.get(),
-                DateTimeFormatter.ofPattern(Logger.DEFAULT_DATE_TIME_FORMAT,
+                DateTimeFormatter.ofPattern(
+                    Logger.DEFAULT_DATE_TIME_FORMAT,
                     Locale.getDefault()).format(LocalDateTime.now(Clock.systemUTC()))));
       } else {
         return LoggerFactory.getConsoleLogger();

openmaqs-base/src/main/java/io/github/openmaqs/base/interfaces/JunitTestResult.java

@@ -0,0 +1,25 @@
+/*
+ *  Copyright 2023 (C) OpenMAQS, All rights Reserved
+ */
+
+package io.github.openmaqs.base.interfaces;
+
+import io.github.openmaqs.utilities.logging.TestResultType;
+
+public class JunitTestResult implements TestResult {
+  private final TestResultType currentStatus;
+
+  public JunitTestResult(TestResultType status) {
+    this.currentStatus = status;
+  }
+
+  @Override
+  public TestResultType getStatus() {
+    return this.currentStatus;
+  }
+
+  @Override
+  public boolean isSuccess() {
+    return currentStatus == TestResultType.PASS;
+  }
+}

openmaqs-base/src/main/java/io/github/openmaqs/base/interfaces/TestResult.java

@@ -0,0 +1,13 @@
+/*
+ *  Copyright 2023 (C) OpenMAQS, All rights Reserved
+ */
+
+package io.github.openmaqs.base.interfaces;
+
+import io.github.openmaqs.utilities.logging.TestResultType;
+
+public interface TestResult {
+  TestResultType getStatus();
+
+  boolean isSuccess();
+}

openmaqs-base/src/main/java/io/github/openmaqs/base/watcher/JunitTestWatcher.java

@@ -0,0 +1,36 @@
+/*
+ *  Copyright 2023 (C) OpenMAQS, All rights Reserved
+ */
+
+package io.github.openmaqs.base.watcher;
+
+import io.github.openmaqs.base.BaseTest;
+import io.github.openmaqs.base.interfaces.JunitTestResult;
+import io.github.openmaqs.utilities.logging.TestResultType;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.TestWatcher;
+
+/**
+ * The JUnit Test Watcher class.
+ */
+public class JunitTestWatcher implements TestWatcher {
+
+  // Test instance of the test being executed per each thread.
+  BaseTest testInstance;
+
+  public JunitTestWatcher(BaseTest testInstance) {
+    this.testInstance = testInstance;
+  }
+
+  @Override
+  public void testSuccessful(ExtensionContext context) {
+    this.testInstance.setTestResult(new JunitTestResult(TestResultType.PASS));
+    this.testInstance.teardownJunit();
+  }
+
+  @Override
+  public void testFailed(ExtensionContext context, Throwable cause) {
+    this.testInstance.setTestResult(new JunitTestResult(TestResultType.FAIL));
+    this.testInstance.teardownJunit();
+  }
+}

openmaqs-base/src/test/java/io/github/openmaqs/base/junit/JUnitBaseGenericTestUnitTest.java

@@ -0,0 +1,17 @@
+/*
+ *  Copyright 2023 (C) OpenMAQS, All rights Reserved
+ */
+
+package io.github.openmaqs.base.junit;
+
+import io.github.openmaqs.base.BaseGenericTest;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+class JUnitBaseGenericTestUnitTest extends BaseGenericTest {
+
+  @Test
+  void testCreateTestObject() {
+    Assertions.assertNotNull(this.getTestObject());
+  }
+}