KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > junitx > util > AbstractSuiteBuilder


1 /*
2  * The JUnit-addons Software License, Version 1.0
3  * (based on the Apache Software License, Version 1.1)
4  *
5  * Copyright (c) 2002-2003 Vladimir R. Bossicard. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if
20  * any, must include the following acknowlegement:
21  * "This product includes software developed by Vladimir R.
22  * Bossicard as well as other contributors
23  * (http://junit-addons.sourceforge.net/)."
24  * Alternately, this acknowlegement may appear in the software itself,
25  * if and wherever such third-party acknowlegements normally appear.
26  *
27  * 4. The name "JUnit-addons" must not be used to endorse or promote
28  * products derived from this software without prior written
29  * permission. For written permission, please contact
30  * vbossica@users.sourceforge.net.
31  *
32  * 5. Products derived from this software may not be called "JUnit-addons"
33  * nor may "JUnit-addons" appear in their names without prior written
34  * permission of the project managers.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ======================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals. For more information on the JUnit-addons Project, please
52  * see <http://junit-addons.sourceforge.net/>.
53  */
54
55 package junitx.util;
56
57 import java.lang.reflect.InvocationTargetException JavaDoc;
58 import java.lang.reflect.Method JavaDoc;
59 import java.lang.reflect.Modifier JavaDoc;
60 import java.util.List JavaDoc;
61
62 import junit.framework.Test;
63 import junit.framework.TestCase;
64 import junit.framework.TestSuite;
65
66 /**
67  * @version $Revision: 1.5 $ $Date: 2003/04/02 04:50:44 $
68  * @author <a HREF="mailto:vbossica@users.sourceforge.net">Vladimir R. Bossicard</a>
69  */
70 abstract class AbstractSuiteBuilder {
71
72     private TestFilter filter;
73
74     public AbstractSuiteBuilder(TestFilter filter) {
75         this.filter = filter;
76     }
77
78     /**
79      * Sets the <tt>filter</tt> defining the test classes to be included.
80      */
81     public void setFilter(TestFilter filter) {
82         this.filter = filter;
83     }
84
85     /**
86      * Returns <tt>true</tt> if the given <tt>path</tt> refers a test class.
87      */
88     protected boolean isTestClass(String JavaDoc path) {
89         boolean temp = path.endsWith(".class") && (path.indexOf("$") < 0);
90         if (filter == null) {
91             return temp;
92         } else {
93             return temp && filter.include(path);
94         }
95     }
96
97     /**
98      * Populates the <tt>suite</tt> with test cases extracted from the
99      * <tt>classnames</tt> list.
100      */
101     protected void merge(List JavaDoc classenames, TestSuite suite) throws ClassNotFoundException JavaDoc, IllegalAccessException JavaDoc, InvocationTargetException JavaDoc {
102         for (int i = 0; i < classenames.size(); i++) {
103             String JavaDoc classname = (String JavaDoc) classenames.get(i);
104             Class JavaDoc cls = Class.forName(classname);
105
106             if (junit.framework.TestCase.class.isAssignableFrom(cls) && ((this.filter == null) || (this.filter.include(cls)))) {
107                 /* Because a 'suite' method doesn't always exist in a TestCase,
108                  * we need to use the try/catch so that tests can also be
109                  * automatically extracted */
110                 try {
111                     Method JavaDoc suiteMethod = cls.getMethod("suite", new Class JavaDoc[0]);
112                     if (!Modifier.isPublic(suiteMethod.getModifiers())) {
113                         suite.addTest(warning("Method 'suite' should be public (class " + cls.getName() + ")"));
114                     } else if (!Modifier.isStatic(suiteMethod.getModifiers())) {
115                         suite.addTest(warning("Method 'suite' should be static (class " + cls.getName() + ")"));
116                     } else if (!Test.class.isAssignableFrom(suiteMethod.getReturnType())) {
117                         suite.addTest(warning("Method 'suite' should have a Test return type (class " + cls.getName() + ")"));
118                     } else if (suiteMethod.getParameterTypes().length != 0) {
119                         suite.addTest(warning("Method 'suite' should have no arguments (class " + cls.getName() + ")"));
120                     } else {
121                         Test test = (Test) suiteMethod.invoke(null, new Class JavaDoc[0]);
122                         suite.addTest(test);
123                     }
124                 } catch (NoSuchMethodException JavaDoc e) {
125                     suite.addTest(new TestSuite(cls));
126                 }
127             }
128         }
129     }
130
131     /**
132      * Returns a test which will fail and log a warning message.
133      */
134     private static Test warning(final String JavaDoc message) {
135         return new TestCase("warning") {
136             protected void runTest() {
137                 fail(message);
138             }
139         };
140     }
141
142 }
Popular Tags