Evaluation code for #178.

Author: khatchad

README.md

@@ -41,10 +41,17 @@ You should have the following projects in your workspace:
 
 ### Running the Evaluator
 
-[annotations]: https://github.com/ponder-lab/edu.cuny.hunter.streamrefactoring.annotations
+#### Configuring the Evaluation
+
+A file named `eval.properties` can be placed at the project root. The following keys are available:
+
+Key              | Value Type | Description
+---------------- | ---------- | ----------
+nToUseForStreams | Integer    | The value of N to use while building the nCFA for stream types.
 
 ### Further Information
 
 See the [wiki][wiki] for further information.
 
 [wiki]: https://github.com/ponder-lab/Java-8-Stream-Refactoring/wiki
+[annotations]: https://github.com/ponder-lab/edu.cuny.hunter.streamrefactoring.annotations

edu.cuny.hunter.streamrefactoring.eval/src/edu/cuny/hunter/streamrefactoring/eval/handlers/EvaluateConvertToParallelStreamRefactoringHandler.java

@@ -1,10 +1,14 @@
 package edu.cuny.hunter.streamrefactoring.eval.handlers;
 
+import static edu.cuny.hunter.streamrefactoring.core.utils.LoggerNames.LOGGER_NAME;
 import static edu.cuny.hunter.streamrefactoring.core.utils.Util.createConvertToParallelStreamRefactoringProcessor;
 
+import java.io.File;
+import java.io.FileReader;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.PrintWriter;
+import java.io.Reader;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -13,7 +17,9 @@
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.Properties;
 import java.util.Set;
+import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 import org.apache.commons.csv.CSVFormat;
@@ -24,6 +30,7 @@
 import org.eclipse.core.resources.IncrementalProjectBuilder;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.NullProgressMonitor;
@@ -74,14 +81,26 @@
  */
 public class EvaluateConvertToParallelStreamRefactoringHandler extends AbstractHandler {
 
+	private static final String EVALUATION_PROPERTIES_FILE_NAME = "eval.properties";
+
+	private static final Logger LOGGER = Logger.getLogger(LOGGER_NAME);
+
 	private static final boolean BUILD_WORKSPACE = false;
+
 	private static final boolean FIND_IMPLICIT_BENCHMARK_ENTRYPOINTS_DEFAULT = false;
 	private static final String FIND_IMPLICIT_BENCHMARK_ENTRYPOINTS_PROPERTY_KEY = "edu.cuny.hunter.streamrefactoring.eval.findImplicitBenchmarkEntrypoints";
+
 	private static final boolean FIND_IMPLICIT_ENTRYPOINTS_DEFAULT = false;
 	private static final String FIND_IMPLICIT_ENTRYPOINTS_PROPERTY_KEY = "edu.cuny.hunter.streamrefactoring.eval.findImplicitEntrypoints";
+
 	private static final boolean FIND_IMPLICIT_TEST_ENTRYPOINTS_DEFAULT = false;
 	private static final String FIND_IMPLICIT_TEST_ENTRYPOINTS_PROPERTY_KEY = "edu.cuny.hunter.streamrefactoring.eval.findImplicitTestEntrypoints";
+
+	private static final int N_TO_USE_FOR_STREAMS_DEFAULT = 2;
+	private static final String N_TO_USE_FOR_STREAMS_PROPERTY_KEY = "nToUseForStreams";
+
 	private static final int LOGGING_LEVEL = IStatus.INFO;
+
 	private static final boolean PERFORM_CHANGE_DEFAULT = false;
 	private static final String PERFORM_CHANGE_PROPERTY_KEY = "edu.cuny.hunter.streamrefactoring.eval.performChange";
 
@@ -189,8 +208,8 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 				IJavaProject[] javaProjects = Util.getSelectedJavaProjectsFromEvent(event);
 
 				List<String> resultsHeader = new ArrayList<>(
-						Arrays.asList("subject", "SLOC", "#entrypoints", "#streams", "#optimization available streams",
-								"#optimizable streams", "#failed preconditions"));
+						Arrays.asList("subject", "SLOC", "#entrypoints", "N", "#streams",
+								"#optimization available streams", "#optimizable streams", "#failed preconditions"));
 
 				for (Refactoring refactoring : Refactoring.values())
 					resultsHeader.add(refactoring.toString());
