Test is now prettied up with comments and reformated correctly. Now alters project settings correctly and actually tests relevant items (number of steps in pipeline, number of sources in pipeline after project is opened).

This closes issue #316.

Author: PaulaRudy

core/src/test/java/edu/wpi/grip/core/serialization/CompatibilityTest.java

@@ -1,14 +1,13 @@
 package edu.wpi.grip.core.serialization;
 
 import com.google.common.eventbus.EventBus;
-import com.google.common.eventbus.Subscribe;
 import com.google.inject.Guice;
 import com.google.inject.Injector;
 import com.google.inject.Key;
 import com.google.inject.TypeLiteral;
 import edu.wpi.grip.core.*;
-import edu.wpi.grip.core.events.OperationAddedEvent;
 import edu.wpi.grip.core.operations.Operations;
+import edu.wpi.grip.core.settings.ProjectSettings;
 import edu.wpi.grip.core.sources.ImageFileSource;
 import edu.wpi.grip.generated.CVOperations;
 import edu.wpi.grip.util.Files;
@@ -22,29 +21,26 @@
 
 import static junit.framework.TestCase.assertEquals;
 
+/**
+ * This tests for backwards compatibility by opening a project file containing ALL the steps of GRIP
+ * at the time of this file's creation.
+ */
 public class CompatibilityTest {
 
-    private static final URI testphotoURI = Files.testphotoURI;
-    private static final URI testprojectURI = Files.testprojectURI;
+    private static final URI testphotoURI = Files.testphotoURI; //The location of the photo source for the test
+    private static final URI testprojectURI = Files.testprojectURI; //The location of the save file for the test
 
     private Connection.Factory<Object> connectionFactory;
     private ImageFileSource.Factory imageSourceFactory;
     private Step.Factory stepFactory;
     private Pipeline pipeline;
     private Project project;
-
+    private ProjectSettings settings;
 
     private List<Operation> operationList;
     private Optional<Throwable> throwableOptional;
     private EventBus eventBus;
 
-    private class OperationGrabber {
-        @Subscribe
-        public void onOperationAddedEvent(OperationAddedEvent event) {
-            operationList.add(event.getOperation());
-        }
-    }
-
     @Before
     public void setUp() throws Exception {
 
@@ -58,15 +54,18 @@ public void setUp() throws Exception {
         eventBus = injector.getInstance(EventBus.class);
         pipeline = injector.getInstance(Pipeline.class);
         project = injector.getInstance(Project.class);
+        settings = injector.getInstance(ProjectSettings.class);
         stepFactory = injector.getInstance(Step.Factory.class);
 
+        //Add the operations so that GRIP will recognize them
         Operations.addOperations(eventBus);
         CVOperations.addOperations(eventBus);
 
         //Set up the test project file to work with this machine
         String fileName = testprojectURI.toString().substring(5);
         String photoFileName = testphotoURI.toString().substring(5);
 
+        //Open the project save file and read it into a string so that we can alter it
         File file = new File(fileName);
 
         Reader temp = new FileReader(file);
@@ -76,11 +75,19 @@ public void setUp() throws Exception {
             oldtext += line + "\r\n";
         }
         reader.close();
-        String newtext = oldtext.replaceAll("REPLACEME", photoFileName);
-
-        //TODO: replace "preferences" section to work with this machine
+        String newtext = oldtext.replaceAll("REPLACEME", photoFileName);//This gives the correct location of the test photo needed to the project file
+        //The following alters the project settings in the project file to the defaults given in the "settings" variable
+        newtext = newtext.replaceAll("<teamNumber>.*</teamNumber>", "<teamNumber>" + settings.getTeamNumber() + "</teamNumber>");
+        newtext = newtext.replaceAll("<publishAddress>.*</publishAddress>", "<publishAddress>" + settings.getPublishAddress() + "</publishAddress>");
+        newtext = newtext.replaceAll("<deployAddress>.*</deployAddress>", "<deployAddress>" + settings.getDeployAddress() + "</deployAddress>");
+        newtext = newtext.replaceAll("<deployDir>.*</deployDir>", "<deployDir>" + settings.getDeployDir() + "</deployDir>");
+        newtext = newtext.replaceAll("<deployUser>.*</deployUser>", "<deployUser>" + settings.getDeployUser() + "</deployUser>");
+        newtext = newtext.replaceAll("<deployJavaHome>.*</deployJavaHome>", "<deployJavaHome>" + settings.getDeployJavaHome() + "</deployJavaHome>");
+
+        //Write the altered project file text
         FileWriter writer2 = new FileWriter(file);
         writer2.write(newtext);
+
         writer2.close();
 
         //Open the test file as a project
@@ -89,8 +96,7 @@ public void setUp() throws Exception {
 
     @Test
     public void testFoo() throws Exception {
-
-        assertEquals("blarg", 3, 3);
-
+        assertEquals("The expected number of steps were not found", 50, pipeline.getSteps().size());
+        assertEquals("The expected number of sources were not found", 2, pipeline.getSources().size());
     }
 }