Generate entry_points.txt (#175)

Fix #175.

Author: Grace Tang

README.md

@@ -15,6 +15,8 @@ This prototype refactoring plug-in for [Eclipse](http://eclipse.org) represents
 
 Explicit entry points may be marked using the appropriate annotation found in the corresponding [annotation library][annotations].
 
+Explicit entry points can also be marked using importing entry points from a txt file. Each time we run the tool, a txt file named "entry_points.txt" is generated and contained in the current directory of workspace. Then,  before next time we run tool to evaluate the same project, move or copy "entry_points.txt" into project directory or workspace directory of the project. While evaluating the project, the tool will ignore the explicit entry points which are added manually and regonize the explicit entry points through the file automatically.
+
 ### Limitations
 
 There are currently some limitations with embedded streams (i.e., streams declared as part of lambda expressions sent as arguments to intermediate stream operations). This is due to model differences between the Eclipse JDT and WALA. See [#155](https://github.com/ponder-lab/Java-8-Stream-Refactoring/issues/155) for details.

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/analysis/StreamAnalyzer.java

@@ -2,18 +2,23 @@
 
 import static com.ibm.wala.ipa.callgraph.impl.Util.makeMainEntrypoints;
 
+import java.io.File;
 import java.io.IOException;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.Map;
+import java.util.Scanner;
 import java.util.Set;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
 
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.jdt.core.IJavaProject;
 import org.eclipse.jdt.core.dom.ASTVisitor;
 import org.eclipse.jdt.core.dom.IMethodBinding;
@@ -29,6 +34,7 @@
 import com.ibm.wala.ipa.callgraph.Entrypoint;
 import com.ibm.wala.ipa.callgraph.propagation.InstanceKey;
 import com.ibm.wala.ipa.cha.ClassHierarchyException;
+import com.ibm.wala.ipa.cha.IClassHierarchy;
 import com.ibm.wala.shrikeCT.InvalidClassFileException;
 import com.ibm.wala.ssa.SSAOptions;
 import com.ibm.wala.util.CancelException;
@@ -42,6 +48,8 @@ public class StreamAnalyzer extends ASTVisitor {
 
 	private static final Logger LOGGER = Logger.getLogger(LoggerNames.LOGGER_NAME);
 
+	private static final String ENTRY_POINT_FILE = "entry_points.txt";
+
 	private static void addImplicitEntryPoints(Collection<Entrypoint> target, Iterable<Entrypoint> source) {
 		for (Entrypoint implicitEntryPoint : source)
 			if (target.add(implicitEntryPoint))
@@ -181,13 +189,22 @@ public Map<IJavaProject, Collection<Entrypoint>> analyze() throws CoreException
 	 *            graph.
 	 * @return The {@link Entrypoint}s used in building the {@link CallGraph}.
 	 */
-	protected Collection<Entrypoint> buildCallGraph(EclipseProjectAnalysisEngine<InstanceKey> engine)
-			throws IOException, CoreException, CallGraphBuilderCancelException, CancelException {
+	protected Collection<Entrypoint> buildCallGraph(EclipseProjectAnalysisEngine<InstanceKey> engine) throws IOException, CoreException, CallGraphBuilderCancelException, CancelException {
 		// if we haven't built the call graph yet.
 		if (!this.enginesWithBuiltCallGraphsToEntrypointsUsed.keySet().contains(engine)) {
-			// find explicit entry points.
-			Set<Entrypoint> entryPoints = Util.findEntryPoints(engine.getClassHierarchy());
-			entryPoints.forEach(ep -> LOGGER.info(() -> "Adding explicit entry point: " + ep));
+
+			Set<Entrypoint> entryPoints;
+			// find the entry_points.txt in the project directory
+			File entryPointFile = getEntryPointsFile(engine.getProject().getResource().getLocation(), ENTRY_POINT_FILE);
+			if (entryPointFile != null) {
+				// find explicit entry points from entry_points.txt
+				entryPoints = findEntryPointsFromFile(engine.getClassHierarchy(), entryPointFile);
+				entryPoints.forEach(ep -> LOGGER.info(() -> "Adding explicit entry point from file: " + ep));
+			} else {
+				// find explicit entry points.
+				entryPoints = Util.findEntryPoints(engine.getClassHierarchy());
+				entryPoints.forEach(ep -> LOGGER.info(() -> "Adding explicit entry point: " + ep));
+			}
 
 			if (this.findImplicitEntryPoints) {
 				// also find implicit entry points.
@@ -239,6 +256,52 @@ protected Collection<Entrypoint> buildCallGraph(EclipseProjectAnalysisEngine<Ins
 		return this.enginesWithBuiltCallGraphsToEntrypointsUsed.get(engine);
 	}
 
+	/**
+	 * Read entry_points.txt and get a set of method signatures, then, get entry
+	 * points by those signatures
+	 * 
+	 * @return a set of entry points
+	 * @throws IOException
+	 */
+	private static Set<Entrypoint> findEntryPointsFromFile(IClassHierarchy classHierarchy, File file)
+			throws IOException {
+		Set<String> signatures = new HashSet<>();
+
+		try (Scanner scanner = new Scanner(file)) {
+			while (scanner.hasNextLine()) {
+				String line = scanner.nextLine();
+				signatures.add(line);
+			}
+		}
+
+		Set<Entrypoint> entrypoints = Util.findEntryPoints(classHierarchy, signatures);
+		return entrypoints;
+	}
+
+	/**
+	 * Search entry_points.txt in project directory recursively
+	 * 
+	 * @param directory:
+	 *            project directory
+	 * @param fileName:
+	 *            the target file
+	 * @return null: the file does not exist / file: find the file
+	 */
+	private static File getEntryPointsFile(IPath directory, String fileName) {
+		// If file does not exist, find the file in upper level
+		Path directoryPath = Paths.get(directory.toString());
+		File file;
+		do {
+			file = new File(directoryPath.resolve(ENTRY_POINT_FILE).toString());
+			directoryPath = directoryPath.getParent();
+		} while (!file.exists() && directoryPath != null);
+
+		if (!file.exists())
+			return null;
+		else
+			return file;
+	}
+
 	public Set<Stream> getStreamSet() {
 		return this.streamSet;
 	}

edu.cuny.hunter.streamrefactoring.core/src/edu/cuny/hunter/streamrefactoring/core/analysis/Util.java

@@ -264,6 +264,24 @@ public static Set<Entrypoint> findEntryPoints(IClassHierarchy classHierarchy) {
 		return result;
 	}
 
+	/**
+	 * find entry points from file
+	 */
+	public static Set<Entrypoint> findEntryPoints(IClassHierarchy classHierarchy, Set<String> signatures) {
+		final Set<Entrypoint> result = new HashSet<>();
+
+		for (IClass klass : classHierarchy)
+			if (!(isJDKClass(klass) || isLibraryClass(klass))) {
+				// iterate over all declared methods
+				for (com.ibm.wala.classLoader.IMethod method : klass.getDeclaredMethods()) {
+					if (signatures.contains(method.getSignature())) {
+						addEntryPoint(result, method, classHierarchy);
+					}
+				}
+			}
+		return result;
+	}
+
 	static Set<ITypeBinding> getAllInterfaces(ITypeBinding type) {
 		Set<ITypeBinding> ret = new HashSet<>();
 		ITypeBinding[] interfaces = type.getInterfaces();

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

@@ -4,6 +4,7 @@
 
 import java.io.FileWriter;
 import java.io.IOException;
+import java.io.PrintWriter;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -173,6 +174,7 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 			CSVPrinter streamExecutionModePrinter = null;
 			CSVPrinter streamOrderingPrinter = null;
 			CSVPrinter entryPointsPrinter = null;
+			PrintWriter entryPointsTXTPrinter = null;
 
 			ConvertToParallelStreamRefactoringProcessor processor = null;
 
@@ -231,6 +233,8 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 				entryPointsPrinter = createCSVPrinter("entry_points.csv",
 						new String[] { "subject", "method", "type FQN" });
 
+				entryPointsTXTPrinter = new PrintWriter("entry_points.txt");
+
 				for (IJavaProject javaProject : javaProjects) {
 					if (!javaProject.isStructureKnown())
 						throw new IllegalStateException(
@@ -265,6 +269,7 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 						com.ibm.wala.classLoader.IMethod method = entryPoint.getMethod();
 						entryPointsPrinter.printRecord(javaProject.getElementName(), method.getSignature(),
 								method.getDeclaringClass().getName());
+						entryPointsTXTPrinter.println(method.getSignature());
 					}
 
 					// #streams.
@@ -442,6 +447,8 @@ public Object execute(ExecutionEvent event) throws ExecutionException {
 						streamOrderingPrinter.close();
 					if (entryPointsPrinter != null)
 						entryPointsPrinter.close();
+					if (entryPointsTXTPrinter != null)
+						entryPointsTXTPrinter.close();
 
 					// clear cache.
 					if (processor != null)

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile/in/A.java

@@ -0,0 +1,13 @@
+package p;
+
+import java.util.HashSet;
+
+import edu.cuny.hunter.streamrefactoring.annotations.*;
+
+class A {
+	@EntryPoint
+	void m() {
+		HashSet h1 = new HashSet();
+		h1.stream().count();
+	}
+}

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile1/entry_points.txt

@@ -0,0 +1,2 @@
+p.A.<init>()V
+p.A.m()V

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile1/in/A.java

@@ -0,0 +1,12 @@
+package p;
+
+import java.util.HashSet;
+
+import edu.cuny.hunter.streamrefactoring.annotations.*;
+
+class A {
+	void m() {
+		HashSet h1 = new HashSet();
+		h1.stream().count();
+	}
+}

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile2/entry_points.txt

@@ -0,0 +1,2 @@
+q.A.<init>()V
+q.A.m()V

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile2/in/A.java

@@ -0,0 +1,12 @@
+package p;
+
+import java.util.HashSet;
+
+import edu.cuny.hunter.streamrefactoring.annotations.*;
+
+class A {
+	void m() {
+		HashSet h1 = new HashSet();
+		h1.stream().count();
+	}
+}

edu.cuny.hunter.streamrefactoring.tests/resources/ConvertStreamToParallel/testEntryPointFile3/entry_points.txt

@@ -0,0 +1,2 @@
+q.A.<init>()V
+q.A.m()V