Change ExerciseRunner to return Optional, when not present assumed a compilation error

Author: Ville Heikkinen

tmc-plugin/src/fi/helsinki/cs/tmc/runners/AntExerciseRunner.java

@@ -1,13 +1,8 @@
 package fi.helsinki.cs.tmc.runners;
 
+import com.google.common.base.Optional;
 import fi.helsinki.cs.tmc.data.Exercise;
 import fi.helsinki.cs.tmc.data.TestRunResult;
-<<<<<<< HEAD
-=======
-import fi.helsinki.cs.tmc.langs.TestResult;
-import fi.helsinki.cs.tmc.langs.util.TaskExecutor;
-import fi.helsinki.cs.tmc.langs.util.TaskExecutorImpl;
->>>>>>> 7e632d9... Initial refactoring, ant testrunning reworked
 import fi.helsinki.cs.tmc.model.TmcProjectInfo;
 import fi.helsinki.cs.tmc.model.UserVisibleException;
 import fi.helsinki.cs.tmc.testscanner.TestMethod;
@@ -23,7 +18,6 @@
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
-import java.util.concurrent.FutureTask;
 import java.util.logging.Level;
 import static java.util.logging.Level.INFO;
 import java.util.logging.Logger;
@@ -41,11 +35,10 @@ public class AntExerciseRunner extends AbstractJavaExerciseRunner {
     private static final Logger log = Logger.getLogger(AntExerciseRunner.class.getName());
 
     @Override
-    public Callable<TestRunResult> getTestRunningTask(final TmcProjectInfo projectInfo) {
-        return new Callable<TestRunResult>() {
-
+    public Callable<Optional<TestRunResult>> getTestRunningTask(final TmcProjectInfo projectInfo) {
+        return new Callable<Optional<TestRunResult>>() {
             @Override
-            public TestRunResult call() throws Exception {
+            public Optional<TestRunResult> call() throws Exception {
 
                 log.log(INFO,
                         "Starting compile");
@@ -69,10 +62,10 @@ public TestRunResult call() throws Exception {
 
                 int compileResult = task.result();
                 if (compileResult == 0) {
-                    log.log(INFO, "Compile resulted in 0");
-                    return runTests(projectInfo);
+                    log.log(INFO, "Compile success for project {0}", projectInfo.toString());
+                    return Optional.of(runTests(projectInfo));
                 } else {
-                    return null;
+                    return Optional.absent();
                 }
             }
         };

tmc-plugin/src/fi/helsinki/cs/tmc/runners/ExerciseRunner.java

@@ -1,9 +1,16 @@
 package fi.helsinki.cs.tmc.runners;
 
+import com.google.common.base.Optional;
 import fi.helsinki.cs.tmc.data.TestRunResult;
 import fi.helsinki.cs.tmc.model.TmcProjectInfo;
 import java.util.concurrent.Callable;
 
+/**
+ * ExerciseRunner for implementing runner tasks
+ * Using Optional as a container for the result itself, if TestRunResult is not present
+ * compilation failure should be assumed.
+ *  
+ */
 public interface ExerciseRunner {
-    public abstract Callable<TestRunResult> getTestRunningTask(TmcProjectInfo projectInfo);
+    public abstract Callable<Optional<TestRunResult>> getTestRunningTask(TmcProjectInfo projectInfo);
 }

tmc-plugin/src/fi/helsinki/cs/tmc/runners/TestRunHandler.java

@@ -1,5 +1,6 @@
 package fi.helsinki.cs.tmc.runners;
 
+import com.google.common.base.Optional;
 import fi.helsinki.cs.tmc.data.Exercise;
 import fi.helsinki.cs.tmc.data.ResultCollector;
 import fi.helsinki.cs.tmc.data.TestRunResult;
@@ -33,12 +34,12 @@ public InvokedEvent(TmcProjectInfo projectInfo) {
         }
     }
 
-    private ProjectMediator projectMediator;
-    private ConvenientDialogDisplayer dialogDisplayer;
-    private TmcEventBus eventBus;
-    private TestResultDisplayer resultDisplayer;
-    private ExerciseSubmitter exerciseSubmitter;
-    private CourseDb courseDb;
+    private final ProjectMediator projectMediator;
+    private final ConvenientDialogDisplayer dialogDisplayer;
+    private final TmcEventBus eventBus;
+    private final TestResultDisplayer resultDisplayer;
+    private final ExerciseSubmitter exerciseSubmitter;
+    private final CourseDb courseDb;
 
     public TestRunHandler() {
         this.projectMediator = ProjectMediator.getInstance();
@@ -55,17 +56,16 @@ public void performAction(final ResultCollector resultCollector, Project... proj
             final TmcProjectInfo projectInfo = projectMediator.wrapProject(project);
             eventBus.post(new InvokedEvent(projectInfo));
             final ExerciseRunner runner = getRunner(projectInfo);
-            BgTask.start("Running tests", runner.getTestRunningTask(projectInfo), new BgTaskListener<TestRunResult>() {
+            BgTask.start("Running tests", runner.getTestRunningTask(projectInfo), new BgTaskListener<Optional<TestRunResult>>() {
                 @Override
-                public void bgTaskReady(TestRunResult result) {
-                    if (result == null) {
+                public void bgTaskReady(Optional<TestRunResult> result) {
+                    if (!result.isPresent()) {
                         dialogDisplayer.displayError("The code did not compile.");
                         return;
-
                     }
                     Exercise ex = projectMediator.tryGetExerciseForProject(projectInfo, courseDb);
                     boolean canSubmit = ex.isReturnable();
-                    resultDisplayer.showLocalRunResult(result.getTestCaseResults(), canSubmit, new Runnable() {
+                    resultDisplayer.showLocalRunResult(result.get().getTestCaseResults(), canSubmit, new Runnable() {
                         @Override
                         public void run() {
                             exerciseSubmitter.performAction(projectInfo.getProject());
@@ -75,7 +75,7 @@ public void run() {
 
                 @Override
                 public void bgTaskFailed(Throwable ex) {
-                    log.log(INFO, "performAction failed message: {0}, trace: {1}",
+                    log.log(INFO, "performAction of TestRunHandler failed with message: {0}, trace: {1}",
                             new Object[]{ex.getMessage(), Arrays.deepToString(ex.getStackTrace())});
                     dialogDisplayer.displayError("Failed to run the tests: " + ex.getMessage());
                 }