123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562 |
- /********************************************************************
- * Copyright (c) 2005 Contributors.All rights reserved.
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Public License v1.0
- * which accompanies this distribution and is available at
- * http://eclipse.org/legal/epl-v10.html
- *
- * Contributors:
- * Andy Clement initial implementation
- * Helen Hawkins Converted to new interface (bug 148190)
- *******************************************************************/
- package org.aspectj.systemtest.incremental.tools;
-
- import java.io.File;
- import java.io.IOException;
- import java.util.ArrayList;
- import java.util.HashSet;
- import java.util.Iterator;
- import java.util.List;
- import java.util.Map;
- import java.util.Set;
-
- import junit.framework.TestCase;
-
- import org.aspectj.ajde.core.AjCompiler;
- import org.aspectj.ajde.core.IBuildMessageHandler;
- import org.aspectj.ajde.core.ICompilerConfiguration;
- import org.aspectj.ajde.core.IOutputLocationManager;
- import org.aspectj.ajdt.internal.core.builder.AbstractStateListener;
- import org.aspectj.ajdt.internal.core.builder.AjState;
- import org.aspectj.ajdt.internal.core.builder.IncrementalStateManager;
- import org.aspectj.asm.AsmManager;
- import org.aspectj.bridge.IMessage;
- import org.aspectj.tools.ajc.Ajc;
-
- /**
- * This class uses Ajde in the same way that an IDE (e.g. AJDT) does.
- *
- * The build is driven through 'doBuild(projectName)' but the build can be configured by the methods beginning 'configure***'.
- * Information about what happened during a build is accessible through the get*, was*, print* public methods...
- *
- */
- public class AjdeInteractionTestbed extends TestCase {
-
- public static boolean VERBOSE = false; // do you want the gory details?
-
- public static String testdataSrcDir = "../tests/multiIncremental";
- protected static File sandboxDir;
-
- private static boolean buildModel;
-
- // Methods for configuring the build
- public void configureNewProjectDependency(String fromProjectName, String projectItDependsOn) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + fromProjectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).addDependancy(projectItDependsOn);
- }
-
- public void addSourceFolderForSourceFile(String projectName, File f, String sourceFolder) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestOutputLocationManager) ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration())
- .getOutputLocationManager()).setSourceFolderFor(f, sourceFolder);
- }
-
- public void setNextChangeResponse(String projName, int flags) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).changed = flags;
- }
-
- public void setProjectEncoding(String projName, String encoding) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setProjectEncoding(encoding);
- }
-
- public void addProjectSourceFileChanged(String projectName, File changedFile) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).addProjectSourceFileChanged(changedFile);
- }
-
- public void addXmlConfigFile(String projectName, String xmlfile) {
- List<String> l = new ArrayList<String>();
- l.add(xmlfile);
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setProjectXmlConfigFiles(l);
- }
-
- public void addClasspathEntry(String projectName, File classpathEntry) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- MultiProjTestCompilerConfiguration config = ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration());
- config.setClasspath(config.getClasspath() + File.pathSeparator + classpathEntry.toString());
- }
-
- public void addClasspathEntryChanged(String projectName, String changedDir) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).addClasspathEntryChanged(changedDir);
- }
-
- public void configureNonStandardCompileOptions(String projectName, String options) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setNonStandardOptions(options);
- }
-
- public void configureAspectPath(String projectName, Set aspectpath) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setAspectPath(aspectpath);
- }
-
- public void configureProcessor(String projectName, String processor) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setProcessor(processor);
- }
-
- public void configureProcessorPath(String projectName, String processorPath) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setProcessorPath(processorPath);
- }
-
- public void configureAspectPath(String projectName, File aspectpath) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- Set<File> s = new HashSet<File>();
- s.add(aspectpath);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setAspectPath(s);
- }
-
- public void configureResourceMap(String projectName, Map resourcesMap) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setSourcePathResources(resourcesMap);
- }
-
- public void configureJavaOptionsMap(String projectName, Map options) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setJavaOptions(options);
- }
-
- public static void configureInPath(String projectName, Set<File> inpath) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setInpath(inpath);
- }
-
- public static void configureInPath(String projectName, File inpath) {
- Set<File> s = new HashSet<File>();
- s.add(inpath);
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setInpath(s);
- }
-
- public static void configureOutputLocationManager(String projectName, IOutputLocationManager mgr) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- ((MultiProjTestCompilerConfiguration) compiler.getCompilerConfiguration()).setOutputLocationManager(mgr);
- }
-
- public void configureShowWeaveInfoMessages(String projectName, boolean showWeaveInfo) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- IBuildMessageHandler handler = compiler.getMessageHandler();
- if (showWeaveInfo) {
- handler.dontIgnore(IMessage.WEAVEINFO);
- } else {
- handler.ignore(IMessage.WEAVEINFO);
- }
- }
-
- // End of methods for configuring the build
-
- public AjCompiler getCompilerForProjectWithName(String projectName) {
- return CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- }
-
- protected File getWorkingDir() {
- return sandboxDir;
- }
-
- protected void setUp() throws Exception {
- super.setUp();
- // need this line because otherwise reset in previous tests
- AsmManager.attemptIncrementalModelRepairs = true;
- if (AjState.stateListener == null) {
- AjState.stateListener = MyStateListener.getInstance();
-
- }
- MyStateListener.reset();
- // Create a sandbox in which to work
- sandboxDir = Ajc.createEmptySandbox();
- }
-
- protected void tearDown() throws Exception {
- super.tearDown();
- AjState.stateListener = null;
- CompilerFactory.clearCompilerMap();
- IncrementalStateManager.clearIncrementalStates();
- }
-
- /** Drives a build */
- public boolean doBuild(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- resetCompilerRecords(compiler);
- addSourceFilesToBuild(projectName, compiler);
- // addXmlConfigFilesToBuild(projectName, compiler);
- pause(1000); // delay to allow previous runs build stamps to be OK
- lognoln("Building project '" + projectName + "'");
- compiler.build();
- log("");
- checkForErrors(compiler);
- log("Build finished, time taken = "
- + ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).getTimeTaken() + "ms");
- return true;
- }
-
- // public AsmManager getStructureModelFor(String projectName) {
- // AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- // returnc compiler.getStructureModelFor(projectName)
- // }
-
- /** Drives a full build **/
- public boolean doFullBuild(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- resetCompilerRecords(compiler);
- addSourceFilesToBuild(projectName, compiler);
- addXmlConfigFilesToBuild(projectName, compiler);
- pause(1000); // delay to allow previous runs build stamps to be OK
- lognoln("Building project '" + projectName + "'");
- compiler.buildFresh();
- log("");
- checkForErrors(compiler);
- log("Build finished, time taken = "
- + ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).getTimeTaken() + "ms");
- return true;
- }
-
- /**
- * Clears any maps associated with the compiler
- */
- private void resetCompilerRecords(AjCompiler compiler) {
- ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).reset();
- ((MultiProjTestMessageHandler) compiler.getMessageHandler()).reset();
- }
-
- /**
- * Find the source files associated with the given project and add them to the list of projectSourceFiles in the
- * MultiProjTestCompilerConfiguration to be used in the subsequent build
- */
- private void addSourceFilesToBuild(String pname, AjCompiler compiler) {
- File projectBase = new File(sandboxDir, pname);
- ICompilerConfiguration icc = compiler.getCompilerConfiguration();
- List currentFiles = icc.getProjectSourceFiles();
- List<String> filesForCompilation = new ArrayList<String>();
- collectUpFiles(projectBase, projectBase, filesForCompilation);
- boolean changed = false;
- for (int i = 0; i < filesForCompilation.size(); i++) {
- if (!currentFiles.contains(filesForCompilation.get(i))) {
- changed = true;
- }
- }
- for (int i = 0; i < currentFiles.size(); i++) {
- if (!filesForCompilation.contains(currentFiles.get(i))) {
- changed = true;
- }
- }
- if (changed) {
- ((MultiProjTestCompilerConfiguration) icc).setProjectSourceFiles(filesForCompilation);
- }
- }
-
- private void addXmlConfigFilesToBuild(String pname, AjCompiler compiler) {
- File projectBase = new File(sandboxDir, pname);
- ICompilerConfiguration icc = compiler.getCompilerConfiguration();
- List<String> currentXmlFiles = icc.getProjectXmlConfigFiles();
- List<String> collector = new ArrayList<String>();
- collectUpXmlFiles(projectBase, projectBase, collector);
- boolean changed = false;
- for (int i = 0; i < collector.size(); i++) {
- if (!currentXmlFiles.contains(collector.get(i))) {
- changed = true;
- }
- }
- for (int i = 0; i < currentXmlFiles.size(); i++) {
- if (!collector.contains(currentXmlFiles.get(i))) {
- changed = true;
- }
- }
- if (changed) {
- ((MultiProjTestCompilerConfiguration) icc).setProjectXmlConfigFiles(collector);
- }
- }
-
- private void collectUpFiles(File location, File base, List<String> collectionPoint) {
- String contents[] = location.list();
- if (contents == null) {
- return;
- }
- for (int i = 0; i < contents.length; i++) {
- String string = contents[i];
- File f = new File(location, string);
- if (f.isDirectory()) {
- collectUpFiles(f, base, collectionPoint);
- } else if (f.isFile() && (f.getName().endsWith(".aj") || f.getName().endsWith(".java"))) {
- String fileFound;
- try {
- fileFound = f.getCanonicalPath();
- collectionPoint.add(fileFound);
- // String toRemove = base.getCanonicalPath();
- // if (!fileFound.startsWith(toRemove)) throw new RuntimeException("eh? "+fileFound+" "+toRemove);
- // collectionPoint.add(fileFound.substring(toRemove.length()+1));//+1 captures extra separator
- } catch (IOException e) {
- e.printStackTrace();
- }
- }
- }
- }
-
- private void collectUpXmlFiles(File location, File base, List<String> collectionPoint) {
- String contents[] = location.list();
- if (contents == null) {
- return;
- }
- for (int i = 0; i < contents.length; i++) {
- String string = contents[i];
- File f = new File(location, string);
- if (f.isDirectory()) {
- collectUpXmlFiles(f, base, collectionPoint);
- } else if (f.isFile() && f.getName().endsWith(".xml")) {
- String fileFound;
- try {
- fileFound = f.getCanonicalPath();
- collectionPoint.add(fileFound);
- } catch (IOException e) {
- e.printStackTrace();
- }
- }
- }
- }
-
- /**
- * Make sure no errors have been recorded
- */
- private void checkForErrors(AjCompiler compiler) {
- MultiProjTestMessageHandler handler = (MultiProjTestMessageHandler) compiler.getMessageHandler();
- if (handler.hasErrorMessages()) {
- System.err.println("Build errors:");
- for (Iterator<IMessage> iter = handler.getErrorMessages().iterator(); iter.hasNext();) {
- IMessage element = iter.next();
- System.err.println(element);
- }
- System.err.println("---------");
- }
- }
-
- public List<IMessage> getErrorMessages(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestMessageHandler) compiler.getMessageHandler()).getErrorMessages();
- }
-
- public List<IMessage> getWarningMessages(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestMessageHandler) compiler.getMessageHandler()).getWarningMessages();
- }
-
- public List<IMessage> getWeavingMessages(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestMessageHandler) compiler.getMessageHandler()).getWeavingMessages();
- }
-
- public List<IMessage> getCompilerErrorMessages(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestMessageHandler) compiler.getMessageHandler()).getCompilerErrors();
- }
-
- public void checkForError(String projectName, String anError) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- List<IMessage> messages = ((MultiProjTestMessageHandler) compiler.getMessageHandler()).getErrorMessages();
- for (Iterator<IMessage> iter = messages.iterator(); iter.hasNext();) {
- IMessage element = iter.next();
- if (element.getMessage().indexOf(anError) != -1) {
- return;
- }
- }
- fail("Didn't find the error message:\n'" + anError + "'.\nErrors that occurred:\n" + messages);
- }
-
- private void pause(int millis) {
- try {
- Thread.sleep(millis);
- } catch (InterruptedException ie) {
- }
- }
-
- // Methods for querying what happened during a build and accessing information
- // about the build:
-
- /**
- * Helper method for dumping info about which files were compiled and woven during the last build.
- */
- public String printCompiledAndWovenFiles(String projectName) {
- StringBuffer sb = new StringBuffer();
- if (getCompiledFiles(projectName).size() == 0 && getWovenClasses(projectName).size() == 0) {
- sb.append("No files were compiled or woven\n");
- }
- for (Iterator iter = getCompiledFiles(projectName).iterator(); iter.hasNext();) {
- Object element = iter.next();
- sb.append("compiled: " + element + "\n");
- }
- for (Iterator iter = getWovenClasses(projectName).iterator(); iter.hasNext();) {
- Object element = iter.next();
- sb.append("woven: " + element + "\n");
- }
- return sb.toString();
- }
-
- /**
- * Summary report on what happened in the most recent build
- */
- public void printBuildReport(String projectName) {
- System.out.println("\n====== BUILD REPORT (Project " + projectName + ") ===========");
- System.out.println("Build took: " + getTimeTakenForBuild(projectName) + "ms");
- List<String> compiled = getCompiledFiles(projectName);
- System.out.println("Compiled: " + compiled.size() + " files");
- for (Iterator<String> iter = compiled.iterator(); iter.hasNext();) {
- System.out.println(" :" + iter.next());
- }
- List<String> woven = getWovenClasses(projectName);
- System.out.println("Wove: " + woven.size() + " files");
- for (Iterator<String> iter = woven.iterator(); iter.hasNext();) {
- System.out.println(" :" + iter.next());
- }
- if (wasFullBuild()) {
- System.out.println("It was a batch (full) build");
- }
- System.out.println("=============================================");
- }
-
- /**
- * Check we compiled/wove the right number of files, passing '-1' indicates you don't care about that number.
- */
- public void checkCompileWeaveCount(String projectName, int expCompile, int expWoven) {
- if (expCompile != -1 && getCompiledFiles(projectName).size() != expCompile) {
- fail("Expected compilation of " + expCompile + " files but compiled " + getCompiledFiles(projectName).size() + "\n"
- + printCompiledAndWovenFiles(projectName));
- }
- if (expWoven != -1 && getWovenClasses(projectName).size() != expWoven) {
- fail("Expected weaving of " + expWoven + " files but wove " + getWovenClasses(projectName).size() + "\n"
- + printCompiledAndWovenFiles(projectName));
- }
- }
-
- public void checkWasntFullBuild() {
- assertTrue("Shouldn't have been a full (batch) build", !wasFullBuild());
- }
-
- public void checkWasFullBuild() {
- assertTrue("Should have been a full (batch) build", wasFullBuild());
- }
-
- public boolean wasFullBuild() {
- // alternatives: statelistener is debug interface, progressmonitor is new proper interface (see pr145689)
- // return MyBuildProgressMonitor.wasFullBuild();
- return MyStateListener.wasFullBuild();
- }
-
- public long getTimeTakenForBuild(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).getTimeTaken();
- }
-
- public List<String> getCompiledFiles(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).getCompiledFiles();
- }
-
- public AsmManager getModelFor(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return compiler.getModel();
- }
-
- public List<String> getWovenClasses(String projectName) {
- AjCompiler compiler = CompilerFactory.getCompilerForProjectWithDir(sandboxDir + File.separator + projectName);
- return ((MultiProjTestBuildProgressMonitor) compiler.getBuildProgressMonitor()).getWovenClasses();
- }
-
- // Infrastructure below here
-
- private static void log(String msg) {
- if (VERBOSE) {
- System.out.println(msg);
- }
- }
-
- private static void lognoln(String msg) {
- if (VERBOSE) {
- System.out.print(msg);
- }
- }
-
- /** Return the *full* path to this file which is taken relative to the project dir */
- protected static String getFile(String projectName, String path) {
- return new File(sandboxDir, projectName + File.separatorChar + path).getAbsolutePath();
- }
-
- static class MyStateListener extends AbstractStateListener {
-
- private static MyStateListener _instance = new MyStateListener();
-
- private MyStateListener() {
- reset();
- }
-
- public static MyStateListener getInstance() {
- return _instance;
- }
-
- public static boolean informedAboutKindOfBuild;
- public static boolean fullBuildOccurred;
- public static List<String> detectedDeletions = new ArrayList<String>();
- public static StringBuffer decisions = new StringBuffer();
-
- public static void reset() {
- informedAboutKindOfBuild = false;
- decisions = new StringBuffer();
- fullBuildOccurred = false;
- if (detectedDeletions != null) {
- detectedDeletions.clear();
- }
- }
-
- public boolean pathChange = false;
-
- public void pathChangeDetected() {
- pathChange = true;
- }
-
- public void aboutToCompareClasspaths(List oldClasspath, List newClasspath) {
- }
-
- public void detectedClassChangeInThisDir(File f) {
- recordDecision("Detected class change in this directory: " + f.toString());
- }
-
- public void detectedAspectDeleted(File f) {
- detectedDeletions.add(f.toString());
- }
-
- public void buildSuccessful(boolean wasFullBuild) {
- informedAboutKindOfBuild = true;
- fullBuildOccurred = wasFullBuild;
- }
-
- public static String getDecisions() {
- return decisions.toString();
- }
-
- public static boolean wasFullBuild() {
- if (!informedAboutKindOfBuild) {
- throw new RuntimeException("I never heard about what kind of build it was!!");
- }
- return fullBuildOccurred;
- }
-
- // not needed just yet...
- // public void recordInformation(String s) { decisions.append(s).append("\n");}
- public void recordDecision(String s) {
- decisions.append(s).append("\n");
- log(s);
- }
- };
- }
|