001: /*BEGIN_COPYRIGHT_BLOCK
002: *
003: * Copyright (c) 2001-2007, JavaPLT group at Rice University (javaplt@rice.edu)
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are met:
008: * * Redistributions of source code must retain the above copyright
009: * notice, this list of conditions and the following disclaimer.
010: * * Redistributions in binary form must reproduce the above copyright
011: * notice, this list of conditions and the following disclaimer in the
012: * documentation and/or other materials provided with the distribution.
013: * * Neither the names of DrJava, the JavaPLT group, Rice University, nor the
014: * names of its contributors may be used to endorse or promote products
015: * derived from this software without specific prior written permission.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
018: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
019: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
020: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
021: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
022: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
023: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
024: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
025: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
026: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
027: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
028: *
029: * This software is Open Source Initiative approved Open Source Software.
030: * Open Source Initative Approved is a trademark of the Open Source Initiative.
031: *
032: * This file is part of DrJava. Download the current version of this project
033: * from http://www.drjava.org/ or http://sourceforge.net/projects/drjava/
034: *
035: * END_COPYRIGHT_BLOCK*/
036:
037: package edu.rice.cs.drjava.model.junit;
038:
039: import java.io.IOException;
040: import java.io.File;
041: import java.util.List;
042: import edu.rice.cs.drjava.model.OpenDefinitionsDocument;
043: import edu.rice.cs.util.text.SwingDocument;
044:
045: public interface JUnitModel {
046:
047: //-------------------------- Field Setters --------------------------------//
048:
049: /** set the forceTestSuffix flag that forces class names in projects to end in "Test */
050: public void setForceTestSuffix(boolean b);
051:
052: //-------------------------- Listener Management --------------------------//
053:
054: /** Add a JUnitListener to the model.
055: * @param listener a listener that reacts to JUnit events
056: */
057: public void addListener(JUnitListener listener);
058:
059: /** Remove a JUnitListener from the model. If the listener is not currently listening to this
060: * model, this method has no effect.
061: * @param listener a listener that reacts to JUnit events
062: */
063: public void removeListener(JUnitListener listener);
064:
065: /** Removes all JUnitListeners from this model. */
066: public void removeAllListeners();
067:
068: //-------------------------------- Triggers --------------------------------//
069:
070: /** This is used by test cases and perhaps other things. We should kill it. */
071: public SwingDocument getJUnitDocument();
072:
073: /** Creates a JUnit test suite over all currently open documents and runs it. If the class file
074: * associated with a file is not a test case, it will be ignored. Synchronized against the compiler
075: * model to prevent testing and compiling at the same time, which would create invalid results.
076: */
077: public void junitAll();
078:
079: /** Creates a JUnit test suite over all currently open project documents and runs it. If
080: * the class file associated with a file is not a test case, it will be ignored. Synchronized
081: * against the compiler model to prevent testing and compiling at the same time, which would
082: * create invalid results.
083: */
084: public void junitProject();
085:
086: /** Runs JUnit over a list of documents. Synchronized against the compiler model to prevent
087: * testing and compiling at the same time, which would create invalid results.
088: * @param lod the list of documents that are to be run through JUnit testing.
089: */
090: public void junitDocs(List<OpenDefinitionsDocument> lod);
091:
092: /** Runs JUnit over a single document. Synchronized against the compiler model to prevent testing
093: * and compiling at the same time, which would create invalid results.
094: * @param doc the document to be run under JUnit
095: */
096: public void junit(OpenDefinitionsDocument doc)
097: throws ClassNotFoundException, IOException;
098:
099: /** Forwards the classnames and files to the test manager to test all of them.
100: * @param qualifiedClassnames a list of all the qualified class names to test.
101: * @param files a list of their source files in the same order as qualified class names.
102: */
103: public void junitClasses(List<String> qualifiedClassnames,
104: List<File> files);
105:
106: //---------------------------- Model Callbacks ----------------------------//
107:
108: /** Cleans up an attempt JUnit test exeuction when suitable test code is not available.
109: * @param isTestAll whether or not it was a use of the test all button
110: */
111: public void nonTestCase(boolean isTestAll);
112:
113: //----------------------------- Error Results -----------------------------//
114:
115: /** Gets the JUnitErrorModel, which contains error info for the last test run. */
116: public JUnitErrorModel getJUnitErrorModel();
117:
118: /** Resets the junit error state to have no errors. */
119: public void resetJUnitErrors();
120:
121: }
|