Add unit tests

Simplify stub logic

Author: tresf

ant/build.xml

@@ -8,6 +8,7 @@
             <entry key="maven.nativelibdir.path" value="${maven.nativelibdir.path}"/>
             <entry key="maven.assembly.id" value="${maven.assembly.id}"/>
             <entry key="maven.test.skip" value="${maven.test.skip}"/>
+            <entry key="maven.exclude.tests" value="${maven.exclude.tests}"/>
         </propertyfile>
     </target>
 
@@ -193,6 +194,11 @@
             </and>
         </condition>
 
+        <!-- Skip ManualBootLibraryPathTest test if we're not building a native lib -->
+        <condition property="maven.exclude.tests" value="**/ManualBootLibraryPathTest.java" else="">
+            <equals arg1="${cmake.build.skip}" arg2="true"/>
+        </condition>
+
         <!-- Summarize host/target -->
         <echo level="info">Tests will run only if the TARGET and HOST match:${line.separator}${line.separator}</echo>
         <echo level="info">TARGET:   ${os.target.classifier}</echo>

pom.xml

@@ -68,7 +68,7 @@
     <plugin.osmaven.version>1.7.0</plugin.osmaven.version>
     <plugin.signature.version>1.1</plugin.signature.version>
     <plugin.source.version>3.0.1</plugin.source.version>
-    <plugin.surfire.version>3.0.0-M3</plugin.surfire.version>
+    <plugin.surfire.version>3.0.0-M4</plugin.surfire.version>
   </properties>
 
   <dependencies>
@@ -253,6 +253,12 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
         <version>${plugin.surfire.version}</version>
+        <configuration>
+          <reuseForks>false</reuseForks>
+          <excludes>
+            <exclude>${maven.exclude.tests}</exclude>
+          </excludes>
+        </configuration>
       </plugin>
 
       <plugin>

src/main/java/jssc/DefaultJniExtractorStub.java

@@ -17,14 +17,12 @@
  */
 public class DefaultJniExtractorStub extends DefaultJniExtractor {
     private File bootPath;
-    private boolean useStub;
 
     /**
      * Default constructor
      */
     public DefaultJniExtractorStub(Class libraryJarClass) throws IOException {
         super(libraryJarClass);
-        useStub = false;
     }
 
     /**
@@ -37,13 +35,12 @@ public DefaultJniExtractorStub(Class libraryJarClass) throws IOException {
      */
     public DefaultJniExtractorStub(Class libraryJarClass, String bootPath) throws IOException {
         this(libraryJarClass);
-        this.bootPath = new File(bootPath);
 
         if(bootPath != null) {
             File bootTest = new File(bootPath);
             if(bootTest.exists()) {
                 // assume a static, existing directory will contain the native libs
-                this.useStub = true;
+                this.bootPath = bootTest;
             } else {
                 System.err.println("WARNING " + DefaultJniExtractorStub.class.getCanonicalName() + ": Boot path " + bootPath + " not found, falling back to default extraction behavior.");
             }
@@ -60,7 +57,7 @@ public DefaultJniExtractorStub(Class libraryJarClass, String bootPath) throws IO
     @Override
     public File extractJni(String libPath, String libName) throws IOException {
         // Lie and pretend it's already extracted at the bootPath location
-        if(useStub) {
+        if(bootPath != null) {
             return new File(bootPath, NativeLibraryUtil.getPlatformLibraryName(libName));
         }
         // Fallback on default behavior
@@ -69,7 +66,7 @@ public File extractJni(String libPath, String libName) throws IOException {
 
     @Override
     public void extractRegistered() throws IOException {
-        if(useStub) {
+        if(bootPath != null) {
             return; // no-op
         }
         super.extractRegistered();

src/test/java/jssc/bootpath/ManualBootLibraryPathFailedTest.java

@@ -0,0 +1,28 @@
+package jssc.bootpath;
+
+import jssc.SerialNativeInterface;
+import org.junit.Test;
+
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+public class ManualBootLibraryPathFailedTest {
+    @Test
+    public void testBootPathOverride() {
+        /**
+         * This must be in its own class to run in a separate JVM
+         * - See also: https://stackoverflow.com/questions/68657855
+         * - NativeLoader.loadLibrary(...) calls System.loadLibrary(...) which is static
+         * - maven-surefire-plugin must be configured with reuseForks=false to use a new JVM for each class
+         * - TODO: If JUnit adds JVM unloading between methods, this class can be consolidated
+         */
+        String nativeLibDir = "/"; // This should be valid on all platforms
+        System.setProperty("jssc.boot.library.path", nativeLibDir);
+        try {
+            SerialNativeInterface.getNativeLibraryVersion();
+            fail("Library loading should fail if path provided exists but does not contain a native library");
+        } catch (UnsatisfiedLinkError ignore) {
+            assertTrue("Library loading failed as expected with an invalid jssc.boot.library.path", true);
+        }
+    }
+}

src/test/java/jssc/bootpath/ManualBootLibraryPathTest.java

@@ -0,0 +1,32 @@
+package jssc.bootpath;
+
+import jssc.SerialNativeInterface;
+import org.junit.Test;
+import org.scijava.nativelib.NativeLibraryUtil;
+
+import static org.hamcrest.CoreMatchers.*;
+import static org.junit.Assert.assertThat;
+import static org.junit.Assert.fail;
+
+public class ManualBootLibraryPathTest {
+    @Test
+    public void testBootPathOverride() {
+        /**
+         * This must be in its own class to run in a separate JVM
+         * - See also: https://stackoverflow.com/questions/68657855
+         * - NativeLoader.loadLibrary(...) calls System.loadLibrary(...) which is static
+         * - maven-surefire-plugin must be configured with reuseForks=false to use a new JVM for each class
+         * - TODO: If JUnit adds JVM unloading between methods, this class can be consolidated
+         */
+        String nativeLibDir = NativeLibraryUtil.getPlatformLibraryPath(System.getProperty("user.dir") + "/target/cmake/natives/");
+        System.setProperty("jssc.boot.library.path", nativeLibDir);
+        try {
+            final String nativeLibraryVersion = SerialNativeInterface.getNativeLibraryVersion();
+            assertThat(nativeLibraryVersion, is(not(nullValue())));
+            assertThat(nativeLibraryVersion, is(not("")));
+        } catch (UnsatisfiedLinkError linkError) {
+            linkError.printStackTrace();
+            fail("Should be able to call method!");
+        }
+    }
+}