Moved serialization core to its own package; added tests for SerializerCore

cogmission · cogmission · commit 3c3d36ab1c46 · 2016-04-14T11:38:27.000-05:00
diff --git a/src/main/java/org/numenta/nupic/Persistable.java b/src/main/java/org/numenta/nupic/Persistable.java
@@ -25,7 +25,7 @@ public interface Persistable extends Serializable {
      * reified.
      */
     @SuppressWarnings("unchecked")
-    public default <T> T postDeSerialize() { return (T)this; }
+    public default <T> T postDeSerialize() { return postDeSerialize((T)this); }
     /**
      * <em>FOR INTERNAL USE ONLY</em><p>
      * Called to implement a full or partial copy of an object 
@@ -34,6 +34,6 @@ public interface Persistable extends Serializable {
      * @param t     the instance of type &lt;T&gt;
      * @return  a post serialized custom form of T
      */
-    public default <T> T postSerialize(T t) { return t; }
+    public default <T> T postDeSerialize(T t) { return t; }
     
 }
diff --git a/src/main/java/org/numenta/nupic/network/Layer.java b/src/main/java/org/numenta/nupic/network/Layer.java
@@ -323,7 +323,7 @@ public Layer<T> postDeSerialize() {
         
         FunctionFactory old = factory;
         factory = new FunctionFactory();
-        factory.inference = old.inference.postSerialize(old.inference);
+        factory.inference = old.inference.postDeSerialize(old.inference);
         
         checkPointOpObservers = new ArrayList<>();
         
diff --git a/src/main/java/org/numenta/nupic/network/ManualInput.java b/src/main/java/org/numenta/nupic/network/ManualInput.java
@@ -102,7 +102,7 @@ public ManualInput() {}
      */
     @SuppressWarnings("unchecked")
     @Override
-    public <T> T postSerialize(T manualInput) {
+    public <T> T postDeSerialize(T manualInput) {
         ManualInput mi = (ManualInput)manualInput;
         
         ManualInput retVal = new ManualInput();
@@ -517,7 +517,7 @@ public boolean equals(Object obj) {
             return true;
         if(obj == null)
             return false;
-        if(getClass() != obj.getClass())
+        if(!Inference.class.isAssignableFrom(obj.getClass()))
             return false;
         ManualInput other = (ManualInput)obj;
         if(activeCells == null) {
diff --git a/src/main/java/org/numenta/nupic/network/Persistence.java b/src/main/java/org/numenta/nupic/network/Persistence.java
@@ -39,6 +39,8 @@
 import org.joda.time.format.DateTimeFormat;
 import org.joda.time.format.DateTimeFormatter;
 import org.numenta.nupic.Persistable;
+import org.numenta.nupic.serialize.SerialConfig;
+import org.numenta.nupic.serialize.SerializerCore;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
diff --git a/src/main/java/org/numenta/nupic/network/PersistenceAPI.java b/src/main/java/org/numenta/nupic/network/PersistenceAPI.java
@@ -26,6 +26,8 @@
 import java.util.List;
 
 import org.numenta.nupic.Persistable;
+import org.numenta.nupic.serialize.SerialConfig;
+import org.numenta.nupic.serialize.SerializerCore;
 
 /**
  * <p>
diff --git a/src/main/java/org/numenta/nupic/serialize/HTMObjectInput.java b/src/main/java/org/numenta/nupic/serialize/HTMObjectInput.java
@@ -0,0 +1,27 @@
+package org.numenta.nupic.serialize;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.numenta.nupic.Persistable;
+import org.nustaq.serialization.FSTObjectInput;
+
+public class HTMObjectInput extends FSTObjectInput {
+    public HTMObjectInput(InputStream in) throws IOException {
+        super(in);
+    }
+    
+    @SuppressWarnings("rawtypes")
+    public Object readObject(Class...classes) throws Exception {
+        try {
+            Object obj = super.readObject(classes);
+            
+            if(obj instanceof Persistable) {
+                ((Persistable) obj).postDeSerialize();
+            }
+            return obj;
+        }catch(Exception e) {
+            throw new IOException(e);
+        }
+    }
+}
diff --git a/src/main/java/org/numenta/nupic/serialize/HTMObjectOutput.java b/src/main/java/org/numenta/nupic/serialize/HTMObjectOutput.java
@@ -0,0 +1,22 @@
+package org.numenta.nupic.serialize;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+import org.numenta.nupic.Persistable;
+import org.nustaq.serialization.FSTObjectOutput;
+
+public class HTMObjectOutput extends FSTObjectOutput {
+    public HTMObjectOutput(OutputStream out) {
+        super(out);
+    }
+    
+    @SuppressWarnings("rawtypes")
+    public void writeObject(Object t, Class... c) throws IOException {
+        if(t instanceof Persistable) {
+            ((Persistable) t).preSerialize();
+        }
+        
+        super.writeObject(t, c);
+    }
+}
diff --git a/src/main/java/org/numenta/nupic/serialize/SerialConfig.java b/src/main/java/org/numenta/nupic/serialize/SerialConfig.java
@@ -19,7 +19,7 @@
  * http://numenta.org/licenses/
  * ---------------------------------------------------------------------
  */
-package org.numenta.nupic.network;
+package org.numenta.nupic.serialize;
 
 
 import java.io.File;
@@ -42,6 +42,12 @@
 import org.numenta.nupic.model.ProximalDendrite;
 import org.numenta.nupic.model.Segment;
 import org.numenta.nupic.model.Synapse;
+import org.numenta.nupic.network.Inference;
+import org.numenta.nupic.network.Layer;
+import org.numenta.nupic.network.ManualInput;
+import org.numenta.nupic.network.Network;
+import org.numenta.nupic.network.NetworkTest;
+import org.numenta.nupic.network.Region;
 import org.numenta.nupic.util.NamedTuple;
 import org.numenta.nupic.util.Tuple;
 import org.slf4j.Logger;
diff --git a/src/main/java/org/numenta/nupic/serialize/SerializerCore.java b/src/main/java/org/numenta/nupic/serialize/SerializerCore.java
@@ -19,17 +19,16 @@
  * http://numenta.org/licenses/
  * ---------------------------------------------------------------------
  */
-package org.numenta.nupic.network;
+package org.numenta.nupic.serialize;
 
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.ObjectInputStream;
 import java.io.OutputStream;
 
 import org.numenta.nupic.Persistable;
+import org.numenta.nupic.network.PersistenceAPI;
 import org.nustaq.serialization.FSTConfiguration;
-import org.nustaq.serialization.FSTObjectInput;
-import org.nustaq.serialization.FSTObjectOutput;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -147,38 +146,11 @@ public <T extends Persistable> T deSerialize(byte[] bytes) {
         return retVal.postDeSerialize();
     }
     
-    public static class HTMObjectInput extends FSTObjectInput {
-        public HTMObjectInput(InputStream in) throws IOException {
-            super(in);
-        }
-        
-        @SuppressWarnings("rawtypes")
-        public Object readObject(Class...classes) throws Exception {
-            try {
-                Object obj = super.readObject(classes);
-                
-                if(obj instanceof Persistable) {
-                    ((Persistable) obj).postDeSerialize();
-                }
-                return obj;
-            }catch(Exception e) {
-                throw new IOException(e);
-            }
-        }
-    }
-    
-    public static class HTMObjectOutput extends FSTObjectOutput {
-        public HTMObjectOutput(OutputStream out) {
-            super(out);
-        }
-        
-        @SuppressWarnings("rawtypes")
-        public void writeObject(Object t, Class... c) throws IOException {
-            if(t instanceof Persistable) {
-                ((Persistable) t).preSerialize();
-            }
-            
-            super.writeObject(t, c);
-        }
+    /**
+     * For testing only!
+     * @return
+     */
+    FSTConfiguration getSerialScheme() {
+        return fastSerialConfig;
     }
 }
diff --git a/src/test/java/org/numenta/nupic/network/PersistenceAPITest.java b/src/test/java/org/numenta/nupic/network/PersistenceAPITest.java
@@ -80,6 +80,7 @@
 import org.numenta.nupic.network.sensor.Sensor;
 import org.numenta.nupic.network.sensor.SensorParams;
 import org.numenta.nupic.network.sensor.SensorParams.Keys;
+import org.numenta.nupic.serialize.SerialConfig;
 import org.numenta.nupic.util.ArrayUtils;
 import org.numenta.nupic.util.Condition;
 import org.numenta.nupic.util.FastRandom;
diff --git a/src/test/java/org/numenta/nupic/network/PlaygroundTest.java b/src/test/java/org/numenta/nupic/network/PlaygroundTest.java
@@ -21,6 +21,9 @@
  */
 package org.numenta.nupic.network;
 
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
 import java.math.BigDecimal;
 import java.math.RoundingMode;
 import java.util.Arrays;
@@ -39,6 +42,7 @@
 import org.numenta.nupic.network.sensor.Sensor;
 import org.numenta.nupic.network.sensor.SensorParams;
 import org.numenta.nupic.network.sensor.SensorParams.Keys;
+import org.numenta.nupic.serialize.HTMObjectInput;
 import org.numenta.nupic.util.FastRandom;
 
 import rx.Observer;
@@ -187,4 +191,16 @@ private String stringValue(Double valueIndex) {
         }
         return recordOut;
     }
+    
+    public <T> T main(String[] args) throws Exception {
+        InputStream input = new FileInputStream(new File("myfile"));
+        //HTMObjectInput reader = Persistence.get().serializer().getObjectInput(input);
+        try (HTMObjectInput reader = Persistence.get().serializer().getObjectInput(input)) {
+            Class<?> aClass = null;//...  // Persistable subclass
+            T t = (T) reader.readObject(aClass); // Where T is the Persistable subclass type (HTM.java object).
+            return t;
+        } catch(Exception e) {
+            throw e;
+        }
+    }
 }
diff --git a/src/test/java/org/numenta/nupic/network/SerializerCoreTest.java b/src/test/java/org/numenta/nupic/network/SerializerCoreTest.java
diff --git a/src/test/java/org/numenta/nupic/serialize/SerializerCoreTest.java b/src/test/java/org/numenta/nupic/serialize/SerializerCoreTest.java
@@ -0,0 +1,112 @@
+package org.numenta.nupic.serialize;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.Serializable;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.junit.Test;
+import org.numenta.nupic.network.Inference;
+import org.numenta.nupic.network.ManualInput;
+import org.numenta.nupic.network.Persistence;
+
+
+@SuppressWarnings("serial")
+public class SerializerCoreTest implements Serializable {
+
+    @Test
+    public void testGetSerializer() {
+        SerializerCore serializer = Persistence.get().serializer();
+        assertNotNull(serializer);
+        
+        SerializerCore  serializer2 = Persistence.get().serializer();
+        assertTrue(serializer == serializer2);
+    }
+
+    /**
+     * Test HTM wrapper can be created and passes through to underlying implementation.
+     */
+    @Test
+    public void testGetObjectInput() {
+        try {
+            HTMObjectInput input = Persistence.get().serializer().getObjectInput(new InputStream() {
+                @Override public int read() throws IOException {
+                    return 0;
+                }
+            });
+            
+            assertNotNull(input);
+            assertEquals(0, input.read());
+        } catch(IOException e) {
+            e.printStackTrace();
+            fail();
+        }
+    }
+    
+    /**
+     * Test HTM wrapper can be created and passes through to underlying implementation.
+     */
+    @Test
+    public void testGetObjectOutput() {
+        try {
+            HTMObjectOutput output = Persistence.get().serializer().getObjectOutput(new OutputStream() {
+                @Override public void write(int b) throws IOException {
+                    
+                }
+            });
+            
+            assertNotNull(output);
+            output.write(0);
+        } catch(IOException e) {
+            e.printStackTrace();
+            fail();
+        }
+    }
+    
+    @Test
+    public void testSerializeDeSerialize() {
+        final List<Inference> callVerify = new ArrayList<>();
+        
+        SerializerCore serializer = Persistence.get().serializer();
+        
+        Inference inf = new ManualInput() {
+            @SuppressWarnings("unchecked")
+            @Override
+            public <T> T postDeSerialize(T i) {
+                Inference retVal = (Inference)super.postDeSerialize(i);
+                assertNotNull(retVal);
+                assertTrue(retVal != i); // Ensure Objects not same
+                assertTrue(retVal.equals(i)); // However they are still equal!
+                callVerify.add(retVal);
+                assertTrue(callVerify.size() == 1);
+                
+                return (T)retVal;
+            }
+        };
+        
+        byte[] bytes = serializer.serialize(inf);
+        assertNotNull(bytes);
+        
+        Inference serializedInf = serializer.deSerialize(bytes);
+        assertNotNull(serializedInf);
+    }
+    
+    @Test
+    public void testRegisterClass() {
+        SerializerCore serializer = Persistence.get().serializer();
+        int val = serializer.getSerialScheme().getClassRegistry().getIdFromClazz(SerializerCoreTest.class);
+        assertEquals(Integer.MIN_VALUE, val);
+        
+        serializer.registerClass(SerializerCoreTest.class);
+        int val2 = serializer.getSerialScheme().getClassRegistry().getIdFromClazz(SerializerCoreTest.class);
+        assertNotEquals(Integer.MIN_VALUE, val2);
+    }
+}
diff --git a/src/test/java/org/numenta/nupic/util/FastRandomSerializationTest.java b/src/test/java/org/numenta/nupic/util/FastRandomSerializationTest.java
@@ -8,7 +8,7 @@
 import org.junit.Test;
 import org.numenta.nupic.network.Persistence;
 import org.numenta.nupic.network.PersistenceAPI;
-import org.numenta.nupic.network.SerialConfig;
+import org.numenta.nupic.serialize.SerialConfig;
 
 
 public class FastRandomSerializationTest {
