Tests: Add UITestCase unit test super class (print start/end, singletion test); Add @FixMethodOrder(MethodSorters.NAME_ASCENDING)

3 files changed, 163 insertions, 4 deletions

diff --git a/src/test/com/jogamp/openal/test/junit/ALutWAVLoaderTest.java b/src/test/com/jogamp/openal/test/junit/ALutWAVLoaderTest.java
index 7d8fa05..9a9eaef 100644
--- a/src/test/com/jogamp/openal/test/junit/ALutWAVLoaderTest.java
+++ b/src/test/com/jogamp/openal/test/junit/ALutWAVLoaderTest.java
@@ -6,15 +6,19 @@ import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
 
+import org.junit.FixMethodOrder;
 import org.junit.Test;
 import org.junit.Assert;
+import org.junit.runners.MethodSorters;
 
 import com.jogamp.openal.test.resources.ResourceLocation;
+import com.jogamp.openal.test.util.UITestCase;
 import com.jogamp.openal.util.ALut;
 import com.jogamp.openal.util.WAVData;
 import com.jogamp.openal.util.WAVLoader;
 
-public class ALutWAVLoaderTest {
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public class ALutWAVLoaderTest extends UITestCase {
 
     @Test
     public void testALutLoadWAVFileStream() throws IOException {
diff --git a/src/test/com/jogamp/openal/test/junit/DummyTest.java b/src/test/com/jogamp/openal/test/junit/DummyTest.java
index 496c575..01f48da 100644
--- a/src/test/com/jogamp/openal/test/junit/DummyTest.java
+++ b/src/test/com/jogamp/openal/test/junit/DummyTest.java
@@ -1,14 +1,19 @@
 package com.jogamp.openal.test.junit;
 
 import org.junit.Assert;
+import org.junit.FixMethodOrder;
 import org.junit.Test;
+import org.junit.runners.MethodSorters;
+
+import com.jogamp.openal.test.util.UITestCase;
 
 /**
  * Dummy test - always successful, merely exist to not let our Jenkins build not fail.
  */
-public class DummyTest {
-    
-    @Test 
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public class DummyTest extends UITestCase {
+
+    @Test
     public void test00() {
         Assert.assertTrue(true);
     }
diff --git a/src/test/com/jogamp/openal/test/util/UITestCase.java b/src/test/com/jogamp/openal/test/util/UITestCase.java
new file mode 100644
index 0000000..73e6925
--- /dev/null
+++ b/src/test/com/jogamp/openal/test/util/UITestCase.java
@@ -0,0 +1,150 @@
+/**
+ * Copyright 2010, 2014 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+
+package com.jogamp.openal.test.util;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.util.Iterator;
+import java.util.List;
+
+import com.jogamp.common.util.locks.SingletonInstance;
+
+import org.junit.Assume;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.After;
+import org.junit.AfterClass;
+import org.junit.FixMethodOrder;
+import org.junit.Rule;
+import org.junit.rules.TestName;
+import org.junit.runners.MethodSorters;
+import org.junit.runners.model.FrameworkMethod;
+import org.junit.runners.model.TestClass;
+
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
+public abstract class UITestCase {
+    @Rule public TestName _unitTestName = new TestName();
+
+    public static final String SINGLE_INSTANCE_LOCK_FILE = "UITestCase.lock";
+    public static final int SINGLE_INSTANCE_LOCK_PORT = 59999;
+
+    public static final long SINGLE_INSTANCE_LOCK_TO   = 6*60*1000; // wait up to 6 mins
+    public static final long SINGLE_INSTANCE_LOCK_POLL =      1000; // poll every 1s
+
+    private static volatile SingletonInstance singletonInstance;
+
+    private static volatile boolean testSupported = true;
+
+    private static volatile int maxMethodNameLen = 0;
+
+    private static final synchronized void initSingletonInstance() {
+        if( null == singletonInstance )  {
+            // singletonInstance = SingletonInstance.createFileLock(SINGLE_INSTANCE_LOCK_POLL, SINGLE_INSTANCE_LOCK_FILE);
+            singletonInstance = SingletonInstance.createServerSocket(SINGLE_INSTANCE_LOCK_POLL, SINGLE_INSTANCE_LOCK_PORT);
+            if(!singletonInstance.tryLock(SINGLE_INSTANCE_LOCK_TO)) {
+                throw new RuntimeException("Fatal: Could not lock single instance: "+singletonInstance.getName());
+            }
+        }
+    }
+
+    public static boolean isTestSupported() {
+        return testSupported;
+    }
+
+    public static void setTestSupported(boolean v) {
+        System.err.println("setTestSupported: "+v);
+        testSupported = v;
+    }
+
+    public int getMaxTestNameLen() {
+        if(0 == maxMethodNameLen) {
+            int ml = 0;
+            final TestClass tc = new TestClass(getClass());
+            final List<FrameworkMethod> testMethods = tc.getAnnotatedMethods(org.junit.Test.class);
+            for(Iterator<FrameworkMethod> iter=testMethods.iterator(); iter.hasNext(); ) {
+                final int l = iter.next().getName().length();
+                if( ml < l ) { ml = l; }
+            }
+            maxMethodNameLen = ml;
+        }
+        return maxMethodNameLen;
+    }
+
+    public final String getTestMethodName() {
+        return _unitTestName.getMethodName();
+    }
+
+    public final String getSimpleTestName(String separator) {
+        return getClass().getSimpleName()+separator+getTestMethodName();
+    }
+
+    public final String getFullTestName(String separator) {
+        return getClass().getName()+separator+getTestMethodName();
+    }
+
+    @BeforeClass
+    public static void oneTimeSetUp() {
+        // one-time initialization code
+        initSingletonInstance();
+    }
+
+    @AfterClass
+    public static void oneTimeTearDown() {
+        // one-time cleanup code
+        System.gc(); // force cleanup
+        singletonInstance.unlock();
+    }
+
+    @Before
+    public void setUp() {
+        System.err.print("++++ UITestCase.setUp: "+getFullTestName(" - "));
+        if(!testSupported) {
+            System.err.println(" - "+unsupportedTestMsg);
+            Assume.assumeTrue(testSupported); // abort
+        }
+        System.err.println();
+    }
+
+    @After
+    public void tearDown() {
+        System.err.println("++++ UITestCase.tearDown: "+getFullTestName(" - "));
+    }
+
+    public static void waitForKey(String preMessage) {
+        BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
+        System.err.println(preMessage+"> Press enter to continue");
+        try {
+            System.err.println(stdin.readLine());
+        } catch (IOException e) { }
+    }
+
+    static final String unsupportedTestMsg = "Test not supported on this platform.";
+}
+