[feature] callback mechanism for passing intermediate results (#46)

SpoonLabs · Apr 1, 2019 · 214ed3d · 214ed3d
1 parent ec9bda1
commit 214ed3d
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 33 deletions.
diff --git a/src/main/java/fr/inria/coming/core/engine/RevisionNavigationExperiment.java b/src/main/java/fr/inria/coming/core/engine/RevisionNavigationExperiment.java
@@ -6,6 +6,7 @@
 
 import fr.inria.coming.changeminer.entity.FinalResult;
 import fr.inria.coming.changeminer.entity.IRevision;
+import fr.inria.coming.core.engine.callback.IntermediateResultProcessorCallback;
 import fr.inria.coming.core.entities.AnalysisResult;
 import fr.inria.coming.core.entities.RevisionDataset;
 import fr.inria.coming.core.entities.RevisionResult;
@@ -25,6 +26,7 @@ public abstract class RevisionNavigationExperiment<R extends IRevision> {
 	protected List<Analyzer> analyzers = new ArrayList<>();
 	protected List<IFilter> filters = null;
 	protected List<IOutput> outputProcessors = new ArrayList<>();
+	protected IntermediateResultProcessorCallback intermediateCallback = null;
 
 	protected FinalResult<R> allResults = null;
 
@@ -58,6 +60,10 @@ public void setAnalyzers(List<Analyzer> analyzers) {
 	@SuppressWarnings("unchecked")
 	public void processEndRevision(R element, RevisionResult resultAllAnalyzed) {
 
+		if (this.intermediateCallback != null) {
+			this.intermediateCallback.handleResult(resultAllAnalyzed);
+		}
+
 		if (ComingProperties.getPropertyBoolean("save_result_revision_analysis")) {
 			allResults.put(element, resultAllAnalyzed);
 		}
@@ -149,4 +155,12 @@ public void setOutputProcessors(List<IOutput> outputProcessors) {
 		this.outputProcessors = outputProcessors;
 	}
 
+	public IntermediateResultProcessorCallback getIntermediateCallback() {
+		return intermediateCallback;
+	}
+
+	public void setIntermediateCallback(IntermediateResultProcessorCallback intermediateCallback) {
+		this.intermediateCallback = intermediateCallback;
+	}
+
 }
diff --git a/src/main/java/fr/inria/coming/core/engine/callback/IntermediateResultProcessorCallback.java b/src/main/java/fr/inria/coming/core/engine/callback/IntermediateResultProcessorCallback.java
@@ -0,0 +1,14 @@
+package fr.inria.coming.core.engine.callback;
+
+import fr.inria.coming.core.entities.RevisionResult;
+
+/**
+ * 
+ * @author Matias Martinez
+ *
+ */
+public interface IntermediateResultProcessorCallback {
+
+	public void handleResult(RevisionResult result);
+
+}
diff --git a/src/main/java/fr/inria/coming/main/ComingMain.java b/src/main/java/fr/inria/coming/main/ComingMain.java
@@ -11,6 +11,7 @@
 import org.apache.commons.cli.HelpFormatter;
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
 import org.apache.commons.cli.UnrecognizedOptionException;
 import org.apache.log4j.Logger;
 
@@ -27,6 +28,7 @@
 import fr.inria.coming.codefeatures.FeatureAnalyzer;
 import fr.inria.coming.core.engine.Analyzer;
 import fr.inria.coming.core.engine.RevisionNavigationExperiment;
+import fr.inria.coming.core.engine.callback.IntermediateResultProcessorCallback;
 import fr.inria.coming.core.engine.files.FileNavigationExperiment;
 import fr.inria.coming.core.engine.git.GITRepositoryInspector;
 import fr.inria.coming.core.entities.interfaces.IFilter;
@@ -101,24 +103,41 @@ public static void main(String[] args) {
 		}
 	}
 
-	RevisionNavigationExperiment<?> experiment = null;
+	RevisionNavigationExperiment<?> navigatorEngine = null;
 
 	@SuppressWarnings("rawtypes")
 	public FinalResult run(String[] args) throws Exception {
 
+		boolean created = createEngine(args);
+		if (!created)
+			return null;
+
+		return start();
+	}
+
+	public FinalResult start() {
+		if (navigatorEngine == null)
+			throw new IllegalAccessError("error: initialize the engine first");
+
+		FinalResult result = navigatorEngine.analyze();
+
+		return result;
+	}
+
+	public boolean createEngine(String[] args) throws ParseException {
 		ComingProperties.reset();
 		CommandLine cmd = null;
-		this.experiment = null;
+		this.navigatorEngine = null;
 		try {
 			cmd = parser.parse(options, args);
 		} catch (UnrecognizedOptionException e) {
 			System.out.println("Error: " + e.getMessage());
 			help();
-			return null;
+			return false;
 		}
 		if (cmd.hasOption("help")) {
 			help();
-			return null;
+			return false;
 		}
 
 		if (cmd.hasOption("showactions")) {
@@ -128,7 +147,7 @@ public FinalResult run(String[] args) throws Exception {
 				System.out.println(a);
 			}
 			System.out.println("---");
-			return null;
+			return false;
 		}
 
 		if (cmd.hasOption("showentities")) {
@@ -139,7 +158,7 @@ public FinalResult run(String[] args) throws Exception {
 				System.out.println(et);
 			}
 			System.out.println("---");
-			return null;
+			return false;
 		}
 		for (Option option : cmd.getOptions()) {
 
@@ -152,7 +171,7 @@ public FinalResult run(String[] args) throws Exception {
 
 		if (cmd.hasOption("parameters")) {
 			String[] pars = cmd.getOptionValue("parameters").split(":");
-			if (pars.length % 2 != 0){
+			if (pars.length % 2 != 0) {
 				throw new RuntimeException("The number of input parameters must be even.");
 			}
 
@@ -176,33 +195,30 @@ public FinalResult run(String[] args) throws Exception {
 
 		loadOutput();
 
-		// EXECUTION:
-		FinalResult result = experiment.analyze();
-
-		return result;
+		return true;
 	}
 
 	private void loadFilters() {
-		experiment.setFilters(createFilters());
+		navigatorEngine.setFilters(createFilters());
 	}
 
 	private void loadOutput() {
 		String outputs = ComingProperties.getProperty("outputprocessor");
 		if (outputs == null) {
-			experiment.getOutputProcessors().add(0, new StdOutput());
+			navigatorEngine.getOutputProcessors().add(0, new StdOutput());
 		} else {
 			loadOutputProcessors(outputs);
 		}
 	}
 
 	private void loadInput(String input) {
 		if (input == null || input.equals("git")) {
-			experiment = new GITRepositoryInspector();
+			navigatorEngine = new GITRepositoryInspector();
 		} else if (input.equals("files")) {
-			experiment = new FileNavigationExperiment();
+			navigatorEngine = new FileNavigationExperiment();
 		} else {
 			// extension point
-			experiment = loadInputEngine(input);
+			navigatorEngine = loadInputEngine(input);
 		}
 	}
 
@@ -213,25 +229,25 @@ private void loadModelAnalyzers(String modes) {
 		for (String mode : modesp) {
 
 			if ("diff".equals(mode)) {
-				experiment.getAnalyzers().clear();
-				experiment.getAnalyzers().add(new FineGrainDifftAnalyzer());
-				experiment.getOutputProcessors().add(new JSonChangeFrequencyOutput());
+				navigatorEngine.getAnalyzers().clear();
+				navigatorEngine.getAnalyzers().add(new FineGrainDifftAnalyzer());
+				navigatorEngine.getOutputProcessors().add(new JSonChangeFrequencyOutput());
 			} else if ("mineinstance".equals(mode)) {
-				experiment.getAnalyzers().clear();
-				experiment.getAnalyzers().add(new FineGrainDifftAnalyzer());
+				navigatorEngine.getAnalyzers().clear();
+				navigatorEngine.getAnalyzers().add(new FineGrainDifftAnalyzer());
 
 				ChangePatternSpecification pattern = loadPattern();
-				experiment.getAnalyzers().add(new PatternInstanceAnalyzer(pattern));
+				navigatorEngine.getAnalyzers().add(new PatternInstanceAnalyzer(pattern));
 
 				// By default JSON output of pattern instances
-				experiment.getOutputProcessors().add(new JSonPatternInstanceOutput());
+				navigatorEngine.getOutputProcessors().add(new JSonPatternInstanceOutput());
 
 			} else if ("features".equals(mode)) {
-				experiment.getAnalyzers().clear();
-				experiment.getAnalyzers().add(new FineGrainDifftAnalyzer());
-				experiment.getAnalyzers().add(new FeatureAnalyzer());
+				navigatorEngine.getAnalyzers().clear();
+				navigatorEngine.getAnalyzers().add(new FineGrainDifftAnalyzer());
+				navigatorEngine.getAnalyzers().add(new FeatureAnalyzer());
 
-				experiment.getOutputProcessors().add(new FeaturesOutput());
+				navigatorEngine.getOutputProcessors().add(new FeaturesOutput());
 
 			} else {
 				// LOAD Analyzers from command
@@ -241,15 +257,15 @@ private void loadModelAnalyzers(String modes) {
 		}
 
 		if (ComingProperties.getPropertyBoolean("hunkanalysis")) {
-			experiment.getAnalyzers().add(0, new HunkDifftAnalyzer());
+			navigatorEngine.getAnalyzers().add(0, new HunkDifftAnalyzer());
 		}
 	}
 
 	private void loadAnalyzersFromCommand(String mode) {
 		try {
 			Object analyzerLoaded = PlugInLoader.loadPlugin(mode, Analyzer.class);
 			if (analyzerLoaded != null) {
-				experiment.getAnalyzers().add((Analyzer) analyzerLoaded);
+				navigatorEngine.getAnalyzers().add((Analyzer) analyzerLoaded);
 			}
 		} catch (Exception e) {
 			e.printStackTrace();
@@ -263,11 +279,11 @@ private void loadOutputProcessors(String output) {
 		for (String singlefoutput : outputs) {
 			try {
 				if (singlefoutput.equals("changefrequency")) {
-					experiment.getOutputProcessors().add(new JSonChangeFrequencyOutput());
+					navigatorEngine.getOutputProcessors().add(new JSonChangeFrequencyOutput());
 				} else {
 					Object outLoaded = PlugInLoader.loadPlugin(singlefoutput, IOutput.class);
 					if (outLoaded != null) {
-						experiment.getOutputProcessors().add((IOutput) outLoaded);
+						navigatorEngine.getOutputProcessors().add((IOutput) outLoaded);
 					}
 				}
 			} catch (Exception e) {
@@ -408,11 +424,17 @@ private static void help() {
 	}
 
 	public RevisionNavigationExperiment<?> getExperiment() {
-		return experiment;
+		return navigatorEngine;
 	}
 
 	public void setExperiment(RevisionNavigationExperiment<?> experiment) {
-		this.experiment = experiment;
+		this.navigatorEngine = experiment;
 	}
 
+	public void registerIntermediateCallback(IntermediateResultProcessorCallback callback) {
+		if (this.navigatorEngine == null)
+			throw new IllegalStateException("Please, initialize the engine first");
+
+		this.navigatorEngine.setIntermediateCallback(callback);
+	}
 }
diff --git a/src/test/java/fr/inria/coming/spoon/core/MainComingTest.java b/src/test/java/fr/inria/coming/spoon/core/MainComingTest.java
@@ -25,6 +25,7 @@
 import fr.inria.coming.changeminer.entity.CommitFinalResult;
 import fr.inria.coming.changeminer.entity.FinalResult;
 import fr.inria.coming.changeminer.entity.IRevision;
+import fr.inria.coming.core.engine.callback.IntermediateResultProcessorCallback;
 import fr.inria.coming.core.entities.DiffResult;
 import fr.inria.coming.core.entities.HunkDiff;
 import fr.inria.coming.core.entities.RevisionResult;
@@ -164,6 +165,33 @@ public void testOrderOutput() throws Exception {
 
 	}
 
+	@SuppressWarnings("unchecked")
+	@Test
+	public void testIntermediateCallback1() throws Exception {
+		ComingMain cm = new ComingMain();
+		Boolean created = cm.createEngine(new String[] { "-location", "repogit4testv0", "-hunkanalysis", "true" });
+		assertTrue(created);
+		List<String> commitsInOrder = new ArrayList<>();
+		for (String commit : this.commitsId) {
+			commitsInOrder.add(commit);
+		}
+		cm.registerIntermediateCallback(new IntermediateResultProcessorCallback() {
+			int currentIndex = 0;
+
+			@Override
+			public void handleResult(RevisionResult result) {
+				assertEquals(currentIndex, commitsInOrder.indexOf(result.getRelatedRevision().getName()));
+				System.out.println("callback " + currentIndex);
+				currentIndex++;
+
+			}
+		});
+		// Start the analysis
+		FinalResult finalresult = cm.start();
+		assertNotNull(finalresult);
+
+	}
+
 	@SuppressWarnings("unchecked")
 	@Test
 	public void testAssertCommitRemovedFile() throws Exception {