This makes creating data-driven tests simpler, by separating * the test algorithim from the definition of the test data. Note * that logging what happened during the test is already separated * out into the Logger interface.
* *Testlets are used with Datalets, which provide a single set * of data to execute this test case with. * For example:
*Testlets may provide additional worker methods that allow them * to be easily run in varying situations; for example, a * testwriter may have a Test object that calls a number of Testlets * for it's test cases. If one of the Testlets finds a bug, the * testwriter can simply reference the single Testlet and it's * current Datalet in the bug report, without having to reference * the enclosing Test file. This makes it easier for others to * reproduce the problem with a minimum of overhead.
* * @author Shane_Curcuru@lotus.com * @version $Id$ */ public interface Testlet { /** * Accesor method for a brief description of this Testlet. *Testlet implementers should provide a brief, one line * description of the algorithim of their test case.
* //@todo do we need to define a setDescription() method? * Since Testlets are pretty self-sufficient, implementers * should always just define this, and not let callers * re-set them. * * @return String describing what this Testlet does. */ public abstract String getDescription(); /** * Accesor methods for our Logger. *Testlets use simple Loggers that they rely on the caller * to have setup. This frees the Testlet and the Logger from * having to store any other state about the Testlet. It is * the caller's responsibility to do any overall rolling-up * or aggregating of results reporting, if needed.
* * @param l the Logger to have this test use for logging * results; or null to use a default logger */ public abstract void setLogger(Logger l); /** * Accesor methods for our Logger. * * @return Logger we tell all our secrets to; may be null */ public abstract Logger getLogger(); /** * Get a default Logger for use with this Testlet. *Provided to allow subclasses to override this in different * ways. This would probably be called when setLogger(null) * is called. The most common implementation would be to * return a Logger.DEFAULT_LOGGER (which simply * logs things to the console).
* * //@todo this sort of functionality should really be provided * by the Logger class itself - any caller should be able to ask * Logger (or a Logger factory, if you want to get fancy) for a * default Logger for use without having to supply any params. * * @return Logger suitable for passing to setLogger() */ public abstract Logger getDefaultLogger(); /** * Return this Testlet's default Datalet. *Every Testlet should have created a default Datalet that can * be used with this test: i.e. the test case itself has a * default, or sample set of data to execute the test with. This * way a user can simply execute the Testlet on the fly without * having to provide any input data.
*If the Testlet can't provide a default Datalet, either * the user must provide one somehow, or an error message * should be printed out. Note that the Testlet must still * return a Datalet of the correct class from this method, even * if the Datalet returned has no data set into it. This would * allow a harness with random test data generation capabilities * to discover this Testlet, and then generate random Datalets to * pass to it.
* * @return Datalet this Testlet can use as a default test case. */ public abstract Datalet getDefaultDatalet(); /** * Run this Testlet: execute it's test and return. *The Testlet should perform it's test operation, logging * information as needed to it's Logger, using the provided * Datalet as a test point.
*If the Datalet passed is null, the Testlet should use * it's default Datalet as the test point data.
*Testlets should not throw exceptions and should not * return anything nor worry about checking their state or * rolling up any overall results to their Logger. Testlets * should simply focus on performing their one test operation * and outputting any simple pass/fail/other results to their * Logger. It is the responsibility of the caller to do any * overall or rolled-up reporting that is desired.
* * @author Shane_Curcuru@lotus.com * @param Datalet to use as data points for the test; if null, * will attempt to use getDefaultDatalet() */ public abstract void execute(Datalet datalet); } // end of class Testlet