@@ -235,6 +254,11 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 
 				entryPointsTXTPrinter = new PrintWriter("entry_points.txt");
 
+				// set up analysis parameters for all projects.
+				boolean shouldFindImplicitEntrypoints = shouldFindImplicitEntrypoints();
+				boolean shouldFindImplicitTestEntrypoints = shouldFindImplicitTestEntrypoints();
+				boolean shouldFindImplicitBenchmarkEntrypoints = shouldFindImplicitBenchmarkEntrypoints();
+
 				for (IJavaProject javaProject : javaProjects) {
 					if (!javaProject.isStructureKnown())
 						throw new IllegalStateException(
@@ -246,15 +270,13 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 					// lines of code
 					resultsPrinter.print(getProjectLinesOfCode(javaProject));
 
-					// set up analysis.
+					// set up analysis for single project.
 					TimeCollector resultsTimeCollector = new TimeCollector();
-					boolean shouldFindImplicitEntrypoints = shouldFindImplicitEntrypoints();
-					boolean shouldFindImplicitTestEntrypoints = shouldFindImplicitTestEntrypoints();
-					boolean shouldFindImplicitBenchmarkEntrypoints = shouldFindImplicitBenchmarkEntrypoints();
+					int nToUseForStreams = getNForStreams(javaProject);
 
 					resultsTimeCollector.start();
 					processor = createConvertToParallelStreamRefactoringProcessor(new IJavaProject[] { javaProject },
-							shouldFindImplicitEntrypoints, shouldFindImplicitTestEntrypoints,
+							nToUseForStreams, shouldFindImplicitEntrypoints, shouldFindImplicitTestEntrypoints,
 							shouldFindImplicitBenchmarkEntrypoints, Optional.of(monitor));
 					resultsTimeCollector.stop();
 					ConvertToParallelStreamRefactoringProcessor.setLoggingLevel(LOGGING_LEVEL);
@@ -276,6 +298,9 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 						entryPointsTXTPrinter.println(method.getSignature());
 					}
 
+					// N.
+					resultsPrinter.print(nToUseForStreams);
+
 					// #streams.
 					resultsPrinter.print(processor.getStreamSet().size());
 
@@ -521,4 +546,32 @@ private static boolean shouldPerformChange() {
 		else
 			return Boolean.valueOf(performChangePropertyValue);
 	}
+
+	private static int getNForStreams(IJavaProject project) throws IOException, JavaModelException {
+		Properties properties = new Properties();
+		IPath filePath = project.getCorrespondingResource().getLocation().append(EVALUATION_PROPERTIES_FILE_NAME);
+		File file = filePath.toFile();
+
+		if (file.exists())
+			try (Reader reader = new FileReader(file)) {
+				properties.load(reader);
+
+				String nToUseForStreams = properties.getProperty(N_TO_USE_FOR_STREAMS_PROPERTY_KEY);
+
+				if (nToUseForStreams == null) {
+					int ret = N_TO_USE_FOR_STREAMS_DEFAULT;
+					LOGGER.info("Using default N for streams: " + ret + ".");
+					return ret;
+				} else {
+					int ret = Integer.valueOf(nToUseForStreams);
+					LOGGER.info("Using properties file N for streams: " + ret + ".");
+					return ret;
+				}
+			}
+		else {
+			int ret = N_TO_USE_FOR_STREAMS_DEFAULT;
+			LOGGER.info("Using default N for streams: " + ret + ".");
+			return ret;
+		}
+	}
 }