Add module for test utilities.

alexander-yevsyukov · alexander-yevsyukov · commit 3f4d7d29dba8 · 2016-03-24T21:07:37.000+02:00
diff --git a/client/build.gradle b/client/build.gradle
@@ -10,6 +10,7 @@ buildscript {
 
 dependencies {
     compile group: 'io.grpc', name: 'grpc-all', version: '0.13.1'
+    testCompile project (path: ":testutil", configuration: 'testArtifacts')
 }
 
 apply plugin: 'org.spine3.tools.protolookup';
diff --git a/client/src/test/java/org/spine3/base/CommandsShould.java b/client/src/test/java/org/spine3/base/CommandsShould.java
@@ -28,8 +28,8 @@
 import com.google.protobuf.Message;
 import com.google.protobuf.StringValue;
 import org.junit.Test;
+import org.spine3.client.test.TestCommandFactory;
 import org.spine3.test.RunTest;
-import org.spine3.test.TestCommandFactory;
 import org.spine3.type.TypeName;
 
 import java.util.ArrayList;
diff --git a/client/src/test/java/org/spine3/client/test/TestCommandFactory.java b/client/src/test/java/org/spine3/client/test/TestCommandFactory.java
@@ -18,7 +18,7 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-package org.spine3.test;
+package org.spine3.client.test;
 
 import com.google.protobuf.Message;
 import com.google.protobuf.Timestamp;
diff --git a/client/src/test/java/org/spine3/test/Tests.java b/client/src/test/java/org/spine3/test/Tests.java
diff --git a/client/src/test/java/org/spine3/test/package-info.java b/client/src/test/java/org/spine3/test/package-info.java
diff --git a/client/src/test/java/org/spine3/type/TypeNameShould.java b/client/src/test/java/org/spine3/type/TypeNameShould.java
@@ -28,8 +28,8 @@
 import org.junit.Test;
 import org.spine3.base.Command;
 import org.spine3.client.CommandFactory;
+import org.spine3.client.test.TestCommandFactory;
 import org.spine3.test.RunTest;
-import org.spine3.test.TestCommandFactory;
 
 import static org.junit.Assert.*;
 
diff --git a/client/src/test/proto/spine/test/commands.proto b/client/src/test/proto/spine/test/commands.proto
@@ -25,6 +25,7 @@ option java_package="org.spine3.test";
 option java_multiple_files = true;
 option java_outer_classname = "TestCommands";
 
+// A test command to run a test by the method name.
 message RunTest {
     string method_name = 1;
 }
diff --git a/server/src/test/java/org/spine3/server/command/CommandBusShould.java b/server/src/test/java/org/spine3/server/command/CommandBusShould.java
@@ -31,12 +31,12 @@
 import org.spine3.base.Event;
 import org.spine3.base.Responses;
 import org.spine3.client.CommandFactory;
+import org.spine3.client.test.TestCommandFactory;
 import org.spine3.server.Assign;
 import org.spine3.server.CommandDispatcher;
 import org.spine3.server.CommandHandler;
 import org.spine3.server.FailureThrowable;
 import org.spine3.server.error.UnsupportedCommandException;
-import org.spine3.test.TestCommandFactory;
 import org.spine3.test.failures.Failures;
 import org.spine3.test.project.command.AddTask;
 import org.spine3.test.project.command.CreateProject;
@@ -72,7 +72,7 @@ public void setUp() {
 
     @Test(expected = NullPointerException.class)
     public void do_not_accept_null_CommandStore_on_construction() {
-        //noinspection ConstantConditions
+        //noinspection ConstantConditions,ResultOfMethodCallIgnored
         CommandBus.create(null);
     }
 
diff --git a/settings.gradle b/settings.gradle
@@ -1,5 +1,8 @@
 rootProject.name = 'spine'
 
+include ':testutil'
+project(':testutil').projectDir = "$rootDir/testutil" as File
+
 include ':client'
 project(':client').projectDir = "$rootDir/client" as File
 
diff --git a/testutil/build.gradle b/testutil/build.gradle
@@ -0,0 +1,20 @@
+
+dependencies {
+    // Depend on JUnit in the production part of the code, as this module exposes testing utilities
+    // that are based on JUnit.
+    compile group: 'junit', name: 'junit', version: '4.12'
+}
+
+// required for usage of test classes from other modules
+configurations {
+    testArtifacts.extendsFrom testRuntime
+}
+
+task testJar(type: Jar) {
+    classifier "test"
+    from sourceSets.test.output
+}
+artifacts {
+    testArtifacts testJar
+}
+
diff --git a/testutil/src/main/java/org/spine3/test/Tests.java b/testutil/src/main/java/org/spine3/test/Tests.java
@@ -20,8 +20,6 @@
 
 package org.spine3.test;
 
-import org.spine3.Internal;
-
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Modifier;
 
@@ -32,7 +30,6 @@
  *
  * @author Alexander Yevsyukov
  */
-@Internal
 public class Tests {
 
     private static final long MSEC_IN_SECOND = 1000L;
diff --git a/testutil/src/main/java/org/spine3/test/Verify.java b/testutil/src/main/java/org/spine3/test/Verify.java
@@ -162,8 +162,7 @@ public static AssertionError mangledException(AssertionError e, int framesToPop)
     }
 
     public static void fail(String message, Throwable cause) {
-        final AssertionError failedException = new AssertionError(message);
-        failedException.initCause(cause);
+        final AssertionError failedException = new AssertionError(message, cause);
         throw mangledException(failedException);
     }
 
@@ -533,7 +532,7 @@ public static void assertNotEmpty(String multimapName, Multimap<?, ?> actualMult
     public static <T> void assertNotEmpty(String itemsName, T[] items) {
         try {
             assertObjectNotNull(itemsName, items);
-            assertNotEquals(itemsName, 0, items.length);
+            Assert.assertNotEquals(itemsName, 0, items.length);
         } catch (AssertionError e) {
             throw mangledException(e);
         }
@@ -872,7 +871,7 @@ public static<T> void assertContainsAll(
             final FluentIterable<?> fluentIterable = FluentIterable.from(iterable);
 
             for (Object item : items) {
-                assertTrue(fluentIterable.contains(item));
+                Assert.assertTrue(fluentIterable.contains(item));
             }
         } catch (AssertionError e) {
             throw mangledException(e);
@@ -930,7 +929,7 @@ public static<T> void assertSetsEqual(Collection<T> expectedSet, Collection<T> a
                 final Set<T> inActualOnlySet = newHashSet(actualSet);
                 inActualOnlySet.removeAll(expectedSet);
 
-                fail("Sets are not equal.");
+                Assert.fail("Sets are not equal.");
             }
         } catch (AssertionError e) {
             throw mangledException(e);
@@ -1175,7 +1174,7 @@ public static<T> void assertBefore(
             List<T> actualList) {
         try {
             assertObjectNotNull(listName, actualList);
-            assertNotEquals(
+            Assert.assertNotEquals(
                     "Bad test, formerItem and latterItem are equal, listName:<" + listName + '>',
                     formerItem,
                     latterItem);
@@ -1399,8 +1398,8 @@ public static void assertEqualsAndHashCode(String itemNames, Object objectA, Obj
                 Assert.fail("Neither item should be null: <" + objectA + "> <" + objectB + '>');
             }
 
-            assertNotEquals("Neither item should equal new Object()", objectA.equals(new Object()));
-            assertNotEquals("Neither item should equal new Object()", objectB.equals(new Object()));
+            Assert.assertNotEquals("Neither item should equal new Object()", objectA.equals(new Object()));
+            Assert.assertNotEquals("Neither item should equal new Object()", objectB.equals(new Object()));
             Assert.assertEquals("Expected " + itemNames + " to be equal.", objectA, objectA);
             Assert.assertEquals("Expected " + itemNames + " to be equal.", objectB, objectB);
             Assert.assertEquals("Expected " + itemNames + " to be equal.", objectA, objectB);
@@ -1424,6 +1423,7 @@ public static void assertShallowClone(Cloneable object) {
 
     public static void assertShallowClone(String itemName, Cloneable object) {
         try {
+            //noinspection ConfusingArgumentToVarargsMethod
             final Method method = Object.class.getDeclaredMethod("clone", (Class<?>[]) null);
             method.setAccessible(true);
             final Object clone = method.invoke(object);
@@ -1444,7 +1444,7 @@ public static <T> void assertClassNonInstantiable(Class<T> aClass) {
                 Assert.fail("Expected class '" + aClass + "' to be non-instantiable");
             } catch (InstantiationException e) {
                 // pass
-            } catch (IllegalAccessException e) {
+            } catch (IllegalAccessException ignored) {
                 if (canInstantiateThroughReflection(aClass)) {
                     Assert.fail("Expected constructor of non-instantiable class '" + aClass + "' to throw an exception, but didn't");
                 }
@@ -1460,15 +1460,11 @@ private static <T> boolean canInstantiateThroughReflection(Class<T> aClass) {
             declaredConstructor.setAccessible(true);
             declaredConstructor.newInstance();
             return true;
-        } catch (NoSuchMethodException e) {
-            return false;
-        } catch (InvocationTargetException e) {
-            return false;
-        } catch (InstantiationException e) {
-            return false;
-        } catch (IllegalAccessException e) {
-            return false;
-        } catch (AssertionError e) {
+        } catch (NoSuchMethodException |
+                InvocationTargetException |
+                InstantiationException |
+                IllegalAccessException |
+                AssertionError ignored) {
             return false;
         }
     }
diff --git a/testutil/src/main/java/org/spine3/test/package-info.java b/testutil/src/main/java/org/spine3/test/package-info.java
@@ -19,12 +19,9 @@
  */
 
 /**
- * Classes for framework testing.
+ * Utility classes for framework testing.
  */
-@Internal
 @ParametersAreNonnullByDefault
 package org.spine3.test;
 
-import org.spine3.Internal;
-
 import javax.annotation.ParametersAreNonnullByDefault;

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ buildscript {`
`10`	`10`
`11`	`11`	`dependencies {`
`12`	`12`	`compile group: 'io.grpc', name: 'grpc-all', version: '0.13.1'`
	`13`	`+ testCompile project (path: ":testutil", configuration: 'testArtifacts')`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`apply plugin: 'org.spine3.tools.protolookup';`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ option java_package="org.spine3.test";`
`25`	`25`	`option java_multiple_files = true;`
`26`	`26`	`option java_outer_classname = "TestCommands";`
`27`	`27`
	`28`	`+// A test command to run a test by the method name.`
`28`	`29`	`message RunTest {`
`29`	`30`	`string method_name = 1;`
`30`	`31`	`}`